ripple 0.9.5 → 1.0.0.beta

data/spec/ripple/embedded_document/finders_spec.rb

@@ -1,36 +1,29 @@
-# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-require File.expand_path("../../../spec_helper", __FILE__)
+require 'spec_helper'
 
 describe Ripple::EmbeddedDocument::Finders do
-  require 'support/models/address'
-  require 'support/models/favorite'
+  # require 'support/models/address'
+  # require 'support/models/favorite'
 
   before :each do
-    @addr = Address.new
+    @address = Address.new
   end
 
   it "should instantiate a document" do
     Address.stub!(:new).and_return(@address)
     Address.instantiate('_type' => 'Address').should == @address
   end
-  
+
   it "should instantiate a class of _type if present in attrs" do
     Favorite.instantiate('_type' => 'Address').class.should == Address
   end
-  
+
   it "should use self if being called from a class including Ripple::EmbeddedDocument and _type is not present" do
     Address.instantiate({}).class.should == Address
   end
+
+  it 'initializes the document with no changes' do
+    a = Address.instantiate('_type' => 'Address', 'street' => 'Pine St')
+    a.should_not be_changed
+    a.changes.should be_empty
+  end
 end

data/spec/ripple/embedded_document/persistence_spec.rb

@@ -1,25 +1,12 @@
-# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-require File.expand_path("../../../spec_helper", __FILE__)
+require 'spec_helper'
 
 describe Ripple::EmbeddedDocument::Persistence do
-  require 'support/models/user'
-  require 'support/models/address'
-  
+  # require 'support/models/user'
+  # require 'support/models/address'
+
   before :each do
     @root = User.new
-    @addr = Address.new(:street => "196 Broadway")
+    @addr = Address.new(:street => "196 Broadway", :kind => "Home")
     @addr._parent_document = @root
   end
 
@@ -32,17 +19,17 @@ describe Ripple::EmbeddedDocument::Persistence do
     @root.should_receive(:save).and_return(true)
     @addr.save.should be_true
   end
-  
+
   it "should delegate save! to the root document" do
     @root.should_receive(:save).and_return(true)
     @addr.save!.should be_true
   end
-  
+
   it "should raise NoRootDocument when calling save without a root document" do
     @addr._parent_document = nil
     lambda { @addr.save }.should raise_error(Ripple::NoRootDocument)
   end
-  
+
   it "should raise NoRootDocument when calling save! without a root document" do
     @addr._parent_document = nil
     lambda { @addr.save! }.should raise_error(Ripple::NoRootDocument)
@@ -51,25 +38,32 @@ describe Ripple::EmbeddedDocument::Persistence do
   it "should have a root document" do
     @addr._root_document.should == @root
   end
-  
+
   it "should have a parent document" do
      @addr._parent_document.should == @root
   end
-  
+
   it "should respond to new_record?" do
     @addr.should respond_to(:new_record?)
     @addr.should be_a_new_record
   end
-  
+
   it "should respond to persisted" do
     @addr.should respond_to(:persisted?)
     @addr.should_not be_persisted
   end
-  
+
   it "should properly create embedded attributes for persistence" do
     @addr = Address.new
     @root.addresses << @addr
-    @root.attributes_for_persistence.should == {'_type' => 'User', 'addresses' => [{'_type' => 'Address', 'street' => nil}]}
+    @root.attributes_for_persistence.should == {'_type' => 'User', 'email' => nil, 'addresses' => [{'_type' => 'Address', 'street' => nil, 'kind' => nil}]}
+  end
+
+  it "includes undefined properties in the attributes for persistence" do
+    addr = Address.new
+    addr['some_undefined_prop'] = 17
+    @root.addresses << addr
+    @root.attributes_for_persistence['addresses'].first.should include('some_undefined_prop' => 17)
   end
 
   it "should modify its attributes and save" do

data/spec/ripple/embedded_document_spec.rb

@@ -1,21 +1,8 @@
-# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-require File.expand_path("../../spec_helper", __FILE__)
+require 'spec_helper'
 
 describe Ripple::EmbeddedDocument do
-  require 'support/models/address'
-  require 'support/models/user'
+  # require 'support/models/address'
+  # require 'support/models/user'
 
   it "should have a model name when included" do
     Address.should respond_to(:model_name)
@@ -26,9 +13,9 @@ describe Ripple::EmbeddedDocument do
     Address.should be_embeddable
   end
 
-  describe "#==" do
-    let(:user_1) { User.create! }
-    let(:user_2) { User.create! }
+  describe "equality" do
+    let(:user_1) { User.new {|u| u.key = "u1"} }
+    let(:user_2) { User.new {|u| u.key = "u2"} }
     let(:street_1) { '123 Somewhere St' }
     let(:street_2) { '123 Somewhere Ave' }
     let(:address_1) { Address.new(:street => street_1) }
@@ -39,36 +26,59 @@ describe Ripple::EmbeddedDocument do
       address_2._parent_document = user_1
     end
 
-    it "returns true when the documents have the same classes, parents and attributes" do
+    def should_be_equal
       (address_1 == address_2).should be_true
