esse-active_record 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6ec661a171ddf9df565e1da2c3ca67bc34fc18ec957e47867e50b043ce0ee44
-  data.tar.gz: 29e7acc6af3e77bbe52dde14038de3ad82532964dbc7293cdc77f2a3ae4764a3
+  metadata.gz: 412017405772bf674a32c43510c0fdd15c0d1ac9de09357e523aa87c7d8bb0ab
+  data.tar.gz: 869613dcb7b78c03097989dbeb2d565dc790b119043d7a1a7e7183ccdca1ba5f
 SHA512:
-  metadata.gz: cc76722e48a2ea6e002b08dd9f29b53bed75cf4f857254dde166bfc30090fc16482e3b70fe47dbc7409e970dfb5d47b5dcefcc5bf413d56382f5e9a909e98837
-  data.tar.gz: 76dcbec4c950921945faa13785273e523d82644d3757d3b27ee91f352f155371b218f9f1ff40b079cd04ad722acedf8c873b01532dc9143249b0616636b98b0e
+  metadata.gz: b3247f133ad930ea4ac1e69d3a242113c7ac26bc8de33737f350321fbe3b9de01ec21648310ff1b7c7ba326bca763107b4c313c663ae82686bb24da7d47e1cd3
+  data.tar.gz: 63593435b2cea9284e530351398960f5b73d2aceaad6cb336b30cec90e11cb419b4ad7a55a80265a91cb5b2b9c7704572758129d135ddc5f611e0f98f1be0de6

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.3.7 - 2024-08-05
+* Add `connected_to` to the collection for custom connection handling
+
+## 0.0.1
+The first release of the esse-active_record plugin
+* Added: Initial implementation of the plugin

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    esse-active_record (0.3.6)
+    esse-active_record (0.3.7)
       activerecord (>= 4.2, < 8)
       esse (>= 0.3.0)
 

data/ci/Gemfile.rails-5.2.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    esse-active_record (0.3.6)
+    esse-active_record (0.3.7)
       activerecord (>= 4.2, < 8)
       esse (>= 0.3.0)
 

data/ci/Gemfile.rails-6.0.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    esse-active_record (0.3.6)
+    esse-active_record (0.3.7)
       activerecord (>= 4.2, < 8)
       esse (>= 0.3.0)
 

data/ci/Gemfile.rails-6.1.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    esse-active_record (0.3.6)
+    esse-active_record (0.3.7)
       activerecord (>= 4.2, < 8)
       esse (>= 0.3.0)
 

data/ci/Gemfile.rails-7.0.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    esse-active_record (0.3.6)
+    esse-active_record (0.3.7)
       activerecord (>= 4.2, < 8)
       esse (>= 0.3.0)
 

data/ci/Gemfile.rails-7.1.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    esse-active_record (0.3.6)
+    esse-active_record (0.3.7)
       activerecord (>= 4.2, < 8)
       esse (>= 0.3.0)
 

data/lib/esse/active_record/collection.rb

@@ -21,6 +21,12 @@ module Esse
       class_attribute :batch_contexts
       self.batch_contexts = {}
 
+      # Connects to a database or role (ex writing, reading, or another custom role) for the collection query
+      # @param [Symbol] role The role to connect to
+      # @param [Symbol] shard The shard to connect to
+      class_attribute :connect_with
+      self.connect_with = nil
+
       class << self
         def inspect
           return super unless self < Esse::ActiveRecord::Collection
@@ -40,6 +46,7 @@ module Esse
 
           subclass.scopes = scopes.dup
           subclass.batch_contexts = batch_contexts.dup
+          subclass.connect_with = connect_with&.dup
         end
 
         def scope(name, proc = nil, override: false, &block)
@@ -57,6 +64,10 @@ module Esse
 
           batch_contexts[name.to_sym] = proc
         end
+
+        def connected_to(**kwargs)
+          self.connect_with = kwargs
+        end
       end
 
       attr_reader :start, :finish, :batch_size, :params
@@ -74,23 +85,29 @@ module Esse
       end
 
       def each
-        dataset.find_in_batches(**batch_options) do |rows|
-          kwargs = params.dup
-          self.class.batch_contexts.each do |name, proc|
-            kwargs[name] = proc.call(rows, **params)
+        with_connection do
+          dataset.find_in_batches(**batch_options) do |rows|
+            kwargs = params.dup
+            self.class.batch_contexts.each do |name, proc|
+              kwargs[name] = proc.call(rows, **params)
+            end
+            yield(rows, **kwargs)
           end
-          yield(rows, **kwargs)
         end
       end
 
       def each_batch_ids
-        dataset.select(:id).except(:includes, :preload, :eager_load).find_in_batches(**batch_options) do |rows|
-          yield(rows.map(&:id))
+        with_connection do
+          dataset.select(:id).except(:includes, :preload, :eager_load).find_in_batches(**batch_options) do |rows|
+            yield(rows.map(&:id))
+          end
         end
       end
 
       def count
-        dataset.except(:includes, :preload, :eager_load, :group, :order, :limit, :offset).count
+        with_connection do
+          dataset.except(:includes, :preload, :eager_load, :group, :order, :limit, :offset).count
+        end
       end
       alias_method :size, :count
 
@@ -127,6 +144,16 @@ module Esse
 
       protected
 
+      def with_connection
+        if self.class.connect_with&.any?
+          ::ActiveRecord::Base.connected_to(**self.class.connect_with) do
+            yield
+          end
+        else
+          yield
+        end
+      end
+
       def batch_options
         {
           batch_size: batch_size

data/lib/esse/active_record/version.rb

@@ -2,6 +2,6 @@
 
 module Esse
   module ActiveRecord
-    VERSION = '0.3.6'
+    VERSION = '0.3.7'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esse-active_record
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Marcos G. Zimmermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-02 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: esse
@@ -206,6 +206,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt