jchris-couchrest 0.9.12 → 0.12.2

data/spec/couchrest/core/model_spec.rb

@@ -3,7 +3,17 @@ require File.dirname(__FILE__) + '/../../spec_helper'
 class Basic < CouchRest::Model
 end
 
-class WithTemplate < CouchRest::Model
+class BasicWithValidation < CouchRest::Model
+  
+  before :save, :validate
+  key_accessor :name
+  
+  def validate
+    throw(:halt, false) unless name
+  end
+end
+
+class WithTemplateAndUniqueID < CouchRest::Model
   unique_id do |model|
     model['important-field']
   end
@@ -12,10 +22,12 @@ class WithTemplate < CouchRest::Model
     'more-template' => [1,2,3]
   })
   key_accessor :preset
+  key_accessor :has_no_default
 end
 
 class Question < CouchRest::Model
   key_accessor :q, :a
+  couchrest_type = 'Question'
 end
 
 class Person < CouchRest::Model
@@ -29,12 +41,13 @@ class Course < CouchRest::Model
   key_accessor :title
   cast :questions, :as => ['Question']
   cast :professor, :as => 'Person'
+  cast :final_test_at, :as => 'Time'
   view_by :title
   view_by :dept, :ducktype => true
 end
 
 class Article < CouchRest::Model
-  use_database CouchRest.database!('http://localhost:5984/couchrest-model-test')
+  use_database CouchRest.database!('http://127.0.0.1:5984/couchrest-model-test')
   unique_id :slug
   
   view_by :date, :descending => true
@@ -60,12 +73,42 @@ class Article < CouchRest::Model
 
   timestamps!
   
-  before(:create, :generate_slug_from_title)  
+  before(:save, :generate_slug_from_title)  
   def generate_slug_from_title
-    self['slug'] = title.downcase.gsub(/[^a-z0-9]/,'-').squeeze('-').gsub(/^\-|\-$/,'')
+    self['slug'] = title.downcase.gsub(/[^a-z0-9]/,'-').squeeze('-').gsub(/^\-|\-$/,'') if new_document?
+  end
+end
+
+class Player < CouchRest::Model
+  unique_id :email
+
+  key_accessor :email, :name, :str, :coord, :int, :con, :spirit, :level, :xp, :points, :coins, :date, :items, :loc
+
+  view_by :name, :descending => true
+  view_by :loc
+  
+  timestamps!
+end
+
+class Event < CouchRest::Model
+  key_accessor :subject, :occurs_at
+
+  cast :occurs_at, :as => 'Time', :send => 'parse'
+end
+
+describe "save bug" do
+  before(:each) do
+    CouchRest::Model.default_database = reset_test_db!
+  end
+  
+  it "should fix" do
+    @p = Player.new
+    @p.email = 'insane@fakestreet.com'
+    @p.save
   end
 end
 
+
 describe CouchRest::Model do
   before(:all) do
     @cr = CouchRest.new(COUCHHOST)
@@ -74,8 +117,8 @@ describe CouchRest::Model do
     @db = @cr.create_db(TESTDB) rescue nil
     @adb = @cr.database('couchrest-model-test')
     @adb.delete! rescue nil
-    CouchRest.database!('http://localhost:5984/couchrest-model-test')
-    CouchRest::Model.default_database = CouchRest.database!('http://localhost:5984/couchrest-test')
+    CouchRest.database!('http://127.0.0.1:5984/couchrest-model-test')
+    CouchRest::Model.default_database = CouchRest.database!('http://127.0.0.1:5984/couchrest-test')
   end
   
   it "should use the default database" do
@@ -134,7 +177,7 @@ describe CouchRest::Model do
     end
   end
   
-  describe "update attributes" do
+  describe "update attributes without saving" do
     before(:each) do
       a = Article.get "big-bad-danger" rescue nil
       a.destroy if a
@@ -160,22 +203,51 @@ describe CouchRest::Model do
       @art['title'].should == "big bad danger"
     end
     
+  end
+  
+  describe "update attributes" do
+    before(:each) do
+      a = Article.get "big-bad-danger" rescue nil
+      a.destroy if a
+      @art = Article.new(:title => "big bad danger")
+      @art.save
+    end
     it "should save" do
       @art['title'].should == "big bad danger"
       @art.update_attributes('date' => Time.now, :title => "super danger")
       loaded = Article.get @art.id
       loaded['title'].should == "super danger"
     end
-    
   end
   
   describe "a model with template values" do
     before(:all) do
