Assignment Branch Condition size for == is too high. [55.3/15] Open
def ==(other)
return false if other.nil?
return false if self['OpenStdin'] || other['OpenStdin']
return false if self['AttachStdout'] != other['AttachStdout']
- Read upRead up
- Exclude checks
This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric
Cyclomatic complexity for == is too high. [22/6] Open
def ==(other)
return false if other.nil?
return false if self['OpenStdin'] || other['OpenStdin']
return false if self['AttachStdout'] != other['AttachStdout']
- Read upRead up
- Exclude checks
This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.
An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.
Perceived complexity for == is too high. [22/7] Open
def ==(other)
return false if other.nil?
return false if self['OpenStdin'] || other['OpenStdin']
return false if self['AttachStdout'] != other['AttachStdout']
- Read upRead up
- Exclude checks
This cop tries to produce a complexity score that's a measure of the
complexity the reader experiences when looking at a method. For that
reason it considers when
nodes as something that doesn't add as much
complexity as an if
or a &&
. Except if it's one of those special
case
/when
constructs where there's no expression after case
. Then
the cop treats it as an if
/elsif
/elsif
... and lets all the when
nodes count. In contrast to the CyclomaticComplexity cop, this cop
considers else
nodes as adding complexity.
Example:
def my_method # 1
if cond # 1
case var # 2 (0.8 + 4 * 0.2, rounded)
when 1 then func_one
when 2 then func_two
when 3 then func_three
when 4..10 then func_other
end
else # 1
do_something until a && b # 2
end # ===
end # 7 complexity points
Method ==
has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring. Open
def ==(other)
return false if other.nil?
return false if self['OpenStdin'] || other['OpenStdin']
return false if self['AttachStdout'] != other['AttachStdout']
- Read upRead up
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 has too many lines. [23/20] Open
def ==(other)
return false if other.nil?
return false if self['OpenStdin'] || other['OpenStdin']
return false if self['AttachStdout'] != other['AttachStdout']
- Read upRead up
- Exclude checks
This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.
Avoid too many return
statements within this method. Open
return false if self['Tty'] != other['Tty']
Avoid too many return
statements within this method. Open
return false if (self['Labels'] || {}) != (other['Labels'] || {})
Avoid too many return
statements within this method. Open
return false if Array(self['Env']).sort != Array(other['Env']).sort
Avoid too many return
statements within this method. Open
return true
Avoid too many return
statements within this method. Open
return false if self['Cmd'] != other['Cmd']
Avoid too many return
statements within this method. Open
return false unless other_vols.key?(my_vol)
Avoid too many return
statements within this method. Open
return false unless other_ports.key?(my_port)
Avoid too many return
statements within this method. Open
return false if self['Entrypoint'] != other['Entrypoint']
Avoid too many return
statements within this method. Open
return false if my_vols.keys.size != other_vols.keys.size
Avoid too many return
statements within this method. Open
return false if my_ports.keys.size != other_ports.keys.size
Avoid too many return
statements within this method. Open
return false if self['User'] != other['User']
Use =~
in places where the MatchData
returned by #match
will not be used. Open
return name if name.match(/^[A-Z]/)
- Read upRead up
- Exclude checks
This cop identifies the use of Regexp#match
or String#match
, which
returns #<MatchData>
/nil
. The return value of =~
is an integral
index/nil
and is more performant.
Example:
# bad
do_something if str.match(/regex/)
while regex.match('str')
do_something
end
# good
method(str =~ /regex/)
return value unless regex =~ 'str'
Use each_key
instead of keys.each
. Open
my_vols.keys.each do |my_vol|
- Read upRead up
- Exclude checks
This cop checks for uses of each_key
and each_value
Hash methods.
Note: If you have an array of two-element arrays, you can put parentheses around the block arguments to indicate that you're not working with a hash, and suppress RuboCop offenses.
Example:
# bad
hash.keys.each { |k| p k }
hash.values.each { |v| p v }
hash.each { |k, _v| p k }
hash.each { |_k, v| p v }
# good
hash.each_key { |k| p k }
hash.each_value { |v| p v }
Use each_key
instead of keys.each
. Open
my_ports.keys.each do |my_port|
- Read upRead up
- Exclude checks
This cop checks for uses of each_key
and each_value
Hash methods.
Note: If you have an array of two-element arrays, you can put parentheses around the block arguments to indicate that you're not working with a hash, and suppress RuboCop offenses.
Example:
# bad
hash.keys.each { |k| p k }
hash.values.each { |v| p v }
hash.each { |k, _v| p k }
hash.each { |_k, v| p v }
# good
hash.each_key { |k| p k }
hash.each_value { |v| p v }
Freeze mutable objects assigned to constants. Open
DEFAULTS = {
'MetaOptions' => {},
'OpenStdin' => false,
'AttachStdin' => false,
'AttachStdout' => false,
- Read upRead up
- Exclude checks
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
Redundant return
detected. Open
return true
- Read upRead up
- Exclude checks
This cop checks for redundant return
expressions.
Example:
def test
return something
end
def test
one
two
three
return something
end
It should be extended to handle methods whose body is if/else or a case expression with a default branch.
Avoid the use of Perl-style backrefs. Open
.gsub(/(?:_)([a-z\d]*)/i) { $1.capitalize }
- Read upRead up
- Exclude checks
This cop looks for uses of Perl-style regexp match backreferences like $1, $2, etc.
Example:
# bad
puts $1
# good
puts Regexp.last_match(1)