ripple 0.5.0

data/lib/ripple/document/persistence/callbacks.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 'ripple'
+
+module Ripple
+  module Document
+    module Persistence
+      module Callbacks
+        extend ActiveSupport::Concern
+
+        included do
+          extend ActiveModel::Callbacks
+          define_model_callbacks :create, :update, :save, :destroy
+        end
+
+        module InstanceMethods
+          # @private
+          def save
+            state = new? ? :create : :update
+            run_callbacks(:save) do
+              run_callbacks(state) do
+                super
+              end
+            end
+          end
+
+          # @private
+          def destroy
+            run_callbacks(:destroy) do
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ripple/document/properties.rb

@@ -0,0 +1,85 @@
+# 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'
+require 'ripple/core_ext/casting'
+
+module Ripple
+  module Document
+    # Adds the ability to declare properties on your Ripple::Document class.
+    # Properties will automatically generate accessor (get/set/query) methods and
+    # handle type-casting between your Ruby type and JSON-compatible types.
+    module Properties
+      # @private
+      def inherited(subclass)
+        super
+        subclass.properties.merge!(properties)
+      end
+
+      # @return [Hash] the properties defined on the document
+      def properties
+        @properties ||= {}.with_indifferent_access
+      end
+
+      def property(key, type, options={})
+        prop = Property.new(key, type, options)
+        properties[prop.key] = prop
+      end
+    end
+
+    # Encapsulates a single property on your Ripple::Document class.
+    class Property
+      # @return [Symbol] the key of this property in the Document
+      attr_reader :key
+      # @return [Class] the Ruby type of property.
+      attr_reader :type
+      # @return [Hash] configuration options
+      attr_reader :options
+
+      # Create a new document property.
+      # @param [String, Symbol] key the key of the property
+      # @param [Class] type the Ruby type of the property. Use {Boolean} for true or false types.
+      # @param [Hash] options configuration options
+      # @option options [Object, Proc] :default (nil) a default value for the property, or a lambda to evaluate when providing the default.
+      def initialize(key, type, options={})
+        @options = options.to_options
+        @key = key.to_sym
+        @type = type
+      end
+
+      # @return [Object] The default value for this property if defined, or nil.
+      def default
+        if default = options[:default]
+          type_cast(default.respond_to?(:call) ? default.call : default)
+        end
+      end
+
+      # @return [Hash] options appropriate for the validates class method
+      def validation_options
+        @options.dup.except(:default)
+      end
+
+      # Attempt to coerce the passed value into this property's type
+      # @param [Object] value the value to coerce
+      # @return [Object] the value coerced into this property's type
+      # @raise [PropertyTypeMismatch] if the value cannot be coerced into the property's type
+      def type_cast(value)
+        if @type.respond_to?(:ripple_cast)
+          @type.ripple_cast(value)
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/ripple/document/validations.rb

@@ -0,0 +1,44 @@
+# 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 Validations
+      extend ActiveSupport::Concern
+      include ActiveModel::Validations
+
+      module ClassMethods
+        # @private
+        def property(key, type, options={})
+          prop = super
+          validates key, prop.validation_options unless prop.validation_options.blank?
+        end
+      end
+
+      module InstanceMethods
+        # @private
+        def save
+          valid? && super
+        end
+
+        # @private
+        def valid?
+          @_on_validate = new? ? :create : :update
+          super
+        end
+      end
+    end
+  end
+end

data/lib/ripple/embedded_document.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 EmbeddedDocument
+    extend ActiveSupport::Concern
+    extend ActiveSupport::Autoload
+
+    autoload :Persistence
+    include Translation
+
+    included do
+      extend ActiveModel::Naming
+      extend Document::Properties
+      include Persistence
+      include Document::AttributeMethods
+      include Document::Validations
+    end
+
+    module ClassMethods
+      def embeddable?
+        !included_modules.include?(Document)
+      end
+    end
+  end
+end

data/lib/ripple/embedded_document/persistence.rb

