elasticsearch-model 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a357cdf1cb6d365afa38ed6631734804545d9cac
-  data.tar.gz: d11d799cc4c42be14d094e4561ca826f235d8399
+  metadata.gz: e6ee0c4e1aa23d578d305367880c00683f8722eb
+  data.tar.gz: e55f679c7973d5381225ca46514dd3d901a65aa4
 SHA512:
-  metadata.gz: c6608ecda81dc60edd8a18e814ad2baa758d879ed861b9e413b9123c91c648037d719635c7875a4e95e0199dfdad660a34297a4fa759e00eec23c0bf2eefcde3
-  data.tar.gz: 34e2112aa52d77b7b8d3fd688f11618cf2aa34634004217c613b31e65cc3b7cbd884b2614cdfb3b63d60e68ec9b2e4b0a3ff664b142287d170d9097cb9318530
+  metadata.gz: e1bb3398d41326acb683669d4becd275f2f6bb9c4ef4ac8148d810c056d8e59df3ee0647f0dabaeb681d29cd94eff8fee7498fbc09cd3ec91a9abd2986bce953
+  data.tar.gz: 7c7f7e24165e04f86494f5458944155cfa4c36f1e15acd58ede28d27372172885f74c74d1af16d6786960c0402eb0f58a24f223b58a3f865a61cb4a9f5851878

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.1.9
+
+* Added a `suggest` method to wrap the suggestions in response
+* Added the `:includes` option to Adapter::ActiveRecord::Records for eagerly loading associated models
+* Delegated `max_pages` method properly for Kaminari's `next_page`
+* Fixed `#dup` behaviour for Elasticsearch::Model
+* Fixed typos in the README and examples
+
 ## 0.1.8
 
 * Added "default per page" methods for pagination with multi model searches

data/README.md

@@ -229,7 +229,7 @@ response.records.records.class
 # => ActiveRecord::Relation::ActiveRecord_Relation_Article
 ```
 
-The ordering of the records by score will be preserved, unless you explicitely specify a different
+The ordering of the records by score will be preserved, unless you explicitly specify a different
 order in your model query language:
 
 ```ruby

data/elasticsearch-model.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.add_dependency "hashie"
 
   s.add_development_dependency "bundler", "~> 1.3"
-  s.add_development_dependency "rake"
+  s.add_development_dependency "rake", "< 11.0"
 
   s.add_development_dependency "elasticsearch-extensions"
 

data/gemfiles/3.0.gemfile

@@ -10,3 +10,4 @@ gemspec path: '../'
 gem 'activemodel',  '>= 3.0'
 gem 'activerecord', '~> 3.2'
 gem 'mongoid',      '>= 3.0'
+gem 'sqlite3'

data/gemfiles/4.0.gemfile

@@ -9,3 +9,4 @@ gemspec path: '../'
 
 gem 'activemodel',  '~> 4'
 gem 'activerecord', '~> 4'
+gem 'sqlite3'

data/lib/elasticsearch/model.rb

@@ -31,6 +31,7 @@ require 'elasticsearch/model/response/result'
 require 'elasticsearch/model/response/results'
 require 'elasticsearch/model/response/records'
 require 'elasticsearch/model/response/pagination'
+require 'elasticsearch/model/response/suggestions'
 
 require 'elasticsearch/model/ext/active_record'
 

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

@@ -10,10 +10,17 @@ module Elasticsearch
                          lambda { |klass| !!defined?(::ActiveRecord::Base) && klass.respond_to?(:ancestors) && klass.ancestors.include?(::ActiveRecord::Base) }
 
         module Records
+          attr_writer :options
+
+          def options
+            @options ||= {}
+          end
+
           # Returns an `ActiveRecord::Relation` instance
           #
           def records
             sql_records = klass.where(klass.primary_key => ids)
+            sql_records = sql_records.includes(self.options[:includes]) if self.options[:includes]
 
             # Re-order records based on the order from Elasticsearch hits
             # by redefining `to_a`, unless the user has called `order()`

data/lib/elasticsearch/model/importing.rb

@@ -84,7 +84,7 @@ module Elasticsearch
         #
         #     class Article
         #       # ...
-        #       def enrich(batch)
+        #       def self.enrich(batch)
         #         batch.each do |item|
         #           item.metadata = MyAPI.get_metadata(item.id)
         #         end
@@ -92,7 +92,7 @@ module Elasticsearch
         #       end
         #     end
         #
-        #    Article.import preprocess: enrich
+        #    Article.import preprocess: :enrich
         #
         # @example Return an array of error elements instead of the number of errors, eg.
         #          to try importing these records again

data/lib/elasticsearch/model/indexing.rb

@@ -52,7 +52,7 @@ module Elasticsearch
 
           if block_given?
             @mapping[name][:type] ||= 'object'
-            properties = TYPES_WITH_EMBEDDED_PROPERTIES.include?(@mapping[name][:type]) ? :properties : :fields
+            properties = TYPES_WITH_EMBEDDED_PROPERTIES.include?(@mapping[name][:type].to_s) ? :properties : :fields
 
             @mapping[name][properties] ||= {}
 

data/lib/elasticsearch/model/proxy.rb

@@ -66,6 +66,15 @@ module Elasticsearch
         end
       end
 
+      # @overload dup
+      #
+      # Returns a copy of this object. Resets the __elasticsearch__ proxy so
+      # the duplicate will build its own proxy.
+      def initialize_dup(_)
+        @__elasticsearch__ = nil
+        super
+      end
+
       # Common module for the proxy classes
       #
       module Base

data/lib/elasticsearch/model/response.rb

@@ -44,8 +44,8 @@ module Elasticsearch
         #
         # @return [Records]
         #
-        def records
-          @records ||= Records.new(klass, self)
+        def records(options = {})
+          @records ||= Records.new(klass, self, options)
         end
 
         # Returns the "took" time
@@ -71,6 +71,12 @@ module Elasticsearch
         def aggregations
           response['aggregations'] ? Hashie::Mash.new(response['aggregations']) : nil
         end
+
+        # Returns a Hashie::Mash of the suggestions
+        #
+        def suggestions
+          Suggestions.new(response['suggest'])
+        end
       end
     end
   end

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

@@ -20,8 +20,8 @@ module Elasticsearch
             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, to: :response
-            Elasticsearch::Model::Response::Records.__send__ :delegate, :limit_value, :offset_value, :total_count, to: :response
+            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

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

@@ -12,6 +12,8 @@ module Elasticsearch
 
         delegate :each, :empty?, :size, :slice, :[], :to_a, :to_ary, to: :records
 
+        attr_accessor :options
+
         include Base
 
         # @see Base#initialize
@@ -25,6 +27,7 @@ module Elasticsearch
           metaclass = class << self; self; end
           metaclass.__send__ :include, adapter.records_mixin
 
+          self.options = options
           self
         end
 

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

@@ -0,0 +1,13 @@
+module Elasticsearch
+  module Model
+    module Response
+
+      class Suggestions < Hashie::Mash
+        def terms
+          self.to_a.map { |k,v| v.first['options'] }.flatten.map {|v| v['text']}.uniq
+        end
+      end
+
+    end
+  end
+end

data/lib/elasticsearch/model/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Model
-    VERSION = "0.1.8"
+    VERSION = "0.1.9"
   end
 end

data/test/integration/active_record_associations_test.rb

@@ -133,11 +133,16 @@ module Elasticsearch
           # Include the search integration
           #
           Post.__send__ :include, Searchable
+          Comment.__send__ :include, Elasticsearch::Model
+          Comment.__send__ :include, Elasticsearch::Model::Callbacks
 
-          # ----- Reset the index -----------------------------------------------------------------
+          # ----- Reset the indices -----------------------------------------------------------------
 
           Post.delete_all
           Post.__elasticsearch__.create_index! force: true
+
+          Comment.delete_all
+          Comment.__elasticsearch__.create_index! force: true
         end
 
         should "index and find a document" do
@@ -300,6 +305,20 @@ module Elasticsearch
           assert_equal 0, Post.search('categories:One').size
           assert_equal 1, Post.search('categories:Updated').size
         end
+
+        should "eagerly load associated records" do
+          post_1 = Post.create(title: 'One')
+          post_2 = Post.create(title: 'Two')
+          post_1.comments.create text: 'First comment'
+          post_1.comments.create text: 'Second comment'
+
+          Comment.__elasticsearch__.refresh_index!
+
+          records = Comment.search('first').records(includes: :post)
+
+          assert records.first.association(:post).loaded?, "The associated Post should be eagerly loaded"
+          assert_equal 'One', records.first.post.title
+        end
       end
 
     end

data/test/integration/active_record_basic_test.rb

@@ -22,11 +22,18 @@ module Elasticsearch
 
             settings index: { number_of_shards: 1, number_of_replicas: 0 } do
               mapping do
-                indexes :title,      type: 'string', analyzer: 'snowball'
-                indexes :body,       type: 'string'
-                indexes :created_at, type: 'date'
+                indexes :title,         type: 'string', analyzer: 'snowball'
+                indexes :body,          type: 'string'
+                indexes :created_at,    type: 'date'
               end
             end
+
+            def as_indexed_json(options = {})
+              attributes
+                .symbolize_keys
+                .slice(:title, :body, :created_at)
+                .merge(suggest_title: title)
+            end
           end
 
           Article.delete_all
@@ -210,10 +217,15 @@ module Elasticsearch
 
         should "allow dot access to response" do
           response = Article.search query: { match: { title: { query: 'test' } } },
-                                    aggregations: { dates: { date_histogram: { field: 'created_at', interval: 'hour' } } }
+                                    aggregations: { dates: { date_histogram: { field: 'created_at', interval: 'hour' } } },
+                                    suggest: { text: 'tezt', title: { term: { field: 'title', suggest_mode: 'always' } } }
 
           response.response.respond_to?(:aggregations)
-          assert_equal 2, response.response.aggregations.dates.buckets.first.doc_count
+          assert_equal 2, response.aggregations.dates.buckets.first.doc_count
+
+          response.response.respond_to?(:suggest)
+          assert_equal 1, response.suggestions.title.first.options.size
+          assert_equal ['test'], response.suggestions.terms
         end
       end
 

data/test/unit/adapter_active_record_test.rb

@@ -51,6 +51,16 @@ class Elasticsearch::Model::AdapterActiveRecordTest < Test::Unit::TestCase
         instance.load
       end
 
+      should "load the records with its submodels when using :includes" do
+        klass    = mock('class', primary_key: :some_key, where: @records)
+        @records.expects(:includes).with([:submodel]).at_least_once
+
+        instance = DummyClassForActiveRecord.new
+        instance.expects(:klass).returns(klass).at_least_once
+        instance.options[:includes] = [:submodel]
+        instance.records
+      end
+
       should "reorder the records based on hits order" do
         @records.instance_variable_set(:@records, @records)
 

data/test/unit/indexing_test.rb

@@ -127,6 +127,10 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
           indexes :bar
         end
 
+        mappings.indexes :foo_nested_as_symbol, type: :nested do
+          indexes :bar
+        end
+
         # Object is the default when `type` is missing and there's a block passed
         #
         assert_equal 'object', mappings.to_hash[:mytype][:properties][:foo][:type]
@@ -140,6 +144,10 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
         assert_equal 'nested', mappings.to_hash[:mytype][:properties][:foo_nested][:type]
         assert_equal 'string', mappings.to_hash[:mytype][:properties][:foo_nested][:properties][:bar][:type]
         assert_nil             mappings.to_hash[:mytype][:properties][:foo_nested][:fields]
+
+        assert_equal :nested, mappings.to_hash[:mytype][:properties][:foo_nested_as_symbol][:type]
+        assert_not_nil        mappings.to_hash[:mytype][:properties][:foo_nested_as_symbol][:properties]
+        assert_nil            mappings.to_hash[:mytype][:properties][:foo_nested_as_symbol][:fields]
       end
     end
 

data/test/unit/proxy_test.rb

@@ -69,6 +69,17 @@ class Elasticsearch::Model::SearchTest < Test::Unit::TestCase
       assert_equal 'insta barr', DummyProxyModel.new.__elasticsearch__.bar
     end
 
+    should "reset the proxy target for duplicates" do
+      model = DummyProxyModel.new
+      model_target = model.__elasticsearch__.target
+      duplicate = model.dup
+      duplicate_target = duplicate.__elasticsearch__.target
+
+      assert_not_equal model, duplicate
+      assert_equal model, model_target
+      assert_equal duplicate, duplicate_target
+    end
+
     should "return the proxy class from instance proxy" do
       assert_equal Elasticsearch::Model::Proxy::ClassMethodsProxy, DummyProxyModel.new.__elasticsearch__.class.class
     end

data/test/unit/response_pagination_kaminari_test.rb

@@ -194,6 +194,17 @@ class Elasticsearch::Model::ResponsePaginationKaminariTest < Test::Unit::TestCas
 
         assert_equal 5, @response.page(5).results.current_page
       end
+
+      should "return previous page and next page" do
+        assert_equal nil, @response.page(1).results.prev_page
+        assert_equal 2, @response.page(1).results.next_page
+
+        assert_equal 3, @response.page(4).results.prev_page
+        assert_equal nil, @response.page(4).results.next_page
+
+        assert_equal 2, @response.page(3).results.prev_page
+        assert_equal 4, @response.page(3).results.next_page
+      end
     end
 
     context "records" do
@@ -207,6 +218,17 @@ class Elasticsearch::Model::ResponsePaginationKaminariTest < Test::Unit::TestCas
 
         assert_equal 5, @response.page(5).records.current_page
       end
+
+      should "return previous page and next page" do
+        assert_equal nil, @response.page(1).records.prev_page
+        assert_equal 2, @response.page(1).records.next_page
+
+        assert_equal 3, @response.page(4).records.prev_page
+        assert_equal nil, @response.page(4).records.next_page
+
+        assert_equal 2, @response.page(3).records.prev_page
+        assert_equal 4, @response.page(3).records.next_page
+      end
     end
   end
 
@@ -371,6 +393,17 @@ class Elasticsearch::Model::ResponsePaginationKaminariTest < Test::Unit::TestCas
 
         assert_equal 5, @response.page(5).results.current_page
       end
+
+      should "return previous page and next page" do
+        assert_equal nil, @response.page(1).results.prev_page
+        assert_equal 2, @response.page(1).results.next_page
+
+        assert_equal 3, @response.page(4).results.prev_page
+        assert_equal nil, @response.page(4).results.next_page
+
+        assert_equal 2, @response.page(3).results.prev_page
+        assert_equal 4, @response.page(3).results.next_page
+      end
     end
 
     context "records" do
@@ -384,6 +417,17 @@ class Elasticsearch::Model::ResponsePaginationKaminariTest < Test::Unit::TestCas
 
         assert_equal 5, @response.page(5).records.current_page
       end
+
+      should "return previous page and next page" do
+        assert_equal nil, @response.page(1).records.prev_page
+        assert_equal 2, @response.page(1).records.next_page
+
+        assert_equal 3, @response.page(4).records.prev_page
+        assert_equal nil, @response.page(4).records.next_page
+
+        assert_equal 2, @response.page(3).records.prev_page
+        assert_equal 4, @response.page(3).records.next_page
+      end
     end
   end
 end

data/test/unit/response_test.rb

@@ -8,7 +8,8 @@ class Elasticsearch::Model::ResponseTest < Test::Unit::TestCase
     end
 
     RESPONSE = { 'took' => '5', 'timed_out' => false, '_shards' => {'one' => 'OK'}, 'hits' => { 'hits' => [] },
-                 'aggregations' => {'foo' => {'bar' => 10}}}
+                 'aggregations' => {'foo' => {'bar' => 10}},
+                 'suggest' => {'my_suggest' => [ { 'text' => 'foo', 'options' => [ { 'text' => 'Foo', 'score' => 2.0 }, { 'text' => 'Bar', 'score' => 1.0 } ] } ]}}
 
     setup do
       @search  = Elasticsearch::Model::Searching::SearchRequest.new OriginClass, '*'
@@ -73,5 +74,31 @@ class Elasticsearch::Model::ResponseTest < Test::Unit::TestCase
       assert_kind_of Hashie::Mash, response.aggregations.foo
       assert_equal 10, response.aggregations.foo.bar
     end
+
+    should "access the suggest" do
+      @search.expects(:execute!).returns(RESPONSE)
+
+      response = Elasticsearch::Model::Response::Response.new OriginClass, @search
+
+      assert_respond_to response, :suggestions
+      assert_kind_of Hashie::Mash, response.suggestions
+      assert_equal 'Foo', response.suggestions.my_suggest.first.options.first.text
+    end
+
+    should "return array of terms from the suggestions" do
+      @search.expects(:execute!).returns(RESPONSE)
+      response = Elasticsearch::Model::Response::Response.new OriginClass, @search
+
+      assert_not_empty response.suggestions
+      assert_equal [ 'Foo', 'Bar' ], response.suggestions.terms
+    end
+
+    should "return empty array as suggest terms when there are no suggestions" do
+      @search.expects(:execute!).returns({})
+      response = Elasticsearch::Model::Response::Response.new OriginClass, @search
+
+      assert_empty response.suggestions
+      assert_equal [], response.suggestions.terms
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-model
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -70,16 +70,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: elasticsearch-extensions
   requirement: !ruby/object:Gem::Requirement
@@ -364,6 +364,7 @@ files:
 - lib/elasticsearch/model/response/records.rb
 - lib/elasticsearch/model/response/result.rb
 - lib/elasticsearch/model/response/results.rb
+- lib/elasticsearch/model/response/suggestions.rb
 - lib/elasticsearch/model/searching.rb
 - lib/elasticsearch/model/serializing.rb
 - lib/elasticsearch/model/version.rb