ruby-grape/grape-swagger

View on GitHub
lib/grape-swagger/doc_methods.rb

Summary

Maintainability
A
2 hrs
Test Coverage

Method setup has 28 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def setup(options)
      options = DEFAULTS.merge(options)

      # options could be set on #add_swagger_documentation call,
      # for available options see #defaults
Severity: Minor
Found in lib/grape-swagger/doc_methods.rb - About 1 hr to fix

    Method output_path_definitions has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        def self.output_path_definitions(combi_routes, endpoint, target_class, options)
          output = endpoint.swagger_object(
            target_class,
            endpoint.request,
            options
    Severity: Minor
    Found in lib/grape-swagger/doc_methods.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

    Method setup has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        def setup(options)
          options = DEFAULTS.merge(options)
    
          # options could be set on #add_swagger_documentation call,
          # for available options see #defaults
    Severity: Minor
    Found in lib/grape-swagger/doc_methods.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