couchpillow 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccd762815a2494ec8a42b99e4d8feebf29d77fac
-  data.tar.gz: 9b0f6be497aa1a4cc2f0647ff0179953938a4be9
+  metadata.gz: 6c941b4db98918cd72e334fb39d97ce2bb6ea24b
+  data.tar.gz: 28babdcc130a232e33d10f72c8771291729b45ce
 SHA512:
-  metadata.gz: 8771a637242a813b851b683c96fd12b8064c923ec0aafa86a491e40bf3e4d383760e4f428e756ad7518840a2990f07f5b3ff55dc4b605d7475c3a1aa3ac2e9a8
-  data.tar.gz: b4dd50c6540f695ba3f04ecf73299ce0f517563ea9843b237dd4132c49ee8944c60c81ee305afac6d3a9c2351a65b4c40ebbabaf56b3e7179281902625c59996
+  metadata.gz: 5350184abf2713d2385ebb6c810047696fe38dc37a9ec2984777d8099ec342afc363ed0257e75933930dc6269b3a2f049a51a5a1420ce7dbaf6ee453758db808
+  data.tar.gz: d0428814d6e6811a16c43db27f096a55472f2c82b7fcb1e957f4f654e477033907af5a35bf9f72a30938183ff1e43999de52b1400c96be1a40c16b1091231f03

data/couchpillow.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '~> 2.0'
 
   s.add_runtime_dependency 'celluloid', '~> 0.16'
+  s.add_runtime_dependency 'couchbase', '~> 1.3'
 
   s.add_development_dependency 'minitest',  '~> 5.3'
   s.add_development_dependency 'mocha', '~> 1.1'

data/lib/couchpillow/document.rb

@@ -10,6 +10,10 @@ module CouchPillow
 
     DEFAULT_TYPE = "couchpillow".freeze
 
+    EVENTS = [ :cas_conflict ].freeze
+
+    CAS_CONFLICT_RETRY_COUNT = 5
+
 
     attribute :_created_at do
       required
@@ -26,8 +30,18 @@ module CouchPillow
     end
 
 
-    def initialize hash = {}, id = "#{self.class.doc_type}::#{SecureRandom.hex}"
+    # Constructor.
+    # @param hash The document
+    # @param id The id of the document
+    # @param cas CAS value of the document, from the CB client. Optional.
+    # @param flags Flags of the document, from the CB client. Optional.
+    #
+    def initialize hash = {},
+                   id = "#{self.class.doc_type}::#{SecureRandom.hex}",
+                   cas = nil
+
       @data = self.class.symbolize(hash)
+      @original = Marshal.load(Marshal.dump(@data))
 
       @id = id
       time = Time.now.utc
@@ -36,6 +50,8 @@ module CouchPillow
 
       @futures = []
 
+      @cas = cas
+
       rename!
       whitelist!
       assign_defaults!
@@ -56,25 +72,24 @@ module CouchPillow
     # Save this document to the server
     #
     def save! opts = {}
-      whitelist!
-      sort!
-      timestamp!
-      validate!
-      to_save = @data.merge({
-        :_type => self.class.doc_type
-      })
-
-      # write to all connections
-      result = self.class.default_db.set(@id, to_save, opts)
-
-      unless self.class.secondary_dbs.empty?
-        @futures << Celluloid::Future.new do
-          self.class.secondary_dbs.each do |db|
-            db.set(@id, to_save, opts)
-          end
-        end
+      result = nil
+
+      # write to the primary db first
+      result = cas_handler do
+        whitelist!
+        sort!
+        timestamp!
+        validate!
+        opts[:cas] = @cas
+        self.class.default_db.set(@id, to_save, opts)
       end
 
+      # write to the secondary only if the primary succeeds
+      # and ignore CAS for secondary DBs.
+      write_to_secondary_dbs do |db|
+        db.set @id, to_save
+      end if result
+
       result
     end
 
@@ -84,13 +99,10 @@ module CouchPillow
     def delete!
       result = self.class.default_db.delete @id
 
-      unless self.class.secondary_dbs.empty?
-        @futures << Celluloid::Future.new do
-          self.class.secondary_dbs.each do |db|
-            db.delete @id
-          end
-        end
-      end
+      # write to the secondary only if the primary succeeds
+      write_to_secondary_dbs do |db|
+        db.delete @id
+      end if result
 
       result
     end
