elasticsearch-persistence 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55426b2295af55ae3c3c5e22b5db473b208b74a0
-  data.tar.gz: 86391c93cbec7a02acc48ddd1f42f01b48dff606
+  metadata.gz: 0e68271351dc49665d55b42ef03261773e0e0487
+  data.tar.gz: 0062f28b76d0d5e73484b10ba4480e74b576efe4
 SHA512:
-  metadata.gz: 6a628a20d7500464ad4e810ef22269152a301a31508a6b0df11b22e0fdd7a67ce0607f58a675ccafaa9bdb04748d2aae829e9aeba2bae626c643a1cccf23f76d
-  data.tar.gz: 632053ca6192adbbaac8b2e6565043d658bf66a659db9fbf4341dbc89907a2526cc477493f1d324b33c9857ddd02e7e646ab566b07e1cbc5345ee00d1eda42c3
+  metadata.gz: 1610448416e545c6dc7ed1ce18760833fd0f48e3452ea9887762b303896c3dd7cd8ca28e71cff25ed9a9a6062d063944ecc06f8f7cd7483819a05665f7c06553
+  data.tar.gz: 02df7217562efa1277489e1e8878fff983f509f5351d0533d2231154bc556829063a4e8369afddc0c3b722f505e46d59108f3220c1c49c83eb058ef89ab0d291

data/CHANGELOG.md

@@ -1,4 +1,16 @@
-# 0.1.7
+## 0.1.8
+
+* Added `cluster.health wait_for_status: 'yellow'` to Repository integration test
+* Fixed tests for the updates to the `update` method for Persistence::Model
+* Fixed timestamp tests
+* Fixed typos and broken links in documentation, fixed examples
+* Fixed, that `MyModel#save` does in fact persist `updated_at` attribute
+* Fixed, that `options` have not been passed to gateway in MyModel#update
+* Short-circuit the operation and return `false` when the model is not valid
+* Fixed the problem where `document_type` configuration was not propagated to mapping
+
+
+## 0.1.7
 
 * Added an integration test for the `MyModel.all` method
 * Improved the "music" example application

data/README.md

@@ -23,12 +23,18 @@ or install it from a source code checkout:
 
 ## Usage
 
