drewish/rspec-rails-swagger

View on GitHub
lib/rspec/rails/swagger/helpers.rb

Summary

Maintainability
A
2 hrs
Test Coverage

Method response has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

          def response status_code, attributes = {}, &block
            attributes.symbolize_keys!

            validate_status_code! status_code
            validate_description! attributes[:description]
Severity: Minor
Found in lib/rspec/rails/swagger/helpers.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 response has 30 lines of code (exceeds 25 allowed). Consider refactoring.
Open

          def response status_code, attributes = {}, &block
            attributes.symbolize_keys!

            validate_status_code! status_code
            validate_description! attributes[:description]
Severity: Minor
Found in lib/rspec/rails/swagger/helpers.rb - About 1 hr to fix

    TODO found
    Open

                  # TODO: see if we can get the caller to show up in the error
    Severity: Minor
    Found in lib/rspec/rails/swagger/helpers.rb by fixme

    TODO found
    Open

                #TODO template might be a $ref
    Severity: Minor
    Found in lib/rspec/rails/swagger/helpers.rb by fixme

    TODO found
    Open

                # TODO: It's really inefficient to keep recreating this. It'd be nice
    Severity: Minor
    Found in lib/rspec/rails/swagger/helpers.rb by fixme

    Missing space after #.
    Open

                #TODO template might be a $ref
    Severity: Minor
    Found in lib/rspec/rails/swagger/helpers.rb by rubocop

    This cop checks whether comments have a leading space after the # denoting the start of the comment. The leading space is not required for some RDoc special syntax, like #++, #--, #:nodoc, =begin- and =end comments, "shebang" directives, or rackup options.

    Example:

    # bad
    #Some comment
    
    # good
    # Some comment

    There are no issues that match your filters.

    Category
    Status