mattetti-couchrest 0.33 → 0.34

data/lib/couchrest/more/property.rb

@@ -38,3 +38,22 @@ module CouchRest
     
   end
 end
+
+class CastedArray < Array
+  attr_accessor :casted_by
+  
+  def << obj
+    obj.casted_by = self.casted_by if obj.respond_to?(:casted_by)
+    super(obj)
+  end
+  
+  def push(obj)
+    obj.casted_by = self.casted_by if obj.respond_to?(:casted_by)
+    super(obj)
+  end
+  
+  def []= index, obj
+    obj.casted_by = self.casted_by if obj.respond_to?(:casted_by)
+    super(index, obj)
+  end
+end

data/lib/couchrest/support/class.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2004-2008 David Heinemeier Hansson
-#
+# Copyright (c) 2006-2009 David Heinemeier Hansson
+#  
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
 # "Software"), to deal in the Software without restriction, including
@@ -7,10 +7,10 @@
 # distribute, sublicense, and/or sell copies of the Software, and to
 # permit persons to whom the Software is furnished to do so, subject to
 # the following conditions:
-#
+#  
 # The above copyright notice and this permission notice shall be
 # included in all copies or substantial portions of the Software.
-#
+#  
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
@@ -18,79 +18,59 @@
 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- 
-# Allows attributes to be shared within an inheritance hierarchy, but where
-# each descendant gets a copy of their parents' attributes, instead of just a
-# pointer to the same. This means that the child can add elements to, for
-# example, an array without those additions being shared with either their
-# parent, siblings, or children, which is unlike the regular class-level
-# attributes that are shared across the entire hierarchy.
+#
+# Extracted From
+# http://github.com/rails/rails/commit/971e2438d98326c994ec6d3ef8e37b7e868ed6e2
+
+# Extends the class object with class and instance accessors for class attributes,
+# just like the native attr* accessors for instance attributes.
+#
+#  class Person
+#    cattr_accessor :hair_colors
+#  end
+#
+#  Person.hair_colors = [:brown, :black, :blonde, :red]
 class Class
-  # Defines class-level and instance-level attribute reader.
-  #
-  # @param *syms<Array> Array of attributes to define reader for.
-  # @return <Array[#to_s]> List of attributes that were made into cattr_readers
-  #
-  # @api public
-  #
-  # @todo Is this inconsistent in that it does not allow you to prevent
-  #   an instance_reader via :instance_reader => false
   def cattr_reader(*syms)
     syms.flatten.each do |sym|
       next if sym.is_a?(Hash)
-      class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-        unless defined? @@#{sym}
-          @@#{sym} = nil
-        end
-
-        def self.#{sym}
-          @@#{sym}
-        end
-
-        def #{sym}
-          @@#{sym}
-        end
-      RUBY
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        unless defined? @@#{sym}  # unless defined? @@hair_colors
+          @@#{sym} = nil          #   @@hair_colors = nil
+        end                       # end
+                                  #
+        def self.#{sym}           # def self.hair_colors
+          @@#{sym}                #   @@hair_colors
+        end                       # end
+                                  #
+        def #{sym}                # def hair_colors
+          @@#{sym}                #   @@hair_colors
+        end                       # end
+      EOS
     end
   end unless Class.respond_to?(:cattr_reader)
 
-  # Defines class-level (and optionally instance-level) attribute writer.
-  #
-  # @param <Array[*#to_s, Hash{:instance_writer => Boolean}]> Array of attributes to define writer for.
-  # @option syms :instance_writer<Boolean> if true, instance-level attribute writer is defined.
-  # @return <Array[#to_s]> List of attributes that were made into cattr_writers
-  #
-  # @api public
   def cattr_writer(*syms)
-    options = syms.last.is_a?(Hash) ? syms.pop : {}
+    options = syms.extract_options!
     syms.flatten.each do |sym|
-      class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-        unless defined? @@#{sym}
-          @@#{sym} = nil
-        end
-
-        def self.#{sym}=(obj)
-          @@#{sym} = obj
-        end
-      RUBY
-
-      unless options[:instance_writer] == false
-        class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-          def #{sym}=(obj)
-            @@#{sym} = obj
-          end
-        RUBY
-      end
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        unless defined? @@#{sym}                       # unless defined? @@hair_colors
+          @@#{sym} = nil                               #   @@hair_colors = nil
+        end                                            # end
+                                                       #
+        def self.#{sym}=(obj)                          # def self.hair_colors=(obj)
+          @@#{sym} = obj                               #   @@hair_colors = obj
+        end                                            # end
+                                                       #
+        #{"                                            #
+        def #{sym}=(obj)                               # def hair_colors=(obj)
+          @@#{sym} = obj                               #   @@hair_colors = obj
+        end                                            # end
+        " unless options[:instance_writer] == false }  # # instance writer above is generated unless options[:instance_writer] == false
+      EOS
     end
   end unless Class.respond_to?(:cattr_writer)
 
-  # Defines class-level (and optionally instance-level) attribute accessor.
-  #
-  # @param *syms<Array[*#to_s, Hash{:instance_writer => Boolean}]> Array of attributes to define accessor for.
-  # @option syms :instance_writer<Boolean> if true, instance-level attribute writer is defined.
-  # @return <Array[#to_s]> List of attributes that were made into accessors
-  #
-  # @api public
   def cattr_accessor(*syms)
     cattr_reader(*syms)
     cattr_writer(*syms)
@@ -156,6 +136,8 @@ class Class
           def #{ivar}=(obj) self.class.#{ivar} = obj end
         RUBY
       end
+
+      self.send("#{ivar}=", yield) if block_given?
     end
   end unless Class.respond_to?(:extlib_inheritable_writer)
 
@@ -168,9 +150,41 @@ class Class
   # @return <Array[#to_s]> An Array of attributes turned into inheritable accessors.
   #
   # @api public
-  def extlib_inheritable_accessor(*syms)
+  def extlib_inheritable_accessor(*syms, &block)
     extlib_inheritable_reader(*syms)
-    extlib_inheritable_writer(*syms)
+    extlib_inheritable_writer(*syms, &block)
   end unless Class.respond_to?(:extlib_inheritable_accessor)
 end
 
+class Array
+  # Extracts options from a set of arguments. Removes and returns the last
+  # element in the array if it's a hash, otherwise returns a blank hash.
+  #
+  #   def options(*args)
+  #     args.extract_options!
+  #   end
+  #
+  #   options(1, 2)           # => {}
+  #   options(1, 2, :a => :b) # => {:a=>:b}
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end unless Array.new.respond_to?(:extract_options!)
+  
+  # Wraps the object in an Array unless it's an Array.  Converts the
+  # object to an Array using #to_ary if it implements that.
+  def self.wrap(object)
+    case object
+    when nil
+      []
+    when self
+      object
+    else
+      if object.respond_to?(:to_ary)
+        object.to_ary
+      else
+        [object]
+      end
+    end
+  end unless Array.respond_to?(:wrap)
+end
+

data/lib/couchrest/support/rails.rb

@@ -1,8 +1,4 @@
 # This file contains various hacks for Rails compatibility.
-# To use, just require in environment.rb, like so:
-#
-#   require 'couchrest/support/rails'
-
 class Hash
   # Hack so that CouchRest::Document, which descends from Hash,
   # doesn't appear to Rails routing as a Hash of options
@@ -12,8 +8,10 @@ class Hash
   end
 end
 
-
 CouchRest::Document.class_eval do
+  # Need this when passing doc to a resourceful route
+  alias_method :to_param, :id
+
   # Hack so that CouchRest::Document, which descends from Hash,
   # doesn't appear to Rails routing as a Hash of options
   def is_a?(o)
@@ -23,6 +21,15 @@ CouchRest::Document.class_eval do
   alias_method :kind_of?, :is_a?
 end
 
+CouchRest::CastedModel.class_eval do
+  # The to_param method is needed for rails to generate resourceful routes.
+  # In your controller, remember that it's actually the id of the document.
+  def id
+    return nil if base_doc.nil?
+    base_doc.id
+  end
+  alias_method :to_param, :id
+end
 
 require Pathname.new(File.dirname(__FILE__)).join('..', 'validation', 'validation_errors')
 

data/spec/couchrest/core/database_spec.rb

@@ -253,7 +253,7 @@ describe CouchRest::Database do
   describe "PUT attachment from file" do
     before(:each) do
       filename = FIXTURE_PATH + '/attachments/couchdb.png'
-      @file = File.open(filename)
+      @file = File.open(filename, "rb")
     end
     after(:each) do
       @file.close
@@ -552,7 +552,7 @@ describe CouchRest::Database do
         newdoc['artist'].should == 'Zappa'
       end
       it "should fail without an _id" do
-        lambda{@db.copy({"not"=>"a real doc"})}.should raise_error(ArgumentError)
+        lambda{@db.copy_doc({"not"=>"a real doc"})}.should raise_error(ArgumentError)
       end
     end
     describe "to an existing location" do

data/spec/couchrest/more/casted_extended_doc_spec.rb

@@ -43,16 +43,14 @@ describe "assigning a value to casted attribute after initializing an object" do
     @car.driver.should be_nil
   end
   