+The library provides two different patterns for adding persistence to your Ruby objects:
+
+* [Repository Pattern](#the-repository-pattern)
+* [ActiveRecord Pattern](#the-activerecord-pattern)
+
 ### The Repository Pattern
 
 The `Elasticsearch::Persistence::Repository` module provides an implementation of the
 [repository pattern](http://martinfowler.com/eaaCatalog/repository.html) and allows
 to save, delete, find and search objects stored in Elasticsearch, as well as configure
-mappings and settings for the index.
+mappings and settings for the index. It's an unobtrusive and decoupled way of adding
+persistence to your Ruby objects.
 
 Let's have a simple plain old Ruby object (PORO):
 
@@ -92,7 +98,7 @@ repository.delete(note)
 => {"found"=>true, "_index"=>"repository", "_type"=>"note", "_id"=>"1", "_version"=>2}
 ```
 
-The repository module provides a number of features and facilities to configure and customize the behaviour:
+The repository module provides a number of features and facilities to configure and customize the behavior:
 
 * Configuring the Elasticsearch [client](https://github.com/elasticsearch/elasticsearch-ruby#usage) being used
 * Setting the index name, document type, and object class for deserialization
@@ -120,7 +126,7 @@ repository = Elasticsearch::Persistence::Repository.new do
   # Set a custom document type
   type  :my_note
 
-  # Specify the class to inicialize when deserializing documents
+  # Specify the class to initialize when deserializing documents
   klass Note
 
   # Configure the settings and mappings for the Elasticsearch index
@@ -488,7 +494,7 @@ class Article
 
   # Execute code after saving the model.
   #
-  after_save { puts "Successfuly saved: #{self}" }
+  after_save { puts "Successfully saved: #{self}" }
 end
 ```
 
@@ -567,7 +573,7 @@ Any callbacks defined in the model will be triggered during the persistence oper
 
 ```ruby
 article.save
-# Successfuly saved: #<Article {...}>
+# Successfully saved: #<Article {...}>
 ```
 
 The model also supports familiar `find_in_batches` and `find_each` methods to efficiently

data/examples/music/album.rb

@@ -22,7 +22,6 @@ class Album
   attribute :label, Hash, mapping: { type: 'object' }
 
   attribute :title
-  attribute :suggest_title, String, default: {}, mapping: { type: 'completion', payloads: true }
   attribute :released, Date
   attribute :notes
   attribute :uri

data/lib/elasticsearch/persistence/model.rb

@@ -71,7 +71,6 @@ module Elasticsearch
             delegate :settings,
                      :mappings,
                      :mapping,
-                     :document_type,
                      :document_type=,
                      :index_name,
                      :index_name=,
@@ -80,6 +79,13 @@ module Elasticsearch
                      :create_index!,
                      :refresh_index!,
               to: :gateway
+
+            # forward document type to mappings when set
+            def document_type(type = nil)
+              return gateway.document_type unless type
+              gateway.document_type type
+              mapping.type = type
+            end
           end
 
           # Configure the repository based on the model (set up index_name, etc)
@@ -115,8 +121,8 @@ module Elasticsearch
 
           # Set up common attributes
           #
-          attribute :created_at, DateTime, default: lambda { |o,a| Time.now.utc }
-          attribute :updated_at, DateTime, default: lambda { |o,a| Time.now.utc }
+          attribute :created_at, Time, default: lambda { |o,a| Time.now.utc }
+          attribute :updated_at, Time, default: lambda { |o,a| Time.now.utc }
 
           attr_reader :hit
         end

data/lib/elasticsearch/persistence/model/rails.rb

@@ -13,7 +13,7 @@ module Elasticsearch
             end
 
             def update(attributes={}, options={})
-              super(__convert_rails_dates(attributes))
+              super(__convert_rails_dates(attributes), options)
             end
           end
         end

data/lib/elasticsearch/persistence/model/store.rb

@@ -53,10 +53,10 @@ module Elasticsearch
               options.update index: self._index if self._index
               options.update type:  self._type  if self._type
 
-              response = self.class.gateway.save(self, options)
-
               self[:updated_at] = Time.now.utc
 
+              response = self.class.gateway.save(self, options)
+
               @_id       = response['_id']
               @_index    = response['_index']
               @_type     = response['_type']
@@ -99,9 +99,22 @@ module Elasticsearch
           #     p.update name: 'UPDATED'
           #     => {"_index"=>"people", ... "_version"=>2}
           #
+          # @example Pass a version for concurrency control
+          #
+          #     p.update( { name: 'UPDATED' }, { version: 2 } )
+          #     => {"_index"=>"people", ... "_version"=>3}
+          #
+          # @example An exception is raised when the version doesn't match
+          #
+          #     p.update( { name: 'UPDATED' }, { version: 2 } )
+          #     => Elasticsearch::Transport::Transport::Errors::Conflict: [409] {"error" ... }
+          #
           # @return [Hash] The Elasticsearch response as a Hash
           #
           def update(attributes={}, options={})
+            unless options.delete(:validate) == false
+              return false unless valid?
+            end
             raise DocumentNotPersisted, "Object not persisted: #{self.inspect}" unless persisted?
 
             run_callbacks :update do
@@ -109,7 +122,6 @@ module Elasticsearch
               options.update type:  self._type  if self._type
 
               attributes.update( { updated_at: Time.now.utc } )
-
               response = self.class.gateway.update(self.id, { doc: attributes}.merge(options))
 
               self.attributes = self.attributes.merge(attributes)

data/lib/elasticsearch/persistence/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Persistence
-    VERSION = "0.1.7"
+    VERSION = "0.1.8"
   end
 end

data/test/integration/model/model_basic_test.rb

@@ -12,6 +12,7 @@ module Elasticsearch
         include Elasticsearch::Persistence::Model::Rails
 
         settings index: { number_of_shards: 1 }
+        document_type 'human_being'
 
         attribute :name, String,
                   mapping: { fields: {
@@ -60,7 +61,7 @@ module Elasticsearch
           assert_equal 'John Smith', document.name
           assert_equal 'John Smith', Person.find(person.id).name
 
-          assert_not_nil Elasticsearch::Persistence.client.get index: 'people', type: 'person', id: person.id
+          assert_not_nil Elasticsearch::Persistence.client.get index: 'people', type: 'human_being', id: person.id
         end
 
         should "not save an invalid object" do
@@ -143,6 +144,30 @@ module Elasticsearch
           assert found.updated_at > updated_at, [found.updated_at, updated_at].inspect
         end
 
+        should 'update the object timestamp on save' do
+          person = Person.create name: 'John Smith'
+          person.admin = true
+          sleep 1
+          person.save
+
+          Person.gateway.refresh_index!
+
+          found = Person.find(person.id)
+
+          # Compare without milliseconds
+          assert_equal person.updated_at.to_i, found.updated_at.to_i
+        end
+
+        should "respect the version" do
+          person = Person.create name: 'John Smith'
+
+          person.update( { name: 'UPDATE 1' })
+
+          assert_raise Elasticsearch::Transport::Transport::Errors::Conflict do
+            person.update( { name: 'UPDATE 2' }, { version: 1 } )
+          end
+        end
+
         should "find all instances" do
           Person.create name: 'John Smith'
           Person.create name: 'Mary Smith'

data/test/integration/repository/default_class_test.rb

@@ -73,6 +73,8 @@ module Elasticsearch
           note = Note.new(id: '1', title: 'Test')
           @repository.save note, routing: 'ABC'
 
+          @repository.client.cluster.health level: 'indices', wait_for_status: 'yellow'
+
           assert_raise Elasticsearch::Persistence::Repository::DocumentNotFound do
             @repository.find(1, routing: 'DEF')
           end

data/test/unit/model_base_test.rb

@@ -20,29 +20,53 @@ class Elasticsearch::Persistence::ModelBaseTest < Test::Unit::TestCase
     end
 
     should "set the ID from attributes during initialization" do
-      m = DummyBaseModel.new id: 1
-      assert_equal 1, m.id
+      model = DummyBaseModel.new id: 1
+      assert_equal 1, model.id
 
-      m = DummyBaseModel.new 'id' => 2
-      assert_equal 2, m.id
+      model = DummyBaseModel.new 'id' => 2
+      assert_equal 2, model.id
     end
 
     should "set the ID using setter method" do
-      m = DummyBaseModel.new id: 1
-      assert_equal 1, m.id
+      model = DummyBaseModel.new id: 1
+      assert_equal 1, model.id
 
-      m.id = 2
-      assert_equal 2, m.id
+      model.id = 2
+      assert_equal 2, model.id
     end
 
     should "have ID in attributes" do
-      m = DummyBaseModel.new id: 1, name: 'Test'
-      assert_equal 1, m.attributes[:id]
+      model = DummyBaseModel.new id: 1, name: 'Test'
+      assert_equal 1, model.attributes[:id]
     end
 
     should "have the customized inspect method" do
-      m = DummyBaseModel.new name: 'Test'
-      assert_match /name\: "Test"/, m.inspect
+      model = DummyBaseModel.new name: 'Test'
+      assert_match /name\: "Test"/, model.inspect
+    end
+
+    context "with custom document_type" do
+      setup do
+        @model = DummyBaseModel
+        @gateway = mock()
+        @mapping = mock()
+        @model.stubs(:gateway).returns(@gateway)
+        @gateway.stubs(:mapping).returns(@mapping)
+        @document_type = 'dummybase'
+      end
+
+      should "forward the argument to mapping" do
+        @gateway.expects(:document_type).with(@document_type).once
+        @mapping.expects(:type=).with(@document_type).once
+        @model.document_type @document_type
+      end
+
+      should "return the value from the gateway" do
+        @gateway.expects(:document_type).once.returns(@document_type)
+        @mapping.expects(:type=).never
+        returned_type = @model.document_type
+        assert_equal @document_type, returned_type
+      end
     end
   end
 end

data/test/unit/model_rails_test.rb

@@ -91,5 +91,22 @@ class Elasticsearch::Persistence::ModelRailsTest < Test::Unit::TestCase
       assert_equal "2014-01-01", m.published_on.iso8601
     end
 
+    context "when updating," do
+      should "pass the options to gateway" do
+        model = MyRailsModel.new name: 'Test'
+        model.stubs(:persisted?).returns(true)
+
+        model.class.gateway
+          .expects(:update)
+          .with do |object, options|
+            assert_equal 'ABC', options[:routing]
+            true
+          end
+          .returns({'_id' => 'abc123'})
+
+        assert model.update( { title: 'UPDATED' }, { routing: 'ABC' } )
+      end
+    end
+
   end
 end

data/test/unit/model_store_test.rb

@@ -311,6 +311,40 @@ class Elasticsearch::Persistence::ModelStoreTest < Test::Unit::TestCase
         assert subject.update( {}, { script: 'EXEC' } )
       end
 
+      should "not update an invalid model" do
+        @gateway
+          .expects(:update)
+          .never
+
+        subject.instance_eval do
+          def valid?; false; end;
+        end
+
+        assert ! subject.update(title: 'INVALID')
+      end
+
+      should "skip the validation with the :validate option" do
+        subject.expects(:persisted?).returns(true).at_least_once
+        subject.expects(:id).returns('abc123').at_least_once
+
+        @gateway
+          .expects(:update)
+          .with do |object, options|
+            assert_equal 'abc123', object
+            assert_equal nil, options[:id]
+            assert_equal 'INVALID', options[:doc][:title]
+            true
+          end
+          .returns({'_id' => 'abc123'})
+
+        subject.instance_eval do
+          def valid?; false; end;
+        end
+
+        assert subject.update( { title: 'INVALID' }, { validate: false } )
+        assert subject.persisted?
+      end
+
       should "pass the options to gateway" do
         subject.expects(:persisted?).returns(true)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-persistence
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch