esse-active_record 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eeb304ba4915091f1b51addb850fc9161b1c415dcf61fdd9f0b189b43b7b4ac2
+  data.tar.gz: 52182a2e70cdb56f4658ef4ba515a86267ccc4b48a5e1ef5f2895ca192aca6be
+SHA512:
+  metadata.gz: 24eb997cfdb498b4f8725e405aef700c22dd0a31c5d08b8092a923022543e06d9235f63c75a0d8099f06d1cd69fd00a6ecd4a7d8326bd807fe609fb0b295ad93
+  data.tar.gz: e770dcd174126061bd938979ea4d36f9c761a3b4efb6f8360a73642cc423efa57c9c22a9ac637b5453ac4ab497f7cb5e09509b0e60608989b9114ab03099bd5e

data/.rubocop.yml

@@ -0,0 +1,35 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - standard/cop/block_single_line_braces
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
+  Exclude:
+    - "db/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'esse', github: 'marcosgz/esse', branch: 'master'
+gem 'sqlite3', '~> 1.3.6'
+gem 'activerecord', '~> 5.2'
+
+# Specify your gem's dependencies in esse-active_record.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,128 @@
+GIT
+  remote: https://github.com/marcosgz/esse.git
+  revision: fa4eb4d8c54aae89c388415585b4b27c75b31198
+  branch: master
+  specs:
+    esse (0.2.1)
+      multi_json
+      thor (>= 0.19)
+
+PATH
+  remote: .
+  specs:
+    esse-active_record (0.1.1)
+      activerecord (>= 4.2, < 8)
+      esse
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.8.1)
+      activesupport (= 5.2.8.1)
+    activerecord (5.2.8.1)
+      activemodel (= 5.2.8.1)
+      activesupport (= 5.2.8.1)
+      arel (>= 9.0)
+    activesupport (5.2.8.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    arel (9.0.0)
+    ast (2.4.2)
+    awesome_print (1.9.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    dotenv (2.7.6)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.16.2)
+    multi_json (1.15.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    sqlite3 (1.3.13)
+    standard (1.12.1)
+      rubocop (= 1.29.1)
+      rubocop-performance (= 1.13.3)
+    thor (1.2.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.10)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.2.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord (~> 5.2)
+  awesome_print
+  dotenv
+  esse!
+  esse-active_record!
+  pry
+  rake (~> 12.3)
+  rspec (~> 3.0)
+  rubocop (~> 1.20)
+  rubocop-performance (~> 1.11, >= 1.11.5)
+  rubocop-rspec (~> 2.4)
+  sqlite3 (~> 1.3.6)
+  standard (~> 1.3)
+  webmock (~> 3.14)
+  yard (~> 0.9.20)
+
+BUNDLED WITH
+   2.3.21

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Marcos G. Zimmermann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,226 @@
+# Esse ActiveRecord Plugin
+
+This gem is a [esse](https://github.com/marcosgz/esse) plugin for the ActiveRecord ORM. It provides a set of methods to simplify implementation of ActiveRecord models as datasource of esse indexes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'esse-active_record'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install esse-active_record
+
+## Usage
+
+Add the `:active_record` plugin and configure the `collection` with the ActiveRecord model you want to use.
+
+```ruby
+class UsersIndex < Esse::Index
+  plugin :active_record
+
+  repository :user do
+    collection ::User
+    serializer # ...
+  end
+end
+```
+
+Using multiple repositories is also possible:
+
+```ruby
+class UsersIndex < Esse::Index
+  plugin :active_record
+
+  repository :account do
+    collection ::Account
+    serializer # ...
+  end
+
+  repository :admin do
+    collection ::User.where(admin: true)
+    serializer # ...
+  end
+end
+```
+
+### Collection Scope
+It's also possible to specify custom scopes to the repository collection to be used to import data to the index:
+
+```ruby
+class UsersIndex < Esse::Index
+  plugin :active_record
+
+  repository :user do
+    collection ::User do
+      scope :active, -> { where(active: true) }
+      scope :role, ->(role) { where(role: role) }
+    end
+    serializer # ...
+  end
+end
+
+# Import data using the scopes
+#   > UsersIndex.elasticsearch.import(context: { active: true, role: 'admin' })
+#
+# Streaming data using the scopes
+#   > UsersIndex.documents(active: true, role: 'admin').first
+```
+
+## Collection Batch Context
+
+Assume that you have a collection of orders and you want to also include the customer data that lives in a external system. To avoid making a request for each order, you can use the `batch_context` to fetch the data in batches and make it available in the serializer context.
+
+```ruby
+class OrdersIndex < Esse::Index
+  plugin :active_record
+
+  repository :order do
+    collection ::Order do
+      batch_context :customers do |orders, **_existing_context|
+        # The return value will be available in the serializer context
+        # { customers: <value returned from this block> }
+        ExternalSystem::Customer.find_all_by_ids(orders.map(&:customer_id)).index_by(&:id) # => { 1 => <Customer>, 2 => <Customer> }
+      end
+    end
+    serializer do |order, customers: [], **_|
+      customer = customers[order.customer_id]
+      {
+        id: order.id,
+        customer: {
+          id: customer&.id,
+          name: customer&.name
+        }
+      }
+    end
+  end
+end
+```
+
+For active record associations, you can define the repository collection by eager loading the associations as usual:
+
+```ruby
+
+class OrdersIndex < Esse::Index
+  plugin :active_record
+
+  repository :order do
+    collection ::Order.includes(:customer)
+    serializer do |order, **_|
+      {
+        id: order.id,
+        customer: {
+          id: order.customer&.id,
+          name: order.customer&.name
+        }
+      }
+    end
+  end
+end
+```
+
+### Data Streaming Optionsou
+
+As default the active record support 3 streaming options:
+* `batch_size`: the number of documents to be streamed in each batch. Default is 1000;
+* `start`: the primary key value to start from, inclusive of the value;
+* `finish`: the primary key value to end at, inclusive of the value;
+
+This is useful when you want to import simultaneous data. You can make one process import all records between 1 and 10,000, and another from 10,000 and beyond
+
+```ruby
+UsersIndex.elasticsearch.import(context: { start: 1, finish: 10000, batch_size: 500 })
+```
+
+The default valueof `batch_size` can be also defined in the `collection` configuration:
+
+```ruby
+class UsersIndex < Esse::Index
+  plugin :active_record
+
+  repository :user do
+    collection ::User, batch_size: 500
+    serializer # ...
+  end
+end
+```
+
+### Indexing Callbacks
+
+The `index_callbacks` callback can be used to automaitcally index or delete documents after commit on create/update/destroy events.
+
+```ruby
+class UsersIndex < Esse::Index
+  plugin :active_record
+
+  repository :user, const: true do
+    collection ::User
+    serializer # ...
+  end
+
+end
+
+class User < ApplicationRecord
+  belongs_to :organization
+
+  # 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'
+  # 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
+end
+```
+
+Callbacks can also be disabled/enabled globally:
+
+```ruby
+Esse::ActiveRecord::Hoods.disable!
+Esse::ActiveRecord::Hoods.enable!
+Esse::ActiveRecord::Hoods.without_indexing do
+  10.times { User.create! }
+end
+```
+
+or by some specific list of index or index's repository
+
+```ruby
+Esse::ActiveRecord::Hoods.disable!(UsersIndex.repo)
+Esse::ActiveRecord::Hoods.enable!(UsersIndex.repo)
+Esse::ActiveRecord::Hoods.without_indexing(AccountsIndex UsersIndex.repo, ) do
+  10.times { User.create! }
+end
+```
+
+or by the model that the callback is configured
+
+```ruby
+User.without_indexing do
+  10.times { User.create! }
+end
+User.without_indexing(AccountsIndex) do
+  10.times { User.create! }
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake none` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcosgz/esse-active_record.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: %i[]

data/lib/esse/active_record/collection.rb

@@ -0,0 +1,129 @@
+module Esse
+  module ActiveRecord
+    class Collection
+      include Enumerable
+
+      # The model class or the relation to be used as the scope
+      # @return [Proc]
+      class_attribute :base_scope
+
+      # The number of records to be returned in each batch
+      # @return [Integer]
+      class_attribute :batch_size
+
+      # Hash with the custom scopes defined on the model
+      # @return [Hash]
+      class_attribute :scopes
+      self.scopes = {}
+
+      # The hash with the contexts as key and the transformer proc as value
+      # @return [Hash]
+      class_attribute :batch_contexts
+      self.batch_contexts = {}
+
+      class << self
+        def inspect
+          return super unless self < Esse::ActiveRecord::Collection
+          return super unless base_scope
+
+          format('#<Esse::ActiveRecord::Collection__%s>', model)
+        end
+
+        def model
+          raise(NotImplementedError, "No model defined for #{self}") unless base_scope
+
+          base_scope.call.all.model
+        end
+
+        def inherited(subclass)
+          super
+
+          subclass.scopes = scopes.dup
+          subclass.batch_contexts = batch_contexts.dup
+        end
+
+        def scope(name, proc = nil, override: false, &block)
+          proc = proc&.to_proc || block
+          raise ArgumentError, 'proc or block required' unless proc
+          raise ArgumentError, "scope `#{name}' already defined" if !override && scopes.key?(name.to_sym)
+
+          scopes[name.to_sym] = proc
+        end
+
+        def batch_context(name, proc = nil, override: false, &block)
+          proc = proc&.to_proc || block
+          raise ArgumentError, 'proc or block required' unless proc
+          raise ArgumentError, "batch_context `#{name}' already defined" if !override && batch_contexts.key?(name.to_sym)
+
+          batch_contexts[name.to_sym] = proc
+        end
+      end
+
+      attr_reader :start, :finish, :batch_size, :params
+
+      # @param [Integer] start Specifies the primary key value to start from, inclusive of the value.
+      # @param [Integer] finish  Specifies the primary key value to end at, inclusive of the value.
+      # @param [Integer] batch_size The number of records to be returned in each batch. Defaults to 1000.
+      # @param [Hash] params The query criteria
+      # @return [Esse::ActiveRecord::Collection]
+      def initialize(start: nil, finish: nil, batch_size: nil, **params)
+        @start = start
+        @finish = finish
+        @batch_size = batch_size || self.class.batch_size || 1000
+        @params = params
+      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)
+          end
+          yield(rows, **kwargs)
+        end
+      end
+
+      def dataset(**kwargs)
+        query = self.class.base_scope&.call || raise(NotImplementedError, "No scope defined for #{self.class}")
+        query = query.except(:order, :limit, :offset)
+        params.merge(kwargs).each do |key, value|
+          if self.class.scopes.key?(key)
+            scope_proc = self.class.scopes[key]
+            query = if scope_proc.arity == 0
+              query.instance_exec(&scope_proc)
+            else
+              query.instance_exec(value, &scope_proc)
+            end
+          elsif query.model.columns_hash.key?(key.to_s)
+            query = query.where(key => value)
+          else
+            raise ArgumentError, "Unknown scope `#{key}'"
+          end
+        end
+
+        query
+      end
+
+      def inspect
+        return super unless self.class < Esse::ActiveRecord::Collection
+        return super unless self.class.base_scope
+
+        vars = instance_variables.map do |n|
+          "#{n}=#{instance_variable_get(n).inspect}"
+        end
+        format('#<Esse::ActiveRecord::Collection__%s:0x%x %s>', self.class.model, object_id, vars.join(', '))
+      end
+
+      protected
+
+      def batch_options
+        {
+          batch_size: batch_size
+        }.tap do |hash|
+          hash[:start] = start if start
+          hash[:finish] = finish if finish
+        end
+      end
+    end
+  end
+end

data/lib/esse/active_record/hooks.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+module Esse
+  module ActiveRecord
+    module Hooks
+      STORE_STATE_KEY = :esse_active_record_hooks
+
+      class << self
+        def register_model(model_class)
+          @models ||= []
+          @models |= [model_class]
+        end
+
+        def models
+          @models || []
+        end
+
+        def model_names
+          models.map(&:to_s)
+        end
+
+        # Global enable indexing callbacks. If no repository is specified, all repositories will be enabled.
+        # @param repos [Array<String, Esse::Index, Esse::Repo>]
+        # @return [void]
+        def enable!(*repos)
+          filter_repositories(*repos).each do |repo|
+            state[:repos][repo] = true
+          end
+        end
+
+        # Global disable indexing callbacks. If no repository is specified, all repositories will be disabled.
+        # @param repos [Array<String, Esse::Index, Esse::Repo>]
+        # @return [void]
+        def disable!(*repos)
+          filter_repositories(*repos).each do |repo|
+            state[:repos][repo] = false
+          end
+        end
+
+        # Check if the given repository is enabled for indexing. If no repository is specified, all repositories will be checked.
+        #
+        # @param repos [Array<String, Esse::Index, Esse::Repo>]
+        # @return [Boolean]
+        def disabled?(*repos)
+          filter_repositories(*repos).all? { |repo| !state[:repos][repo] }
+        end
+
+        # Check if the given repository is enabled for indexing. If no repository is specified, all repositories will be checked.
+        #
+        # @param repos [Array<String, Esse::Index, Esse::Repo>]
+        # @return [Boolean]
+        def enabled?(*repos)
+          filter_repositories(*repos).all? { |repo| state[:repos][repo] }
+        end
+
+        # Enable model indexing callbacks for the given model. If no repository is specified, all repositories will be enabled.
+        #
+        # @param model_class [Class]
+        # @param repos [Array<String, Esse::Index, Esse::Repo>]
+        # @raise [ArgumentError] if model repository is not registered for the given model
+        # @return [void]
+        def enable_model!(model_class, *repos)
+          ensure_registered_model_class!(model_class)
+          filter_model_repositories(model_class, *repos).each do |repo|
+            state[:models][model_class][repo] = true
+          end
+        end
+
+        # Disable model indexing callbacks for the given model. If no repository is specified, all repositories will be disabled.
+        #
+        # @param model_class [Class]
+        # @param repos [Array<String, Esse::Index, Esse::Repo>]
+        # @raise [ArgumentError] if model repository is not registered for the given model
+        # @return [void]
+        def disable_model!(model_class, *repos)
+          ensure_registered_model_class!(model_class)
+          filter_model_repositories(model_class, *repos).each do |repo|
+            state[:models][model_class][repo] = false
+          end
+        end
+
+        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"
+        end
+
+        # Check if the given model is enabled for indexing. If no repository is specified, all repositories will be checked.
+        #
+        # @param model_class [Class]
+        # @param repos [Array<String, Esse::Index, Esse::Repo>]
+        # @return [Boolean]
+        def enabled_for_model?(model_class, *repos)
+          return false unless registered_model_class?(model_class)
+
+          filter_model_repositories(model_class, *repos).all? do |repo|
+            state.dig(:models, model_class, repo) != false
+          end
+        end
+
+        # Disable indexing callbacks execution for the block execution.
+        # Example:
+        #  Esse::ActiveRecord::Hooks.without_indexing { User.create! }
+        #  Esse::ActiveRecord::Hooks.without_indexing(UsersIndex, AccountsIndex.repo(:user)) { User.create! }
+        def without_indexing(*repos)
+          state_before_disable = state[:repos].dup
+          disable!(*repos)
+
+          yield
+        ensure
+          state[:repos] = state_before_disable
+        end
+
+        # Disable model indexing callbacks execution for the block execution for the given model.
+        # Example:
+        #  BroadcastChanges.without_indexing_for_model(User) { }
+        #  BroadcastChanges.without_indexing_for_model(User, :datasync, :other) { }
+        def without_indexing_for_model(model_class, *repos)
+          state_before_disable = state[:models].dig(model_class).dup
+          disable_model!(model_class, *repos)
+          yield
+        ensure
+          if state_before_disable.nil?
+            state[:models].delete(model_class)
+          else
+            state[:models][model_class] = state_before_disable
+          end
+        end
+
+        def resolve_index_repository(name)
+          index_name, repo_name = name.to_s.underscore.split('::').join('/').split(':', 2)
+          if index_name !~ /(I|_i)ndex$/ && index_name !~ /_index\/([\w_]+)$/
+            index_name = format('%<index_name>s_index', index_name: index_name)
+          end
+          klass = index_name.classify.constantize
+          return klass if klass <= Esse::Repository
+
+          repo_name.present? ? klass.repo(repo_name) : klass.repo
+        end
+
+        private
+
+        def all_repos
+          models.flat_map(&method(:model_repos)).uniq
+        end
+
+        # 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)
+        end
+
+        # Returns a list of all repositories for the given model
+        # If no repository is specified, all repositories will be returned.
+        # @return [Array<*Esse::Repository>] List of repositories
+        def filter_repositories(*repos)
+          (expand_index_repos(*repos) & all_repos).presence || all_repos
+        end
+
+        # Return repositorys for the given model. If no repository is specified, all repositories will be returned.
+        #
+        # @param model_class [Class]
+        # @param repos [Array<*Esse::Repository>] List of repositories to check for the given model
+        # @return [Array<*Esse::Repository>] List of repositories
+        def filter_model_repositories(model_class, *repos)
+          model_repos = model_repos(model_class) & all_repos
+          (expand_index_repos(*repos) & model_repos).presence || model_repos
+        end
+
+        def expand_index_repos(*repos)
+          repos.flat_map do |repo_name|
+            case repo_name
+            when Class
+              repo_name <= Esse::Index ? repo_name.repo_hash.values : repo_name
+            when String, Symbol
+              resolve_index_repository(repo_name)
+            else
+              raise ArgumentError, "Invalid index or repository name: #{repo_name.inspect}"
+            end
+          end
+        end
+
+        # Check if model class is registered
+        # @return [Boolean] true if model class is registered
+        def registered_model_class?(model_class)
+          models.include?(model_class)
+        end
+
+        # Data Structure:
+        #
+        # repos: { <Esse::Repository class> => <true|false>, ... }
+        # models: {
+        #   <ActiveRecord::Base class> => {
+        #     <Esse::Repository class> => <true|false>
+        #   }
+        # }
+        def state
+          global_store[STORE_STATE_KEY] ||= {
+            repos: all_repos.map { |k| [k, true] }.to_h, # Control global state of the index repository level
+            models: Hash.new { |h, k| h[k] = {} }, # Control the state of the model & index repository level
+          }
+        end
+
+        def global_store
+          Thread.current
+        end
+      end
+    end
+  end
+end

data/lib/esse/active_record/model.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Esse
+  module ActiveRecord
+    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
+
+        # 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 ||= {}
+
+          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
+
+          esse_index_repos[index_repo_name] ||= {}
+          esse_index_repos[index_repo_name][operation_name] = {
+            record: (block || -> { self }),
+            options: options,
+          }
+
+          Esse::ActiveRecord::Hooks.register_model(self)
+
+          if_enabled = -> { Esse::ActiveRecord::Hooks.enabled?(index_repo_name) && Esse::ActiveRecord::Hooks.enabled_for_model?(self.class, index_repo_name) }
+          (on & %i[create 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)
+              repo.elasticsearch.index_document(document, **opts[:options]) if document
+              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.elasticsearch.delete_document(document, **opts[:options]) if document
+              true
+            end
+          end
+        end
+
+        # Disable indexing for the block execution on model level
+        # Example:
+        #  User.without_indexing { }
+        #  User.without_indexing(UsersIndex, AccountsIndex::User) { }
+        def without_indexing(*repos)
+          Esse::ActiveRecord::Hooks.without_indexing_for_model(self, *repos) do
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/esse/active_record/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Esse
+  module ActiveRecord
+    VERSION = '0.1.1'
+  end
+end

data/lib/esse/active_record.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'esse'
+require 'active_record'
+require_relative 'active_record/version'
+require_relative 'active_record/model'
+require_relative 'active_record/hooks'
+require_relative 'active_record/collection'
+require_relative 'plugins/active_record'
+
+module Esse
+  module ActiveRecord
+  end
+end

data/lib/esse/plugins/active_record.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+module Esse
+  module Plugins
+    module ActiveRecord
+      module RepositoryClassMethods
+        # @param [Class] model_class The ActiveRecord Relation or model class
+        # @param [Hash] options The options
+        # @option options [Symbol] :batch_size The batch size for the collection
+        def collection(*args, **kwargs, &block)
+          unless model_or_relation?(args.first)
+            return super(*args, **kwargs, &block)
+          end
+          model_class = args.shift
+
+          repo = Class.new(Esse::ActiveRecord::Collection)
+          repo.base_scope = -> { model_class }
+          repo.batch_size = kwargs.delete(:batch_size) if kwargs.key?(:batch_size)
+          repo.class_eval(&block) if block
+
+          super(repo, *args, **kwargs)
+        end
+
+        def dataset(**params)
+          if @collection_proc.nil?
+            raise NotImplementedError, "Can't call `dataset' on a repository without a collection defined"
+          elsif @collection_proc.is_a?(Class) && @collection_proc < Esse::ActiveRecord::Collection
+            @collection_proc.new(**params).dataset
+          elsif defined? super
+            super
+          else
+            raise NoMethodError, "undefined method `dataset' for #{self}"
+          end
+        end
+
+        private
+
+        def model_or_relation?(klass)
+          return true if klass.is_a?(Class) && klass < ::ActiveRecord::Base
+          return true if klass.is_a?(::ActiveRecord::Relation)
+
+          false
+        end
+      end
+    end
+  end
+end

data/sig/esse/active_record.rbs

@@ -0,0 +1,6 @@
+module Esse
+  module ActiveRecord
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,253 @@
+--- !ruby/object:Gem::Specification
+name: esse-active_record
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Marcos G. Zimmermann
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: esse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: dotenv
+  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: 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.5
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: ActiveRecord extensions for Esse
+email:
+- mgzmaster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/esse/active_record.rb
+- lib/esse/active_record/collection.rb
+- lib/esse/active_record/hooks.rb
+- lib/esse/active_record/model.rb
+- lib/esse/active_record/version.rb
+- lib/esse/plugins/active_record.rb
+- sig/esse/active_record.rbs
+homepage: https://github.com/marcosgz/esse-active_record
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/marcosgz/esse-active_record
+  source_code_uri: https://github.com/marcosgz/esse-active_record
+  changelog_uri: https://github.com/marcosgz/esse-active_record/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.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key:
+specification_version: 4
+summary: ActiveRecord extensions for Esse
+test_files: []