esse-active_record 0.2.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f0c8cdcc6995c22670eb1083dbccd260c76f5caa453e08b1cb8cc3c4cd3f6b8
-  data.tar.gz: 0f412a70e5a7f26fcede5aaf8c88017665d17bea11363be2ab3174882c6f1e07
+  metadata.gz: b48e48c6b27fee2e8612414bd9ba6730bbfd57ddc30b9f5ebadf5742c57d4be4
+  data.tar.gz: c1b74e88c8942aea5a72c58326c0051d57326ff6d6c61e80b723abd043dd74a1
 SHA512:
-  metadata.gz: '079289f4c4bda72b3e97874775e8e1d32691d3a4f65d2412b155a9fbd8c71120b4e7596e14a6da0e44b5efc744c2522593fea7fc89f0533f11fbaa2de009bd20'
-  data.tar.gz: b1a7fe2d08f3eaee49595974efcad29d8da109504f71d9e1654db092a6e4391a23653814df892d77a9e50d45cb7a59f225b22ceffb1d28082cbeb8d292e1abc4
+  metadata.gz: 46019ab0f4d79af084a062fe41de8d1341b9261f0cf3651c94bb3e290db71a0f1794350fed8f2ef58f8dbc98910c2854e7a15fd5027cce0f1fd057ccda734b34
+  data.tar.gz: e2c5861b580b09bf968d04a984ab3e6d94d27c89a2386a84397ceabf9860237be85ec135c79c387c3ad4559e4cbeb1462f863604de01f1a9c047143df0f5448a

data/Gemfile

@@ -2,7 +2,9 @@
 
 source 'https://rubygems.org'
 
-gem 'esse', '~> 0.2.4'
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem 'esse', '~> 0.3.0'
 gem 'sqlite3', '~> 1.7.3'
 gem 'activerecord', '~> 5.2'
 gem 'esse-rspec', '~> 0.0.6'

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    esse-active_record (0.2.1)
+    esse-active_record (0.3.2)
       activerecord (>= 4.2, < 8)
