Sign upLogin

sanger/sequencescape

View on GitHub
Star
app/models/qcable/statemachine.rb

Summary

Maintainability
A
1 hr
Test Coverage
A
100%

Complex method Qcable::Statemachine::included (53.2)
Open

  def self.included(base) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
    base.class_eval do
      ## State machine
      ## namespace: true as destroyed clashes with rails, but we can't easily rename the state
      aasm column: :state, whiny_persistence: true, namespace: true, name: 'qc_state' do
Severity: Minor
Found in app/models/qcable/statemachine.rb by flog

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

Method included has 36 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def self.included(base) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
    base.class_eval do
      ## State machine
      ## namespace: true as destroyed clashes with rails, but we can't easily rename the state
      aasm column: :state, whiny_persistence: true, namespace: true, name: 'qc_state' do
Severity: Minor
Found in app/models/qcable/statemachine.rb - About 1 hr to fix

    Qcable::Statemachine#self.included has approx 30 statements
    Open

      def self.included(base) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
    Severity: Minor
    Found in app/models/qcable/statemachine.rb by reek

    A method with Too Many Statements is any method that has a large number of lines.

    Too Many Statements warns about any method that has more than 5 statements. Reek's smell detector for Too Many Statements counts +1 for every simple statement in a method and +1 for every statement within a control structure (if, else, case, when, for, while, until, begin, rescue) but it doesn't count the control structure itself.

    So the following method would score +6 in Reek's statement-counting algorithm:

    def parse(arg, argv, &error)
  if !(val = arg) and (argv.empty? or /\A-/ =~ (val = argv[0]))
    return nil, block, nil                                         # +1
  end
  opt = (val = parse_arg(val, &error))[1]                          # +2
  val = conv_arg(*val)                                             # +3
  if opt and !arg
    argv.shift                                                     # +4
  else
    val[0] = nil                                                   # +5
  end
  val                                                              # +6
end

    (You might argue that the two assigments within the first @if@ should count as statements, and that perhaps the nested assignment should count as +2.)

    Qcable::Statemachine has no descriptive comment
    Open

    module Qcable::Statemachine
    Severity: Minor
    Found in app/models/qcable/statemachine.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

    Qcable::Statemachine#permit_automatic_transition? doesn't depend on instance state (maybe move it to another class?)
    Open

      def permit_automatic_transition?(event)
    Severity: Minor
    Found in app/models/qcable/statemachine.rb by reek

    A Utility Function is any instance method that has no dependency on the state of the instance.

    Qcable::Statemachine#default_state performs a nil-check
    Open

        return :created if lot.nil?
    Severity: Minor
    Found in app/models/qcable/statemachine.rb by reek

    A NilCheck is a type check. Failures of NilCheck violate the "tell, don't ask" principle.

    Additionally, type checks often mask bigger problems in your source code like not using OOP and / or polymorphism when you should.

    Example

    Given

    class Klass
  def nil_checker(argument)
    if argument.nil?
      puts "argument isn't nil!"
    end
  end
end

    Reek would emit the following warning:

    test.rb -- 1 warning:
  [3]:Klass#nil_checker performs a nil-check. (NilCheck)

    There are no issues that match your filters.

    Category
    Status