couchrest_model 1.1.2 → 1.2.0.beta

data/spec/unit/base_spec.rb

@@ -81,6 +81,53 @@ describe "Model Base" do
       @doc.name.should eql("foobar")
     end
   end
+  describe "multipart attributes" do
+    context "with valid params" do        
+      it "should parse a legal date" do
+        valid_date_params = { "exec_date(1i)"=>"2011", 
+                              "exec_date(2i)"=>"10", 
+                              "exec_date(3i)"=>"18"}
+        @obj = WithDateAndTime.new valid_date_params
+        @obj.exec_date.should_not be_nil
+        @obj.exec_date.should be_kind_of(Date)
+        @obj.exec_date.should == Date.new(2011, 10 ,18)
+      end
+    
+      it "should parse a legal time" do
+        valid_time_params = { "exec_time(1i)"=>"2011", 
+                              "exec_time(2i)"=>"10", 
+                              "exec_time(3i)"=>"18",
+                              "exec_time(4i)"=>"15",
+                              "exec_time(5i)"=>"15",
+                              "exec_time(6i)"=>"15",}
+        @obj = WithDateAndTime.new valid_time_params
+        @obj.exec_time.should_not be_nil
+        @obj.exec_time.should be_kind_of(Time)
+        @obj.exec_time.should == Time.utc(2011, 10 ,18, 15, 15, 15)
+      end
+    end
+    
+    context "with invalid params" do
+      before(:each) do
+        @invalid_date_params = { "exec_date(1i)"=>"2011", 
+                                 "exec_date(2i)"=>"foo", 
+                                 "exec_date(3i)"=>"18"}
+      end
+      it "should still create a model if there are invalid attributes" do
+        @obj = WithDateAndTime.new @invalid_date_params
+        @obj.should_not be_nil
+        @obj.should be_kind_of(WithDateAndTime)
+      end
+      it "should not crash because of an empty value" do
+        @invalid_date_params["exec_date(2i)"] = ""
+        @obj = WithDateAndTime.new @invalid_date_params
+        @obj.should_not be_nil
+        @obj.exec_date.should_not be_kind_of(Date)
+        @obj.should be_kind_of(WithDateAndTime)
+      end
+    end
+  end
+  
 
   describe "ActiveModel compatability Basic" do
 
@@ -355,25 +402,24 @@ describe "Model Base" do
   
   describe "counting all instances of a model" do
     before(:each) do
-      @db = reset_test_db!
+      reset_test_db!
     end
-    
+
     it ".count should return 0 if there are no docuemtns" do
       WithTemplateAndUniqueID.count.should == 0
     end
-    
+
     it ".count should return the number of documents" do
       WithTemplateAndUniqueID.new('slug' => '1').save
       WithTemplateAndUniqueID.new('slug' => '2').save
       WithTemplateAndUniqueID.new('slug' => '3').save
-      
       WithTemplateAndUniqueID.count.should == 3
     end
   end
   
   describe "finding the first instance of a model" do
     before(:each) do      
-      @db = reset_test_db!
+      reset_test_db!
       WithTemplateAndUniqueID.new('slug' => '1').save
       WithTemplateAndUniqueID.new('slug' => '2').save
       WithTemplateAndUniqueID.new('slug' => '3').save

data/spec/unit/core_extensions/time_parsing.rb

@@ -9,6 +9,47 @@ describe "Time Parsing core extension" do
       Time.respond_to?("parse_iso8601").should be_true
     end
 
