Sign upLogin

sanger/sequencescape

View on GitHub
Star
app/api/core/io/list.rb

Summary

Maintainability
A
25 mins
Test Coverage
F
50%

Core::Io::List has at least 5 instance variables
Open

class Core::Io::List
Severity: Minor
Found in app/api/core/io/list.rb by reek

Too Many Instance Variables is a special case of LargeClass.

Example

Given this configuration

TooManyInstanceVariables:
  max_instance_variables: 3

and this code:

class TooManyInstanceVariables
  def initialize
    @arg_1 = :dummy
    @arg_2 = :dummy
    @arg_3 = :dummy
    @arg_4 = :dummy
  end
end

Reek would emit the following warning:

test.rb -- 5 warnings:
  [1]:TooManyInstanceVariables has at least 4 instance variables (TooManyInstanceVariables)

Core::Io::List has no descriptive comment
Open

class Core::Io::List
Severity: Minor
Found in app/api/core/io/list.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

Method pagination_actions has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

  def pagination_actions
    {
      first: action_for_page(1),
      last: action_for_page(@last_page),
      read: action_for_page(@current_page)
Severity: Minor
Found in app/api/core/io/list.rb - About 25 mins to fix

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

Core::Io::List#initialize has the variable name 'o'
Open

    @objects = objects.map { |o| Core::Io::Registry.instance.lookup(o.class).create!(@container, o) }
Severity: Minor
Found in app/api/core/io/list.rb by reek

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.

There are no issues that match your filters.

Category
Status