egonbraun/logmsg

View on GitHub

Showing 33 of 33 total issues

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

    def load
      close if @loaded

      @path.each do |file|
        next unless File.exist?(file)
Severity: Minor
Found in lib/logmsg.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 unregister has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    def unregister
      unless @logger.nil?
        @logger.close unless @path == STDOUT_STREAM || @path == STDERR_STREAM
        @logger = nil
      end
Severity: Minor
Found in lib/logmsg/logfile.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

Freeze mutable objects assigned to constants.
Open

    DEFAULT_PATH = [
      File.join('.', ".#{DEFAULT_SETTINGS_FILE}"),
      File.join(File.expand_path('~'), ".#{DEFAULT_SETTINGS_FILE}"),
      File.join(File.dirname(__FILE__), "logmsg/yaml/#{DEFAULT_SETTINGS_FILE}")
    ]
Severity: Minor
Found in lib/logmsg.rb by rubocop

This cop checks whether some constant value isn't a mutable literal (e.g. array or hash).

Example:

# bad
CONST = [1, 2, 3]

# good
CONST = [1, 2, 3].freeze

Freeze mutable objects assigned to constants.
Open

    DEFAULT_DATETIME_FORMAT = '%Y-%m-%d %H:%M:%S'
Severity: Minor
Found in lib/logmsg/logfile.rb by rubocop

This cop checks whether some constant value isn't a mutable literal (e.g. array or hash).

Example:

# bad
CONST = [1, 2, 3]

# good
CONST = [1, 2, 3].freeze

Prefer annotated tokens (like %<foo>s</foo>) over template tokens (like %{foo}).
Open

    DEFAULT_LOG_FORMAT = '%{progname} [%{datetime}] %{severity}: %{msg}'
Severity: Minor
Found in lib/logmsg.rb by rubocop

Use a consistent style for named format string tokens.

Note: unannotated style cop only works for strings which are passed as arguments to those methods: sprintf, format, %. The reason is that unannotated format is very similar to encoded URLs or Date/Time formatting strings.

Example: EnforcedStyle: annotated (default)

# bad
format('%{greeting}', greeting: 'Hello')
format('%s', 'Hello')

# good
format('%<greeting>s', greeting: 'Hello')</greeting>

Example: EnforcedStyle: template

# bad
format('%<greeting>s', greeting: 'Hello')
format('%s', 'Hello')

# good
format('%{greeting}', greeting: 'Hello')</greeting>

Example: EnforcedStyle: unannotated

# bad
format('%<greeting>s', greeting: 'Hello')
format('%{greeting}', 'Hello')

# good
format('%s', 'Hello')</greeting>

Use meaningful heredoc delimiters.
Open

  EOF
Severity: Minor
Found in bin/logmsg by rubocop

This cop checks that your heredocs are using meaningful delimiters. By default it disallows END and EO*, and can be configured through blacklisting additional delimiters.

Example:

# good
<

Freeze mutable objects assigned to constants.
Open

DEFAULT_SEVERITY = 'info'
Severity: Minor
Found in bin/logmsg by rubocop

This cop checks whether some constant value isn't a mutable literal (e.g. array or hash).

Example:

# bad
CONST = [1, 2, 3]

# good
CONST = [1, 2, 3].freeze

Prefer annotated tokens (like %<foo>s</foo>) over template tokens (like %{foo}).
Open

    DEFAULT_LOG_FORMAT = '%{progname} [%{datetime}] %{severity}: %{msg}'
Severity: Minor
Found in lib/logmsg.rb by rubocop

Use a consistent style for named format string tokens.

Note: unannotated style cop only works for strings which are passed as arguments to those methods: sprintf, format, %. The reason is that unannotated format is very similar to encoded URLs or Date/Time formatting strings.

Example: EnforcedStyle: annotated (default)

# bad
format('%{greeting}', greeting: 'Hello')
format('%s', 'Hello')

# good
format('%<greeting>s', greeting: 'Hello')</greeting>

Example: EnforcedStyle: template

# bad
format('%<greeting>s', greeting: 'Hello')
format('%s', 'Hello')

# good
format('%{greeting}', greeting: 'Hello')</greeting>

Example: EnforcedStyle: unannotated

# bad
format('%<greeting>s', greeting: 'Hello')
format('%{greeting}', 'Hello')

# good
format('%s', 'Hello')</greeting>

Prefer annotated tokens (like %<foo>s</foo>) over unannotated tokens (like %s).
Open

    DEFAULT_DATETIME_FORMAT = '%Y-%m-%d %H:%M:%S'
Severity: Minor
Found in lib/logmsg/logfile.rb by rubocop

Use a consistent style for named format string tokens.

Note: unannotated style cop only works for strings which are passed as arguments to those methods: sprintf, format, %. The reason is that unannotated format is very similar to encoded URLs or Date/Time formatting strings.

Example: EnforcedStyle: annotated (default)

# bad
format('%{greeting}', greeting: 'Hello')
format('%s', 'Hello')

# good
format('%<greeting>s', greeting: 'Hello')</greeting>

Example: EnforcedStyle: template

# bad
format('%<greeting>s', greeting: 'Hello')
format('%s', 'Hello')

# good
format('%{greeting}', greeting: 'Hello')</greeting>

Example: EnforcedStyle: unannotated

# bad
format('%<greeting>s', greeting: 'Hello')
format('%{greeting}', 'Hello')

# good
format('%s', 'Hello')</greeting>

Freeze mutable objects assigned to constants.
Open

    DEFAULT_DATETIME_FORMAT = '%Y-%m-%d %H:%M:%S'
Severity: Minor
Found in lib/logmsg.rb by rubocop

This cop checks whether some constant value isn't a mutable literal (e.g. array or hash).

