elasticsearch-model 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 726d16096fd6ca31266bab9b42c4f878cba6942eada1649de7fbf946af2575f0
-  data.tar.gz: 8ce1faffcdda9dae38ff2beddab31f0b161853c4fd9919b699cdb5e5a27f2baa
+  metadata.gz: 7ed2b3f49b07fddee98c7628224c50ed65147a28a27c0e1cad0234ebe38b645f
+  data.tar.gz: 9c2cea09cb144c08c912352d4f055d70796c6662713900382ee3672a33a90da2
 SHA512:
-  metadata.gz: 63904bd61ec508918ee8a0d6cbe7cd089dc0b6df7c6f4d8ea1fef7538b2aea3a88962724e6a5fc486f5ec10146350e4176655b3fbeec868a66b6b3e00e767307
-  data.tar.gz: 36fccab94cf1f3cdfa599ad0a6d74cecc1b503c80da296e73381f3b3f2130244d57a9b51fabaff5e624e7f0955442e3b0e67d7006b6b94f705fdc4249252ac12
+  metadata.gz: 3156e42603250f4e3a6deee15c7bf78bfe95a6f2de1c425a45e350e1f7bbe3fc366837dbcbf80b492c2dfedd815c0968e56ba9437da2434342d634bd3993155e
+  data.tar.gz: 3862bef940069503924101479c3c3514a20ae783658a2ae395245f5245328c5e41d5c7e485c6e2371534ccd4502bcc82cf1205846e3f550006fe2b4c79be4d3f

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in elasticsearch-model.gemspec
 gemspec
+
+group :development, :testing do
+  gem 'rspec'
+  gem 'pry-nav'
+end

data/README.md

@@ -19,6 +19,7 @@ is compatible with the Elasticsearch `master` branch, therefore, with the next m
 | 0.1           | → | 1.x           |
 | 2.x           | → | 2.x           |
 | 5.x           | → | 5.x           |
+| 6.x           | → | 6.x           |
 | master        | → | master        |
 
 ## Installation
@@ -724,13 +725,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
 
@@ -748,6 +744,17 @@ 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 deprecation
+
+`Single Table Inheritance` has been supported through the 6.x series of this gem. 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.

data/Rakefile

@@ -4,12 +4,25 @@ desc "Run unit tests"
 task :default => 'test:unit'
 task :test    => 'test:unit'
 
-namespace :bundler do
-  desc "Install dependencies for all the Gemfiles"
+if RUBY_VERSION < '2.3'
+  GEMFILES = ['3.0.gemfile', '4.0.gemfile', '5.0.gemfile']
+else
+  GEMFILES = ['4.0.gemfile', '5.0.gemfile']
+end
+
+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'
   task :install do
-    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/3.0.gemfile', __FILE__)}' bundle install"
-    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/4.0.gemfile', __FILE__)}' bundle install"
-    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/5.0.gemfile', __FILE__)}' bundle install"
+    unless defined?(JRUBY_VERSION)
+      puts '-'*80
+      gemfiles = ENV['RAILS_VERSIONS'] ? ENV['RAILS_VERSIONS'].split(',').map { |v| "#{v}.gemfile"} : GEMFILES
+      gemfiles.each do |gemfile|
+        Bundler.with_clean_env do
+          sh "bundle install --gemfile #{File.expand_path('../gemfiles/'+gemfile, __FILE__)}"
+        end
+        puts '-'*80
+      end
+    end
   end
 end
 
@@ -17,38 +30,16 @@ end
 
 require 'rake/testtask'
 namespace :test do
-  Rake::TestTask.new(:run_unit) do |test|
-    test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/unit/**/*_test.rb"]
-    test.verbose = false
-    test.warning = false
-  end
-
-  Rake::TestTask.new(:run_integration) do |test|
-    test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/integration/**/*_test.rb"]
-    test.verbose = false
-    test.warning = false
-  end
-
-  desc "Run unit tests against ActiveModel 3, 4 and 5"
-  task :unit do
-    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/3.0.gemfile', __FILE__)}' bundle exec rake test:run_unit"
-    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/4.0.gemfile', __FILE__)}' bundle exec rake test:run_unit"
-    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/5.0.gemfile', __FILE__)}' bundle exec rake test:run_unit"
-  end
-
-  desc "Run integration tests against latest stable ActiveModel (5)"
-  task :integration do
-    #sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/3.0.gemfile', __FILE__)}' bundle exec rake test:run_integration"
-    #sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/4.0.gemfile', __FILE__)}' bundle exec rake test:run_integration"
-    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/5.0.gemfile', __FILE__)}' bundle exec rake test:run_integration"
-  end
 
-  desc "Run unit and integration tests"
-  task :all do
-    Rake::Task['test:unit'].invoke
-    Rake::Task['test:integration'].invoke
+  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
+    puts '-' * 80
+    gemfiles.each do |gemfile|
+      sh "BUNDLE_GEMFILE='#{File.expand_path("../gemfiles/#{gemfile}", __FILE__)}' " +
+             " bundle exec rspec"
+      puts '-' * 80
+    end
   end
 end
 

data/elasticsearch-model.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.add_dependency "activesupport",       '> 3'
   s.add_dependency "hashie"
 
-  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "bundler"
   s.add_development_dependency "rake", "~> 11.1"
 
   s.add_development_dependency "elasticsearch-extensions"

data/examples/activerecord_mapping_completion.rb

@@ -50,20 +50,7 @@ response_1 = Article.search 'foo';
 puts "Article search:".ansi(:bold),
      response_1.to_a.map { |d| "Title: #{d.title}" }.inspect.ansi(:bold, :yellow)
 
-response_2 = Article.__elasticsearch__.client.suggest \
-  index: Article.index_name,
-  body: {
-    articles: {
-      text: 'foo',
-      completion: { field: 'title.suggest' }
-    }
-  };
-
-puts "Article suggest:".ansi(:bold),
-     response_2['articles'].first['options'].map { |d| "#{d['text']} -> #{d['_source']['url']}" }.
-     inspect.ansi(:bold, :green)
-
-response_3 = Article.search \
+response_2 = Article.search \
   query: {
     match: { title: 'foo' }
   },
@@ -76,7 +63,7 @@ response_3 = Article.search \
   _source: ['title', 'url']
 
 puts "Article search with suggest:".ansi(:bold),
-     response_3.response['suggest']['articles'].first['options'].map { |d| "#{d['text']} -> #{d['_source']['url']}" }.
+     response_2.response['suggest']['articles'].first['options'].map { |d| "#{d['text']} -> #{d['_source']['url']}" }.
      inspect.ansi(:bold, :blue)
 
 require 'pry'; binding.pry;

data/gemfiles/3.0.gemfile

@@ -10,4 +10,9 @@ gemspec path: '../'
 gem 'activemodel',  '>= 3.0'
 gem 'activerecord', '~> 3.2'
 gem 'mongoid',      '>= 3.0'
-gem 'sqlite3' unless defined?(JRUBY_VERSION)
+gem 'sqlite3', '~> 1.3.6' unless defined?(JRUBY_VERSION)
+
+group :development, :testing do
+  gem 'rspec'
+  gem 'pry-nav'
+end

data/gemfiles/4.0.gemfile

@@ -9,4 +9,10 @@ gemspec path: '../'
 
 gem 'activemodel',  '~> 4'
 gem 'activerecord', '~> 4'
-gem 'sqlite3' unless defined?(JRUBY_VERSION)
+gem 'sqlite3', '~> 1.3.6' unless defined?(JRUBY_VERSION)
+gem 'mongoid', '~> 5'
+
+group :development, :testing do
+  gem 'rspec'
+  gem 'pry-nav'
+end

data/gemfiles/5.0.gemfile

@@ -10,3 +10,9 @@ gemspec path: '../'
 gem 'activemodel',  '~> 5'
 gem 'activerecord', '~> 5'
 gem 'sqlite3' unless defined?(JRUBY_VERSION)
+gem 'mongoid', '~> 6'
+
+group :development, :testing do
+  gem 'rspec'
+  gem 'pry-nav'
+end

data/lib/elasticsearch/model.rb

@@ -131,12 +131,6 @@ module Elasticsearch
       end
     end
 
-    # Access the module settings
-    #
-    def self.settings
-      @settings ||= {}
-    end
-
     module ClassMethods
       # Get the client common for all models
       #
@@ -193,7 +187,7 @@ module Elasticsearch
       # @note Inheritance is disabled by default.
       #
       def inheritance_enabled
-        @inheritance_enabled ||= false
+        @settings[:inheritance_enabled] ||= false
       end
 
       # Enable inheritance of index_name and document_type
@@ -203,8 +197,21 @@ module Elasticsearch
       #     Elasticsearch::Model.inheritance_enabled = true
       #
       def inheritance_enabled=(inheritance_enabled)
-        @inheritance_enabled = inheritance_enabled
+        warn STI_DEPRECATION_WARNING if inheritance_enabled
+        @settings[:inheritance_enabled] = inheritance_enabled
+      end
+
+      # Access the module settings
+      #
+      def settings
+        @settings ||= {}
       end
+
+      private
+
+      STI_DEPRECATION_WARNING = "DEPRECATION WARNING: Support for Single Table Inheritance (STI) is deprecated " +
+        "and will be removed in version 7.0.0.\nPlease save different model documents in separate indices and refer " +
+        "to the Elasticsearch documentation for more information.".freeze
     end
     extend ClassMethods
 

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

