ripple 0.5.0

data/spec/ripple/attribute_methods_spec.rb

@@ -0,0 +1,149 @@
+# 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__)
+
+describe Ripple::Document::AttributeMethods do
+  before :all do
+    class Widget
+      include Ripple::Document
+      property :size, Integer
+      property :name, String, :default => "widget"
+    end
+  end
+
+  before :each do
+    @widget = Widget.new
+  end
+
+  describe "object key" do
+    it "should provide access to the key" do
+      @widget.should respond_to(:key)
+      @widget.key.should be_nil
+    end
+
+    it "should provide a mutator for the key" do
+      @widget.should respond_to(:key=)
+      @widget.key = "cog"
+      @widget.key.should == "cog"
+    end
+
+    it "should accept the key in mass assignment" do
+      @widget.attributes = {:key => "cog"}
+      @widget.key.should == "cog"
+    end
+
+  end
+
+  describe "accessors" do
+    it "should be defined for defined properties" do
+      @widget.should respond_to(:size)
+      @widget.should respond_to(:name)
+    end
+
+    it "should return nil if no default is defined on the property" do
+      @widget.size.should be_nil
+    end
+
+    it "should return the property default if defined and not set" do
+      @widget.name.should == "widget"
+    end
+  end
+
+  describe "mutators" do
+    it "should have mutators for defined properties" do
+      @widget.should respond_to(:size=)
+      @widget.should respond_to(:name=)
+    end
+
+    it "should assign the value of the attribute" do
+      @widget.size = 10
+      @widget.size.should == 10
+    end
+
+    it "should type cast assigned values automatically" do
+      @widget.name = :so_what
+      @widget.name.should == "so_what"
+    end
+
+    it "should raise an error when assigning a bad value" do
+      lambda { @widget.size = true }.should raise_error(Ripple::PropertyTypeMismatch)
+    end
+  end
+
+  describe "query methods" do
+    it "should be defined for defined properties" do
+      @widget.should respond_to(:size?)
+      @widget.should respond_to(:name?)
+    end
+
+    it "should be false when the attribute is nil" do
+      @widget.size.should be_nil
+      @widget.size?.should be_false
+    end
+
+    it "should be true when the attribute has a value present" do
+      @widget.size = 10
+      @widget.size?.should be_true
+    end
+
+    it "should be false for 0 values" do
+      @widget.size = 0
+      @widget.size?.should be_false
+    end
+
+    it "should be false for empty values" do
+      @widget.name = ""
+      @widget.name?.should be_false
+    end
+  end
+
+  it "should track changes to attributes" do
+    @widget.name = "foobar"
+    @widget.changed?.should be_true
+    @widget.name_changed?.should be_true
+    @widget.name_change.should == ["widget", "foobar"]
+    @widget.changes.should == {"name" => ["widget", "foobar"]}
+  end
+
+
+  it "should refresh the attribute methods when adding a new property" do
+    Widget.should_receive(:undefine_attribute_methods)
+    Widget.property :start_date, Date
+    Widget.properties.delete(:start_date) # cleanup
+  end
+
+  it "should provide a hash representation of all of the attributes" do
+    @widget.attributes.should == {"name" => "widget", "size" => nil}
+  end
+
+  it "should load attributes from mass assignment" do
+    @widget.attributes = {"name" => "Riak", "size" => 100000 }
+    @widget.name.should == "Riak"
+    @widget.size.should == 100000
+  end
+
+  it "should assign attributes on initialization" do
+    @widget = Widget.new(:name => "Riak")
+    @widget.name.should == "Riak"
+  end
+
+  it "should have no changed attributes after initialization" do
+    @widget = Widget.new(:name => "Riak")
+    @widget.changes.should be_blank
+  end
+
+  after :all do
+    Object.send(:remove_const, :Widget)
+  end
+end

data/spec/ripple/bucket_access_spec.rb

@@ -0,0 +1,48 @@
+# 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.dirname(__FILE__))
+
+describe Ripple::Document::BucketAccess do
+  before :all do
+    class Invoice; include Ripple::Document; end
+    class LateInvoice < Invoice; end
+    class PaidInvoice < Invoice; self.bucket_name = "paid"; end
+  end
+
+  it "should use the plural model name as the bucket name" do
+    Invoice.bucket_name.should == "invoices"
+  end
+
+  it "should use the parent bucket name by default (SBI)" do
+    LateInvoice.bucket_name.should == "invoices"
+  end
+
+  it "should allow a class to set the bucket name" do
+    PaidInvoice.bucket_name.should == "paid"
+  end
+
+  it "should allow access to the bucket" do
+    bucket = Riak::Bucket.new(Ripple.client, "invoices")
+    Ripple.client.should_receive(:[]).with("invoices", {:keys => false}).and_return(bucket)
+    Invoice.bucket.should == bucket
+  end
+
+  after :all do
+    Object.module_eval do
+      remove_const(:PaidInvoice)
+      remove_const(:LateInvoice)
+      remove_const(:Invoice)
+    end
+  end
+end

data/spec/ripple/callbacks_spec.rb

