Method tripped?
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
def tripped?(entry)
if entry.dup_count < duplicate_threshold
reset(entry) if entry.blocked_count > 0
return false
end
- Read upRead up
- Create a ticketCreate a ticket
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
:count
member overrides Struct#count
and it may be unexpected. Open
TimeSlot = Struct.new(:timestamp, :count)
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
Checks unexpected overrides of the Struct
built-in methods
via Struct.new
.
Example:
# bad
Bad = Struct.new(:members, :clone, :count)
b = Bad.new([], true, 1)
b.members #=> [] (overriding `Struct#members`)
b.clone #=> true (overriding `Object#clone`)
b.count #=> 1 (overriding `Enumerable#count`)
# good
Good = Struct.new(:id, :name)
g = Good.new(1, "foo")
g.members #=> [:id, :name]
g.clone #=> #<struct good id="1," name="foo">
g.count #=> 2</struct>
Wrap expressions with varying precedence with parentheses to avoid ambiguity. Open
new_timestamp = last_timestamp + ((now - last_timestamp) / slot_width).to_int * slot_width
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
Looks for expressions containing multiple binary operators
where precedence is ambiguous due to lack of parentheses. For example,
in 1 + 2 * 3
, the multiplication will happen before the addition, but
lexically it appears that the addition will happen first.
The cop does not consider unary operators (ie. !a
or -b
) or comparison
operators (ie. a =~ b
) because those are not ambiguous.
NOTE: Ranges are handled by Lint/AmbiguousRange
.
Example:
# bad
a + b * c
a || b && c
a ** b + c
# good (different precedence)
a + (b * c)
a || (b && c)
(a ** b) + c
# good (same precedence)
a + b + c
a * b / c % d