Style/AccessorGrouping: Fix detection of Sorbet sig {} blocks
#11650
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
issyl0
force-pushed
the
fix-accessor-grouping-cop-for-sorbet-blocks
branch
from
9dce847
to
bb70257
Compare
issyl0
force-pushed
the
fix-accessor-grouping-cop-for-sorbet-blocks
branch
from
bb70257
to
ff1ce4c
Compare
|
Force-pushed to add backticks to the cop name in the changelog. |
bbatsov
reviewed
Mar 2, 2023
| @@ -90,6 +90,13 @@ def previous_line_comment?(node) | |||
|
|
|||
| def groupable_accessor?(node) | |||
| return true unless (previous_expression = node.left_siblings.last) | |||
|
|
|||
| if previous_expression.block_type? | |||
There was a problem hiding this comment.
Might be good to add a small comment here explaining what this bit of code targets.
bbatsov
reviewed
Mar 2, 2023
| annotation_method :one | ||
| attr_reader :one | ||
|
|
||
| annotation_method :two | ||
| attr_reader :two | ||
|
|
||
| sig { returns(Integer) } |
There was a problem hiding this comment.
You can also mention such an example explicitly in the cop's description.
- Sorbet `sig { returns(Integer) }` annotations above `attr_reader`
methods should be ignored after
9921cdc, per the docs, but they
weren't being.
- Sorbet `sig {}` constructs are blocks (hence the braces), not
`send_type?` directly.
- Hence, we now check if the previous expression is a block and if so,
descend into its child nodes until we find a `send_type`, then use
that to determine if the accessor is groupable.
- Relates to rubocop#11596.
issyl0
force-pushed
the
fix-accessor-grouping-cop-for-sorbet-blocks
branch
from
ff1ce4c
to
7fa0439
Compare
|
Thanks! |
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.
sig { returns(Integer) }annotations aboveattr_readermethods should be ignored after9921cdcdf7c4cd, per the docs, but they weren't being (see the test I added here for evidence).sig {}constructs are blocks (hence the braces), notsend_type?directly.send_type, then use that to determine if the accessor is groupable.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 runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.