am-kantox/kantox-chronoscope

View on GitHub
lib/kantox/chronoscope/generic.rb

Summary

Maintainability
A
2 hrs
Test Coverage

Method log_report has 41 lines of code (exceeds 25 allowed). Consider refactoring.
Open

      def log_report(count)
        count = @@chronoscope_data.size if count <= 0

        delim_label = [" ⇓⇓ [#{LOGGER_TAG}] ⇓⇓ ", " ⇑⇑ [#{LOGGER_TAG}] ⇑⇑ "].map do |label|
          delim = '—' * ((log_width - label.length) / 2)
Severity: Minor
Found in lib/kantox/chronoscope/generic.rb - About 1 hr to fix

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

          def ⌚(arg = DEFAULT_TAG, log = false)
            return (@@chronoscope_data[arg.to_s] = nil) unless block_given? # pass no block to reset
    
            result = nil # needed for it to be defined in this scope
            @@chronoscope_data[arg.to_s] ||= { count: 0, total: 0, stack: @@★.dup }
    Severity: Minor
    Found in lib/kantox/chronoscope/generic.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

    FIXME found
    Open

          # FIXME: total currently adds up all calls, including nested
    Severity: Minor
    Found in lib/kantox/chronoscope/generic.rb by fixme

    Use normalcase for variable numbers.
    Open

          @@★ = []
    Severity: Minor
    Found in lib/kantox/chronoscope/generic.rb by rubocop

    This cop makes sure that all numbered variables use the configured style, snakecase, normalcase or noninteger, for their numbering.

    Example: EnforcedStyle: snake_case

    # bad
    
    variable1 = 1
    
    # good
    
    variable_1 = 1

    Example: EnforcedStyle: normalcase (default)

    # bad
    
    variable_1 = 1
    
    # good
    
    variable1 = 1

    Example: EnforcedStyle: non_integer

    # bad
    
    variable1 = 1
    
    variable_1 = 1
    
    # good
    
    variableone = 1
    
    variable_one = 1

    Avoid rescuing without specifying an error class.
    Open

            rescue => e
    Severity: Minor
    Found in lib/kantox/chronoscope/generic.rb by rubocop

    This cop checks for rescuing StandardError. There are two supported styles implicit and explicit. This cop will not register an offense if any error other than StandardError is specified.

    Example: EnforcedStyle: implicit

    # `implicit` will enforce using `rescue` instead of
    # `rescue StandardError`.
    
    # bad
    begin
      foo
    rescue StandardError
      bar
    end
    
    # good
    begin
      foo
    rescue
      bar
    end
    
    # good
    begin
      foo
    rescue OtherError
      bar
    end
    
    # good
    begin
      foo
    rescue StandardError, SecurityError
      bar
    end

    Example: EnforcedStyle: explicit (default)

    # `explicit` will enforce using `rescue StandardError`
    # instead of `rescue`.
    
    # bad
    begin
      foo
    rescue
      bar
    end
    
    # good
    begin
      foo
    rescue StandardError
      bar
    end
    
    # good
    begin
      foo
    rescue OtherError
      bar
    end
    
    # good
    begin
      foo
    rescue StandardError, SecurityError
      bar
    end

    Avoid rescuing without specifying an error class.
    Open

          rescue
    Severity: Minor
    Found in lib/kantox/chronoscope/generic.rb by rubocop

    This cop checks for rescuing StandardError. There are two supported styles implicit and explicit. This cop will not register an offense if any error other than StandardError is specified.

    Example: EnforcedStyle: implicit

    # `implicit` will enforce using `rescue` instead of
    # `rescue StandardError`.
    
    # bad
    begin
      foo
    rescue StandardError
      bar
    end
    
    # good
    begin
      foo
    rescue
      bar
    end
    
    # good
    begin
      foo
    rescue OtherError
      bar
    end
    
    # good
    begin
      foo
    rescue StandardError, SecurityError
      bar
    end

    Example: EnforcedStyle: explicit (default)

    # `explicit` will enforce using `rescue StandardError`
    # instead of `rescue`.
    
    # bad
    begin
      foo
    rescue
      bar
    end
    
    # good
    begin
      foo
    rescue StandardError
      bar
    end
    
    # good
    begin
      foo
    rescue OtherError
      bar
    end
    
    # good
    begin
      foo
    rescue StandardError, SecurityError
      bar
    end

    Do not place comments on the same line as the def keyword.
    Open

          def ⌛(cleanup: true, count: 18, log: true) # Yes, 18 is my fave number)
    Severity: Minor
    Found in lib/kantox/chronoscope/generic.rb by rubocop

    This cop checks for comments put on the same line as some keywords. These keywords are: begin, class, def, end, module.

    Note that some comments (such as :nodoc: and rubocop:disable) are allowed.

    Example:

    # bad
    if condition
      statement
    end # end if
    
    # bad
    class X # comment
      statement
    end
    
    # bad
    def x; end # comment
    
    # good
    if condition
      statement
    end
    
    # good
    class X # :nodoc:
      y
    end

    There are no issues that match your filters.

    Category
    Status