couchobject 0.5.0 → 0.6.0

data/spec/persistable/deleting.rb

@@ -0,0 +1,113 @@
+require File.dirname(__FILE__) + '/persistable_helper.rb'
+
+describe CouchObject::Persistable, "deleting objects" do
+  before(:each) do
+    @building = ApartmentBuilding.new
+    @apartment = Apartment.new
+    
+    @db = mock("mock db")
+    CouchObject::Database.stub!(:open).and_return(@db)
+    
+    @content_apartment = %{
+       {
+         "_id":"123BAC",
+         "_rev":"946B7D1C",
+         "class":"Apartment"
+       }
+     }
+     CouchObject::Database.stub!(:open).and_return(@db)
+     
+     content = HTTPResponse.new(JSON.unparse({
+       "_id" => "123BAC", 
+       "_rev" => "946B7D1C", 
+     }))
+
+     @document_response = CouchObject::Response.new(content)
+  end
+  
+  it "should be able to delete itself." do
+    response = HTTPResponse.new(@content_apartment)
+    @db.should_receive(:get).with("123BAC").and_return(response)
+    @db.should_receive(:delete).with("123BAC", "946B7D1C")
+    
+    building = Apartment.get_by_id("123BAC", "foo")
+    building.delete.should == true
+  end
+  
+  it "deleting an unsaved document should be possible" do
+    @building.delete.should == true
+  end
+  
+  it "the deleted object should be reset" do
+    response = HTTPResponse.new(@content_apartment)
+    @db.should_receive(:get).with("123BAC").and_return(response)
+    @db.should_receive(:delete).with("123BAC", "946B7D1C")
+    
+    building = Apartment.get_by_id("123BAC", "foo")
+    building.delete.should == true
+    building.id.should == nil
+    building.revision.should == nil
+  end
+  
+  it "when deleting an object that has relations, the relations should also be deleted" do
+    # Receives open seven times. First to store the documents, then to delete.
+    CouchObject::Database.should_receive(:open).exactly(6).and_return(@db)
+    
+    # Store the new documents
+    @db.should_receive(:post).exactly(3).and_return(@document_response)
+
+    # Delete all the objects
+    @db.should_receive(:delete).twice.with("123BAC", "946B7D1C")
+    @db.should_receive(:delete).with("new_ID_foo", "new_Revision_foo")
+
+    @view_content_no_rows = %{
+      {"total_rows":3,"rows":[]}
+    }
+    response = HTTPResponse.new(@view_content_no_rows)
+
+    another_apartment = @apartment.clone
+    @apartment.new?.should == true
+    another_apartment.new?.should == true
+
+    @building.apartments << @apartment << another_apartment
+    @building.save
+
+    @apartment.new?.should == false 
+    another_apartment.new?.should == false
+    
+    # They have been set up identically, so we have to cheat and change
+    # the ID of one of the apartments
+    another_apartment.instance_variable_set("@id", "new_ID_foo")
+    another_apartment.instance_variable_set("@revision", "new_Revision_foo")
+    
+    @building.delete
+    @building.id.should == nil
+    @building.revision.should == nil
+    
+    @apartment.id.should == nil
+    @apartment.revision.should == nil
+    
+    another_apartment.id.should == nil
+    another_apartment.revision.should == nil
+  end
+
+  it "deleting an object that is in a relation should notify the owner" do
+    @building.apartments << @apartment
+    @apartment.apartment_building.should_not == nil
+    @building.apartments.size.should == 1
+    @apartment.delete
+    @building.apartments.size.should == 0
+    @apartment.apartment_building.should == nil
+  end
+
+  it "should be able to delete has_many relations" do
+    @building.apartments << @apartment
+    @apartment.apartment_building.should_not == nil
+    @building.apartments.size.should == 1
+    @building.apartments.delete(@apartment)
+    @building.apartments.size.should == 0
+    @apartment.apartment_building.should == nil
+    
+  end
+end
+

data/spec/persistable/deleting_spec.rb

@@ -0,0 +1,113 @@
+require File.dirname(__FILE__) + '/persistable_helper.rb'
+
+describe CouchObject::Persistable, "deleting objects" do
+  before(:each) do
+    @building = ApartmentBuilding.new
+    @apartment = Apartment.new
+    
+    @db = mock("mock db")
+    CouchObject::Database.stub!(:open).and_return(@db)
+    
+    @content_apartment = %{
+       {
+         "_id":"123BAC",
+         "_rev":"946B7D1C",
+         "class":"Apartment"
+       }
+     }
+     CouchObject::Database.stub!(:open).and_return(@db)
+     
+     content = HTTPResponse.new(JSON.unparse({
+       "_id" => "123BAC", 
+       "_rev" => "946B7D1C", 
+     }))
+
+     @document_response = CouchObject::Response.new(content)
+  end
+  
+  it "should be able to delete itself." do
+    response = HTTPResponse.new(@content_apartment)
+    @db.should_receive(:get).with("123BAC").and_return(response)
+    @db.should_receive(:delete).with("123BAC", "946B7D1C")
+    
+    building = Apartment.get_by_id("123BAC", "foo")
+    building.delete.should == true
+  end
+  
+  it "deleting an unsaved document should be possible" do
+    @building.delete.should == true
+  end
+  
+  it "the deleted object should be reset" do
+    response = HTTPResponse.new(@content_apartment)
+    @db.should_receive(:get).with("123BAC").and_return(response)
+    @db.should_receive(:delete).with("123BAC", "946B7D1C")
+    
+    building = Apartment.get_by_id("123BAC", "foo")
+    building.delete.should == true
+    building.id.should == nil
+    building.revision.should == nil
+  end
+  
+  it "when deleting an object that has relations, the relations should also be deleted" do
+    # Receives open seven times. First to store the documents, then to delete.
+    CouchObject::Database.should_receive(:open).exactly(6).and_return(@db)
+    
+    # Store the new documents
+    @db.should_receive(:post).exactly(3).and_return(@document_response)
+
+    # Delete all the objects
+    @db.should_receive(:delete).twice.with("123BAC", "946B7D1C")
+    @db.should_receive(:delete).with("new_ID_foo", "new_Revision_foo")
+
+    @view_content_no_rows = %{
+      {"total_rows":3,"rows":[]}
+    }
+    response = HTTPResponse.new(@view_content_no_rows)
+
+    another_apartment = @apartment.clone
+    @apartment.new?.should == true
+    another_apartment.new?.should == true
+
+    @building.apartments << @apartment << another_apartment
+    @building.save
+
+    @apartment.new?.should == false 
+    another_apartment.new?.should == false
+    
+    # They have been set up identically, so we have to cheat and change
+    # the ID of one of the apartments
+    another_apartment.instance_variable_set("@id", "new_ID_foo")
+    another_apartment.instance_variable_set("@revision", "new_Revision_foo")
+    
+    @building.delete
+    @building.id.should == nil
+    @building.revision.should == nil
+    
+    @apartment.id.should == nil
+    @apartment.revision.should == nil
+    
+    another_apartment.id.should == nil
+    another_apartment.revision.should == nil
+  end
+
+  it "deleting an object that is in a relation should notify the owner" do
+    @building.apartments << @apartment
+    @apartment.apartment_building.should_not == nil
+    @building.apartments.size.should == 1
+    @apartment.delete
+    @building.apartments.size.should == 0
+    @apartment.apartment_building.should == nil
+  end
+
+  it "should be able to delete has_many relations" do
+    @building.apartments << @apartment
+    @apartment.apartment_building.should_not == nil
+    @building.apartments.size.should == 1
+    @building.apartments.delete(@apartment)
+    @building.apartments.size.should == 0
+    @apartment.apartment_building.should == nil
+    
+  end
+end
+

data/spec/persistable/error_messages.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/persistable_helper.rb'
+
+# This tests are bullshit really...
+# Check if the errors exist and call their message parameters too...
+# gives us good rcov coverage...
+
+describe CouchObject::Errors, "errormessages: " do
+  it "CantCompareSize" do
+    error = CouchObject::Errors::CantCompareSize.new
+    error.message.should == "Can't compare the size of two objects unless at least one of them has been saved and both have timestamps."
+  end
+
+  it "CantCompareSize" do
+    error = CouchObject::Errors::NoDatabaseLocationSet.new
+    error.message.should == "Unless the document has previously been saved you need to supply the full URI to the CouchDB server where the document is to be saved."
+  end
+
+  it "HasManyAssociationError" do
+    error = CouchObject::Errors::HasManyAssociationError.new
+    error.message
+  end
+  it "BelongsToAssociationError" do
+    error = CouchObject::Errors::BelongsToAssociationError.new
+    error.message
+  end
+  it "MissingView" do
+    error = CouchObject::Errors::MissingView.new
+    error.message
+  end
+
+end
+

