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

Update Lint/Void to recognize more nonmutating methods #12913

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

vlad-pisanov
Copy link

Update Lint/Void to recognize more nonmutating methods when the CheckForMethodsWithNoSideEffects option is used.

This PR adds one (now)-native transform_keys method, and about a dozen common ActiveSupport methods such as stringify_keys, compact_blank and squish.

The ActiveSupport methods are only recognized when AllCops/ActiveSupportExtensionsEnabled: true (such as in a Rails project)


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.

Comment on lines +74 to +77
encode filter flatten gsub lstrip merge next
reject reverse rotate rstrip scrub select
shuffle slice sort sort_by squeeze strip sub
succ swapcase tr tr_s transform_keys
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added filter and transform_keys

@koic
Copy link
Member

koic commented May 19, 2024

The goal seems reasonable, but it might be preferable to adjust the approach slightly. Instead of using ActiveSupportExtensionsEnabled, it might be better to provide a user config parameter like NonmutatingMethods. (There might be a better name than NonmutatingMethods.)
After that, In RuboCop Rails, configure NonmutatingMethods as follows:

# config/default.yml in the RuboCop Rails
NonmutatingMethods:
  - compact_blank
  - deep_merge
  - deep_stringify_keys
  - ...

This approach allows for the elimination of the NONMUTATING_ACTIVE_SUPPORT_METHODS_WITH_BANG_VERSION constant, ensuring that changes in Active Support do not have an impact.

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.

None yet

2 participants