-      esse (>= 0.2.3)
+      esse (>= 0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -39,7 +39,7 @@ GEM
     elasticsearch-transport (7.17.10)
       faraday (>= 1, < 3)
       multi_json
-    esse (0.2.6)
+    esse (0.3.0)
       multi_json
       thor (>= 0.19)
     esse-rspec (0.0.6)
@@ -122,7 +122,7 @@ GEM
     standard-performance (1.0.1)
       lint_roller (~> 1.0)
       rubocop-performance (~> 1.16.0)
-    thor (1.3.0)
+    thor (1.3.1)
     thread_safe (0.3.6)
     tzinfo (1.2.11)
       thread_safe (~> 0.1)
@@ -142,7 +142,7 @@ DEPENDENCIES
   awesome_print
   dotenv
   elasticsearch (~> 7.17, >= 7.17.10)
-  esse (~> 0.2.4)
+  esse (~> 0.3.0)
   esse-active_record!
   esse-rspec (~> 0.0.6)
   pry

data/README.md

@@ -154,7 +154,7 @@ end
 
 ### Indexing Callbacks
 
-The `index_callbacks` callback can be used to automaitcally index or delete documents after commit on create/update/destroy events.
+The `index_callback` callback can be used to automaitcally index or delete documents after commit on create/update/destroy events.
 
 ```ruby
 class UsersIndex < Esse::Index
@@ -173,9 +173,9 @@ class User < ApplicationRecord
   # Using a index and repository as argument. Note that the index name is used instead of the
   # of the constant name. it's so because index and model depends on each other should result in
   # circular dependencies issues.
-  index_callbacks 'users_index:user'
+  index_callback 'users_index:user'
   # Using a block to direct a different object to be indexed
-  index_callbacks('organizations') { user.organization } # The `_index` suffix and repo name  is optional on the index name
+  index_callback('organizations') { user.organization } # The `_index` suffix and repo name  is optional on the index name
 end
 ```
 
@@ -194,7 +194,7 @@ or by some specific list of index or index's repository
 ```ruby
 Esse::ActiveRecord::Hooks.disable!(UsersIndex.repo)
 Esse::ActiveRecord::Hooks.enable!(UsersIndex.repo)
-Esse::ActiveRecord::Hooks.without_indexing(AccountsIndex UsersIndex.repo, ) do
+Esse::ActiveRecord::Hooks.without_indexing(AccountsIndex, UsersIndex.repo) do
   10.times { User.create! }
 end
 ```

data/ci/Gemfile.rails-5.2.lock

@@ -1,9 +1,9 @@
 PATH
   remote: ..
   specs:
-    esse-active_record (0.2.1)
+    esse-active_record (0.3.2)
       activerecord (>= 4.2, < 8)
-      esse (>= 0.2.3)
+      esse (>= 0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -39,7 +39,7 @@ GEM
     elasticsearch-transport (7.17.10)
       faraday (>= 1, < 3)
       multi_json
-    esse (0.2.6)
+    esse (0.3.0)
       multi_json
       thor (>= 0.19)
     esse-rspec (0.0.6)

data/ci/Gemfile.rails-6.0.lock

@@ -1,9 +1,9 @@
 PATH
   remote: ..
   specs:
-    esse-active_record (0.2.1)
+    esse-active_record (0.3.2)
       activerecord (>= 4.2, < 8)
-      esse (>= 0.2.3)
+      esse (>= 0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -37,7 +37,7 @@ GEM
     elasticsearch-transport (7.17.10)
       faraday (>= 1, < 3)
       multi_json
-    esse (0.2.6)
+    esse (0.3.0)
       multi_json
       thor (>= 0.19)
     esse-rspec (0.0.6)

data/ci/Gemfile.rails-6.1.lock

@@ -1,9 +1,9 @@
 PATH
   remote: ..
   specs:
-    esse-active_record (0.2.1)
+    esse-active_record (0.3.2)
       activerecord (>= 4.2, < 8)
-      esse (>= 0.2.3)
+      esse (>= 0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -37,7 +37,7 @@ GEM
     elasticsearch-transport (7.17.10)
       faraday (>= 1, < 3)
       multi_json
-    esse (0.2.6)
+    esse (0.3.0)
       multi_json
       thor (>= 0.19)
     esse-rspec (0.0.6)

data/ci/Gemfile.rails-7.0.lock

@@ -1,9 +1,9 @@
 PATH
   remote: ..
   specs:
-    esse-active_record (0.2.1)
+    esse-active_record (0.3.2)
       activerecord (>= 4.2, < 8)
-      esse (>= 0.2.3)
+      esse (>= 0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -37,7 +37,7 @@ GEM
     elasticsearch-transport (7.17.10)
       faraday (>= 1, < 3)
       multi_json
-    esse (0.2.6)
+    esse (0.3.0)
       multi_json
       thor (>= 0.19)
     esse-rspec (0.0.6)

data/ci/Gemfile.rails-7.1.lock

@@ -1,9 +1,9 @@
 PATH
   remote: ..
   specs:
-    esse-active_record (0.2.1)
+    esse-active_record (0.3.2)
       activerecord (>= 4.2, < 8)
-      esse (>= 0.2.3)
+      esse (>= 0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -47,7 +47,7 @@ GEM
     elasticsearch-transport (7.17.10)
       faraday (>= 1, < 3)
       multi_json
-    esse (0.2.6)
+    esse (0.3.0)
       multi_json
       thor (>= 0.19)
     esse-rspec (0.0.6)

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Esse::ActiveRecord
+  module Callbacks
+    class IndexingOnCreate < Callback
+      def call(model)
+        record = block_result || model
+        document = repo.serialize(record)
+        repo.index.index(document, **options) if document
+        true
+      end
+    end
+
+    register_callback(:indexing, :create, IndexingOnCreate)
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Esse::ActiveRecord
+  module Callbacks
+    class IndexingOnDestroy < Callback
+      def call(model)
+        record = block_result || model
+        document = repo.serialize(record)
+        repo.index.delete(document, **options) if document
+        true
+      rescue Esse::Transport::NotFoundError
+        true
+      end
+    end
+
+    register_callback(:indexing, :destroy, IndexingOnDestroy)
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+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
+
+        document = repo.serialize(record)
+        return true unless document
+
+        update_document(document)
+        return true unless document.routing
+
+        prev_record = model.class.new(model.attributes.merge(model.previous_changes.transform_values(&:first))).tap(&:readonly!)
+        prev_document = repo.serialize(prev_record)
+
+        return true unless prev_document
+        return true if [prev_document.id, prev_document.routing].include?(nil)
+        return true if prev_document.routing == document.routing
+        return true if prev_document.id != document.id
+
+        begin
+          repo.index.delete(prev_document, **options)
+        rescue Esse::Transport::NotFoundError
+        end
+
+        true
+      end
+
+      protected
+
+      def update_document(document)
+        if update_with == :update
+          begin
+            repo.index.update(document, **options)
+          rescue Esse::Transport::NotFoundError
+            repo.index.index(document, **options)
+          end
+        else
+          repo.index.index(document, **options)
+        end
+      end
+    end
+
+    register_callback(:indexing, :update, IndexingOnUpdate)
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Esse::ActiveRecord
+  module Callbacks
+    class UpdateLazyAttribute < Callback
+      attr_reader :attribute_name
+
+      def initialize(attribute_name:, **kwargs, &block)
+        @attribute_name = attribute_name
+        super(**kwargs, &block)
+      end
+
+      def call(model)
+        related_ids = Array(block_result || model.id)
+        return true if related_ids.empty?
+
+        repo.update_documents_attribute(attribute_name, *related_ids, **options)
+
+        true
+      end
+    end
+
+    register_callback(:update_lazy_attribute, :create, UpdateLazyAttribute)
+    register_callback(:update_lazy_attribute, :update, UpdateLazyAttribute)
+    register_callback(:update_lazy_attribute, :destroy, UpdateLazyAttribute)
+  end
+end

data/lib/esse/active_record/callbacks.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Esse
+  module ActiveRecord
+    class Callback
+      attr_reader :repo, :options, :block_result
+
+      def initialize(repo:, block_result: nil, **kwargs)
+        @repo = repo
+        @options = kwargs
+        @block_result = block_result
+      end
+
+      def call(model)
+        raise NotImplementedError, 'You must implement #call method'
+      end
+    end
+
+    module Callbacks
+      class << self
+        def to_h
+          @callbacks || {}.freeze
+        end
+
+        def register_callback(identifier, operation, callback_class)
+          unless callback_class < Esse::ActiveRecord::Callback
+            raise ArgumentError, 'callback_class must be a subclass of Esse::ActiveRecord::Callback'
+          end
+
+          key = :"#{identifier}_on_#{operation}"
+
+          @callbacks = @callbacks ? @callbacks.dup : {}
+          if @callbacks.key?(key)
+            raise ArgumentError, "callback #{identifier} for #{operation} operation already registered"
+          end
+
+          @callbacks[key] = callback_class
+        ensure
+          @callbacks&.freeze
+        end
+
+        def registered?(identifier, operation)
+          return false unless @callbacks
+
+          @callbacks.key?(:"#{identifier}_on_#{operation}")
+        end
+
+        def fetch!(identifier, operation)
+          key = :"#{identifier}_on_#{operation}"
+          if registered?(identifier, operation)
+            [key, @callbacks[key]]
+          else
+            raise ArgumentError, "callback #{identifier} for #{operation} operation not registered"
+          end
+        end
+      end
+    end
+  end
+end
+
+require_relative 'callbacks/indexing_on_create'
+require_relative 'callbacks/indexing_on_update'
+require_relative 'callbacks/indexing_on_destroy'
+require_relative 'callbacks/update_lazy_attribute'

data/lib/esse/active_record/hooks.rb

@@ -82,7 +82,7 @@ module Esse
         def ensure_registered_model_class!(model_class)
           return if registered_model_class?(model_class)
 
-          raise ArgumentError, "Model class #{model_class} is not registered. The model should inherit from Esse::ActiveRecord::Model and have a `index_callbacks' callback defined"
+          raise ArgumentError, "Model class #{model_class} is not registered. The model should inherit from Esse::ActiveRecord::Model and have a `index_callback' callback defined"
         end
 
         # Check if the given model is enabled for indexing. If no repository is specified, all repositories will be checked.
@@ -147,7 +147,7 @@ module Esse
         # Returns a list of all repositories for the given model
         # @return [Array<Symbol>]
         def model_repos(model_class)
-          expand_index_repos(*model_class.esse_index_repos.keys)
+          expand_index_repos(*model_class.esse_callbacks.keys)
         end
 
         # Returns a list of all repositories for the given model

data/lib/esse/active_record/model.rb

@@ -5,93 +5,68 @@ module Esse
     module Model
       extend ActiveSupport::Concern
 
-      def self.inherited(subclass)
-        super
-        subclass.esse_index_repos = esse_index_repos.dup
-      end
-
       module ClassMethods
-        attr_reader :esse_index_repos
+        extend Esse::Deprecations::Deprecate
 
-        # Define callback for create/update/delete elasticsearch index document after model commit.
-        #
-        # @param [String] index_repo_name The path of index and repository name.
-        #   For example a index with a single repository named `users` is `users`. And a index with
-        #   multiple repositories named `animals` and `dog` as the repository name is `animals/dog`.
-        #   For namespace, use `/` as the separator.
-        # @raise [ArgumentError] when the repo and events are already registered
-        # @raise [ArgumentError] when the specified index have multiple repos
-        def index_callbacks(index_repo_name, on: %i[create update destroy], **options, &block)
-          @esse_index_repos ||= {}
+        def esse_callbacks
+          @esse_callbacks ||= {}.freeze
+        end
 
-          operation_name = :index
-          if esse_index_repos.dig(index_repo_name, operation_name)
-            raise ArgumentError, format('index repository %<name>p already registered %<op>s operation', name: index_repo_name, op: operation_name)
-          end
+        def esse_callback(index_repo_name, operation_name, on: %i[create update destroy], **options, &block)
+          @esse_callbacks = esse_callbacks.dup
+          if_enabled = -> { Esse::ActiveRecord::Hooks.enabled?(index_repo_name) && Esse::ActiveRecord::Hooks.enabled_for_model?(self.class, index_repo_name) }
 
-          esse_index_repos[index_repo_name] ||= {}
-          esse_index_repos[index_repo_name][operation_name] = {
-            record: block || -> { self },
-            options: options,
-          }
+          Array(on).each do |event|
+            identifier, klass = Esse::ActiveRecord::Callbacks.fetch!(operation_name, event)
 
-          Esse::ActiveRecord::Hooks.register_model(self)
+            if @esse_callbacks.dig(index_repo_name, identifier)
+              raise ArgumentError, format('index repository %<name>p already registered %<op>s operation', name: index_repo_name, op: operation_name)
+            end
+
+            @esse_callbacks[index_repo_name] = @esse_callbacks[index_repo_name]&.dup || {}
+            @esse_callbacks[index_repo_name][identifier] = [klass, options, block]
 
-          if_enabled = -> { Esse::ActiveRecord::Hooks.enabled?(index_repo_name) && Esse::ActiveRecord::Hooks.enabled_for_model?(self.class, index_repo_name) }
-          (on & %i[create]).each do |event|
             after_commit(on: event, if: if_enabled) do
-              opts = self.class.esse_index_repos.fetch(index_repo_name).fetch(operation_name)
-              record = opts.fetch(:record)
-              record = instance_exec(&record) if record.respond_to?(:call)
-              repo = Esse::ActiveRecord::Hooks.resolve_index_repository(index_repo_name)
-              document = repo.serialize(record)
-              repo.index.index(document, **opts[:options]) if document
-              true
+              klass, options, block = self.class.esse_callbacks.fetch(index_repo_name).fetch(identifier)
+              options[:repo] = Esse::ActiveRecord::Hooks.resolve_index_repository(index_repo_name)
+              options[:block_result] = instance_exec(&block) if block.respond_to?(:call)
+              instance = klass.new(**options)
+              instance.call(self)
             end
           end
-          (on & %i[update]).each do |event|
-            after_commit(on: event, if: if_enabled) do
-              opts = self.class.esse_index_repos.fetch(index_repo_name).fetch(operation_name)
-              record = opts.fetch(:record)
-              record = instance_exec(&record) if record.respond_to?(:call)
-              repo = Esse::ActiveRecord::Hooks.resolve_index_repository(index_repo_name)
-              document = repo.serialize(record)
-              next true unless document
-
-              repo.index.index(document, **opts[:options])
-              next true unless document.routing
-
-              prev_record = self.class.new(attributes.merge(previous_changes.transform_values(&:first))).tap(&:readonly!)
-              prev_document = repo.serialize(prev_record)
 
-              next true unless prev_document
-              next true if [prev_document.id, prev_document.routing].include?(nil)
-              next true if prev_document.routing == document.routing
-              next true if prev_document.id != document.id
+          Esse::ActiveRecord::Hooks.register_model(self)
+        ensure
+          @esse_callbacks&.each_value { |v| v.freeze }&.freeze
+        end
 
-              begin
-                repo.index.delete(prev_document, **opts[:options])
-              rescue Esse::Transport::NotFoundError
+        # Define callback for create/update/delete elasticsearch index document after model commit.
+        #
+        # @param [String] index_repo_name The path of index and repository name.
+        #   For example a index with a single repository named `users` is `users`. And a index with
+        #   multiple repositories named `animals` and `dog` as the repository name is `animals/dog`.
+        #   For namespace, use `/` as the separator.
+        # @raise [ArgumentError] when the repo and events are already registered
+        # @raise [ArgumentError] when the specified index have multiple repos
+        def index_callback(index_repo_name, on: %i[create update destroy], with: nil, **options, &block)
+          if with
+            Array(on).each do |event|
+              if on == :update
+                esse_callback(index_repo_name, :indexing, on: event, with: with, **options, &block)
+              else
+                esse_callback(index_repo_name, :indexing, on: event, **options, &block)
               end
-
-              true
-            end
-          end
-          (on & %i[destroy]).each do |event|
-            after_commit(on: event, if: if_enabled) do
-              opts = self.class.esse_index_repos.fetch(index_repo_name).fetch(operation_name)
-              record = opts.fetch(:record)
-              record = instance_exec(&record) if record.respond_to?(:call)
-              repo = Esse::ActiveRecord::Hooks.resolve_index_repository(index_repo_name)
-              document = repo.serialize(record)
-              repo.index.delete(document, **opts[:options]) if document
-              true
-            rescue Esse::Transport::NotFoundError
-              true
             end
+          else
+            esse_callback(index_repo_name, :indexing, on: on, **options, &block)
           end
         end
 
+        def update_lazy_attribute_callback(index_repo_name, attribute_name, on: %i[create update destroy], **options, &block)
+          options[:attribute_name] = attribute_name
+          esse_callback(index_repo_name, :update_lazy_attribute, on: on, **options, &block)
+        end
+
         # Disable indexing for the block execution on model level
         # Example:
         #  User.without_indexing { }
@@ -101,6 +76,16 @@ module Esse
             yield
           end
         end
+
+        def index_callbacks(*args, **options, &block)
+          index_callback(*args, **options, &block)
+        end
+        deprecate :index_callbacks, :index_callback, 2024, 12
+
+        def esse_index_repos
+          esse_callbacks
+        end
+        deprecate :esse_index_repos, :esse_callbacks, 2024, 12
       end
     end
   end

data/lib/esse/active_record/version.rb

@@ -2,6 +2,6 @@
 
 module Esse
   module ActiveRecord
-    VERSION = '0.2.1'
+    VERSION = '0.3.2'
   end
 end

data/lib/esse/active_record.rb

@@ -3,6 +3,7 @@
 require 'esse'
 require 'active_record'
 require_relative 'active_record/version'
+require_relative 'active_record/callbacks'
 require_relative 'active_record/model'
 require_relative 'active_record/hooks'
 require_relative 'active_record/collection'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esse-active_record
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Marcos G. Zimmermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-04 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: esse
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -222,6 +222,11 @@ files:
 - ci/Gemfile.rails-7.1
 - ci/Gemfile.rails-7.1.lock
 - lib/esse/active_record.rb
+- lib/esse/active_record/callbacks.rb
+- lib/esse/active_record/callbacks/indexing_on_create.rb
+- lib/esse/active_record/callbacks/indexing_on_destroy.rb
+- lib/esse/active_record/callbacks/indexing_on_update.rb
+- lib/esse/active_record/callbacks/update_lazy_attribute.rb
 - lib/esse/active_record/collection.rb
 - lib/esse/active_record/hooks.rb
 - lib/esse/active_record/model.rb