Sign upLogin

sanger/sequencescape

View on GitHub
Star
app/models/qc_report.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
91%

Complex method QcReport::ReportBehaviour#generate_report (39.8)
Open

    def generate_report # rubocop:todo Metrics/AbcSize
      begin
        study.each_well_for_qc_report_in_batches(
          exclude_existing,
          product_criteria,
Severity: Minor
Found in app/models/qc_report.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 QcReport::StateMachine::included (30.5)
Open

    def self.included(base) # rubocop:todo Metrics/AbcSize
      base.class_eval do
        # When adding new states, please make sure you update the config/locals/en.yml file
        # with descriptions.
Severity: Minor
Found in app/models/qc_report.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

QcReport::ReportBehaviour#generate_report contains iterators nested 2 deep
Open

            assets.each do |asset|
Severity: Minor
Found in app/models/qc_report.rb by reek

A Nested Iterator occurs when a block contains another block.

Example

Given

class Duck
  class << self
    def duck_names
      %i!tick trick track!.each do |surname|
        %i!duck!.each do |last_name|
          puts "full name is #{surname} #{last_name}"
        end
      end
    end
  end
end

Reek would report the following warning:

test.rb -- 1 warning:
  [5]:Duck#duck_names contains iterators nested 2 deep (NestedIterators)

QcReport::ReportBehaviour#generate_report has approx 12 statements
Open

    def generate_report # rubocop:todo Metrics/AbcSize
Severity: Minor
Found in app/models/qc_report.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.)

QcReport::StateMachine#self.included has approx 17 statements
Open

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

Complex method QcReport#generate_report_identifier (25.3)
Open

  def generate_report_identifier
    return true if study.nil? || product_criteria.nil?

    rid =
      [study.abbreviation, product_criteria.product.name, DateTime.now.to_formatted_s(:number)].compact
Severity: Minor
Found in app/models/qc_report.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

QcReport has no descriptive comment
Open

class QcReport < ApplicationRecord
Severity: Minor
Found in app/models/qc_report.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

QcReport::ReportBehaviour has no descriptive comment
Open

  module ReportBehaviour
Severity: Minor
Found in app/models/qc_report.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

QcReport::StateMachine has no descriptive comment
Open

  module StateMachine
Severity: Minor
Found in app/models/qc_report.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

QcReport::StateMachine::ClassMethods has no descriptive comment
Open

    module ClassMethods
Severity: Minor
Found in app/models/qc_report.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

QcReport#identifier_required? performs a nil-check
Open

    report_identifier.nil?
Severity: Minor
Found in app/models/qc_report.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)

QcReport#generate_report_identifier performs a nil-check
Open

    return true if study.nil? || product_criteria.nil?
Severity: Minor
Found in app/models/qc_report.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)

QcReport::StateMachine::ClassMethods#available_states doesn't depend on instance state (maybe move it to another class?)
Open

      def available_states
Severity: Minor
Found in app/models/qc_report.rb by reek

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

QcReport::ReportBehaviour#generate_report has the variable name 'e'
Open

      rescue => e
Severity: Minor
Found in app/models/qc_report.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