couchrest_model 1.0.0.beta7

data/lib/couchrest_model.rb

@@ -0,0 +1,56 @@
+
+# require File.join(File.dirname(__FILE__), "couchrest", "extended_document")
+
+gem 'couchrest'
+
+require 'couchrest'
+
+require 'active_support/core_ext'
+require 'active_support/json'
+require 'active_model'
+require "active_model/callbacks"
+require "active_model/conversion"
+require "active_model/deprecated_error_methods"
+require "active_model/errors"
+require "active_model/naming"
+require "active_model/serialization"
+require "active_model/translation"
+require "active_model/validator"
+require "active_model/validations"
+require 'mime/types'
+require "enumerator"
+require "time"
+require 'digest/md5'
+
+require 'bigdecimal' # used in typecast
+require 'bigdecimal/util' # used in typecast
+
+require 'couchrest/model'
+require 'couchrest/model/errors'
+require "couchrest/model/persistence"
+require "couchrest/model/typecast"
+require "couchrest/model/property"
+require "couchrest/model/casted_array"
+require "couchrest/model/properties"
+require "couchrest/model/validations"
+require "couchrest/model/callbacks"
+require "couchrest/model/document_queries"
+require "couchrest/model/views"
+require "couchrest/model/design_doc"
+require "couchrest/model/extended_attachments"
+require "couchrest/model/class_proxy"
+require "couchrest/model/collection"
+require "couchrest/model/attribute_protection"
+require "couchrest/model/attributes"
+require "couchrest/model/associations"
+
+# Monkey patches applied to couchrest
+require "couchrest/model/support/couchrest"
+require "couchrest/model/support/hash"
+
+# Base libraries
+require "couchrest/model/casted_model"
+require "couchrest/model/base"
+
+# Add rails support *after* everything has loaded
+

data/spec/couchrest/assocations_spec.rb