@@ -99,25 +111,25 @@ module CouchPillow
     # Attempt to update this Document. Fails if this Document does not yet
     # exist in the database.
     #
-    def update!
-      whitelist!
-      sort!
-      timestamp!
-      validate!
-      to_save = @data.merge({
-        :_type => self.class.doc_type
-      })
-
-      result = self.class.default_db.replace @id, to_save
-
-      unless self.class.secondary_dbs.empty?
-        @futures << Celluloid::Future.new do
-          self.class.secondary_dbs.each do |db|
-            db.replace @id, to_save
-          end
-        end
+    def update! opts = {}
+
+      # write to the primary db first
+      result = cas_handler do
+        whitelist!
+        sort!
+        timestamp!
+        validate!
+        opts[:cas] = @cas
+        result = self.class.default_db.replace(@id, to_save, opts)
       end
 
+      # write to the secondary only if the primary succeeds
+      # and ignore CAS for secondary DBs.
+      opts.delete :cas
+      write_to_secondary_dbs do |db|
+        db.replace @id, to_save
+      end if result
+
       result
     end
 
@@ -244,10 +256,12 @@ module CouchPillow
     # @return nil if not found or Document is of a different type.
     #
     def self.get id
-      result = default_db.get(id) and
+      result, _, cas = default_db.get(id, extended: true)
+
+      result and
         type = result[:_type] || result["_type"] and
         type == doc_type and
-        new(result, id) or
+        new(result, id, cas) or
         nil
     end
 
@@ -290,6 +304,14 @@ module CouchPillow
     end
 
 
+    # Registers a listener on a specific event.
+    # See {EVENTS} constant for a list of accepted events.
+    #
+    def self.on event, &block
+      event_listeners[event] = block if EVENTS.include?(event)
+    end
+
+
     private
 
 
@@ -300,6 +322,59 @@ module CouchPillow
     end
 
 
+    def write_to_secondary_dbs &block
+      unless self.class.secondary_dbs.empty?
+        @futures << Celluloid::Future.new do
+          self.class.secondary_dbs.each do |db|
+            block.call(db)
+          end
+        end
+      end
+    end
+
+
+    def cas_handler &block
+      # write to the primary db first
+      rtcount = CAS_CONFLICT_RETRY_COUNT
+      begin
+        block.call
+
+      rescue ValidationError
+        raise
+
+      rescue Couchbase::Error::KeyExists
+        other_doc, _, newcas = self.class.default_db.get(@id, extended: true)
+        raise CASError, "There is a CAS conflict, but DB does not yield a document" unless other_doc
+        raise CASError, "There is a CAS conflict, but no :cas_conflict handler has been defined. See 'on' directive." unless self.class.event_listeners[:cas_conflict]
+
+        # resolve conflict
+        other_doc = self.class.symbolize(other_doc)
+        @data = self.class.event_listeners[:cas_conflict].call(@original, other_doc, to_save)
+        @cas = newcas
+
+        rtcount -= 1
+        raise CASError, "Exhausted retries" if rtcount == 0
+        retry
+
+      end
+    end
+
+
+    # Get the final hash that will be saved to the database.
+    # Check if data has been modified.
+    #
+    def to_save
+      hash = @data.hash
+      return @tos if @tos && @toshash && @toshash == hash
+
+      @tos = @data.merge({
+        :_type => self.class.doc_type
+      })
+      @toshash = @data.hash
+      @tos
+    end
+
+
     def self.doc_type
       @type ||= DEFAULT_TYPE
     end
@@ -320,6 +395,11 @@ module CouchPillow
     end
 
 
+    def self.event_listeners
+      @event_listeners ||= {}
+    end
+
+
     def self.symbolize hash
       hash.inject({}) do |memo,(k,v)|
         memo[k.to_sym] = v

data/lib/couchpillow/{validation_error.rb → errors.rb}

@@ -1,8 +1,9 @@
 module CouchPillow
 
-  # Validation Error.
-  #
   class ValidationError < StandardError
   end
 
+  class CASError < StandardError
+  end
+
 end

data/lib/couchpillow/version.rb

@@ -1,5 +1,5 @@
 module CouchPillow
   GEM_NAME = "couchpillow"
   NAME = "CouchPillow"
-  VERSION = "0.4.4"
+  VERSION = "0.4.5"
 end

data/lib/couchpillow.rb

@@ -2,6 +2,7 @@ require 'securerandom'
 require 'json'
 require 'time'
 require 'celluloid/autostart'
