Sign upLogin

sanger/sequencescape

View on GitHub
Star
app/api/core/io/base/eager_loading_behaviour.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
100%

Core::Io::Base::EagerLoadingBehaviour#eager_loading_for is controlled by argument 'model'
Open

    model or raise StandardError, 'nil model does not make sense here at all!'
Severity: Minor
Found in app/api/core/io/base/eager_loading_behaviour.rb by reek

Control Parameter is a special case of Control Couple

Example

A simple example would be the "quoted" parameter in the following method:

def write(quoted)
  if quoted
    write_quoted @value
  else
    write_unquoted @value
  end
end

Fixing those problems is out of the scope of this document but an easy solution could be to remove the "write" method alltogether and to move the calls to "writequoted" / "writeunquoted" in the initial caller of "write".

Core::Io::Base::EagerLoadingBehaviour has no descriptive comment
Open

module Core::Io::Base::EagerLoadingBehaviour
Severity: Minor
Found in app/api/core/io/base/eager_loading_behaviour.rb by reek

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

There are no issues that match your filters.

Category
Status