Method has too many lines. [14/10] Open
def self.get_lock(lockable, user, timeout)
return nil if lockable.nil? || user.nil?
lock = find_by(lockable: lockable)
return create_lock(lockable, user, timeout) if lock.nil?
- 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 get_lock is too high. [19.67/15] Open
def self.get_lock(lockable, user, timeout)
return nil if lockable.nil? || user.nil?
lock = find_by(lockable: lockable)
return create_lock(lockable, user, timeout) if lock.nil?
- 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
Method get_lock
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
def self.get_lock(lockable, user, timeout)
return nil if lockable.nil? || user.nil?
lock = find_by(lockable: lockable)
return create_lock(lockable, user, timeout) if lock.nil?
- 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
Use a guard clause instead of wrapping the code inside a conditional expression. Open
if lock.nil?
- 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
Prefer Date or Time over DateTime. Open
if lock.created_at + lock.timeout_period.minutes <= DateTime.now
- Read upRead up
- Exclude checks
This cop checks for uses of DateTime
that should be replaced by
Date
or Time
.
Example:
# bad - uses `DateTime` for current time
DateTime.now
# good - uses `Time` for current time
Time.now
# bad - uses `DateTime` for modern date
DateTime.iso8601('2016-06-29')
# good - uses `Date` for modern date
Date.iso8601('2016-06-29')
# good - uses `DateTime` with start argument for historical date
DateTime.iso8601('1751-04-23', Date::ENGLAND)