SampleManifestExcel::Tags::AliquotUpdater#update calls 'attributes[:tag_group]' 2 times Open
attributes[:tag_group]
.tags
.find_or_create_by(oligo: value) { |t| t.map_id = attributes[:tag_group].tags.count + 1 }
- 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.
SampleManifestExcel::Tags::AliquotUpdater#update calls 'attributes[:tag_group]; .tags' 2 times Open
attributes[:tag_group]
.tags
.find_or_create_by(oligo: value) { |t| t.map_id = attributes[:tag_group].tags.count + 1 }
- 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.
SampleManifestExcel::Tags::AliquotUpdater::ClassMethods has no descriptive comment Open
module ClassMethods
- 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
Complex method SampleManifestExcel::Tags::AliquotUpdater#update (20.0) Open
def update(attributes = {})
return unless valid?
tag =
if value.present?
- Read upRead up
- Exclude checks
Flog calculates the ABC score for methods. The ABC score is based on assignments, branches (method calls), and conditions.
You can read more about ABC metrics or the flog tool
SampleManifestExcel::Tags::AliquotUpdater#update has the variable name 't' Open
.find_or_create_by(oligo: value) { |t| t.map_id = attributes[:tag_group].tags.count + 1 }
- 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.
TODO found Open
# TODO: Add specific tests
- Exclude checks