@@ -35,7 +35,11 @@ module Elasticsearch
                 else
                   self.__send__(:exec_queries)
                 end
-                @records.sort_by { |record| hits.index { |hit| hit['_id'].to_s == record.id.to_s } }
+                if !self.order_values.present?
+                  @records.sort_by { |record| hits.index { |hit| hit['_id'].to_s == record.id.to_s } }
+                else
+                  @records
+                end
               end if self
             end
 
@@ -47,30 +51,6 @@ module Elasticsearch
           def load
             records.__send__(:load)
           end
-
-          # Intercept call to the `order` method, so we can ignore the order from Elasticsearch
-          #
-          def order(*args)
-            sql_records = records.__send__ :order, *args
-
-            # Redefine the `to_a` method to the original one
-            #
-            sql_records.instance_exec do
-              ar_records_method_name = :to_a
-              ar_records_method_name = :records if defined?(::ActiveRecord) && ::ActiveRecord::VERSION::MAJOR >= 5
-
-              define_singleton_method(ar_records_method_name) do
-                if defined?(::ActiveRecord) && ::ActiveRecord::VERSION::MAJOR >= 4
-                  self.load
-                else
-                  self.__send__(:exec_queries)
-                end
-                @records
-              end
-            end
-
-            sql_records
-          end
         end
 
         module Callbacks
@@ -106,7 +86,8 @@ module Elasticsearch
             scope = scope.instance_exec(&query) if query
 
             scope.find_in_batches(options) do |batch|
-              yield (preprocess ? self.__send__(preprocess, batch) : batch)
+              batch = self.__send__(preprocess, batch) if preprocess
+              yield(batch) if batch.present?
             end
           end
 

data/lib/elasticsearch/model/indexing.rb

@@ -269,7 +269,8 @@ module Elasticsearch
             self.client.indices.delete index: target_index
           rescue Exception => e
             if e.class.to_s =~ /NotFound/ && options[:force]
-              STDERR.puts "[!!!] Index does not exist (#{e.class})"
+              client.transport.logger.debug("[!!!] Index does not exist (#{e.class})") if client.transport.logger
+              nil
             else
               raise e
             end
@@ -295,7 +296,8 @@ module Elasticsearch
             self.client.indices.refresh index: target_index
           rescue Exception => e
             if e.class.to_s =~ /NotFound/ && options[:force]
-              STDERR.puts "[!!!] Index does not exist (#{e.class})"
+              client.transport.logger.debug("[!!!] Index does not exist (#{e.class})") if client.transport.logger
+              nil
             else
               raise e
             end
@@ -409,7 +411,7 @@ module Elasticsearch
                 type:  document_type,
                 id:    self.id,
                 body:  { doc: attributes } }.merge(options)
-            )
+            ) unless attributes.empty?
           else
             index_document(options)
           end

data/lib/elasticsearch/model/naming.rb

@@ -79,7 +79,12 @@ module Elasticsearch
 
             if Elasticsearch::Model.settings[:inheritance_enabled]
               self.ancestors.each do |klass|
-                next if klass == self
+                # When Naming is included in Proxy::ClassMethods the actual model
+                # is among its ancestors. We don't want to call the actual model
+                # since it will result in the same call to the same instance of
+                # Proxy::ClassMethods. To prevent this we also skip the ancestor
+                # that is the target.
+                next if klass == self || self.respond_to?(:target) && klass == self.target
                 break if value = klass.respond_to?(prop) && klass.send(prop)
               end
             end

data/lib/elasticsearch/model/response.rb

@@ -60,7 +60,7 @@ module Elasticsearch
         # Returns the statistics on shards
         #
         def shards
-          @shards ||= HashWrapper.new(raw_response['_shards'])
+          @shards ||= response['_shards']
         end
 
         # Returns a Hashie::Mash of the aggregations
@@ -76,7 +76,7 @@ module Elasticsearch
         end
 
         def raw_response
-          @raw_response ||= search.execute!
+          @raw_response ||= @response ? @response.to_hash : search.execute!
         end
       end
     end

data/lib/elasticsearch/model/response/pagination.rb

