Y24-121 - Refactoring validations for pipelines #4150
4135-y24-121-as-a-developer-ben-i-would-like-there-to-be-fine-grained-batch-creation-validation-for-sequencing-pipelines
into develop
BatchCreationValidator#batch_meets_minimum_size calls 'record.min_size' 3 times New
return unless record.min_size && (record.requests.size < record.min_size)
record.errors.add :base, "You must create batches of at least #{record.min_size}
- 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.
BatchCreationValidator#all_requests_are_ready? doesn't depend on instance state (maybe move it to another class?) New
def all_requests_are_ready?(record)
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
BatchCreationValidator#batch_meets_minimum_size doesn't depend on instance state (maybe move it to another class?) New
def batch_meets_minimum_size(record)
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
BatchCreationValidator#requests_have_same_flowcell_type doesn't depend on instance state (maybe move it to another class?) New
def requests_have_same_flowcell_type(record)
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
BatchCreationValidator#requests_have_same_read_length doesn't depend on instance state (maybe move it to another class?) New
def requests_have_same_read_length(record)
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
BatchCreationValidator#requests_have_same_target_purpose doesn't depend on instance state (maybe move it to another class?) New
def requests_have_same_target_purpose(record)
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
DefaultValidator has no descriptive comment New
class DefaultValidator < CustomValidatorBase
- 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
NovaSeq6000Validator has no descriptive comment New
class NovaSeq6000Validator < CustomValidatorBase
- 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
NovaSeq6000Validator#validate doesn't depend on instance state (maybe move it to another class?) New
def validate(record)
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
CustomValidatorBase#validate has unused parameter 'record' New
def validate(record)
- Read upRead up
- Exclude checks
Unused Parameter
refers to methods with parameters that are unused in scope of the method.
Having unused parameters in a method is code smell because leaving dead code in a method can never improve the method and it makes the code confusing to read.
Example
Given:
class Klass
def unused_parameters(x,y,z)
puts x,y # but not z
end
end
Reek would emit the following warning:
[2]:Klass#unused_parameters has unused parameter 'z' (UnusedParameters)
DynamicValidations#get_validator_class doesn't depend on instance state (maybe move it to another class?) New
def get_validator_class(pipeline)
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
Category
Status
File | Maintainability |
lib/custom_validator_base.rb | |
app/validators/nova_seq6000_validator.rb | |
app/validators/batch_creation_validator.rb | |
app/validators/default_validator.rb | |
lib/dynamic_validations.rb |