ripple 0.8.0.beta2 → 0.8.0

data/lib/rails/generators/ripple/model/model_generator.rb

@@ -1,3 +1,17 @@
+# 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 'rails/generators/ripple_generator'
 
 module Ripple

data/lib/rails/generators/ripple_generator.rb

@@ -1,8 +1,23 @@
+# 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 "rails/generators/named_base"
 require "rails/generators/active_model"
 
 module Ripple
+  # ActiveModel generators for use in a Rails project.
   module Generators
+    # @private
     class Base < ::Rails::Generators::NamedBase
 
       def self.source_root
@@ -11,6 +26,7 @@ module Ripple
       end
     end
 
+    # Generator for a {Ripple::Document} model
     class ActiveModel < ::Rails::Generators::ActiveModel
       def self.all(klass)
         "#{klass}.all"
@@ -47,6 +63,7 @@ module Ripple
   end
 end
 
+# @private
 module Rails
   module Generators
     class GeneratedAttribute #:nodoc:

data/lib/ripple.rb

@@ -57,15 +57,19 @@ module Ripple
       Thread.current[:ripple_client] = value
     end
 
+    # Sets the global Ripple configuration.
     def config=(hash)
       self.client = nil
       @config = hash.symbolize_keys
     end
 
+    # Reads the global Ripple configuration.
     def config
       @config ||= {}
     end
 
+    # Loads the Ripple configuration from a given YAML file.
+    # Evaluates the configuration with ERB before loading.
     def load_configuration(config_file, config_keys = [:ripple])
       config_file = File.expand_path(config_file)
       config_hash = YAML.load(ERB.new(File.read(config_file)).result).with_indifferent_access
@@ -76,7 +80,9 @@ module Ripple
     end
     alias_method :load_config, :load_configuration
   end
-  
+
+  # Exception raised when the path passed to
+  # {Ripple::load_configuration} does not point to a existing file.
   class MissingConfiguration < StandardError
     include Translation
     def initialize(file_path)

data/lib/ripple/associations.rb

@@ -14,6 +14,38 @@
 require 'ripple'
 
 module Ripple
+  # Adds associations via links and embedding to {Ripple::Document}
+  # models. Examples:
+  # 
+  #   # Documents can contain embedded documents, and link to other standalone documents
+  #   # via associations using the many and one class methods.
+  #   class Person
+  #     include Ripple::Document
+  #     property :name, String
+  #     many :addresses
+  #     many :friends, :class_name => "Person"
+  #     one :account
+  #   end
+  #    
+  #   # Account and Address are embeddable documents
+  #   class Account
+  #     include Ripple::EmbeddedDocument
+  #     property :paid_until, Time
+  #     embedded_in :person # Adds "person" method to get parent document
+  #   end
+  #    
+  #   class Address
+  #     include Ripple::EmbeddedDocument
+  #     property :street, String
+  #     property :city, String
+  #     property :state, String
+  #     property :zip, String
+  #   end
+  #    
+  #   person = Person.find("adamhunter")
+  #   person.friends << Person.find("seancribbs") # Links to people/seancribbs with tag "friend"
+  #   person.addresses << Address.new(:street => "100 Main Street") # Adds an embedded address
+  #   person.account.paid_until = 3.months.from_now
   module Associations
     extend ActiveSupport::Concern
     extend ActiveSupport::Autoload
@@ -100,6 +132,8 @@ module Ripple
     end
   end
 
+  # The "reflection" for an association - metadata about how it is
+  # configured.
   class Association
     include Ripple::Translation
     attr_reader :type, :name, :options
@@ -210,6 +244,7 @@ module Ripple
       end
     end
 
+    # @private
     def type_matches?(value)
       case
       when polymorphic?

data/lib/ripple/attribute_methods.rb

@@ -49,8 +49,6 @@ module Ripple
     end
 
     module InstanceMethods
-      attr_accessor :key
-
       # A copy of the values of all attributes in the Document. The result
       # is not memoized, so use sparingly.  This does not include associated objects,
       # nor embedded documents.
@@ -76,10 +74,6 @@ module Ripple
         end
       end
 
-      def key=(value)
-        @key = value.to_s
-      end
-
       # @private
       def initialize(attrs={})
         super()

data/lib/ripple/callbacks.rb

@@ -14,6 +14,8 @@
 require 'ripple'
 
 module Ripple
+  # Adds lifecycle callbacks to {Ripple::Document} models, in the typical
+  # ActiveModel fashion.
   module Callbacks
     extend ActiveSupport::Concern
 
