mattetti-couchrest 0.14.2 → 0.15

data/README.md

@@ -59,13 +59,7 @@ Creating and Querying Views:
 
 ## CouchRest::Model
 
-CouchRest::Model is a module designed along the lines of DataMapper::Resource.
-By subclassing, suddenly you get all sorts of powerful sugar, so that working
-with CouchDB in your Rails or Merb app is no harder than working with the
-standard SQL alternatives. See the CouchRest::Model documentation for an
-example article class that illustrates usage.
-
-CouchRest::Model will be removed from this package.
+CouchRest::Model has been deprecated and replaced by CouchRest::ExtendedDocument
 
 
 ## CouchRest::ExtendedDocument

data/examples/model/example.rb

@@ -1,31 +1,38 @@
-require 'rubygems'
-require 'couchrest'
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'couchrest')
 
 def show obj
   puts obj.inspect
   puts
 end
 
-CouchRest::Model.default_database = CouchRest.database!('couchrest-model-example')
+SERVER = CouchRest.new
+SERVER.default_database = 'couchrest-extendeddoc-example'
 
-class Author < CouchRest::Model
-  key_accessor :name
+class Author < CouchRest::ExtendedDocument
+  use_database SERVER.default_database
+  property :name
+  
   def drink_scotch
     puts "... glug type glug ... I'm #{name} ... type glug glug ..."
   end
 end
 
-class Post < CouchRest::Model
-  key_accessor :title, :body, :author
-
-  cast :author, :as => 'Author'
+class Post < CouchRest::ExtendedDocument
+  use_database SERVER.default_database
+  
+  property :title
+  property :body
+  property :author, :cast_as => 'Author'
 
   timestamps!
 end
 
-class Comment < CouchRest::Model
-  cast :commenter, :as => 'Author'
-
+class Comment < CouchRest::ExtendedDocument
+  use_database SERVER.default_database
+  
+  property :commenter, :cast_as => 'Author'
+  timestamps!
+  
   def post= post
     self["post_id"] = post.id
   end
@@ -33,7 +40,6 @@ class Comment < CouchRest::Model
     Post.get(self['post_id']) if self['post_id']
   end
   
-  timestamps!
 end
 
 puts "Act I: CRUD"

data/lib/couchrest/core/database.rb

@@ -279,7 +279,7 @@ module CouchRest
 
     private
     
-    def uri_for_attachment doc, name
+    def uri_for_attachment(doc, name)
       if doc.is_a?(String)
         puts "CouchRest::Database#fetch_attachment will eventually require a doc as the first argument, not a doc.id"
         docid = doc

data/lib/couchrest/more/extended_document.rb

@@ -31,6 +31,7 @@ module CouchRest
     
     def initialize(keys={})
       apply_defaults # defined in CouchRest::Mixins::Properties
+      keys ||= {}
       super
       cast_keys      # defined in CouchRest::Mixins::Properties
       unless self['_id'] && self['_rev']
@@ -100,7 +101,7 @@ module CouchRest
     # missing. In case of error, no attributes are changed.    
     def update_attributes_without_saving(hash)
       hash.each do |k, v|
-        raise NoMethodError, "#{k}= method not available, use key_accessor or key_writer :#{k}" unless self.respond_to?("#{k}=")
+        raise NoMethodError, "#{k}= method not available, use property :#{k}" unless self.respond_to?("#{k}=")
       end      
       hash.each do |k, v|
         self.send("#{k}=",v)

data/lib/couchrest/more/property.rb

@@ -18,6 +18,8 @@ module CouchRest
       def parse_type(type)
         if type.nil?
           @type = 'String'
+        elsif type.is_a?(Array) && type.empty?
+          @type = 'Array'
         else
           @type = type.is_a?(Array) ? [type.first.to_s] : type.to_s
         end

data/lib/couchrest.rb

@@ -27,7 +27,7 @@ require 'couchrest/monkeypatches'
 
 # = CouchDB, close to the metal
 module CouchRest
-  VERSION = '0.14.2'
+  VERSION = '0.15'
   
   autoload :Server,       'couchrest/core/server'
   autoload :Database,     'couchrest/core/database'

data/spec/couchrest/core/database_spec.rb

@@ -704,7 +704,7 @@ describe CouchRest::Database do
   describe "creating a database" do
     before(:each) do
       @db = @cr.database('couchrest-test-db_to_create')
-      @db.delete!
+      @db.delete! if @cr.databases.include?('couchrest-test-db_to_create')
     end
     
     it "should just work fine" do

data/spec/couchrest/more/extended_doc_attachment_spec.rb

@@ -0,0 +1,129 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe "ExtendedDocument attachments" do
+  
+  describe "#has_attachment?" do
+    before(:each) do
+      @obj = Basic.new
+      @obj.save.should == 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 == 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 == 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 == 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
+  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 == 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 se 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 == 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
+  end
+end