elasticsearch-persistence 7.2.1 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da08635ca213d32288a7bf6eafadd4e5c90495ffa647938ed0932c815f1b36f4
-  data.tar.gz: 64eecce8b4e1990692812a07f7668a73cecb0e0c6e7d0b10122abb544f85b9af
+  metadata.gz: 88bcaa32622770f7fe47c65cbc707b06719d51dd3f6c81e1690666e8ed224034
+  data.tar.gz: 60dc779f07f2fec1d368266fdba2a8f31de473e3dd53405fc0394159756fd524
 SHA512:
-  metadata.gz: e2a90150247fb70ca0398d517d9b8276b11fc6b69d1906b0862f62b6171cfd7ed99f9b598633faf531f6ebfbf89d8128dbc2333bd743e20fb99c28882f3703ec
-  data.tar.gz: cc74ca2a8ee2cc7e2e3ab3717089258bcc6096fda78412c5af8a6f1441c3ae682a2f93bb154ffe15751b115724894944736f2b08c3121b9de72a6d9c1e7f9378
+  metadata.gz: 206ee66e4041b522a8ebc15d0b102068dfabcc7ad927654e45680bc9ff964f66affd581e050f73d3fc14cb2996c7cbfd2915c9c6d3acebceea73babc7f9e1e68
+  data.tar.gz: 4525c21fafaaae024b0e7343bbdd0c24ee0a90e251e21c1d54ecc5a83d5f07f69075fba4d537c49655bb210d189ffa7950463c8605848d5bde485e69d3882821

data/Gemfile

@@ -25,6 +25,7 @@ gem 'elasticsearch-model',
     require: false
 
 group :development, :testing do
+  gem 'debug' unless defined?(JRUBY_VERSION)
   gem 'pry-nav'
   gem 'rspec'
 end

data/README.md

@@ -4,17 +4,19 @@ Persistence layer for Ruby domain objects in Elasticsearch, using the Repository
 
 ## Compatibility
 
-This library is compatible with Ruby 2.4 and higher.
+This library is compatible with Ruby 3.1 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 `8.x` of the Elasticsearch stack.
 
-| 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
 
@@ -77,7 +79,7 @@ note = Note.new id: 1, text: 'Test'
 repository.save(note)
 # PUT http://localhost:9200/repository/_doc/1 [status:201, request:0.210s, query:n/a]
 # > {"id":1,"text":"Test"}
-# < {"_index":"repository","_type":"note","_id":"1","_version":1,"created":true}
+# < {"_index":"repository","_id":"1","_version":1,"created":true}
 ```
 
 ...find it...
@@ -85,7 +87,7 @@ repository.save(note)
 ```ruby
 n = repository.find(1)
 # GET http://localhost:9200/repository/_doc/1 [status:200, request:0.003s, query:n/a]
-# < {"_index":"repository","_type":"note","_id":"1","_version":2,"found":true, "_source" : {"id":1,"text":"Test"}}
+# < {"_index":"repository","_id":"1","_version":2,"found":true, "_source" : {"id":1,"text":"Test"}}
 => <Note:0x007fcbfc0c4980 @attributes={"id"=>1, "text"=>"Test"}>
 ```
 
@@ -104,14 +106,14 @@ repository.search(query: { match: { text: 'test' } }).first
 ```ruby
 repository.delete(note)
 # DELETE http://localhost:9200/repository/_doc/1 [status:200, request:0.014s, query:n/a]
-# < {"found":true,"_index":"repository","_type":"note","_id":"1","_version":3}
-=> {"found"=>true, "_index"=>"repository", "_type"=>"note", "_id"=>"1", "_version"=>2}
+# < {"found":true,"_index":"repository","_id":"1","_version":3}
+=> {"found"=>true, "_index"=>"repository", "_id"=>"1", "_version"=>2}
 ```
 
 The repository module provides a number of features and facilities to configure and customize the behavior:
 
 * Configuring the Elasticsearch [client](https://github.com/elastic/elasticsearch-ruby#usage) being used
-* Setting the index name, document type, and object class for deserialization
+* Setting the index name, and object class for deserialization
 * Composing mappings and settings for the index
 * Creating, deleting or refreshing the index
 * Finding or searching for documents
@@ -144,7 +146,7 @@ class MyRepository
 end
 
 client = Elasticsearch::Client.new(url: ENV['ELASTICSEARCH_URL'], log: true)
-repository = MyRepository.new(client: client, index_name: :my_notes, type: :note, klass: Note)
+repository = MyRepository.new(client: client, index_name: :my_notes, klass: Note)
 repository.settings number_of_shards: 1 do
   mapping do
     indexes :text, analyzer: 'snowball'
@@ -152,8 +154,7 @@ repository.settings number_of_shards: 1 do
 end
 ```
 