@@ -0,0 +1,86 @@
+# 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__)
+
+describe Ripple::Document::Persistence::Callbacks do
+  before :all do
+    class Box; include Ripple::Document; property :shape, String end
+  end
+
+  it "should add create, update, save, and destroy callback declarations" do
+    [:save, :create, :update, :destroy].each do |event|
+      Box.private_instance_methods.should include("_run_#{event}_callbacks")
+      [:before, :after, :around].each do |time|
+        Box.should respond_to("#{time}_#{event}")
+      end
+    end
+  end
+
+  describe "invoking callbacks" do
+    before :each do
+      response = {:headers => {"content-type" => ["application/json"]}, :body => "{}"}
+      @client = Ripple.client
+      @http = mock("HTTP Backend", :get => response, :put => response, :post => response, :delete => response)
+      @client.stub!(:http).and_return(@http)
+      $pinger = mock("callback verifier")
+    end
+
+    it "should call save callbacks on save" do
+      Box.before_save { $pinger.ping }
+      Box.after_save { $pinger.ping }
+      Box.around_save(lambda { $pinger.ping })
+      $pinger.should_receive(:ping).exactly(3).times
+      @box = Box.new
+      @box.save
+    end
+
+    it "should call create callbacks on save when the document is new" do
+      Box.before_create { $pinger.ping }
+      Box.after_create { $pinger.ping }
+      Box.around_create(lambda { $pinger.ping })
+      $pinger.should_receive(:ping).exactly(3).times
+      @box = Box.new
+      @box.save
+    end
+
+    it "should call update callbacks on save when the document is not new" do
+      Box.before_update { $pinger.ping }
+      Box.after_update { $pinger.ping }
+      Box.around_update(lambda { $pinger.ping })
+      $pinger.should_receive(:ping).exactly(3).times
+      @box = Box.new
+      @box.stub!(:new?).and_return(false)
+      @box.save
+    end
+
+    it "should call destroy callbacks" do
+      Box.before_destroy { $pinger.ping }
+      Box.after_destroy { $pinger.ping }
+      Box.around_destroy(lambda { $pinger.ping })
+      $pinger.should_receive(:ping).exactly(3).times
+      @box = Box.new
+      @box.destroy
+    end
+
+    after :each do
+      [:save, :create, :update, :destroy].each do |type|
+        Box.reset_callbacks(type)
+      end
+    end
+  end
+
+  after :all do
+    Object.send(:remove_const, :Box)
+  end
+end

data/spec/ripple/document_spec.rb

@@ -0,0 +1,35 @@
+# 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.dirname(__FILE__))
+
+describe Ripple::Document do
+  before :all do
+    class Page; include Ripple::Document; end
+  end
+
+  it "should add bucket access methods to classes when included" do
+    Page.metaclass.included_modules.should include(Ripple::Document::BucketAccess)
+    Page.should respond_to(:bucket_name)
+    Page.should respond_to(:bucket)
+    Page.should respond_to(:bucket_name=)
+  end
+
+  it "should not be embeddable" do
+    Page.should_not be_embeddable
+  end
+
+  after :all do
+    Object.module_eval { remove_const(:Page) }
+  end
+end

data/spec/ripple/embedded_document_spec.rb

@@ -0,0 +1,52 @@
+# 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__)
+
+describe Ripple::EmbeddedDocument do
+  before :all do
+    class Address; include Ripple::EmbeddedDocument; end
+  end
+
+  it "should have a model name when included" do
+    Address.should respond_to(:model_name)
+    Address.model_name.should be_kind_of(ActiveModel::Name)
+  end
+
+  it "should be embeddable" do
+    Address.should be_embeddable
+  end
+
+  describe "persistence" do
+    before :each do
+      @root = mock("root document")
+      @root.stub!(:new?).and_return(true)
+      @addr = Address.new
+      @addr._root_document = @root
+    end
+
+    it "should delegate new? to the root document" do
+      @root.should_receive(:new?).and_return(true)
+      @addr.should be_new
+    end
+
+    it "should delegate save to the root document" do
+      @root.should_receive(:save).and_return(true)
+      @addr.save.should be_true
+    end
+  end
+
+  after :all do
+    Object.send(:remove_const, :Address)
+  end
+end

data/spec/ripple/finders_spec.rb

@@ -0,0 +1,146 @@
+# 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__)
+
+describe Ripple::Document::Finders do
+  before :all do
+    class Box
+      include Ripple::Document
+      property :shape, String
+    end
+  end
+
+  before :each do
+    @http = mock("HTTP Backend")
+    @client = Ripple.client
+    @client.stub!(:http).and_return(@http)
+    @bucket = Riak::Bucket.new(@client, "boxes")
+    @client.stub!(:[]).and_return(@bucket)
+  end
+
+  it "should return an empty array if no keys are passed to find" do
+    Box.find().should == []
+  end
+
+  describe "finding single documents" do
+    it "should find a single document by key and assign its attributes" do
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "square", {}, {}).and_return({:code => 200, :headers => {"content-type" => ["application/json"]}, :body => '{"shape":"square"}'})
+      box = Box.find("square")
+      box.should be_kind_of(Box)
+      box.shape.should == "square"
+      box.key.should == "square"
+      box.instance_variable_get(:@robject).should_not be_nil
+      box.should_not be_new_record
+    end
+
+    it "should return nil when no object exists at that key" do
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "square", {}, {}).and_raise(Riak::FailedRequest.new(:get, 200, 404, {}, "404 not found"))
+      box = Box.find("square")
+      box.should be_nil
+    end
+
+    it "should re-raise the failed request exception if not a 404" do
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "square", {}, {}).and_raise(Riak::FailedRequest.new(:get, 200, 500, {}, "500 internal server error"))
+      lambda { Box.find("square") }.should raise_error(Riak::FailedRequest)
+    end
+  end
+
+  describe "finding multiple documents" do
+    it "should find multiple documents by the keys" do
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "square", {}, {}).and_return({:code => 200, :headers => {"content-type" => ["application/json"]}, :body => '{"shape":"square"}'})
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "rectangle", {}, {}).and_return({:code => 200, :headers => {"content-type" => ["application/json"]}, :body => '{"shape":"rectangle"}'})
+      boxes = Box.find("square", "rectangle")
+      boxes.should have(2).items
+      boxes.first.shape.should == "square"
+      boxes.last.shape.should == "rectangle"
+    end
+
+    it "should return nil for documents that no longer exist" do
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "square", {}, {}).and_return({:code => 200, :headers => {"content-type" => ["application/json"]}, :body => '{"shape":"square"}'})
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "rectangle", {}, {}).and_raise(Riak::FailedRequest.new(:get, 200, 404, {}, "404 not found"))
+      boxes = Box.find("square", "rectangle")
+      boxes.should have(2).items
+      boxes.first.shape.should == "square"
+      boxes.last.should be_nil
+    end
+  end
+
+  describe "finding all documents in the bucket" do
+    it "should load all objects in the bucket" do
+      @bucket.should_receive(:keys).and_return(["square", "rectangle"])
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "square", {}, {}).and_return({:code => 200, :headers => {"content-type" => ["application/json"]}, :body => '{"shape":"square"}'})
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "rectangle", {}, {}).and_return({:code => 200, :headers => {"content-type" => ["application/json"]}, :body => '{"shape":"rectangle"}'})
+      boxes = Box.all
+      boxes.should have(2).items
+      boxes.first.shape.should == "square"
+      boxes.last.shape.should == "rectangle"
+    end
+
+    it "should exclude objects that are not found" do
+      @bucket.should_receive(:keys).and_return(["square", "rectangle"])
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "square", {}, {}).and_return({:code => 200, :headers => {"content-type" => ["application/json"]}, :body => '{"shape":"square"}'})
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "rectangle", {}, {}).and_raise(Riak::FailedRequest.new(:get, 200, 404, {}, "404 not found"))
+      boxes = Box.all
+      boxes.should have(1).item
+      boxes.first.shape.should == "square"
+    end
+
+    it "should yield found objects to the passed block and return an empty array" do
+      @bucket.should_receive(:keys).and_yield("square").and_yield("rectangle")
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "square", {}, {}).and_return({:code => 200, :headers => {"content-type" => ["application/json"]}, :body => '{"shape":"square"}'})
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "rectangle", {}, {}).and_return({:code => 200, :headers => {"content-type" => ["application/json"]}, :body => '{"shape":"rectangle"}'})
+      @block = mock()
+      @block.should_receive(:ping).twice
+      Box.all do |box|
+        @block.ping
+        ["square", "rectangle"].should include(box.shape)
+      end.should == []
+    end
+
+    it "should yield found objects to the passed block, excluding missing objects, and return an empty array" do
+      @bucket.should_receive(:keys).and_yield("square").and_yield("rectangle")
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "square", {}, {}).and_return({:code => 200, :headers => {"content-type" => ["application/json"]}, :body => '{"shape":"square"}'})
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "rectangle", {}, {}).and_raise(Riak::FailedRequest.new(:get, 200, 404, {}, "404 not found"))
+      @block = mock()
+      @block.should_receive(:ping).once
+      Box.all do |box|
+        @block.ping
+        ["square", "rectangle"].should include(box.shape)
+      end.should == []
+    end
+  end
+
+  describe "single-bucket inheritance" do
+    before :all do
+      class CardboardBox < Box; end
+    end
+
+    it "should instantiate as the proper type if defined in the document" do
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "square", {}, {}).and_return({:code => 200, :headers => {"content-type" => ["application/json"]}, :body => '{"shape":"square"}'})
+      @http.should_receive(:get).with(200, "/raw/", "boxes", "rectangle", {}, {}).and_return({:code => 200, :headers => {"content-type" => ["application/json"]}, :body => '{"shape":"rectangle", "_type":"CardboardBox"}'})
+      boxes = Box.find("square", "rectangle")
+      boxes.should have(2).items
+      boxes.first.should_not be_kind_of(CardboardBox)
+      boxes.last.should be_kind_of(CardboardBox)
+    end
+
+    after :all do
+      Object.send(:remove_const, :CardboardBox)
+    end
+  end
+
+  after :all do
+    Object.send(:remove_const, :Box)
+  end
+end