@@ -0,0 +1,213 @@
+# encoding: utf-8
+require File.expand_path('../../spec_helper', __FILE__)
+
+class Client < CouchRest::Model::Base
+  use_database DB
+
+  property :name
+  property :tax_code
+end
+
+class SaleEntry < CouchRest::Model::Base
+  use_database DB
+
+  property :description
+  property :price
+end
+
+class SaleInvoice < CouchRest::Model::Base  
+  use_database DB
+
+  belongs_to :client
+  belongs_to :alternate_client, :class_name => 'Client', :foreign_key => 'alt_client_id'
+
+  collection_of :entries, :class_name => 'SaleEntry'
+
+  property :date, Date
+  property :price, Integer 
+end
+
+
+describe "Assocations" do
+
+  describe "of type belongs to" do
+
+    before :each do
+      @invoice = SaleInvoice.create(:price => "sam", :price => 2000)
+      @client = Client.create(:name => "Sam Lown")
+    end
+
+    it "should create a foreign key property with setter and getter" do
+      @invoice.properties.find{|p| p.name == 'client_id'}.should_not be_nil
+      @invoice.respond_to?(:client_id).should be_true
+      @invoice.respond_to?("client_id=").should be_true
+    end
+
+    it "should set the property and provide object when set" do
+      @invoice.client = @client
+      @invoice.client_id.should eql(@client.id)
+      @invoice.client.should eql(@client)
+    end
+
+    it "should set the attribute, save and return" do
+      @invoice.client = @client
+      @invoice.save
+      @invoice = SaleInvoice.get(@invoice.id)
+      @invoice.client.id.should eql(@client.id)
+    end
+
+    it "should remove the association if nil is provided" do
+      @invoice.client = @client
+      @invoice.client = nil
+      @invoice.client_id.should be_nil
+    end
+
+    it "should not try to search for association if foreign_key is nil" do
+      @invoice.client_id = nil
+      Client.should_not_receive(:get)
+      @invoice.client
+    end
+
+    it "should raise error if class name does not exist" do
+      lambda {
+        class TestBadAssoc < CouchRest::Model::Base
+          belongs_to :test_bad_item
+        end
+      }.should raise_error
+    end
+
+    it "should allow override of foreign key" do
+      @invoice.respond_to?(:alternate_client).should be_true
+      @invoice.respond_to?("alternate_client=").should be_true
+      @invoice.properties.find{|p| p.name == 'alt_client_id'}.should_not be_nil
+    end
+
+    it "should allow override of foreign key and save" do
+      @invoice.alternate_client = @client
+      @invoice.save
+      @invoice = SaleInvoice.get(@invoice.id)
+      @invoice.alternate_client.id.should eql(@client.id)
+    end
+
+  end
+
+  describe "of type collection_of" do
+
+    before(:each) do
+      @invoice = SaleInvoice.create(:price => "sam", :price => 2000)
+      @entries = [
+        SaleEntry.create(:description => 'test line 1', :price => 500),
+        SaleEntry.create(:description => 'test line 2', :price => 500),
+        SaleEntry.create(:description => 'test line 3', :price => 1000)
+      ]
+    end
+
+    it "should create an associated property and collection proxy" do
+      @invoice.respond_to?('entry_ids')
+      @invoice.respond_to?('entry_ids=')
+      @invoice.entries.class.should eql(::CouchRest::CollectionOfProxy)
+    end
+
+    it "should allow replacement of objects" do
+      @invoice.entries = @entries
+      @invoice.entries.length.should eql(3)
+      @invoice.entry_ids.length.should eql(3)
+      @invoice.entries.first.should eql(@entries.first)
+      @invoice.entry_ids.first.should eql(@entries.first.id)
+    end
+
+    it "should allow ids to be set directly and load entries" do
+      @invoice.entry_ids = @entries.collect{|i| i.id}
+      @invoice.entries.length.should eql(3)
+      @invoice.entries.first.should eql(@entries.first)
+    end
+    
+    it "should replace collection if ids replaced" do
+      @invoice.entry_ids = @entries.collect{|i| i.id}
+      @invoice.entries.length.should eql(3) # load once
+      @invoice.entry_ids = @entries[0..1].collect{|i| i.id}
+      @invoice.entries.length.should eql(2)
+    end
+
+    it "should allow forced collection update if ids changed" do
+      @invoice.entry_ids = @entries[0..1].collect{|i| i.id}
+      @invoice.entries.length.should eql(2) # load once
+      @invoice.entry_ids << @entries[2].id
+      @invoice.entry_ids.length.should eql(3)
+      @invoice.entries.length.should eql(2) # cached!
+      @invoice.entries(true).length.should eql(3) 
+    end
+
+    it "should empty arrays when nil collection provided" do
+      @invoice.entries = @entries
+      @invoice.entries = nil
+      @invoice.entry_ids.should be_empty
+      @invoice.entries.should be_empty
+    end
+
+    it "should empty arrays when nil ids array provided" do
+      @invoice.entries = @entries
+      @invoice.entry_ids = nil
+      @invoice.entry_ids.should be_empty
+      @invoice.entries.should be_empty
+    end
+
+    it "should ignore nil entries" do
+      @invoice.entries = [ nil ]
+      @invoice.entry_ids.should be_empty
+      @invoice.entries.should be_empty
+    end
+
+    describe "proxy" do
+
+      it "should ensure new entries to proxy are matched" do
+        @invoice.entries << @entries.first
+        @invoice.entry_ids.first.should eql(@entries.first.id)
+        @invoice.entries.first.should eql(@entries.first)
+        @invoice.entries << @entries[1]
+        @invoice.entries.count.should eql(2)
+        @invoice.entry_ids.count.should eql(2)
+        @invoice.entry_ids.last.should eql(@entries[1].id)
+        @invoice.entries.last.should eql(@entries[1])
+      end
+
+      it "should support push method" do
+        @invoice.entries.push(@entries.first)
+        @invoice.entry_ids.first.should eql(@entries.first.id)
+      end
+
+      it "should support []= method" do
+        @invoice.entries[0] = @entries.first
+        @invoice.entry_ids.first.should eql(@entries.first.id)
+      end
+
+      it "should support unshift method" do
+        @invoice.entries.unshift(@entries.first)
+        @invoice.entry_ids.first.should eql(@entries.first.id)
+        @invoice.entries.unshift(@entries[1])
+        @invoice.entry_ids.first.should eql(@entries[1].id)
+      end
+
+      it "should support pop method" do
+        @invoice.entries.push(@entries.first)
+        @invoice.entries.pop.should eql(@entries.first)
+        @invoice.entries.empty?.should be_true
+        @invoice.entry_ids.empty?.should be_true
+      end
+
+      it "should support shift method" do
+        @invoice.entries.push(@entries[0])
+        @invoice.entries.push(@entries[1])
+        @invoice.entries.shift.should eql(@entries[0])
+        @invoice.entries.first.should eql(@entries[1])
+        @invoice.entry_ids.first.should eql(@entries[1].id)
+      end
+
+
+    end
+  
+
+  end
+
+end
+

data/spec/couchrest/attachment_spec.rb