@@ -1,192 +1,2 @@
-module Elasticsearch
-  module Model
-    module Response
-
-      # Pagination for search results/records
-      #
-      module Pagination
-        # Allow models to be paginated with the "kaminari" gem [https://github.com/amatsuda/kaminari]
-        #
-        module Kaminari
-          def self.included(base)
-            # Include the Kaminari configuration and paging method in response
-            #
-            base.__send__ :include, ::Kaminari::ConfigurationMethods::ClassMethods
-            base.__send__ :include, ::Kaminari::PageScopeMethods
-
-            # Include the Kaminari paging methods in results and records
-            #
-            Elasticsearch::Model::Response::Results.__send__ :include, ::Kaminari::ConfigurationMethods::ClassMethods
-            Elasticsearch::Model::Response::Results.__send__ :include, ::Kaminari::PageScopeMethods
-            Elasticsearch::Model::Response::Records.__send__ :include, ::Kaminari::PageScopeMethods
-
-            Elasticsearch::Model::Response::Results.__send__ :delegate, :limit_value, :offset_value, :total_count, :max_pages, to: :response
-            Elasticsearch::Model::Response::Records.__send__ :delegate, :limit_value, :offset_value, :total_count, :max_pages, to: :response
-
-            base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-              # Define the `page` Kaminari method
-              #
-              def #{::Kaminari.config.page_method_name}(num=nil)
-                @results  = nil
-                @records  = nil
-                @response = nil
-                @page     = [num.to_i, 1].max
-                @per_page ||= __default_per_page
-
-                self.search.definition.update size: @per_page,
-                                              from: @per_page * (@page - 1)
-
-                self
-              end
-            RUBY
-          end
-
-          # Returns the current "limit" (`size`) value
-          #
-          def limit_value
-            case
-              when search.definition[:size]
-                search.definition[:size]
-              else
-                __default_per_page
-            end
-          end
-
-          # Returns the current "offset" (`from`) value
-          #
-          def offset_value
-            case
-              when search.definition[:from]
-                search.definition[:from]
-              else
-                0
-            end
-          end
-
-          # Set the "limit" (`size`) value
-          #
-          def limit(value)
-            return self if value.to_i <= 0
-            @results  = nil
-            @records  = nil
-            @response = nil
-            @per_page = value.to_i
-
-            search.definition.update :size => @per_page
-            search.definition.update :from => @per_page * (@page - 1) if @page
-            self
-          end
-
-          # Set the "offset" (`from`) value
-          #
-          def offset(value)
-            return self if value.to_i < 0
-            @results  = nil
-            @records  = nil
-            @response = nil
-            @page     = nil
-            search.definition.update :from => value.to_i
-            self
-          end
-
-          # Returns the total number of results
-          #
-          def total_count
-            results.total
-          end
-
-          # Returns the models's `per_page` value or the default
-          #
-          # @api private
-          #
-          def __default_per_page
-            klass.respond_to?(:default_per_page) && klass.default_per_page || ::Kaminari.config.default_per_page
-          end
-        end
-
-        # Allow models to be paginated with the "will_paginate" gem [https://github.com/mislav/will_paginate]
-        #
-        module WillPaginate
-          def self.included(base)
-            base.__send__ :include, ::WillPaginate::CollectionMethods
-
-            # Include the paging methods in results and records
-            #
-            methods = [:current_page, :offset, :length, :per_page, :total_entries, :total_pages, :previous_page, :next_page, :out_of_bounds?]
-            Elasticsearch::Model::Response::Results.__send__ :delegate, *methods, to: :response
-            Elasticsearch::Model::Response::Records.__send__ :delegate, *methods, to: :response
-          end
-
-          def offset
-            (current_page - 1) * per_page
-          end
-
-          def length
-            search.definition[:size]
-          end
-
-          # Main pagination method
-          #
-          # @example
-          #
-          #     Article.search('foo').paginate(page: 1, per_page: 30)
-          #
-          def paginate(options)
-            param_name = options[:param_name] || :page
-            page       = [options[param_name].to_i, 1].max
-            per_page   = (options[:per_page] || __default_per_page).to_i
-
-            search.definition.update size: per_page,
-                                     from: (page - 1) * per_page
-            self
-          end
-
-          # Return the current page
-          #
-          def current_page
-            search.definition[:from] / per_page + 1 if search.definition[:from] && per_page
-          end
-
-          # Pagination method
-          #
-          # @example
-          #
-          #     Article.search('foo').page(2)
-          #
-          def page(num)
-            paginate(page: num, per_page: per_page) # shorthand
-          end
-
-          # Return or set the "size" value
-          #
-          # @example
-          #
-          #     Article.search('foo').per_page(15).page(2)
-          #
-          def per_page(num = nil)
-            if num.nil?
-              search.definition[:size]
-            else
-              paginate(page: current_page, per_page: num) # shorthand
-            end
-          end
-
-          # Returns the total number of results
-          #
-          def total_entries
-            results.total
-          end
-
-          # Returns the models's `per_page` value or the default
-          #
-          # @api private
-          #
-          def __default_per_page
-            klass.respond_to?(:per_page) && klass.per_page || ::WillPaginate.per_page
-          end
-        end
-      end
-
-    end
-  end
-end
+require 'elasticsearch/model/response/pagination/kaminari'
+require 'elasticsearch/model/response/pagination/will_paginate'