@@ -0,0 +1,46 @@
+# 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 EmbeddedDocument
+    module Persistence
+      extend ActiveSupport::Concern
+
+      included do
+        attr_accessor :_root_document
+      end
+
+      module InstanceMethods
+        # Delegates to the root document
+        def new?
+          if @_root_document
+            @_root_document.new?
+          else
+            super
+          end
+        end
+
+        # Delegates to the root document
+        def save
+          if @_root_document
+            @_root_document.save
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ripple/i18n.rb

@@ -0,0 +1,15 @@
+# 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 'active_support/i18n'
+I18n.load_path << File.expand_path("../locale/en.yml", __FILE__)

data/lib/ripple/locale/en.yml

@@ -0,0 +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.
+en:
+  ripple:
+    property_type_mismatch: "Cannot cast {{value}} into a {{class}}"

data/lib/ripple/property_type_mismatch.rb

@@ -0,0 +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 'ripple'
+
+module Ripple
+  class PropertyTypeMismatch < StandardError
+    include Translation
+    def initialize(klass, value)
+      super t("property_type_mismatch", :class => klass, :value => value.inspect)
+    end
+  end
+end

data/lib/ripple/translation.rb

@@ -0,0 +1,24 @@
+# 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 Translation
+    include Riak::Util::Translation
+
+    def i18n_scope
+      :ripple
+    end
+  end
+end

data/ripple.gemspec

@@ -0,0 +1,159 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ripple}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sean Cribbs"]
+  s.date = %q{2010-02-10}
+  s.description = %q{ripple is a rich Ruby client for Riak, Basho's distributed database.  It includes all the basics of accessing and manipulating Riak buckets and objects, and an object mapper library for building a rich domain on top of Riak.}
+  s.email = %q{seancribbs@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "RELEASE_NOTES.textile",
+     "Rakefile",
+     "VERSION",
+     "lib/riak.rb",
+     "lib/riak/bucket.rb",
+     "lib/riak/client.rb",
+     "lib/riak/client/curb_backend.rb",
+     "lib/riak/client/http_backend.rb",
+     "lib/riak/client/net_http_backend.rb",
+     "lib/riak/failed_request.rb",
+     "lib/riak/i18n.rb",
+     "lib/riak/invalid_response.rb",
+     "lib/riak/link.rb",
+     "lib/riak/locale/en.yml",
+     "lib/riak/map_reduce.rb",
+     "lib/riak/map_reduce_error.rb",
+     "lib/riak/robject.rb",
+     "lib/riak/util/headers.rb",
+     "lib/riak/util/multipart.rb",
+     "lib/riak/util/translation.rb",
+     "lib/riak/walk_spec.rb",
+     "lib/ripple.rb",
+     "lib/ripple/core_ext/casting.rb",
+     "lib/ripple/document.rb",
+     "lib/ripple/document/attribute_methods.rb",
+     "lib/ripple/document/attribute_methods/dirty.rb",
+     "lib/ripple/document/attribute_methods/query.rb",
+     "lib/ripple/document/attribute_methods/read.rb",
+     "lib/ripple/document/attribute_methods/write.rb",
+     "lib/ripple/document/bucket_access.rb",
+     "lib/ripple/document/finders.rb",
+     "lib/ripple/document/persistence.rb",
+     "lib/ripple/document/persistence/callbacks.rb",
+     "lib/ripple/document/properties.rb",
+     "lib/ripple/document/validations.rb",
+     "lib/ripple/embedded_document.rb",
+     "lib/ripple/embedded_document/persistence.rb",
+     "lib/ripple/i18n.rb",
+     "lib/ripple/locale/en.yml",
+     "lib/ripple/property_type_mismatch.rb",
+     "lib/ripple/translation.rb",
+     "ripple.gemspec",
+     "spec/fixtures/cat.jpg",
+     "spec/fixtures/multipart-blank.txt",
+     "spec/fixtures/multipart-with-body.txt",
+     "spec/riak/bucket_spec.rb",
+     "spec/riak/client_spec.rb",
+     "spec/riak/curb_backend_spec.rb",
+     "spec/riak/headers_spec.rb",
+     "spec/riak/http_backend_spec.rb",
+     "spec/riak/link_spec.rb",
+     "spec/riak/map_reduce_spec.rb",
+     "spec/riak/multipart_spec.rb",
+     "spec/riak/net_http_backend_spec.rb",
+     "spec/riak/object_spec.rb",
+     "spec/riak/walk_spec_spec.rb",
+     "spec/ripple/attribute_methods_spec.rb",
+     "spec/ripple/bucket_access_spec.rb",
+     "spec/ripple/callbacks_spec.rb",
+     "spec/ripple/document_spec.rb",
+     "spec/ripple/embedded_document_spec.rb",
+     "spec/ripple/finders_spec.rb",
+     "spec/ripple/persistence_spec.rb",
+     "spec/ripple/properties_spec.rb",
+     "spec/ripple/ripple_spec.rb",
+     "spec/ripple/validations_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/support/http_backend_implementation_examples.rb",
+     "spec/support/mock_server.rb"
+  ]
+  s.homepage = %q{http://seancribbs.github.com/ripple}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.requirements = ["`gem install curb` for better HTTP performance"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{ripple is a rich Ruby client for Riak, Basho's distributed database.}
+  s.test_files = [
+    "spec/riak/bucket_spec.rb",
+     "spec/riak/client_spec.rb",
+     "spec/riak/curb_backend_spec.rb",
+     "spec/riak/headers_spec.rb",
+     "spec/riak/http_backend_spec.rb",
+     "spec/riak/link_spec.rb",
+     "spec/riak/map_reduce_spec.rb",
+     "spec/riak/multipart_spec.rb",
+     "spec/riak/net_http_backend_spec.rb",
+     "spec/riak/object_spec.rb",
+     "spec/riak/walk_spec_spec.rb",
+     "spec/ripple/attribute_methods_spec.rb",
+     "spec/ripple/bucket_access_spec.rb",
+     "spec/ripple/callbacks_spec.rb",
+     "spec/ripple/document_spec.rb",
+     "spec/ripple/embedded_document_spec.rb",
+     "spec/ripple/finders_spec.rb",
+     "spec/ripple/persistence_spec.rb",
+     "spec/ripple/properties_spec.rb",
+     "spec/ripple/ripple_spec.rb",
+     "spec/ripple/validations_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/support/http_backend_implementation_examples.rb",
+     "spec/support/mock_server.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3"])
+      s.add_development_dependency(%q<fakeweb>, [">= 1.2"])
+      s.add_development_dependency(%q<rack>, [">= 1.0"])
+      s.add_development_dependency(%q<yard>, [">= 0.5.2"])
+      s.add_development_dependency(%q<curb>, [">= 0.6"])
+      s.add_runtime_dependency(%q<activesupport>, ["= 3.0.0.beta"])
+      s.add_runtime_dependency(%q<activemodel>, ["= 3.0.0.beta"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3"])
+      s.add_dependency(%q<fakeweb>, [">= 1.2"])
+      s.add_dependency(%q<rack>, [">= 1.0"])
+      s.add_dependency(%q<yard>, [">= 0.5.2"])
+      s.add_dependency(%q<curb>, [">= 0.6"])
+      s.add_dependency(%q<activesupport>, ["= 3.0.0.beta"])
+      s.add_dependency(%q<activemodel>, ["= 3.0.0.beta"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3"])
+    s.add_dependency(%q<fakeweb>, [">= 1.2"])
+    s.add_dependency(%q<rack>, [">= 1.0"])
+    s.add_dependency(%q<yard>, [">= 0.5.2"])
+    s.add_dependency(%q<curb>, [">= 0.6"])
+    s.add_dependency(%q<activesupport>, ["= 3.0.0.beta"])
+    s.add_dependency(%q<activemodel>, ["= 3.0.0.beta"])
+  end
+end
+