Sign upLogin

sanger/sequencescape

View on GitHub
Star
app/api/core/endpoint/basic_handler/actions/factory.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
100%

Core::Endpoint::BasicHandler::Actions::Factory::Nested#separate contains iterators nested 4 deep
Open

              actions(object, options.merge(target: object)).map { |action, url| action_stream.attribute(action, url) }
Severity: Minor
Found in app/api/core/endpoint/basic_handler/actions/factory.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::Endpoint::BasicHandler::Actions::Factory::Nested has no descriptive comment
Open

  class Nested < Core::Endpoint::BasicHandler
Severity: Minor
Found in app/api/core/endpoint/basic_handler/actions/factory.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

Core::Endpoint::BasicHandler::Actions::Factory has no descriptive comment
Open

module Core::Endpoint::BasicHandler::Actions::Factory
Severity: Minor
Found in app/api/core/endpoint/basic_handler/actions/factory.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