simply_stored 0.2.5 → 0.3.0

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 Changelog
 =============
 
+0.3.0
+=============
+
+- SimplyStored now automatically retries conflicted save operations if it is possible to resolve the conflict.
+  Solving the conflict means that if updated were done one different attributes the local object will 
+  refresh those attributes and try to save again. This will be tried two times by default. Afterwards the conflict
+  exception will be re-raised.
+  
+  This feature can be controlled on the class level like this: User.auto_conflict_resolution_on_save = true | false
 
 0.2.5
 =============

data/README.md

@@ -10,6 +10,8 @@ Both backends have also support for S3 attachments.
 See also [RockingChair](http://github.com/jweiss/rocking_chair) on how to speed-up your unit tests 
 by using an in-memory CouchDB backend.
 
+More examples on how to work with SimplyStored can be found [here](http://github.com/jweiss/simply_stored_examples)
+
 Installation
 ============
 
@@ -217,6 +219,37 @@ SimplyStored also has support for "soft deleting" - much like acts_as_paranoid.
     Document.find_all_by_title('secret project info', :with_deleted => true)
     # => [doc]
 
+CouchDB - Auto resolution of conflicts on save
+
+SimplyStored now by default retries conflicted save operations if it is possible to resolve the conflict.
+Solving the conflict means that if updated were done one different attributes the local object will 
+refresh those attributes and try to save again. This will be tried two times by default. Afterwards the conflict
+exception will be re-raised.
+  
+This feature can be controlled on the class level like this: 
+    User.auto_conflict_resolution_on_save = true | false
+    
+If auto_conflict_resolution_on_save is enabled, something like this will work:
+
+    class Document
+      include SimplyStored::Couch
+      
+      property :title
+      property :content
+    end
+    
+    original = Document.create(:title => 'version 1', :content => 'Hi there')
+    
+    other_client = Document.find(original.id)
+    
+    original.title = 'version 2'
+    original.save!
+    
+    other_client.content = 'A better version'
+    other_client.save!  # -> this line would fail without auto_conflict_resolution_on_save
+    
+    other_client.title 
+    # => 'version 2'
 
 License
 =============

data/lib/simply_stored/couch.rb

@@ -114,6 +114,14 @@ module SimplyStored
         !soft_delete_attribute.nil?
       end
       
+      def auto_conflict_resolution_on_save
+        @auto_conflict_resolution_on_save.nil? ? true : @auto_conflict_resolution_on_save
+      end
+      
+      def auto_conflict_resolution_on_save=(val)
+        @auto_conflict_resolution_on_save = val
+      end
+      
       def simpledb_string(*names)
         names.each do |name|
           property name

data/lib/simply_stored/instance_methods.rb

@@ -15,11 +15,15 @@ module SimplyStored
     end
 
     def save(validate = true)
-      CouchPotato.database.save_document(self, validate)
+      retry_on_conflict do
+        CouchPotato.database.save_document(self, validate)
+      end
     end
 
     def save!
-      CouchPotato.database.save_document!(self)
+      retry_on_conflict do
+        CouchPotato.database.save_document!(self)
+      end
     end
 
     def destroy(override_soft_delete=false)
@@ -64,6 +68,53 @@ module SimplyStored
     
     protected
     
+    def retry_on_conflict(max_retries = 2, &blk)
+      retry_count = 0
+      begin
+        blk.call
+      rescue RestClient::Conflict => e
+        if self.class.auto_conflict_resolution_on_save && retry_count < max_retries && try_to_merge_conflict
+          retry_count += 1
+          retry
+        else
+          raise e
+        end
+      end
+    end
+    
+    def try_to_merge_conflict
+      original = self.class.find(id)
+      our_attributes = self.attributes.dup
+      their_attributes = original.attributes.dup
+      [:updated_at, :created_at, :id, :rev, :_id, :_rev].each do |skipped_attribute|
+        our_attributes.delete(skipped_attribute)
+        their_attributes.delete(skipped_attribute)
+      end
+      if _merge_possible?(our_attributes, their_attributes)
+        _copy_non_conflicting_attributes(our_attributes, their_attributes)
+        self._rev = original._rev
+        true
+      else
+        false
+      end
+    end
+    
+    def _copy_non_conflicting_attributes(our_attributes, their_attributes)
+      their_attributes.each do |attr_name, their_value|
+        if !self.send("#{attr_name}_changed?") && our_attributes[attr_name] != their_value
+          self.send("#{attr_name}=", their_value)
+        end
+      end
+    end
+    
+    def _merge_possible?(our_attributes, their_attributes)
+      their_attributes.all? do |attr_name, their_value|
+        our_attributes[attr_name] == their_value || # same
+        !self.send("#{attr_name}_changed?") || # we didn't change
+        self.send("#{attr_name}_changed?") && their_value == self.send("#{attr_name}_was") # we changed and they kept the original
+      end
+    end
+    
     def reset_association_caches
       self.class.properties.each do |property|
         if property.respond_to?(:association?) && property.association?

data/test/simply_stored_couch_test.rb

@@ -1938,7 +1938,6 @@ class CouchTest < Test::Unit::TestCase
       
       context "when counting" do
         setup do
-          recreate_db
           @hemorrhoid = Hemorrhoid.create(:nickname => 'Claas')
           assert @hemorrhoid.destroy
           assert @hemorrhoid.reload.deleted?
@@ -1973,5 +1972,96 @@ class CouchTest < Test::Unit::TestCase
 
     end
     
+    context "when handling conflicts" do
+      setup do
+        @original = User.create(:name => 'Mickey Mouse', :title => "Dr.", :homepage => 'www.gmx.de')
+        @copy = User.find(@original.id)
+        User.auto_conflict_resolution_on_save = true
+      end
+      
+      should "be able to save without modifications" do
+        assert @copy.save
+      end
+      
+      should "be able to save when modification happen on different attributes" do
+        @original.name = "Pluto"
+        assert @original.save
+        
+        @copy.title = 'Prof.'
+        assert_nothing_raised do
+          assert @copy.save
+        end
+        
+        assert_equal "Pluto", @copy.reload.name
+        assert_equal "Prof.", @copy.reload.title
+        assert_equal "www.gmx.de", @copy.reload.homepage
+      end
+      
+      should "be able to save when modification happen on different, multiple attributes - remote" do
+        @original.name = "Pluto"
+        @original.homepage = 'www.google.com'
+        assert @original.save
+        
+        @copy.title = 'Prof.'
+        assert_nothing_raised do
+          assert @copy.save
+        end
+        
+        assert_equal "Pluto", @copy.reload.name
+        assert_equal "Prof.", @copy.reload.title
+        assert_equal "www.google.com", @copy.reload.homepage
+      end
+      
+      should "be able to save when modification happen on different, multiple attributes locally" do
+        @original.name = "Pluto"
+        assert @original.save
+        
+        @copy.title = 'Prof.'
+        @copy.homepage = 'www.google.com'
+        assert_nothing_raised do
+          assert @copy.save
+        end
+        
+        assert_equal "Pluto", @copy.reload.name
+        assert_equal "Prof.", @copy.reload.title
+        assert_equal "www.google.com", @copy.reload.homepage
+      end
+      
+      should "re-raise the conflict if there is no merge possible" do
+        @original.name = "Pluto"
+        assert @original.save
+        
+        @copy.name = 'Prof.'
+        assert_raise(RestClient::Conflict) do
+          assert @copy.save
+        end
+        
+        assert_equal "Prof.", @copy.name
+        assert_equal "Pluto", @copy.reload.name
+      end
+      
+      should "re-raise the conflict if retried several times" do
+        exception = RestClient::Conflict.new
+        CouchPotato.database.expects(:save_document).raises(exception).times(3)
+        
+        @copy.name = 'Prof.'
+        assert_raise(RestClient::Conflict) do
+          assert @copy.save
+        end
+      end
+      
+      should "not try to merge and re-save if auto_conflict_resolution_on_save is disabled" do
+        User.auto_conflict_resolution_on_save = false
+        exception = RestClient::Conflict.new
+        CouchPotato.database.expects(:save_document).raises(exception).times(1)
+        
+        @copy.name = 'Prof.'
+        assert_raise(RestClient::Conflict) do
+          assert @copy.save
+        end
+      end
+      
+    end
+    
   end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: simply_stored
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Mathias Meyer, Jonathan Weiss
@@ -9,39 +14,61 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-04 00:00:00 +01:00
+date: 2010-04-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: couch_potato
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 2
+        version: 1.4.2
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: couch_potato
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 15
         version: 0.2.15
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: validatable
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id004
 description: Convenience layer for CouchDB and SimpleDB. Requires CouchPotato and RightAWS library respectively.
 email: info@peritor.com
 executables: []
@@ -86,18 +113,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Convenience layer for CouchDB and SimpleDB