+require 'couchbase'
 
 module CouchPillow
 
@@ -19,7 +20,7 @@ end
 
 require 'couchpillow/attribute'
 require 'couchpillow/attributive'
-require 'couchpillow/validation_error'
+require 'couchpillow/errors'
 require 'couchpillow/boolean'
 require 'couchpillow/document'
 require 'couchpillow/version'

data/test/helper.rb

@@ -9,28 +9,34 @@ class FakeCouchbaseServer
 
   def initialize
     @storage = {}
+    @cas = {}
   end
 
 
   def set id, data, opts = {}
+    raise Couchbase::Error::KeyExists if @storage.has_key?(id) && opts[:cas] && @cas[id] != opts[:cas]
     @storage[id] = data
+    @cas[id] = SecureRandom.hex(8)
   end
 
 
   def delete id
     @storage.delete(id)
+    @cas.delete(id)
   end
 
 
-  def replace id, data
-    @storage.has_key?(id) or raise "Document does not exist"
+  def replace id, data, opts = {}
+    raise "Document does not exist" unless @storage.has_key?(id)
+    raise Couchbase::Error::KeyExists if @storage.has_key?(id) && opts[:cas] && @cas[id] != opts[:cas]
+
     @storage[id] = data
+    @cas[id] = SecureRandom.hex(8)
   end
 
 
-  def get id
+  def get id, opts = {}
+    return [@storage[id], nil, @cas[id]] if opts[:extended] == true
     @storage[id]
   end
 end
-
-

data/test/test_attribute.rb

@@ -118,5 +118,4 @@ class TestAttribute < Minitest::Test
     end
   end
 
-
 end

data/test/test_document.rb

@@ -209,7 +209,7 @@ class TestDocument < Minitest::Test
 
 
   def test_get_returns_nil
-    CouchPillow.db.expects(:get).with('123').returns(nil)
+    CouchPillow.db.expects(:get).with('123', { extended: true }).returns(nil)
     Document.expects(:default_db).returns(CouchPillow.db)
     d = Document.get('123')
     assert_equal nil, d
@@ -223,7 +223,7 @@ class TestDocument < Minitest::Test
 
     CouchPillow.db
       .expects(:get)
-      .with('123')
+      .with('123', { extended: true })
       .returns( { '_type' => 'something else', 'stuff' => 'data' } )
 
     d = klass.get('123')
@@ -486,4 +486,69 @@ class TestDocument < Minitest::Test
     assert_equal "hello", data[:foo]
   end
 
+
+  def test_cas_no_on_directive
+
+    klass = Class.new(Document) do
+      type 'test'
+
+      attribute :foo do
+        type String
+        auto_convert
+        required
+        default { "tester" }
+      end
+    end
+
+    d = klass.new( foo: "Hello" )
+    d.save!
+    doc_id = d.id
+
+    d1 = klass.get(doc_id)
+    d2 = klass.get(doc_id)
+    d2.foo = "Someone else"
+    d2.save!
+    assert_raises CouchPillow::CASError do
+      d1.save!
+    end
+  end
+
+
+  def test_cas_with_on_directive
+    # must declare it here so Ruby can see the assert_equal methods
+    cas_conflict_resolver = Proc.new do |original, theirs, mine|
+      assert_equal "Hello", original[:foo]
+      assert_equal "Someone else", theirs[:foo]
+      assert_equal "This is mine", mine[:foo]
+      mine
+    end
+
+    klass = Class.new(Document) do
+      type 'test'
+
+      attribute :foo do
+        type String
+        auto_convert
+        required
+        default { "tester" }
+      end
+
+      on :cas_conflict, &cas_conflict_resolver
+    end
+
+    d = klass.new( foo: "Hello" )
+    d.save!
+    doc_id = d.id
+
+    d1 = klass.get(doc_id)
+    d1.foo = "This is mine"
+    d2 = klass.get(doc_id)
+    d2.foo = "Someone else"
+    d2.save!
+    d1.save!
+
+    assert_equal "This is mine", klass.get(doc_id).foo
+  end
+
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: couchpillow
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Albert Tedja
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: couchbase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +96,7 @@ files:
 - lib/couchpillow/attributive.rb
 - lib/couchpillow/boolean.rb
 - lib/couchpillow/document.rb
-- lib/couchpillow/validation_error.rb
+- lib/couchpillow/errors.rb
 - lib/couchpillow/version.rb
 - test/helper.rb
 - test/test_attribute.rb