-  # Note that this isn't casting the attribute, it's just assigning it a value
-  # (see "should not cast attribute")
   it "should let you assign the value" do
     @car.driver = @driver
     @car.driver.name.should == 'Matt'
   end
   
-  it "should not cast attribute" do
+  it "should cast attribute" do
     @car.driver = JSON.parse(JSON.generate(@driver))
-    @car.driver.should_not be_instance_of(Driver)
+    @car.driver.should be_instance_of(Driver)
   end
 
 end

data/spec/couchrest/more/casted_model_spec.rb

@@ -4,6 +4,8 @@ require File.expand_path('../../../spec_helper', __FILE__)
 require File.join(FIXTURE_PATH, 'more', 'card')
 require File.join(FIXTURE_PATH, 'more', 'cat')
 require File.join(FIXTURE_PATH, 'more', 'person')
+require File.join(FIXTURE_PATH, 'more', 'question')
+require File.join(FIXTURE_PATH, 'more', 'course')
 
 
 class WithCastedModelMixin < Hash
@@ -21,6 +23,26 @@ class DummyModel < CouchRest::ExtendedDocument
   property :keywords,         :cast_as => ["String"]
 end
 
+class CastedCallbackDoc < CouchRest::ExtendedDocument
+  use_database TEST_SERVER.default_database
+  raise "Default DB not set" if TEST_SERVER.default_database.nil?
+  property :callback_model, :cast_as => 'WithCastedCallBackModel'
+end
+class WithCastedCallBackModel < Hash
+  include CouchRest::CastedModel
+  include CouchRest::Validation
+  property :name
+  property :run_before_validate
+  property :run_after_validate
+  
+  before_validate do |object|
+    object.run_before_validate = true
+  end
+  after_validate do |object| 
+    object.run_after_validate = true
+  end
+end
+
 describe CouchRest::CastedModel do
   
   describe "A non hash class including CastedModel" do
@@ -106,7 +128,40 @@ describe CouchRest::CastedModel do
       @obj.keywords.should be_an_instance_of(Array)
       @obj.keywords.first.should == 'couch'
     end
+  end
+  
+  describe "update attributes without saving" do
+    before(:each) do
+      @question = Question.new(:q => "What is your quest?", :a => "To seek the Holy Grail")
+    end
+    it "should work for attribute= methods" do
+      @question.q.should == "What is your quest?"
+      @question['a'].should == "To seek the Holy Grail"
+      @question.update_attributes_without_saving(:q => "What is your favorite color?", 'a' => "Blue")
+      @question['q'].should == "What is your favorite color?"
+      @question.a.should == "Blue"
+    end
+    
+    it "should also work for attributes= alias" do
+      @question.respond_to?(:attributes=).should be_true
+      @question.attributes = {:q => "What is your favorite color?", 'a' => "Blue"}
+      @question['q'].should == "What is your favorite color?"
+      @question.a.should == "Blue"
+    end
+    
+    it "should flip out if an attribute= method is missing" do
+      lambda {
+        @q.update_attributes_without_saving('foo' => "something", :a => "No green")
+      }.should raise_error(NoMethodError)
+    end
     
+    it "should not change any attributes if there is an error" do
+      lambda {
+        @q.update_attributes_without_saving('foo' => "something", :a => "No green")
+      }.should raise_error(NoMethodError)
+      @question.q.should == "What is your quest?"
+      @question.a.should == "To seek the Holy Grail"
+    end
   end
   
   describe "saved document with casted models" do
@@ -154,6 +209,10 @@ describe CouchRest::CastedModel do
       toy = CatToy.new :name => "Mouse"
       @cat.toys.push(toy)
       @cat.save.should be_true
+      @cat = Cat.get @cat.id
+      @cat.toys.class.should == CastedArray
+      @cat.toys.first.class.should == CatToy
+      @cat.toys.first.should === toy
     end
 
     it "should fail because name is not present" do
@@ -171,7 +230,177 @@ describe CouchRest::CastedModel do
       cat.masters.push Person.new
       cat.should be_valid
     end
