Sign upLogin

zipmark/rspec_api_documentation

View on GitHub
Star
lib/rspec_api_documentation/client_base.rb

Summary

Maintainability
A
1 hr
Test Coverage

Method clean_out_uploaded_data has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    def clean_out_uploaded_data(params, request_body)
      params.each do |value|
        if [Hash, Array].member? value.class
          request_body = if value.respond_to?(:has_key?) && value.has_key?(:tempfile)
                           data = value[:tempfile].read
Severity: Minor
Found in lib/rspec_api_documentation/client_base.rb - About 45 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 document_example has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    def document_example(method, path)
      return unless metadata[:document]

      request_body = read_request_body
Severity: Minor
Found in lib/rspec_api_documentation/client_base.rb - About 35 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

There are no issues that match your filters.

Category
Status