esse-active_record 0.3.5 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edf541425801e7e18e816e6a0169c021f52017829ada9643f959452ba207a658
-  data.tar.gz: 8cbc35bd232d9c6fde1cc6ef79aba08feffd00db04dfd6238cf60f4058457bd5
+  metadata.gz: 412017405772bf674a32c43510c0fdd15c0d1ac9de09357e523aa87c7d8bb0ab
+  data.tar.gz: 869613dcb7b78c03097989dbeb2d565dc790b119043d7a1a7e7183ccdca1ba5f
 SHA512:
-  metadata.gz: 3125eb0d88c23be59bdb5a889005357833b50cde303be94ed9e2fce2fc008bb59e2c636d7c08f14b9f028a84aad6f35d43151824669210916067dfa2e42f6991
-  data.tar.gz: 217f00f691e17cc13402a63e799220a94807194205fd1439ebe426f1e36bcef73511793cd71a8a3931c0b1e975cb7b3fa2ada1b92eac8de8151f2f70016a5168
+  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.5)
+    esse-active_record (0.3.7)
       activerecord (>= 4.2, < 8)
       esse (>= 0.3.0)
 

data/README.md

@@ -210,6 +210,35 @@ User.without_indexing(AccountsIndex) do
 end
 ```
 
+### Asynchronous Indexing
+
+If you are using a background job processor like Sidekiq or Faktory, you may be interested in indexing documents asynchronously. For this, you can use the [esse-async_indexing](https://github.com/marcosgz/esse-async_indexing) gem.
+
+Add the `esse-async_indexing` gem to your Gemfile and require the `esse/async_indexing/active_record` file in your application initialization. Make sure to setup the gem configurationg according to the [esse-async_indexing documentation](https://github.com/marcosgz/esse-async_indexing).
+
+
+```ruby
+require 'esse/async_indexing/active_record'
+```
+
+Then, you can use the `async_index_callback` or `async_update_lazy_attribute_callback` methods to push the indexing job to the background job processor.
+
+```diff
+class City < ApplicationRecord
+  include Esse::ActiveRecord::Model
+- include Esse::ActiveRecord::Model
++ include Esse::AsyncIndexing::ActiveRecord::Model
+
+  belongs_to :state, optional: true
+
+
+  async_indexing_callback('geos_index:city') { id }
+- index_callback('geos_index:city') { id }
+- update_lazy_attribute_callback('geos_index:state', 'cities_count', if: :state_id?) { state_id }
++ async_index_callback('geos_index:city', service_name: :sidekiq) { id }
++ async_update_lazy_attribute_callback('geos_index:state', 'cities_count', if: :state_id?, service_name: :sidekiq) { state_id }
+end
+```
 
 ## Development
 

data/ci/Gemfile.rails-5.2.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    esse-active_record (0.3.5)
+    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.5)
+    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.5)
+    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.5)
+    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.5)
+    esse-active_record (0.3.7)
       activerecord (>= 4.2, < 8)
       esse (>= 0.3.0)
 

data/lib/esse/active_record/callbacks/indexing_on_update.rb

@@ -3,13 +3,6 @@
 module Esse::ActiveRecord
   module Callbacks
     class IndexingOnUpdate < Callback
-      attr_reader :update_with
-
-      def initialize(with: :index, **kwargs, &block)
-        @update_with = with
-        super(**kwargs, &block)
-      end
-
       def call(model)
         record = block_result || model
 
@@ -43,7 +36,7 @@ module Esse::ActiveRecord
       def update_document(document)
         return if document.ignore_on_index?
 
-        if update_with == :update
+        if @with == :update || (@with.nil? && repo.lazy_document_attributes.any?)
           begin
             repo.index.update(document, **options)
           rescue Esse::Transport::NotFoundError

data/lib/esse/active_record/callbacks.rb

@@ -5,8 +5,9 @@ module Esse
     class Callback
       attr_reader :repo, :options, :block_result
 
-      def initialize(repo:, block_result: nil, **kwargs)
+      def initialize(repo:, block_result: nil, with: nil, **kwargs)
         @repo = repo
+        @with = with
         @options = kwargs
         @block_result = block_result
       end

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).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.5'
+    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.5
+  version: 0.3.7
 platform: ruby
 authors:
 - Marcos G. Zimmermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-29 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