couchrest_model 1.0.0.beta8 → 1.0.0

data/lib/couchrest/model/base.rb

@@ -4,6 +4,7 @@ module CouchRest
 
       extend ActiveModel::Naming
 
+      include CouchRest::Model::Configuration
       include CouchRest::Model::Persistence
       include CouchRest::Model::Callbacks
       include CouchRest::Model::DocumentQueries    
@@ -12,8 +13,7 @@ module CouchRest
       include CouchRest::Model::ExtendedAttachments
       include CouchRest::Model::ClassProxy
       include CouchRest::Model::Collection
-      include CouchRest::Model::AttributeProtection
-      include CouchRest::Model::Attributes
+      include CouchRest::Model::PropertyProtection
       include CouchRest::Model::Associations
       include CouchRest::Model::Validations
 
@@ -37,7 +37,7 @@ module CouchRest
       
       # Accessors
       attr_accessor :casted_by
-      
+
 
       # Instantiate a new CouchRest::Model::Base by preparing all properties
       # using the provided document hash.
@@ -47,10 +47,10 @@ module CouchRest
       # * :directly_set_attributes: true when data comes directly from database
       #
       def initialize(doc = {}, options = {})
-        prepare_all_attributes(doc, options)
+        doc = prepare_all_attributes(doc, options)
         super(doc)
         unless self['_id'] && self['_rev']
-          self['couchrest-type'] = self.class.to_s
+          self[self.model_type_key] = self.class.to_s
         end
         after_initialize if respond_to?(:after_initialize)
       end

data/lib/couchrest/model/casted_model.rb

@@ -4,10 +4,10 @@ module CouchRest::Model
     extend ActiveSupport::Concern
 
     included do
-      include CouchRest::Model::AttributeProtection
-      include CouchRest::Model::Attributes
+      include CouchRest::Model::Configuration
       include CouchRest::Model::Callbacks
       include CouchRest::Model::Properties
+      include CouchRest::Model::PropertyProtection
       include CouchRest::Model::Associations
       include CouchRest::Model::Validations
       attr_accessor :casted_by

data/lib/couchrest/model/class_proxy.rb

@@ -75,6 +75,12 @@ module CouchRest
           doc
         end
         
+        def last(opts = {})
+          doc = @klass.last({:database => @database}.merge(opts))
+          doc.database = @database if doc && doc.respond_to?(:database)
+          doc
+        end
+        
         def get(id)
           doc = @klass.get(id, @database)
           doc.database = @database if doc && doc.respond_to?(:database)

data/lib/couchrest/model/collection.rb

@@ -82,6 +82,7 @@ module CouchRest
               design_doc['views'][view_name.to_s] &&
               design_doc['views'][view_name.to_s]["couchrest-defaults"]) || {}
           view_options = default_view_options.merge(options)
+          view_options.delete(:database)
 
           [design_doc, view_name, view_options]
         end
@@ -94,6 +95,8 @@ module CouchRest
           raise ArgumentError, 'search_name is required' if search_name.nil?
 
           search_options = options.clone
+          search_options.delete(:database)
+
           [design_doc, search_name, search_options]
         end
 

data/lib/couchrest/model/configuration.rb

@@ -0,0 +1,51 @@
+module CouchRest
+
+  # CouchRest Model Configuration support, stolen from Carrierwave by jnicklas
+  #    http://github.com/jnicklas/carrierwave/blob/master/lib/carrierwave/uploader/configuration.rb
+
+  module Model
+    module Configuration
+      extend ActiveSupport::Concern
+
+      included do
+        add_config :model_type_key
+        add_config :mass_assign_any_attribute
+        
+        configure do |config|
+          config.model_type_key = 'couchrest-type' # 'model'?
+          config.mass_assign_any_attribute = false
+        end
+      end
+
+      module ClassMethods
+
+        def add_config(name)
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def self.#{name}(value=nil)
+              @#{name} = value if value
+              return @#{name} if self.object_id == #{self.object_id} || defined?(@#{name})
+              name = superclass.#{name}
+              return nil if name.nil? && !instance_variable_defined?("@#{name}")
+              @#{name} = name && !name.is_a?(Module) && !name.is_a?(Symbol) && !name.is_a?(Numeric) && !name.is_a?(TrueClass) && !name.is_a?(FalseClass) ? name.dup : name
+            end
+
+            def self.#{name}=(value)
+              @#{name} = value
+            end
+
+            def #{name}
+              self.class.#{name}
+            end
+          RUBY
+        end
+
+        def configure
+          yield self
+        end
+      end
+
+    end
+  end
+end
+
+

