ripple 0.7.1 → 0.8.0.beta

data/lib/ripple/associations/one_linked_proxy.rb

@@ -0,0 +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 'ripple'
+
+module Ripple
+  module Associations
+    class OneLinkedProxy < Proxy
+      include One
+      include Linked
+
+      protected
+      def find_target
+        return nil if links.blank?
+        klass.send(:instantiate,robjects.first)
+      end
+    end
+  end
+end

data/lib/ripple/attribute_methods/dirty.rb

@@ -20,7 +20,7 @@ module Ripple
       include ActiveModel::Dirty
 
       # @private
-      def save
+      def save(*args)
         if result = super
           changed_attributes.clear
         end
@@ -29,7 +29,7 @@ module Ripple
 
       # @private
       def reload
-        returning super do
+        super.tap do
           changed_attributes.clear
         end
       end

data/lib/ripple/core_ext.rb

@@ -0,0 +1 @@
+require 'ripple/core_ext/casting'

data/lib/ripple/core_ext/casting.rb

@@ -57,13 +57,15 @@ end
 # @private
 class String
   def self.ripple_cast(value)
+    return nil if value.nil?
     value.respond_to?(:to_s) && value.to_s or raise Ripple::PropertyTypeMismatch.new(self, value)
   end
 end
 
 # Stand-in for true/false property types.
-module Boolean
-  def self.ripple_cast(value)
+module ::Boolean
+  extend self
+  def ripple_cast(value)
     case value
     when NilClass
       nil
@@ -83,16 +85,12 @@ end
 
 # @private
 class TrueClass
-  def self.ripple_cast(value)
-    Boolean.ripple_cast(value)
-  end
+  extend Boolean
 end
 
 # @private
 class FalseClass
-  def self.ripple_cast(value)
-    Boolean.ripple_cast(value)
-  end
+  extend Boolean
 end
 
 # @private

data/lib/ripple/document.rb

@@ -58,6 +58,7 @@ module Ripple
       include Ripple::Callbacks
       include Ripple::Conversion
       include Ripple::Document::Finders
+      include Ripple::Inspection
     end
 
     module ClassMethods

data/lib/ripple/document/bucket_access.rb

@@ -25,7 +25,7 @@ module Ripple
 
       # @return [Riak::Bucket] The bucket assigned to this class.
       def bucket
-        Ripple.client[bucket_name, {:keys => false}]
+        Riak::Bucket.new(Ripple.client, bucket_name)
       end
 
       # Set the bucket name for this class and its subclasses.

data/lib/ripple/document/finders.rb

@@ -110,7 +110,7 @@ module Ripple
 
         private
         def find_one(key)
-          instantiate(bucket.get(key))
+          instantiate(bucket.get(key, quorums.slice(:r)))
         rescue Riak::FailedRequest => fr
           return nil if fr.code.to_i == 404
           raise fr

data/lib/ripple/document/persistence.rb

@@ -18,9 +18,9 @@ module Ripple
     module Persistence
       extend ActiveSupport::Concern
       extend ActiveSupport::Autoload
-      
+
       module ClassMethods
-        
+
         # Instantiates a new record, applies attributes from a block, and saves it
         def create(attrs={}, &block)
           new(attrs, &block).tap {|s| s.save}
@@ -31,7 +31,13 @@ module Ripple
         def destroy_all
           all(&:destroy)
         end
-        
+
+        attr_writer :quorums
+        alias_method "set_quorums", "quorums="
+
+        def quorums
+          @quorums ||= {}
+        end
       end
 
       module InstanceMethods
@@ -46,12 +52,27 @@ module Ripple
           @new || false
         end
 
+        # Updates a single attribute and then saves the document
+        # NOTE: THIS SKIPS VALIDATIONS! Use with caution.
+        # @return [true,false] whether the document succeeded in saving
+        def update_attribute(attribute, value)
+          send("#{attribute}=", value)
+          save(:validate => false)
+        end
+
+        # Writes new attributes and then saves the document
+        # @return [true,false] whether the document succeeded in saving
+        def update_attributes(attrs)
+          self.attributes = attrs
+          save
+        end
+
         # Saves the document in Riak.
         # @return [true,false] whether the document succeeded in saving
-        def save
+        def save(*args)
           robject.key = key if robject.key != key
           robject.data = attributes_for_persistence
-          robject.store
+          robject.store(self.class.quorums.slice(:w,:dw))
           self.key = robject.key
           @new = false
           true
@@ -70,7 +91,7 @@ module Ripple
 
         # Deletes the document from Riak and freezes this instance
         def destroy
-          robject.delete unless new?
+          robject.delete(self.class.quorums.slice(:rw)) unless new?
           freeze
           true
         rescue Riak::FailedRequest
@@ -81,8 +102,7 @@ module Ripple
         def freeze
           @attributes.freeze; super
         end