@@ -0,0 +1,148 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe "Model attachments" do
+  
+  describe "#has_attachment?" do
+    before(:each) do
+      reset_test_db!
+      @obj = Basic.new
+      @obj.save.should be_true
+      @file = File.open(FIXTURE_PATH + '/attachments/test.html')
+      @attachment_name = 'my_attachment'
+      @obj.create_attachment(:file => @file, :name => @attachment_name)
+    end
+  
+    it 'should return false if there is no attachment' do
+      @obj.has_attachment?('bogus').should be_false
+    end
+  
+    it 'should return true if there is an attachment' do
+      @obj.has_attachment?(@attachment_name).should be_true
+    end
+  
+    it 'should return true if an object with an attachment is reloaded' do
+      @obj.save.should be_true
+      reloaded_obj = Basic.get(@obj.id)
+      reloaded_obj.has_attachment?(@attachment_name).should be_true
+    end
+  
+    it 'should return false if an attachment has been removed' do
+      @obj.delete_attachment(@attachment_name)
+      @obj.has_attachment?(@attachment_name).should be_false
+    end
+  end
+
+  describe "creating an attachment" do
+    before(:each) do
+      @obj = Basic.new
+      @obj.save.should be_true
+      @file_ext = File.open(FIXTURE_PATH + '/attachments/test.html')
+      @file_no_ext = File.open(FIXTURE_PATH + '/attachments/README')
+      @attachment_name = 'my_attachment'
+      @content_type = 'media/mp3'
+    end
+  
+    it "should create an attachment from file with an extension" do
+      @obj.create_attachment(:file => @file_ext, :name => @attachment_name)
+      @obj.save.should be_true
+      reloaded_obj = Basic.get(@obj.id)
+      reloaded_obj['_attachments'][@attachment_name].should_not be_nil
+    end
+  
+    it "should create an attachment from file without an extension" do
+      @obj.create_attachment(:file => @file_no_ext, :name => @attachment_name)
+      @obj.save.should be_true
+      reloaded_obj = Basic.get(@obj.id)
+      reloaded_obj['_attachments'][@attachment_name].should_not be_nil
+    end
+  
+    it 'should raise ArgumentError if :file is missing' do
+      lambda{ @obj.create_attachment(:name => @attachment_name) }.should raise_error
+    end
+  
+    it 'should raise ArgumentError if :name is missing' do
+      lambda{ @obj.create_attachment(:file => @file_ext) }.should raise_error
+    end
+  
+    it 'should set the content-type if passed' do
+      @obj.create_attachment(:file => @file_ext, :name => @attachment_name, :content_type => @content_type)
+      @obj['_attachments'][@attachment_name]['content_type'].should == @content_type
+    end
+
+    it "should detect the content-type automatically" do
+      @obj.create_attachment(:file => File.open(FIXTURE_PATH + '/attachments/couchdb.png'), :name => "couchdb.png")
+      @obj['_attachments']['couchdb.png']['content_type'].should == "image/png" 
+    end
+
+    it "should use name to detect the content-type automatically if no file" do
+      file = File.open(FIXTURE_PATH + '/attachments/couchdb.png')
+      file.stub!(:path).and_return("badfilname")
+      @obj.create_attachment(:file => File.open(FIXTURE_PATH + '/attachments/couchdb.png'), :name => "couchdb.png")
+      @obj['_attachments']['couchdb.png']['content_type'].should == "image/png" 
+    end
+
+  end
+
+  describe 'reading, updating, and deleting an attachment' do
+    before(:each) do
+      @obj = Basic.new
+      @file = File.open(FIXTURE_PATH + '/attachments/test.html')
+      @attachment_name = 'my_attachment'
+      @obj.create_attachment(:file => @file, :name => @attachment_name)
+      @obj.save.should be_true
+      @file.rewind
+      @content_type = 'media/mp3'
+    end
+  
+    it 'should read an attachment that exists' do
+      @obj.read_attachment(@attachment_name).should == @file.read
+    end
+  
+    it 'should update an attachment that exists' do
+      file = File.open(FIXTURE_PATH + '/attachments/README')
+      @file.should_not == file
+      @obj.update_attachment(:file => file, :name => @attachment_name)
+      @obj.save
+      reloaded_obj = Basic.get(@obj.id)
+      file.rewind
+      reloaded_obj.read_attachment(@attachment_name).should_not == @file.read
+      reloaded_obj.read_attachment(@attachment_name).should == file.read
+    end
+  
+    it 'should set the content-type if passed' do
+      file = File.open(FIXTURE_PATH + '/attachments/README')
+      @file.should_not == file
+      @obj.update_attachment(:file => file, :name => @attachment_name, :content_type => @content_type)
+      @obj['_attachments'][@attachment_name]['content_type'].should == @content_type
+    end
+  
+    it 'should delete an attachment that exists' do
+      @obj.delete_attachment(@attachment_name)
+      @obj.save
+      lambda{Basic.get(@obj.id).read_attachment(@attachment_name)}.should raise_error
+    end
+  end
+
+  describe "#attachment_url" do
+    before(:each) do
+      @obj = Basic.new
+      @file = File.open(FIXTURE_PATH + '/attachments/test.html')
+      @attachment_name = 'my_attachment'
+      @obj.create_attachment(:file => @file, :name => @attachment_name)
+      @obj.save.should be_true
+    end
+  
+    it 'should return nil if attachment does not exist' do
+      @obj.attachment_url('bogus').should be_nil
+    end
+  
+    it 'should return the attachment URL as specified by CouchDB HttpDocumentApi' do
+      @obj.attachment_url(@attachment_name).should == "#{Basic.database}/#{@obj.id}/#{@attachment_name}"
+    end
+    
+    it 'should return the attachment URI' do
+      @obj.attachment_uri(@attachment_name).should == "#{Basic.database.uri}/#{@obj.id}/#{@attachment_name}"
+    end
+    
+  end
+end