@@ -24,6 +26,7 @@ module Ripple
     end
 
     module ClassMethods
+      # Defines a callback to be run before validations.
       def before_validation(*args, &block)
         options = args.last
         if options.is_a?(Hash) && options[:on]
@@ -33,6 +36,7 @@ module Ripple
         set_callback(:validation, :before, *args, &block)
       end
 
+      # Defines a callback to be run after validations.
       def after_validation(*args, &block)
         options = args.extract_options!
         options[:prepend] = true
@@ -43,6 +47,7 @@ module Ripple
       end
     end
 
+    # @private
     module InstanceMethods
       # @private
       def save(*args, &block)

data/lib/ripple/conversion.rb

@@ -14,21 +14,26 @@
 require 'ripple'
 
 module Ripple
+  # Provides ActionPack compatibility for {Ripple::Document} models.
   module Conversion
     include ActiveModel::Conversion
 
+    # True if this is a new document
     def new_record?
       new?
     end
 
+    # True if this is not a new document
     def persisted?
       !new?
     end
 
+    # Converts to a view key
     def to_key
       new? ? nil : [key]
     end
 
+    # Converts to a URL parameter
     def to_param
       key
     end

data/lib/ripple/core_ext.rb

@@ -1 +1,14 @@
+# 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/core_ext/casting'

data/lib/ripple/document.rb

@@ -44,11 +44,13 @@ module Ripple
 
     autoload :BucketAccess
     autoload :Finders
+    autoload :Key
     autoload :Persistence
 
     included do
       extend ActiveModel::Naming
       extend BucketAccess
+      include Ripple::Document::Key
       include Ripple::Document::Persistence
       extend Ripple::Properties
       include Ripple::AttributeMethods
@@ -71,6 +73,13 @@ module Ripple
       def _root_document
         self
       end
+
+      # Returns true if the +comparison_object+ is the same object, or is of the same type and has the same key.
+      def ==(comparison_object)
+        comparison_object.equal?(self) ||
+          (comparison_object.class < Document && (comparison_object.instance_of?(self.class) || comparison_object.class.bucket.name == self.class.bucket.name) &&
+           comparison_object.key == key && !comparison_object.new?)
+      end
     end
   end
 end

data/lib/ripple/document/finders.rb

@@ -56,7 +56,7 @@ module Ripple
         #   @return [Array<Document>] a list of found documents, including nil for missing documents
         def find(*args)
           args.flatten!
-          return nil if args.empty?
+          return nil if args.empty? || args.all?(&:blank?)
           return find_one(args.first) if args.one?
           args.map {|key| find_one(key) }
         end

data/lib/ripple/document/key.rb

@@ -0,0 +1,49 @@
+# 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 Document
+    module Key
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # Defines the key to be derived from a property.
+        # @param [String,Symbol] prop the property to derive the key from
+        def key_on(prop)
+          class_eval <<-CODE
+          def key
+            #{prop}.to_s
+          end
+          def key=(value)
+            self.#{prop} = value
+          end
+          CODE
+        end
+      end
+      
+      module InstanceMethods
+        # Reads the key for this Document.
+        def key
+          @key
+        end
+        
+        # Sets the key for this Document.
+        def key=(value)
+          @key = value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/ripple/document/persistence.rb

@@ -23,7 +23,7 @@ module Ripple
 
         # Instantiates a new record, applies attributes from a block, and saves it
         def create(attrs={}, &block)
-          new(attrs, &block).tap {|s| s.save}
+          new(attrs, &block).tap {|s| s.save }
         end
 
         # Destroys all records one at a time.

data/lib/ripple/embedded_document.rb

@@ -14,11 +14,13 @@
 require 'ripple'
 
 module Ripple
+  # Represents a document model that is composed into or stored in a parent
+  # Document.  Embedded documents may also embed other documents, have
+  # callbacks and validations, but are solely dependent on the parent Document.
   module EmbeddedDocument
     extend ActiveSupport::Concern
     extend ActiveSupport::Autoload
 
-    autoload :Conversion
     autoload :Finders
     autoload :Persistence
     include Translation

data/lib/ripple/embedded_document/finders.rb

@@ -15,6 +15,7 @@ require 'ripple'
 
 module Ripple
   module EmbeddedDocument
+    # @private
     module Finders
       extend ActiveSupport::Concern
 

data/lib/ripple/embedded_document/persistence.rb

@@ -14,6 +14,8 @@
 require 'ripple'
 
 module Ripple
+  # Exception raised when save is called on an EmbeddedDocument that
+  # is not attached to a root Document.
   class NoRootDocument < StandardError
     include Translation
     def initialize(doc, method)
@@ -22,18 +24,24 @@ module Ripple
   end
 
   module EmbeddedDocument
+    # Adds methods to {Ripple::EmbeddedDocument} that delegate storage
+    # operations to the parent document.
     module Persistence
       extend ActiveSupport::Concern
 
       module ClassMethods
+        # Creates a method that points to the parent document. 
         def embedded_in(parent)
           define_method(parent) { @_parent_document }
         end
       end
 
       module InstanceMethods
-        attr_reader :_parent_document
+        # The parent document to this embedded document. This may be a
+        # {Ripple::Document} or another {Ripple::EmbeddedDocument}.
+        attr_accessor :_parent_document
 
+        # Whether the root document is unsaved.
         def new?
           if _root_document
             _root_document.new?
@@ -42,16 +50,20 @@ module Ripple
           end
         end
 
+        # Sets this embedded documents attributes and saves the root document.
         def update_attributes(attrs)
           self.attributes = attrs
           save
         end
 
+        # Updates this embedded document's attribute and saves the
+        # root document, skipping validations.
         def update_attribute(attribute, value)
           send("#{attribute}=", value)
           save(:validate => false)
         end
 
+        # Saves this embedded document by delegating to the root document.
         def save(*args)
           if _root_document
             _root_document.save(*args)
@@ -60,17 +72,15 @@ module Ripple
           end
         end
 
+        # @private
         def attributes_for_persistence
           attributes.merge("_type" => self.class.name)
         end
 
+        # The root {Ripple::Document} to which this embedded document belongs.
         def _root_document
           @_parent_document.try(:_root_document)
         end
-
-        def _parent_document=(value)
-          @_parent_document = value
-        end
       end
     end
   end

data/lib/ripple/inspection.rb

@@ -17,6 +17,7 @@ require 'ripple'
 module Ripple
   # Makes IRB and other inspect output a bit friendlier
   module Inspection
+    # A human-readable version of the {Ripple::Document} or {Ripple::EmbeddedDocument}
     def inspect
       attribute_list = attributes_for_persistence.except("_type").map {|k,v| "#{k}=#{v.inspect}" }.join(' ')
       identifier = self.class.embeddable? ? "" : ":#{key || '[new]'}"

data/lib/ripple/property_type_mismatch.rb

@@ -14,6 +14,8 @@
 require 'ripple'
 
 module Ripple
+  # Exception raised when the value assigned to a document property
+  # cannot be coerced into the property's defined type.
   class PropertyTypeMismatch < StandardError
     include Translation
     def initialize(klass, value)

data/lib/ripple/railtie.rb

@@ -14,6 +14,8 @@
 require 'ripple'
 
 module Ripple
+  # Railtie for automatic initialization of the Ripple framework
+  # during Rails initialization.
   class Railtie < Rails::Railtie
     initializer "ripple.configure_rails_initialization" do
       Ripple.load_configuration Rails.root.join('config', 'ripple.yml'), [Rails.env]

data/lib/ripple/timestamps.rb

@@ -14,10 +14,14 @@
 require 'ripple'
 
 module Ripple
+  # Adds automatic creation and update timestamps to a
+  # {Ripple::Document} model.
   module Timestamps
     extend ActiveSupport::Concern
 
     module ClassMethods
+      # Adds the :created_at and :updated_at timestamp properties to
+      # the document.
       def timestamps!
         property :created_at, Time, :default => proc { Time.now.utc }
         property :updated_at, Time
@@ -26,6 +30,7 @@ module Ripple
     end
 
     module InstanceMethods
+      # Sets the :updated_at attribute before saving the document.
       def touch
         self.updated_at = Time.now.utc
       end

data/lib/ripple/translation.rb

@@ -14,9 +14,11 @@
 require 'ripple'
 
 module Ripple
+  # Adds i18n translation/string-lookup capabilities.
   module Translation
     include Riak::Util::Translation
 
+    # The scope of i18n keys to search (:ripple).
     def i18n_scope
       :ripple
     end

data/lib/ripple/validations.rb

@@ -14,7 +14,6 @@
 require 'ripple'
 
 module Ripple
-
   # Raised by <tt>save!</tt> when the document is invalid.  Use the
   # +document+ method to retrieve the document which did not validate.
   #   begin
@@ -32,6 +31,8 @@ module Ripple
     end
   end
 
+  # Adds validations to {Ripple::Document} models. Validations are
+  # executed before saving the document.
   module Validations
     extend ActiveSupport::Concern
     extend ActiveSupport::Autoload