-      @tmpl = WithTemplate.new
+      @tmpl = WithTemplateAndUniqueID.new
+      @tmpl2 = WithTemplateAndUniqueID.new(:preset => 'not_value', 'important-field' => '1')
     end
     it "should have fields set when new" do
       @tmpl.preset.should == 'value'
     end
+    it "shouldn't override explicitly set values" do
+      @tmpl2.preset.should == 'not_value'
+    end
+    it "shouldn't override existing documents" do
+      @tmpl2.save
+      tmpl2_reloaded = WithTemplateAndUniqueID.get(@tmpl2.id)
+      @tmpl2.preset.should == 'not_value'
+      tmpl2_reloaded.preset.should == 'not_value'
+    end
+    it "shouldn't fill in existing documents" do
+      @tmpl2.save
+      # If user adds a new default value, shouldn't be retroactively applied to
+      # documents upon fetching
+      WithTemplateAndUniqueID.set_default({:has_no_default => 'giraffe'})
+      
+      tmpl2_reloaded = WithTemplateAndUniqueID.get(@tmpl2.id)
+      @tmpl2.has_no_default.should be_nil
+      tmpl2_reloaded.has_no_default.should be_nil
+      WithTemplateAndUniqueID.new.has_no_default.should == 'giraffe'
+    end
   end
   
   describe "getting a model" do
@@ -213,32 +285,56 @@ describe CouchRest::Model do
       @course["questions"][0].a[0].should == "beast"
     end
   end
-
+  
   describe "finding all instances of a model" do
     before(:all) do
-      WithTemplate.new('important-field' => '1').save
-      WithTemplate.new('important-field' => '2').save
-      WithTemplate.new('important-field' => '3').save
-      WithTemplate.new('important-field' => '4').save
+      WithTemplateAndUniqueID.new('important-field' => '1').save
+      WithTemplateAndUniqueID.new('important-field' => '2').save
+      WithTemplateAndUniqueID.new('important-field' => '3').save
+      WithTemplateAndUniqueID.new('important-field' => '4').save
     end
     it "should make the design doc" do
-      WithTemplate.all
-      d = WithTemplate.design_doc
-      d['views']['all']['map'].should include('WithTemplate')
+      WithTemplateAndUniqueID.all
+      d = WithTemplateAndUniqueID.design_doc
+      d['views']['all']['map'].should include('WithTemplateAndUniqueID')
     end
     it "should find all" do
-      rs = WithTemplate.all 
+      rs = WithTemplateAndUniqueID.all 
       rs.length.should == 4
     end
   end
 
+  describe "finding the first instance of a model" do
+    before(:each) do      
+      @db = reset_test_db!
+      WithTemplateAndUniqueID.new('important-field' => '1').save
+      WithTemplateAndUniqueID.new('important-field' => '2').save
+      WithTemplateAndUniqueID.new('important-field' => '3').save
+      WithTemplateAndUniqueID.new('important-field' => '4').save
+    end
+    it "should make the design doc" do
+      WithTemplateAndUniqueID.all
+      d = WithTemplateAndUniqueID.design_doc
+      d['views']['all']['map'].should include('WithTemplateAndUniqueID')
+    end
+    it "should find first" do
+      rs = WithTemplateAndUniqueID.first
+      rs['important-field'].should == "1"
+    end
+    it "should return nil if no instances are found" do
+      WithTemplateAndUniqueID.all.each {|obj| obj.destroy }
+      WithTemplateAndUniqueID.first.should be_nil
+    end
+  end
+  
   describe "getting a model with a subobject field" do
     before(:all) do
       course_doc = {
         "title" => "Metaphysics 410",
         "professor" => {
           "name" => ["Mark", "Hinchliff"]
-        }
+        },
+        "final_test_at" => "2008/12/19 13:00:00 +0800"
       }
       r = Course.database.save course_doc
       @course = Course.get r['id']
@@ -249,6 +345,21 @@ describe CouchRest::Model do
     it "should instantiate the professor as a person" do
       @course['professor'].last_name.should == "Hinchliff"
     end
+    it "should instantiate the final_test_at as a Time" do
+      @course['final_test_at'].should == Time.parse("2008/12/19 13:00:00 +0800")
+    end
+  end
+
+  describe "cast keys to any type" do
+    before(:all) do
+      event_doc = { :subject => "Some event", :occurs_at => Time.now }
+      e = Event.database.save event_doc
+
+      @event = Event.get e['id']
+    end
+    it "should cast created_at to Time" do
+      @event['occurs_at'].should be_an_instance_of(Time)
+    end
   end
 
   describe "saving a model" do