-The custom Elasticsearch client will be used now, with a custom index and type names,
-as well as the custom serialization and de-serialization logic.
+The custom Elasticsearch client will be used now, with a custom index, as well as the custom serialization and de-serialization logic.
 
 We can create the index with the desired settings and mappings:
 
@@ -169,7 +170,7 @@ Save the document with extra properties added by the `serialize` method:
 repository.save(note)
 # PUT http://localhost:9200/my_notes/note/1
 # > {"id":1,"text":"Test","my_special_key":"my_special_stuff"}
-{"_index"=>"my_notes", "_type"=>"my_note", "_id"=>"1", "_version"=>4, ... }
+{"_index"=>"my_notes", "_id"=>"1", "_version"=>4, ... }
 ```
 
 And `deserialize` it:
@@ -193,7 +194,6 @@ class NoteRepository
   include Elasticsearch::Persistence::Repository::DSL
 
   index_name 'notes'
-  document_type 'note'
   klass Note
 
   settings number_of_shards: 1 do
@@ -236,7 +236,7 @@ You can also override the default configuration with options passed to the initi
 
 ```ruby
 client = Elasticsearch::Client.new(url: 'http://localhost:9250', log: true)
-client.transport.transport.logger.formatter = proc { |s, d, p, m| "\e[2m# #{m}\n\e[0m" }
+client.transport.logger.formatter = proc { |s, d, p, m| "\e[2m# #{m}\n\e[0m" }
 repository = NoteRepository.new(client: client, index_name: 'notes_development')
 
 repository.create_index!(force: true)
