Core::Endpoint::BasicHandler::Actions::Standard::InstanceMethods has no descriptive comment Open
module InstanceMethods
- Read upRead up
- Exclude checks
Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.
Example
Given
class Dummy
# Do things...
end
Reek would emit the following warning:
test.rb -- 1 warning:
[1]:Dummy has no descriptive comment (IrresponsibleModule)
Fixing this is simple - just an explaining comment:
# The Dummy class is responsible for ...
class Dummy
# Do things...
end
Core::Endpoint::BasicHandler::Actions::Standard#standard_action calls 'a.to_sym' 2 times Open
standard_actions.merge!(names.to_h { |a| [a.to_sym, a.to_sym] })
- Read upRead up
- Exclude checks
Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.
Reek implements a check for Duplicate Method Call.
Example
Here's a very much simplified and contrived example. The following method will report a warning:
def double_thing()
@other.thing + @other.thing
end
One quick approach to silence Reek would be to refactor the code thus:
def double_thing()
thing = @other.thing
thing + thing
end
A slightly different approach would be to replace all calls of double_thing
by calls to @other.double_thing
:
class Other
def double_thing()
thing + thing
end
end
The approach you take will depend on balancing other factors in your code.
Core::Endpoint::BasicHandler::Actions::Standard has no descriptive comment Open
module Core::Endpoint::BasicHandler::Actions::Standard
- Read upRead up
- Exclude checks
Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.
Example
Given
class Dummy
# Do things...
end
Reek would emit the following warning:
test.rb -- 1 warning:
[1]:Dummy has no descriptive comment (IrresponsibleModule)
Fixing this is simple - just an explaining comment:
# The Dummy class is responsible for ...
class Dummy
# Do things...
end
Core::Endpoint::BasicHandler::Actions::Standard::InstanceMethods#standard_update! doesn't depend on instance state (maybe move it to another class?) Open
def standard_update!(request, _)
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
Core::Endpoint::BasicHandler::Actions::Standard::InstanceMethods#standard_create! doesn't depend on instance state (maybe move it to another class?) Open
def standard_create!(request, _)
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
Core::Endpoint::BasicHandler::Actions::Standard#standard_action has the variable name 'a' Open
standard_actions.merge!(names.to_h { |a| [a.to_sym, a.to_sym] })
- Read upRead up
- Exclude checks
An Uncommunicative Variable Name
is a variable name that doesn't communicate its intent well enough.
Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.