@@ -277,6 +388,21 @@ describe CouchRest::Model do
       @obj['couchrest-type'].should == 'Basic'
     end
   end
+  
+  describe "saving a model with validation hooks added as extlib" do
+    before(:all) do
+      @obj = BasicWithValidation.new
+    end
+    
+    it "save should return false is the model doesn't save as expected" do
+      @obj.save.should be_false
+    end
+    
+    it "save! should raise and exception if the model doesn't save" do
+      lambda{ @obj.save!}.should raise_error("#{@obj.inspect} failed to save")
+    end
+    
+  end
 
   describe "saving a model with a unique_id configured" do
     before(:each) do
@@ -285,6 +411,11 @@ describe CouchRest::Model do
       Article.database.delete(@old) if @old
     end
     
+    it "should be a new document" do
+      @art.should be_a_new_document
+      @art.title.should be_nil
+    end
+    
     it "should require the title" do
       lambda{@art.save}.should raise_error
       @art.title = 'This is the title'
@@ -321,8 +452,8 @@ describe CouchRest::Model do
 
   describe "saving a model with a unique_id lambda" do
     before(:each) do
-      @templated = WithTemplate.new
-      @old = WithTemplate.get('very-important') rescue nil
+      @templated = WithTemplateAndUniqueID.new
+      @old = WithTemplateAndUniqueID.get('very-important') rescue nil
       @old.destroy if @old
     end
     
@@ -335,7 +466,7 @@ describe CouchRest::Model do
     it "should save with the id" do
       @templated['important-field'] = 'very-important'
       @templated.save.should == true
-      t = WithTemplate.get('very-important')
+      t = WithTemplateAndUniqueID.get('very-important')
       t.should == @templated
     end
     
@@ -344,14 +475,14 @@ describe CouchRest::Model do
       @templated.save.should == true
       @templated['important-field'] = 'not-important'
       @templated.save.should == true
-      t = WithTemplate.get('very-important')
+      t = WithTemplateAndUniqueID.get('very-important')
       t.should == @templated
     end
     
     it "should raise an error when the id is taken" do
       @templated['important-field'] = 'very-important'
       @templated.save.should == true
-      lambda{WithTemplate.new('important-field' => 'very-important').save}.should raise_error
+      lambda{WithTemplateAndUniqueID.new('important-field' => 'very-important').save}.should raise_error
     end
     
     it "should set the id" do
@@ -390,10 +521,14 @@ describe CouchRest::Model do
         written_at += 24 * 3600
       end
     end
+
+    it "should have a design doc" do
+      Article.design_doc["views"]["by_date"].should_not be_nil
+    end
     
-    it "should create the design doc" do
-      Article.by_date rescue nil
-      doc = Article.design_doc
+    it "should save the design doc" do
+      Article.by_date #rescue nil
+      doc = Article.database.get Article.design_doc.id
       doc['views']['by_date'].should_not be_nil
     end
     
@@ -402,7 +537,13 @@ describe CouchRest::Model do
       view['rows'].length.should == 4
     end
     
-    it "should return the matching objects (with descending)" do
+    it "should not include non-Articles" do
+      Article.database.save({"date" => 1})
+      view = Article.by_date :raw => true
+      view['rows'].length.should == 4
+    end
+    
+    it "should return the matching objects (with default argument :descending => true)" do
       articles = Article.by_date
       articles.collect{|a|a.title}.should == @titles.reverse
     end
@@ -417,10 +558,9 @@ describe CouchRest::Model do
     before(:all) do
       Course.database.delete! rescue nil
       @db = @cr.create_db(TESTDB) rescue nil
-      Course.new(:title => 'aaa').save
-      Course.new(:title => 'bbb').save
-      Course.new(:title => 'ddd').save
-      Course.new(:title => 'eee').save
+      %w{aaa bbb ddd eee}.each do |title|
+        Course.new(:title => title).save
+      end
     end
     it "should make the design doc upon first query" do
       Course.by_title 
@@ -442,13 +582,12 @@ describe CouchRest::Model do
       courses = []
       rs = Course.by_title # remove me
       Course.view(:by_title) do |course|
-        # puts "course"
         courses << course
       end
-      # courses.should == 'x'
       courses[0]["doc"]["title"].should =='aaa'
     end
   end
+
   
   describe "a ducktype view" do
     before(:all) do
@@ -494,7 +633,7 @@ describe CouchRest::Model do
       articles[1].title.should == 'not junk'
     end
     it "should be queryable with couchrest options" do
