couchrest_model 1.1.0.beta5 → 1.1.0.rc1

data/Rakefile

@@ -1,23 +1,20 @@
 require 'rubygems'
 require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'rake'
+require 'rspec/core/rake_task'
 require "rake/rdoctask"
 
-require 'rspec'
-require 'rspec/core/rake_task'
+Bundler::GemHelper.install_tasks
 
 desc "Run all specs"
-Rspec::Core::RakeTask.new(:spec) do |spec|
-	spec.rspec_opts = ["--color"]
-	spec.pattern = 'spec/**/*_spec.rb'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ["--color"]
+  spec.pattern = 'spec/**/*_spec.rb'
 end
 
 desc "Print specdocs"
-Rspec::Core::RakeTask.new(:doc) do |spec|
-	spec.rspec_opts = ["--format", "specdoc"]
-	spec.pattern = 'spec/*_spec.rb'
+RSpec::Core::RakeTask.new(:doc) do |spec|
+  spec.rspec_opts = ["--format", "specdoc"]
+  spec.pattern = 'spec/*_spec.rb'
 end
 
 desc "Generate the rdoc"
@@ -38,4 +35,4 @@ module Rake
 end
 
 Rake.remove_task("github:release")
-Rake.remove_task("release")
+Rake.remove_task("release")

data/VERSION

@@ -1 +1 @@
-1.1.0.beta5
+1.1.0.rc1

data/couchrest_model.gemspec

@@ -17,18 +17,18 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/couchrest/couchrest_model}
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Extends the CouchRest Document for advanced modelling.}
-  
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
-  s.add_dependency(%q<couchrest>, "1.1.0.pre2")
+
+  s.add_dependency(%q<couchrest>, "1.1.0.pre3")
   s.add_dependency(%q<mime-types>, "~> 1.15")
-  s.add_dependency(%q<activemodel>, "~> 3.0.0")
+  s.add_dependency(%q<activemodel>, "~> 3.0")
   s.add_dependency(%q<tzinfo>, "~> 0.3.22")
-  s.add_dependency(%q<railties>, "~> 3.0.0")
-  s.add_development_dependency(%q<rspec>, ">= 2.0.0")
+  s.add_development_dependency(%q<rspec>, "~> 2.6.0")
+  s.add_development_dependency(%q<json>, ["~> 1.5.1"])
   s.add_development_dependency(%q<rack-test>, ">= 0.5.7")
   # s.add_development_dependency("jruby-openssl", ">= 0.7.3")
 end

data/history.md

@@ -1,5 +1,28 @@
 # CouchRest Model Change History
 
+## 1.1.0.rc - 2011-06-08
+
+* New Features
+  * Properties with a nil value are now no longer sent to the database.
+  * Now possible to build new objects via CastedArray#build
+  * Implement #get! and #find! class methods
+  * Now is possible delete particular elements in casted array(Kostiantyn Kahanskyi)
+
+* Minor fixes
+  * #as_json now correctly uses ActiveSupports methods.
+  * Rails 3.1 support (Peter Williams)
+  * Initialization blocks when creating new models (Peter Williams)
+  * Removed railties dependency (DAddYE)
+  * DesignDoc cache refreshed if a database is deleted.
+  * Fixing dirty tracking on collection_of association.
+  * Uniqueness Validation views created on initialization, not on demand!
+  * #destroy freezes object instead of removing _id and _rev, better for callbacks (pointer by karmi)
+  * #destroyed? method now available
+  * #reload no longer uses Hash#merge! which was causing issues with dirty tracking on casted models. (pointer by kostia)
+  * Non-property mass assignment on #new no longer possible without :directly_set_attributes option.
+  * Using CouchRest 1.1.0.pre3. (No more Hashes!)
+  * Fixing problem assigning a CastedHash to a property declared as a Hash (Kostiantyn Kahanskyi, gfmtim)
+
 ## 1.1.0.beta5 - 2011-04-30
 
 * Major changes:

data/lib/couchrest/model/associations.rb

@@ -153,7 +153,7 @@ module CouchRest
             def #{attrib}(reload = false)
               return @#{attrib} unless @#{attrib}.nil? or reload
               ary = self.#{options[:foreign_key]}.collect{|i| #{options[:proxy]}.get(i)}
