elasticsearch-model 0.1.0 → 0.1.1

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.1.1
+
+* Improved documentation and tests
+* Fixed Kaminari implementation bugs and inconsistencies
+
+## 0.1.0 (Initial Version)

data/README.md

@@ -76,10 +76,8 @@ module Searchable
     mapping do
       # ...
     end
-  end
 
-  module ClassMethods
-    def search(query)
+    def self.search(query)
       # ...
     end
   end
@@ -99,8 +97,8 @@ all its functionality. To prevent polluting your model namespace, this functiona
 available via the `__elasticsearch__` class and instance level proxy methods;
 see the `Elasticsearch::Model::Proxy` class documentation for technical information.
 
-The module will include important methods, such as `search`, into the includeing class or module
-only when they haven't been defined already. Following two calls are thus functionally equivalent:
+The module will include important methods, such as `search`, into the class or module only
+when they haven't been defined already. Following two calls are thus functionally equivalent:
 
 ```ruby
 Article.__elasticsearch__.search 'fox'

data/elasticsearch-model.gemspec

@@ -38,6 +38,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "kaminari"
   # NOTE: Do not add Mongoid here, keep only in 3/4 files
 
+  s.add_development_dependency "minitest", "~> 4.0"
   s.add_development_dependency "shoulda-context"
   s.add_development_dependency "mocha"
   s.add_development_dependency "turn"

data/examples/activerecord_associations.rb

@@ -68,6 +68,8 @@ end
 class Author < ActiveRecord::Base
   has_many :authorships
 
+  after_update { self.authorships.each(&:touch) }
+
   def full_name
     [first_name, last_name].compact.join(' ')
   end

data/lib/elasticsearch/model/indexing.rb

@@ -333,11 +333,17 @@ module Elasticsearch
         #
         def update_document(options={})
           if changed_attributes = self.instance_variable_get(:@__changed_attributes)
+            attributes = if respond_to?(:as_indexed_json)
+              changed_attributes.select { |k,v| self.as_indexed_json.keys.include? k }
+            else
+              changed_attributes
+            end
+
             client.update(
               { index: index_name,
                 type:  document_type,
                 id:    self.id,
-                body:  { doc: changed_attributes } }.merge(options)
+                body:  { doc: attributes } }.merge(options)
             )
           else
             index_document(options)

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

@@ -30,8 +30,12 @@ module Elasticsearch
                 @results  = nil
                 @records  = nil
                 @response = nil
-                self.search.definition.update size: klass.default_per_page,
-                                              from: klass.default_per_page * ([num.to_i, 1].max - 1)
+                @page     = [num.to_i, 1].max
+                @per_page ||= klass.default_per_page
+
+                self.search.definition.update size: @per_page,
+                                              from: @per_page * (@page - 1)
+
                 self
               end
             RUBY
@@ -41,12 +45,10 @@ module Elasticsearch
           #
           def limit_value
             case
-              when search.definition[:body] && search.definition[:body][:size]
-                search.definition[:body][:size]
               when search.definition[:size]
                 search.definition[:size]
               else
-                0
+                search.klass.default_per_page
             end
           end
 
@@ -54,8 +56,6 @@ module Elasticsearch
           #
           def offset_value
             case
-              when search.definition[:body] && search.definition[:body][:from]
-                search.definition[:body][:from]
               when search.definition[:from]
                 search.definition[:from]
               else
@@ -69,7 +69,10 @@ module Elasticsearch
             @results  = nil
             @records  = nil
             @response = nil
-            search.definition.update :size => value
+            @per_page = value
+
+            search.definition.update :size => @per_page
+            search.definition.update :from => @per_page * (@page - 1) if @page
             self
           end
 
@@ -79,6 +82,7 @@ module Elasticsearch
             @results  = nil
             @records  = nil
             @response = nil
+            @page     = nil
             search.definition.update :from => value
             self
           end

data/lib/elasticsearch/model/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Model
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/test/integration/active_record_custom_serialization_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Model
+    class ActiveRecordCustomSerializationTest < Elasticsearch::Test::IntegrationTestCase
+
+      class ::ArticleWithCustomSerialization < ActiveRecord::Base
+        include Elasticsearch::Model
+        include Elasticsearch::Model::Callbacks
+
+        mapping do
+          indexes :title
+        end
+
+        def as_indexed_json(options={})
+          as_json(options.merge root: false).slice('title')
+        end
+      end
+
+      context "ActiveRecord model with custom JSON serialization" do
+        setup do
+          ActiveRecord::Schema.define(:version => 1) do
+            create_table ArticleWithCustomSerialization.table_name do |t|
+              t.string   :title
+              t.string   :status
+            end
+          end
+
+          ArticleWithCustomSerialization.delete_all
+          ArticleWithCustomSerialization.__elasticsearch__.create_index! force: true
+        end
+
+        should "index only the title attribute when creating" do
+          ArticleWithCustomSerialization.create! title: 'Test', status: 'green'
+
+          a = ArticleWithCustomSerialization.__elasticsearch__.client.get \
+                index: 'article_with_custom_serializations',
+                type:  'article_with_custom_serialization',
+                id:    '1'
+
+          assert_equal( { 'title' => 'Test' }, a['_source'] )
+        end
+
+        should "index only the title attribute when updating" do
+          ArticleWithCustomSerialization.create! title: 'Test', status: 'green'
+
+          article = ArticleWithCustomSerialization.first
+          article.update_attributes title: 'UPDATED', status: 'red'
+
+          a = ArticleWithCustomSerialization.__elasticsearch__.client.get \
+                index: 'article_with_custom_serializations',
+                type:  'article_with_custom_serialization',
+                id:    '1'
+
+          assert_equal( { 'title' => 'UPDATED' }, a['_source'] )
+        end
+      end
+
+    end
+  end
+end

data/test/integration/active_record_import_test.rb

@@ -26,6 +26,7 @@ module Elasticsearch
 
           ImportArticle.delete_all
           ImportArticle.__elasticsearch__.create_index! force: true
+          ImportArticle.__elasticsearch__.client.cluster.health wait_for_status: 'yellow'
 
           100.times { |i| ImportArticle.create! title: "Test #{i}" }
         end

data/test/integration/active_record_pagination_test.rb

@@ -4,9 +4,11 @@ module Elasticsearch
   module Model
     class ActiveRecordPaginationTest < Elasticsearch::Test::IntegrationTestCase
 
-      class ::Article < ActiveRecord::Base
+      class ::ArticleForPagination < ActiveRecord::Base
         include Elasticsearch::Model
 
+        scope :published, -> { where(published: true) }
+
         settings index: { number_of_shards: 1, number_of_replicas: 0 } do
           mapping do
             indexes :title,      type: 'string', analyzer: 'snowball'
@@ -20,23 +22,26 @@ module Elasticsearch
       context "ActiveRecord pagination" do
         setup do
           ActiveRecord::Schema.define(:version => 1) do
-            create_table :articles do |t|
+            create_table ::ArticleForPagination.table_name do |t|
               t.string   :title
               t.datetime :created_at, :default => 'NOW()'
+              t.boolean  :published
             end
           end
 
-          Article.delete_all
-          Article.__elasticsearch__.create_index! force: true
+          ArticleForPagination.delete_all
+          ArticleForPagination.__elasticsearch__.create_index! force: true
 
-          68.times do |i| ::Article.create! title: "Test #{i}" end
+          68.times do |i|
+            ::ArticleForPagination.create! title: "Test #{i}", published: (i % 2 == 0)
+          end
 
-          Article.import
-          Article.__elasticsearch__.refresh_index!
+          ArticleForPagination.import
+          ArticleForPagination.__elasticsearch__.refresh_index!
         end
 
         should "be on the first page by default" do
-          records = Article.search('title:test').page(1).records
+          records = ArticleForPagination.search('title:test').page(1).records
 
           assert_equal 25, records.size
           assert_equal 1, records.current_page
@@ -50,7 +55,7 @@ module Elasticsearch
         end
 
         should "load next page" do
-          records = Article.search('title:test').page(2).records
+          records = ArticleForPagination.search('title:test').page(2).records
 
           assert_equal 25, records.size
           assert_equal 2, records.current_page
@@ -64,7 +69,7 @@ module Elasticsearch
         end
 
         should "load last page" do
-          records = Article.search('title:test').page(3).records
+          records = ArticleForPagination.search('title:test').page(3).records
 
           assert_equal 18, records.size
           assert_equal 3, records.current_page
@@ -78,7 +83,7 @@ module Elasticsearch
         end
 
         should "not load invalid page" do
-          records = Article.search('title:test').page(6).records
+          records = ArticleForPagination.search('title:test').page(6).records
 
           assert_equal 0, records.size
           assert_equal 6, records.current_page
@@ -91,16 +96,34 @@ module Elasticsearch
           assert   records.out_of_range?, "Should be out of range"
         end
 
+        should "be combined with scopes" do
+          records = ArticleForPagination.search('title:test').page(2).records.published
+          assert records.all? { |r| r.published? }
+          assert_equal 12, records.size
+        end
+
+        should "set the limit per request" do
+          records = ArticleForPagination.search('title:test').limit(50).page(2).records
+
+          assert_equal 18,  records.size
+          assert_equal 2,   records.current_page
+          assert_equal 1,   records.prev_page
+          assert_equal nil, records.next_page
+          assert_equal 2,   records.total_pages
+
+          assert records.last_page?, "Should be the last page"
+        end
+
         context "with specific model settings" do
           teardown do
-            Article.instance_variable_set(:@_default_per_page, nil)
+            ArticleForPagination.instance_variable_set(:@_default_per_page, nil)
           end
-        end
 
-        should "respect paginates_per" do
-          Article.paginates_per 50
+          should "respect paginates_per" do
+            ArticleForPagination.paginates_per 50
 
-          assert_equal 50, Article.search('*').page(1).records.size
+            assert_equal 50, ArticleForPagination.search('*').page(1).records.size
+          end
         end
       end
 

data/test/integration/mongoid_basic_test.rb

@@ -61,6 +61,7 @@ if ENV["MONGODB_AVAILABLE"]
             MongoidArticle.create! title: 'Coding'
 
             MongoidArticle.__elasticsearch__.refresh_index!
+            MongoidArticle.__elasticsearch__.client.cluster.health wait_for_status: 'yellow'
           end
 
           should "index and find a document" do
@@ -147,6 +148,7 @@ if ENV["MONGODB_AVAILABLE"]
               MongoidArticle.delete_all
               97.times { |i| MongoidArticle.create! title: "Test #{i}" }
               MongoidArticle.__elasticsearch__.create_index! force: true
+              MongoidArticle.__elasticsearch__.client.cluster.health wait_for_status: 'yellow'
             end
 
             should "import all the documents" do

data/test/unit/indexing_test.rb

@@ -129,6 +129,25 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
         end
       end
 
+      class ::DummyIndexingModelWithCallbacksAndCustomAsIndexedJson
+        extend  Elasticsearch::Model::Indexing::ClassMethods
+        include Elasticsearch::Model::Indexing::InstanceMethods
+
+        def self.before_save(&block)
+          (@callbacks ||= {})[block.hash] = block
+        end
+
+        def changed_attributes; [:foo, :bar]; end
+
+        def changes
+          {:foo => ['A', 'B'], :bar => ['C', 'D']}
+        end
+
+        def as_indexed_json(options={})
+          { :foo => 'B' }
+        end
+      end
+
       should "register before_save callback when included" do
         ::DummyIndexingModelWithCallbacks.expects(:before_save).returns(true)
         ::DummyIndexingModelWithCallbacks.__send__ :include, Elasticsearch::Model::Indexing::InstanceMethods
@@ -251,6 +270,25 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
 
         instance.update_document
       end
+
+      should "exclude attributes not contained in custom as_indexed_json during partial update" do
+        client   = mock('client')
+        instance = ::DummyIndexingModelWithCallbacksAndCustomAsIndexedJson.new
+
+        # Set the fake `changes` hash
+        instance.instance_variable_set(:@__changed_attributes, {foo: 'B', bar: 'D' })
+
+        client.expects(:update).with do |payload|
+          assert_equal({foo: 'B'}, payload[:body][:doc])
+        end
+
+        instance.expects(:client).returns(client)
+        instance.expects(:index_name).returns('foo')
+        instance.expects(:document_type).returns('bar')
+        instance.expects(:id).returns('1')
+
+        instance.update_document
+      end
     end
 
     context "Re-creating the index" do

data/test/unit/response_pagination_test.rb

@@ -13,7 +13,7 @@ class Elasticsearch::Model::ResponsePaginationTest < Test::Unit::TestCase
                  'hits' => { 'total' => 100, 'hits' => (1..100).to_a.map { |i| { _id: i } } } }
 
     setup do
-      @search    = Elasticsearch::Model::Searching::SearchRequest.new ModelClass, '*'
+      @search   = Elasticsearch::Model::Searching::SearchRequest.new ModelClass, '*'
       @response = Elasticsearch::Model::Response::Response.new ModelClass, @search, RESPONSE
       @response.klass.stubs(:client).returns mock('client')
     end
@@ -62,7 +62,7 @@ class Elasticsearch::Model::ResponsePaginationTest < Test::Unit::TestCase
 
     context "limit/offset readers" do
       should "return the default" do
-        assert_equal 0, @response.limit_value
+        assert_equal Kaminari.config.default_per_page, @response.limit_value
         assert_equal 0, @response.offset_value
       end
 
@@ -74,12 +74,13 @@ class Elasticsearch::Model::ResponsePaginationTest < Test::Unit::TestCase
         assert_equal 50, @response.offset_value
       end
 
-      should "return the value from body" do
-        search    = Elasticsearch::Model::Searching::SearchRequest.new ModelClass, { query: { match_all: {} }, from: 10, size: 50 }
+      should "ignore the value from request body" do
+        search    = Elasticsearch::Model::Searching::SearchRequest.new ModelClass,
+                    { query: { match_all: {} }, from: 333, size: 999 }
         @response = Elasticsearch::Model::Response::Response.new ModelClass, search, RESPONSE
 
-        assert_equal 50, @response.limit_value
-        assert_equal 10, @response.offset_value
+        assert_equal Kaminari.config.default_per_page, @response.limit_value
+        assert_equal 0, @response.offset_value
       end
     end
 
@@ -103,6 +104,33 @@ class Elasticsearch::Model::ResponsePaginationTest < Test::Unit::TestCase
       end
     end
 
+    context "with the page() and limit() methods" do
+      setup do
+        @response.records
+        @response.results
+      end
+
+      should "set the values" do
+        @response.page(3).limit(35)
+        assert_equal 35, @response.search.definition[:size]
+        assert_equal 70, @response.search.definition[:from]
+      end
+
+      should "set the values when limit is called first" do
+        @response.limit(35).page(3)
+        assert_equal 35, @response.search.definition[:size]
+        assert_equal 70, @response.search.definition[:from]
+      end
+
+      should "reset the instance variables" do
+        @response.page(3).limit(35)
+
+        assert_nil @response.instance_variable_get(:@response)
+        assert_nil @response.instance_variable_get(:@records)
+        assert_nil @response.instance_variable_get(:@results)
+      end
+    end
+
     context "offset setter" do
       setup do
         @response.records

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-model
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
+date: 2014-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -187,6 +187,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
@@ -373,6 +389,7 @@ extra_rdoc_files:
 - LICENSE.txt
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -411,6 +428,7 @@ files:
 - test/integration/active_record_associations_parent_child.rb
 - test/integration/active_record_associations_test.rb
 - test/integration/active_record_basic_test.rb
+- test/integration/active_record_custom_serialization_test.rb
 - test/integration/active_record_import_test.rb
 - test/integration/active_record_namespaced_model_test.rb
 - test/integration/active_record_pagination_test.rb
@@ -466,6 +484,7 @@ test_files:
 - test/integration/active_record_associations_parent_child.rb
 - test/integration/active_record_associations_test.rb
 - test/integration/active_record_basic_test.rb
+- test/integration/active_record_custom_serialization_test.rb
 - test/integration/active_record_import_test.rb
 - test/integration/active_record_namespaced_model_test.rb
 - test/integration/active_record_pagination_test.rb