+    describe "#as_json" do
+
+      it "should convert local time to JSON string" do
+        time = Time.new(2011, 04, 01, 19, 05, 30, "+02:00")
+        time.as_json.should eql("2011-04-01T19:05:30.000+02:00")
+      end
+
+      it "should convert utc time to JSON string" do
+        time = Time.utc(2011, 04, 01, 19, 05, 30)
+        time.as_json.should eql("2011-04-01T19:05:30.000Z")
+      end
+
+      it "should convert local time with fraction to JSON" do
+        time = Time.new(2011, 04, 01, 19, 05, 30.123, "+02:00")
+        time.as_json.should eql("2011-04-01T19:05:30.123+02:00")
+      end
+
+      it "should convert utc time with fraction to JSON" do
+        time = Time.utc(2011, 04, 01, 19, 05, 30.123)
+        time.as_json.should eql("2011-04-01T19:05:30.123Z")
+      end
+
+      it "should allow fraction digits" do
+        time = Time.utc(2011, 04, 01, 19, 05, 30.123456)
+        time.as_json(:fraction_digits => 6).should eql("2011-04-01T19:05:30.123456Z")
+      end
+
+      it "should use CouchRest::Model::Base.time_fraction_digits config option" do
+        CouchRest::Model::Base.time_fraction_digits = 6
+        time = Time.utc(2011, 04, 01, 19, 05, 30.123456)
+        time.as_json.should eql("2011-04-01T19:05:30.123456Z")
+        CouchRest::Model::Base.time_fraction_digits = 3 # Back to normal
+      end
+
+      it "should cope with a nil options parameter" do
+        time = Time.utc(2011, 04, 01, 19, 05, 30.123456)
+        lambda { time.as_json(nil) }.should_not raise_error
+      end
+
+    end
+
     describe ".parse_iso8601" do
 
       describe "parsing" do

data/spec/unit/designs/design_spec.rb

@@ -0,0 +1,291 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe CouchRest::Model::Designs::Design do
+
+  before :all do
+    reset_test_db!
+  end
+
+  class DesignSampleModel < CouchRest::Model::Base
+    use_database DB
+    property :name
+    property :surname
+    design do
+      view :by_name
+    end
+    design :stats do
+      view :by_surname
+    end
+  end
+
+  describe "class methods" do
+
+    before :all do
+      @klass = CouchRest::Model::Designs::Design
+    end
+
+    describe ".method_name" do
+      it "should return standard method name" do
+        @klass.method_name.should eql('design_doc')
+      end
+
+      it "should add prefix to standard method name" do
+        @klass.method_name('stats').should eql('stats_design_doc')
+      end
+    end
+
+  end
+
+  describe "base methods" do
+
+    before :each do
+      @model = mock("ModelExample")
+      @model.stub(:to_s).and_return("ModelExample")
+      @obj = CouchRest::Model::Designs::Design.new(@model)
+    end
+
+
+    describe "initialisation without prefix" do
+      it "should associate model and set method name" do
+        @obj.model.should eql(@model)
+        @obj.method_name.should eql("design_doc")
+      end
+
+      it "should generate correct id" do
+        @obj['_id'].should eql("_design/ModelExample")
+      end
+
+      it "should apply defaults" do
+        @obj['language'].should eql('javascript')
+      end
+    end
+
+    describe "initialisation with prefix" do
+
+      it "should associate model and set method name" do
+        @obj = CouchRest::Model::Designs::Design.new(@model, 'stats')
+        @obj.model.should eql(@model)
+        @obj.method_name.should eql("stats_design_doc")
+      end
+
+      it "should generate correct id with prefix" do
+        @obj = CouchRest::Model::Designs::Design.new(@model, 'stats')
+        @obj['_id'].should eql("_design/ModelExample_stats")
+      end
+
+    end
+
+
+
+    describe "#sync and #sync!" do
+
+      it "should skip if auto update disabled" do
+        @obj.auto_update = false
+        @obj.should_not_receive(:sync!)
+        @obj.sync
+      end
+
+      describe "with real model" do
+
+        before :all do
+          reset_test_db!
+          @mod = DesignSampleModel
+          @doc = @mod.design_doc
+          @db  = @mod.database
+        end
+
+        it "should not have been saved up until sync called" do
+          lambda { @mod.database.get(@doc['_id']) }.should raise_error(RestClient::ResourceNotFound)
+        end
+
+
+        it "should save a design that is in cache and has changed" do
+          @doc.sync # put in cache
+          @doc['views']['all']['map'] += '// comment'
+          # This would fail if changes were not detected!
+          @doc.sync
+          doc = @db.get(@doc['_id'])
+          doc['views']['all']['map'].should eql(@doc['views']['all']['map'])
+        end
+
+        it "should not save a design that is not in cache and has not changed" do
+          @doc.sync # put doc in cache
+          @doc.send(:set_cache_checksum, @doc.database, nil)
+
+          @db.should_not_receive(:save_doc)
+          @doc.should_receive(:set_cache_checksum)
+          @doc.sync
+        end
+
+        it "should not reload a design that is in cache and has not changed" do
+          @doc.sync
+          @doc.should_not_receive(:load_from_database)
+          @doc.sync
+        end
+
+        it "should be re-created if database destroyed" do
+          @doc.sync  # saved
+          reset_test_db!
+          @db.should_receive(:save_doc).with(@doc)
+          @doc.sync
+        end
+
+        it "should not update the local design definition" do
+          @doc.sync!
+          doc = @db.get(@doc['_id'])
+          doc['views']['test'] = {'map' => "function(d) { if (d) { emit(d._id, null); } }"}
+          @db.save_doc(doc)
+          @doc.send(:set_cache_checksum, @doc.database, nil)
+          @doc.sync
+          @doc['views'].should_not have_key('test')
+          @doc['_rev'].should be_nil
+        end
+
+        it "should save a non existant design" do
+          begin
+            doc = @db.get(@doc['_id'])
+          rescue
+            doc = nil
+          end
+          @db.delete_doc(doc) if doc
+          @doc.sync!
+          doc = @db.get(@doc['_id'])
+          doc.should_not be_nil
+          doc['views']['all'].should eql(@doc['views']['all'])
+        end
+
+      end
+    end
+
+
+    describe "checksum" do
+
+      before :all do
+        @mod = DesignSampleModel
+        @doc = @mod.design_doc
+      end
+
+      it "should return fresh checksum when not calculated earlier" do
+        @doc.checksum.should_not be_blank
+      end
+
+      it "should provide same checksum without refresh on re-request" do
+        chk = @doc.checksum
+        @doc.should_not_receive(:chaecksum!)
+        @doc.checksum.should eql(chk)
+      end
+
+      it "should provide new checksum if the design has changed" do
+        chk = @doc.checksum
+        @doc['views']['all']['map'] += '// comment'
+        @doc.checksum.should_not eql(chk)
+      end
+
+    end
+
+    describe "database" do
+      it "should provide model's database" do
+        @mod = DesignSampleModel
+        @doc = @mod.design_doc
+        @mod.should_receive(:database)
+        @doc.database
+      end
+    end
+
+
+    describe "#uri" do
+      it "should provide complete url" do
+        @doc = DesignSampleModel.design_doc
+        @doc.uri.should eql("#{DesignSampleModel.database.root}/_design/DesignSampleModel")
+      end
+    end
+
+    describe "#view" do
+      it "should instantiate a new view and pass options" do
+        CouchRest::Model::Designs::View.should_receive(:new).with(@obj, @model, {}, 'by_test')
+        @obj.view('by_test', {})
+      end
+    end
+
+    describe "#view_names" do
+      it "should provide a list of all the views available" do
+        @doc = DesignSampleModel.design_doc
+        @doc.view_names.should eql(['by_name', 'all'])
+      end
+    end
+
+    describe "#has_view?" do
+      before :each do
+        @doc = DesignSampleModel.design_doc
+      end
+
+      it "should tell us if a view exists" do
+        @doc.has_view?('by_name').should be_true
+      end
+
+      it "should tell us if a view exists as symbol" do
+        @doc.has_view?(:by_name).should be_true
+      end
+
+      it "should tell us if a view does not exist" do
+        @doc.has_view?(:by_foobar).should be_false
+      end
+    end
+
+    describe "#create_view" do
+      before :each do
+        @doc = DesignSampleModel.design_doc
+        @doc['views'] = @doc['views'].clone
+      end
+
+      it "should forward view creation to View model" do
+        CouchRest::Model::Designs::View.should_receive(:define_and_create).with(@doc, 'by_other_name', {})
+        @doc.create_view('by_other_name')
+      end
+
+      it "should forward view creation to View model with opts" do
+        CouchRest::Model::Designs::View.should_receive(:define_and_create).with(@doc, 'by_other_name', {:by => 'name'})
+        @doc.create_view('by_other_name', :by => 'name')
+      end
+    end
+
+
+    describe "#create_filter" do
+      before :each do
+        @doc = DesignSampleModel.design_doc
+      end
+
+      it "should add simple filter" do
+        @doc.create_filter('test', 'foobar')
+        @doc['filters']['test'].should eql('foobar')
+        @doc['filters'] = nil # cleanup
+      end
+    end
+
+  end
+
+
+  describe "Checksum calculations" do
+
+    it "should calculate a consistent checksum for model" do
+      #WithTemplateAndUniqueID.design_doc.checksum.should eql('caa2b4c27abb82b4e37421de76d96ffc')
+      WithTemplateAndUniqueID.design_doc.checksum.should eql('f0973aaa72e4db0efeb2a281ea297cec')
+    end
+
+    it "should calculate checksum for complex model" do
+      #Article.design_doc.checksum.should eql('70dff8caea143bf40fad09adf0701104')
+      Article.design_doc.checksum.should eql('7ef39bffdf5837e8b078411ac417d860')
+    end
+
+    it "should cache the generated checksum value" do
+      Article.design_doc.checksum
+      Article.design_doc['couchrest-hash'].should_not be_blank
+      Article.first
+    end
+
+  end
+
+
+end

data/spec/unit/designs/view_spec.rb

@@ -16,6 +16,7 @@ describe "Design View" do
   describe "(unit tests)" do
 
     before :each do
+      @mod   = DesignViewModel
       @klass = CouchRest::Model::Designs::View
     end
 
@@ -30,14 +31,15 @@ describe "Design View" do
       describe "with CouchRest Model" do
 
         it "should setup attributes" do
-          @obj = @klass.new(DesignViewModel, {}, 'test_view')
-          @obj.model.should eql(DesignViewModel)
+          @obj = @klass.new(@mod.design_doc, @mod, {}, 'test_view')
+          @obj.design_doc.should eql(@mod.design_doc)
+          @obj.model.should eql(@mod)
           @obj.name.should eql('test_view')
           @obj.query.should be_empty
         end
 
         it "should complain if there is no name" do
-          lambda { @klass.new(DesignViewModel, {}, nil) }.should raise_error
+          lambda { @klass.new(@mod.design_doc, @mod, {}, nil) }.should raise_error(/Name must be provided/)
         end
 
       end
@@ -45,56 +47,142 @@ describe "Design View" do
       describe "with previous view instance" do
 
         before :each do
-          first = @klass.new(DesignViewModel, {}, 'test_view')
-          @obj = @klass.new(first, {:foo => :bar})
+          first = @klass.new(@mod.design_doc, @mod, {}, 'test_view')
+          @obj = @klass.new(@mod.design_doc, first, {:foo => :bar})
         end
 
         it "should copy attributes" do
-          @obj.model.should eql(DesignViewModel)
+          @obj.model.should eql(@mod)
           @obj.name.should eql('test_view')
           @obj.query.should eql({:foo => :bar})
         end
 
       end
 
-    end
+      describe "with proxy in query for first initialization" do
+        it "should set model to proxy object and remove from query" do
+          proxy = mock("Proxy")
+          @obj = @klass.new(@mod.design_doc, @mod, {:proxy => proxy}, 'test_view')
+          @obj.model.should eql(proxy)
+        end
+      end
+
+      describe "with proxy in query for chained instance" do
+        it "should set the model to proxy object instead of parents model" do
+          proxy = mock("Proxy")
+          @obj = @klass.new(@mod.design_doc, @mod, {}, 'test_view')
+          @obj.model.should eql(@mod)
+          @obj = @obj.proxy(proxy)
+          @obj.model.should eql(proxy)
+        end
+      end
 
