elasticsearch-model 7.0.0.pre → 7.1.2.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be320b65dde58892add536b616fa70a1bd3ad1be9f4dd4d49d3250fb62d8bb93
-  data.tar.gz: 27386a4dea06f8ba4cbb6bf926b76315b38b4dff0df55e02a050ffdd54430afc
+  metadata.gz: 51e1e98703f1834d64dc969afcc75f107460220a9e213dc128dc5e1015be5a7b
+  data.tar.gz: b44da631182388ef384dcab9f6e9d3626c40bf2b6272ef35c6f4857670320f6e
 SHA512:
-  metadata.gz: f47057b8d82eb6f49fe7b495806a3b35caa149ebdb3236ed9133d4faad32159e5b47db970e2d6b2488681be4dba5a6f40dc1eec7cfaaee997c428bfb1bd9bb0b
-  data.tar.gz: b1eb060284f12d714c1a7a32cb3705aeee05eb641fb98fcb269e582eacfa28b7da8449d97fa30d6bf5ec4ad188f5f491250ba81e54bf4fa2b8358af62adac60a
+  metadata.gz: a627d5e725a0a3ffb0476873617e0f5d99f297ac1bad49554b69e1546f28bbc58a6cd3b3e54282d0127ed3da828f187f6dba4dc449bbe51ad8229b0b0167a276
+  data.tar.gz: 35b7bc2cb6161fff40247e4cf76fd789ffbc12c4c2acfb1e8223b567ce799bcb12a9fd8857cf1bdbdb13999a981114b2e46f6054f5a27dfb1d487cb188f86860

data/Gemfile

@@ -21,6 +21,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :testing do
-  gem 'rspec'
   gem 'pry-nav'
+  gem 'rspec'
 end

data/README.md

@@ -1,25 +1,22 @@
 # Elasticsearch::Model
 
