efigence/cracklib_reloaded

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

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

Classes should not assume that instance variables are set or present outside of the current class definition.

Good:

class Foo
  def initialize
    @bar = :foo
  end
 
  def foo?
    @bar == :foo
  end
end

Good as well:

class Foo
  def foo?
    bar == :foo
  end
 
  def bar
    @bar ||= :foo
  end
end

Bad:

class Foo
  def go_foo!
    @bar = :foo
  end
 
  def foo?
    @bar == :foo
  end
end

Example

Running Reek on:

class Dummy
  def test
    @ivar
  end
end

would report:

[1]:InstanceVariableAssumption: Dummy assumes too much for instance variable @ivar

Note that this example would trigger this smell warning as well:

class Parent
  def initialize(omg)
    @omg = omg
  end
end
 
class Child < Parent
  def foo
    @omg
  end
end

The way to address the smell warning is that you should create an attr_reader to use @omg in the subclass and not access @omg directly like this:

class Parent
  attr_reader :omg
 
  def initialize(omg)
    @omg = omg
  end
end
 
class Child < Parent
  def foo
    omg
  end
end

Directly accessing instance variables is considered a smell because it breaks encapsulation and makes it harder to reason about code.

If you don't want to expose those methods as public API just make them private like this:

class Parent
  def initialize(omg)
    @omg = omg
  end
 
  private
  attr_reader :omg
end
 
class Child < Parent
  def foo
    omg
  end
end

Current Support in Reek

An instance variable must:

• be set in the constructor
• or be accessed through a method with lazy initialization / memoization.

If not, Instance Variable Assumption will be reported.

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

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

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)

Dependencies in the gemspec should be alphabetically sorted.

Example:

# bad
spec.add_dependency 'rubocop'
spec.add_dependency 'rspec'
 
# good
spec.add_dependency 'rspec'
spec.add_dependency 'rubocop'
 
# good
spec.add_dependency 'rubocop'
 
spec.add_dependency 'rspec'
 
# bad
spec.add_development_dependency 'rubocop'
spec.add_development_dependency 'rspec'
 
# good
spec.add_development_dependency 'rspec'
spec.add_development_dependency 'rubocop'
 
# good
spec.add_development_dependency 'rubocop'
 
spec.add_development_dependency 'rspec'
 
# bad
spec.add_runtime_dependency 'rubocop'
spec.add_runtime_dependency 'rspec'
 
# good
spec.add_runtime_dependency 'rspec'
spec.add_runtime_dependency 'rubocop'
 
# good
spec.add_runtime_dependency 'rubocop'
 
spec.add_runtime_dependency 'rspec'
 
# good only if TreatCommentsAsGroupSeparators is true
# For code quality
spec.add_dependency 'rubocop'
# For tests
spec.add_dependency 'rspec'

Checks for if and unless statements that would fit on one line if written as a modifier if/unless. The maximum line length is configured in the Metrics/LineLength cop.

Example:

# bad
if condition
  do_stuff(bar)
end
 
unless qux.empty?
  Foo.do_something
end
 
# good
do_stuff(bar) if condition
Foo.do_something unless qux.empty?

Dependencies in the gemspec should be alphabetically sorted.

Example:

# bad
spec.add_dependency 'rubocop'
spec.add_dependency 'rspec'
 
# good
spec.add_dependency 'rspec'
spec.add_dependency 'rubocop'
 
# good
spec.add_dependency 'rubocop'
 
spec.add_dependency 'rspec'
 
# bad
spec.add_development_dependency 'rubocop'
spec.add_development_dependency 'rspec'
 
# good
spec.add_development_dependency 'rspec'
spec.add_development_dependency 'rubocop'
 
# good
spec.add_development_dependency 'rubocop'
 
spec.add_development_dependency 'rspec'
 
# bad
spec.add_runtime_dependency 'rubocop'
spec.add_runtime_dependency 'rspec'
 
# good
spec.add_runtime_dependency 'rspec'
spec.add_runtime_dependency 'rubocop'
 
# good
spec.add_runtime_dependency 'rubocop'
 
spec.add_runtime_dependency 'rspec'
 
# good only if TreatCommentsAsGroupSeparators is true
# For code quality
spec.add_dependency 'rubocop'
# For tests
spec.add_dependency 'rspec'

Dependencies in the gemspec should be alphabetically sorted.

Example:

# bad
spec.add_dependency 'rubocop'
spec.add_dependency 'rspec'
 
# good
spec.add_dependency 'rspec'
spec.add_dependency 'rubocop'
 
# good
spec.add_dependency 'rubocop'
 
spec.add_dependency 'rspec'
 
# bad
spec.add_development_dependency 'rubocop'
spec.add_development_dependency 'rspec'
 
# good
spec.add_development_dependency 'rspec'
spec.add_development_dependency 'rubocop'
 
# good
spec.add_development_dependency 'rubocop'
 
spec.add_development_dependency 'rspec'
 
# bad
spec.add_runtime_dependency 'rubocop'
spec.add_runtime_dependency 'rspec'
 
# good
spec.add_runtime_dependency 'rspec'
spec.add_runtime_dependency 'rubocop'
 
# good
spec.add_runtime_dependency 'rubocop'
 
spec.add_runtime_dependency 'rspec'
 
# good only if TreatCommentsAsGroupSeparators is true
# For code quality
spec.add_dependency 'rubocop'
# For tests
spec.add_dependency 'rspec'

Dependencies in the gemspec should be alphabetically sorted.

Example:

# bad
spec.add_dependency 'rubocop'
spec.add_dependency 'rspec'
 
# good
spec.add_dependency 'rspec'
spec.add_dependency 'rubocop'
 
# good
spec.add_dependency 'rubocop'
 
spec.add_dependency 'rspec'
 
# bad
spec.add_development_dependency 'rubocop'
spec.add_development_dependency 'rspec'
 
# good
spec.add_development_dependency 'rspec'
spec.add_development_dependency 'rubocop'
 
# good
spec.add_development_dependency 'rubocop'
 
spec.add_development_dependency 'rspec'
 
# bad
spec.add_runtime_dependency 'rubocop'
spec.add_runtime_dependency 'rspec'
 
# good
spec.add_runtime_dependency 'rspec'
spec.add_runtime_dependency 'rubocop'
 
# good
spec.add_runtime_dependency 'rubocop'
 
spec.add_runtime_dependency 'rspec'
 
# good only if TreatCommentsAsGroupSeparators is true
# For code quality
spec.add_dependency 'rubocop'
# For tests
spec.add_dependency 'rspec'