Add new Rails/StrongParametersExpect
cop
#1412
Merged
+266
−0
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.
Summary
This PR adds new
Rails/StrongParametersExpect
cop that enforces the use ofActionController::Parameters#expect
as a method for strong parameter handling.As a starting point for this cop, the implementation in this PR will detect the following cases.
Safety
This cop's autocorrection is considered unsafe because there are cases where the HTTP status may change from 500 to 400 when handling invalid parameters. This change, however, reflects an intentional incompatibility introduced for valid reasons by the
expect
method, which aligns better with strong parameter conventions.Additional Information
This cop does not detect the following cases for the reasons outlined below. Consideration will be given to whether these should be provided as separate options.
params.permit
Incompatibilities occur with the returned object.
params.require
It cannot be determined whether
expect(:ids)
orexpect(ids: [])
should be used for the parameter.ids
is42
:ids
is[42, 43]
:params[]
andparams.fetch
Incompatibilities occur when the value is an array.
These may be designed and provided separately in the future.
Closes #1358.
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}.md
if the new code introduces user-observable changes. See changelog entry format for details.