-              @#{attrib} = ::CouchRest::CollectionOfProxy.new(ary, self, '#{options[:foreign_key]}')
+              @#{attrib} = ::CouchRest::Model::CollectionOfProxy.new(ary, find_property('#{options[:foreign_key]}'), self)
             end
           EOS
         end
@@ -161,7 +161,7 @@ module CouchRest
         def create_collection_of_setter(attrib, options)
           class_eval <<-EOS, __FILE__, __LINE__ + 1
             def #{attrib}=(value)
-              @#{attrib} = ::CouchRest::CollectionOfProxy.new(value, self, '#{options[:foreign_key]}')
+              @#{attrib} = ::CouchRest::Model::CollectionOfProxy.new(value, find_property('#{options[:foreign_key]}'), self)
             end
           EOS
         end
@@ -169,67 +169,63 @@ module CouchRest
       end
 
     end
-  end
 
-  # Special proxy for a collection of items so that adding and removing
-  # to the list automatically updates the associated property.
-  class CollectionOfProxy < Array
-    attr_accessor :property
-    attr_accessor :casted_by
-
-    def initialize(array, casted_by, property)
-      self.property = property
-      self.casted_by = casted_by
-      (array ||= []).compact!
-      casted_by[property.to_s] = [] # replace the original array!
-      array.compact.each do |obj|
+    # Special proxy for a collection of items so that adding and removing
+    # to the list automatically updates the associated property.
+    class CollectionOfProxy < CastedArray
+
+      def initialize(array, property, parent)
+        (array ||= []).compact!
+        super(array, property, parent)
+        casted_by[casted_by_property.to_s] = [] # replace the original array!
+        array.compact.each do |obj|
+          check_obj(obj)
+          casted_by[casted_by_property.to_s] << obj.id
+        end
+      end
+      
+      def << obj
         check_obj(obj)
-        casted_by[property.to_s] << obj.id
+        casted_by[casted_by_property.to_s] << obj.id
+        super(obj)
+      end
+      
+      def push(obj)
+        check_obj(obj)
+        casted_by[casted_by_property.to_s].push obj.id
+        super(obj)
+      end
+      
+      def unshift(obj)
+        check_obj(obj)
+        casted_by[casted_by_property.to_s].unshift obj.id
+        super(obj)
       end
-      super(array)
-    end
-    
-    def << obj
-      check_obj(obj)
-      casted_by[property.to_s] << obj.id
-      super(obj)
-    end
-    
-    def push(obj)
-      check_obj(obj)
-      casted_by[property.to_s].push obj.id
-      super(obj)
-    end
-    
-    def unshift(obj)
-      check_obj(obj)
-      casted_by[property.to_s].unshift obj.id
-      super(obj)
-    end
 
-    def []= index, obj
-      check_obj(obj)
-      casted_by[property.to_s][index] = obj.id
-      super(index, obj)
-    end
+      def []= index, obj
+        check_obj(obj)
+        casted_by[casted_by_property.to_s][index] = obj.id
+        super(index, obj)
+      end
 
-    def pop
-      casted_by[property.to_s].pop
-      super
-    end
-    
-    def shift
-      casted_by[property.to_s].shift
-      super
-    end
+      def pop
+        casted_by[casted_by_property.to_s].pop
+        super
+      end
+      
+      def shift
+        casted_by[casted_by_property.to_s].shift
+        super
+      end
 
-    protected
+      protected
+
+      def check_obj(obj)
+        raise "Object cannot be added to #{casted_by.class.to_s}##{casted_by_property.to_s} collection unless saved" if obj.new?
+      end
 
-    def check_obj(obj)
-      raise "Object cannot be added to #{casted_by.class.to_s}##{property.to_s} collection unless saved" if obj.new?
     end
 
   end
 
-
 end

data/lib/couchrest/model/base.rb

@@ -1,6 +1,6 @@
 module CouchRest
   module Model
-    class Base < Document
+    class Base < CouchRest::Document
 
       extend ActiveModel::Naming
 
