elasticsearch-model 7.2.1 → 8.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1aecf263867f2176d7819eccd7e23f9b37bc85132223b8f64398ab85736ea75
-  data.tar.gz: af80ff000fcf065f2694141bfcdc282a947cfea05f5ece2f11a24897f5753039
+  metadata.gz: 0c760a3ffa71e37511564ccafa368fbaf6c7bb8329c0a472c9e1ef9b26739740
+  data.tar.gz: 1ded565b299e1a95f35315bdff3645b564d401f2970943ad8c5445d6ee39e1ea
 SHA512:
-  metadata.gz: 246ae4f642a662a4a0c5fe6e26581c052c15ddf868d9b47b640c3f996e584056a8facc4004d61151647e67e6624d1bb16cad90a4513f303ad0afdeaf84b1eedf
-  data.tar.gz: 406c37164bb6fc16068d2edcf6e1183d9c2ba34420d57fab9d3f288416fd0d75173ecc4ad3f37236051d517db717c4fb37ae2d44663f87a6b28213637ea8f7a5
+  metadata.gz: a5fca8875b77ac7c26a9bb42802bca17bc88837c356a9ae83ca4404ea4779ad8bd2dc3c039332075a68a17cbfb5f815a34eacc93648dc70f50a42c12aea9026d
+  data.tar.gz: 1d56f2c15d073532f89c31b78ccdeabc84ec1dc7dc501728770eea544f9ceb4e8d126570c8593e23dfb381f5249645de6ed0cecb288dbdf67de886e4ad200f45

data/Gemfile

@@ -21,6 +21,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :testing do
+  gem 'debug' unless defined?(JRUBY_VERSION)
   gem 'pry-nav'
   gem 'rspec'
 end

data/README.md

@@ -6,17 +6,19 @@ It aims to simplify integration of Ruby classes ("models"), commonly found e.g.
 
 ## Compatibility
 
-This library is compatible with Ruby 2.4 and higher.
+This library is compatible with Ruby 3 and higher.
 
-The library version numbers follow the Elasticsearch major versions. The `main` branch is compatible with the latest Elasticsearch stack stable release.
+The version numbers follow the Elasticsearch major versions. Currently the `main` branch is compatible with version `7.x` of the Elasticsearch stack. **We haven't tested and updated the code for Elasticsearch `8.0` yet**.
 
-| Rubygem       |   | Elasticsearch |
-|:-------------:|:-:| :-----------: |
-| 0.1           | → | 1.x           |
-| 2.x           | → | 2.x           |
-| 5.x           | → | 5.x           |
-| 6.x           | → | 6.x           |
-| main          | → | 7.x           |
+| Rubygem |   | Elasticsearch |
+|:-------:|:-:|:-------------:|
+| 0.1     | → | 1.x           |
+| 2.x     | → | 2.x           |
+| 5.x     | → | 5.x           |
+| 6.x     | → | 6.x           |
+| 7.x     | → | 7.x           |
+| 8.x     | → | 8.x           |
+| main    | → | 8.x           |
 
 ## Installation
 
@@ -267,8 +269,8 @@ It is possible to search across multiple models with the module method:
 ```ruby
 Elasticsearch::Model.search('fox', [Article, Comment]).results.to_a.map(&:to_hash)
 # => [
-#      {"_index"=>"articles", "_type"=>"article", "_id"=>"1", "_score"=>0.35136628, "_source"=>...},
-#      {"_index"=>"comments", "_type"=>"comment", "_id"=>"1", "_score"=>0.35136628, "_source"=>...}
+#      {"_index"=>"articles", "_id"=>"1", "_score"=>0.35136628, "_source"=>...},
+#      {"_index"=>"comments", "_id"=>"1", "_score"=>0.35136628, "_source"=>...}
 #    ]
 
 Elasticsearch::Model.search('fox', [Article, Comment]).records.to_a
@@ -343,7 +345,7 @@ response.results.first.title
 # => "Quick brown fox"
 ```
 
