README.md

sevencop

Custom cops for RuboCop.

Installation

Add this line to your application's Gemfile:

gem 'sevencop', require: false

And then execute:

bundle install

Or install it yourself as:

gem install sevencop

Usage

Require sevencop from your .rubocop.yml:

# .rubocop.yml
require:
  - sevencop

then enable the cops you want to use:

# .rubocop.yml
Sevencop/BelongsToOptional:
  Enabled: true

Cops

All cops are Enabled: false by default.

Sevencop/AutoloadOrdered

Sort autoload in alphabetical order within their section.

# bad
autoload :B, 'b'
autoload :A, 'a'

# good
autoload :A, 'a'
autoload :B, 'b'

# good
autoload :B, 'b'
autoload :D, 'd'

autoload :A, 'a'
autoload :C, 'a'

Sevencop/BelongsToOptional

Force belongs_to with optional: true option.

# bad
belongs_to :group

# good
belongs_to :group, optional: true

# good
belongs_to :group, optional: false

# good
belongs_to :group, options

This is useful for migration of config.active_record.belongs_to_required_by_default.

Sevencop/HashLiteralOrder

Sort Hash literal entries by key.

# bad
{
  b: 1,
  a: 1,
  c: 1
}

# good
{
  a: 1,
  b: 1,
  c: 1
}

Sevencop/InferredSpecType

Identifies redundant spec type.

# bad
# spec/models/user_spec.rb
RSpec.describe User, type: :model

# good
# spec/models/user_spec.rb
RSpec.describe User

# good
# spec/models/user_spec.rb
RSpec.describe User, type: :request

Sevencop/MethodDefinitionKeywordArgumentsOrdered

Sort method definition keyword arguments in alphabetical order.

# bad
def foo(b:, a:); end

# good
def foo(a:, b:); end

# bad
def foo(c:, d:, b: 1, a: 2); end

# good
def foo(c:, d:, a: 2, b: 1); end

Sevencop/MethodDefinitionMultilineArguments

Inserts new lines between method definition parameters.

# bad
def foo(a, b)
end

# good
def foo(
  a,
  b
)

# good
def foo(a)
end

Sevencop/OrderField

Identifies a String including "field" is passed to order or reorder.

# bad
articles.order('field(id, ?)', a)

# good
articles.order(Arel.sql('field(id, ?)'), a)

# bad
reorder('field(id, ?)', a)

# good
reorder(Arel.sql('field(id, ?)'), a)

Sevencop/UniquenessValidatorExplicitCaseSensitivity

Identifies use of UniquenessValidator without :case_sensitive option.

# bad
validates :name, uniqueness: true

# good
validates :name, uniqueness: { case_sensitive: true }

# good
validates :name, uniqueness: { case_sensitive: false }

# bad
validates :name, uniqueness: { allow_nil: true, scope: :user_id }

# good
validates :name, uniqueness: { allow_nil: true, scope: :user_id, case_sensitive: true }

Useful to keep the same behavior between Rails 6.0 and 6.1 where case insensitive collation is used in MySQL.

Sevencop/WhereNot

Identifies passing multi-elements Hash literal to where.not.

# bad
where.not(key1: value1, key2: value2)

# good
where.not(key1: value1).where.not(key2: value2)