mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
c6379fd27f
Performance cops will be extracted from RuboCop to RuboCop Performance when next RuboCop 0.68 will be released. https://github.com/rubocop-hq/rubocop/issues/5977 RuboCop 0.67 is its transition period. Since rails/rails repository uses Performance cops, This PR added rubocop-performance gem to Gemfile. And this PR fixes some offenses using the following auto-correct. ```console % bundle exec rubocop -a Offenses: activerecord/test/cases/connection_adapters/connection_handlers_multi_db_test.rb:212:26: C: [Corrected] Layout/SpaceAroundOperators: Operator = > should be surrounded by a single space. "primary" => { adapter: "sqlite3", database: "db/primary.sqlite3" } ^^ activerecord/test/cases/connection_adapters/connection_handlers_multi_db_test.rb:239:26: C: [Corrected] Layout/SpaceAroundOperators: Operator => should be surrounded by a single space. "primary" => { adapter: "sqlite3", database: "db/primary.sqlite3" } ^^ actionview/test/template/resolver_shared_tests.rb:1:1: C: [Corrected] Style/FrozenStringLiteralComment: Missing magic comment # frozen_string_literal: true. module ResolverSharedTests ^ actionview/test/template/resolver_shared_tests.rb:10:33: C: [Corrected] Layout/SpaceAroundEqualsInParameterDefault: Surrounding space missing in default value assignment. def with_file(filename, source="File at #{filename}") ^ actionview/test/template/resolver_shared_tests.rb:106:5: C: [Corrected] Rails/RefuteMethods: Prefer assert_not_same over refute_same. refute_same a, b ^^^^^^^^^^^ 2760 files inspected, 5 offenses detected, 5 offenses corrected ```
255 lines
5.1 KiB
YAML
255 lines
5.1 KiB
YAML
require: rubocop-performance
|
|
|
|
AllCops:
|
|
TargetRubyVersion: 2.5
|
|
# RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
|
|
# to ignore them, so only the ones explicitly set in this file are enabled.
|
|
DisabledByDefault: true
|
|
Exclude:
|
|
- '**/templates/**/*'
|
|
- '**/vendor/**/*'
|
|
- 'actionpack/lib/action_dispatch/journey/parser.rb'
|
|
- 'railties/test/fixtures/tmp/**/*'
|
|
- 'actionmailbox/test/dummy/**/*'
|
|
- 'actiontext/test/dummy/**/*'
|
|
- '**/node_modules/**/*'
|
|
|
|
Performance:
|
|
Exclude:
|
|
- '**/test/**/*'
|
|
|
|
Rails:
|
|
Enabled: true
|
|
|
|
# Prefer assert_not over assert !
|
|
Rails/AssertNot:
|
|
Include:
|
|
- '**/test/**/*'
|
|
|
|
# Prefer assert_not_x over refute_x
|
|
Rails/RefuteMethods:
|
|
Include:
|
|
- '**/test/**/*'
|
|
|
|
# Prefer &&/|| over and/or.
|
|
Style/AndOr:
|
|
Enabled: true
|
|
|
|
# Do not use braces for hash literals when they are the last argument of a
|
|
# method call.
|
|
Style/BracesAroundHashParameters:
|
|
Enabled: true
|
|
EnforcedStyle: context_dependent
|
|
|
|
# Align `when` with `case`.
|
|
Layout/CaseIndentation:
|
|
Enabled: true
|
|
|
|
# Align comments with method definitions.
|
|
Layout/CommentIndentation:
|
|
Enabled: true
|
|
|
|
Layout/ElseAlignment:
|
|
Enabled: true
|
|
|
|
# Align `end` with the matching keyword or starting expression except for
|
|
# assignments, where it should be aligned with the LHS.
|
|
Layout/EndAlignment:
|
|
Enabled: true
|
|
EnforcedStyleAlignWith: variable
|
|
AutoCorrect: true
|
|
|
|
Layout/EmptyLineAfterMagicComment:
|
|
Enabled: true
|
|
|
|
Layout/EmptyLinesAroundBlockBody:
|
|
Enabled: true
|
|
|
|
# In a regular class definition, no empty lines around the body.
|
|
Layout/EmptyLinesAroundClassBody:
|
|
Enabled: true
|
|
|
|
# In a regular method definition, no empty lines around the body.
|
|
Layout/EmptyLinesAroundMethodBody:
|
|
Enabled: true
|
|
|
|
# In a regular module definition, no empty lines around the body.
|
|
Layout/EmptyLinesAroundModuleBody:
|
|
Enabled: true
|
|
|
|
Layout/FirstParameterIndentation:
|
|
Enabled: true
|
|
|
|
# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
|
|
Style/HashSyntax:
|
|
Enabled: true
|
|
|
|
# Method definitions after `private` or `protected` isolated calls need one
|
|
# extra level of indentation.
|
|
Layout/IndentationConsistency:
|
|
Enabled: true
|
|
EnforcedStyle: rails
|
|
|
|
# Two spaces, no tabs (for indentation).
|
|
Layout/IndentationWidth:
|
|
Enabled: true
|
|
|
|
Layout/LeadingCommentSpace:
|
|
Enabled: true
|
|
|
|
Layout/SpaceAfterColon:
|
|
Enabled: true
|
|
|
|
Layout/SpaceAfterComma:
|
|
Enabled: true
|
|
|
|
Layout/SpaceAfterSemicolon:
|
|
Enabled: true
|
|
|
|
Layout/SpaceAroundEqualsInParameterDefault:
|
|
Enabled: true
|
|
|
|
Layout/SpaceAroundKeyword:
|
|
Enabled: true
|
|
|
|
Layout/SpaceAroundOperators:
|
|
Enabled: true
|
|
|
|
Layout/SpaceBeforeComma:
|
|
Enabled: true
|
|
|
|
Layout/SpaceBeforeComment:
|
|
Enabled: true
|
|
|
|
Layout/SpaceBeforeFirstArg:
|
|
Enabled: true
|
|
|
|
Style/DefWithParentheses:
|
|
Enabled: true
|
|
|
|
# Defining a method with parameters needs parentheses.
|
|
Style/MethodDefParentheses:
|
|
Enabled: true
|
|
|
|
Style/FrozenStringLiteralComment:
|
|
Enabled: true
|
|
EnforcedStyle: always
|
|
Exclude:
|
|
- 'actionview/test/**/*.builder'
|
|
- 'actionview/test/**/*.ruby'
|
|
- 'actionpack/test/**/*.builder'
|
|
- 'actionpack/test/**/*.ruby'
|
|
- 'activestorage/db/migrate/**/*.rb'
|
|
- 'activestorage/db/update_migrate/**/*.rb'
|
|
- 'actionmailbox/db/migrate/**/*.rb'
|
|
- 'actiontext/db/migrate/**/*.rb'
|
|
|
|
Style/RedundantFreeze:
|
|
Enabled: true
|
|
|
|
# Use `foo {}` not `foo{}`.
|
|
Layout/SpaceBeforeBlockBraces:
|
|
Enabled: true
|
|
|
|
# Use `foo { bar }` not `foo {bar}`.
|
|
Layout/SpaceInsideBlockBraces:
|
|
Enabled: true
|
|
EnforcedStyleForEmptyBraces: space
|
|
|
|
# Use `{ a: 1 }` not `{a:1}`.
|
|
Layout/SpaceInsideHashLiteralBraces:
|
|
Enabled: true
|
|
|
|
Layout/SpaceInsideParens:
|
|
Enabled: true
|
|
|
|
# Check quotes usage according to lint rule below.
|
|
Style/StringLiterals:
|
|
Enabled: true
|
|
EnforcedStyle: double_quotes
|
|
|
|
# Detect hard tabs, no hard tabs.
|
|
Layout/Tab:
|
|
Enabled: true
|
|
|
|
# Blank lines should not have any spaces.
|
|
Layout/TrailingBlankLines:
|
|
Enabled: true
|
|
|
|
# No trailing whitespace.
|
|
Layout/TrailingWhitespace:
|
|
Enabled: true
|
|
|
|
# Use quotes for string literals when they are enough.
|
|
Style/UnneededPercentQ:
|
|
Enabled: true
|
|
|
|
Lint/AmbiguousOperator:
|
|
Enabled: true
|
|
|
|
Lint/AmbiguousRegexpLiteral:
|
|
Enabled: true
|
|
|
|
Lint/ErbNewArguments:
|
|
Enabled: true
|
|
|
|
# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
|
|
Lint/RequireParentheses:
|
|
Enabled: true
|
|
|
|
Lint/ShadowingOuterLocalVariable:
|
|
Enabled: true
|
|
|
|
Lint/StringConversionInInterpolation:
|
|
Enabled: true
|
|
|
|
Lint/UriEscapeUnescape:
|
|
Enabled: true
|
|
|
|
Lint/UselessAssignment:
|
|
Enabled: true
|
|
|
|
Lint/DeprecatedClassMethods:
|
|
Enabled: true
|
|
|
|
Style/ParenthesesAroundCondition:
|
|
Enabled: true
|
|
|
|
Style/RedundantBegin:
|
|
Enabled: true
|
|
|
|
Style/RedundantReturn:
|
|
Enabled: true
|
|
AllowMultipleReturnValues: true
|
|
|
|
Style/Semicolon:
|
|
Enabled: true
|
|
AllowAsExpressionSeparator: true
|
|
|
|
# Prefer Foo.method over Foo::method
|
|
Style/ColonMethodCall:
|
|
Enabled: true
|
|
|
|
Style/TrivialAccessors:
|
|
Enabled: true
|
|
|
|
Performance/FlatMap:
|
|
Enabled: true
|
|
|
|
Performance/RedundantMerge:
|
|
Enabled: true
|
|
|
|
Performance/StartWith:
|
|
Enabled: true
|
|
|
|
Performance/EndWith:
|
|
Enabled: true
|
|
|
|
Performance/RegexpMatch:
|
|
Enabled: true
|
|
|
|
Performance/ReverseEach:
|
|
Enabled: true
|
|
|
|
Performance/UnfreezeString:
|
|
Enabled: true
|