data/spec/persistable/error_messages_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/persistable_helper.rb'
+
+# This tests are bullshit really...
+# Check if the errors exist and call their message parameters too...
+# gives us good rcov coverage...
+
+describe CouchObject::Errors, "errormessages: " do
+  it "CantCompareSize" do
+    error = CouchObject::Errors::CantCompareSize.new
+    error.message.should == "Can't compare the size of two objects unless at least one of them has been saved and both have timestamps."
+  end
+
+  it "CantCompareSize" do
+    error = CouchObject::Errors::NoDatabaseLocationSet.new
+    error.message.should == "Unless the document has previously been saved you need to supply the full URI to the CouchDB server where the document is to be saved."
+  end
+
+  it "HasManyAssociationError" do
+    error = CouchObject::Errors::HasManyAssociationError.new
+    error.message
+  end
+  it "BelongsToAssociationError" do
+    error = CouchObject::Errors::BelongsToAssociationError.new
+    error.message
+  end
+  it "MissingView" do
+    error = CouchObject::Errors::MissingView.new
+    error.message
+  end
+
+end
+

data/spec/persistable/loading.rb

@@ -0,0 +1,339 @@
+require File.dirname(__FILE__) + '/persistable_helper.rb'
+
+describe CouchObject::Persistable, "for loading objects:" do
+  before(:each) do
+    @bike = Bike.new
+    @with_location = WithStorageLocation.new
+    
+    @db = mock("mock db")
+
+    @content_bike = %{
+      {
+        "_id":"123BAC",
+        "_rev":"946B7D1C",
+        "class":"Bike",
+        "attributes":
+        {
+          "wheels":2
+        }
+      }
+    }
+    
+    @content_motor_bike = %{
+      {
+        "_id":"123BAC",
+        "_rev":"946B7D1C",
+        "class":"MotorBike",
+        "attributes":
+        {
+          "wheels":2
+        }
+      }
+    }
+    
+    @content_with_location = %{
+      {
+        "_id":"123BAC",
+        "_rev":"946B7D1C",
+        "class":"WithStorageLocation",
+        "attributes":
+          {}
+        }
+    }
+    
+    CouchObject::Database.stub!(:open).and_return(@db)
+  end
+ 
+  it "should get document by id" do 
+    response = HTTPResponse.new(@content_bike)
+    
+    @db.should_receive(:get).with("123BAC").and_return(response)
+    
+    bike = Bike.get_by_id("123BAC", "foo")
+    bike.id.should == "123BAC"
+  end
+    
+  it "should instantiate a new object WITH a :from_couch method when loaded from the document store" do
+    response = HTTPResponse.new(@content_bike)
+    
+    @db.should_receive(:get).with("123BAC").and_return(response)
+
+    bike = Bike.get_by_id("123BAC", "foo")
+    bike.class.should == Bike
+    bike.wheels.should == 2
+  end
+    
+  it "should instantiate a new object WITHOUT a :from_couch method when loaded from the document store" do
+    response = HTTPResponse.new(@content_motor_bike)
+    @db.should_receive(:get).with("123BAC").and_return(response)
+      
+    motorbike = MotorBike.get_by_id("123BAC", "foo")
+    motorbike.class.should == MotorBike
+    motorbike.wheels.should == 2
+  end
+  
+  it "classes with the storage location preset should be able to load documents by only supplying the ID" do
+    response = HTTPResponse.new(@content_with_location)
+    @db.should_receive(:get).with("123BAC").and_return(response)
+
+    with_content = WithStorageLocation.get_by_id("123BAC")
+    with_content.id.should == "123BAC"
+  end
+
+  it "should raise an error if a class that does not have the database uri set by default tries to laod a document only by ID" do
+    lambda{ bike = Bike.get_by_id("123BAC") }.
+      should raise_error(CouchObject::Errors::NoDatabaseLocationSet)
+  end
+
+  it "should raise an ID if the object doesn't exist in the database" do
+    response_missing = HTTPResponse.
+      new(%{{"error":"not_found","reason":"missing"}})
+    response_deleted = HTTPResponse.
+      new(%{{"error":"not_found","reason":"deleted"}})
+
+    @db.should_receive(:get).with("123BAC_1").and_return(response_missing)
+    @db.should_receive(:get).with("123BAC_2").and_return(response_deleted)
+
+    lambda{ bike = Bike.get_by_id("123BAC_1", "foo_db") }.
+      should raise_error(CouchObject::Errors::DocumentNotFound)
+      
+    lambda{ bike = Bike.get_by_id("123BAC_2", "foo_db") }.
+      should raise_error(CouchObject::Errors::DocumentNotFound)
+    
+  end
+  
+end
+
+describe CouchObject::Persistable, "for loading object with subobject:" do
+  before(:each) do
+    @obj = WithSubobject.new
+    
+    @db = mock("mock db")
+  
+    @json_string = %{
+      {
+        "_id":"88F411C76D243294A8108DB25F2F8315",
+        "_rev":"4221814729",
+        "class":"WithSubobject",
+        "attributes":
+        {
+          "a_class":
+          {
+            "updated_at":
+            {
+              "json_class":"Time",
+              "s":1202756456,
+              "u":955933
+            },
+            "class":"Subobject",
+            "attributes":
+            {
+              "some_other_class":
+              {
+                "updated_at":
+                {
+                  "json_class":"Time",
+                  "s":1202756456,
+                  "u":955986
+                },
+                "class":"SubSubobject",
+                "attributes":
+                {
+                  "value":"New value"
+                },
+                "created_at":
+                {
+                  "json_class":"Time",
+                  "s":1202756456,
+                  "u":955989
+                }
+              }
+            },
+            "created_at":
+            {
+              "json_class":"Time",
+              "s":1202756456,
+              "u":955936
+            }
+          }
+        }
+      }
+    }
+    
+    CouchObject::Database.stub!(:open).and_return(@db)
+  end
+
+  it "should initialize all levels of subclasses" do
+    response = HTTPResponse.new(@json_string)
+    @db.should_receive(:get).with("123BAC").and_return(response)
+    
+    with_subobject = WithSubobject.get_by_id("123BAC")
+    with_subobject.a_class.class.should == Subobject
+    with_subobject.a_class.some_other_class.class.should == SubSubobject
+    with_subobject.a_class.some_other_class.value.should == "New value"
+    with_subobject.a_class.some_other_class.created_at.class.should == Time
+  end
+end
+
+describe CouchObject::Persistable, "for loading objects from a view" do
+  before(:each) do
+    @bike = Bike.new
+    @with_location = WithStorageLocation.new
+    
+    @db = mock("mock db")
+
+    @content_bike = %{
+      {
+        "_id":"123BAC",
+        "_rev":"946B7D1C",
+        "class":"Bike",
+        "attributes":
+        {
+          "wheels":2
+        }
+      }
+    }
+    
+    @content_motor_bike = %{
+      {
+        "_id":"123BAC",
+        "_rev":"946B7D1C",
+        "class":"MotorBike",
+        "attributes":
+        {
+          "wheels":2
+        }
+      }
+    }
+    
+    @content_with_location = %{
+      {
+        "_id":"123BAC",
+        "_rev":"946B7D1C",
+        "class":"WithStorageLocation",
+        "attributes":
+          {}
+        }
+    }
+    
+    @view_content = %{
+{"total_rows":4,"offset":0,"rows":[{"id":"1657A08F51BC66AEFD8630C27BD18E17","key":"1657A08F51BC66AEFD8630C27BD18E17","value":{"_id":"1657A08F51BC66AEFD8630C27BD18E17","_rev":"1626884106","class":"House","attributes":{}}},{"id":"1D7E2C45B946C1C4A7E76016FDAB104B","key":"1D7E2C45B946C1C4A7E76016FDAB104B","value":{"_id":"1D7E2C45B946C1C4A7E76016FDAB104B","_rev":"1069657208","class":"House","attributes":{}}},{"id":"D646E0796DF90D62AE402208E4043216","key":"D646E0796DF90D62AE402208E4043216","value":{"_id":"D646E0796DF90D62AE402208E4043216","_rev":"633260494","class":"House","attributes":{}}},{"id":"D770670E2219EC767BBB55FFB7763ADA","key":"D770670E2219EC767BBB55FFB7763ADA","value":{"_id":"D770670E2219EC767BBB55FFB7763ADA","_rev":"3666401817","class":"House","attributes":{}}}]}
+    }
+
+    @view_content_for_id = %{
+{"total_rows":4,"offset":0,"rows":[{"id":"1657A08F51BC66AEFD8630C27BD18E17","key":"1657A08F51BC66AEFD8630C27BD18E17","value":{"_id":"1657A08F51BC66AEFD8630C27BD18E17","_rev":"1626884106","class":"House","attributes":{}}}]}
+    }
+    
+    @view_content_mixed = %{   
+      {"total_rows":2,"offset":0,"rows":[{"id":"5030848C1F2E31820ADF6B22832037DE","key":"5030848C1F2E31820ADF6B22832037DE","value":{"_id":"5030848C1F2E31820ADF6B22832037DE","_rev":"2247680957","class":"Bike","attributes":{}}},{"id":"D646E0796DF90D62AE402208E4043216","key":"D646E0796DF90D62AE402208E4043216","value":{"_id":"D646E0796DF90D62AE402208E4043216","_rev":"633260494","class":"House","attributes":{}}}]}
+    }
+    
+    @view_content_subclasses = %{
+{"total_rows":1,"offset":0,"rows":[{"id":"5A89FEF09C2E63E040B65909E277B604","key":"5A89FEF09C2E63E040B65909E277B604","value":{"_id":"5A89FEF09C2E63E040B65909E277B604","_rev":"4002434601","class":"WithSubobject","attributes":{"a_class":{"updated_at":{"json_class":"Time","s":1203104797,"u":954565},"class":"Subobject","attributes":{"some_other_class":{"updated_at":{"json_class":"Time","s":1203104797,"u":954624},"class":"SubSubobject","attributes":{"value":"Initialized"},"created_at":{"json_class":"Time","s":1203104797,"u":954627}}},"created_at":{"json_class":"Time","s":1203104797,"u":954569}}}}}]}
+    }
+    
+    @view_content_no_rows = %{
+      {"total_rows":3,"rows":[]}
+    }
+    
+    @view_content_missing_view = %{
+      {"error":"not_found","reason":"missing"}
+    }
+    
+    CouchObject::Database.stub!(:open).and_return(@db)
+  end
+ 
+  it "should raise errors for missing arguments" do 
+    lambda{bike = Bike.get_from_view()}.should \
+      raise_error(ArgumentError)
+
+    lambda{bike = Bike.get_from_view("foo_view")}.should \
+      raise_error(CouchObject::Errors::NoDatabaseLocationSet)
+  end
+
+  it "should return an array with four elements of class type House" do
+    response = HTTPResponse.new(@view_content)
+    @db.should_receive(:get).with("foo").and_return(response)
+    
+    new_instances = Bike.get_from_view("foo", {:db_uri => "foo"})
+
+    new_instances.should be_a_kind_of(Array)
+    new_instances.size.should == 4
+    new_instances.each do |instance|
+      instance.class.should == House
+      instance.new?.should == false
+    end
+  end
+
+  it "should be able to get an element by key" do
+    response = HTTPResponse.new(@view_content_for_id)
+    @db.should_receive(:get).with("foo?key=%221657A08F51BC66AEFD8630C27BD18E17%22").and_return(response)
+    
+    new_instances = Bike.get_from_view("foo", {:db_uri => "foo", :key => "1657A08F51BC66AEFD8630C27BD18E17"})
+
+    new_instances.should be_a_kind_of(Array)
+    new_instances.size.should == 1
+    new_instances.first.class.should == House
+    new_instances.first.new?.should == false
+    
+  end
+
+  it "should return a blank array when sending in a non existent key" do
+    response = HTTPResponse.new(@view_content_no_rows)
+    @db.should_receive(:get).with("foo?key=%22D18E17%22").and_return(response)
+    
+    new_instances = Bike.get_from_view("foo", 
+      {:db_uri => "foo", :key => "D18E17"})
+
+    new_instances.should be_a_kind_of(Array)
+    new_instances.size.should == 0
+    
+  end
+
+
+  it "should be able to return instances from a view with different objects" do
+    response = HTTPResponse.new(@view_content_mixed)
+    @db.should_receive(:get).with("foo").and_return(response)
+    
+    new_instances = Bike.get_from_view("foo", {:db_uri => "foo"})
+
+    new_instances.should be_a_kind_of(Array)
+    new_instances.size.should == 2
+    new_instances[0].class.should == Bike
+    new_instances[0].new?.should == false
+
+    new_instances[1].class.should == House
+    new_instances[1].new?.should == false
+
+    
+  end
+
+  it "should be able to load classes that have subclasses from a view" do
+    response = HTTPResponse.new(@view_content_subclasses)
+    @db.should_receive(:get).with("foo").and_return(response)
+    
+    new_instances = WithSubobject.get_from_view("foo", {:db_uri => "foo"})
+
+    new_instances.should be_a_kind_of(Array)
+    new_instances.size.should == 1
+    new_instances.first.class.should == WithSubobject
+    new_instances.first.new?.should == false
+    
+    new_instances.first.a_class.class.should == Subobject
+    new_instances.first.a_class.some_other_class.class.should == SubSubobject
+    new_instances.first.a_class.some_other_class.value.should == "Initialized"
+    
+  end
+
+  it "should raise an error for non existing views" do
+    response = HTTPResponse.new(@view_content_missing_view)
+    @db.should_receive(:get).with("_view/doesnt_exist").and_return(response)
+    
+    lambda{Bike.get_from_view("_view/doesnt_exist", 
+        {:db_uri => "foo"})}.
+      should raise_error(CouchObject::Errors::MissingView)
+
+  end
+
+end
+