[Fix #7976] Add ignore options for Layout/EmptyLinesAroundAttributeAccessor
#7982
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
koic
force-pushed
the
add_ignore_options_for_empty_lines_around_attribute_accessor
branch
3 times, most recently
from
d7eeef6
to
35c311d
Compare
koic
force-pushed
the
add_ignore_options_for_empty_lines_around_attribute_accessor
branch
from
35c311d
to
c8cc5b9
Compare
bbatsov
reviewed
May 17, 2020
config/default.yml
Outdated
| @@ -468,6 +468,13 @@ Layout/EmptyLinesAroundAttributeAccessor: | |||
| StyleGuide: '#empty-lines-around-attribute-accessor' | |||
| Enabled: pending | |||
| VersionAdded: '0.83' | |||
| VersionChanged: '1.0' | |||
| IgnoreAliasSyntax: true | |||
There was a problem hiding this comment.
I'd rather use Allow and Allowed here.
bbatsov
reviewed
May 17, 2020
| @@ -4,6 +4,8 @@ module RuboCop | |||
| module Cop | |||
| module Layout | |||
| # Checks for a newline after attribute accessor. | |||
| # `alias` syntax and `alias_method`, `public`, `protected`, and `private` methods are ignored by default. | |||
There was a problem hiding this comment.
We should also be more specific in the initial sentence - it's an attribute accessor or a group of them.
|
Good work! Probably at some point we should have something more generic for other macros that are typically grouped together. |
koic
force-pushed
the
add_ignore_options_for_empty_lines_around_attribute_accessor
branch
from
c8cc5b9
to
872af14
Compare
|
Yeah, I update this PR. |
bbatsov
reviewed
May 17, 2020
config/default.yml
Outdated
| @@ -468,6 +468,13 @@ Layout/EmptyLinesAroundAttributeAccessor: | |||
| StyleGuide: '#empty-lines-around-attribute-accessor' | |||
| Enabled: pending | |||
| VersionAdded: '0.83' | |||
| VersionChanged: '1.0' | |||
There was a problem hiding this comment.
We should also change this to 0.84.
…ributeAccessor` Fixes rubocop#7976 and rubocop#7981 This PR adds `AllowAliasSyntax` and `AllowedMethods` options. for `Layout/EmptyLinesAroundAttributeAccessor` cop. Users can configure a behavior for `alias` syntax using `IgnoreAliasSyntax` option. Ignored by default (true). And users can specify ignored methods using `AllowedMethods`. By default, set `alias_method`, `public`, `protected`, and `private` provided by Ruby. `cattr_accessor`, `attribute`, other methods provided by Rails (and other gems) can be set by user applications or RuboCop Rails gem.
koic
force-pushed
the
add_ignore_options_for_empty_lines_around_attribute_accessor
branch
from
872af14
to
aad52dd
Compare
koic
deleted the
add_ignore_options_for_empty_lines_around_attribute_accessor
branch
koic
added a commit
to koic/rubocop
that referenced
this pull request
May 17, 2020
Follow up rubocop#7982.
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #7976 and #7981
This PR adds
IgnoreAliasSyntaxandIgnoredMethodsoptions forLayout/EmptyLinesAroundAttributeAccessor.Users can configure a behavior for
aliassyntax usingIgnoreAliasSyntaxoption. Ignored by default (true).And users can specify ignored methods using
IgnoredMethods. By default, setalias_method,public,protected, andprivateprovided by Ruby.cattr_accessor,attribute, other methods provided by Rails (and other gems) can be set by user applications or RuboCop Rails gem.Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.