+      address_1.eql?(address_2).should be_true
+
       (address_2 == address_1).should be_true
+      address_2.eql?(address_1).should be_true
+
+      address_1.hash.should == address_2.hash
     end
 
-    it "returns true when the documents match and only one of them includes the _type attribute" do
-      attrs = address_1.attributes
-      address_1.stub(:attributes => attrs.merge('_type' => 'Address'))
+    def should_not_be_equal(other_address = address_2)
+      (address_1 == other_address).should be_false
+      address_1.eql?(other_address).should be_false
 
-      (address_1 == address_2).should be_true
-      (address_2 == address_1).should be_true
+      (other_address == address_1).should be_false
+      address_1.eql?(other_address).should be_false
+
+      address_1.hash.should_not == other_address.hash
+    end
+
+    specify "two document are equal when they have the same classes, parents and attributes" do
+      should_be_equal
     end
 
-    it "returns false when the parents are different (even if the attributes and classes are the same)" do
+    specify "two documents are not equal when the parents are different (even if the attributes and classes are the same)" do
       address_2._parent_document = user_2
-      (address_1 == address_2).should be_false
-      (address_2 == address_1).should be_false
+      should_not_be_equal
     end
 
-    it "returns false when the attributes are different (even if the parents and classes are the same)" do
+    specify "two documents are not equal when the attributes are different (even if the parents and classes are the same)" do
       address_2.street = street_2
-      (address_1 == address_2).should be_false
-      (address_2 == address_1).should be_false
+      should_not_be_equal
     end
 
-    it "returns false then the classes are different (even if the parents and attributes are the same)" do
+    specify "two documents are not equal when the classes are different (even if the parents and attributes are the same)" do
       special_address = SpecialAddress.new(address_1.attributes)
       special_address._parent_document = address_1._parent_document
-      (address_1 == special_address).should be_false
-      (special_address == address_1).should be_false
+
+      should_not_be_equal(special_address)
+    end
+
+    specify "two documents are not equal when their embedded documents are not equal (even if they are identical otherwise)" do
+      address_1.notes << Note.new(:text => 'Bob lives here')
+      address_2.notes << Note.new(:text => 'Jill lives here')
+
+      should_not_be_equal
+    end
+
+    specify "two documents can be equal when their embedded doc objects are different instances but are equal" do
+      address_1.notes << Note.new(:text => 'Bob lives here')
+      address_2.notes << Note.new(:text => 'Bob lives here')
+
+      should_be_equal
     end
   end
 end

data/spec/ripple/finders_spec.rb

@@ -1,22 +1,9 @@
-# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-require File.expand_path("../../spec_helper", __FILE__)
+require 'spec_helper'
 
 describe Ripple::Document::Finders do
-  require 'support/models/box'
-  require 'support/models/cardboard_box'
-  
+  # require 'support/models/box'
+  # require 'support/models/cardboard_box'
+
   before :each do
     @backend = mock("Backend")
     @client = Ripple.client
@@ -34,7 +21,7 @@ describe Ripple::Document::Finders do
     Box.find(nil).should be_nil
     Box.find("").should be_nil
   end
-  
+
   it "should raise Ripple::DocumentNotFound if an empty array is passed to find!" do
     lambda { Box.find!() }.should raise_error(Ripple::DocumentNotFound, "Couldn't find document without a key")
   end
@@ -43,7 +30,7 @@ describe Ripple::Document::Finders do
     before do
       @bucket.stub!(:get).with("square", {}).and_return(@plain)
     end
-    
+
     it "should find a single document by key and assign its attributes" do
       @bucket.should_receive(:get).with("square", {}).and_return(@plain)
       box = Box.find("square")
@@ -54,6 +41,11 @@ describe Ripple::Document::Finders do
       box.should_not be_new_record
     end
 
+    it "should have no changes after find" do
+      box = Box.find("square")
+      box.changes.should == {}
+    end
+
     it "should find the first document using the first key with the bucket's keys" do
       box  = Box.new
       keys = ['some_boxes_key']
@@ -110,9 +102,15 @@ describe Ripple::Document::Finders do
       box.should be_kind_of(Box)
       box.key.should == "square"
     end
+
+    it 'initializes the document with no changed attributes' do
+      box = Box.find("square")
+      box.should_not be_changed
+      box.changes.should be_empty
+    end
   end
 
-  describe "finding multiple documents" do
+  describe "finding multiple documents when given a splat of keys" do
     it "should find multiple documents by the keys" do
       @bucket.should_receive(:get).with("square", {}).and_return(@plain)
       @bucket.should_receive(:get).with("rectangle", {}).and_return(@cb)
@@ -141,12 +139,48 @@ describe Ripple::Document::Finders do
     end
   end
 
