Sign upLogin

pboling/debug_logging

View on GitHub
Star

Showing 19 of 19 total issues

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

    def debug_signature_to_s(args: nil, kwargs: nil, config_proxy: nil) # rubocop:disable Metrics/CyclomaticComplexity
      return "" unless (args || kwargs) && config_proxy

      printed_args = ""
Severity: Minor
Found in lib/debug_logging/argument_printer.rb - About 1 day 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 logged has a Cognitive Complexity of 35 (exceeds 5 allowed). Consider refactoring.
Open

    def logged(*methods_to_log)
      methods_to_log, payload, config_opts = DebugLogging::Util.extract_payload_and_config(
        method_names: methods_to_log,
        payload: nil,
        config: nil,
Severity: Minor
Found in lib/debug_logging/class_logger.rb - About 5 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 debug_signature_to_s has 98 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def debug_signature_to_s(args: nil, kwargs: nil, config_proxy: nil) # rubocop:disable Metrics/CyclomaticComplexity
      return "" unless (args || kwargs) && config_proxy

      printed_args = ""
Severity: Major
Found in lib/debug_logging/argument_printer.rb - About 3 hrs to fix

    Method logged has 71 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        def logged(*methods_to_log)
      methods_to_log, payload, config_opts = DebugLogging::Util.extract_payload_and_config(
        method_names: methods_to_log,
        payload: nil,
        config: nil,
    Severity: Major
    Found in lib/debug_logging/class_logger.rb - About 2 hrs to fix

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

          def notified(*methods_to_notify)
      methods_to_notify, payload, config_opts = DebugLogging::Util.extract_payload_and_config(
        method_names: methods_to_notify,
        payload: nil,
        config: nil,
      Severity: Minor
      Found in lib/debug_logging/class_notifier.rb - About 2 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 extract_payload_and_config has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
      Open

          def extract_payload_and_config(method_names:, payload: nil, config: nil)
      # When scoped config is present it will always be a new configuration instance per method
      # When scoped config is not present it will reuse the class' configuration object
      scoped_payload = (method_names.is_a?(Array) && method_names.last.is_a?(Hash) && method_names.pop.clone(freeze: false)) || {}
      payload = if payload
      Severity: Minor
      Found in lib/debug_logging/util.rb - About 2 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 notified has 52 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          def notified(*methods_to_notify)
      methods_to_notify, payload, config_opts = DebugLogging::Util.extract_payload_and_config(
        method_names: methods_to_notify,
        payload: nil,
        config: nil,
      Severity: Major
      Found in lib/debug_logging/class_notifier.rb - About 2 hrs to fix

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

            def debug_invocation_id_to_s(args: nil, kwargs: nil, start_at: nil, config_proxy: nil)
      return "" unless (args || kwargs) && config_proxy

      if config_proxy.debug_add_invocation_id
        time = start_at ? Util.debug_time(start_at) : Time.now
        Severity: Minor
        Found in lib/debug_logging/argument_printer.rb - About 1 hr 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 extract_payload_and_config has 28 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            def extract_payload_and_config(method_names:, payload: nil, config: nil)
      # When scoped config is present it will always be a new configuration instance per method
      # When scoped config is not present it will reuse the class' configuration object
      scoped_payload = (method_names.is_a?(Array) && method_names.last.is_a?(Hash) && method_names.pop.clone(freeze: false)) || {}
      payload = if payload
        Severity: Minor
        Found in lib/debug_logging/util.rb - About 1 hr to fix

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

              def config_proxy_finder(scope:, method_name:, proxy_ref:, config_opts: {}, &block)
      if (proxy = scope.send(:instance_variable_get, DebugLogging::Configuration.config_pointer(
        proxy_ref,
        method_name,
      )))
          Severity: Minor
          Found in lib/debug_logging/util.rb - About 1 hr 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

          Identical blocks of code found in 2 locations. Consider refactoring.
          Open

                      other_args_string = if config_proxy.debug_args_to_s_proc
              printed, add_other_args_ellipsis = debug_safe_proc(
                proc_name: "args_to_s_proc",
                proc: config_proxy.debug_args_to_s_proc,
                args: other_args,
          Severity: Minor
          Found in lib/debug_logging/argument_printer.rb and 1 other location - About 50 mins to fix
          lib/debug_logging/argument_printer.rb on lines 80..91

          Duplicated Code

          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

          Tuning

          This issue has a mass of 43.

          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

          Refactorings

          Further Reading

          Identical blocks of code found in 2 locations. Consider refactoring.
          Open

                      other_args_string = if config_proxy.debug_args_to_s_proc
              printed, add_other_args_ellipsis = debug_safe_proc(
                proc_name: "args_to_s_proc",
                proc: config_proxy.debug_args_to_s_proc,
                args: other_args,
          Severity: Minor
          Found in lib/debug_logging/argument_printer.rb and 1 other location - About 50 mins to fix
          lib/debug_logging/argument_printer.rb on lines 114..125

          Duplicated Code

          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

          Tuning

          This issue has a mass of 43.

          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

          Refactorings

          Further Reading

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

                def debug_time_box(time, *names, &blk)
        names.each do |name|
          meth = instance_method(name)
          define_method(name) do |*args, &block|
            Timeout.timeout(time) do
          Severity: Minor
          Found in lib/debug_logging/hooks.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 debug_invocation_to_s has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

              def debug_invocation_to_s(klass: nil, separator: nil, method_to_log: nil, config_proxy: nil)
      return "" unless config_proxy

      klass_string = if config_proxy.debug_colorized_chain_for_class
        config_proxy.debug_colorized_chain_for_class.call(ColorizedString[klass.to_s])
          Severity: Minor
          Found in lib/debug_logging/argument_printer.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

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

              def self.extended(obj)
      TracePoint.trace(:end) do |t|
        if obj == t.self
          if obj.respond_to?(:debug_finalize)
            obj.debug_finalize
          Severity: Minor
          Found in lib/debug_logging/finalize.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

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

              def debug_payload_to_s(payload: nil, config_proxy: nil)
      return "" unless payload && config_proxy

      case config_proxy.debug_add_payload
      when true
          Severity: Minor
          Found in lib/debug_logging/argument_printer.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

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

              def log(message = nil, &block)
      return unless enabled
      return unless logger

      if block
          Severity: Minor
          Found in lib/debug_logging/configuration.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

          Identical blocks of code found in 2 locations. Consider refactoring.
          Open

                          method_return_value = if args.size == 1 && (harsh = args[0]) && harsh.is_a?(Hash)
                  original_method.call(**harsh, &block)
                else
                  original_method.call(*args, &block)
                end
          Severity: Minor
          Found in lib/debug_logging/class_logger.rb and 1 other location - About 20 mins to fix
          lib/debug_logging/class_logger.rb on lines 43..47

          Duplicated Code

          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

          Tuning

          This issue has a mass of 28.

          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

          Refactorings

          Further Reading

          Identical blocks of code found in 2 locations. Consider refactoring.
          Open

                            method_return_value = if args.size == 1 && (harsh = args[0]) && harsh.is_a?(Hash)
                    original_method.call(**harsh, &block)
                  else
                    original_method.call(*args, &block)
                  end
          Severity: Minor
          Found in lib/debug_logging/class_logger.rb and 1 other location - About 20 mins to fix
          lib/debug_logging/class_logger.rb on lines 53..57

          Duplicated Code

          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

          Tuning

          This issue has a mass of 28.

          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

          Refactorings

          Further Reading

          Severity
          Category
          Status
          Source
          Language