couch_potato 0.2.12

data/spec/create_spec.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "create" do
+  before(:all) do
+    recreate_db
+  end
+  describe "succeeds" do
+    it "should store the class" do
+      @comment = Comment.new :title => 'my_title'
+      CouchPotato.database.save_document! @comment
+      CouchPotato.couchrest_database.get(@comment.id)['ruby_class'].should == 'Comment'
+    end
+  end
+  describe "fails" do
+    it "should not store anything" do
+      @comment = Comment.new
+      CouchPotato.database.save_document @comment
+      CouchPotato.couchrest_database.documents['rows'].should be_empty
+    end
+  end
+end
+

data/spec/custom_view_spec.rb

@@ -0,0 +1,149 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class Build
+  include CouchPotato::Persistence
+
+  property :state
+  property :time
+
+  view :timeline, :key => :time
+  view :count, :key => :time, :reduce => true
+  view :minimal_timeline, :key => :time, :properties => [:state], :type => :properties
+  view :key_array_timeline, :key => [:time, :state]
+  view :custom_timeline, :map => "function(doc) { emit(doc._id, {state: 'custom_' + doc.state}); }", :type => :custom
+  view :custom_timeline_returns_docs, :map => "function(doc) { emit(doc._id, null); }", :include_docs => true, :type => :custom
+  view :custom_with_reduce, :map => "function(doc) {if(doc.foreign_key) {emit(doc.foreign_key, 1);} else {emit(doc.id, 1)}}", :reduce => "function(key, values) {return({\"count\": sum(values)});}", :group => true, :type => :custom
+  view :raw, :type => :raw, :map => "function(doc) {emit(doc._id, doc.state)}"
+  view :filtered_raw, :type => :raw, :map => "function(doc) {emit(doc._id, doc.state)}", :results_filter => lambda{|res| res['rows'].map{|row| row['value']}}
+  view :with_view_options, :group => true, :key => :time
+end
+
+describe 'view' do
+  before(:each) do
+    recreate_db
+  end
+
+  it "should return instances of the class" do
+    CouchPotato.database.save_document Build.new(:state => 'success', :time => '2008-01-01')
+    results = CouchPotato.database.view(Build.timeline)
+    results.map(&:class).should == [Build]
+  end
+
+  it "should pass the view options to the view query" do
+    query = mock 'query'
+    CouchPotato::View::ViewQuery.stub!(:new).and_return(query)
+    query.should_receive(:query_view!).with(hash_including(:key => 1)).and_return('rows' => [])
+    CouchPotato.database.view Build.timeline(:key => 1)
+  end
+
+  it "should not return documents that don't have a matching ruby_class" do
+    CouchPotato.couchrest_database.save_doc({:time => 'x'})
+    CouchPotato.database.view(Build.timeline).should == []
+  end
+
+  it "should count documents" do
+    CouchPotato.database.save_document Build.new(:state => 'success', :time => '2008-01-01')
+    CouchPotato.database.view(Build.count(:reduce => true)).should == 1
+  end
+
+  it "should count zero documents" do
+    CouchPotato.database.view(Build.count(:reduce => true)).should == 0
+  end
+
+  describe "properties defined" do
+    it "should assign the configured properties" do
+      CouchPotato.couchrest_database.save_doc(:state => 'success', :time => '2008-01-01', :ruby_class => 'Build')
+      CouchPotato.database.view(Build.minimal_timeline).first.state.should == 'success'
+    end
+
+    it "should not assign the properties not configured" do
+      CouchPotato.couchrest_database.save_doc(:state => 'success', :time => '2008-01-01', :ruby_class => 'Build')
+      CouchPotato.database.view(Build.minimal_timeline).first.time.should be_nil
+    end
+
+    it "should assign the id even if it is not configured" do
+      id = CouchPotato.couchrest_database.save_doc(:state => 'success', :time => '2008-01-01', :ruby_class => 'Build')['id']
+      CouchPotato.database.view(Build.minimal_timeline).first._id.should == id
+    end
+  end
+
+  describe "no properties defined" do
+    it "should assign all properties to the objects by default" do
+      id = CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01', :ruby_class => 'Build'})['id']
+      result = CouchPotato.database.view(Build.timeline).first
+      result.state.should == 'success'
+      result.time.should == '2008-01-01'
+      result._id.should == id
+    end
+  end
+
+  describe "map function given" do
+    it "should still return instances of the class" do
+      CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})
+      CouchPotato.database.view(Build.custom_timeline).map(&:class).should == [Build]
+    end
+
+    it "should assign the properties from the value" do
+      CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})
+      CouchPotato.database.view(Build.custom_timeline).map(&:state).should == ['custom_success']
+    end
+
+    it "should assign the id" do
+      doc = CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})
+      CouchPotato.database.view(Build.custom_timeline).map(&:_id).should == [doc['id']]
+    end
+
+    it "should leave the other properties blank" do
+      CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})
+      CouchPotato.database.view(Build.custom_timeline).map(&:time).should == [nil]
+    end
+    
+    describe "that returns null documents" do
+      it "should return instances of the class" do
+        CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})
+        CouchPotato.database.view(Build.custom_timeline_returns_docs).map(&:class).should == [Build]
+      end
+
+      it "should assign the properties from the value" do
+        CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})
+        CouchPotato.database.view(Build.custom_timeline_returns_docs).map(&:state).should == ['success']
+      end
+    end
+    
+    describe "additional reduce function given" do
+      it "should still assign the id" do
+        doc = CouchPotato.couchrest_database.save_doc({})
+        CouchPotato.couchrest_database.save_doc({:foreign_key => doc['id']})
+        CouchPotato.database.view(Build.custom_with_reduce).map(&:_id).should == [doc['id']]
+        
+      end
+    end
+  end
+
+  describe "with array as key" do
+    it "should create a map function with the composite key" do
+      CouchPotato::View::ViewQuery.should_receive(:new).with(anything, anything, anything, string_matching(/emit\(\[doc\['time'\], doc\['state'\]\]/), anything).and_return(stub('view query').as_null_object)
+      CouchPotato.database.view Build.key_array_timeline
+    end
+  end
+
+  describe "raw view" do
+    it "should return the raw data" do
+      CouchPotato.database.save_document Build.new(:state => 'success', :time => '2008-01-01')
+      CouchPotato.database.view(Build.raw)['rows'][0]['value'].should == 'success'
+    end
+
+    it "should return filtred raw data" do
+      CouchPotato.database.save_document Build.new(:state => 'success', :time => '2008-01-01')
+      CouchPotato.database.view(Build.filtered_raw).should == ['success']
+    end
+
+    it "should pass view options declared in the view declaration to the query" do
+     view_query = mock 'view_query'
+     CouchPotato::View::ViewQuery.stub!(:new).and_return(view_query)
+     view_query.should_receive(:query_view!).with(hash_including(:group => true)).and_return({'rows' => []})
+     CouchPotato.database.view(Build.with_view_options)
+    end
+  end
+
+end

data/spec/default_property_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class Test
+  include CouchPotato::Persistence
+
+  property :test, :default => 'Test value'
+  property :complex, :default => []
+end
+
+describe 'default properties' do
+  before(:all) do
+    recreate_db
+  end
+
+  it "should use the default value if nothing is supplied" do
+    t = Test.new
+
+    t.test.should == 'Test value'
+  end
+
+  it "should persist the default value if nothing is supplied" do
+    t = Test.new
+    CouchPotato.database.save_document! t
+
+    t = CouchPotato.database.load_document t.id
+    t.test.should == 'Test value'
+  end
+
+  it "should not have the same default for two instances of the object" do
+    t = Test.new
+    t2 = Test.new
+    t.complex.object_id.should_not == t2.complex.object_id
+  end
+end

data/spec/destroy_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'destroy' do
+  before(:all) do
+    recreate_db
+  end
+  
+  before(:each) do
+    @comment = Comment.new :title => 'title'
+    CouchPotato.database.save_document! @comment
+    @comment_id = @comment.id
+    CouchPotato.database.destroy_document @comment
+  end
+  
+  it "should unset the id" do
+    @comment._id.should be_nil
+  end
+  
+  it "should unset the revision" do
+    @comment._rev.should be_nil
+  end
+  
+  it "should remove the document from the database" do
+    lambda {
+      CouchPotato.couchrest_database.get(@comment_id).should
+    }.should raise_error(RestClient::ResourceNotFound)
+  end
+  
+end

data/spec/fixtures/address.rb

@@ -0,0 +1,9 @@
+class Address
+  include CouchPotato::Persistence
+  
+  property :street
+  property :city
+  property :state
+  property :zip
+  property :country
+end

data/spec/fixtures/person.rb

@@ -0,0 +1,6 @@
+class Person
+  include CouchPotato::Persistence
+  
+  property :name
+  property :ship_address, :type => Address
+end

data/spec/property_spec.rb

@@ -0,0 +1,101 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.join(File.dirname(__FILE__), 'fixtures', 'address')
+require File.join(File.dirname(__FILE__), 'fixtures', 'person')
+
+class Watch
+  include CouchPotato::Persistence
+  
+  property :time, :type => Time
+  property :overwritten_read
+  property :overwritten_write
+  
+  def overwritten_read
+    super.to_s
+  end
+  
+  def overwritten_write=(value)
+    super value.to_s
+  end
+end
+
+
+describe 'properties' do
+  before(:all) do
+    recreate_db
+  end
+  
+  it "should allow me to overwrite read accessor and call super" do
+    Watch.new(:overwritten_read => 1).overwritten_read.should == '1'
+  end
+  
+  it "should allow me to overwrite write accessor and call super" do
+    Watch.new(:overwritten_write => 1).overwritten_write.should == '1'
+  end
+  
+  it "should return the property names" do
+    Comment.property_names.should == [:created_at, :updated_at, :title]
+  end
+  
+  it "should persist a string" do
+    c = Comment.new :title => 'my title'
+    CouchPotato.database.save_document! c
+    c = CouchPotato.database.load_document c.id
+    c.title.should == 'my title'
+  end
+  
+  it "should persist a number" do
+    c = Comment.new :title => 3
+    CouchPotato.database.save_document! c
+    c = CouchPotato.database.load_document c.id
+    c.title.should == 3
+  end
+  
+  it "should persist a hash" do
+    c = Comment.new :title => {'key' => 'value'}
+    CouchPotato.database.save_document! c
+    c = CouchPotato.database.load_document c.id
+    c.title.should == {'key' => 'value'}
+  end
+  
+  it "should persist a Time object" do
+    w = Watch.new :time => Time.now
+    CouchPotato.database.save_document! w
+    w = CouchPotato.database.load_document w.id
+    w.time.year.should == Time.now.year
+  end
+  
+  it "should persist an object" do
+    p = Person.new :name => 'Bob'
+    a = Address.new :city => 'Denver'
+    p.ship_address = a
+    CouchPotato.database.save_document! p
+    p = CouchPotato.database.load_document p.id
+    p.ship_address.should === a
+  end
+  
+  it "should persist null for a null " do
+    p = Person.new :name => 'Bob'
+    p.ship_address = nil
+    CouchPotato.database.save_document! p
+    p = CouchPotato.database.load_document p.id
+    p.ship_address.should be_nil
+  end
+  
+  describe "predicate" do
+    it "should return true if property set" do
+      Comment.new(:title => 'title').title?.should be_true
+    end
+    
+    it "should return false if property nil" do
+      Comment.new.title?.should be_false
+    end
+    
+    it "should return false if property false" do
+      Comment.new(:title => false).title?.should be_false
+    end
+    
+    it "should return false if property blank" do
+      Comment.new(:title => '').title?.should be_false
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'spec'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'couch_potato'
+
+CouchPotato::Config.database_name = 'couch_potato_test'
+
+
+class Comment
+  include CouchPotato::Persistence
+
+  validates_presence_of :title
+
+  property :title
+end
+
+def recreate_db
+  CouchPotato.couchrest_database.delete! rescue nil
+  CouchPotato.couchrest_database.server.create_db CouchPotato::Config.database_name
+end
+recreate_db
+
+Spec::Matchers.define :string_matching do |regex|
+  match do |string|
+    string =~ regex
+  end
+end

data/spec/unit/attributes_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+class Plant
+  include CouchPotato::Persistence
+  property :leaf_count
+end
+
+describe "attributes" do
+  
+  describe 'attributes=' do
+    it "should assign the attributes" do
+      plant = Plant.new 
+      plant.attributes = {:leaf_count => 1}
+      plant.leaf_count.should == 1
+    end
+  end
+
+  describe "attributes" do
+    it "should return the attributes" do
+      plant = Plant.new(:leaf_count => 1)
+      plant.attributes.should == {:leaf_count => 1, :created_at => nil, :updated_at => nil}
+    end
+  end
+  
+  # useful when loading models from custom views
+  describe "accessing ghost attributes" do
+    it "should allow me to access attributes that are in the couchdb document but not defined as a property" do
+      plant = Plant.json_create({"ruby_class" => "Plant", "color" => "red", "leaf_count" => 1})
+      plant.color.should == 'red'
+    end
+    
+    it "should raise a no method error when trying to read attributes that are not in the document" do
+      plant = Plant.json_create({"ruby_class" => "Plant", "leaf_count" => 1})
+      lambda do
+        plant.length
+      end.should raise_error(NoMethodError)
+    end
+    
+    it "should raise a no method error if the document hasn't been loaded from the database" do
+      plant = Plant.new
+      lambda do
+        plant.length
+      end.should raise_error(NoMethodError, /undefined method `length'/)
+    end
+  end
+
+end
+