-    describe ".create" do
+    end
 
+    describe ".define_and_create" do
       before :each do
-        @design_doc = {}
-        DesignViewModel.stub!(:design_doc).and_return(@design_doc)
+        @design_doc = { }
       end
 
-      it "should add a basic view" do
-        @klass.create(DesignViewModel, 'test_view', :map => 'foo')
-        @design_doc['views']['test_view'].should_not be_nil
+      it "should call define and create_model_methods method" do
+        @klass.should_receive(:define).with(@design_doc, 'test', {}).and_return(nil)
+        @klass.should_receive(:create_model_methods).with(@design_doc, 'test', {}).and_return(nil)
+        @klass.define_and_create(@design_doc, 'test')
       end
 
-      it "should auto generate mapping from name" do
-        lambda { @klass.create(DesignViewModel, 'by_title') }.should_not raise_error
-        str = @design_doc['views']['by_title']['map']
-        str.should include("((doc['#{DesignViewModel.model_type_key}'] == 'DesignViewModel') && (doc['title'] != null))")
-        str.should include("emit(doc['title'], 1);")
-        str = @design_doc['views']['by_title']['reduce']
-        str.should include("return sum(values);")
+      it "should call define and create_model_methods method with opts" do
+        @klass.should_receive(:define).with(@design_doc, 'test', {:foo => :bar}).and_return(nil)
+        @klass.should_receive(:create_model_methods).with(@design_doc, 'test', {:foo => :bar}).and_return(nil)
+        @klass.define_and_create(@design_doc, 'test', {:foo => :bar})
       end
 
-      it "should auto generate mapping from name with and" do
-        @klass.create(DesignViewModel, 'by_title_and_name')
-        str = @design_doc['views']['by_title_and_name']['map']
-        str.should include("(doc['title'] != null) && (doc['name'] != null)")
-        str.should include("emit([doc['title'], doc['name']], 1);")
-        str = @design_doc['views']['by_title_and_name']['reduce']
-        str.should include("return sum(values);")
+    end
+
+    describe ".define" do
+
+      describe "with no auto update" do
+        before :each do
+          @design_doc = { }
+          @design_doc.stub!(:model).and_return(DesignViewModel)
+          @design_doc.stub!(:auto_update).and_return(false)
+        end
+
+        it "should set map view to true" do
+          @klass.define(@design_doc, 'test_view')
+          @design_doc['views']['test_view']['map'].should eql(true)
+          @design_doc['views']['test_view']['reduce'].should be_false
+        end
+
+        it "should set reduce to true if set" do
+          @klass.define(@design_doc, 'test_view', :reduce => true)
+          @design_doc['views']['test_view']['map'].should eql(true)
+          @design_doc['views']['test_view']['reduce'].should eql(true)
+        end
       end
 
