Redundant return
detected. Open
return 'class="danger"'
- Read upRead up
- Exclude checks
This cop checks for redundant return
expressions.
Example:
def test
return something
end
def test
one
two
three
return something
end
It should be extended to handle methods whose body is if/else or a case expression with a default branch.
Redundant return
detected. Open
return ''
- Read upRead up
- Exclude checks
This cop checks for redundant return
expressions.
Example:
def test
return something
end
def test
one
two
three
return something
end
It should be extended to handle methods whose body is if/else or a case expression with a default branch.
Keep a blank line before and after private
. Open
private
- Read upRead up
- Exclude checks
Access modifiers should be surrounded by blank lines.
Example:
# bad
class Foo
def bar; end
private
def baz; end
end
# good
class Foo
def bar; end
private
def baz; end
end
Missing magic comment # frozen_string_literal: true
. Open
module PeopleHelper
- Read upRead up
- Exclude checks
This cop is designed to help upgrade to Ruby 3.0. It will add the
comment # frozen_string_literal: true
to the top of files to
enable frozen string literals. Frozen string literals may be default
in Ruby 3.0. The comment will be added below a shebang and encoding
comment. The frozen string literal comment is only valid in Ruby 2.3+.
Example: EnforcedStyle: when_needed (default)
# The `when_needed` style will add the frozen string literal comment
# to files only when the `TargetRubyVersion` is set to 2.3+.
# bad
module Foo
# ...
end
# good
# frozen_string_literal: true
module Foo
# ...
end
Example: EnforcedStyle: always
# The `always` style will always add the frozen string literal comment
# to a file, regardless of the Ruby version or if `freeze` or `<<` are
# called on a string literal.
# bad
module Bar
# ...
end
# good
# frozen_string_literal: true
module Bar
# ...
end
Example: EnforcedStyle: never
# The `never` will enforce that the frozen string literal comment does
# not exist in a file.
# bad
# frozen_string_literal: true
module Baz
# ...
end
# good
module Baz
# ...
end
Missing top-level module documentation comment. Open
module PeopleHelper
- Read upRead up
- Exclude checks
This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.
The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.
Example:
# bad
class Person
# ...
end
# good
# Description/Explanation of Person class
class Person
# ...
end
Do not put a space between a method name and the opening parenthesis. Open
def display_date_with_days_hint (person, field_name)
- Read upRead up
- Exclude checks
Checks for space between a method name and a left parenthesis in defs.
Example:
# bad
def func (x) end
def method= (y) end
# good
def func(x) end
def method=(y) end
Incorrect indentation detected (column 2 instead of 4). Open
# return 1/0
- Read upRead up
- Exclude checks
This cops checks the indentation of comments.
Example:
# bad
# comment here
def method_name
end
# comment here
a = 'hello'
# yet another comment
if true
true
end
# good
# comment here
def method_name
end
# comment here
a = 'hello'
# yet another comment
if true
true
end
Line is too long. [86/80] Open
html += distance_of_time_in_words(person.send(field_name), Time.zone.today) + '" '
- Exclude checks
Do not put a space between a method name and the opening parenthesis. Open
def display_hours_worked (person)
- Read upRead up
- Exclude checks
Checks for space between a method name and a left parenthesis in defs.
Example:
# bad
def func (x) end
def method= (y) end
# good
def func(x) end
def method=(y) end
Do not put a space between a method name and the opening parenthesis. Open
def td_class_string (person, field_name)
- Read upRead up
- Exclude checks
Checks for space between a method name and a left parenthesis in defs.
Example:
# bad
def func (x) end
def method= (y) end
# good
def func(x) end
def method=(y) end
Redundant return
detected. Open
return 'class="warning"'
- Read upRead up
- Exclude checks
This cop checks for redundant return
expressions.
Example:
def test
return something
end
def test
one
two
three
return something
end
It should be extended to handle methods whose body is if/else or a case expression with a default branch.
Use underscores(_) as decimal mark and separate every 3 digits with them. Open
when 14..60000 # Look this up !
- Read upRead up
- Exclude checks
This cop checks for big numeric literals without _ between groups of digits in them.
Example:
# bad
1000000
1_00_000
1_0000
# good
1_000_000
1000
# good unless Strict is set
10_000_00 # typical representation of $10,000 in cents