Module has too many lines. [115/100] Open
module RssHelper
# ROB: Methods pulled from oai_dc_helpers.rb and simplified to return strings/nil
# So far only used for StillImages. May need some more tweaking for other content-types.
def rss_dc_identifier(item)
- Read upRead up
- Exclude checks
This cop checks if the length a module exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.
Method has too many lines. [15/10] Open
def rss_link_for(item)
# For some reason `url_for[ item.basket, item]` gives us *_path rather than *_url strings.
if item.is_a? AudioRecording
basket_audio_recording_url(item.basket, item)
elsif item.is_a? Document
- 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.
Assignment Branch Condition size for rss_link_for is too high. [18.97/15] Open
def rss_link_for(item)
# For some reason `url_for[ item.basket, item]` gives us *_path rather than *_url strings.
if item.is_a? AudioRecording
basket_audio_recording_url(item.basket, item)
elsif item.is_a? Document
- 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 rss_link_for is too high. [7/6] Open
def rss_link_for(item)
# For some reason `url_for[ item.basket, item]` gives us *_path rather than *_url strings.
if item.is_a? AudioRecording
basket_audio_recording_url(item.basket, item)
elsif item.is_a? Document
- 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 rss_link_for is too high. [8/7] Open
def rss_link_for(item)
# For some reason `url_for[ item.basket, item]` gives us *_path rather than *_url strings.
if item.is_a? AudioRecording
basket_audio_recording_url(item.basket, item)
elsif item.is_a? Document
- 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 rss_link_for
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
def rss_link_for(item)
# For some reason `url_for[ item.basket, item]` gives us *_path rather than *_url strings.
if item.is_a? AudioRecording
basket_audio_recording_url(item.basket, item)
elsif item.is_a? Document
- 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
Redundant else
-clause. Open
else
- Read upRead up
- Exclude checks
Checks for empty else-clauses, possibly including comments and/or an
explicit nil
depending on the EnforcedStyle.
Example: EnforcedStyle: empty
# warn only on empty else
# bad
if condition
statement
else
end
# good
if condition
statement
else
nil
end
# good
if condition
statement
else
statement
end
# good
if condition
statement
end
Example: EnforcedStyle: nil
# warn on else with nil in it
# bad
if condition
statement
else
nil
end
# good
if condition
statement
else
end
# good
if condition
statement
else
statement
end
# good
if condition
statement
end
Example: EnforcedStyle: both (default)
# warn on empty else and else with nil in it
# bad
if condition
statement
else
nil
end
# bad
if condition
statement
else
end
# good
if condition
statement
else
statement
end
# good
if condition
statement
end
Unused method argument - item
. If it's necessary, use _
or _item
as an argument name to indicate that it won't be used. You can also write as rss_dc_publisher(*)
if you want the method to accept any arguments but don't care about them. Open
def rss_dc_publisher(item)
- Read upRead up
- Exclude checks
This cop checks for unused method arguments.
Example:
# bad
def some_method(used, unused, _unused_but_allowed)
puts used
end
Example:
# good
def some_method(used, _unused, _unused_but_allowed)
puts used
end