+  end
+  
+  describe "calling valid?" do
+    before :each do
+      @cat = Cat.new
+      @toy1 = CatToy.new
+      @toy2 = CatToy.new
+      @toy3 = CatToy.new
+      @cat.favorite_toy = @toy1
+      @cat.toys << @toy2
+      @cat.toys << @toy3
+    end
+    
+    describe "on the top document" do
+      it "should put errors on all invalid casted models" do
+        @cat.should_not be_valid
+        @cat.errors.should_not be_empty
+        @toy1.errors.should_not be_empty
+        @toy2.errors.should_not be_empty
+        @toy3.errors.should_not be_empty
+      end
+      
+      it "should not put errors on valid casted models" do
+        @toy1.name = "Feather"
+        @toy2.name = "Twine" 
+        @cat.should_not be_valid
+        @cat.errors.should_not be_empty
+        @toy1.errors.should be_empty
+        @toy2.errors.should be_empty
+        @toy3.errors.should_not be_empty
+      end
+    end
+    
+    describe "on a casted model property" do
+      it "should only validate itself" do
+        @toy1.should_not be_valid
+        @toy1.errors.should_not be_empty
+        @cat.errors.should be_empty
+        @toy2.errors.should be_empty
+        @toy3.errors.should be_empty
+      end
+    end
+    
+    describe "on a casted model inside a casted collection" do
+      it "should only validate itself" do
+        @toy2.should_not be_valid
+        @toy2.errors.should_not be_empty
+        @cat.errors.should be_empty
+        @toy1.errors.should be_empty
+        @toy3.errors.should be_empty
+      end
+    end
+  end
+  
+  describe "calling new? on a casted model" do
+    before :each do
+      reset_test_db!
+      @cat = Cat.new(:name => 'Sockington')
+      @favorite_toy = CatToy.new(:name => 'Catnip Ball')
+      @cat.favorite_toy = @favorite_toy
+      @cat.toys << CatToy.new(:name => 'Fuzzy Stick')
+    end
     
+    it "should be true on new" do
+      CatToy.new.should be_new
+      CatToy.new.new_record?.should be_true
+    end
+    
+    it "should be true after assignment" do
+      @cat.should be_new
+      @cat.favorite_toy.should be_new
+      @cat.toys.first.should be_new
+    end
+    
+    it "should not be true after create or save" do
+      @cat.create
+      @cat.save
+      @cat.favorite_toy.should_not be_new
+      @cat.toys.first.should_not be_new
+    end
+    
+    it "should not be true after get from the database" do
+      @cat.save
+      @cat = Cat.get(@cat.id)
+      @cat.favorite_toy.should_not be_new
+      @cat.toys.first.should_not be_new
+    end
+    
+    it "should still be true after a failed create or save" do
+      @cat.name = nil
+      @cat.create.should be_false
+      @cat.save.should be_false
+      @cat.favorite_toy.should be_new
+      @cat.toys.first.should be_new
+    end
+  end
+  
+  describe "calling base_doc from a nested casted model" do
+    before :each do
+      @course = Course.new(:title => 'Science 101')
+      @professor = Person.new(:name => 'Professor Plum')
+      @cat = Cat.new(:name => 'Scratchy')
+      @toy1 = CatToy.new
+      @toy2 = CatToy.new
+      @course.professor = @professor
+      @professor.pet = @cat
+      @cat.favorite_toy = @toy1
+      @cat.toys << @toy2
+    end
+    
+    it "should reference the top document for" do
+      @course.base_doc.should === @course
+      @professor.casted_by.should === @course
+      @professor.base_doc.should === @course
+      @cat.base_doc.should === @course
+      @toy1.base_doc.should === @course
+      @toy2.base_doc.should === @course
+    end
+    
+    it "should call setter on top document" do
+      @toy1.base_doc.should_not be_nil
+      @toy1.base_doc.title = 'Tom Foolery'
+      @course.title.should == 'Tom Foolery'
+    end
+    
+    it "should return nil if not yet casted" do
+      person = Person.new
+      person.base_doc.should == nil
+    end
+  end
+  
+  describe "calling base_doc.save from a nested casted model" do
+    before :each do
+      reset_test_db!
+      @cat = Cat.new(:name => 'Snowball')
+      @toy = CatToy.new
+      @cat.favorite_toy = @toy
+    end
+    
+    it "should not save parent document when casted model is invalid" do
+      @toy.should_not be_valid
+      @toy.base_doc.save.should be_false
+      lambda{@toy.base_doc.save!}.should raise_error
+    end
+    
+    it "should save parent document when nested casted model is valid" do
+      @toy.name = "Mr Squeaks"
+      @toy.should be_valid
+      @toy.base_doc.save.should be_true
+      lambda{@toy.base_doc.save!}.should_not raise_error
+    end
   end
   
+  describe "callbacks" do
+    before(:each) do
+      @doc = CastedCallbackDoc.new
+      @model = WithCastedCallBackModel.new
+      @doc.callback_model = @model
+    end
+    
+    describe "validate" do
+      it "should run before_validate before validating" do
+        @model.run_before_validate.should be_nil
+        @model.should be_valid
+        @model.run_before_validate.should be_true
+      end
+      it "should run after_validate after validating" do
+        @model.run_after_validate.should be_nil
+        @model.should be_valid
+        @model.run_after_validate.should be_true
+      end      
+    end
+  end
 end