inertia186/obarc

View on GitHub
lib/obarc/session.rb

Summary

Maintainability
C
1 day
Test Coverage

Class Session has 51 methods (exceeds 20 allowed). Consider refactoring.
Open

  class Session
    OPTIONS_KEYS = %i(protocol server_host server_port api_version username
      password base_url logger cookies verify_ssl)
    
    attr_accessor :cookies, :username, :password, :verify_ssl
Severity: Major
Found in lib/obarc/session.rb - About 7 hrs to fix

    Method query_listings has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

        def query_listings(options = {})
          pattern = options.delete(:pattern)
          all_listings = JSON[Api::get_listings(options, self)]
          listings = all_listings['listings']
          
    Severity: Minor
    Found in lib/obarc/session.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

    Cyclomatic complexity for query_listings is too high. [7/6]
    Open

        def query_listings(options = {})
          pattern = options.delete(:pattern)
          all_listings = JSON[Api::get_listings(options, self)]
          listings = all_listings['listings']
          
    Severity: Minor
    Found in lib/obarc/session.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. [31/30]
    Open

        def query_listings(options = {})
          pattern = options.delete(:pattern)
          all_listings = JSON[Api::get_listings(options, self)]
          listings = all_listings['listings']
          
    Severity: Minor
    Found in lib/obarc/session.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 query_listings has 31 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        def query_listings(options = {})
          pattern = options.delete(:pattern)
          all_listings = JSON[Api::get_listings(options, self)]
          listings = all_listings['listings']
          
    Severity: Minor
    Found in lib/obarc/session.rb - About 1 hr to fix

      Method upload_contract_images_with has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          def upload_contract_images_with(symbol, contract = {})
            contract[:images] = [contract.delete(symbol)].flatten.map do |image|
              response = if image.size < 2000 && image =~ URI::ABS_URI
                upload_image(image: open(image, 'rb'))
              else
      Severity: Minor
      Found in lib/obarc/session.rb - About 25 mins 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 initialize has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          def initialize(options = {})
            OPTIONS_KEYS.each do |k|
              value = if options.key?(k)
                options[k]
              else
      Severity: Minor
      Found in lib/obarc/session.rb - About 25 mins 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

          # @param FIXME not yet supported, future: limit-[number of most recent notifications]
      Severity: Minor
      Found in lib/obarc/session.rb by fixme

      FIXME found
      Open

          #   * start [FIXME] the starting point in the message list
      Severity: Minor
      Found in lib/obarc/session.rb by fixme

      end at 125, 6 is not aligned with if at 120, 25.
      Open

            end
      Severity: Minor
      Found in lib/obarc/session.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)

      end at 277, 8 is not aligned with if at 273, 19.
      Open

              end
      Severity: Minor
      Found in lib/obarc/session.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)

      end at 27, 8 is not aligned with if at 23, 16.
      Open

              end
      Severity: Minor
      Found in lib/obarc/session.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