@@ -49,14 +49,19 @@ module CouchRest
       # * :directly_set_attributes: true when data comes directly from database
       # * :database: provide an alternative database
       #
-      def initialize(doc = {}, options = {})
-        doc = prepare_all_attributes(doc, options)
-        # set the instances database, if provided
+      # If a block is provided the new model will be passed into the
+      # block so that it can be populated.
+      def initialize(attributes = {}, options = {})
+        super()
+        prepare_all_attributes(attributes, options)
+        # set the instance's database, if provided
         self.database = options[:database] unless options[:database].nil?
-        super(doc)
         unless self['_id'] && self['_rev']
           self[self.model_type_key] = self.class.to_s
         end
+
+        yield self if block_given?
+
         after_initialize if respond_to?(:after_initialize)
       end
 
@@ -75,16 +80,6 @@ module CouchRest
         super
       end
 
-      ## Compatibility with ActiveSupport and older frameworks
-
-      # Hack so that CouchRest::Document, which descends from Hash,
-      # doesn't appear to Rails routing as a Hash of options
-      def is_a?(klass)
-        return false if klass == Hash
-        super
-      end
-      alias :kind_of? :is_a?
-
       def persisted?
         !new?
       end

data/lib/couchrest/model/casted_array.rb

@@ -50,6 +50,22 @@ module CouchRest::Model
       super
     end
 
+    def delete(obj)
+      couchrest_parent_will_change! if use_dirty? && self.length > 0
+      super(obj)
+    end
+
+    def delete_at(index)
+      couchrest_parent_will_change! if use_dirty? && self.length > 0
+      super(index)
+    end
+
+    def build(*args)
+      obj = casted_by_property.build(*args)
+      self.push(obj)
+      obj
+    end
+
     protected
 
     def instantiate_and_cast(obj, change = true)

data/lib/couchrest/model/class_proxy.rb

@@ -87,7 +87,14 @@ module CouchRest
           doc
         end
         alias :find :get
-        
+
+        def get!(id)
+          doc = @klass.get!(id, @database)
+          doc.database = @database if doc && doc.respond_to?(:database)
+          doc
+        end
+        alias :find! :get!
+
         # Views
         
         def has_view?(view)

data/lib/couchrest/model/collection.rb

@@ -244,6 +244,7 @@ module CouchRest
           else
             options = { :limit => per_page, :skip => per_page * (page - 1) }
           end
+          options[:include_docs] = true
           view_options.merge(options)
         end
 

data/lib/couchrest/model/design_doc.rb

@@ -108,8 +108,6 @@ module CouchRest
           }
         end
 
-
-
       end # module ClassMethods
 
     end

data/lib/couchrest/model/document_queries.rb

@@ -1,13 +1,10 @@
 module CouchRest
   module Model
     module DocumentQueries
-      
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-      
+      extend ActiveSupport::Concern
+
       module ClassMethods
-        
+
         # 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.
@@ -73,7 +70,7 @@ module CouchRest
           end
         end
         alias :find :get
-        
+
         # Load a document from the database by id
         # An exception will be raised if the document isn't found
         #
@@ -86,9 +83,12 @@ 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?
+          raise CouchRest::Model::DocumentNotFound if id.blank?
+
           doc = db.get id
           build_from_database(doc)
+        rescue RestClient::ResourceNotFound
+          raise CouchRest::Model::DocumentNotFound
         end
         alias :find! :get!
         

data/lib/couchrest/model/errors.rb

@@ -19,5 +19,7 @@ module CouchRest
         end
       end
     end
+
+    class DocumentNotFound < Errors::CouchRestModelError; end
   end
 end

data/lib/couchrest/model/persistence.rb

@@ -21,8 +21,8 @@ module CouchRest
 
       # Creates the document in the db. Raises an exception
       # if the document is not created properly.
-      def create!
-        self.class.fail_validate!(self) unless self.create
+      def create!(options = {})
+        self.class.fail_validate!(self) unless self.create(options)
       end
 
       # Trigger the callbacks (before, after, around)
@@ -54,19 +54,21 @@ module CouchRest
       end
 
       # Deletes the document from the database. Runs the :destroy callbacks.
