Method has too many lines. [15/10] Open
def add_georadius_opts!(args, opts)
args << :WITHCOORD if opts[:withcoord]
args << :WITHDIST if opts[:withdist]
args << :WITHHASH if opts[:withhash]
- 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.
Cyclomatic complexity for add_georadius_opts! is too high. [8/6] Open
def add_georadius_opts!(args, opts)
args << :WITHCOORD if opts[:withcoord]
args << :WITHDIST if opts[:withdist]
args << :WITHHASH if opts[:withhash]
- 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.
Assignment Branch Condition size for add_georadius_opts! is too high. [16.16/15] Open
def add_georadius_opts!(args, opts)
args << :WITHCOORD if opts[:withcoord]
args << :WITHDIST if opts[:withdist]
args << :WITHHASH if opts[:withhash]
- 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
Perceived complexity for add_georadius_opts! is too high. [8/7] Open
def add_georadius_opts!(args, opts)
args << :WITHCOORD if opts[:withcoord]
args << :WITHDIST if opts[:withdist]
args << :WITHHASH if opts[:withhash]
- 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 georadius
has 6 arguments (exceeds 4 allowed). Consider refactoring. Open
def georadius(key, longitude, latitude, radius, unit, opts = {})
Method georadiusbymember
has 5 arguments (exceeds 4 allowed). Consider refactoring. Open
def georadiusbymember(key, member, radius, unit, opts = {})
Method add_georadius_opts!
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
def add_georadius_opts!(args, opts)
args << :WITHCOORD if opts[:withcoord]
args << :WITHDIST if opts[:withdist]
args << :WITHHASH if opts[:withhash]
- 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
Avoid parameter lists longer than 5 parameters. [6/5] Open
def georadius(key, longitude, latitude, radius, unit, opts = {})
- Read upRead up
- Exclude checks
This cop checks for methods with too many parameters. The maximum number of parameters is configurable. Keyword arguments can optionally be excluded from the total count.
Use ==
if you meant to do a comparison or wrap the expression in parentheses to indicate you meant to assign in a condition. Open
if order = opts[:order]
- Read upRead up
- Exclude checks
This cop checks for assignments in the conditions of if/while/until.
Example:
# bad
if some_var = true
do_something
end
Example:
# good
if some_var == true
do_something
end
Use ==
if you meant to do a comparison or wrap the expression in parentheses to indicate you meant to assign in a condition. Open
if store_key = opts[:store]
- Read upRead up
- Exclude checks
This cop checks for assignments in the conditions of if/while/until.
Example:
# bad
if some_var = true
do_something
end
Example:
# good
if some_var == true
do_something
end
Line is too long. [86/80] Open
# @option opts [Integer] :count limit the results to the first N matching items.
- Exclude checks
Line is too long. [82/80] Open
# not including elements already existing for which the score was updated.
- Exclude checks
Missing top-level module documentation comment. Open
module Geo
- Read upRead up
- Exclude checks
This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.
The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.
Example:
# bad
class Person
# ...
end
# good
# Description/Explanation of Person class
class Person
# ...
end
Line is too long. [81/80] Open
# defaults to meters: m (meters), km (kilometers), mi (miles), ft (feet).
- Exclude checks
Line is too long. [81/80] Open
# sorted set score of the item, in the form of a 52 bit unsigned integer.
- Exclude checks
Line is too long. [81/80] Open
# sorted set score of the item, in the form of a 52 bit unsigned integer.
- Exclude checks
Use a guard clause instead of wrapping the code inside a conditional expression. Open
if storedist_key = opts[:storedist]
- Read upRead up
- Exclude checks
Use a guard clause instead of wrapping the code inside a conditional expression
Example:
# bad
def test
if something
work
end
end
# good
def test
return unless something
work
end
# also good
def test
work if something
end
# bad
if something
raise 'exception'
else
ok
end
# good
raise 'exception' if something
ok
Line is too long. [81/80] Open
# items. Two different sorting methods can be invoked using the following
- Exclude checks
Line is too long. [90/80] Open
# the Geohash corresponding to each member name passed as argument to the command.
- Exclude checks
Line is too long. [86/80] Open
# @option opts [Integer] :count limit the results to the first N matching items.
- Exclude checks
Line is too long. [81/80] Open
# items. Two different sorting methods can be invoked using the following
- Exclude checks
Use ==
if you meant to do a comparison or wrap the expression in parentheses to indicate you meant to assign in a condition. Open
if count = opts[:count]
- Read upRead up
- Exclude checks
This cop checks for assignments in the conditions of if/while/until.
Example:
# bad
if some_var = true
do_something
end
Example:
# good
if some_var == true
do_something
end
Use ==
if you meant to do a comparison or wrap the expression in parentheses to indicate you meant to assign in a condition. Open
if storedist_key = opts[:storedist]
- Read upRead up
- Exclude checks
This cop checks for assignments in the conditions of if/while/until.
Example:
# bad
if some_var = true
do_something
end
Example:
# good
if some_var == true
do_something
end