Sign upLogin

nicholalexander/basket

View on GitHub
Star
lib/basket/queue_collection.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
100%

Basket::QueueCollection has no descriptive comment
Open

  class QueueCollection
Severity: Minor
Found in lib/basket/queue_collection.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

Basket::QueueCollection#check_for_raw_removed_element performs a nil-check
Open

      raise Basket::ElementNotFoundError if raw_removed_element.nil?
Severity: Minor
Found in lib/basket/queue_collection.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