@@ -267,7 +267,7 @@ The repository uses the standard Elasticsearch [client](https://github.com/elast
 ```ruby
 client = Elasticsearch::Client.new(url: 'http://search.server.org')
 repository = NoteRepository.new(client: client)
-repository.client.transport.transport.logger = Logger.new(STDERR)
+repository.client.transport.logger = Logger.new(STDERR)
 repository.client
 # => Elasticsearch::Client
 
@@ -317,36 +317,8 @@ repository.index_name
 
 ```
 
-The `document_type` method specifies the Elasticsearch document type to use for storage, lookup and search. The default value is
-'_doc'. Keep in mind that future versions of Elasticsearch will not allow you to set this yourself and will use the type,
-'_doc'.
-
-```ruby
-repository = NoteRepository.new(document_type: 'note')
-repository.document_type
-# => 'note'
-
-```
-
-or with the DSL mixin:
-
-```ruby
-class NoteRepository
-  include Elasticsearch::Persistence::Repository
-  include Elasticsearch::Persistence::Repository::DSL
-
-  document_type 'note'
-end
-
-repository = NoteRepository.new
-repository.document_type
-# => 'note'
-
-```
-
 The `klass` method specifies the Ruby class name to use when initializing objects from
-documents retrieved from the repository. If this value is not set, a Hash representation of the document will be 
-returned instead.
+documents retrieved from the repository. If this value is not set, a Hash representation of the document will be returned instead.
 
 ```ruby
 repository = NoteRepository.new(klass: Note)
@@ -451,7 +423,7 @@ The `save` method allows you to store a domain object in the repository:
 ```ruby
 note = Note.new id: 1, title: 'Quick Brown Fox'
 repository.save(note)
-# => {"_index"=>"notes_development", "_type"=>"_doc", "_id"=>"1", "_version"=>1, "created"=>true}
+# => {"_index"=>"notes_development", "_id"=>"1", "_version"=>1, "created"=>true}
 ```
 
 The `update` method allows you to perform a partial update of a document in the repository.
@@ -459,14 +431,14 @@ Use either a partial document:
 
 ```ruby
 repository.update id: 1, title: 'UPDATED',  tags: []
-# => {"_index"=>"notes_development", "_type"=>"_doc", "_id"=>"1", "_version"=>2}
+# => {"_index"=>"notes_development", "_id"=>"1", "_version"=>2}
 ```
 
 Or a script (optionally with parameters):
 
 ```ruby
 repository.update 1, script: 'if (!ctx._source.tags.contains(t)) { ctx._source.tags += t }', params: { t: 'foo' }
-# => {"_index"=>"notes_development", "_type"=>"_doc", "_id"=>"1", "_version"=>3}
+# => {"_index"=>"notes_development", "_id"=>"1", "_version"=>3}
 ```
 
 

data/Rakefile

@@ -15,11 +15,11 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
-desc "Run unit tests"
-task :default => 'test:unit'
-task :test    => 'test:unit'
+desc 'Run unit tests'
+task default: 'test:unit'
+task test: 'test:unit'
 
 # ----- Test tasks ------------------------------------------------------------
 
@@ -27,14 +27,15 @@ require 'rake/testtask'
 require 'rspec/core/rake_task'
 
 namespace :test do
-
   RSpec::Core::RakeTask.new(:spec)
 
   Rake::TestTask.new(:all) do |test|
     test.verbose = false
     test.warning = false
-    test.deps = [ :spec ]
+    test.deps = [:spec]
   end
+
+  task unit: :spec
 end
 
 namespace :bundle do
@@ -65,6 +66,6 @@ if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
       cane.style_measure = 120
     end
   rescue LoadError
-    warn "cane not available, quality task not provided."
+    warn 'cane not available, quality task not provided.'
   end
 end

data/elasticsearch-persistence.gemspec

@@ -16,52 +16,49 @@
 # under the License.
 
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'elasticsearch/persistence/version'
 
 Gem::Specification.new do |s|
-  s.name          = "elasticsearch-persistence"
+  s.name          = 'elasticsearch-persistence'
   s.version       = Elasticsearch::Persistence::VERSION
-  s.authors       = ["Karel Minarik"]
-  s.email         = ["karel.minarik@elasticsearch.org"]
-  s.description   = "Persistence layer for Ruby models and Elasticsearch."
-  s.summary       = "Persistence layer for Ruby models and Elasticsearch."
-  s.homepage      = "https://github.com/elasticsearch/elasticsearch-rails/"
-  s.license       = "Apache 2"
+  s.authors       = ['Elastic Client Library Maintainers']
+  s.email         = ['client-libs@elastic.co']
+  s.description   = 'Persistence layer for Ruby models and Elasticsearch.'
+  s.summary       = 'Persistence layer for Ruby models and Elasticsearch.'
+  s.homepage      = 'https://github.com/elasticsearch/elasticsearch-rails/'
+  s.license       = 'Apache 2'
 
   s.files         = `git ls-files -z`.split("\x0")
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ["lib"]
-
-  s.extra_rdoc_files  = [ "README.md", "LICENSE.txt" ]
-  s.rdoc_options      = [ "--charset=UTF-8" ]
-
-  s.required_ruby_version = ">= 1.9.3"
-
-  s.add_dependency "elasticsearch",       '~> 7'
-  s.add_dependency "elasticsearch-model", '7.2.1'
-  s.add_dependency "activesupport",       '> 4'
-  s.add_dependency "activemodel",         '> 4'
-  s.add_dependency "hashie"
-
-  s.add_development_dependency "bundler"
-  s.add_development_dependency "rake", "~> 12"
+  s.require_paths = ['lib']
 
-  s.add_development_dependency "oj" unless defined?(JRUBY_VERSION)
+  s.extra_rdoc_files  = ['README.md', 'LICENSE.txt']
+  s.rdoc_options      = ['--charset=UTF-8']
 
-  s.add_development_dependency "rails", '> 4'
+  s.required_ruby_version = '>= 3'
 
-  s.add_development_dependency "minitest"
-  s.add_development_dependency "test-unit"
-  s.add_development_dependency "shoulda-context"
-  s.add_development_dependency "mocha"
-  s.add_development_dependency "turn"
-  s.add_development_dependency "yard"
-  s.add_development_dependency "ruby-prof" unless defined?(JRUBY_VERSION)
-  s.add_development_dependency "pry"
+  s.add_dependency 'activemodel',         '> 4'
+  s.add_dependency 'activesupport',       '> 4'
+  s.add_dependency 'elasticsearch',       '~> 8'
+  s.add_dependency 'elasticsearch-model', '8'
+  s.add_dependency 'hashie'
 
-  s.add_development_dependency "simplecov"
-  s.add_development_dependency "cane"
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'cane'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'oj' unless defined?(JRUBY_VERSION)
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rails', '> 4'
+  s.add_development_dependency 'rake', '~> 12'
+  s.add_development_dependency 'ruby-prof' unless defined?(JRUBY_VERSION)
+  s.add_development_dependency 'shoulda-context'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'test-unit'
+  s.add_development_dependency 'turn'
+  s.add_development_dependency 'yard'
 end

data/examples/notes/application.rb

@@ -75,7 +75,6 @@ class NoteRepository
   client Elasticsearch::Client.new url: ENV['ELASTICSEARCH_URL'], log: true
 
   index_name :notes
-  document_type  :note
 
   mapping do
     indexes :text,       analyzer: 'snowball'

data/examples/notes/test.rb

@@ -90,7 +90,7 @@ class Elasticsearch::Persistence::ExampleApplicationTest < Test::Unit::TestCase
       app.settings.repository.client = Elasticsearch::Client.new \
         hosts: [{ host: 'localhost', port: ENV.fetch('TEST_CLUSTER_PORT', 9250)}],
         log: true
-      app.settings.repository.client.transport.transport.logger.formatter = proc { |s, d, p, m| "\e[2m#{m}\n\e[0m" }
+      app.settings.repository.client.transport.logger.formatter = proc { |s, d, p, m| "\e[2m#{m}\n\e[0m" }
       app.settings.repository.create_index! force: true
       app.settings.repository.client.cluster.health wait_for_status: 'yellow'
     end

data/lib/elasticsearch/persistence/repository/dsl.rb

@@ -23,7 +23,6 @@ module Elasticsearch
       #
       # @since 6.0.0
       module DSL
-
         def self.included(base)
           base.send(:extend, Elasticsearch::Model::Indexing::ClassMethods)
           base.send(:extend, ClassMethods)
@@ -34,19 +33,6 @@ module Elasticsearch
         #
         # @since 6.0.0
         module ClassMethods
-
-          # Get or set the class-level document type setting.
-          #
-          # @example
-          #   MyRepository.document_type
-          #
-          # @return [ String, Symbol ] _type The repository's document type.
-          #
-          # @since 6.0.0
-          def document_type(_type = nil)
-            @document_type ||= _type
-          end
-
           # Get or set the class-level index name setting.
           #
           # @example

data/lib/elasticsearch/persistence/repository/find.rb

@@ -64,7 +64,6 @@ module Elasticsearch
         #
         def exists?(id, options={})
           request = { index: index_name, id: id }
-          request[:type] = document_type if document_type
           client.exists(request.merge(options))
         end
 
@@ -84,10 +83,9 @@ module Elasticsearch
         #
         def __find_one(id, options={})
           request = { index: index_name, id: id }
-          request[:type] = document_type if document_type
           document = client.get(request.merge(options))
           deserialize(document)
-        rescue Elasticsearch::Transport::Transport::Errors::NotFound => e
+        rescue Elastic::Transport::Transport::Errors::NotFound => e
           raise DocumentNotFound, e.message, caller
         end
 
@@ -95,7 +93,6 @@ module Elasticsearch
         #
         def __find_many(ids, options={})
           request = { index: index_name, body: { ids: ids } }
-          request[:type] = document_type if document_type
           documents = client.mget(request.merge(options))
           documents[DOCS].map do |document|
             deserialize(document) if document[FOUND]

data/lib/elasticsearch/persistence/repository/search.rb

@@ -60,8 +60,7 @@ module Elasticsearch
         # @return [Elasticsearch::Persistence::Repository::Response::Results]
         #
         def search(query_or_definition, options={})
-          request = { index: index_name,
-                      type: document_type }
+          request = { index: index_name }
           if query_or_definition.respond_to?(:to_hash)
             request[:body] = query_or_definition.to_hash
           elsif query_or_definition.is_a?(String)
@@ -98,8 +97,7 @@ module Elasticsearch
         #
         def count(query_or_definition=nil, options={})
           query_or_definition ||= { query: { match_all: {} } }
-          request = { index: index_name,
-                      type: document_type }
+          request = { index: index_name }
 
           if query_or_definition.respond_to?(:to_hash)
             request[:body] = query_or_definition.to_hash

data/lib/elasticsearch/persistence/repository/store.rb

@@ -27,7 +27,7 @@ module Elasticsearch
         #
         # @example
         #     repository.save(myobject)
-        #     => {"_index"=>"...", "_type"=>"...", "_id"=>"...", "_version"=>1, "created"=>true}
+        #     => {"_index"=>"...", "_id"=>"...", "_version"=>1, "created"=>true}
         #
         # @param [ Object ] document The document to save into Elasticsearch.
         # @param [ Hash ] options The save request options.
@@ -40,7 +40,6 @@ module Elasticsearch
           request = { index: index_name,
                       id: id,
                       body: serialized }
-          request[:type] = document_type if document_type
           client.index(request.merge(options))
         end
 
@@ -49,12 +48,12 @@ module Elasticsearch
         # @example Update the document with partial data
         #
         #     repository.update id: 1, title: 'UPDATED',  tags: []
-        #     # => {"_index"=>"...", "_type"=>"...", "_id"=>"1", "_version"=>2}
+        #     # => {"_index"=>"...", "_id"=>"1", "_version"=>2}
         #
         # @example Update the document with a script
         #
         #     repository.update 1, script: 'ctx._source.views += 1'
-        #     # => {"_index"=>"...", "_type"=>"...", "_id"=>"1", "_version"=>3}
+        #     # => {"_index"=>"...", "_id"=>"1", "_version"=>3}
         #
         # @param [ Object ] document_or_id The document to update or the id of the document to update.
         # @param [ Hash ] options The update request options.
@@ -65,7 +64,6 @@ module Elasticsearch
           if document_or_id.is_a?(String) || document_or_id.is_a?(Integer)
             id = document_or_id
             body = options
-            type = document_type
           else
             document = serialize(document_or_id)
             id = __extract_id_from_document(document)
@@ -74,9 +72,8 @@ module Elasticsearch
             else
               body = { doc: document }.merge(options)
             end
-            type = document.delete(:type) || document_type
           end
-          client.update(index: index_name, id: id, type: type, body: body)
+          client.update(index: index_name, id: id, body: body)
         end
 
         # Remove the serialized object or document with specified ID from Elasticsearch
@@ -84,7 +81,7 @@ module Elasticsearch
         # @example Remove the document with ID 1
         #
         #     repository.delete(1)
-        #     # => {"_index"=>"...", "_type"=>"...", "_id"=>"1", "_version"=>4}
+        #     # => {"_index"=>"...", "_id"=>"1", "_version"=>4}
         #
         # @param [ Object ] document_or_id The document to delete or the id of the document to delete.
         # @param [ Hash ] options The delete request options.
@@ -98,7 +95,7 @@ module Elasticsearch
             serialized = serialize(document_or_id)
             id = __get_id_from_document(serialized)
           end
-          client.delete({ index: index_name, type: document_type, id: id }.merge(options))
+          client.delete({ index: index_name, id: id }.merge(options))
         end
       end
     end

data/lib/elasticsearch/persistence/repository.rb

@@ -58,7 +58,6 @@ module Elasticsearch
         # @param [ Proc ] block A block to evaluate on the new repository instance.
         #
         # @option options [ Symbol, String ] :index_name The name of the index.
-        # @option options [ Symbol, String ] :document_type The type of documents persisted in this repository.
         # @option options [ Symbol, String ] :client The client used to handle requests to and from Elasticsearch.
         # @option options [ Symbol, String ] :klass The class used to instantiate an object when documents are
         #   deserialized. The default is nil, in which case the raw document will be returned as a Hash.
@@ -95,7 +94,6 @@ module Elasticsearch
       # @param [ Hash ] options The options to use.
       #
       # @option options [ Symbol, String ] :index_name The name of the index.
-      # @option options [ Symbol, String ] :document_type The type of documents persisted in this repository.
       # @option options [ Symbol, String ] :client The client used to handle requests to and from Elasticsearch.
       # @option options [ Symbol, String ] :klass The class used to instantiate an object when documents are
       #   deserialized. The default is nil, in which case the raw document will be returned as a Hash.
@@ -121,19 +119,6 @@ module Elasticsearch
                       Elasticsearch::Client.new
       end
 
-      # Get the document type used by the repository object.
-      #
-      # @example
-      #   repository.document_type
-      #
-      # @return [ String, Symbol ] The repository's document type.
-      #
-      # @since 6.0.0
-      def document_type
-        @document_type ||= @options[:document_type] ||
-                             __get_class_value(:document_type)
-      end
-
       # Get the index name used by the repository.
       #
       # @example
@@ -180,7 +165,6 @@ module Elasticsearch
       def mapping(*args)
         @memoized_mapping ||= @options[:mapping] || (begin
           if _mapping = __get_class_value(:mapping)
-            _mapping.instance_variable_set(:@type, document_type)
             _mapping
           end
         end) || (super && @mapping)
@@ -229,7 +213,7 @@ module Elasticsearch
       #
       # @since 6.0.0
       def inspect
-        "#<#{self.class}:0x#{object_id} index_name=#{index_name} document_type=#{document_type} klass=#{klass}>"
+        "#<#{self.class}:0x#{object_id} index_name=#{index_name} klass=#{klass}>"
       end
 
       private

data/lib/elasticsearch/persistence/version.rb

@@ -17,6 +17,6 @@
 
 module Elasticsearch
   module Persistence
-    VERSION = '7.2.1'
+    VERSION = '8.0.0'.freeze
   end
 end