ripple 0.7.0 → 0.7.1

data/lib/ripple/callbacks.rb

@@ -0,0 +1,73 @@
+# 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
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    included do
+      extend ActiveModel::Callbacks
+      define_model_callbacks :create, :update, :save, :destroy
+      define_callbacks :validation, :terminator => "result == false", :scope => [:kind, :name]
+    end
+
+    module ClassMethods
+      def before_validation(*args, &block)
+        options = args.last
+        if options.is_a?(Hash) && options[:on]
+          options[:if] = Array(options[:if])
+          options[:if] << "@_on_validate == :#{options[:on]}"
+        end
+        set_callback(:validation, :before, *args, &block)
+      end
+
+      def after_validation(*args, &block)
+        options = args.extract_options!
+        options[:prepend] = true
+        options[:if] = Array(options[:if])
+        options[:if] << "!halted && value != false"
+        options[:if] << "@_on_validate == :#{options[:on]}" if options[:on]
+        set_callback(:validation, :after, *(args << options), &block)
+      end
+    end
+
+    module InstanceMethods
+      # @private
+      def save(*args, &block)
+        state = new? ? :create : :update
+        run_callbacks(:save) do
+          run_callbacks(state) do
+            super
+          end
+        end
+      end
+
+      # @private
+      def destroy(*args, &block)
+        run_callbacks(:destroy) do
+          super
+        end
+      end
+
+      # @private
+      def valid?(*args, &block)
+        @_on_validate = new? ? :create : :update
+        run_callbacks(:validation) do
+          super
+        end
+      end
+    end
+  end
+end

data/lib/ripple/{document/associations/one.rb → conversion.rb}

@@ -14,18 +14,23 @@
 require 'ripple'
 
 module Ripple
-  module Document
-    module Associations
-      module One
-        include Instantiators
-                
-        protected
-          def instantiate_target(instantiator, attrs={})
-            @target = klass.send(instantiator, attrs)
-            loaded
-            @target
-          end
-      end
+  module Conversion
+    include ActiveModel::Conversion
+
+    def new_record?
+      new?
+    end
+
+    def persisted?
+      !new?
+    end
+
+    def to_key
+      new? ? nil : [key]
+    end
+
+    def to_param
+      key
     end
   end
-end
+end

data/lib/ripple/document.rb

@@ -42,24 +42,34 @@ module Ripple
     extend ActiveSupport::Concern
     extend ActiveSupport::Autoload
 
-    autoload :Association, "ripple/document/associations"
-    autoload :Associations
-    autoload :AttributeMethods
     autoload :BucketAccess
-    autoload :Callbacks
     autoload :Finders
     autoload :Persistence
-    autoload :Properties
-    autoload :Property, "ripple/document/properties"
-    autoload :Timestamps
-    autoload :Validations
 
     included do
+      extend ActiveModel::Naming
       extend BucketAccess
       include Ripple::Document::Persistence
-      include Ripple::EmbeddedDocument
+      extend Ripple::Properties
+      include Ripple::AttributeMethods
+      include Ripple::Timestamps
+      include Ripple::Validations
+      include Ripple::Associations
+      include Ripple::Callbacks
+      include Ripple::Conversion
       include Ripple::Document::Finders
     end
 
+    module ClassMethods
+      def embeddable?
+        false
+      end
+    end
+
+    module InstanceMethods
+      def _root_document
+        self
+      end
+    end
   end
 end

data/lib/ripple/embedded_document.rb

@@ -25,21 +25,21 @@ module Ripple
 
     included do
       extend ActiveModel::Naming
-      extend Ripple::Document::Properties
-      include Ripple::Document::AttributeMethods
-      include Ripple::Document::Timestamps
-      include Ripple::Document::Validations
-      include Ripple::Document::Associations
-      include Ripple::Document::Callbacks
-      include Conversion
-      include Finders
       include Persistence
+      extend Ripple::Properties
+      include Ripple::AttributeMethods
+      include Ripple::Timestamps
+      include Ripple::Validations
+      include Ripple::Associations
+      include Ripple::Callbacks
+      include Ripple::Conversion
+      include Finders
     end
 
     module ClassMethods
       def embeddable?
-        !included_modules.include?(Document)
+        true
       end
     end
   end
-end
+end

data/lib/ripple/embedded_document/persistence.rb

@@ -20,88 +20,47 @@ module Ripple
       super(t("no_root_document", :doc => doc.inspect, :method => method))
     end
   end
-  
+
   module EmbeddedDocument
     module Persistence
       extend ActiveSupport::Concern
-      
+
       module ClassMethods
         def embedded_in(parent)
           define_method(parent) { @_parent_document }
         end
       end
-      
+
       module InstanceMethods
-        
         attr_reader :_parent_document
-        
-        def embeddable?
-          self.class.embeddable?
-        end
-        
+
         def new?
-          if _root_document?
-            super
-          elsif @_root_document
+          if _root_document
             _root_document.new?
           else
             true
           end
         end
-        
-        # because alias_method doesn't like super
-        def new_record?; new?; end
-        
-        # for ActiveModel::Conversion
-        def persisted?; !new?; end
-        
+
         def save(*args)
-          if _root_document?
-            super
-          elsif @_root_document
+          if _root_document
             _root_document.save(*args)
           else
             raise NoRootDocument.new(self, :save)
           end
         end
-        
-        def save!(*args)
-          if _root_document?
-            super
-          elsif @_root_document
-            _root_document.save!(*args)
-          else
-            raise NoRootDocument.new(self, :save!)
-          end
-        end
-        
-        def _root_document
-          embeddable? ? @_root_document : self
-        end
-        
-        def _root_document?
-          _root_document === self
-        end
 
         def attributes_for_persistence
