ripple 0.5.0

data/lib/ripple/document/attribute_methods.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 'ripple'
+
+module Ripple
+  module Document
+    # Makes ActiveRecord-like attribute accessors based on your
+    # {Document}'s properties.
+    module AttributeMethods
+      extend ActiveSupport::Concern
+      extend ActiveSupport::Autoload
+      include ActiveModel::AttributeMethods
+
+      autoload :Read
+      autoload :Write
+      autoload :Query
+      autoload :Dirty
+
+      included do
+        attr_accessor :key
+        include Read
+        include Write
+        include Query
+        include Dirty
+      end
+
+      module ClassMethods
+        # @private
+        def property(key, type, options={})
+          undefine_attribute_methods
+          super
+        end
+
+        # Generates all the attribute-related methods for properties defined
+        # on the document, including accessors, mutators and query methods.
+        def define_attribute_methods
+          super(properties.keys)
+        end
+      end
+
+      module InstanceMethods
+        # 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.
+        # @return [Hash] all document attributes, by key
+        def attributes
+          self.class.properties.values.inject({}) do |hash, prop|
+            hash[prop.key] = attribute(prop.key)
+            hash
+          end.with_indifferent_access
+        end
+
+        # Mass assign the document's attributes.
+        # @param [Hash] attrs the attributes to assign
+        def attributes=(attrs)
+          raise ArgumentError, "value of attributes must be a Hash" unless Hash === attrs
+          attrs.each do |k,v|
+            if respond_to?("#{k}=")
+              __send__("#{k}=",v)
+            else
+              __send__(:attribute=,k,v)
+            end
+          end
+        end
+
+        # @private
+        def initialize(attrs={})
+          super()
+          @attributes = attributes_from_property_defaults
+          self.attributes = attrs
+        end
+
+        # @private
+        def method_missing(method, *args, &block)
+          self.class.define_attribute_methods
+          super
+        end
+
+        # @private
+        def respond_to?(*args)
+          self.class.define_attribute_methods
+          super
+        end
+
+        protected
+        # @private
+        def attribute_method?(attr_name)
+          self.class.properties.include?(attr_name)
+        end
+
+        def attributes_from_property_defaults
+          self.class.properties.values.inject({}) do |hash, prop|
+            hash[prop.key] = prop.default if prop.default
+            hash
+          end.with_indifferent_access
+        end
+      end
+    end
+  end
+end

data/lib/ripple/document/attribute_methods/dirty.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 'ripple'
+
+module Ripple
+  module Document
+    module AttributeMethods
+      module Dirty
+        extend ActiveSupport::Concern
+        include ActiveModel::Dirty
+
+        # @private
+        def save
+          if result = super
+            changed_attributes.clear
+          end
+          result
+        end
+
+        # @private
+        def reload
+          returning super do
+            changed_attributes.clear
+          end
+        end
+
+        # @private
+        def initialize(attrs={})
+          super(attrs)
+          changed_attributes.clear
+        end
+
+        private
+        def attribute=(attr_name, value)
+          attribute_will_change!(attr_name)
+          super
+        end
+      end
+    end
+  end
+end

data/lib/ripple/document/attribute_methods/query.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 AttributeMethods
+      module Query
+        extend ActiveSupport::Concern
+
+        included do
+          attribute_method_suffix "?"
+        end
+
+        private
+        # Based on code from ActiveRecord
+        def attribute?(attr_name)
+          unless value = attribute(attr_name)
+            false
+          else
+            prop = self.class.properties[attr_name]
+            if prop.nil?
+              if Numeric === value || value !~ /[^0-9]/
+                !value.to_i.zero?
+              else
+                Boolean.ripple_cast(value) || value.present?
+              end
+            elsif prop.type <= Numeric
+              !value.zero?
+            else
+              value.present?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ripple/document/attribute_methods/read.rb

@@ -0,0 +1,38 @@
+# 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 AttributeMethods
+      module Read
+        extend ActiveSupport::Concern
+
+        included do
+          attribute_method_suffix ""
+        end
+
+        private
+        def attribute(attr_name)
+          if @attributes.include?(attr_name)
+            value = @attributes[attr_name]
+            value.duplicable? ? value.clone : value
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ripple/document/attribute_methods/write.rb

@@ -0,0 +1,36 @@
+# 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 AttributeMethods
+      module Write
+        extend ActiveSupport::Concern
+
+        included do
+          attribute_method_suffix "="
+        end
+
+        private
+        def attribute=(attr_name, value)
+          if prop = self.class.properties[attr_name]
+            value = prop.type_cast(value)
+          end
+          @attributes[attr_name] = value
+        end
+      end
+    end
+  end
+end

data/lib/ripple/document/bucket_access.rb

