Method deliver_approved_notification has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open
def deliver_approved_notification
if buyer? && approval_required?
unless admins.empty? || admins.first.created_by_provider_signup?
run_after_commit do
AccountMailer.approved(self).deliver_later- 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
Account::States#deliver_rejected_notification performs a nil-check Open
unless admins.empty? || self.provider_account.nil?- Read upRead up
- Exclude checks
A NilCheck is a type check. Failures of NilCheck violate the "tell, don't ask" principle.
Additionally, type checks often mask bigger problems in your source code like not using OOP and / or polymorphism when you should.
Example
Given
class Klass
def nil_checker(argument)
if argument.nil?
puts "argument isn't nil!"
end
end
endReek would emit the following warning:
test.rb -- 1 warning:
[3]:Klass#nil_checker performs a nil-check. (NilCheck)Account::States#marked_for_suspension is a writable attribute Open
attr_accessor :marked_for_suspension- Read upRead up
- Exclude checks
A class that publishes a setter for an instance variable invites client classes to become too intimate with its inner workings, and in particular with its representation of state.
The same holds to a lesser extent for getters, but Reek doesn't flag those.
Example
Given:
class Klass
attr_accessor :dummy
endReek would emit the following warning:
reek test.rb
test.rb -- 1 warning:
[2]:Klass declares the writable attribute dummy (Attribute)