Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fix #11908] Support AllowedReceivers for Style/CollectionMethods #11909

Conversation

koic
Copy link
Member

@koic koic commented Jun 1, 2023

Fixes #11908.

This PR supports AllowedReceivers for Style/CollectionMethods. For example, by setting AllowedReceivers: ['params'] in RuboCop Rails or user configuration, the following false positive for params can be prevented:

def selection_params(current, last_category = nil, params = {})
  params.merge(
    category_id: current.is_a?(Category) ? current.to_param : last_category.to_param,
    site_id: current.is_a?(Site) ? current.to_param : nil,
  ).delete_if { |_k, v| v.nil? }
end

The configuration to params is not set in the RuboCop core due to Rails specific issues. So if this approach is accepted, I will add it to RuboCop Rails's default configuration.


Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.

…ethods`

Fixes rubocop#11908.

This PR supports `AllowedReceivers` for `Style/CollectionMethods`.
For example, by setting `AllowedReceivers: ['params']` in RuboCop Rails or user configuration,
the following false positive for `params` can be prevented:

```ruby
def selection_params(current, last_category = nil, params = {})
  params.merge(
    category_id: current.is_a?(Category) ? current.to_param : last_category.to_param,
    site_id: current.is_a?(Site) ? current.to_param : nil,
  ).delete_if { |_k, v| v.nil? }
end
```

The configuration to `params` is not set in the RuboCop core due to Rails specific issues.
So if this approach is accepted, I will add it to RuboCop Rails's default configuration.
@bbatsov
Copy link
Collaborator

bbatsov commented Jun 2, 2023

Nice improvement! Thanks!

@bbatsov bbatsov merged commit 356fc46 into rubocop:master Jun 2, 2023
@koic koic deleted the support_allowed_receivers_for_style_collection_compact branch June 2, 2023 08:45
koic added a commit to koic/rubocop-rails that referenced this pull request Jun 25, 2024
koic added a commit to koic/rubocop-rails that referenced this pull request Jun 25, 2024
koic added a commit to koic/rubocop-rails that referenced this pull request Jun 25, 2024
koic added a commit to koic/rubocop-rails that referenced this pull request Jul 8, 2024
koic added a commit to koic/rubocop-rails that referenced this pull request Jul 21, 2024
koic added a commit to koic/rubocop-rails that referenced this pull request Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug report: An error with Style/CollectionCompact
2 participants