[Fix #562] Add new Rails/CompactBlank cop
#598
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
koic
force-pushed
the
add_new_rails_compact_blank_cop
branch
from
f03f4e5 to
401297a
Compare
pirj
reviewed
Dec 20, 2021
Comment on lines
38
to
39
| (args | ||
| (arg _)) |
There was a problem hiding this comment.
Wondering how this works.
ruby-parse returns:
(args
(procarg0
(arg :e)))
| # @example | ||
| # | ||
| # # bad | ||
| # collection.reject { |e| e.blank? } |
There was a problem hiding this comment.
To me, this is not sufficiently bad. Especially with block-pass:
collection.reject(&:blank?)However, with hashes this becomes unwieldy, and I don't think there's a better option than compact_blank:
hash_collection.reject { |_k, v| v.blank? }Even though I'd rather prefer having something more generic like:
hash_collection.reject_values(&:blank?)
Comment on lines
6
to
7
| # This cop checks for places where custom logic on rejection blanks | ||
| # from arrays and hashes can be replaced with `compact_blank`. |
There was a problem hiding this comment.
WDYT of
Checks if collection can be blank-compacted with
compact_blank.
koic
force-pushed
the
add_new_rails_compact_blank_cop
branch
from
401297a to
e001bc0
Compare
|
@pirj Thank you for your review! I've updated the PR overall. |
pirj
approved these changes
Dec 21, 2021
| # | ||
| # # bad | ||
| # collection.reject!(&:blank?) | ||
| # collection.reject!(&:empty?) |
There was a problem hiding this comment.
I'd through in the example with a Hash, since it's outstandingly bad.
# bad
hashmap.reject { |_k, v| b.blank? }
# good
hashmap.compact_blank
Fixes rubocop#562. This cop checks for places where custom logic on rejection blanks from arrays and hashes can be replaced with `compact_blank`. ```ruby # bad collection.reject { |e| e.blank? } collection.reject { |e| e.empty? } # good collection.compact_blank # bad collection.reject! { |e| e.blank? } collection.reject! { |e| e.empty? } # good collection.compact_blank! ```
koic
force-pushed
the
add_new_rails_compact_blank_cop
branch
from
e001bc0 to
c7f39c4
Compare
koic
added a commit
that referenced
this pull request
Dec 24, 2021
Follow up to #598. This PR marks `Rails/CompactBlank` as unsafe. It is unsafe by default because false positives may occur in the blank check of block arguments to the receiver object. ```ruby [[1, 2], [3, nil]].reject { |first, second| second.blank? } # => [[1, 2]] [[1, 2], [3, nil]].compact_blank # => [[1, 2], [3, nil]] ```
okuramasafumi
added a commit
to okuramasafumi/rubocop-rails
that referenced
this pull request
Jan 5, 2022
In rubocop#598 new `Rails/CompactBlank` cop was added, but there's no entry for it in CHANGELOG.
10 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 #562.
This cop checks for places where custom logic on rejection blanks from arrays and hashes can be replaced with
compact_blank.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.and description in grammatically correct, complete sentences.