ripple 0.6.1 → 0.7.0

data/spec/ripple/associations_spec.rb

@@ -0,0 +1,111 @@
+# 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::Associations do
+  require 'support/models/invoice'
+  require 'support/models/customer'
+  require 'support/models/note'
+
+  it "should provide access to the associations hash" do
+    Invoice.should respond_to(:associations)
+    Invoice.associations.should be_kind_of(Hash)
+  end
+  
+  it "should add associations on the class instance" do 
+    Invoice.new.should respond_to(:associations)
+    Invoice.new.associations.should be_kind_of(Hash)
+  end
+  
+  it "should collect the embedded associations" do
+    Invoice.new.embedded_associations.should == Array(Invoice.associations[:note])
+  end
+
+  it "should copy associations to a subclass" do
+    Invoice.associations[:foo] = "bar"
+    class SubInvoice < Invoice; end
+    SubInvoice.associations[:foo].should == "bar"
+  end
+
+  describe "when adding a :many association" do
+    it "should add accessor and mutator methods" do
+      Invoice.many :items
+      Invoice.instance_methods.map(&:to_sym).should include(:items)
+      Invoice.instance_methods.map(&:to_sym).should include(:items=)
+    end
+  end
+
+  describe "when adding a :one association" do
+    it "should add accessor, mutator, and query methods" do
+      Invoice.one :payee
+      Invoice.instance_methods.map(&:to_sym).should include(:payee)
+      Invoice.instance_methods.map(&:to_sym).should include(:payee=)
+      Invoice.instance_methods.map(&:to_sym).should include(:payee?)
+    end
+  end
+end
+
+describe Ripple::Document::Association do
+  it "should initialize with a type and name" do
+    lambda { Ripple::Document::Association.new(:many, :pages) }.should_not raise_error
+  end
+
+  describe "determining the class name" do
+    it "should default to the camelized class name on :one relationships" do
+      @association = Ripple::Document::Association.new(:one, :page)
+      @association.class_name.should == "Page"
+    end
+
+    it "should default to the singularized camelized class name on :many relationships" do
+      @association = Ripple::Document::Association.new(:many, :pages)
+      @association.class_name.should == "Page"
+    end
+
+    it "should use the :class_name option when given" do
+      @association = Ripple::Document::Association.new(:many, :pages, :class_name => "Note")
+      @association.class_name.should == "Note"
+    end
+  end
+
+  describe "determining the target class" do
+    require 'support/models/tree'
+
+    it "should default to the constantized class name" do
+      @association = Ripple::Document::Association.new(:one, :t, :class_name => "Trunk")
+      @association.klass.should == Trunk
+    end
+
+    it "should be determined by the derived class name" do
+      @association = Ripple::Document::Association.new(:many, :branches)
+      @association.klass.should == Branch
+    end
+
+    it "should use the :class option when given" do
+      @association = Ripple::Document::Association.new(:many, :pages, :class => Leaf)
+      @association.klass.should == Leaf
+    end
+  end
+
+  it "should be many when type is :many" do
+    Ripple::Document::Association.new(:many, :pages).should be_many
+  end
+
+  it "should be one when type is :one" do
+    Ripple::Document::Association.new(:one, :pages).should be_one
+  end
+
+  it "should determine an instance variable based on the name" do
+    Ripple::Document::Association.new(:many, :pages).ivar.should == "@_pages"
+  end
+end

data/spec/ripple/attribute_methods_spec.rb

@@ -14,16 +14,8 @@
 require File.expand_path("../../spec_helper", __FILE__)
 
 describe Ripple::Document::AttributeMethods do
-  before :all do
-    Object.module_eval do
-      class Widget
-        include Ripple::Document
-        property :size, Integer
-        property :name, String, :default => "widget"
-      end
-    end
-  end
-
+  require 'support/models/widget'
+  
   before :each do
     @widget = Widget.new
   end
@@ -40,9 +32,15 @@ describe Ripple::Document::AttributeMethods do
       @widget.key.should == "cog"
     end
 
-    it "should accept the key in mass assignment" do
-      @widget.attributes = {:key => "cog"}
-      @widget.key.should == "cog"
+    it "should not set the key from mass assignment" do
+      @widget.key = 'widget-key'
+      @widget.attributes = {'key' => 'new-key'}
+      @widget.key.should == 'widget-key'
+    end
+    
+    it "should typecast the key to a string" do
+      @widget.key = 10
+      @widget.key.should == "10"
     end
 
   end
@@ -60,6 +58,10 @@ describe Ripple::Document::AttributeMethods do
     it "should return the property default if defined and not set" do
       @widget.name.should == "widget"
     end
