ripple 0.9.5 → 1.0.0.beta

data/lib/ripple/conflict/document_hooks.rb

@@ -0,0 +1,20 @@
+module Ripple
+  module Conflict
+    module DocumentHooks
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        attr_reader :on_conflict_block
+
+        def on_conflict(*expected_conflicts, &block)
+          @expected_conflicts = expected_conflicts
+          @on_conflict_block = block
+        end
+
+        def expected_conflicts
+          @expected_conflicts ||= []
+        end
+      end
+    end
+  end
+end

data/lib/ripple/conflict/resolver.rb

@@ -0,0 +1,71 @@
+require 'ripple/conflict/basic_resolver'
+
+module Ripple
+  module Conflict
+    class Resolver
+      include Translation
+
+      attr_reader :document, :model_class
+
+      delegate :expected_conflicts, :on_conflict_block, :to => :model_class
+
+      def self.to_proc
+        @to_proc ||= lambda do |robject|
+          possible_model_classes = robject.siblings.map { |s| s.data['_type'] }.uniq
+          return nil unless possible_model_classes.size == 1
+
+          resolver = new(robject, possible_model_classes.first.constantize)
+          resolver.resolve
+          resolver.document.robject
+        end
+      end
+
+      Riak::RObject.on_conflict(&self)
+
+      def initialize(robject, model_class)
+        @robject = robject
+        @model_class = model_class
+      end
+
+      def resolve
+        assert_conflict_block
+        basic_resolver.perform
+        assert_no_unexpected_conflicts
+        document.instance_exec(siblings, basic_resolver.remaining_conflicts, &on_conflict_block)
+        document.update_robject
+      end
+
+      def siblings
+        @siblings ||= @robject.siblings.map { |s| @model_class.send(:instantiate, s) }
+      end
+
+      def document
+        # pick a sibling robject to use as the basis of the document to resolve
+        # which one doesn't really matter.
+        @document ||= @model_class.send(:instantiate, @robject.siblings.first.dup)
+      end
+
+      private
+
+      def basic_resolver
+        @basic_resolver ||= BasicResolver.new(self)
+      end
+
+      def assert_conflict_block
+        return if on_conflict_block
+
+        raise NotImplementedError, t('conflict_handler_not_implemented', :document => document)
+      end
+
+      def assert_no_unexpected_conflicts
+        return unless basic_resolver.unexpected_conflicts.any?
+
+        raise NotImplementedError, t('unexpected_conflicts',
+          :conflicts => basic_resolver.unexpected_conflicts.inspect,
+          :document  => document.inspect
+        )
+      end
+    end
+  end
+end
+

data/lib/ripple/conflict/test_helper.rb

@@ -0,0 +1,33 @@
+module Ripple
+  module Conflict
+    module TestHelper
+      def create_conflict(main_record, *modifiers)
+        # We have to disable all on conflict resolvers while we create conflict
+        # so that they don't auto-resolve it.
+        orig_hooks = Riak::RObject.on_conflict_hooks.dup
+        Riak::RObject.on_conflict_hooks.clear
+
+        begin
+          klass, key = main_record.class, main_record.key
+          records = modifiers.map { |_| klass.find!(key) }
+
+          records.zip(modifiers).each do |(record, modifier)|
+            # necessary to get conflict, so riak thinks they are being saved by different clients
+            Ripple.client.client_id += 1
+
+            modifier.call(record)
+            record.save!
+          end
+
+          robject = klass.bucket.get(key)
+          raise "#{robject} is not in conflict as expected." unless robject.conflict?
+        ensure
+          orig_hooks.each do |hook|
+            Riak::RObject.on_conflict(&hook)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/ripple/conversion.rb

@@ -1,17 +1,3 @@
-# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-
 require 'active_model/conversion'
 
 module Ripple

data/lib/ripple/core_ext.rb

@@ -1,15 +1,2 @@
-# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-
 require 'ripple/core_ext/casting'
+require 'ripple/core_ext/object'

data/lib/ripple/core_ext/casting.rb

@@ -1,17 +1,4 @@
-# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-
+require 'tzinfo'
 require 'active_support/json'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/object/to_json'
@@ -23,6 +10,7 @@ require 'active_support/core_ext/time/conversions'
 require 'active_support/core_ext/time/zones'
 require 'active_support/core_ext/string/conversions'
 require 'ripple/property_type_mismatch'
+require 'set'
 
 # @private
 class Object
@@ -74,8 +62,8 @@ class String
   end
 end
 
-boolean_cast = proc do
-  def self.ripple_cast(value)
+BooleanCast = Module.new do
+  def ripple_cast(value)
     case value
     when NilClass
       nil
@@ -98,9 +86,9 @@ unless defined?(::Boolean)
   module ::Boolean; end
 end
 
-::Boolean.module_eval(&boolean_cast)
-TrueClass.module_eval(&boolean_cast)
-FalseClass.module_eval(&boolean_cast)
+::Boolean.send(:extend, BooleanCast)
+TrueClass.send(:extend, BooleanCast)
+FalseClass.send(:extend, BooleanCast)
 
 # @private
 class Time
@@ -147,3 +135,15 @@ module ActiveSupport
   end
 end
 
+# @private
+class Set
+  def as_json(options = {})
+    map { |e| e.as_json(options) }
+  end
+
+  def self.ripple_cast(value)
+    return nil if value.nil?
+    value.is_a?(Enumerable) && new(value) or raise Ripple::PropertyTypeMismatch.new(self, value)
+  end
+end
+

data/lib/ripple/core_ext/object.rb

@@ -0,0 +1,8 @@
+unless respond_to?(:define_singleton_method)
+  class Object
+    def define_singleton_method(name, &block)
+      singleton_class = class << self; self; end
+      singleton_class.send(:define_method, name, &block)
+    end
+  end
+end