-      # Removes the <tt>_id</tt> and <tt>_rev</tt> fields, preparing the
-      # document to be saved to a new <tt>_id</tt> if required.
       def destroy
         _run_destroy_callbacks do
           result = database.delete_doc(self)
           if result['ok']
-            self.delete('_rev')
-            self.delete('_id')
+            @_destroyed = true
+            self.freeze
           end
           result['ok']
         end
       end
 
+      def destroyed?
+        !!@_destroyed
+      end
+
       # Update the document's attributes and save. For example:
       #
       #   doc.update_attributes :name => "Fred"
@@ -85,7 +87,7 @@ module CouchRest
       #
       # Returns self.
       def reload
-        merge!(self.class.get(id))
+        prepare_all_attributes(database.get(id), :directly_set_attributes => true)
         self
       end
 
@@ -104,22 +106,25 @@ module CouchRest
 
       module ClassMethods
 
-        # Creates a new instance, bypassing attribute protection
+        # Creates a new instance, bypassing attribute protection and
+        # uses the type field to determine which model to use to instanatiate
+        # the new object.
         #
         # ==== Returns
         #  a document instance
         #
-        def build_from_database(doc = {})
-          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)
+        def build_from_database(doc = {}, options = {}, &block)
+          src = doc[model_type_key]
+          base = (src.blank? || src == self.to_s) ? self : src.constantize
+          base.new(doc, options.merge(:directly_set_attributes => true), &block)
         end
 
         # Defines an instance and save it directly to the database
         #
         # ==== Returns
         #  returns the reloaded document
-        def create(attributes = {})
-          instance = new(attributes)
+        def create(attributes = {}, &block)
+          instance = new(attributes, &block)
           instance.create
           instance
         end
@@ -128,8 +133,8 @@ module CouchRest
         #
         # ==== Returns
         #  returns the reloaded document or raises an exception
-        def create!(attributes = {})
-          instance = new(attributes)
+        def create!(attributes = {}, &block)
+          instance = new(attributes, &block)
           instance.create!
           instance
         end

data/lib/couchrest/model/properties.rb

@@ -5,25 +5,15 @@ module CouchRest
       extend ActiveSupport::Concern
 
       included do
-        extlib_inheritable_accessor(:properties) unless self.respond_to?(:properties)
-        extlib_inheritable_accessor(:properties_by_name) unless self.respond_to?(:properties_by_name)
+        class_attribute(:properties) unless self.respond_to?(:properties)
+        class_attribute(:properties_by_name) unless self.respond_to?(:properties_by_name)
         self.properties ||= []
         self.properties_by_name ||= {}
         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
-      #
-      # ==== Returns
-      # Array:: the list of properties for model's class
-      def properties
-        self.class.properties
-      end
-
-      # Returns all the class's properties as a Hash where the key is the name
-      # of the property.
-      def properties_by_name
-        self.class.properties_by_name
+      def as_json(options = nil)
+        Hash[self].reject{|k,v| v.nil?}.as_json(options)
       end
 
       # Returns the Class properties with their values
@@ -90,17 +80,18 @@ module CouchRest
         self.disable_dirty = dirty
       end
 
-      def prepare_all_attributes(doc = {}, options = {})
+      def prepare_all_attributes(attrs = {}, options = {})
         self.disable_dirty = !!options[:directly_set_attributes]
         apply_all_property_defaults
         if options[:directly_set_attributes]
-          directly_set_read_only_attributes(doc)
+          directly_set_read_only_attributes(attrs)
+          directly_set_attributes(attrs, true)
         else
-          doc = remove_protected_attributes(doc)
+          attrs = remove_protected_attributes(attrs)
+          directly_set_attributes(attrs)
         end
-        res = doc.nil? ? doc : directly_set_attributes(doc)
         self.disable_dirty = false
-        res
+        self
       end
 
       def find_property!(property)
@@ -111,16 +102,13 @@ module CouchRest
 
       # 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
+      def directly_set_attributes(hash, mass_assign = false)
+        return if hash.nil?
+        hash.reject do |key, value|
+          if self.respond_to?("#{key}=")
+            self.send("#{key}=", value)
+          elsif mass_assign || mass_assign_any_attribute
+            self[key] = value
           end
         end
       end

