couch_potato-rails2 0.5.6

data/spec/create_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe "create" do
+  before(:each) 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).send(JSON.create_id).should == 'Comment'
+    end
+    
+    it "should persist a given created_at" do
+      @comment = Comment.new :created_at => Time.parse('2010-01-02 12:34:48 +0000'), :title => '-'
+      CouchPotato.database.save_document! @comment
+      CouchPotato.couchrest_database.get(@comment.id).created_at.should == Time.parse('2010-01-02 12:34:48 +0000')
+    end
+    
+    it "should persist a given updated_at" do
+      @comment = Comment.new :updated_at => Time.parse('2010-01-02 12:34:48 +0000'), :title => '-'
+      CouchPotato.database.save_document! @comment
+      CouchPotato.couchrest_database.get(@comment.id).updated_at.should == Time.parse('2010-01-02 12:34:48 +0000')
+    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,239 @@
+require '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 :custom_count_with_reduce, :map => "function(doc) {if(doc.foreign_key) {emit(doc.foreign_key, 1);} else {emit(doc._id, 1)}}", :reduce => "function(key, values) {return(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
+
+class CustomBuild < Build
+end
+
+describe 'view' do
+  before(:each) do
+    recreate_db
+    @db = CouchPotato.database
+  end
+
+  it "should return instances of the class" do
+    @db.save_document Build.new(:state => 'success', :time => '2008-01-01')
+    results = @db.view(Build.timeline)
+    results.map(&:class).should == [Build]
+  end
+  
+  it "should return the ids if there document was not included" do
+    build = Build.new(:state => 'success', :time => '2008-01-01')
+    @db.save_document build
+    results = @db.view(Build.timeline(:include_docs => false))
+    results.should == [build.id]
+  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' => [])
+    @db.view Build.timeline(:key => 1)
+  end
+
+  it "should not return documents that don't have a matching JSON.create_id" do
+    CouchPotato.couchrest_database.save_doc({:time => 'x'})
+    @db.view(Build.timeline).should == []
+  end
+
+  it "should count documents" do
+    @db.save_document! Build.new(:state => 'success', :time => '2008-01-01')
+    @db.view(Build.count(:reduce => true)).should == 1
+  end
+
+  it "should count zero documents" do
+    @db.view(Build.count(:reduce => true)).should == 0
+  end
+  
+  it "should return the total_rows" do
+    @db.save_document! Build.new(:state => 'success', :time => '2008-01-01')
+    @db.view(Build.count(:reduce => false)).total_rows.should == 1
+  end
+  
+  describe "with multiple keys" do
+    it "should return the documents with matching keys" do
+      build = Build.new(:state => 'success', :time => '2008-01-01')
+      @db.save! build
+      @db.view(Build.timeline(:keys => ['2008-01-01'])).should == [build]
+    end
+    
+    it "should not return documents with non-matching keys" do
+      build = Build.new(:state => 'success', :time => '2008-01-01')
+      @db.save! build
+      @db.view(Build.timeline(:keys => ['2008-01-02'])).should be_empty
+    end
+  end
+
+  describe "properties defined" do
+    it "should assign the configured properties" do
+      CouchPotato.couchrest_database.save_doc(:state => 'success', :time => '2008-01-01', JSON.create_id.to_sym => 'Build')
+      @db.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', JSON.create_id.to_sym => 'Build')
+      @db.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', JSON.create_id.to_sym => 'Build')['id']
+      @db.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', JSON.create_id.to_sym => 'Build'})['id']
+      result = @db.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'})
+      @db.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'})
+      @db.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'})
+      @db.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'})
+      @db.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'})
+        @db.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'})
+        @db.view(Build.custom_timeline_returns_docs).map(&:state).should == ['success']
+      end
+      
+      it "should still return instance of class if document included JSON.create_id" do
+        CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01', JSON.create_id.to_sym => "Build"})
+        view_data = @db.view(Build.custom_timeline_returns_docs)
+        view_data.map(&:class).should == [Build]
+        view_data.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']})
+        @db.view(Build.custom_with_reduce).map(&:_id).should == [doc['id']]
+      end
+      
+      describe "when the additional reduce function is a typical count" do
+        it "should parse the reduce count" do
+          doc = CouchPotato.couchrest_database.save_doc({})
+          CouchPotato.couchrest_database.save_doc({:foreign_key => doc['id']})
+          @db.view(Build.custom_count_with_reduce(:reduce => true)).should == 2
+        end
+      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) do |db, design_name, view, list|
+        view['key_array_timeline'][:map].should match(/emit\(\[doc\['time'\], doc\['state'\]\]/)
+        
+        stub('view query', :query_view! => {'rows' => []})
+      end
+      @db.view Build.key_array_timeline
+    end
+  end
+
+  describe "raw view" do
+    it "should return the raw data" do
+      @db.save_document Build.new(:state => 'success', :time => '2008-01-01')
+      @db.view(Build.raw)['rows'][0]['value'].should == 'success'
+    end
+
+    it "should return filtred raw data" do
+      @db.save_document Build.new(:state => 'success', :time => '2008-01-01')
+      @db.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' => []})
+     @db.view(Build.with_view_options)
+    end
+  end
+
+  describe "inherited views" do
+    it "should support parent views for objects of the subclass" do
+      @db.save_document CustomBuild.new(:state => 'success', :time => '2008-01-01')
+      @db.view(CustomBuild.timeline).size.should == 1
+      @db.view(CustomBuild.timeline).first.should be_kind_of(CustomBuild)
+    end
+  end
+  
+  describe "list functions" do
+    class Coworker
+      include CouchPotato::Persistence
+      
+      property :name
+      
+      view :all_with_list, :key => :name, :list => :append_doe
+      view :all, :key => :name
+      
+      list :append_doe, <<-JS
+        function(head, req) {
+          var row;
+          send('{"rows": [');
+          while(row = getRow()) {
+            row.doc.name = row.doc.name + ' doe';
+            send(JSON.stringify(row));
+          };
+          send(']}');
+        }
+      JS
+    end
+    
+    it "should use the list function declared at class level" do
+      @db.save! Coworker.new(:name => 'joe')
+      @db.view(Coworker.all_with_list).first.name.should == 'joe doe'
+    end
+    
+    it "should use the list function passed at runtime" do
+      @db.save! Coworker.new(:name => 'joe')
+      @db.view(Coworker.all(:list => :append_doe)).first.name.should == 'joe doe'
+    end
+    
+  end
+end

data/spec/default_property_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+class Test
+  include CouchPotato::Persistence
+
+  property :test, :default => 'Test value'
+  property :complex, :default => [1, 2, 3]
+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
+  
+  it "should not return the default value when the actual value is empty" do
+    t = Test.new(:complex => []).complex.should == []
+  end
+end

data/spec/destroy_spec.rb

@@ -0,0 +1,29 @@
+require '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,10 @@
+class Address
+  include CouchPotato::Persistence
+  
+  property :street
+  property :city
+  property :state
+  property :zip
+  property :country
+  property :verified, :type => :boolean
+end

data/spec/fixtures/person.rb

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

data/spec/property_spec.rb

@@ -0,0 +1,323 @@
+require 'spec_helper'
+require 'fixtures/address'
+require 'fixtures/person'
+
+class Watch
+  include CouchPotato::Persistence
+  
+  property :time, :type => Time
+  property :date, :type => Date
+  property :overwritten_read
+  property :overwritten_write
+  
+  def overwritten_read
+    super.to_s
+  end
+  
+  def overwritten_write=(value)
+    super value.to_s
+  end
+end
+
+class CuckooClock < Watch
+  property :cuckoo
+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
+  
+  def it_should_persist value
+    c = Comment.new :title => value
+    CouchPotato.database.save_document! c
+    c = CouchPotato.database.load_document c.id
+    c.title.should == value
+  end
+
+  it "should persist a child class" do
+    it_should_persist Child.new('text' => 'some text')
+  end
+
+  it "should persist a hash with a child class" do
+    it_should_persist 'child' => Child.new('text' => 'some text')
+  end
+
+  it "should persist an array with a child class" do
+    it_should_persist [Child.new('text' => 'some text')]
+  end
+
+  it "should persist something very complex" do
+    something_very_complex = [
+      [
+        [
+          {
+            'what' => [
+              {
+                'ever' => Child.new('text' => 'some text')
+              }
+            ],
+            'number' => 3
+          },
+          "string"
+        ],
+        Child.new('text' => 'nothing')
+      ]
+    ]
+    it_should_persist something_very_complex
+  end
+  
+  it "should persist an object" do
+    p = Person.new
+    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
+    p.ship_address = nil
+    CouchPotato.database.save_document! p
+    p = CouchPotato.database.load_document p.id
+    p.ship_address.should be_nil
+  end
+  
+  it "should actually pass the null value down in the JSON document " do
+    p = Person.new
+    p.ship_address = nil
+    db = mock(:database)
+    db.should_receive(:save_doc).with do |attributes|
+      attributes.has_key?(:ship_address).should == true
+    end.and_return({})
+    CouchPotato.database.stub(:couchrest_database).and_return(db)
+    CouchPotato.database.save_document! p
+  end
+
+  it "should persist false for a false" do
+    p = Person.new
+    p.ship_address = false
+    CouchPotato.database.save_document! p
+    p = CouchPotato.database.load_document p.id
+    p.ship_address.should be_false
+  end
+  
+  describe "time properties" do
+    it "should persist a Time as utc" do
+      time = Time.now
+      w = Watch.new :time => time
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.time.to_s.should == time.utc.to_s
+    end
+    
+    it "should parse a string and persist it as utc time" do
+      w = Watch.new :time => '2009-01-01 13:25 +0100'
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.time.should be_a(Time)
+      w.time.should == Time.parse('2009-01-01 12:25 +0000')
+    end
+    
+    it "should store nil" do
+      w = Watch.new :time => nil
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.time.should be_nil
+    end
+    
+    it "should store an empty string as nil" do
+      w = Watch.new :time => ''
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.time.should be_nil
+    end
+  end
+  
+  describe "date properties" do
+    it "should persist a date" do
+      date = Date.today
+      w = Watch.new :date => date
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.date.should == date
+    end
+    
+    it "should parse a string and persist it as a date" do
+      w = Watch.new :date => '2009-01-10'
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.date.should == Date.parse('2009-01-10')
+    end
+    
+    it "should store nil" do
+      w = Watch.new :date => nil
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.date.should be_nil
+    end
+    
+    it "should store an empty string as nil" do
+      w = Watch.new :date => ''
+      CouchPotato.database.save_document! w
+      w = CouchPotato.database.load_document w.id
+      w.date.should be_nil
+    end
+  end
+  
+  describe "boolean properties" do
+    it "should persist '0' as false" do
+      a = Address.new
+      a.verified = '0'
+      CouchPotato.database.save_document! a
+      a = CouchPotato.database.load_document a.id
+      a.verified.should be_false
+    end
+    
+    it "should persist 0 as false" do
+      a = Address.new
+      a.verified = 0
+      CouchPotato.database.save_document! a
+      a = CouchPotato.database.load_document a.id
+      a.verified.should be_false
+    end
+    
+    it "should persist 'false' as false" do
+      a = Address.new
+      a.verified = 'false'
+      CouchPotato.database.save_document! a
+      a = CouchPotato.database.load_document a.id
+      a.verified.should be_false
+    end
+    
+    it "should persist '1' as true" do
+      a = Address.new
+      a.verified = '1'
+      CouchPotato.database.save_document! a
+      a = CouchPotato.database.load_document a.id
+      a.verified.should be_true
+    end
+    
+    it "should persist 1 as true" do
+      a = Address.new
+      a.verified = 1
+      CouchPotato.database.save_document! a
+      a = CouchPotato.database.load_document a.id
+      a.verified.should be_true
+    end
+    
+    it "should leave nil as nil" do
+      a = Address.new
+      a.verified = nil
+      CouchPotato.database.save_document! a
+      a = CouchPotato.database.load_document a.id
+      a.verified.should be_nil
+    end
+  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
+  
+  describe "with subclasses" do
+    it "should include properties of superclasses" do
+      CuckooClock.properties.map(&:name).should include(:time)
+      CuckooClock.properties.map(&:name).should include(:cuckoo)
+    end
+    
+    it "should return attributes of superclasses" do
+      clock = CuckooClock.new(:time => Time.now, :cuckoo => 'bavarian')
+      clock.attributes[:time].should_not == nil
+      clock.attributes[:cuckoo].should == 'bavarian'
+    end
+  end
+  
+  describe "inspecting an object" do
+    let(:comment) do
+      comment = Comment.new(:title => 'title')
+      comment.instance_eval do
+        @_id = "123456abcdef"
+        @_rev = "1-654321fedcba"
+      end
+      comment
+    end
+    
+    it "should not include change-tracking variables" do
+      comment.inspect.should_not include('title_was')
+    end
+    
+    it "should include the normal persistent variables" do
+      comment.inspect.should include('title: "title"')
+    end
+    
+    it "should include the id" do
+      comment.inspect.should include(%Q{_id: "123456abcdef",})
+    end
+    
+    it "should include the revision" do
+      comment.inspect.should include(%Q{_rev: "1-654321fedcba",})
+    end
+    
+    it "should return a complete string" do
+      # stub to work around (un)sorted hash on different rubies
+      comment.stub!(:attributes).and_return([['created_at', ''], ['updated_at', ''], ['title', 'title']])
+      comment.inspect.should == %Q{#<Comment _id: "123456abcdef", _rev: "1-654321fedcba", created_at: "", updated_at: "", title: "title">}
+    end
+    
+    it "should include complex datatypes fully inspected" do
+      comment.title = {'en' => 'Blog post'}
+      comment.inspect.should include('title: {"en"=>"Blog post"}')
+      
+      comment.title = nil
+      comment.inspect.should include('title: nil')
+    end
+  end
+end