-        
-        protected
+
         attr_writer :robject
 
         def robject

data/lib/ripple/embedded_document.rb

@@ -34,6 +34,7 @@ module Ripple
       include Ripple::Callbacks
       include Ripple::Conversion
       include Finders
+      include Ripple::Inspection
     end
 
     module ClassMethods

data/lib/ripple/embedded_document/persistence.rb

@@ -42,6 +42,16 @@ module Ripple
           end
         end
 
+        def update_attributes(attrs)
+          self.attributes = attrs
+          save
+        end
+
+        def update_attribute(attribute, value)
+          send("#{attribute}=", value)
+          save(:validate => false)
+        end
+
         def save(*args)
           if _root_document
             _root_document.save(*args)
@@ -57,7 +67,7 @@ module Ripple
         def _root_document
           @_parent_document.try(:_root_document)
         end
-        
+
         def _parent_document=(value)
           @_parent_document = value
         end

data/lib/ripple/inspection.rb

@@ -0,0 +1,26 @@
+# 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 'ripple'
+
+module Ripple
+  # Makes IRB and other inspect output a bit friendlier
+  module Inspection
+    def inspect
+      attribute_list = attributes_for_persistence.except("_type").map {|k,v| "#{k}=#{v.inspect}" }.join(' ')
+      identifier = self.class.embeddable? ? "" : ":#{key || '[new]'}"
+      "<#{self.class.name}#{identifier} #{attribute_list}>"
+    end
+  end
+end

data/lib/ripple/locale/en.yml

@@ -13,11 +13,14 @@
 #    limitations under the License.
 en:
   ripple:
-    property_type_mismatch: "Cannot cast {{value}} into a {{class}}"
     attribute_hash: "value of attributes must be a Hash"
-    document_invalid: "Validation failed: {{errors}}"
+    document_invalid: "Validation failed: %{errors}"
     document_not_found: 
       no_key: "Couldn't find document without a key"
-      one_key: "Couldn't find document with key: {{key}}"
-      many_keys: "Couldn't find documents with keys: {{keys}}"
-    no_root_document: "You cannot call {{method}} on {{doc}} without a root document"
+      one_key: "Couldn't find document with key: %{key}"
+      many_keys: "Couldn't find documents with keys: %{keys}"
+    invalid_association_value: "Invalid value %{value} for association %{name} of type %{klass} on %{owner}"
+    missing_configuration: "You are missing your ripple configuration file that should be at %{file}"
+    no_root_document: "You cannot call %{method} on %{doc} without a root document"
+    property_type_mismatch: "Cannot cast %{value} into a %{class}"
+

data/lib/ripple/railtie.rb

@@ -12,21 +12,11 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 require 'ripple'
-require 'rails'
 
-# require in gemfile using
-# <tt>gem "ripple", :require_as => ["ripple", "ripple/railtie"]</tt>
 module Ripple
   class Railtie < Rails::Railtie
-    railtie_name :ripple
-    
     initializer "ripple.configure_rails_initialization" do
-      Ripple.load_configuration
+      Ripple.load_configuration Rails.root.join('config', 'ripple.yml'), [Rails.env]
     end
   end
-  
-  def self.load_configuration
-    config_file = Rails.root.join('config', 'database.yml')
-    self.config = YAML.load_file(File.expand_path config_file).with_indifferent_access[:ripple][Rails.env]
-  end
-end
+end

data/lib/ripple/validations.rb

@@ -64,6 +64,11 @@ module Ripple
       def save!
         (raise Ripple::DocumentInvalid.new(self) unless save) || true
       end
+
+      def update_attributes!(attrs)
+        self.attributes = attrs
+        save!
+      end
     end
   end
 end

data/lib/ripple/validations/associated_validator.rb

@@ -14,14 +14,13 @@
 #
 # Taken from ActiveRecord::Validations::AssociatedValidators
 #
-
 require 'ripple'
 
 module Ripple
   module Validations
     class AssociatedValidator < ActiveModel::EachValidator
       def validate_each(record, attribute, value)
-        unless Array(value).all? {|r| r.nil? || r.valid? }
+        unless Array(value).map {|r| r.nil? || r.valid? }.all?
           record.errors.add(attribute, :invalid, :default => options[:message], :value => value)
         end
       end

data/spec/fixtures/config.yml

@@ -1,3 +1,8 @@
 ripple:
   port: 9000
-  host: localhost
+  host: localhost
+  
+ripple_rails:
+  development:
+    port: 9001
+    host: 127.0.0.1

data/spec/integration/ripple/associations_spec.rb

@@ -21,6 +21,8 @@ describe "Ripple Associations" do
         one  :profile
         many :addresses
         property :email, String, :presence => true
