[Fix #3936] Add new Style/MixinGrouping cop
#3982
Merged
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
bbatsov
reviewed
Jan 29, 2017
| include ConfigurableEnforcedStyle | ||
|
|
||
| MIXIN_METHODS = [:extend, :include, :prepend].freeze | ||
| MSG = 'Put mixins in %s.'.freeze |
There was a problem hiding this comment.
I think the message is a bit confusing and should definitely mention include or extend for extra clarity.
bbatsov
reviewed
Jan 29, 2017
| @@ -728,6 +728,12 @@ Style/MethodName: | |||
| - snake_case | |||
| - camelCase | |||
|
|
|||
| Style/MixinGrouping: | |||
| EnforcedStyle: separated | |||
| SupportedStyles: | |||
There was a problem hiding this comment.
Some explanations about the supported styles would be useful.
|
A couple of points:
|
This cop checks for grouping of `mixins` in class and `module` bodies. By default, it enforces a separated style, i.e.: ``` class Foo include Bar include Qux end ``` but it can be configured to enforce a grouped style as well.
Drenmi
force-pushed
the
feature/mixin-grouping-cop
branch
from
9f1e3f8
to
2341191
Compare
|
@bbatsov: Comments addressed. 😀
Opened a PR for this.
I was holding off on this one, because I didn't have time to deal with the visibility scopes of the |
|
👍 |
pocke
added a commit
to pocke/rubocop
that referenced
this pull request
Jan 31, 2017
bbatsov
pushed a commit
that referenced
this pull request
Feb 1, 2017
PikachuEXE
reviewed
Feb 22, 2017
|
|
||
| # good | ||
| class Foo | ||
| include Bar |
There was a problem hiding this comment.
include Bar, Qox==
include Qox
include Bar
PikachuEXE
reviewed
Feb 22, 2017
|
|
||
| # good | ||
| class Foo | ||
| extend Bar, Qox |
There was a problem hiding this comment.
include Bar
include Qox==
include Qox, Bar
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.
This cop checks for grouping of
mixinsin class andmodulebodies. By default, it enforces a separated style, i.e.:but it can be configured to enforce a grouped style as well.
It's currently Chinese New Year, so I didn't have time to add autocorrect. Will add it in at a later point, unless someone beats me to it. 😀
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).and description in grammatically correct, complete sentences.
rake generate_cops_documentation(required only when you've added a new cop or changed the configuration/documentation of an existing cop).