@@ -60,11 +61,15 @@ module Ripple
         return false if options[:validate] && !valid?
         super()
       end
-      
+
+      # Saves the document and raises {DocumentInvalid} exception if
+      # validations fail. 
       def save!
         (raise Ripple::DocumentInvalid.new(self) unless save) || true
       end
 
+      # Sets the passed attributes and saves the document, raising a
+      # {DocumentInvalid} exception if the validations fail.
       def update_attributes!(attrs)
         self.attributes = attrs
         save!

data/spec/ripple/conversion_spec.rb

@@ -14,22 +14,22 @@
 require File.expand_path("../../spec_helper", __FILE__)
 
 describe Ripple::Conversion do
-  require 'support/models/address'
+  require 'support/models/box'
 
   before :each do
-    @addr = Address.new { |a| a.key = 'some-key' }
-    @addr.stub!(:new?).and_return(false)
+    @box = Box.new { |a| a.key = 'some-key' }
+    @box.stub!(:new?).and_return(false)
   end
 
   it "should return the key as an array for to_key" do
-    @addr.to_key.should == ['some-key']
+    @box.to_key.should == ['some-key']
   end
 
   it "should be able to be converted to a param" do
-    @addr.to_param.should == 'some-key'
+    @box.to_param.should == 'some-key'
   end
 
   it "should be able to be converted to a model" do
-    @addr.to_model.should == @addr
+    @box.to_model.should == @box
   end
 end

data/spec/ripple/core_ext_spec.rb

@@ -1,3 +1,16 @@
+# 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 Time do

data/spec/ripple/document_spec.rb

@@ -27,6 +27,36 @@ describe Ripple::Document do
     Page.should_not be_embeddable
   end
 
+  describe "equivalence" do
+    before do
+      class Homepage < Page; end
+      class ErrorPage; include Ripple::Document; self.bucket_name = "pages"; end
+      @doc = Page.new
+      @doc2 = Page.new
+      @sub = Homepage.new
+      @error = ErrorPage.new
+      [@doc,@doc2,@sub,@error].each {|d| d.key = "root"; d.stub!(:new?).and_return(false) }
+    end
+
+    it "should be equal if the same object" do
+      @doc.should == @doc
+    end
+
+    it "should be equal if instance of same class and key" do
+      @doc.should == @doc2
+      @doc.should == @sub
+    end
+
+    it "should be equal if of the same bucket and key" do
+      @doc.should == @error
+    end
+
+    it "should not be equal if new record" do
+      @doc2.stub!(:new?).and_return(true)
+      @doc.should_not == @doc2
+    end
+  end
+
   describe "ActiveModel compatibility" do
     include ActiveModel::Lint::Tests
 

data/spec/ripple/finders_spec.rb

@@ -25,10 +25,15 @@ describe Ripple::Document::Finders do
     Box.stub!(:bucket).and_return(@bucket)
   end
 
-  it "should return an empty array if no keys are passed to find" do
+  it "should return nil if no keys are passed to find" do
     Box.find().should be_nil
   end
 
+  it "should return nil if no valid keys are passed to find" 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

data/spec/ripple/key_spec.rb

@@ -0,0 +1,43 @@
+# 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::Key do
+  require 'support/models/box'
+  before do
+    @box = Box.new
+  end
+  
+  it "should define key getter and setter" do
+    @box.should respond_to(:key)
+    @box.should respond_to(:key=)
+  end
+
+  it "should stringify the assigned key" do
+    @box.key = 2
+    @box.key.should == "2"
+  end
+
+  it "should use a property as the key" do
+    class ShapedBox < Box
+      key_on :shape
+    end
+    @box = ShapedBox.new
+    @box.key = "square"
+    @box.key.should == "square"
+    @box.shape.should == "square"
+    @box.shape = "oblong"
+    @box.key.should == "oblong"
+  end  
+end

data/spec/ripple/timestamps_spec.rb

@@ -1,3 +1,17 @@
+# 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(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Ripple::Timestamps do

data/spec/support/associations/proxies.rb

@@ -1,4 +1,18 @@
-# yet another filch from mongo mapper
+# 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.
+
+
 class FakeNilProxy < Ripple::Associations::Proxy
   def find_target; nil end
 end

data/spec/support/mocks.rb

@@ -1,3 +1,17 @@
+# 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.
+
 def mock_response(overrides={})
   {:headers => {"content-type" => ["application/json"]}, :body => '{}'}.merge(overrides)
-end
+end

data/spec/support/models/address.rb

