[MODEL] Small tweaks to the update_document_attributes method implementation

Related: elastic#230

Author: karmi

elasticsearch-model/lib/elasticsearch/model/indexing.rb

@@ -317,6 +317,8 @@ def delete_document(options={})
         #
         # When the changed attributes are not available, performs full re-index of the record.
         #
+        # See the {#update_document_attributes} method for updating specific attributes directly.
+        #
         # @param options [Hash] Optional arguments for passing to the client
         #
         # @example Update a document corresponding to the record
@@ -352,21 +354,21 @@ def update_document(options={})
           end
         end
 
-        # Allows for partial update of a document by manually supplying the changes
+        # Perform a _partial_ update of specific document attributes
+        # (without consideration for changed attributes as in {#update_document})
         #
-        # @param attributes [Hash] Required attributes to be updated
-        # @param options [Hash] Optional arguments for passing to the client
+        # @param attributes [Hash] Attributes to be updated
+        # @param options    [Hash] Optional arguments for passing to the client
         #
-        # @example update just the title
+        # @example Update the `title` attribute
         #
         #     @article = Article.first
         #     @article.title = "New title"
-        #     @article.__elasticsearch__.update_document_attributes({title: "New title"})
+        #     @article.__elasticsearch__.update_document_attributes title: "New title"
         #
         # @return [Hash] The response from Elasticsearch
         #
-        #
-        def update_document_attributes(attributes,options={})
+        def update_document_attributes(attributes, options={})
           client.update(
             { index: index_name,
               type:  document_type,

elasticsearch-model/test/integration/active_record_basic_test.rb

@@ -128,14 +128,19 @@ class ::Article < ActiveRecord::Base
           assert_equal 1, response.records.size
         end
 
-         should "allow specific updates to be made to the document directly" do
+         should "update specific attributes" do
           article = Article.first
 
-          article.update_document_attributes({title: 'green grass'})
+          response = Article.search 'title:special'
+
+          assert_equal 0, response.results.size
+          assert_equal 0, response.records.size
+
+          article.__elasticsearch__.update_document_attributes title: 'special'
 
           Article.__elasticsearch__.refresh_index!
 
-          response = Article.search 'title:green'
+          response = Article.search 'title:special'
 
           assert_equal 1, response.results.size
           assert_equal 1, response.records.size

elasticsearch-model/test/unit/indexing_test.rb

@@ -324,44 +324,46 @@ def as_indexed_json(options={})
         instance.update_document
       end
 
-      should "have the update_document_attributes method" do
+      should "update only the specific attributes" do
         client   = mock('client')
         instance = ::DummyIndexingModelWithCallbacks.new
 
+        # Set the fake `changes` hash
+        instance.instance_variable_set(:@__changed_attributes, {author: 'john'})
+
         client.expects(:update).with do |payload|
           assert_equal 'foo',  payload[:index]
           assert_equal 'bar',  payload[:type]
           assert_equal '1',    payload[:id]
+          assert_equal({title: 'green'}, 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_attributes({})
+        instance.update_document_attributes title: "green"
       end
 
-      should "update only the supplied attributes" do
+      should "pass options to the update_document_attributes method" do
         client   = mock('client')
         instance = ::DummyIndexingModelWithCallbacks.new
 
-        # Set the fake `changes` hash
-        instance.instance_variable_set(:@__changed_attributes, {foo: 'bar'})
-
         client.expects(:update).with do |payload|
           assert_equal 'foo',  payload[:index]
           assert_equal 'bar',  payload[:type]
           assert_equal '1',    payload[:id]
           assert_equal({title: 'green'}, payload[:body][:doc])
+          assert_equal true,   payload[:refresh]
         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_attributes({title: "green"})
+        instance.update_document_attributes( { title: "green" }, { refresh: true } )
       end
     end