Sign upLogin

Apipie/apipie-rails

View on GitHub
Star
lib/apipie/extractor/collector.rb

Summary

Maintainability
B
5 hrs
Test Coverage

Method refine_params_description has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
Open

      def refine_params_description(params_desc, recorded_params)
        recorded_params.each do |key, value|
          params_desc[key] ||= {}
          param_desc = params_desc[key]
Severity: Minor
Found in lib/apipie/extractor/collector.rb - About 4 hrs 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 refine_params_description has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

      def refine_params_description(params_desc, recorded_params)
        recorded_params.each do |key, value|
          params_desc[key] ||= {}
          param_desc = params_desc[key]
Severity: Minor
Found in lib/apipie/extractor/collector.rb - About 1 hr to fix

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

          def ignore_call?(record)
        return true unless record[:controller]
        return true if @ignored.include?(record[:controller].name)
        return true if @ignored.include?("#{Apipie.get_resource_id(record[:controller].name)}##{record[:action]}")
        return true unless @api_controllers_paths.include?(controller_full_path(record[:controller]))
    Severity: Minor
    Found in lib/apipie/extractor/collector.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

    There are no issues that match your filters.

    Category
    Status