+    
+    it "should allow raw attribute access when accessing the document with []" do
+      @widget['name'].should == 'widget'
+    end
 
     it "should expose the property directly" do
       @widget.name.gsub!("w","f")
@@ -77,6 +79,11 @@ describe Ripple::Document::AttributeMethods do
       @widget.size = 10
       @widget.size.should == 10
     end
+    
+    it "should allow assignment of undefined attributes when assigning to the document with []=" do
+      @widget['name'] = 'sprocket'
+      @widget.name.should == 'sprocket'
+    end
 
     it "should type cast assigned values automatically" do
       @widget.name = :so_what
@@ -149,8 +156,22 @@ describe Ripple::Document::AttributeMethods do
     @widget = Widget.new(:name => "Riak")
     @widget.changes.should be_blank
   end
-
-  after :all do
-    Object.send(:remove_const, :Widget)
+  
+  it "should allow adding to the @attributes hash for attributes that do no exist" do
+    @widget = Widget.new
+    @widget['foo'] = 'bar'
+    @widget.instance_eval { @attributes['foo'] }.should == 'bar'
+  end
+  
+  it "should allow reading from the @attributes hash for attributes that do no exist" do
+    @widget = Widget.new
+    @widget['foo'] = 'bar'
+    @widget['foo'].should == 'bar'
+  end
+  
+  it "should allow a block upon initialization to set attributes protected from mass assignment" do
+    @widget = Widget.new { |w| w.key = 'some-key' }
+    @widget.key.should == 'some-key'
   end
+
 end

data/spec/ripple/bucket_access_spec.rb

@@ -14,13 +14,9 @@
 require File.expand_path("../spec_helper", File.dirname(__FILE__))
 
 describe Ripple::Document::BucketAccess do
-  before :all do
-    Object.module_eval do
-      class Invoice; include Ripple::Document; end
-      class LateInvoice < Invoice; end
-      class PaidInvoice < Invoice; self.bucket_name = "paid"; end
-    end
-  end
+  require 'support/models/invoice'
+  require 'support/models/late_invoice'
+  require 'support/models/paid_invoice'
 
   it "should use the plural model name as the bucket name" do
     Invoice.bucket_name.should == "invoices"
@@ -40,11 +36,4 @@ describe Ripple::Document::BucketAccess do
     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

@@ -13,10 +13,8 @@
 #    limitations under the License.
 require File.expand_path("../../spec_helper", __FILE__)
 
-describe Ripple::Document::Persistence::Callbacks do
-  before :all do
-    Object.module_eval { class Box; include Ripple::Document; property :shape, String end }
-  end
+describe Ripple::Document::Callbacks do
+  require 'support/models/box'
 
   it "should add create, update, save, and destroy callback declarations" do
     [:save, :create, :update, :destroy].each do |event|
@@ -27,6 +25,12 @@ describe Ripple::Document::Persistence::Callbacks do
     end
   end
 
+  it "should validate callback declarations" do
+    Box.private_instance_methods.map(&:to_s).should include("_run_validation_callbacks")
+    Box.should respond_to("before_validation")
+    Box.should respond_to("after_validation")
+  end
+
   describe "invoking callbacks" do
     before :each do
       response = {:headers => {"content-type" => ["application/json"]}, :body => "{}"}
@@ -72,15 +76,55 @@ describe Ripple::Document::Persistence::Callbacks do
       @box = Box.new
       @box.destroy
     end
+    
+    describe "validation callbacks" do
+      it "should call validation callbacks" do
+        Box.before_validation { $pinger.ping }
+        Box.after_validation  { $pinger.ping }
+        $pinger.should_receive(:ping).twice
+        @box = Box.new
+        @box.valid?
+      end
+      
+      it "should call validation callbacks only if the document is new" do
+        Box.before_validation(:on => :create) { $pinger.ping }
+        Box.after_validation(:on => :create) { $pinger.ping }
+        $pinger.should_receive(:ping).twice
+        @box = Box.new
+        @box.valid?
+      end
+
+      it "should not call validation callbacks only if the document is new" do
+        Box.before_validation(:on => :update) { $pinger.ping }
+        Box.after_validation(:on => :update) { $pinger.ping }
+        $pinger.should_not_receive(:ping)
+        @box = Box.new
+        @box.valid?
+      end
+      
+      it "should call validation callbacks only if the document is not new" do
+        Box.before_validation(:on => :update) { $pinger.ping }
+        Box.after_validation(:on => :update) { $pinger.ping }
+        $pinger.should_receive(:ping).twice
+        @box = Box.new
+        @box.stub(:new?).and_return(false)
+        @box.valid?
+      end
+
+      it "should not call validation callbacks only if the document is not new" do
+        Box.before_validation(:on => :create) { $pinger.ping }
+        Box.after_validation(:on => :create) { $pinger.ping }
+        $pinger.should_not_receive(:ping)
+        @box = Box.new
+        @box.stub!(:new?).and_return(false)
+        @box.valid?
+      end
+    end
 
     after :each do
