Let ConsistentParenthesesStyle :omit_parentheses ignore trait + omitted hash value #136
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
thejonroberts
commented
Nov 21, 2024
| @@ -79,7 +79,7 @@ class ConsistentParenthesesStyle < ::RuboCop::Cop::Base | |||
| def_node_matcher :omit_hash_value?, <<~PATTERN | |||
| (send | |||
| #factory_call? %FACTORY_CALLS | |||
| {sym str send lvar} | |||
| {sym str send lvar} _* | |||
There was a problem hiding this comment.
First time working with AST. So there may be some implications here that I am missing. The intention is to allow any number of traits to be used before the hash values in the calls.
pirj
force-pushed
the
135-parentheses-style-hash-syntax-shorthand
branch
from
1ceefd7
to
8fea49c
Compare
When ConsistentParenthesesStyle is :omit_parentheses, we ignore factory calls that have an omitted hash value (ruby 3.1 shorthand syntax). Parentheses are required if the arguments end with the key of the omitted value. (e.g. `create(:user, name:)`) However, if a trait was used, (e.g. `create(:user, :trait, name:)`) omit_hash_value? matcher did not match it, and thus would remove the parentheses, potentially causing a syntax error. This change adds a wildcard to the omit_hash_value? matcher to allow any number of symbols/traits at the start of the pattern (before the hash values). see rubocop#135
pirj
force-pushed
the
135-parentheses-style-hash-syntax-shorthand
branch
from
8fea49c
to
45968e9
Compare
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.
Fix #135
When ConsistentParenthesesStyle is :omit_parentheses, we ignore factory calls that have an omitted hash value (ruby 3.1 shorthand syntax). Parentheses are required if the arguments end with the key of the omitted value. (e.g.
create(:user, name:))However, if a trait was used, (e.g.
create(:user, :trait, name:))omit_hash_value?matcher did not match it, and thus it would be an offense and corrected to remove the parentheses - potentially causing a syntax error.This change adds a wildcard to the
omit_hash_value?matcher to allow any number of symbols at the start of the factory call (before the hash values).Before submitting the PR make sure the following are checked:
master(if not - rebase it).[ ] Updated documentation.CHANGELOG.mdif the new code introduces user-observable changes.bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).