@@ -1,3 +1,17 @@
+# 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 'support/models/note'
 
 class Address
@@ -5,4 +19,4 @@ class Address
   property :street, String, :presence => true
   many :notes
   embedded_in :user
-end
+end

data/spec/support/models/box.rb

@@ -1,6 +1,19 @@
+# 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.
 
 class Box
   include Ripple::Document
   property :shape, String
   timestamps!
-end
+end

data/spec/support/models/cardboard_box.rb

@@ -1,3 +1,16 @@
+# 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.
 
 class CardboardBox < Box
-end
+end

data/spec/support/models/clock.rb

@@ -1,6 +1,19 @@
+# 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.
 
 
 class Clock
   include Ripple::Document
   timestamps!
-end
+end

data/spec/support/models/customer.rb

@@ -1,4 +1,17 @@
+# 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.
 
 class Customer
   include Ripple::Document
-end
+end

data/spec/support/models/email.rb

@@ -1,4 +1,17 @@
+# 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.
 
 class Email
   include Ripple::Document
-end
+end

data/spec/support/models/family.rb

@@ -1,3 +1,16 @@
+# 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.
 class Parent
   include Ripple::Document
   one :child
@@ -11,4 +24,4 @@ end
 
 class Grandchild
   include Ripple::EmbeddedDocument
-end
+end

data/spec/support/models/favorite.rb

@@ -1,4 +1,17 @@
+# 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.
 
 class Favorite
   include Ripple::EmbeddedDocument
-end
+end

data/spec/support/models/invoice.rb

@@ -1,6 +1,19 @@
+# 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.
 
 class Invoice
   include Ripple::Document
   one :customer
   one :note
-end
+end

data/spec/support/models/late_invoice.rb

@@ -1,3 +1,16 @@
+# 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.
 
 class LateInvoice < Invoice
 end

data/spec/support/models/note.rb

@@ -1,4 +1,17 @@
+# 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.
 
 class Note
   include Ripple::EmbeddedDocument
-end
+end

data/spec/support/models/page.rb

@@ -1,4 +1,17 @@
+# 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.
 
 class Page
   include Ripple::Document
-end 
+end 

data/spec/support/models/paid_invoice.rb

@@ -1,4 +1,17 @@
+# 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.
 
 class PaidInvoice < Invoice
   self.bucket_name = "paid"
-end
+end

data/spec/support/models/tasks.rb

@@ -1,3 +1,17 @@
+# 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.
+
 class Person
   include Ripple::Document
   many :tasks

data/spec/support/models/tree.rb

@@ -1,3 +1,17 @@
+# 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.
+
 class Leaf; end; 
 class Branch; end; 
-class Trunk; end
+class Trunk; end

data/spec/support/models/user.rb

@@ -1,6 +1,20 @@
+# 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 'support/models/address'
 
 class User
   include Ripple::Document
   many :addresses
-end
+end

data/spec/support/models/widget.rb

@@ -1,3 +1,16 @@
+# 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.
 
 class Widget
   include Ripple::Document

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: ripple
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 0
   - 8
   - 0
-  - beta2
-  version: 0.8.0.beta2
+  version: 0.8.0
 platform: ruby
 authors: 
 - Sean Cribbs
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-29 00:00:00 -04:00
+date: 2010-08-31 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,8 +46,7 @@ dependencies:
         - 0
         - 8
         - 0
-        - beta2
-        version: 0.8.0.beta2
+        version: 0.8.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -115,6 +113,7 @@ files:
 - lib/ripple/core_ext.rb
 - lib/ripple/document/bucket_access.rb
 - lib/ripple/document/finders.rb
+- lib/ripple/document/key.rb
 - lib/ripple/document/persistence.rb
 - lib/ripple/document.rb
 - lib/ripple/embedded_document/finders.rb
@@ -152,6 +151,7 @@ files:
 - spec/ripple/embedded_document_spec.rb
 - spec/ripple/finders_spec.rb
 - spec/ripple/inspection_spec.rb
+- spec/ripple/key_spec.rb
 - spec/ripple/persistence_spec.rb
 - spec/ripple/properties_spec.rb
 - spec/ripple/ripple_spec.rb
@@ -197,13 +197,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
@@ -231,6 +229,7 @@ test_files:
 - spec/ripple/embedded_document_spec.rb
 - spec/ripple/finders_spec.rb
 - spec/ripple/inspection_spec.rb
+- spec/ripple/key_spec.rb
 - spec/ripple/persistence_spec.rb
 - spec/ripple/properties_spec.rb
 - spec/ripple/ripple_spec.rb