Sign upLogin

sanger/sequencescape

View on GitHub
Star
app/models/batch/state_machine_behaviour.rb

Summary

Maintainability
A
1 hr
Test Coverage
A
96%

Complex method Batch::StateMachineBehaviour::included (50.3)
Open

  def self.included(base) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
    base.class_eval do
      include AASM
      aasm column: :state, whiny_persistence: true do
        state :pending, initial: true
Severity: Minor
Found in app/models/batch/state_machine_behaviour.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

Complex method Batch::StateMachineBehaviour#create_release_batch_event_for (30.8)
Open

  def create_release_batch_event_for(user) # rubocop:todo Metrics/AbcSize
    lab_events
      .create!(batch: self, user: user, description: 'Released')
      .tap do |event|
        event.add_descriptor Descriptor.new(name: 'workflow_id', value: workflow.id)
Severity: Minor
Found in app/models/batch/state_machine_behaviour.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 29 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def self.included(base) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
    base.class_eval do
      include AASM
      aasm column: :state, whiny_persistence: true do
        state :pending, initial: true
Severity: Minor
Found in app/models/batch/state_machine_behaviour.rb - About 1 hr to fix

    Batch::StateMachineBehaviour#create_release_batch_event_for has approx 6 statements
    Open

      def create_release_batch_event_for(user) # rubocop:todo Metrics/AbcSize
    Severity: Minor
    Found in app/models/batch/state_machine_behaviour.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.)

    Batch::StateMachineBehaviour#self.included has approx 24 statements
    Open

      def self.included(base) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
    Severity: Minor
    Found in app/models/batch/state_machine_behaviour.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.)

    Batch::StateMachineBehaviour has no descriptive comment
    Open

    module Batch::StateMachineBehaviour
    Severity: Minor
    Found in app/models/batch/state_machine_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

    Batch::StateMachineBehaviour#create_release_batch_event_for calls 'workflow.name' 3 times
    Open

            event.add_descriptor Descriptor.new(name: 'workflow', value: "Released from #{workflow.name}")
        event.add_descriptor Descriptor.new(name: 'task', value: workflow.name)
        event.add_descriptor Descriptor.new(name: 'Released', value: workflow.name)
    Severity: Minor
    Found in app/models/batch/state_machine_behaviour.rb by reek

    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.

    There are no issues that match your filters.

    Category
    Status