@@ -0,0 +1,38 @@
+# 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/document'
+
+module Ripple
+  module Document
+    # Similar to ActiveRecord's tables or MongoMapper's collections, we
+    # provide a sane default bucket in which to store your documents.
+    module BucketAccess
+      # @return [String] The bucket name assigned to the document class.  Subclasses will inherit their bucket name from their parent class unless they redefine it.
+      def bucket_name
+        superclass.respond_to?(:bucket_name) ? superclass.bucket_name : model_name.plural
+      end
+
+      # @return [Riak::Bucket] The bucket assigned to this class.
+      def bucket
+        Ripple.client[bucket_name, {:keys => false}]
+      end
+
+      # Set the bucket name for this class and its subclasses.
+      # @param [String] value the new bucket name
+      def bucket_name=(value)
+        metaclass.send(:define_method, :bucket_name){ value }
+      end
+    end
+  end
+end

data/lib/ripple/document/finders.rb

@@ -0,0 +1,84 @@
+# 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 Finders
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # Retrieve single or multiple documents from Riak.
+        # @overload find(key)
+        #   Find a single document.
+        #   @param [String] key the key of a document to find
+        #   @return [Document] the found document, or nil
+        # @overload find(key1, key2, ...)
+        #   Find a list of documents.
+        #   @param [String] key1 the key of a document to find
+        #   @param [String] key2 the key of a document to find
+        #   @return [Array<Document>] a list of found documents, including nil for missing documents
+        # @overload find(keylist)
+        #   Find a list of documents.
+        #   @param [Array<String>] keylist an array of keys to find
+        #   @return [Array<Document>] a list of found documents, including nil for missing documents
+        def find(*args)
+          args.flatten!
+          return [] if args.length == 0
+          return find_one(args.first) if args.length == 1
+          args.map {|key| find_one(key) }
+        end
+
+        # Find all documents in the Document's bucket and return them.
+        # @overload all()
+        #   Get all documents and return them in an array.
+        #   @return [Array<Document>] all found documents in the bucket
+        # @overload all() {|doc| ... }
+        #   Stream all documents in the bucket through the block.
+        #   TODO: Make this work with the CurbBackend (currently single-request oriented).
+        #   @yield [Document] doc a found document
+        def all
+          if block_given?
+            bucket.keys do |key|
+              obj = find_one(key)
+              yield obj if obj
+            end
+            []
+          else
+            bucket.keys.inject([]) do |acc, k|
+              obj = find_one(k)
+              obj ? acc << obj : acc
+            end
+          end
+        end
+
+        private
+        def find_one(key)
+          instantiate(bucket.get(key))
+        rescue Riak::FailedRequest => fr
+          return nil if fr.code.to_i == 404
+          raise fr
+        end
+
+        def instantiate(robject)
+          klass = robject.data['_type'].constantize rescue self
+          klass.new(robject.data.merge('key' => robject.key)).tap do |doc|
+            doc.instance_variable_set(:@new, false)
+            doc.instance_variable_set(:@robject, robject)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ripple/document/persistence.rb

@@ -0,0 +1,93 @@
+# 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 Persistence
+      extend ActiveSupport::Concern
+      extend ActiveSupport::Autoload
+
+      autoload :Callbacks
+
+      included do
+        include Callbacks
+      end
+
+      module InstanceMethods
+        # @private
+        def initialize
+          super
+          @new = true
+        end
+
+        # Determines whether this is a new document.
+        def new?
+          @new || false
+        end
+        alias :new_record? :new?
+
+        # Saves the document in Riak.
+        # @return [true,false] whether the document succeeded in saving
+        def save
+          robject.key = key if robject.key != key
+          robject.data = attributes_for_persistence
+          robject.store
+          self.key = robject.key
+          @new = false
+          true
+        rescue Riak::FailedRequest
+          false
+        end
+
+        # Reloads the document from Riak
+        # @return self
+        def reload
+          return self if new?
+          robject.reload(:force => true)
+          @attributes.merge!(@robject.data)
+          self
+        end
+
+        # Deletes the document from Riak and freezes this instance
+        def destroy
+          robject.delete unless new?
+          freeze
+          true
+        rescue Riak::FailedRequest
+          false
+        end
+
+        # Freezes the document, preventing further modification.
+        def freeze
+          @attributes.freeze; super
+        end
+
+        protected
+        attr_writer :robject
+
+        def robject
+          @robject ||= Riak::RObject.new(self.class.bucket, key).tap do |obj|
+            obj.content_type = "application/json"
+          end
+        end
+
+        private
+        def attributes_for_persistence
+          attributes.merge("_type" => self.class.name)
+        end
+      end
+    end
+  end
+end