+        many :friends, :class_name => "User"
+        one :emergency_contact, :class_name => "User"
       end
       class Profile
         include Ripple::EmbeddedDocument
@@ -41,6 +43,8 @@ describe "Ripple Associations" do
     @profile  = Profile.new(:name => 'Ripple')
     @billing  = Address.new(:street => '123 Somewhere Dr', :kind => 'billing')
     @shipping = Address.new(:street => '321 Anywhere Pl', :kind => 'shipping')
+    @friend1 = User.create(:email => "friend@ripple.com")
+    @friend2 = User.create(:email => "friend2@ripple.com")
   end
   
   it "should save one embedded associations" do
@@ -66,6 +70,23 @@ describe "Ripple Associations" do
     @bill.should be_a(Address)
     @ship.should be_a(Address)
   end
+
+  it "should save a many linked association" do    
+    @user.friends << @friend1 << @friend2
+    @user.save
+    @user.should_not be_new_record
+    @found = User.find(@user.key)
+    @found.friends.map(&:key).should include(@friend1.key)
+    @found.friends.map(&:key).should include(@friend2.key)
+  end
+
+  it "should save a one linked association" do
+    @user.emergency_contact = @friend1
+    @user.save
+    @user.should_not be_new_record
+    @found = User.find(@user.key)
+    @found.emergency_contact.key.should == @friend1.key
+  end
   
   after :each do
     User.destroy_all

data/spec/ripple/associations/many_embedded_proxy_spec.rb

@@ -121,4 +121,10 @@ describe Ripple::Associations::ManyEmbeddedProxy do
     @user.addresses << @address
     @user.addresses.to_ary.should == [@address]
   end
+
+  it "should refuse assigning documents of the wrong type" do
+    lambda { @user.addresses = nil }.should raise_error
+    lambda { @user.addresses = @address }.should raise_error
+    lambda { @user.addresses = [@note] }.should raise_error
+  end
 end

data/spec/ripple/associations/many_linked_proxy_spec.rb

@@ -0,0 +1,103 @@
+# 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::Associations::ManyLinkedProxy do
+  require 'support/models/tasks'
+
+  before :each do
+    @person = Person.new {|p| p.key = "riak-user" }
+    @task = Task.new {|t| t.key = "one" }
+    @other_task = Task.new {|t| t.key = "two" }
+    [@person, @task, @other_task].each do |doc|
+      doc.stub!(:new?).and_return(false)
+    end
+  end
+
+  it "should be empty before any associated documents are set" do
+    @person.tasks.should be_empty
+  end
+
+  it "should accept an array of documents" do
+    @person.tasks = [@task]
+  end
+
+  it "should set the links on the RObject when assigning" do
+    @person.tasks = [@task]
+    @person.robject.links.should include(@task.robject.to_link("tasks"))
+  end
+
+  it "should return the assigned documents when assigning" do
+    t = (@person.tasks = [@task])
+    t.should == [@task]
+  end
+
+  it "should save unsaved documents when assigning" do
+    @task.should_receive(:new?).and_return(true)
+    @task.should_receive(:save).and_return(true)
+    @person.tasks = [@task]
+  end
+
+  it "should link-walk to the associated documents when accessing" do
+    @person.robject.links << @task.robject.to_link("tasks")
+    @person.robject.should_receive(:walk).with(Riak::WalkSpec.new(:bucket => "tasks", :tag => "tasks")).and_return([])
+    @person.tasks.should == []
+  end
+
+  it "should replace associated documents with a new set" do
+    @person.tasks = [@task]
+    @person.tasks = [@other_task]
+    @person.tasks.should == [@other_task]
+  end
+
+  it "should be able to append documents to the associated set" do
+    @person.tasks << @task
+    @person.tasks << @other_task
+    @person.should have(2).tasks
+  end
+
+  it "should be able to chain calls to adding documents" do
+    @person.tasks << @task << @other_task
+    @person.should have(2).tasks
+  end
+
+  it "should set the links on the RObject when appending" do
+    @person.tasks << @task << @other_task
+    [@task, @other_task].each do |t|
+      @person.robject.links.should include(t.robject.to_link("tasks"))
+    end
+  end
+
+  it "should be able to count the associated documents" do
+    @person.tasks << @task
+    @person.tasks.count.should == 1
+    @person.tasks << @other_task
+    @person.tasks.count.should == 2
+  end
+
+  # it "should be able to build a new associated document" do
+  #   pending "Need unsaved document support"
+  # end
+
+  it "should return an array from to_ary" do
+    @person.tasks << @task
+    @person.tasks.to_ary.should == [@task]
+  end
+
+  it "should refuse assigning a collection of the wrong type" do
+    lambda { @person.tasks = nil }.should raise_error
+    lambda { @person.tasks = @task }.should raise_error
+    lambda { @person.tasks = [@person] }.should raise_error
+  end
+end