-The `elasticsearch-model` library builds on top of the
-the [`elasticsearch`](https://github.com/elastic/elasticsearch-ruby) library.
+The `elasticsearch-model` library builds on top of the the [`elasticsearch`](https://github.com/elastic/elasticsearch-ruby) library.
 
-It aims to simplify integration of Ruby classes ("models"), commonly found
-e.g. in [Ruby on Rails](http://rubyonrails.org) applications, with the
-[Elasticsearch](http://www.elasticsearch.org) search and analytics engine.
+It aims to simplify integration of Ruby classes ("models"), commonly found e.g. in [Ruby on Rails](http://rubyonrails.org) applications, with the [Elasticsearch](https://www.elastic.co) search and analytics engine.
 
 ## Compatibility
 
-This library is compatible with Ruby 1.9.3 and higher.
+This library is compatible with Ruby 2.4 and higher.
 
-The library version numbers follow the Elasticsearch major versions, and the `master` branch
-is compatible with the Elasticsearch `master` branch, therefore, with the next major version.
+The library version numbers follow the Elasticsearch major versions. The `master` branch is compatible with the latest Elasticsearch stack stable release.
 
 | Rubygem       |   | Elasticsearch |
 |:-------------:|:-:| :-----------: |
 | 0.1           | → | 1.x           |
 | 2.x           | → | 2.x           |
 | 5.x           | → | 5.x           |
-| master        | → | master        |
+| 6.x           | → | 6.x           |
+| master        | → | 7.x           |
 
 ## Installation
 
@@ -72,9 +69,7 @@ This will extend the model with functionality related to Elasticsearch.
 
 #### Feature Extraction Pattern
 
-Instead of including the `Elasticsearch::Model` module directly in your model,
-you can include it in a "concern" or "trait" module, which is quite common pattern in Rails applications,
-using e.g.  `ActiveSupport::Concern` as the instrumentation:
+Instead of including the `Elasticsearch::Model` module directly in your model, you can include it in a "concern" or "trait" module, which is quite common pattern in Rails applications, using e.g.  `ActiveSupport::Concern` as the instrumentation:
 
 ```ruby
 # In: app/models/concerns/searchable.rb
@@ -151,7 +146,7 @@ for information about the Ruby client API.
 
 ### Importing the data
 
-The first thing you'll want to do is importing your data into the index:
+The first thing you'll want to do is import your data into the index:
 
 ```ruby
 Article.import
@@ -289,11 +284,8 @@ NOTE: It is _not_ possible to chain other methods on top of the `records` object
 
 #### Pagination
 
-You can implement pagination with the `from` and `size` search parameters. However, search results
-can be automatically paginated with the [`kaminari`](http://rubygems.org/gems/kaminari) or
-[`will_paginate`](https://github.com/mislav/will_paginate) gems.
-(The pagination gems must be added before the Elasticsearch gems in your Gemfile,
-or loaded first in your application.)
+You can implement pagination with the `from` and `size` search parameters. However, search results can be automatically paginated with the [`kaminari`](http://rubygems.org/gems/kaminari) or [`will_paginate`](https://github.com/mislav/will_paginate) gems.
+(The pagination gems must be added before the Elasticsearch gems in your Gemfile, or loaded first in your application.)
 
 If Kaminari or WillPaginate is loaded, use the familiar paging methods:
 
@@ -321,8 +313,7 @@ Elasticsearch::Model::Response::Response.__send__ :include, Elasticsearch::Model
 
 #### The Elasticsearch DSL
 
-In most situations, you'll want to pass the search definition
-in the Elasticsearch [domain-specific language](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html) to the client:
+In most situations, you'll want to pass the search definition in the Elasticsearch [domain-specific language](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) to the client:
 
 ```ruby
 response = Article.search query:     { match:  { title: "Fox Dogs" } },
@@ -332,8 +323,7 @@ response.results.first.highlight.title
 # ["Quick brown <em>fox</em>"]
 ```
 
-You can pass any object which implements a `to_hash` method, which is called automatically,
-so you can use a custom class or your favourite JSON builder to build the search definition:
+You can pass any object which implements a `to_hash` method, which is called automatically, so you can use a custom class or your favourite JSON builder to build the search definition:
 
 ```ruby
 require 'jbuilder'
@@ -353,8 +343,7 @@ response.results.first.title
 # => "Quick brown fox"
 ```
 
-Also, you can use the [**`elasticsearch-dsl`**](https://github.com/elastic/elasticsearch-ruby/tree/master/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-ruby/tree/master/elasticsearch-dsl) library, which provides a specialized Ruby API for the Elasticsearch Query DSL:
 
 ```ruby
 require 'elasticsearch/dsl'
@@ -732,13 +721,8 @@ module and its submodules for technical information.
 
 The module provides a common `settings` method to customize various features.
 
-At the moment, the only supported setting is `:inheritance_enabled`, which makes the class receiving the module
-respect index names and document types of a super-class, eg. in case you're using "single table inheritance" (STI)
-in Rails:
-
-```ruby
-Elasticsearch::Model.settings[:inheritance_enabled] = true
-```
+Before version 7.0.0 of the gem, the only supported setting was `:inheritance_enabled`. This setting has been deprecated
+and removed.
 
 ## Development and Community
 
@@ -756,20 +740,34 @@ curl -# https://download.elasticsearch.org/elasticsearch/elasticsearch/elasticse
 SERVER=start TEST_CLUSTER_COMMAND=$PWD/tmp/elasticsearch-1.0.0.RC1/bin/elasticsearch bundle exec rake test:all
 ```
 
+### Single Table Inheritance support
+
+Versions < 7.0.0 of this gem supported inheritance-- more specifically, `Single Table Inheritance`. With this feature,
+elasticsearch settings (index mappings, etc) on a parent model could be inherited by a child model leading to different
+model documents being indexed into the same Elasticsearch index. This feature depended on the ability to set a `type`
+for a document in Elasticsearch. The Elasticsearch team has deprecated support for `types`, as is described
+[here.](https://www.elastic.co/guide/en/elasticsearch/reference/current/removal-of-types.html)
+This gem will also remove support for types and `Single Table Inheritance` in version 7.0 as it enables an anti-pattern.
+Please save different model documents in separate indices. If you want to use STI, you can include an artificial
+`type` field manually in each document and use it in other operations.
+
 ## License
 
 This software is licensed under the Apache 2 license, quoted below.
 
-    Copyright (c) 2014 Elasticsearch <http://www.elasticsearch.org>
-
-    Licensed under the Apache License, Version 2.0 (the "License");
-    you may not use this file except in compliance with the License.
+    Licensed to Elasticsearch B.V. under one or more contributor
+    license agreements. See the NOTICE file distributed with
+    this work for additional information regarding copyright
+    ownership. Elasticsearch B.V. licenses this file to you under
+    the Apache License, Version 2.0 (the "License"); you may
+    not use this file except in compliance with the License.
     You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-    Unless required by applicable law or agreed to in writing, software
-    distributed under the License is distributed on an "AS IS" BASIS,
-    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-    See the License for the specific language governing permissions and
-    limitations under the License.
+    
+    	http://www.apache.org/licenses/LICENSE-2.0
+    
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.

data/Rakefile

@@ -15,17 +15,15 @@
 # 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:all'
+task test:    'test:all'
 
-if RUBY_VERSION < '2.3'
-  GEMFILES = ['3.0.gemfile', '4.0.gemfile', '5.0.gemfile']
-else
-  GEMFILES = ['4.0.gemfile', '5.0.gemfile', '6.0.gemfile']
-end
+gemfiles = ['5.0.gemfile', '6.0.gemfile']
+gemfiles << '4.0.gemfile' if RUBY_VERSION < '2.7'
+GEMFILES = gemfiles.freeze
 
 namespace :bundle do
   desc 'Install dependencies for all the Gemfiles in /gemfiles. Optionally define env variable RAILS_VERSIONS. E.g. RAILS_VERSIONS=3.0,5.0'
@@ -47,7 +45,6 @@ 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

data/elasticsearch-model.gemspec

@@ -16,56 +16,54 @@
 # 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/model/version'
 
 Gem::Specification.new do |s|
-  s.name          = "elasticsearch-model"
+  s.name          = 'elasticsearch-model'
   s.version       = Elasticsearch::Model::VERSION
-  s.authors       = ["Karel Minarik"]
-  s.email         = ["karel.minarik@elasticsearch.org"]
-  s.description   = "ActiveModel/Record integrations for Elasticsearch."
-  s.summary       = "ActiveModel/Record integrations for Elasticsearch."
-  s.homepage      = "https://github.com/elasticsearch/elasticsearch-rails/"
-  s.license       = "Apache 2"
+  s.authors       = ['Karel Minarik']
+  s.email         = ['karel.minarik@elasticsearch.org']
+  s.description   = 'ActiveModel/Record integrations for Elasticsearch.'
+  s.summary       = 'ActiveModel/Record integrations for Elasticsearch.'
+  s.homepage      = 'https://github.com/elasticsearch/elasticsearch-rails/'
+  s.license       = 'Apache 2'
 
   s.files         = `git ls-files`.split($/)
   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",       '> 1'
-  s.add_dependency "activesupport",       '> 3'
-  s.add_dependency "hashie"
-
-  s.add_development_dependency "bundler"
-  s.add_development_dependency "rake", "~> 11.1"
-
-  s.add_development_dependency "elasticsearch-extensions"
+  s.require_paths = ['lib']
 
-  s.add_development_dependency "sqlite3" unless defined?(JRUBY_VERSION)
-  s.add_development_dependency "activemodel",   "> 3"
+  s.extra_rdoc_files  = ['README.md', 'LICENSE.txt']
+  s.rdoc_options      = ['--charset=UTF-8']
 
-  s.add_development_dependency "oj" unless defined?(JRUBY_VERSION)
-  s.add_development_dependency "kaminari"
-  s.add_development_dependency "will_paginate"
+  s.required_ruby_version = '>= 2.4'
 
-  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 'activesupport', '> 3'
+  s.add_dependency 'elasticsearch', '~> 7'
+  s.add_dependency 'hashie'
 
-  s.add_development_dependency "simplecov"
-  s.add_development_dependency "cane"
-  s.add_development_dependency "require-prof"
+  s.add_development_dependency 'activemodel', '> 3'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'cane'
+  s.add_development_dependency 'elasticsearch-extensions'
+  s.add_development_dependency 'kaminari'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake', '~> 12'
+  s.add_development_dependency 'require-prof'
+  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 'will_paginate'
+  s.add_development_dependency 'yard'
+  unless defined?(JRUBY_VERSION)
+    s.add_development_dependency 'oj'
+    s.add_development_dependency 'ruby-prof'
+    s.add_development_dependency 'sqlite3'
+  end
 end

data/examples/activerecord_associations.rb

@@ -98,6 +98,22 @@ module Searchable
 
   module Indexing
 
+  #Index only the specified fields
+  settings do
+    mappings dynamic: false do
+      indexes :categories, type: :object do
+        indexes :title
+      end
+      indexes :authors, type: :object do
+        indexes :full_name
+        indexes :department
+      end
+      indexes :comments, type: :object do
+        indexes :text 
+      end
+    end
+  end
+    
     # Customize the JSON serialization for Elasticsearch
     def as_indexed_json(options={})
       self.as_json(

data/gemfiles/4.0.gemfile

@@ -26,10 +26,11 @@ gemspec path: '../'
 
 gem 'activemodel',  '~> 4'
 gem 'activerecord', '~> 4'
-gem 'sqlite3', '> 1.3', '< 1.4' unless defined?(JRUBY_VERSION)
 gem 'mongoid', '~> 5'
+gem 'sqlite3', '> 1.3', '< 1.4' unless defined?(JRUBY_VERSION)
 
 group :development, :testing do
-  gem 'rspec'
+  gem 'bigdecimal', '~> 1'
   gem 'pry-nav'
-end
+  gem 'rspec'
+end

data/gemfiles/6.0.gemfile

@@ -25,10 +25,10 @@ source 'https://rubygems.org'
 
 gemspec path: '../'
 
-gem 'activemodel',  '6.0.0.rc1'
-gem 'activerecord', '6.0.0.rc1'
+gem 'activemodel',  '6.0.0'
+gem 'activerecord', '6.0.0'
 gem 'sqlite3' unless defined?(JRUBY_VERSION)
-gem 'mongoid', '~> 6'
+#gem 'mongoid', '~> 6'
 
 group :development, :testing do
   gem 'rspec'

data/lib/elasticsearch/model.rb

@@ -89,9 +89,10 @@ module Elasticsearch
 
     # Adds the `Elasticsearch::Model` functionality to the including class.
     #
-    # * Creates the `__elasticsearch__` class and instance methods, pointing to the proxy object
-    # * Includes the necessary modules in the proxy classes
-    # * Sets up delegation for crucial methods such as `search`, etc.
+    # * Creates the `__elasticsearch__` class and instance method. These methods return a proxy object with
+    #   other common methods defined on them.
+    # * The module includes other modules with further functionality.
+    # * Sets up delegation for common methods such as `import` and `search`.
     #
     # @example Include the module in the `Article` model definition
     #
@@ -108,50 +109,16 @@ module Elasticsearch
       base.class_eval do
         include Elasticsearch::Model::Proxy
 
-        Elasticsearch::Model::Proxy::ClassMethodsProxy.class_eval do
-          include Elasticsearch::Model::Client::ClassMethods
-          include Elasticsearch::Model::Naming::ClassMethods
-          include Elasticsearch::Model::Indexing::ClassMethods
-          include Elasticsearch::Model::Searching::ClassMethods
-        end
-
-        Elasticsearch::Model::Proxy::InstanceMethodsProxy.class_eval do
-          include Elasticsearch::Model::Client::InstanceMethods
-          include Elasticsearch::Model::Naming::InstanceMethods
-          include Elasticsearch::Model::Indexing::InstanceMethods
-          include Elasticsearch::Model::Serializing::InstanceMethods
-        end
-
-        Elasticsearch::Model::Proxy::InstanceMethodsProxy.class_eval <<-CODE, __FILE__, __LINE__ + 1
-          def as_indexed_json(options={})
-            target.respond_to?(:as_indexed_json) ? target.__send__(:as_indexed_json, options) : super
-          end
-        CODE
-
-        # Delegate important methods to the `__elasticsearch__` proxy, unless they are defined already
-        #
+        # Delegate common methods to the `__elasticsearch__` ClassMethodsProxy, unless they are defined already
         class << self
           METHODS.each do |method|
             delegate method, to: :__elasticsearch__ unless self.public_instance_methods.include?(method)
           end
         end
-
-        # Mix the importing module into the proxy
-        #
-        self.__elasticsearch__.class_eval do
-          include Elasticsearch::Model::Importing::ClassMethods
-          include Adapter.from_class(base).importing_mixin
-        end
-
-        # Add to the registry if it's a class (and not in intermediate module)
-        Registry.add(base) if base.is_a?(Class)
       end
-    end
 
-    # Access the module settings
-    #
-    def self.settings
-      @settings ||= {}
+      # Add to the model to the registry if it's a class (and not in intermediate module)
+      Registry.add(base) if base.is_a?(Class)
     end
 
     module ClassMethods
@@ -205,22 +172,10 @@ module Elasticsearch
         Response::Response.new(models, request)
       end
 
-      # Check if inheritance is enabled
-      #
-      # @note Inheritance is disabled by default.
-      #
-      def inheritance_enabled
-        @inheritance_enabled ||= false
-      end
-
-      # Enable inheritance of index_name and document_type
-      #
-      # @example Enable inheritance
-      #
-      #     Elasticsearch::Model.inheritance_enabled = true
+      # Access the module settings
       #
-      def inheritance_enabled=(inheritance_enabled)
-        @inheritance_enabled = inheritance_enabled
+      def settings
+        @settings ||= {}
       end
     end
     extend ClassMethods