Sign upLogin

inertia186/obarc

View on GitHub
Star
lib/obarc/api.rb

Summary

Maintainability
A
3 hrs
Test Coverage

Cyclomatic complexity for method_missing is too high. [21/6]
Open

    def method_missing(m, *args, &block)
      super unless respond_to_missing?(m)
      
      # Many of the calls to restapi.py are uniform enough for DRY code, but the
      # ones that aren't are mapped here.
Severity: Minor
Found in lib/obarc/api.rb by rubocop

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Method has too many lines. [32/30]
Open

    def method_missing(m, *args, &block)
      super unless respond_to_missing?(m)
      
      # Many of the calls to restapi.py are uniform enough for DRY code, but the
      # ones that aren't are mapped here.
Severity: Minor
Found in lib/obarc/api.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Method method_missing has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

    def method_missing(m, *args, &block)
      super unless respond_to_missing?(m)
      
      # Many of the calls to restapi.py are uniform enough for DRY code, but the
      # ones that aren't are mapped here.
Severity: Minor
Found in lib/obarc/api.rb - About 1 hr to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Method method_missing has 32 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def method_missing(m, *args, &block)
      super unless respond_to_missing?(m)
      
      # Many of the calls to restapi.py are uniform enough for DRY code, but the
      # ones that aren't are mapped here.
Severity: Minor
Found in lib/obarc/api.rb - About 1 hr to fix

    Method execute has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

        def execute(options = {})
      if options[:method] == :post
        options[:headers][:content_type] = 'application/x-www-form-urlencoded'
      end
    Severity: Minor
    Found in lib/obarc/api.rb - About 1 hr to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    FIXME found
    Open

                  # FIXME Might want to warn that we are possibly mixing multipart
    Severity: Minor
    Found in lib/obarc/api.rb by fixme

    end at 81, 8 is not aligned with if at 77, 13.
    Open

            end
    Severity: Minor
    Found in lib/obarc/api.rb by rubocop

    This cop checks whether the end keywords are aligned properly.

    Three modes are supported through the EnforcedStyleAlignWith configuration parameter:

    If it's set to keyword (which is the default), the end shall be aligned with the start of the keyword (if, class, etc.).

    If it's set to variable the end shall be aligned with the left-hand-side of the variable assignment, if there is one.

    If it's set to start_of_line, the end shall be aligned with the start of the line where the matching keyword appears.

    Example: EnforcedStyleAlignWith: keyword (default)

    # bad

variable = if true
    end

# good

variable = if true
           end

    Example: EnforcedStyleAlignWith: variable

    # bad

variable = if true
    end

# good

variable = if true
end

    Example: EnforcedStyleAlignWith: startofline

    # bad

variable = if true
    end

# good

puts(if true
end)

    Unused method argument - include_private. If it's necessary, use _ or _include_private as an argument name to indicate that it won't be used.
    Open

        def respond_to_missing?(m, include_private = false)
    Severity: Minor
    Found in lib/obarc/api.rb by rubocop

    This cop checks for unused method arguments.

    Example:

    # bad

def some_method(used, unused, _unused_but_allowed)
  puts used
end

    Example:

    # good

def some_method(used, _unused, _unused_but_allowed)
  puts used
end

    Unused block argument - v. If it's necessary, use _ or _v as an argument name to indicate that it won't be used.
    Open

          options = options.delete_if { |k, v| elements.include? k }
    Severity: Minor
    Found in lib/obarc/api.rb by rubocop

    This cop checks for unused block arguments.

    Example:

    # bad

do_something do |used, unused|
  puts used
end

do_something do |bar|
  puts :foo
end

define_method(:foo) do |bar|
  puts :baz
end

    Example:

    #good

do_something do |used, _unused|
  puts used
end

do_something do
  puts :foo
end

define_method(:foo) do |_bar|
  puts :baz
end

    end at 83, 6 is not aligned with case at 61, 47.
    Open

          end
    Severity: Minor
    Found in lib/obarc/api.rb by rubocop

    This cop checks whether the end keywords are aligned properly.

    Three modes are supported through the EnforcedStyleAlignWith configuration parameter:

    If it's set to keyword (which is the default), the end shall be aligned with the start of the keyword (if, class, etc.).

    If it's set to variable the end shall be aligned with the left-hand-side of the variable assignment, if there is one.

    If it's set to start_of_line, the end shall be aligned with the start of the line where the matching keyword appears.

    Example: EnforcedStyleAlignWith: keyword (default)

    # bad

variable = if true
    end

# good

variable = if true
           end

    Example: EnforcedStyleAlignWith: variable

    # bad

variable = if true
    end

# good

variable = if true
end

    Example: EnforcedStyleAlignWith: startofline

    # bad

variable = if true
    end

# good

puts(if true
end)

    There are no issues that match your filters.

    Category
    Status