data/lib/couchrest/model/design_doc.rb

@@ -2,10 +2,7 @@
 module CouchRest
   module Model
     module DesignDoc
-      
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
+      extend ActiveSupport::Concern
       
       module ClassMethods
         
@@ -34,7 +31,7 @@ module CouchRest
             "views" => {
               'all' => {
                 'map' => "function(doc) {
-                  if (doc['couchrest-type'] == '#{self.to_s}') {
+                  if (doc['#{self.model_type_key}'] == '#{self.to_s}') {
                     emit(doc['_id'],1);
                   }
                 }"

data/lib/couchrest/model/document_queries.rb

@@ -8,21 +8,21 @@ module CouchRest
       
       module ClassMethods
         
-        # Load all documents that have the "couchrest-type" field equal to the
+        # Load all documents that have the model_type_key's field equal to the
         # name of the current class. Take the standard set of
         # CouchRest::Database#view options.
         def all(opts = {}, &block)
           view(:all, opts, &block)
         end
         
-        # Returns the number of documents that have the "couchrest-type" field
+        # Returns the number of documents that have the model_type_key's field
         # equal to the name of the current class. Takes the standard set of 
         # CouchRest::Database#view options
         def count(opts = {}, &block)
           all({:raw => true, :limit => 0}.merge(opts), &block)['total_rows']
         end
         
-        # Load the first document that have the "couchrest-type" field equal to
+        # Load the first document that have the model_type_key's field equal to
         # the name of the current class.
         #
         # ==== Returns
@@ -38,6 +38,22 @@ module CouchRest
           first_instance.empty? ? nil : first_instance.first
         end
         
+        # Load the last document that have the model_type_key's field equal to
+        # the name of the current class.
+        # It's similar to method first, just adds :descending => true
+        #
+        # ==== Returns
+        # Object:: The last object instance available
+        # or
+        # Nil:: if no instances available
+        #
+        # ==== Parameters
+        # opts<Hash>::
+        # View options, see <tt>CouchRest::Database#view</tt> options for more info.
+        def last(opts = {})
+          first(opts.merge!(:descending => true))
+        end
+        
         # Load a document from the database by id
         # No exceptions will be raised if the document isn't found
         #
@@ -70,6 +86,7 @@ module CouchRest
         # id<String, Integer>:: Document ID
         # db<Database>:: optional option to pass a custom database to use
         def get!(id, db = database)
+          raise "Missing or empty document ID" if id.to_s.empty?
           doc = db.get id
           create_from_database(doc)
         end

data/lib/couchrest/model/persistence.rb

@@ -62,6 +62,20 @@ module CouchRest
         end
       end
 
+      # Update the document's attributes and save. For example:
+      #
+      #   doc.update_attributes :name => "Fred"
+      # 
+      # Is the equivilent of doing the following:
+      #
+      #   doc.attributes = { :name => "Fred" }
+      #   doc.save
+      #
+      def update_attributes(hash)
+        update_attributes_without_saving hash
+        save
+      end
+
     protected
 
       def perform_validations(options = {})
@@ -83,7 +97,7 @@ module CouchRest
         # ==== Returns
         #  a document instance
         def create_from_database(doc = {})
-          base = (doc['couchrest-type'].blank? || doc['couchrest-type'] == self.to_s) ? self : doc['couchrest-type'].constantize
+          base = (doc[model_type_key].blank? || doc[model_type_key] == self.to_s) ? self : doc[model_type_key].constantize
           base.new(doc, :directly_set_attributes => true)      
         end
 

data/lib/couchrest/model/properties.rb

@@ -2,16 +2,12 @@
 module CouchRest
   module Model
     module Properties
-      
-      class IncludeError < StandardError; end
-      
-      def self.included(base)
-        base.class_eval <<-EOS, __FILE__, __LINE__ + 1
-            extlib_inheritable_accessor(:properties) unless self.respond_to?(:properties)
-            self.properties ||= []
-        EOS
-        base.extend(ClassMethods)
-        raise CouchRest::Mixins::Properties::IncludeError, "You can only mixin Properties in a class responding to [] and []=, if you tried to mixin CastedModel, make sure your class inherits from Hash or responds to the proper methods" unless (base.new.respond_to?(:[]) && base.new.respond_to?(:[]=))
+      extend ActiveSupport::Concern
+
+      included do
+        extlib_inheritable_accessor(:properties) unless self.respond_to?(:properties)
+        self.properties ||= []
+        raise "You can only mixin Properties in a class responding to [] and []=, if you tried to mixin CastedModel, make sure your class inherits from Hash or responds to the proper methods" unless (method_defined?(:[]) && method_defined?(:[]=))
       end
 
       # Returns the Class properties
@@ -22,16 +18,45 @@ module CouchRest
         self.class.properties
       end
 
+      # Returns the Class properties with their values
+      #
+      # ==== Returns
+      # Array:: the list of properties with their values
+      def properties_with_values
+        props = {}
+        properties.each { |property| props[property.name] = read_attribute(property.name) }
+        props
+      end
+
+      # Read the casted value of an attribute defined with a property.
+      #
+      # ==== Returns
+      # Object:: the casted attibutes value.
       def read_attribute(property)
-        self[property.to_s]
+        self[find_property!(property).to_s]
       end
 
+      # Store a casted value in the current instance of an attribute defined
+      # with a property.
       def write_attribute(property, value)
-        prop = property.is_a?(Property) ? property : self.class.properties.detect {|p| p.to_s == property.to_s}
-        raise "Missing property definition for #{property.to_s}" unless prop
-        self[prop.to_s] = prop.cast(self, value)
+        prop = find_property!(property)
+        self[prop.to_s] = prop.is_a?(String) ? value : prop.cast(self, value)
+      end
+
+      # Takes a hash as argument, and applies the values by using writer methods
+      # for each key. It doesn't save the document at the end. Raises a NoMethodError if the corresponding methods are
+      # missing. In case of error, no attributes are changed.
+      def update_attributes_without_saving(hash)
+        # Remove any protected and update all the rest. Any attributes
+        # which do not have a property will simply be ignored.
+        attrs = remove_protected_attributes(hash)
+        directly_set_attributes(attrs)
       end
+      alias :attributes= :update_attributes_without_saving
 
+
+      private
+      # The following methods should be accessable by the Model::Base Class, but not by anything else!
       def apply_all_property_defaults
         return if self.respond_to?(:new?) && (new? == false)
         # TODO: cache the default object
@@ -39,9 +64,57 @@ module CouchRest
           write_attribute(property, property.default_value)
         end
       end
-     
+
+      def prepare_all_attributes(doc = {}, options = {})
+        apply_all_property_defaults
+        if options[:directly_set_attributes]
+          directly_set_read_only_attributes(doc)
+        else
+          doc = remove_protected_attributes(doc)
+        end
+        directly_set_attributes(doc) unless doc.nil?
+      end
+
+      def find_property!(property)
+        prop = property.is_a?(Property) ? property : self.class.properties.detect {|p| p.to_s == property.to_s}
+        raise ArgumentError, "Missing property definition for #{property.to_s}" if prop.nil?
+        prop
+      end
+
+      # Set all the attributes and return a hash with the attributes
+      # that have not been accepted.
+      def directly_set_attributes(hash)
+        hash.reject do |attribute_name, attribute_value|
+          if self.respond_to?("#{attribute_name}=")
+            self.send("#{attribute_name}=", attribute_value)
+            true
+          elsif mass_assign_any_attribute # config option
+            self[attribute_name] = attribute_value
+            true
+          else
+            false
+          end
+        end
+      end
+
+      def directly_set_read_only_attributes(hash)
+        property_list = self.properties.map{|p| p.name}
+        hash.each do |attribute_name, attribute_value|
+          next if self.respond_to?("#{attribute_name}=")
+          if property_list.include?(attribute_name)
+            write_attribute(attribute_name, hash.delete(attribute_name))
+          end
+        end
+      end
+
+      def set_attributes(hash)
+        attrs = remove_protected_attributes(hash)
+        directly_set_attributes(attrs)
+      end
+
+
       module ClassMethods
-        
+
         def property(name, *options, &block)
           opts = { }
           type = options.shift
@@ -64,16 +137,16 @@ module CouchRest
           class_eval <<-EOS, __FILE__, __LINE__
             property(:updated_at, Time, :read_only => true, :protected => true, :auto_validation => false)
             property(:created_at, Time, :read_only => true, :protected => true, :auto_validation => false)
-            
+
             set_callback :save, :before do |object|
               write_attribute('updated_at', Time.now)
               write_attribute('created_at', Time.now) if object.new?
             end
           EOS
         end
-        
+
         protected
-        
+
           # This is not a thread safe operation, if you have to set new properties at runtime
           # make sure a mutex is used.
           def define_property(name, options={}, &block)
@@ -87,7 +160,7 @@ module CouchRest
               type = [type] # inject as an array
             end
             property = Property.new(name, type, options)
-            create_property_getter(property) 
+            create_property_getter(property)
             create_property_setter(property) unless property.read_only == true
             if property.type_class.respond_to?(:validates_casted_model)
               validates_casted_model property.name
@@ -95,7 +168,7 @@ module CouchRest
             properties << property
             property
           end
-          
+
           # defines the getter for the property (and optional aliases)
           def create_property_getter(property)
             # meth = property.name
@@ -136,9 +209,10 @@ module CouchRest
               EOS
             end
           end
-          
+
       end # module ClassMethods
-      
+
     end
   end
 end
+

data/lib/couchrest/model/property.rb

@@ -33,7 +33,7 @@ module CouchRest::Model
           data.keys.sort.each do |k|
             value << data[k]
           end
-        elsif value.class != Array
+        elsif !value.is_a?(Array)
           raise "Expecting an array or keyed hash for property #{parent.class.name}##{self.name}"
         end
         arr = value.collect { |data| cast_value(parent, data) }
@@ -58,7 +58,8 @@ module CouchRest::Model
       if default.class == Proc
         default.call
       else
-        Marshal.load(Marshal.dump(default))
+        # Marshal.load(Marshal.dump(default)) # Removed as there are no failing tests and caused mutex errors
+        default
       end
     end
 
@@ -72,12 +73,12 @@ module CouchRest::Model
       def parse_type(type)
         if type.nil?
           @casted = false
-          @type = nil 
+          @type = nil
           @type_class = nil
         else
           base = type.is_a?(Array) ? type.first : type
           base = Object if base.nil?
-          raise "Defining a property type as a #{type.class.name.humanize} is not supported in CouchRest Model!" if base.class != Class 
+          raise "Defining a property type as a #{type.class.name.humanize} is not supported in CouchRest Model!" if base.class != Class
           @type_class = base
           @type = type
         end

data/lib/couchrest/model/property_protection.rb

@@ -0,0 +1,71 @@
+module CouchRest
+  module Model
+    module PropertyProtection
+      extend ActiveSupport::Concern
+
+      # Property protection from mass assignment to CouchRest::Model properties
+      #
+      # Protected methods will be removed from
+      #  * new
+      #  * update_attributes
+      #  * upate_attributes_without_saving
+      #  * attributes=
+      #
+      # There are two modes of protection
+      #  1) Declare accessible poperties, and assume all unspecified properties are protected
+      #    property :name,  :accessible => true
+      #    property :admin                      # this will be automatically protected
+      #
+      #  2) Declare protected properties, and assume all unspecified properties are accessible
+      #    property :name                       # this will not be protected
+      #    property :admin, :protected => true
+      #
+      #  3) Mix and match, and assume all unspecified properties are protected.
+      #    property :name,  :accessible => true
+      #    property :admin, :protected  => true # ignored
+      #    property :phone                      # this will be automatically protected
+      #
+      #  Note: the timestamps! method protectes the created_at and updated_at properties
+
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def accessible_properties
+          props = properties.select { |prop| prop.options[:accessible] }
+          if props.empty?
+            props = properties.select { |prop| !prop.options[:protected] }
+          end
+          props
+        end
+
+        def protected_properties
+          accessibles = accessible_properties
+          properties.reject { |prop| accessibles.include?(prop) }
+        end
+      end
+
+      def accessible_properties
+        self.class.accessible_properties
+      end
+
+      def protected_properties
+        self.class.protected_properties
+      end
+
+      # Return a new copy of the attributes hash with protected attributes
+      # removed.
+      def remove_protected_attributes(attributes)
+        protected_names = protected_properties.map { |prop| prop.name }
+        return attributes if protected_names.empty? or attributes.nil?
+
+        attributes.reject do |property_name, property_value|
+          protected_names.include?(property_name.to_s)
+        end
+      end
+
+    end
+  end
+end

data/lib/couchrest/model/typecast.rb

@@ -1,19 +1,23 @@
 class Time                       
   # returns a local time value much faster than Time.parse
   def self.mktime_with_offset(string)
-    string =~ /(\d{4})[\-|\/](\d{2})[\-|\/](\d{2})[T|\s](\d{2}):(\d{2}):(\d{2})([\+|\s|\-])*(\d{2}):?(\d{2})/
+    string =~ /(\d{4})[\-|\/](\d{2})[\-|\/](\d{2})[T|\s](\d{2}):(\d{2}):(\d{2})(([\+|\s|\-])*(\d{2}):?(\d{2}))?/
     # $1 = year
     # $2 = month
     # $3 = day
     # $4 = hours
     # $5 = minutes
     # $6 = seconds
-    # $7 = time zone direction
-    # $8 = tz difference
+    # $8 = time zone direction
+    # $9 = tz difference
     # utc time with wrong TZ info: 
-    time = mktime($1, RFC2822_MONTH_NAME[$2.to_i - 1], $3, $4, $5, $6, $7)
-    tz_difference = ("#{$7 == '-' ? '+' : '-'}#{$8}".to_i * 3600)
-    time + tz_difference + zone_offset(time.zone) 
+    time = mktime($1, RFC2822_MONTH_NAME[$2.to_i - 1], $3, $4, $5, $6)
+    if ($7)
+      tz_difference = ("#{$8 == '-' ? '+' : '-'}#{$9}".to_i * 3600)
+      time + tz_difference + zone_offset(time.zone) 
+    else
+      time
+    end
   end 
 end
 
@@ -75,7 +79,7 @@ module CouchRest
         # Match numeric string
         def typecast_to_numeric(value, method)
           if value.respond_to?(:to_str)
-            if value.to_str =~ /\A(-?(?:0|[1-9]\d*)(?:\.\d+)?|(?:\.\d+))\z/
+            if value.gsub(/,/, '.').gsub(/\.(?!\d*\Z)/, '').to_str =~ /\A(-?(?:0|[1-9]\d*)(?:\.\d+)?|(?:\.\d+))\z/
               $1.send(method)
             else
               value
@@ -128,6 +132,7 @@ module CouchRest
         rescue ArgumentError
           value
         rescue TypeError
+          # After failures, resort to normal time parse
           value
         end