data/lib/couchrest/model/property.rb

@@ -27,19 +27,15 @@ module CouchRest::Model
         if value.nil?
           value = []
         elsif [Hash, HashWithIndifferentAccess].include?(value.class)
-          # Assume provided as a Hash where key is index!
-          data = value
-          value = [ ]
-          data.keys.sort.each do |k|
-            value << data[k]
-          end
+          # Assume provided as a params hash where key is index
+          value = parameter_hash_to_array(value)
         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) }
         # allow casted_by calls to be passed up chain by wrapping in CastedArray
         CastedArray.new(arr, self, parent)
-      elsif (type == Object || type == Hash) && (value.class == Hash)
+      elsif (type == Object || type == Hash) && (value.is_a?(Hash))
         # allow casted_by calls to be passed up chain by wrapping in CastedHash
         CastedHash[value, self, parent]
       elsif !value.nil?
@@ -64,8 +60,28 @@ module CouchRest::Model
       end
     end
 
+    # Initialize a new instance of a property's type ready to be
+    # used. If a proc is defined for the init method, it will be used instead of 
+    # a normal call to the class.
+    def build(*args)
+      raise StandardError, "Cannot build property without a class" if @type_class.nil?
+      if @init_method.is_a?(Proc)
+        @init_method.call(*args)
+      else
+        @type_class.send(@init_method, *args)
+      end
+    end
+
     private
 
+      def parameter_hash_to_array(source)
+        value = [ ]
+        source.keys.each do |k|
+          value[k.to_i] = source[k]
+        end
+        value.compact
+      end
+
       def associate_casted_value_to_parent(parent, value)
         value.casted_by = parent if value.respond_to?(:casted_by)
         value.casted_by_property = self if value.respond_to?(:casted_by_property)

data/lib/couchrest/model/proxyable.rb

@@ -73,12 +73,12 @@ module CouchRest
         end
 
         # Base
-        def new(*args)
-          proxy_update(model.new(*args))
+        def new(attrs = {}, options = {}, &block)
+          proxy_block_update(:new, attrs, options, &block)
         end
 
-        def build_from_database(doc = {})
-          proxy_update(model.build_from_database(doc))
+        def build_from_database(attrs = {}, options = {}, &block)
+          proxy_block_update(:build_from_database, attrs, options, &block)
         end
 
         def method_missing(m, *args, &block)
@@ -170,6 +170,13 @@ module CouchRest
           end
         end
 
+        def proxy_block_update(method, *args, &block)
+          model.send(method, *args) do |doc|
+            proxy_update(doc)
+            yield doc if block_given?
+          end
+        end
+
       end
     end
   end

data/lib/couchrest/model/support/couchrest_database.rb

@@ -0,0 +1,13 @@
+#
+# Extend CouchRest's normal database delete! method to ensure any caches are
+# also emptied. Given that this is a rare event, and the consequences are not 
+# very severe, we just completely empty the cache.
+#
+CouchRest::Database.class_eval do
+
+  def delete!
+    Thread.current[:couchrest_design_cache] = { }
+    CouchRest.delete @root
+  end
+
+end

data/lib/couchrest/model/support/couchrest_design.rb

@@ -18,7 +18,7 @@ CouchRest::Design.class_eval do
     flatten =
       lambda {|r|
         (recurse = lambda {|v|
-          if v.is_a?(Hash)
+          if v.is_a?(Hash) || v.is_a?(CouchRest::Document)
             v.to_a.map{|v| recurse.call(v)}.flatten
           elsif v.is_a?(Array)
             v.flatten.map{|v| recurse.call(v)}

data/lib/couchrest/model/typecast.rb

@@ -14,8 +14,7 @@ module CouchRest
         elsif [String, TrueClass, Integer, Float, BigDecimal, DateTime, Time, Date, Class].include?(klass)
           send('typecast_to_'+klass.to_s.downcase, value)
         else
-          # Allow the init_method to be defined as a Proc for advanced conversion
-          property.init_method.is_a?(Proc) ? property.init_method.call(value) : klass.send(property.init_method, value)
+          property.build(value)
         end
       end