-  describe "finding all documents in the bucket" do
+  describe "finding multiple documents when given an array" do
+    it "should find multiple documents by the keys" do
+      @bucket.should_receive(:get).with("square", {}).and_return(@plain)
+      @bucket.should_receive(:get).with("rectangle", {}).and_return(@cb)
+      boxes = Box.find(["square", "rectangle"])
+      boxes.should have(2).items
+      boxes.first.shape.should == "square"
+      boxes.last.shape.should == "rectangle"
+    end
+
+    it "should return an array of docs when given an array of one key" do
+      @bucket.should_receive(:get).with("square", {}).and_return(@plain)
+      boxes = Box.find(["square"])
+      boxes.should have(1).items
+      boxes.first.shape.should == "square"
+    end
+
+    it "should return an empty array when given an empty array" do
+      Box.find([ ]).should == []
+    end
+
+    describe "when using find with missing keys" do
+      before :each do
+        @bucket.should_receive(:get).with("square", {}).and_return(@plain)
+        @bucket.should_receive(:get).with("rectangle", {}).and_raise(Riak::HTTPFailedRequest.new(:get, 200, 404, {}, "404 not found"))
+      end
+
+      it "should return nil for documents that no longer exist" do
+        boxes = Box.find(["square", "rectangle"])
+        boxes.should have(2).items
+        boxes.first.shape.should == "square"
+        boxes.last.should be_nil
+      end
+    end
+  end
+
+  describe "listings all documents in the bucket" do
     it "should load all objects in the bucket" do
       @bucket.should_receive(:keys).and_return(["square", "rectangle"])
       @bucket.should_receive(:get).with("square", {}).and_return(@plain)
       @bucket.should_receive(:get).with("rectangle", {}).and_return(@cb)
-      boxes = Box.all
+      boxes = Box.list
       boxes.should have(2).items
       boxes.first.shape.should == "square"
       boxes.last.shape.should == "rectangle"
@@ -156,7 +190,7 @@ describe Ripple::Document::Finders do
       @bucket.should_receive(:keys).and_return(["square", "rectangle"])
       @bucket.should_receive(:get).with("square", {}).and_return(@plain)
       @bucket.should_receive(:get).with("rectangle", {}).and_raise(Riak::HTTPFailedRequest.new(:get, 200, 404, {}, "404 not found"))
-      boxes = Box.all
+      boxes = Box.list
       boxes.should have(1).item
       boxes.first.shape.should == "square"
     end
@@ -167,16 +201,11 @@ describe Ripple::Document::Finders do
       @bucket.should_receive(:get).with("rectangle", {}).and_raise(Riak::HTTPFailedRequest.new(:get, 200, 404, {}, "404 not found"))
       @block = mock()
       @block.should_receive(:ping).once
-      Box.all do |box|
+      Box.list do |box|
         @block.ping
         ["square", "rectangle"].should include(box.shape)
       end.should == []
     end
-
-    it "should pass any given options to the underlying Bucket#keys method" do
-      @bucket.should_receive(:keys).with(:reload => true).and_return([])
-      Box.all(:reload => true).should == []
-    end
   end
 
   describe "single-bucket inheritance" do

data/spec/ripple/inspection_spec.rb

@@ -1,48 +1,51 @@
-# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-require File.expand_path("../../spec_helper", __FILE__)
+require 'spec_helper'
 
 describe Ripple::Inspection do
-  require 'support/models/box'
-  require 'support/models/address'
+  # require 'support/models/box'
+  # require 'support/models/address'
+
+  shared_examples_for 'an inspected document' do |method|
+
+    it "should include the class name in the inspect string" do
+      @box.send(method).should be_starts_with("<Box")
+    end
+
+    it "should include the key in the #{method} string for documents" do
+      @box.key = "square"
+      @box.send(method).should be_starts_with("<Box:square")
+    end
+
+    it "should indicate a new document when no key is specified" do
+      @box.send(method).should be_starts_with("<Box:[new]")
+    end
+
+    it "should not display a key for embedded documents" do
+      @address.send(method).should_not include("[new]")
+    end
+
+  end
 
   before :each do
     @box = Box.new
     @address = Address.new
   end
-  
-  it "should include the class name in the inspect string" do
-    @box.inspect.should be_starts_with("<Box")
-  end
-  
-  it "should include the key in the inspect string for documents" do
-    @box.key = "square"
-    @box.inspect.should be_starts_with("<Box:square")
-  end
-  
-  it "should indicate a new document when no key is specified" do
-    @box.inspect.should be_starts_with("<Box:[new]")
-  end
 
-  it "should enumerate the document's properties and their values" do
-    @box.shape = "square"
-    @box.inspect.should include("shape=\"square\"")
-    @box.inspect.should include("created_at=")
-    @box.inspect.should include("updated_at=")
+  describe '#inspect' do
+
+    it_should_behave_like 'an inspected document', :inspect
+
+    it "should enumerate the document's properties and their values" do
+      @box.shape = "square"
+      @box.inspect.should include("shape=\"square\"")
+      @box.inspect.should include("created_at=")
+      @box.inspect.should include("updated_at=")
+    end
+
   end
-  
-  it "should not display a key for embedded documents" do
-    @address.inspect.should_not include("[new]")
+
+  describe '#to_s' do
+
+    it_should_behave_like 'an inspected document', :to_s
+
   end
 end