Sign upLogin

piotrmurach/tty-logger

View on GitHub
Star

Showing 13 of 13 total issues

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

    def log(current_level, *msg)
      scoped_fields = msg.last.is_a?(::Hash) ? msg.pop : {}
      fields_copy = scoped_fields.dup
      if msg.empty? && block_given?
        msg = []
Severity: Minor
Found in lib/tty/logger.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 call has 38 lines of code (exceeds 25 allowed). Consider refactoring.
Open

        def call(event)
          @mutex.lock

          style = configure_styles(event)
          color = configure_color(style)
Severity: Minor
Found in lib/tty/logger/handlers/console.rb - About 1 hr to fix

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

          def compile(filters)
        compiled = {
          regexps: [],
          nested_regexps: [],
          blocks: []
    Severity: Minor
    Found in lib/tty/logger/data_filter.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 compile has 33 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

          def compile(filters)
        compiled = {
          regexps: [],
          nested_regexps: [],
          blocks: []
    Severity: Minor
    Found in lib/tty/logger/data_filter.rb - About 1 hr to fix

      Method call has 30 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

              def call(event)
          @mutex.lock

          data = {}
          metadata.each do |meta|
      Severity: Minor
      Found in lib/tty/logger/handlers/stream.rb - About 1 hr to fix

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

            def log(current_level, *msg)
      scoped_fields = msg.last.is_a?(::Hash) ? msg.pop : {}
      fields_copy = scoped_fields.dup
      if msg.empty? && block_given?
        msg = []
        Severity: Minor
        Found in lib/tty/logger.rb - About 1 hr to fix

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

                  def call(event)
          @mutex.lock

          style = configure_styles(event)
          color = configure_color(style)
          Severity: Minor
          Found in lib/tty/logger/handlers/console.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 dump has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

                  def dump(obj, max_bytes: 2**12, max_depth: 3)
          bytesize = 0

          line = obj.each_with_object([]) do |(k, v), acc|
            str = "#{dump_key(k)}=#{dump_val(v, max_depth)}"
          Severity: Minor
          Found in lib/tty/logger/formatters/text.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 compare_levels has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

                def compare_levels(left, right)
        left = left.is_a?(Integer) ? left : level_to_number(left)
        right = right.is_a?(Integer) ? right : level_to_number(right)

        return :eq if left == right
          Severity: Minor
          Found in lib/tty/logger/levels.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 coerce_formatter has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

                  def coerce_formatter(name)
          case name
          when String, Symbol
            const_name = if Formatters.const_defined?(name.upcase)
                           name.upcase
          Severity: Minor
          Found in lib/tty/logger/handlers/base.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 call has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

                  def call(event)
          @mutex.lock

          data = {}
          metadata.each do |meta|
          Severity: Minor
          Found in lib/tty/logger/handlers/stream.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

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

          TTY::Logger.configure do |config|
  config.max_bytes = 2**7
  config.metadata = [:all]
  config.handlers = [[:stream, { formatter: :text }]]
  config.level = :debug
          Severity: Minor
          Found in examples/stream.rb and 1 other location - About 15 mins to fix
          examples/console.rb on lines 5..9

          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 26.

          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

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

          TTY::Logger.configure do |config|
  config.max_bytes = 2**5
  config.metadata = [:all]
  config.handlers = [[:console, { formatter: :text }]]
  config.level = :debug
          Severity: Minor
          Found in examples/console.rb and 1 other location - About 15 mins to fix
          examples/stream.rb on lines 5..9

          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 26.

          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