data/lib/ripple/document.rb

@@ -1,23 +1,11 @@
-# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-
 require 'active_support/concern'
 require 'active_model/naming'
+require 'ripple/conflict/document_hooks'
 require 'ripple/document/bucket_access'
 require 'ripple/document/key'
 require 'ripple/document/persistence'
 require 'ripple/document/finders'
+require 'ripple/document/link'
 require 'ripple/properties'
 require 'ripple/attribute_methods'
 require 'ripple/timestamps'
@@ -64,6 +52,7 @@ module Ripple
       include Ripple::Document::Key
       include Ripple::Document::Persistence
       extend Ripple::Properties
+      include Ripple::Document::Finders
       include Ripple::AttributeMethods
       include Ripple::Timestamps
       include Ripple::Validations
@@ -71,10 +60,10 @@ module Ripple
       include Ripple::Callbacks
       include Ripple::Observable
       include Ripple::Conversion
-      include Ripple::Document::Finders
       include Ripple::Inspection
       include Ripple::NestedAttributes
       include Ripple::Serialization
+      include Ripple::Conflict::DocumentHooks
     end
 
     module ClassMethods
@@ -92,7 +81,23 @@ module Ripple
       def ==(comparison_object)
         comparison_object.equal?(self) ||
           (comparison_object.class < Document && (comparison_object.instance_of?(self.class) || comparison_object.class.bucket.name == self.class.bucket.name) &&
-           comparison_object.key == key && !comparison_object.new?)
+           !new? && comparison_object.key == key && !comparison_object.new?)
+      end
+
+      def eql?(other)
+        return true if other.equal?(self)
+
+        (other.class.equal?(self.class)) &&
+        !other.new? && !new? &&
+        (other.key == key)
+      end
+
+      def hash
+        if new?
+          super # every new document should be treated as a different doc
+        else
+          [self.class, key].hash
+        end
       end
     end
   end

data/lib/ripple/document/bucket_access.rb

@@ -1,17 +1,3 @@
-# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-
 require 'ripple'
 
 module Ripple

data/lib/ripple/document/finders.rb

@@ -1,22 +1,9 @@
-# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-
 require 'ripple/translation'
 require 'active_support/concern'
 require 'active_support/inflector'
 require 'active_support/core_ext/hash/except'
 require 'active_support/core_ext/hash/slice'
+require 'ripple/conflict/resolver'
 
 module Ripple
 
@@ -60,10 +47,14 @@ module Ripple
         #   @param [Array<String>] keylist an array of keys to find
         #   @return [Array<Document>] a list of found documents, including nil for missing documents
         def find(*args)
-          args.flatten!
-          return nil if args.empty? || args.all?(&:blank?)
-          return find_one(args.first) if args.size == 1
-          args.map {|key| find_one(key) }
+          if args.first.is_a?(Array)
+            args.flatten.map {|key| find_one(key) }
+          else
+            args.flatten!
+            return nil if args.empty? || args.all?(&:blank?)
+            return find_one(args.first) if args.size == 1
+            args.map {|key| find_one(key) }
+          end
         end
 
         # Retrieve single or multiple documents from Riak
@@ -90,15 +81,17 @@ module Ripple
         end
 
         # Find all documents in the Document's bucket and return them.
-        # @overload all()
+        # @overload list()
         #   Get all documents and return them in an array.
         #   @param [Hash] options options to be passed to the
         #     underlying {Bucket#keys} method.
         #   @return [Array<Document>] all found documents in the bucket
-        # @overload all() {|doc| ... }
+        # @overload list() {|doc| ... }
         #   Stream all documents in the bucket through the block.
         #   @yield [Document] doc a found document
-        def all(options={})
+        # @note This operation is incredibly expensive and should not
+        #     be used in production applications.
+        def list
           if block_given?
             bucket.keys do |keys|
               keys.each do |key|
@@ -108,7 +101,7 @@ module Ripple
             end
             []
           else
-            bucket.keys(options).inject([]) do |acc, k|
+            bucket.keys.inject([]) do |acc, k|
               obj = find_one(k)
               obj ? acc << obj : acc
             end
@@ -126,9 +119,10 @@ module Ripple
           klass = robject.data['_type'].constantize rescue self
           klass.new.tap do |doc|
             doc.key = robject.key
-            doc.__send__(:attributes=, robject.data.except("_type"), false) if robject.data
+            doc.__send__(:raw_attributes=, robject.data.except("_type")) if robject.data
             doc.instance_variable_set(:@new, false)
             doc.instance_variable_set(:@robject, robject)
+            doc.changed_attributes.clear
           end
         end
       end

data/lib/ripple/document/key.rb

@@ -1,17 +1,3 @@
-# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-
 require 'active_support/concern'
 
 module Ripple
@@ -23,26 +9,20 @@ module Ripple
         # Defines the key to be derived from a property.
         # @param [String,Symbol] prop the property to derive the key from
         def key_on(prop)
-          class_eval <<-CODE
-          def key
-            #{prop}.to_s
-          end
-          def key=(value)
-            self.#{prop} = value
-          end
-          def key_attr
-            :#{prop}
-          end          
-          CODE
+          prop = prop.to_sym
+
+          define_method(:key) { send(prop).to_s }
+          define_method(:key=) { |v| send(:"#{prop}=", v) }
+          define_method(:key_attr) { prop }
         end
       end
-      
+
       module InstanceMethods
         # Reads the key for this Document.
         def key
           @key
         end
-        
+
         # Sets the key for this Document.
         def key=(value)
           @key = value.to_s
@@ -50,7 +30,7 @@ module Ripple
 
         def key_attr
           :key
-        end        
+        end
       end
     end
   end