esse-async_indexing 0.0.2

data/lib/esse/plugins/async_indexing.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Esse
+  module Plugins
+    module AsyncIndexing
+      module RepositoryClassMethods
+        DEFAULT_ASYNC_INDEXING_JOBS = {
+          import: ->(service:, repo:, operation:, ids:, **kwargs) {
+            unless (ids = Esse::ArrayUtils.wrap(ids)).empty?
+              batch_id = Esse::RedisStorage::Queue.for(repo: repo).enqueue(values: ids)
+              Esse::AsyncIndexing.worker("Esse::AsyncIndexing::Jobs::ImportBatchIdJob", service: service)
+                .with_args(repo.index.name, repo.repo_name, batch_id, Esse::HashUtils.deep_transform_keys(kwargs, &:to_s))
+                .push
+            end
+          },
+          index: ->(service:, repo:, operation:, id:, **kwargs) {
+            if id
+              Esse::AsyncIndexing.worker("Esse::AsyncIndexing::Jobs::DocumentIndexByIdJob", service: service)
+                .with_args(repo.index.name, repo.repo_name, id, Esse::HashUtils.deep_transform_keys(kwargs, &:to_s))
+                .push
+            end
+          },
+          update: ->(service:, repo:, operation:, id:, **kwargs) {
+            if id
+              Esse::AsyncIndexing.worker("Esse::AsyncIndexing::Jobs::DocumentUpdateByIdJob", service: service)
+                .with_args(repo.index.name, repo.repo_name, id, Esse::HashUtils.deep_transform_keys(kwargs, &:to_s))
+                .push
+            end
+          },
+          delete: ->(service:, repo:, operation:, id:, **kwargs) {
+            if id
+              Esse::AsyncIndexing.worker("Esse::AsyncIndexing::Jobs::DocumentDeleteByIdJob", service: service)
+                .with_args(repo.index.name, repo.repo_name, id, Esse::HashUtils.deep_transform_keys(kwargs, &:to_s))
+                .push
+            end
+          }
+        }.freeze
+
+        # This method is used to retrieve only the ids of the documents in the collection.
+        # It's used to asynchronously index the documents.
+        # The #each_batch_ids method is optional and should be implemented by the collection class.
+        #
+        # @return [Enumerator] The enumerator
+        def batch_ids(*args, **kwargs, &block)
+          if implement_batch_ids?
+            Enumerator.new do |yielder|
+              @collection_proc.new(*args, **kwargs).each_batch_ids do |batch|
+                yielder.yield(batch)
+              end
+            end
+          else
+            raise NotImplementedError, format("the %<t>p collection does not implement the #each_batch_ids method", t: @collection_proc)
+          end
+        end
+
+        # Check if the collection class implements the each_batch_ids method
+        #
+        # @return [Boolean] True if the collection class implements the each_batch_ids method
+        # @see #each_batch_ids
+        def implement_batch_ids?
+          @collection_proc.is_a?(Class) && @collection_proc.instance_methods.include?(:each_batch_ids)
+        end
+
+        # DSL to define custom job enqueueing
+        #
+        # async_indexing_job(:import) do |service:, repo:, operation:, ids:, **kwargs|
+        #   MyCustomJob.perform_later(repo.index.name, ids, **kwargs)
+        # end
+        # async_indexing_job(:index, :update, :delete) do |service:, repo:, operation:, id, **kwargs|
+        #   MyCustomJob.perform_later(repo.index.name, [id], **kwargs)
+        # end
+        def async_indexing_job(*operations, &block)
+          operations = AsyncIndexingJobValidator::OPERATIONS if operations.empty?
+          AsyncIndexingJobValidator.call(operations, block)
+          hash = operations.each_with_object({}) { |operation, h| h[operation] = block }
+          @async_indexing_jobs = async_indexing_jobs.dup.merge(hash)
+        ensure
+          @async_indexing_jobs.freeze
+        end
+
+        def async_indexing_jobs
+          @async_indexing_jobs || {}.freeze
+        end
+
+        def async_indexing_job_for(operation)
+          async_indexing_jobs[operation] || DEFAULT_ASYNC_INDEXING_JOBS[operation] || raise(ArgumentError, "The #{operation} operation is not implemented")
+        end
+
+        class AsyncIndexingJobValidator
+          OPERATIONS = %i[import index update delete].freeze
+
+          def self.call(operations, block)
+            unless block.is_a?(Proc)
+              raise ArgumentError, "The block of async_indexing_job must be a callable object"
+            end
+
+            operations.each do |operation|
+              next if OPERATIONS.include?(operation)
+              raise ArgumentError, format("Unrecognized operation: %<operation>p. Valid operations are: %<valid>p", operation: operation, valid: OPERATIONS)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/esse-async-indexing.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "esse/async_indexing"

