bigcommerce/gruf

View on GitHub
lib/gruf/interceptors/instrumentation/request_logging/interceptor.rb

Summary

Maintainability
B
4 hrs
Test Coverage
A
93%

Method call has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

          def call(&block)
            return yield if options.fetch(:ignore_methods, [])&.include?(request.method_name)

            result = Gruf::Interceptors::Timer.time(&block)

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 call has 31 lines of code (exceeds 25 allowed). Consider refactoring.
Open

          def call(&block)
            return yield if options.fetch(:ignore_methods, [])&.include?(request.method_name)

            result = Gruf::Interceptors::Timer.time(&block)

    Method redact! has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

              def redact!(parts = [], idx = 0, params = {}, redacted_string = 'REDACTED')
                return unless parts.is_a?(Array) && params.is_a?(Hash)
    
                return if idx >= parts.size || !params.key?(parts[idx])
    
    

    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 formatter has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

              def formatter
                unless @formatter
                  fmt = options.fetch(:formatter, :plain)
                  @formatter = case fmt
                               when Symbol
    Severity: Minor
    Found in lib/gruf/interceptors/instrumentation/request_logging/interceptor.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