Add custom RuboCop for `assert_not` over `refute`
Since at least cf4afc4 we have preferred `assert_not` methods over
`refute` methods. I have seen plenty of comments in PRs about this,
and we have tried to fix it a few times (5294ad8, e45f176, 8910f12,
41f50be, d4cfd54, 48a183e, and 211adb4), but the `refute` methods
keep sneaking back in.
This custom RuboCop will take care of enforcing this preference, so we
don't have to think about it again. I suspect there are other similar
stylistic preferences that could be solved with some custom RuboCops, so
I will definitely keep my eyes open. `assert_not` over `assert !` might
be a good candidate, for example.
I wasn't totally sure if `ci/custom_cops` was the best place to put
this, but nothing else seemed quite right. At one point I had it set up
as a gem, but I think custom cops like this would have limited value
in another context.
I want to see how code climate handles the new cops before
autocorrecting the existing violations. If things go as expected, I will
push another commit with those corrections.
2018-04-04 00:50:00 +00:00
|
|
|
require: './ci/custom_cops/lib/custom_cops'
|
|
|
|
|
2016-06-13 14:29:50 +00:00
|
|
|
AllCops:
|
2018-02-17 21:02:18 +00:00
|
|
|
TargetRubyVersion: 2.4
|
2016-08-06 15:45:37 +00:00
|
|
|
# RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
|
2016-08-07 11:06:51 +00:00
|
|
|
# to ignore them, so only the ones explicitly set in this file are enabled.
|
2016-06-13 14:29:50 +00:00
|
|
|
DisabledByDefault: true
|
2016-08-06 15:45:37 +00:00
|
|
|
Exclude:
|
|
|
|
- '**/templates/**/*'
|
|
|
|
- '**/vendor/**/*'
|
2016-12-24 14:33:02 +00:00
|
|
|
- 'actionpack/lib/action_dispatch/journey/parser.rb'
|
2016-06-13 14:29:50 +00:00
|
|
|
|
Add custom RuboCop for `assert_not` over `refute`
Since at least cf4afc4 we have preferred `assert_not` methods over
`refute` methods. I have seen plenty of comments in PRs about this,
and we have tried to fix it a few times (5294ad8, e45f176, 8910f12,
41f50be, d4cfd54, 48a183e, and 211adb4), but the `refute` methods
keep sneaking back in.
This custom RuboCop will take care of enforcing this preference, so we
don't have to think about it again. I suspect there are other similar
stylistic preferences that could be solved with some custom RuboCops, so
I will definitely keep my eyes open. `assert_not` over `assert !` might
be a good candidate, for example.
I wasn't totally sure if `ci/custom_cops` was the best place to put
this, but nothing else seemed quite right. At one point I had it set up
as a gem, but I think custom cops like this would have limited value
in another context.
I want to see how code climate handles the new cops before
autocorrecting the existing violations. If things go as expected, I will
push another commit with those corrections.
2018-04-04 00:50:00 +00:00
|
|
|
# Prefer assert_not_x over refute_x
|
|
|
|
CustomCops/RefuteNot:
|
|
|
|
Include:
|
|
|
|
- '**/*_test.rb'
|
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# Prefer &&/|| over and/or.
|
|
|
|
Style/AndOr:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2016-06-13 14:29:50 +00:00
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# Do not use braces for hash literals when they are the last argument of a
|
|
|
|
# method call.
|
|
|
|
Style/BracesAroundHashParameters:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2017-08-12 11:31:46 +00:00
|
|
|
EnforcedStyle: context_dependent
|
2016-06-13 14:29:50 +00:00
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# Align `when` with `case`.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/CaseIndentation:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2016-06-13 14:29:50 +00:00
|
|
|
|
2016-09-14 08:57:52 +00:00
|
|
|
# Align comments with method definitions.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/CommentIndentation:
|
2016-09-14 08:57:52 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2018-01-18 03:09:16 +00:00
|
|
|
Layout/ElseAlignment:
|
|
|
|
Enabled: true
|
|
|
|
|
2017-07-10 13:36:57 +00:00
|
|
|
Layout/EmptyLineAfterMagicComment:
|
|
|
|
Enabled: true
|
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# In a regular class definition, no empty lines around the body.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/EmptyLinesAroundClassBody:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2016-06-13 14:29:50 +00:00
|
|
|
|
2017-02-12 11:44:15 +00:00
|
|
|
# In a regular method definition, no empty lines around the body.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/EmptyLinesAroundMethodBody:
|
2017-02-12 11:44:15 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# In a regular module definition, no empty lines around the body.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/EmptyLinesAroundModuleBody:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2016-07-17 07:10:45 +00:00
|
|
|
|
2017-07-16 09:11:03 +00:00
|
|
|
Layout/FirstParameterIndentation:
|
|
|
|
Enabled: true
|
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
|
|
|
|
Style/HashSyntax:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2016-07-17 07:10:45 +00:00
|
|
|
|
2016-07-21 11:49:13 +00:00
|
|
|
# Method definitions after `private` or `protected` isolated calls need one
|
|
|
|
# extra level of indentation.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/IndentationConsistency:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2016-07-17 07:10:45 +00:00
|
|
|
EnforcedStyle: rails
|
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# Two spaces, no tabs (for indentation).
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/IndentationWidth:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2016-07-17 07:10:45 +00:00
|
|
|
|
2017-12-14 08:30:54 +00:00
|
|
|
Layout/LeadingCommentSpace:
|
|
|
|
Enabled: true
|
|
|
|
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceAfterColon:
|
2016-10-29 03:05:58 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceAfterComma:
|
2016-10-29 03:05:58 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceAroundEqualsInParameterDefault:
|
2016-10-29 03:05:58 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceAroundKeyword:
|
2016-10-29 03:05:58 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceAroundOperators:
|
2016-10-29 03:05:58 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2017-12-12 11:00:50 +00:00
|
|
|
Layout/SpaceBeforeComma:
|
|
|
|
Enabled: true
|
|
|
|
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceBeforeFirstArg:
|
2016-10-29 03:05:58 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2017-11-27 06:16:12 +00:00
|
|
|
Style/DefWithParentheses:
|
|
|
|
Enabled: true
|
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# Defining a method with parameters needs parentheses.
|
|
|
|
Style/MethodDefParentheses:
|
|
|
|
Enabled: true
|
|
|
|
|
2017-07-09 12:06:36 +00:00
|
|
|
Style/FrozenStringLiteralComment:
|
|
|
|
Enabled: true
|
|
|
|
EnforcedStyle: always
|
2017-07-23 15:36:41 +00:00
|
|
|
Exclude:
|
|
|
|
- 'actionview/test/**/*.builder'
|
|
|
|
- 'actionview/test/**/*.ruby'
|
2017-07-24 20:20:53 +00:00
|
|
|
- 'actionpack/test/**/*.builder'
|
|
|
|
- 'actionpack/test/**/*.ruby'
|
2017-08-22 05:32:27 +00:00
|
|
|
- 'activestorage/db/migrate/**/*.rb'
|
2017-07-09 12:06:36 +00:00
|
|
|
|
2016-08-16 07:30:11 +00:00
|
|
|
# Use `foo {}` not `foo{}`.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceBeforeBlockBraces:
|
2016-08-16 07:30:11 +00:00
|
|
|
Enabled: true
|
|
|
|
|
|
|
|
# Use `foo { bar }` not `foo {bar}`.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceInsideBlockBraces:
|
2016-08-16 07:30:11 +00:00
|
|
|
Enabled: true
|
|
|
|
|
|
|
|
# Use `{ a: 1 }` not `{a:1}`.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceInsideHashLiteralBraces:
|
2016-08-16 07:30:11 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceInsideParens:
|
2016-10-29 03:05:58 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# Check quotes usage according to lint rule below.
|
|
|
|
Style/StringLiterals:
|
|
|
|
Enabled: true
|
|
|
|
EnforcedStyle: double_quotes
|
|
|
|
|
|
|
|
# Detect hard tabs, no hard tabs.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/Tab:
|
2016-08-06 15:45:37 +00:00
|
|
|
Enabled: true
|
|
|
|
|
|
|
|
# Blank lines should not have any spaces.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/TrailingBlankLines:
|
2016-08-06 15:45:37 +00:00
|
|
|
Enabled: true
|
|
|
|
|
|
|
|
# No trailing whitespace.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/TrailingWhitespace:
|
2016-08-06 15:45:37 +00:00
|
|
|
Enabled: true
|
|
|
|
|
|
|
|
# Use quotes for string literals when they are enough.
|
|
|
|
Style/UnneededPercentQ:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2016-07-21 11:49:13 +00:00
|
|
|
# Align `end` with the matching keyword or starting expression except for
|
|
|
|
# assignments, where it should be aligned with the LHS.
|
2016-07-20 03:35:11 +00:00
|
|
|
Lint/EndAlignment:
|
2016-08-06 15:45:37 +00:00
|
|
|
Enabled: true
|
2017-01-16 06:36:57 +00:00
|
|
|
EnforcedStyleAlignWith: variable
|
2018-01-18 03:09:16 +00:00
|
|
|
AutoCorrect: true
|
2016-08-06 15:45:37 +00:00
|
|
|
|
|
|
|
# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
|
|
|
|
Lint/RequireParentheses:
|
|
|
|
Enabled: true
|
2017-10-28 12:15:34 +00:00
|
|
|
|
2017-10-31 22:32:04 +00:00
|
|
|
Style/RedundantReturn:
|
|
|
|
Enabled: true
|
|
|
|
AllowMultipleReturnValues: true
|
|
|
|
|
2017-10-28 12:15:34 +00:00
|
|
|
Style/Semicolon:
|
|
|
|
Enabled: true
|
|
|
|
AllowAsExpressionSeparator: true
|
2018-02-22 06:26:48 +00:00
|
|
|
|
|
|
|
# Prefer Foo.method over Foo::method
|
|
|
|
Style/ColonMethodCall:
|
|
|
|
Enabled: true
|