data/lib/esse-async_indexing.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "esse/async_indexing"

metadata

@@ -0,0 +1,244 @@
+--- !ruby/object:Gem::Specification
+name: esse-async_indexing
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Marcos G. Zimmermann
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: esse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+- !ruby/object:Gem::Dependency
+  name: esse-redis_storage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extends Esse to allow async indexing using Faktory or Sidekiq.
+email:
+- mgzmaster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- docker-compose.yml
+- lib/esse-async-indexing.rb
+- lib/esse-async_indexing.rb
+- lib/esse/async_indexing.rb
+- lib/esse/async_indexing/actions.rb
+- lib/esse/async_indexing/actions/batch_delete.rb
+- lib/esse/async_indexing/actions/batch_import.rb
+- lib/esse/async_indexing/actions/batch_import_all.rb
+- lib/esse/async_indexing/actions/batch_update.rb
+- lib/esse/async_indexing/actions/bulk_update_lazy_document_attribute.rb
+- lib/esse/async_indexing/actions/coerce_index_repository.rb
+- lib/esse/async_indexing/actions/delete_document.rb
+- lib/esse/async_indexing/actions/import_batch_id.rb
+- lib/esse/async_indexing/actions/index_document.rb
+- lib/esse/async_indexing/actions/update_document.rb
+- lib/esse/async_indexing/actions/update_lazy_document_attribute.rb
+- lib/esse/async_indexing/actions/upsert_document.rb
+- lib/esse/async_indexing/active_record.rb
+- lib/esse/async_indexing/active_record_callbacks/callback.rb
+- lib/esse/async_indexing/active_record_callbacks/lazy_update_attribute.rb
+- lib/esse/async_indexing/active_record_callbacks/on_create.rb
+- lib/esse/async_indexing/active_record_callbacks/on_destroy.rb
+- lib/esse/async_indexing/active_record_callbacks/on_update.rb
+- lib/esse/async_indexing/adapters.rb
+- lib/esse/async_indexing/adapters/adapter.rb
+- lib/esse/async_indexing/adapters/faktory.rb
+- lib/esse/async_indexing/adapters/sidekiq.rb
+- lib/esse/async_indexing/cli.rb
+- lib/esse/async_indexing/cli/async_import.rb
+- lib/esse/async_indexing/config.rb
+- lib/esse/async_indexing/configuration.rb
+- lib/esse/async_indexing/configuration/base.rb
+- lib/esse/async_indexing/configuration/faktory.rb
+- lib/esse/async_indexing/configuration/sidekiq.rb
+- lib/esse/async_indexing/errors.rb
+- lib/esse/async_indexing/jobs/bulk_update_lazy_document_attribute_job.rb
+- lib/esse/async_indexing/jobs/document_delete_by_id_job.rb
+- lib/esse/async_indexing/jobs/document_index_by_id_job.rb
+- lib/esse/async_indexing/jobs/document_update_by_id_job.rb
+- lib/esse/async_indexing/jobs/document_upsert_by_id_job.rb
+- lib/esse/async_indexing/jobs/import_all_job.rb
+- lib/esse/async_indexing/jobs/import_batch_id_job.rb
+- lib/esse/async_indexing/jobs/update_lazy_document_attribute_job.rb
+- lib/esse/async_indexing/testing.rb
+- lib/esse/async_indexing/version.rb
+- lib/esse/async_indexing/worker.rb
+- lib/esse/async_indexing/workers.rb
+- lib/esse/async_indexing/workers/faktory.rb
+- lib/esse/async_indexing/workers/shared_class_methods.rb
+- lib/esse/async_indexing/workers/sidekiq.rb
+- lib/esse/plugins/async_indexing.rb
+homepage: https://github.com/marcosgz/esse-async_indexing
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/marcosgz/esse-async_indexing
+  source_code_uri: https://github.com/marcosgz/esse-async_indexing
+  changelog_uri: https://github.com/marcosgz/esse-async_indexing/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: Esse extension to allow async indexing using Faktory or Sidekiq.
+test_files: []