Add Configurable option for Rails/TransactionExitStatement

rubocop · Aug 17, 2023 · ad71894 · ad71894
1 parent 3bc0e2d
commit ad71894
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 3 deletions.
diff --git a/changelog/change_add_configurable_option_to_transaction_exit_statement.md b/changelog/change_add_configurable_option_to_transaction_exit_statement.md
@@ -0,0 +1 @@
+* [#1072](https://github.com/rubocop/rubocop-rails/pull/1072): Add Configurable option for `Rails/TransactionExitStatement`. ([@marocchino][])
diff --git a/config/default.yml b/config/default.yml
@@ -1081,6 +1081,9 @@ Rails/TransactionExitStatement:
   Description: 'Avoid the usage of `return`, `break` and `throw` in transaction blocks.'
   Reference:
     - https://github.com/rails/rails/commit/15aa4200e083
+  TransactionMethods:
+    - transaction
+    - with_lock
   Enabled: pending
   VersionAdded: '2.14'
 

diff --git a/docs/modules/ROOT/pages/cops_rails.adoc b/docs/modules/ROOT/pages/cops_rails.adoc
@@ -6190,6 +6190,16 @@ ApplicationRecord.transaction do
 end
 ----
 
+=== Configurable attributes
+
+|===
+| Name | Default value | Configurable values
+
+| TransactionMethods
+| `transaction`, `with_lock`
+| Array
+|===
+
 === References
 
 * https://github.com/rails/rails/commit/15aa4200e083

diff --git a/lib/rubocop/cop/rails/transaction_exit_statement.rb b/lib/rubocop/cop/rails/transaction_exit_statement.rb
@@ -55,8 +55,6 @@ class TransactionExitStatement < Base
           Exit statement `%<statement>s` is not allowed. Use `raise` (rollback) or `next` (commit).
         MSG
 
-        RESTRICT_ON_SEND = %i[transaction with_lock].freeze
-
         def_node_search :exit_statements, <<~PATTERN
           ({return | break | send nil? :throw} ...)
         PATTERN
@@ -85,6 +83,10 @@ def on_send(node)
 
         private
 
+        def transaction_methods
+          cop_config['TransactionMethods'] || []
+        end
+
         def statement(statement_node)
           if statement_node.return_type?
             'return'
@@ -98,7 +100,7 @@ def statement(statement_node)
         def nested_block?(statement_node)
           block_node = statement_node.ancestors.find(&:block_type?)
 
-          RESTRICT_ON_SEND.none? { |name| block_node.method?(name) }
+          transaction_methods.none? { |name| block_node.method?(name) }
         end
       end
     end

diff --git a/spec/rubocop/cop/rails/transaction_exit_statement_spec.rb b/spec/rubocop/cop/rails/transaction_exit_statement_spec.rb
@@ -108,4 +108,10 @@
 
   it_behaves_like 'flags transaction exit statements', :transaction
   it_behaves_like 'flags transaction exit statements', :with_lock
+
+  context 'transaction methods' do
+    let(:cop_config) { { 'TransactionMethods' => %w[writable_transaction] } }
+
+    it_behaves_like 'flags transaction exit statements', :writable_transaction
+  end
 end