Sign upLogin

sanger/sequencescape

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

Summary

Maintainability
A
0 mins
Test Coverage
A
100%

Complex method Core::Io::Base::JsonFormattingBehaviour::Output#generate_object_to_json_mapping (38.7)
Open

  def generate_object_to_json_mapping(attribute_to_json) # rubocop:todo Metrics/AbcSize
    # Sort the attribute_to_json map such that the JSON elements are in order, thus ensuring that
    # we will only open and close blocks as we go.  Then build a tree that can be executed against
    # an object to generate the JSON appropriately.
    tree =
Severity: Minor
Found in app/api/core/io/base/json_formatting_behaviour/output.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

Core::Io::Base::JsonFormattingBehaviour::Output#generate_object_to_json_mapping has approx 9 statements
Open

  def generate_object_to_json_mapping(attribute_to_json) # rubocop:todo Metrics/AbcSize
Severity: Minor
Found in app/api/core/io/base/json_formatting_behaviour/output.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.)

Core::Io::Base::JsonFormattingBehaviour::Output#generate_object_to_json_mapping contains iterators nested 2 deep
Open

            json_path.inject(tree) { |node, step| node[step] }.leaf(json_leaf, attribute_path)
Severity: Minor
Found in app/api/core/io/base/json_formatting_behaviour/output.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)

Core::Io::Base::JsonFormattingBehaviour::Output has no descriptive comment
Open

module Core::Io::Base::JsonFormattingBehaviour::Output
Severity: Minor
Found in app/api/core/io/base/json_formatting_behaviour/output.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