-          attributes.merge("_type" => self.class.name).merge(embedded_attributes_for_persistence)
+          attributes.merge("_type" => self.class.name)
+        end
+
+        def _root_document
+          @_parent_document.try(:_root_document)
         end
         
         def _parent_document=(value)
-          @_root_document   = value._root_document
           @_parent_document = value
         end
-        
-        protected
-        
-          def embedded_attributes_for_persistence
-            embedded_associations.inject({}) do |attrs, association|
-              if documents = instance_variable_get(association.ivar)
-                attrs[association.name] = documents.is_a?(Array) ? documents.map(&:attributes_for_persistence) : documents.attributes_for_persistence
-              end
-              attrs
-            end
-          end
       end
     end
   end

data/lib/ripple/properties.rb

@@ -0,0 +1,83 @@
+# 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'
+require 'ripple/core_ext/casting'
+
+module Ripple
+  # Adds the ability to declare properties on your Ripple::Document class.
+  # Properties will automatically generate accessor (get/set/query) methods and
+  # handle type-casting between your Ruby type and JSON-compatible types.
+  module Properties
+    # @private
+    def inherited(subclass)
+      super
+      subclass.properties.merge!(properties)
+    end
+
+    # @return [Hash] the properties defined on the document
+    def properties
+      @properties ||= {}.with_indifferent_access
+    end
+
+    def property(key, type, options={})
+      prop = Property.new(key, type, options)
+      properties[prop.key] = prop
+    end
+  end
+
+  # Encapsulates a single property on your Ripple::Document class.
+  class Property
+    # @return [Symbol] the key of this property in the Document
+    attr_reader :key
+    # @return [Class] the Ruby type of property.
+    attr_reader :type
+    # @return [Hash] configuration options
+    attr_reader :options
+
+    # Create a new document property.
+    # @param [String, Symbol] key the key of the property
+    # @param [Class] type the Ruby type of the property. Use {Boolean} for true or false types.
+    # @param [Hash] options configuration options
+    # @option options [Object, Proc] :default (nil) a default value for the property, or a lambda to evaluate when providing the default.
+    def initialize(key, type, options={})
+      @options = options.to_options
+      @key = key.to_sym
+      @type = type
+    end
+
+    # @return [Object] The default value for this property if defined, or nil.
+    def default
+      if default = options[:default]
+        type_cast(default.respond_to?(:call) ? default.call : default)
+      end
+    end
+
+    # @return [Hash] options appropriate for the validates class method
+    def validation_options
+      @options.dup.except(:default)
+    end
+
+    # Attempt to coerce the passed value into this property's type
+    # @param [Object] value the value to coerce
+    # @return [Object] the value coerced into this property's type
+    # @raise [PropertyTypeMismatch] if the value cannot be coerced into the property's type
+    def type_cast(value)
+      if @type.respond_to?(:ripple_cast)
+        @type.ripple_cast(value)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/ripple/timestamps.rb

@@ -0,0 +1,34 @@
+# 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
+  module Timestamps
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def timestamps!
+        property :created_at, Time, :default => proc { Time.now.utc }
+        property :updated_at, Time
+        before_save :touch
+      end
+    end
+
+    module InstanceMethods
+      def touch
+        self.updated_at = Time.now.utc
+      end
+    end
+  end
+end

data/lib/ripple/{document/validations.rb → validations.rb}

@@ -14,7 +14,7 @@
 require 'ripple'
 
 module Ripple
-  
+
   # Raised by <tt>save!</tt> when the document is invalid.  Use the
   # +document+ method to retrieve the document which did not validate.
   #   begin
@@ -31,42 +31,40 @@ module Ripple
       super(t("document_invalid", :errors => errors))
     end
   end
-  
-  module Document
-    module Validations
-      extend ActiveSupport::Concern
-      extend ActiveSupport::Autoload
-      include ActiveModel::Validations
-      
-      autoload :AssociatedValidator
 
-      module ClassMethods
-        # @private
-        def property(key, type, options={})
-          prop = super
-          validates key, prop.validation_options unless prop.validation_options.blank?
-        end
-        
-        # Instantiates a new record, applies attributes from a block, and saves it
-        # Raises Ripple::DocumentInvalid if the record did not save
-        def create!(attrs={}, &block)
-          obj = create(attrs, &block)
-          (raise Ripple::DocumentInvalid.new(obj) if obj.new?) || obj
-        end
+  module Validations
+    extend ActiveSupport::Concern
+    extend ActiveSupport::Autoload
+    include ActiveModel::Validations
+
+    autoload :AssociatedValidator
+
+    module ClassMethods
+      # @private
+      def property(key, type, options={})
+        prop = super
+        validates key, prop.validation_options unless prop.validation_options.blank?
+      end
+
+      # Instantiates a new document, applies attributes from a block, and saves it
+      # Raises Ripple::DocumentInvalid if the record did not save
+      def create!(attrs={}, &block)
+        obj = create(attrs, &block)
+        (raise Ripple::DocumentInvalid.new(obj) if obj.new?) || obj
       end
+    end
 
-      module InstanceMethods
-        # @private
-        def save(options={:validate => true})
-          return false if options[:validate] && !valid?
-          super()
-        end
-        
-        def save!
-          (raise Ripple::DocumentInvalid.new(self) unless save) || true
-        end
-        
+    module InstanceMethods
+      # @private
+      def save(options={:validate => true})
+        return false if options[:validate] && !valid?
+        super()
+      end
+      
+      def save!
+        (raise Ripple::DocumentInvalid.new(self) unless save) || true
       end
     end
   end
 end
+