+      describe "with auto update" do
+
+        before :each do
+          @design_doc = { }
+          @design_doc.stub!(:model).and_return(DesignViewModel)
+          @design_doc.stub!(:auto_update).and_return(true)
+        end
+
+        it "should add a basic view" do
+          @klass.define(@design_doc, 'test_view', :map => 'foo')
+          @design_doc['views']['test_view'].should_not be_nil
+        end
+
+        it "should auto generate mapping from name" do
+          lambda { @klass.define(@design_doc, 'by_title') }.should_not raise_error
+          str = @design_doc['views']['by_title']['map']
+          str.should include("((doc['#{DesignViewModel.model_type_key}'] == 'DesignViewModel') && (doc['title'] != null))")
+          str.should include("emit(doc['title'], 1);")
+          str = @design_doc['views']['by_title']['reduce']
+          str.should include("return sum(values);")
+        end
+
+        it "should auto generate mapping from name with and" do
+          @klass.define(@design_doc, 'by_title_and_name')
+          str = @design_doc['views']['by_title_and_name']['map']
+          str.should include("(doc['title'] != null) && (doc['name'] != null)")
+          str.should include("emit([doc['title'], doc['name']], 1);")
+          str = @design_doc['views']['by_title_and_name']['reduce']
+          str.should include("return sum(values);")
+        end
+      end
+
+      describe ".create_model_methods" do
+        before :each do
+          @model = DesignViewModel
+          @design_doc = { }
+          @design_doc.stub!(:model).and_return(@model)
+          @design_doc.stub!(:method_name).and_return("design_doc")
+          @model.stub!('design_doc').and_return(@design_doc)
+        end
+        it "should create standard view method" do
+          @klass.create_model_methods(@design_doc, 'by_name')
+          @model.should respond_to('by_name')
+          @design_doc.should_receive('view').with('by_name', {})
+          @model.by_name
+        end
+        it "should create find_ view method" do
+          @klass.create_model_methods(@design_doc, 'by_name')
+          @model.should respond_to('find_by_name')
+          view = mock("View")
+          view.should_receive('key').with('fred').and_return(view)
+          view.should_receive('first').and_return(nil)
+          @design_doc.should_receive('view').and_return(view)
+          @model.find_by_name('fred')
+        end
+      end
     end
 
+
     describe "instance methods" do
 
       before :each do
-        @obj = @klass.new(DesignViewModel, {}, 'test_view')
+        @obj = @klass.new(@mod.design_doc, @mod, {}, 'test_view')
       end
 
       describe "#rows" do
@@ -468,6 +556,20 @@ describe "Design View" do
         end
       end
 
+      describe "#stale" do
+        it "should update query with ok" do
+          @obj.should_receive(:update_query).with(:stale => 'ok')
+          @obj.stale('ok')
+        end
+        it "should update query with update_after" do
+          @obj.should_receive(:update_query).with(:stale => 'update_after')
+          @obj.stale('update_after')
+        end
+        it "should fail if anything else is provided" do
+          lambda { @obj.stale('yes') }.should raise_error(/can only be set with/)
+        end
+      end
+
       describe "#include_docs" do
         it "should call include_docs! on new view" do
           @obj.should_receive(:update_query).and_return(@obj)
@@ -532,13 +634,6 @@ describe "Design View" do
         end
       end
 
-      describe "#design_doc" do
-        it "should call design_doc on model" do
-          @obj.model.should_receive(:design_doc)
-          @obj.send(:design_doc)
-        end
-      end
-
       describe "#can_reduce?" do
         it "should check and prove true" do
           @obj.should_receive(:name).and_return('test_view')
@@ -557,8 +652,8 @@ describe "Design View" do
           # disable real execution!
           @design_doc = mock("DesignDoc")
           @design_doc.stub!(:view_on)
-          @obj.model.stub!(:save_design_doc)
-          @obj.model.stub!(:design_doc).and_return(@design_doc)
+          @design_doc.stub!(:sync)
+          @obj.stub!(:design_doc).and_return(@design_doc)
         end
 
         it "should return previous result if set" do
@@ -582,7 +677,7 @@ describe "Design View" do
 
         it "should call to save the design document" do
           @obj.should_receive(:can_reduce?).and_return(false)
-          @obj.model.should_receive(:save_design_doc).with(DB)
+          @design_doc.should_receive(:sync).with(DB)
           @obj.send(:execute)
         end
 
@@ -595,9 +690,9 @@ describe "Design View" do
 
         it "should remove nil values from query" do
           @obj.should_receive(:can_reduce?).and_return(true)
-          @obj.stub!(:use_database).and_return('database')
+          @obj.stub!(:use_database).and_return(@mod.database)
           @obj.query = {:reduce => true, :limit => nil, :skip => nil}
-          @design_doc.should_receive(:view_on).with('database', 'test_view', {:reduce => true})
+          @design_doc.should_receive(:view_on).with(@mod.database, 'test_view', {:reduce => true})
           @obj.send(:execute)
         end