rubocop-vendor 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c809c5b9a7d9b2d126f055b5e497fde38c3b753da4dd75e951b177abf61749e
-  data.tar.gz: d815df554dc91c1e56dda01e92aab3fd704a78f47ecece6f1ea8615be18aede8
+  metadata.gz: 8824e0593901b2f7a580ee710ff54e02d1c25e44b7898fd6a9520645c8ec0280
+  data.tar.gz: 95c6fa1afeae6027be9771322d5406e429548770a9cd388a75dd81a115687580
 SHA512:
-  metadata.gz: 4719406e2c8b304e04b7058d3791eaef770f905cbc006772d80aa4e204cf05236d457309e75686cac53165c041f14eccfa6321c80d8d24b248ccebefe6a93b7d
-  data.tar.gz: e279095669e96d455fb54ec11285f2f1aa1c5aa0b7d9f10131ea23f9f07440fd03b8d0a10d0abfa5517e2c00a40dcc3218ba592f5f5b15aa6efb9cedd52fe635
+  metadata.gz: a7b9ad5f24cacc268c7bbcc04986211bdb5ca23afe41a3b6b4e8b5c2972b19e157d238e9d737de981a5f5e3d946f0465ff8a3f182b88e3c09d7652210819c83d
+  data.tar.gz: 85ab88216ac6f67068657f0b149c84c27b6c2f4e6914943b1bf64a951749da339baafcda92fe50078b6d4c8a21bac9a10abc1389bc5ae9e19390609135117287

data/config/default.yml

@@ -59,3 +59,8 @@ Vendor/WsSdkPathInjection:
   Description: 'Avoid using `ws_sdk` with path injection.'
   Enabled: true
   VersionAdded: '0.12.0'
+
+Vendor/ActiveRecordBaseTransactionUse:
+  Description: 'Avoid using ActiveRecord::Base.transaction.'
+  Enabled: true
+  VersionAdded: '0.13.0'

data/lib/rubocop/cop/vendor/active_record_base_transaction_use.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Vendor
+      # Flags uses of ActiveRecord::Base.transaction,
+      # as subclasses of ActiveRecord::Base may use a different
+      # database connection.
+      #
+      # This becomes relevant if, for instance, your application
+      # defines models or any subclass of ActiveRecord::Base
+      # specifying connection configurations, e.g. using `connects_to`.
+      #
+      # The guarantee that transaction connection matches the
+      # model connection is strongest when `MyModelClass.transaction`
+      # wraps database operations on instances of MyModelClass only.
+      #
+      # If multiple model classes are involved in a .transaction
+      # call, `.transaction` only needs to be called on one of them,
+      # or a common ancestor sharing the same connection
+      # if both models share the same underlying connection.
+      #
+      # If not, a workaround would be to open a transaction on both
+      # model classes.
+      #
+      # @example
+      #
+      #   # bad
+      #   ActiveRecord::Base.transaction do
+      #     ... database operations
+      #   end
+      #
+      #   # good
+      #   MyModelClass.transaction do
+      #     ... database operations on instances of MyModelClass
+      #   end
+      #
+      #   # also good
+      #   my_model_instance.with_lock do
+      #     ... database operations on my_model_instance
+      #   end
+      #
+      #   # good if and only if both models share a database connection
+      #   MyModelClass.transaction do
+      #     ... database operations on instances of MyModelClass
+      #     ... database operations on instances of MyOtherModelClass
+      #   end
+      #
+      #   # good if and only if ApplicationRecord shares a database
+      #   # connection with all models involved
+      #   ApplicationRecord.transaction do
+      #     ... database operations on instances of MyModelClass
+      #     ... database operations on instances of MyOtherModelClass
+      #   end
+      #
+      #   # good if the models do not share a database connection
+      #   MyModelClass.transaction do
+      #     MyOtherModelClass.transaction do
+      #       ... database operations on instances of MyModelClass
+      #       ... database operations on instances of MyOtherModelClass
+      #     end
+      #   end
+      #
+      class ActiveRecordBaseTransactionUse < Base
+        MSG = 'Avoid using `ActiveRecord::Base.transaction, as models inheriting a subclass of ActiveRecord::Base may use a different database connection from ActiveRecord::Base.connection.'
+
+        # @!method uses_active_record_base?(node)
+        def_node_matcher :uses_active_record_base?, <<-PATTERN
+          (const (const {nil? cbase} :ActiveRecord) :Base)
+        PATTERN
+
+        def on_send(node)
+          receiver_node, method_name = *node
+
+          return unless uses_active_record_base?(receiver_node) && method_name == :transaction
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/vendor_cops.rb

@@ -3,6 +3,7 @@
 module RuboCop
 end
 
+require_relative 'vendor/active_record_base_transaction_use'
 require_relative 'vendor/active_record_connection_execute'
 require_relative 'vendor/recursive_open_struct_gem'
 require_relative 'vendor/sidekiq_throttled_gem'

data/lib/rubocop/vendor/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Vendor
-    VERSION = '0.12.1'
+    VERSION = '0.13.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-vendor
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Danilo Cabello
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-02 00:00:00.000000000 Z
+date: 2024-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -96,6 +96,7 @@ files:
 - README.md
 - config/default.yml
 - lib/rubocop-vendor.rb
+- lib/rubocop/cop/vendor/active_record_base_transaction_use.rb
 - lib/rubocop/cop/vendor/active_record_connection_execute.rb
 - lib/rubocop/cop/vendor/base.rb
 - lib/rubocop/cop/vendor/recursive_open_struct_gem.rb