-      [:save, :create, :update, :destroy].each do |type|
+      [:save, :create, :update, :destroy, :validation].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

@@ -14,12 +14,10 @@
 require File.expand_path("../spec_helper", File.dirname(__FILE__))
 
 describe Ripple::Document do
-  before :all do
-    Object.module_eval { class Page; include Ripple::Document; end }
-  end
+  require 'support/models/page'
 
   it "should add bucket access methods to classes when included" do
-    Page.metaclass.included_modules.should include(Ripple::Document::BucketAccess)
+    (class << Page; self; end).included_modules.should include(Ripple::Document::BucketAccess)
     Page.should respond_to(:bucket_name)
     Page.should respond_to(:bucket)
     Page.should respond_to(:bucket_name=)
@@ -29,7 +27,25 @@ describe Ripple::Document do
     Page.should_not be_embeddable
   end
 
-  after :all do
-    Object.module_eval { remove_const(:Page) }
+  describe "ActiveModel compatibility" do
+    include ActiveModel::Lint::Tests
+
+    before :each do
+      @model = Page.new
+    end
+
+    def assert(value, message="")
+      value.should be
+    end
+
+    def assert_kind_of(klass, value)
+      value.should be_kind_of(klass)
+    end
+
+    ActiveModel::Lint::Tests.instance_methods.grep(/^test/).each do |m|
+      it "#{m}" do
+        send(m)
+      end
+    end
   end
 end

data/spec/ripple/embedded_document/conversion_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__)
+
+describe Ripple::EmbeddedDocument::Conversion do
+  require 'support/models/address'
+
+  before :each do
+    @addr = Address.new { |a| a.key = 'some-key' }
+    @addr.stub!(:new?).and_return(false)
+  end
+
+  it "should return the key as an array for to_key" do
+    @addr.to_key.should == ['some-key']
+  end
+  
+  it "should be able to be converted to a param" do
+    @addr.to_param.should == 'some-key'
+  end
+  
+  it "should be able to be converted to a model" do
+    @addr.to_model.should == @addr
+  end
+end

data/spec/{riak/headers_spec.rb → ripple/embedded_document/finders_spec.rb}

@@ -11,24 +11,27 @@
 #    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__))
+require File.expand_path("../../../spec_helper", __FILE__)
 
-describe Riak::Util::Headers do
-  it "should include the Net::HTTPHeader module" do
-    Riak::Util::Headers.included_modules.should include(Net::HTTPHeader)
-  end
+describe Ripple::EmbeddedDocument::Finders do
+  require 'support/models/address'
+  require 'support/models/favorite'
 
-  it "should be initially empty" do
-    Riak::Util::Headers.new.to_hash.should == {}
+  before :each do
+    @addr = Address.new
   end
 
-  it "should parse a header line into the key and value" do
-    Riak::Util::Headers.parse("Content-Type: text/plain\n").should == ["Content-Type", "text/plain"]
+  it "should instantiate a document" do
+    Address.stub!(:new).and_return(@address)
+    Address.instantiate('_type' => 'Address').should == @address
   end
-
-  it "should parse a header line and add it to the collection" do
-    h = Riak::Util::Headers.new
-    h.parse("Content-Type: text/plain\n")
-    h.to_hash.should == {"content-type" => ["text/plain"]}
+  
+  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
+
 end

data/spec/ripple/embedded_document/persistence_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::EmbeddedDocument::Persistence do
+  require 'support/models/user'
+  require 'support/models/address'
+  
+  before :each do
+    @root = User.new
+    @addr = Address.new
+    @addr._parent_document = @root
+  end
+  
+  it "should be embeddable if including Ripple::EmbeddedDocument" do
+    @addr.should be_embeddable
+  end
+  
+  it "should not be a root document if including Ripple::EmbeddedDocument" do
+    @addr.should_not be__root_document
+  end
+  
+  it "should be a root document if including Ripple::Document" do
+    @root.should be__root_document
+  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
+  
+  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 = Address.new
+    lambda { @addr.save }.should raise_error(Ripple::NoRootDocument)
+  end
+  
+  it "should raise NoRootDocument when calling save! without a root document" do
+    @addr = Address.new
+    lambda { @addr.save! }.should raise_error(Ripple::NoRootDocument)
+  end
+
+  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}]}
+  end
+end