Method has too many lines. [13/10] Open
def create
@comment = Comment.new(comment_params)
@comment.user = current_user
respond_to do |format|
- Read upRead up
- Exclude checks
This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.
Missing magic comment # frozen_string_literal: true
. Open
class CommentsController < ApplicationController
- Read upRead up
- Exclude checks
This cop is designed to help upgrade to after 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
after 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: always (default)
# 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
Use the return of the conditional for variable assignment and comparison. Open
if @comment.save
notice = 'Comment was successfully created.'
else
notice = 'Comment was invalid.'
end
- Exclude checks
Missing top-level class documentation comment. Open
class CommentsController < ApplicationController
- 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
Align the arguments of a method call if they span more than one line. Open
notice: notice)
- Read upRead up
- Exclude checks
Here we check if the arguments on a multi-line method definition are aligned.
Example: EnforcedStyle: withfirstargument (default)
# good
foo :bar,
:baz
foo(
:bar,
:baz
)
# bad
foo :bar,
:baz
foo(
:bar,
:baz
)
Example: EnforcedStyle: withfixedindentation
# good
foo :bar,
:baz
# bad
foo :bar,
:baz