-Also, you can use the [**`elasticsearch-dsl`**](https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-dsl) library, which provides a specialized Ruby API for the Elasticsearch Query DSL:
+Also, you can use the [**`elasticsearch-dsl`**](https://github.com/elastic/elasticsearch-dsl-ruby) library, which provides a specialized Ruby API for the Elasticsearch Query DSL:
 
 ```ruby
 require 'elasticsearch/dsl'
@@ -413,13 +415,11 @@ Article.__elasticsearch__.create_index! force: true
 Article.__elasticsearch__.refresh_index!
 ```
 
-By default, index name and document type will be inferred from your class name,
-you can set it explicitly, however:
+By default, index name will be inferred from your class name, you can set it explicitly, however:
 
 ```ruby
 class Article
   index_name    "articles-#{Rails.env}"
-  document_type "post"
 end
 ```
 
@@ -527,11 +527,11 @@ class Indexer
     case operation.to_s
       when /index/
         record = Article.find(record_id)
-        Client.index  index: 'articles', type: 'article', id: record.id, body: record.__elasticsearch__.as_indexed_json
+        Client.index  index: 'articles', id: record.id, body: record.__elasticsearch__.as_indexed_json
       when /delete/
         begin
-          Client.delete index: 'articles', type: 'article', id: record_id
-        rescue Elasticsearch::Transport::Transport::Errors::NotFound
+          Client.delete index: 'articles', id: record_id
+        rescue Elastic::Transport::Transport::Errors::NotFound
           logger.debug "Article not found, ID: #{record_id}"
         end
       else raise ArgumentError, "Unknown operation '#{operation}'"
@@ -553,7 +553,7 @@ You'll see the job being processed in the console where you started the _Sidekiq
 Indexer JID-eb7e2daf389a1e5e83697128 DEBUG: ["index", "ID: 7"]
 Indexer JID-eb7e2daf389a1e5e83697128 INFO: PUT http://localhost:9200/articles/article/1 [status:200, request:0.004s, query:n/a]
 Indexer JID-eb7e2daf389a1e5e83697128 DEBUG: > {"id":1,"title":"Updated", ...}
-Indexer JID-eb7e2daf389a1e5e83697128 DEBUG: < {"ok":true,"_index":"articles","_type":"article","_id":"1","_version":6}
+Indexer JID-eb7e2daf389a1e5e83697128 DEBUG: < {"ok":true,"_index":"articles","_id":"1","_version":6}
 Indexer JID-eb7e2daf389a1e5e83697128 INFO: done: 0.006 sec
 ```
 

data/Rakefile

@@ -21,8 +21,7 @@ desc 'Run unit tests'
 task default: 'test:all'
 task test:    'test:all'
 
-gemfiles = ['5.0.gemfile', '6.0.gemfile']
-gemfiles << '4.0.gemfile' if RUBY_VERSION < '2.7'
+gemfiles = ['6.1.gemfile', '7.0.gemfile']
 GEMFILES = gemfiles.freeze
 
 namespace :bundle do
@@ -47,16 +46,18 @@ end
 require 'rake/testtask'
 namespace :test do
   desc 'Run all tests. Optionally define env variable RAILS_VERSIONS. E.g. RAILS_VERSIONS=3.0,5.0'
-  task :all, [:rails_versions] do |task, args|
-    gemfiles = ENV['RAILS_VERSIONS'] ? ENV['RAILS_VERSIONS'].split(',').map {|v| "#{v}.gemfile"} : GEMFILES
+  task :all do |task, args|
+    gemfiles = ENV['RAILS_VERSIONS'] ? ENV['RAILS_VERSIONS'].split(',').map { |v| "#{v}.gemfile" } : GEMFILES
     puts '-' * 80
     gemfiles.each do |gemfile|
       puts "GEMFILE: #{gemfile}"
-      sh "BUNDLE_GEMFILE='#{File.expand_path("../gemfiles/#{gemfile}", __FILE__)}' " +
-             " bundle exec rspec"
+      sh "BUNDLE_GEMFILE='#{File.expand_path("../gemfiles/#{gemfile}", __FILE__)}' " \
+             ' bundle exec rspec'
       puts '-' * 80
     end
   end
+
+  task unit: :all
 end
 
 # ----- Documentation tasks ---------------------------------------------------

data/elasticsearch-model.gemspec

@@ -24,8 +24,8 @@ require 'elasticsearch/model/version'
 Gem::Specification.new do |s|
   s.name          = 'elasticsearch-model'
   s.version       = Elasticsearch::Model::VERSION
-  s.authors       = ['Karel Minarik']
-  s.email         = ['karel.minarik@elasticsearch.org']
+  s.authors       = ['Elastic Client Library Maintainers']
+  s.email         = ['client-libs@elastic.co']
   s.description   = 'ActiveModel/Record integrations for Elasticsearch.'
   s.summary       = 'ActiveModel/Record integrations for Elasticsearch.'
   s.homepage      = 'https://github.com/elasticsearch/elasticsearch-rails/'
@@ -39,10 +39,10 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files  = ['README.md', 'LICENSE.txt']
   s.rdoc_options      = ['--charset=UTF-8']
 
-  s.required_ruby_version = '>= 2.4'
+  s.required_ruby_version = '>= 3'
 
   s.add_dependency 'activesupport', '> 3'
-  s.add_dependency 'elasticsearch', '~> 7'
+  s.add_dependency 'elasticsearch', '~> 8'
   s.add_dependency 'hashie'
 
   s.add_development_dependency 'activemodel', '> 3'

data/examples/activerecord_associations.rb

@@ -81,7 +81,7 @@ end
 # ----- Elasticsearch client setup ----------------------------------------------------------------
 
 Elasticsearch::Model.client = Elasticsearch::Client.new log: true
-Elasticsearch::Model.client.transport.transport.logger.formatter = proc { |s, d, p, m| "\e[2m#{m}\n\e[0m" }
+Elasticsearch::Model.client.transport.logger.formatter = proc { |s, d, p, m| "\e[2m#{m}\n\e[0m" }
 
 # ----- Search integration ------------------------------------------------------------------------
 

data/examples/activerecord_custom_analyzer.rb

@@ -37,8 +37,8 @@ ActiveRecord::Schema.define(version: 1) do
   end
 end
 
-Elasticsearch::Model.client.transport.transport.logger = ActiveSupport::Logger.new(STDOUT)
-Elasticsearch::Model.client.transport.transport.logger.formatter = lambda { |s, d, p, m| "#{m.ansi(:faint)}\n" }
+Elasticsearch::Model.client.transport.logger = ActiveSupport::Logger.new(STDOUT)
+Elasticsearch::Model.client.transport.logger.formatter = lambda { |s, d, p, m| "#{m.ansi(:faint)}\n" }
 
 class Article < ActiveRecord::Base
   include Elasticsearch::Model

data/gemfiles/{6.0.gemfile → 6.1.gemfile}

@@ -20,17 +20,17 @@
 # $ BUNDLE_GEMFILE=./gemfiles/6.0.gemfile bundle install
 # $ BUNDLE_GEMFILE=./gemfiles/6.0.gemfile bundle exec rake test:integration
 
-
 source 'https://rubygems.org'
 
 gemspec path: '../'
 
-gem 'activemodel',  '6.0.0'
-gem 'activerecord', '6.0.0'
+gem 'activemodel',  '6.1'
+gem 'activerecord', '6.1'
 gem 'sqlite3' unless defined?(JRUBY_VERSION)
-#gem 'mongoid', '~> 6'
+# gem 'mongoid', '~> 6'
 
 group :development, :testing do
-  gem 'rspec'
+  gem 'debug'
   gem 'pry-nav'
+  gem 'rspec'
 end

data/gemfiles/{5.0.gemfile → 7.0.gemfile}

@@ -17,19 +17,20 @@
 
 # Usage:
 #
-# $ BUNDLE_GEMFILE=./gemfiles/5.0.gemfile bundle install
-# $ BUNDLE_GEMFILE=./gemfiles/5.0.gemfile bundle exec rake test:integration
+# $ BUNDLE_GEMFILE=./gemfiles/7.0.gemfile bundle install
+# $ BUNDLE_GEMFILE=./gemfiles/7.0.gemfile bundle exec rake test:integration
 
 source 'https://rubygems.org'
 
 gemspec path: '../'
 
-gem 'activemodel',  '~> 5'
-gem 'activerecord', '~> 5'
+gem 'activemodel',  '~> 7'
+gem 'activerecord', '~> 7'
 gem 'sqlite3' unless defined?(JRUBY_VERSION)
-gem 'mongoid', '~> 6'
+# gem 'mongoid', '~> 6'
 
 group :development, :testing do
-  gem 'rspec'
+  gem 'debug'
   gem 'pry-nav'
+  gem 'rspec'
 end

data/gemfiles/{3.0.gemfile → 7.1.gemfile}

@@ -17,19 +17,20 @@
 
 # Usage:
 #
-# $ BUNDLE_GEMFILE=./gemfiles/3.0.gemfile bundle install
-# $ BUNDLE_GEMFILE=./gemfiles/3.0.gemfile bundle exec rake test:integration
+# $ BUNDLE_GEMFILE=./gemfiles/7.0.gemfile bundle install
+# $ BUNDLE_GEMFILE=./gemfiles/7.0.gemfile bundle exec rake test:integration
 
 source 'https://rubygems.org'
 
 gemspec path: '../'
 
-gem 'activemodel',  '>= 3.0'
-gem 'activerecord', '~> 3.2'
-gem 'mongoid',      '>= 3.0'
-gem 'sqlite3', '> 1.3', '< 1.4' unless defined?(JRUBY_VERSION)
+gem 'activemodel',  '~> 7.1'
+gem 'activerecord', '~> 7.1'
+gem 'sqlite3' unless defined?(JRUBY_VERSION)
+# gem 'mongoid', '~> 6'
 
 group :development, :testing do
-  gem 'rspec'
+  gem 'debug'
   gem 'pry-nav'
-end
+  gem 'rspec'
+end

data/lib/elasticsearch/model/adapter.rb

@@ -17,7 +17,6 @@
 
 module Elasticsearch
   module Model
-
     # Contains an adapter which provides OxM-specific implementations for common behaviour:
     #
     # * {Adapter::Adapter#records_mixin   Fetching records from the database}
@@ -29,7 +28,6 @@ module Elasticsearch
     # @see Elasticsearch::Model::Adapter::Mongoid
     #
     module Adapter
-
       # Returns an adapter based on the Ruby class passed
       #
       # @example Create an adapter for an ActiveRecord-based model

data/lib/elasticsearch/model/adapters/active_record.rb

@@ -18,11 +18,9 @@
 module Elasticsearch
   module Model
     module Adapter
-
       # An adapter for ActiveRecord-based models
       #
       module ActiveRecord
-
         Adapter.register self,
                          lambda { |klass| !!defined?(::ActiveRecord::Base) && klass.respond_to?(:ancestors) && klass.ancestors.include?(::ActiveRecord::Base) }
 
@@ -71,7 +69,6 @@ module Elasticsearch
         end
 
         module Callbacks
-
           # Handle index updates (creating, updating or deleting documents)
           # when the model changes, by hooking into the lifecycle
           #
@@ -87,7 +84,6 @@ module Elasticsearch
         end
 
         module Importing
-
           # Fetch batches of records from the database (used by the import method)
           #
           #

data/lib/elasticsearch/model/adapters/default.rb

@@ -18,15 +18,12 @@
 module Elasticsearch
   module Model
     module Adapter
-
       # The default adapter for models which haven't one registered
       #
       module Default
-
         # Module for implementing methods and logic related to fetching records from the database
         #
         module Records
-
           # Return the collection of records fetched from the database
           #
           # By default uses `MyModel#find[1, 2, 3]`
@@ -60,7 +57,6 @@ module Elasticsearch
             raise NotImplemented, "Method not implemented for default adapter"
           end
         end
-
       end
     end
   end

data/lib/elasticsearch/model/adapters/mongoid.rb

@@ -18,18 +18,21 @@
 module Elasticsearch
   module Model
     module Adapter
-
       # An adapter for Mongoid-based models
       #
       # @see http://mongoid.org
       #
       module Mongoid
-
-        Adapter.register self,
-                         lambda { |klass| !!defined?(::Mongoid::Document) && klass.respond_to?(:ancestors) && klass.ancestors.include?(::Mongoid::Document) }
+        Adapter.register(
+          self,
+          lambda do |klass|
+            !!defined?(::Mongoid::Document) &&
+              klass.respond_to?(:ancestors) &&
+              klass.ancestors.include?(::Mongoid::Document)
+          end
+        )
 
         module Records
-
           # Return a `Mongoid::Criteria` instance
           #
           def records
@@ -59,7 +62,6 @@ module Elasticsearch
         end
 
         module Callbacks
-
           # Handle index updates (creating, updating or deleting documents)
           # when the model changes, by hooking into the lifecycle
           #
@@ -73,7 +75,6 @@ module Elasticsearch
         end
 
         module Importing
-
           # Fetch batches of records from the database
           #
           # @see https://github.com/mongoid/mongoid/issues/1334
@@ -88,19 +89,16 @@ module Elasticsearch
             scope = all
             scope = scope.send(named_scope) if named_scope
             scope = query.is_a?(Proc) ? scope.class_exec(&query) : scope.where(query) if query
-  
             scope.no_timeout.each_slice(batch_size) do |items|
               yield (preprocess ? self.__send__(preprocess, items) : items)
             end
           end
 
           def __transform
-            lambda {|a|  { index: { _id: a.id.to_s, data: a.as_indexed_json } }}
+            lambda { |a| { index: { _id: a.id.to_s, data: a.as_indexed_json } } }
           end
         end
-
       end
-
     end
   end
 end

data/lib/elasticsearch/model/adapters/multiple.rb

@@ -18,7 +18,6 @@
 module Elasticsearch
   module Model
     module Adapter
-
       # An adapter to be used for deserializing results from multiple models,
       # retrieved through `Elasticsearch::Model.search`
       #

data/lib/elasticsearch/model/importing.rb

@@ -17,14 +17,12 @@
 
 module Elasticsearch
   module Model
-
     # Provides support for easily and efficiently importing large amounts of
     # records from the including class into the index.
     #
     # @see ClassMethods#import
     #
     module Importing
-
       # When included in a model, adds the importing methods.
       #
       # @example Import all records from the `Article` model
@@ -42,13 +40,12 @@ module Elasticsearch
       end
 
       module ClassMethods
-
         # Import all model records into the index
         #
         # The method will pick up correct strategy based on the `Importing` module
         # defined in the corresponding adapter.
         #
-        # @param options [Hash] Options passed to the underlying `__find_in_batches`method
+        # @param options [Hash] Options passed to the underlying `__find_in_batches` method
         # @param block  [Proc] Optional block to evaluate for each batch
         #
         # @yield [Hash] Gives the Hash with the Elasticsearch response to the block
@@ -62,7 +59,6 @@ module Elasticsearch
         #         "index" => {
         #           "error" => 'FAILED',
         #           "_index" => "test",
-        #           "_type" => "_doc",
         #           "_id" => '1',
         #           "_version" => 1,
         #           "result" => "foo",
@@ -141,7 +137,6 @@ module Elasticsearch
           errors       = []
           refresh      = options.delete(:refresh)   || false
           target_index = options.delete(:index)     || index_name
-          target_type  = options.delete(:type)      || document_type
           transform    = options.delete(:transform) || __transform
           pipeline     = options.delete(:pipeline)
           return_value = options.delete(:return)    || 'count'
@@ -161,14 +156,10 @@ module Elasticsearch
           __find_in_batches(options) do |batch|
             params = {
               index: target_index,
-              type:  target_type,
               body:  __batch_to_bulk(batch, transform)
             }
-
             params[:pipeline] = pipeline if pipeline
-
             response = client.bulk params
-
             yield response if block_given?
 
             errors +=  response['items'].select { |k, v| k.values.first['error'] }
@@ -188,8 +179,6 @@ module Elasticsearch
           batch.map { |model| transform.call(model) }
         end
       end
-
     end
-
   end
 end

data/lib/elasticsearch/model/indexing.rb

@@ -17,7 +17,6 @@
 
 module Elasticsearch
   module Model
-
     # Provides the necessary support to set up index options (mappings, settings)
     # as well as instance methods to create, update or delete documents in the index.
     #
@@ -29,7 +28,6 @@ module Elasticsearch
     # @see InstanceMethods#delete_document
     #
     module Indexing
-
       # Wraps the [index settings](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html)
       #
       class Settings
@@ -51,13 +49,11 @@ module Elasticsearch
       # Wraps the [index mappings](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html)
       #
       class Mappings
-        attr_accessor :options, :type
+        attr_accessor :options
 
-        # @private
         TYPES_WITH_EMBEDDED_PROPERTIES = %w(object nested)
 
-        def initialize(type = nil, options={})
-          @type    = type
+        def initialize(options={})
           @options = options
           @mapping = {}
         end
@@ -87,11 +83,7 @@ module Elasticsearch
         end
 
         def to_hash
-          if @type
-            { @type.to_sym => @options.merge( properties: @mapping ) }
-          else
-            @options.merge( properties: @mapping )
-          end
+          @options.merge( properties: @mapping )
         end
 
         def as_json(options={})
@@ -100,7 +92,6 @@ module Elasticsearch
       end
 
       module ClassMethods
-
         # Defines mappings for the index
         #
         # @example Define mapping for model
@@ -152,7 +143,7 @@ module Elasticsearch
         # when it doesn't already define them. Use the `__elasticsearch__` proxy otherwise.
         #
         def mapping(options={}, &block)
-          @mapping ||= Mappings.new(document_type, options)
+          @mapping ||= Mappings.new(options)
 
           @mapping.options.update(options) unless options.empty?
 
@@ -290,7 +281,7 @@ module Elasticsearch
             self.client.indices.delete index: target_index
           rescue Exception => e
             if e.class.to_s =~ /NotFound/ && options[:force]
-              client.transport.transport.logger.debug("[!!!] Index does not exist (#{e.class})") if client.transport.transport.logger
+              client.transport.logger.debug("[!!!] Index does not exist (#{e.class})") if client.transport.logger
               nil
             else
               raise e
@@ -317,7 +308,7 @@ module Elasticsearch
             self.client.indices.refresh index: target_index
           rescue Exception => e
             if e.class.to_s =~ /NotFound/ && options[:force]
-              client.transport.transport.logger.debug("[!!!] Index does not exist (#{e.class})") if client.transport.transport.logger
+              client.transport.logger.debug("[!!!] Index does not exist (#{e.class})") if client.transport.logger
               nil
             else
               raise e
@@ -372,7 +363,6 @@ module Elasticsearch
           request = { index: index_name,
                       id:    id,
                       body:  document }
-          request.merge!(type: document_type) if document_type
 
           client.index(request.merge!(options))
         end
@@ -393,7 +383,6 @@ module Elasticsearch
         def delete_document(options={})
           request = { index: index_name,
                       id:    self.id }
-          request.merge!(type: document_type) if document_type
 
           client.delete(request.merge!(options))
         end
@@ -434,7 +423,6 @@ module Elasticsearch
               request = { index: index_name,
                           id:    self.id,
                           body:  { doc: attributes } }
-              request.merge!(type: document_type) if document_type
 
               client.update(request.merge!(options))
             end
@@ -461,7 +449,6 @@ module Elasticsearch
           request = { index: index_name,
                       id:    self.id,
                       body:  { doc: attributes } }
-          request.merge!(type: document_type) if document_type
 
           client.update(request.merge!(options))
         end

data/lib/elasticsearch/model/multimodel.rb

@@ -17,7 +17,6 @@
 
 module Elasticsearch
   module Model
-
     # Keeps a global registry of classes that include `Elasticsearch::Model`
     #
     class Registry
@@ -80,17 +79,9 @@ module Elasticsearch
         models.map { |m| m.index_name }
       end
 
-      # Get an Array of document types used for retrieving documents when doing a search across multiple models
-      #
-      # @return [Array] the list of document types used for retrieving documents
-      #
-      def document_type
-        models.map { |m| m.document_type }.compact.presence
-      end
-
       # Get the client common for all models
       #
-      # @return Elasticsearch::Transport::Client
+      # @return Elastic::Transport::Client
       #
       def client
         Elasticsearch::Model.client