Example:

# bad
CONST = [1, 2, 3]

# good
CONST = [1, 2, 3].freeze

Prefer annotated tokens (like %<foo>s</foo>) over template tokens (like %{foo}).
Open

    DEFAULT_FORMAT = '%{severity}: %{msg}'
Severity: Minor
Found in lib/logmsg/logfile.rb by rubocop

Use a consistent style for named format string tokens.

Note: unannotated style cop only works for strings which are passed as arguments to those methods: sprintf, format, %. The reason is that unannotated format is very similar to encoded URLs or Date/Time formatting strings.

Example: EnforcedStyle: annotated (default)

# bad
format('%{greeting}', greeting: 'Hello')
format('%s', 'Hello')

# good
format('%<greeting>s', greeting: 'Hello')</greeting>

Example: EnforcedStyle: template

# bad
format('%<greeting>s', greeting: 'Hello')
format('%s', 'Hello')

# good
format('%{greeting}', greeting: 'Hello')</greeting>

Example: EnforcedStyle: unannotated

# bad
format('%<greeting>s', greeting: 'Hello')
format('%{greeting}', 'Hello')

# good
format('%s', 'Hello')</greeting>

Operator = should be surrounded by a single space.
Open

  spec.bindir        = 'bin'
Severity: Minor
Found in logmsg.gemspec by rubocop

Checks that operators have space around them, except for ** which should not have surrounding space.

Example:

# bad
total = 3*4
"apple"+"juice"
my_number = 38/4
a ** b

# good
total = 3 * 4
"apple" + "juice"
my_number = 38 / 4
a**b

Operator << should be surrounded by a single space.
Open

  spec.executables   << 'logmsg'
Severity: Minor
Found in logmsg.gemspec by rubocop

Checks that operators have space around them, except for ** which should not have surrounding space.

Example:

# bad
total = 3*4
"apple"+"juice"
my_number = 38/4
a ** b

# good
total = 3 * 4
"apple" + "juice"
my_number = 38 / 4
a**b

Line is too long. [83/80]
Open

  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4', '>= 0.4.8'
Severity: Minor
Found in logmsg.gemspec by rubocop

Freeze mutable objects assigned to constants.
Open

  VERSION = '1.0.6'
Severity: Minor
Found in lib/logmsg/version.rb by rubocop

This cop checks whether some constant value isn't a mutable literal (e.g. array or hash).

Example:

# bad
CONST = [1, 2, 3]

# good
CONST = [1, 2, 3].freeze

Favor format over String#%.
Open

        "#{@format}\n" % { severity: s, datetime: d, progname: p, msg: m }
Severity: Minor
Found in lib/logmsg/logfile.rb by rubocop

This cop enforces the use of a single string formatting utility. Valid options include Kernel#format, Kernel#sprintf and String#%.

The detection of String#% cannot be implemented in a reliable manner for all cases, so only two scenarios are considered - if the first argument is a string literal and if the second argument is an array literal.

Example: EnforcedStyle: format(default)

# bad
puts sprintf('%10s', 'hoge')
puts '%10s' % 'hoge'

# good
puts format('%10s', 'hoge')

Example: EnforcedStyle: sprintf

# bad
puts format('%10s', 'hoge')
puts '%10s' % 'hoge'

# good
puts sprintf('%10s', 'hoge')

Example: EnforcedStyle: percent

# bad
puts format('%10s', 'hoge')
puts sprintf('%10s', 'hoge')

# good
puts '%10s' % 'hoge'

Freeze mutable objects assigned to constants.
Open

    DEFAULT_FORMAT = '%{severity}: %{msg}'
Severity: Minor
Found in lib/logmsg/logfile.rb by rubocop

This cop checks whether some constant value isn't a mutable literal (e.g. array or hash).

Example:

# bad
CONST = [1, 2, 3]

# good
CONST = [1, 2, 3].freeze

Unnecessary utf-8 encoding comment.
Open

# coding: utf-8
Severity: Minor
Found in logmsg.gemspec by rubocop

Use empty? instead of length < 1.
Open

if ARGV.length < 1
Severity: Minor
Found in bin/logmsg by rubocop

This cop checks for numeric comparisons that can be replaced by a predicate method, such as receiver.length == 0, receiver.length > 0, receiver.length != 0, receiver.length < 1 and receiver.size == 0 that can be replaced by receiver.empty? and !receiver.empty.

Example:

# bad
[1, 2, 3].length == 0
0 == "foobar".length
array.length < 1
{a: 1, b: 2}.length != 0
string.length > 0
hash.size > 0

# good
[1, 2, 3].empty?
"foobar".empty?
array.empty?
!{a: 1, b: 2}.empty?
!string.empty?
!hash.empty?

Use @severities.length.zero? instead of @severities.length == 0.
Open

      severity >= @threshold && @severities.length == 0
Severity: Minor
Found in lib/logmsg/logfile.rb by rubocop

This cop checks for usage of comparison operators (==, >, <) to test numbers as zero, positive, or negative. These can be replaced by their respective predicate methods. The cop can also be configured to do the reverse.

The cop disregards #nonzero? as it its value is truthy or falsey, but not true and false, and thus not always interchangeable with != 0.

The cop ignores comparisons to global variables, since they are often populated with objects which can be compared with integers, but are not themselves Interger polymorphic.

Example: EnforcedStyle: predicate (default)

# bad

foo == 0
0 > foo
bar.baz > 0

# good

foo.zero?
foo.negative?
bar.baz.positive?

Example: EnforcedStyle: comparison

# bad

foo.zero?
foo.negative?
bar.baz.positive?

# good

foo == 0
0 > foo
bar.baz > 0
Severity
Category
Status
Source
Language