-      articles = Article.by_user_id_and_date :count => 1, :startkey => 'quentin'
+      articles = Article.by_user_id_and_date :limit => 1, :startkey => 'quentin'
       articles.length.should == 1
       articles[0].title.should == "even more interesting"
     end
@@ -527,6 +666,7 @@ describe CouchRest::Model do
     end
   end
 
+  # TODO: moved to Design, delete
   describe "adding a view" do
     before(:each) do
       Article.by_date
@@ -544,10 +684,29 @@ describe CouchRest::Model do
       Article.by_updated_at
       newdocs = Article.database.documents :startkey => "_design/", 
         :endkey => "_design/\u9999"
+      # puts @design_docs.inspect
+      # puts newdocs.inspect
       newdocs["rows"].length.should == @design_docs["rows"].length + 1
     end
   end
 
+  describe "with a lot of designs left around" do
+    before(:each) do
+      Article.by_date
+      Article.view_by :field
+      Article.by_field
+    end
+    it "should clean them up" do
+      Article.view_by :stream
+      Article.by_stream
+      ddocs = Article.all_design_doc_versions
+      ddocs["rows"].length.should > 1
+      Article.cleanup_design_docs!
+      ddocs = Article.all_design_doc_versions
+      ddocs["rows"].length.should == 1
+    end
+  end
+
   describe "destroying an instance" do
     before(:each) do
       @obj = Basic.new
@@ -568,4 +727,129 @@ describe CouchRest::Model do
       lambda{Basic.get(@obj.id)}.should raise_error
     end
   end
+  
+  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

data/spec/couchrest/helpers/pager_spec.rb

@@ -28,7 +28,7 @@ describe CouchRest::Pager do
       end
       @db.bulk_save(@docs)
     end
-    it "should yield total_docs / count times" do
+    it "should yield total_docs / limit times" do
       n = 0
       @pager.all_docs(10) do |doc|
         n += 1
@@ -76,7 +76,7 @@ describe CouchRest::Pager do
     end
     
     it "should have a view" do
-      @db.view('magic/number', :count => 10)['rows'][0]['key'].should == 0
+      @db.view('magic/number', :limit => 10)['rows'][0]['key'].should == 0
     end
     
     it "should yield once per key" do

data/spec/fixtures/attachments/README

@@ -0,0 +1,3 @@
+This is an example README file.
+
+More of the README, whee.

data/spec/spec_helper.rb

@@ -1,6 +1,20 @@
+require "rubygems"
+require "spec" # Satisfies Autotest and anyone else not using the Rake tasks
+
 require File.dirname(__FILE__) + '/../lib/couchrest'
 
-FIXTURE_PATH = File.dirname(__FILE__) + '/fixtures'
+unless defined?(FIXTURE_PATH)
+  FIXTURE_PATH = File.dirname(__FILE__) + '/fixtures' 
+  SCRATCH_PATH = File.dirname(__FILE__) + '/tmp'
+
+  COUCHHOST = "http://127.0.0.1:5984"
+  TESTDB = 'couchrest-test'
+end
 
-COUCHHOST = "http://localhost:5984"
-TESTDB = 'couchrest-test'
+def reset_test_db!
+  cr = CouchRest.new(COUCHHOST)
+  db = cr.database(TESTDB)
+  db.delete! rescue nil
+  db = cr.create_db(TESTDB) rescue nin
+  db
+end

data/utils/remap.rb

@@ -2,11 +2,11 @@ require 'rubygems'
 require 'couchrest'
 
 # set the source db and map view
-source = CouchRest.new("http://localhost:5984").database('source-db')
+source = CouchRest.new("http://127.0.0.1:5984").database('source-db')
 source_view = 'mydesign/view-map'
 
 # set the target db
-target = CouchRest.new("http://localhost:5984").database('target-db')
+target = CouchRest.new("http://127.0.0.1:5984").database('target-db')
 
 
 pager = CouchRest::Pager.new(source)

data/utils/subset.rb

@@ -5,10 +5,10 @@ require 'couchrest'
 # use it to create a smaller dataset on which to prototype views.
 
 # specify the source database
-source = CouchRest.new("http://localhost:5984").database('source-db')
+source = CouchRest.new("http://127.0.0.1:5984").database('source-db')
 
 # specify the target database
-target = CouchRest.new("http://localhost:5984").database('target-db')
+target = CouchRest.new("http://127.0.0.1:5984").database('target-db')
 
 # pager efficiently yields all view rows
 pager = CouchRest::Pager.new(source)