data/spec/couchrest/attribute_protection_spec.rb

@@ -0,0 +1,153 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe "Model Attributes" do
+
+  describe "no declarations" do
+    class NoProtection < CouchRest::Model::Base
+      use_database TEST_SERVER.default_database
+      property :name
+      property :phone
+    end
+
+    it "should not protect anything through new" do
+      user = NoProtection.new(:name => "will", :phone => "555-5555")
+
+      user.name.should == "will"
+      user.phone.should == "555-5555"
+    end
+
+    it "should not protect anything through attributes=" do
+      user = NoProtection.new
+      user.attributes = {:name => "will", :phone => "555-5555"}
+
+      user.name.should == "will"
+      user.phone.should == "555-5555"
+    end
+    
+    it "should recreate from the database properly" do
+      user = NoProtection.new
+      user.name = "will"
+      user.phone = "555-5555"
+      user.save!
+      
+      user = NoProtection.get(user.id)
+      user.name.should == "will"
+      user.phone.should == "555-5555"
+    end
+  end
+
+  describe "Model Base", "accessible flag" do
+    class WithAccessible < CouchRest::Model::Base
+      use_database TEST_SERVER.default_database
+      property :name, :accessible => true
+      property :admin, :default => false
+    end
+
+    it "should recognize accessible properties" do
+      props = WithAccessible.accessible_properties.map { |prop| prop.name}
+      props.should include("name")
+      props.should_not include("admin")
+    end
+
+    it "should protect non-accessible properties set through new" do
+      user = WithAccessible.new(:name => "will", :admin => true) 
+
+      user.name.should == "will"
+      user.admin.should == false
+    end
+
+    it "should protect non-accessible properties set through attributes=" do
+      user = WithAccessible.new
+      user.attributes = {:name => "will", :admin => true}
+
+      user.name.should == "will"
+      user.admin.should == false
+    end
+  end
+
+  describe "Model Base", "protected flag" do
+    class WithProtected < CouchRest::Model::Base
+      use_database TEST_SERVER.default_database
+      property :name
+      property :admin, :default => false, :protected => true
+    end
+
+    it "should recognize protected properties" do
+      props = WithProtected.protected_properties.map { |prop| prop.name}
+      props.should_not include("name")
+      props.should include("admin")
+    end
+
+    it "should protect non-accessible properties set through new" do
+      user = WithProtected.new(:name => "will", :admin => true) 
+
+      user.name.should == "will"
+      user.admin.should == false
+    end
+
+    it "should protect non-accessible properties set through attributes=" do
+      user = WithProtected.new
+      user.attributes = {:name => "will", :admin => true}
+
+      user.name.should == "will"
+      user.admin.should == false
+    end
+  end
+
+  describe "protected flag" do
+    class WithBoth < CouchRest::Model::Base
+      use_database TEST_SERVER.default_database
+      property :name, :accessible => true
+      property :admin, :default => false, :protected => true
+    end
+
+    it "should raise an error when both are set" do
+      lambda { WithBoth.new }.should raise_error 
+    end
+  end
+
+  describe "from database" do
+    class WithProtected < CouchRest::Model::Base
+      use_database TEST_SERVER.default_database
+      property :name
+      property :admin, :default => false, :protected => true
+      view_by :name
+    end
+    
+    before(:each) do
+      @user = WithProtected.new
+      @user.name = "will"
+      @user.admin = true
+      @user.save!
+    end
+
+    def verify_attrs(user)
+      user.name.should  == "will"
+      user.admin.should == true
+    end
+
+    it "Base#get should not strip protected attributes" do
+      reloaded = WithProtected.get( @user.id )
+      verify_attrs reloaded 
+    end
+
+    it "Base#get! should not strip protected attributes" do
+      reloaded = WithProtected.get!( @user.id )
+      verify_attrs reloaded 
+    end
+
+    it "Base#all should not strip protected attributes" do
+      # all creates a CollectionProxy
+      docs = WithProtected.all(:key => @user.id)
+      docs.size.should == 1
+      reloaded = docs.first
+      verify_attrs reloaded 
+    end
+
+    it "views should not strip protected attributes" do
+      docs = WithProtected.by_name(:startkey => "will", :endkey => "will")
+      reloaded = docs.first
+      verify_attrs reloaded 
+    end
+  end
+end