Sign upLogin

sanger/sequencescape

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

Summary

Maintainability
A
0 mins
Test Coverage
B
89%

Core::Endpoint::BasicHandler::Paged::PagedTarget has no descriptive comment
Open

  class PagedTarget
Severity: Minor
Found in app/api/core/endpoint/basic_handler/paged.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::Paged::PagedTarget::PageOfResults has no descriptive comment
Open

    class PageOfResults
Severity: Minor
Found in app/api/core/endpoint/basic_handler/paged.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::Paged has no descriptive comment
Open

module Core::Endpoint::BasicHandler::Paged
Severity: Minor
Found in app/api/core/endpoint/basic_handler/paged.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::Paged::PagedTarget#paginate doesn't depend on instance state (maybe move it to another class?)
Open

    def paginate(options)
Severity: Minor
Found in app/api/core/endpoint/basic_handler/paged.rb by reek

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

Core::Endpoint::BasicHandler::Paged#self.page_accessor performs a nil-check
Open

      page.nil? ? nil : [action, [1, page].max]
Severity: Minor
Found in app/api/core/endpoint/basic_handler/paged.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