Allow TransactionExitStatement to be configured to be enabled for all Rails versions #1535
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.
Rails 7.2 restored the pre-6.1 behavior of non-local returns in transactions. In response, RuboCop Rails disabled the TransactionExitStatement cop in Rails 7.2 and above without providing the option to opt-in. This cop disallows non-local exits (
return
,break
,throw
) within ActiveRecord transactions.Of the two behaviors (commit-on-return and roll-back-on-return), I personally don't find one to be way more obviously intuitive than the other. Perhaps I did at one point pre-6.1, but the churn since then has introduced confusion and doubt. Devs newer to Rails might not have ever had experience with the pre-6.1 behavior. I see value in being able to continue using this cop to avoid using code patterns where the behavior may not be broadly understood.
Adds a
EnableForAllRailsVersions
config option to the TransactionExitStatement cop that allows you to override the Rails version check and continue using this cop regardless of Rails version. The default isfalse
so the default behavior of disabling this cop in Rails 7.2 and above remains as-is.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.