better-ripple 1.0.0

data/lib/ripple/property_type_mismatch.rb

@@ -0,0 +1,12 @@
+require 'ripple/translation'
+
+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)
+      super t("property_type_mismatch", :class => klass, :value => value.inspect)
+    end
+  end
+end

data/lib/ripple/railtie.rb

@@ -0,0 +1,26 @@
+require 'rails/railtie'
+
+module Ripple
+  # Railtie for automatic initialization of the Ripple framework
+  # during Rails initialization.
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "ripple/railties/ripple.rake"
+    end
+
+    initializer "ripple.configure_rails_initialization" do
+      if File.exist?(Rails.root + "config/ripple.yml")
+        Ripple.load_configuration Rails.root.join('config', 'ripple.yml'), [Rails.env]
+      end
+    end
+
+    initializer "ripple.configure_test_server_root", :after => "ripple.configure_rails_initialization" do
+      unless Rails.env.development? || Rails.env.production?
+        # Make sure the TestServer lives in the default location, if
+        # not set in the config file.
+        Ripple.config[:root] ||= (Rails.root + 'tmp/riak_test_server').to_s
+        Ripple.config[:js_source_dir] ||= (Rails.root + "app/mapreduce").to_s
+      end
+    end
+  end
+end

data/lib/ripple/railties/ripple.rake

@@ -0,0 +1,103 @@
+require 'ripple/translation'
+require 'riak/cluster'
+require 'pp'
+
+namespace :riak do
+  task :cluster_created => :rails_env do
+    fail Ripple::Translator.t('cluster_not_created') unless cluster.exist?
+  end
+
+  desc "Starts the Riak cluster for the current environment"
+  task :start => :cluster_created do
+    cluster.start
+  end
+
+  desc "Stops the Riak cluster for the current environment"
+  task :stop => :cluster_created do
+    cluster.stop
+  end
+
+  desc "Creates a Riak cluster for the current environment in db/, e.g. db/development"
+  task :create => :rails_env do
+    cluster.create
+  end
+
+  desc "Destroys the generated Riak cluster for the current environment."
+  task :destroy => ['rails_env', 'riak:stop'] do
+    cluster.destroy
+  end
+
+  desc "Drops data only from the Riak cluster for the current environment."
+  task :drop => :cluster_created do
+    cluster.drop
+  end
+
+  namespace :create do
+    desc "Creates Riak clusters for all environments defined in config/ripple.yml"
+    task :all do
+      load_config.each do |env, config|
+        cluster(env.to_s, config).create
+      end
+    end
+  end
+
+  namespace :drop do
+    desc "Drops data Riak clusters for all environments defined in config/ripple.yml"
+    task :all do
+      load_config.each do |env, config|
+        c = cluster(env.to_s, config)
+        warn Ripple::Translator.t('cluster_not_created') unless c.exist?
+        c.drop
+      end
+    end
+  end
+end
+
+namespace :db do
+  desc "Creates the database(s) for the current environment"
+  task :create => "riak:create"
+
+  namespace(:create) do
+    desc "Creates the database(s) for all environments"
+    task :all => "riak:create:all"
+  end
+
+  desc "Drops the database(s) for the current environment"
+  task :drop => ['db:stop', 'riak:drop']
+
+  namespace(:drop) do
+    desc "Drops the database(s) for all environments"
+    task :all => "riak:drop:all"
+  end
+
+  desc "Starts the database(s) for the current environment"
+  task :start => 'riak:start'
+
+  desc "Stops the database(s) for the current environment"
+  task :stop => 'riak:stop'
+
+  desc "Creates the database(s) and loads the seed data."
+  task :setup => ['db:create', 'db:start', 'db:seed']
+
+  desc "Drops and recreates the database(s) for the current environment."
+  task :reset => ['db:drop', 'db:setup']
+
+  desc "Loads the seed data in to the current environment"
+  task :seed => :environment do
+    Rails.application.load_seed
+  end
+end
+
+def load_config
+  file = Rails.root + "config/ripple.yml"
+  raise Ripple::MissingConfiguration, file.to_s unless file.exist?
+  YAML.load(ERB.new(file.read).result).with_indifferent_access
+end
+
+def cluster(environment=nil, config=nil)
+  environment ||= Rails.env
+  config ||= load_config[environment].with_indifferent_access
+  root = Rails.root + "db" + environment.to_s
+  # TODO: We need to deal with multiple hosts and client ports
+  Riak::Cluster.new({ :root => root.to_s }.merge(config).with_indifferent_access)
+end

data/lib/ripple/serialization.rb

@@ -0,0 +1,82 @@
+# Copyright 2010-2011 Sean Cribbs 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/concern'
+require 'active_model/serialization'
+require 'active_model/serializers/json'
+
+module Ripple
+  # Provides methods for serializing Ripple documents to external
+  # formats (e.g. JSON).  By default, embedded documents will be
+  # included in the resulting format.
+  module Serialization
+    extend ActiveSupport::Concern
+    include ::ActiveModel::Serializers::JSON
+
+    # Creates a Hash suitable for conversion to an external format.
+    # @param [Hash] options (nil) serialization options
+    # @option options [Array<Symbol>] :only emit only the specified attributes
+    # @option options [Array<Symbol>] :except omit the specified attributes
+    # @option options [Array<Symbol>, Hash] :include include the
+    #      specified associations (with or without extra
+    #      options). This defaults to all embedded associations.
+    # @return [Hash] a hash of attributes and embedded documents
+    def serializable_hash(options=nil)
+      options = options.try(:clone) || {}
+    
+      unless options.has_key?(:include)
+        options[:include] = self.class.embedded_associations.map(&:name)
+      end
+    
+      hash = super(options)
+    
+      hash['key'] = key if respond_to?(:key) && key.present? && (!options[:except] || !options[:except].map(&:to_s).include?("key"))
+    
+      serializable_add_includes(options) do |association, records, opts|
+        hash[association.to_s] = records.is_a?(Enumerable) ? records.map {|r| r.serializable_hash(opts) } : records.serializable_hash(opts)
+      end
+      hash
+    end
+    
+    private
+    def serializable_add_includes(options={})
+      return unless include_associations = options.delete(:include)
+    
+      base_only_or_except = {
+        :except => options[:except],
+        :only => options[:only]
+      }
+    
+      include_has_options = include_associations.is_a?(Hash)
+      associations = include_has_options ? include_associations.keys : Array.wrap(include_associations)
+    
+      for association in associations
+        records = case self.class.associations[association.to_sym].type
+                  when :many
+                    send(association).to_a
+                  when :one
+                    send(association)
+                  end
+    
+        unless records.nil?
+          association_options = include_has_options ? include_associations[association] : base_only_or_except
+          opts = options.merge(association_options)
+          yield(association, records, opts)
+        end
+      end
+    
+      options[:include] = include_associations
+    end
+  end
+end

data/lib/ripple/test_server.rb

@@ -0,0 +1,35 @@
+require 'riak/test_server'
+require 'singleton'
+
+module Ripple
+  # Extends the {Riak::TestServer} to be aware of the Ripple
+  # configuration and adjust settings appropriately. Also simplifies
+  # its usage in the generation of test helpers.
+  class TestServer < Riak::TestServer
+    include Singleton
+
+    # Creates and starts the test server
+    def self.setup
+      instance.create
+      instance.start
+    end
+
+    # Clears data from the test server
+    def self.clear
+      instance.drop
+    end
+
+    # @private
+    def initialize(options=Ripple.config.dup)
+      options[:env] ||= {}
+      options[:env][:riak_kv] ||= {}
+      options[:env][:riak_kv][:js_source_dir] ||= Ripple.config.delete(:js_source_dir)
+      options[:env][:riak_kv][:map_cache_size] ||= 0
+      options[:env][:riak_core] ||= {}
+      options[:env][:riak_core][:http] ||= [ Tuple[Ripple.config[:host], Ripple.config[:http_port]] ]
+      options[:env][:riak_kv][:pb_port] ||= Ripple.config[:pb_port]
+      options[:env][:riak_kv][:pb_ip] ||= Ripple.config[:host]
+      super(options)
+    end
+  end
+end

data/lib/ripple/timestamps.rb

@@ -0,0 +1,25 @@
+require 'active_support/time'
+require 'active_support/concern'
+
+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!(options={})
+        property :created_at, Time, options.merge(:default => proc { Time.now })
+        property :updated_at, Time, options.dup
+        before_save :touch
+      end
+    end
+
+    # Sets the :updated_at attribute before saving the document.
+    def touch
+      self.updated_at = Time.now
+    end
+  end
+end

data/lib/ripple/translation.rb

@@ -0,0 +1,18 @@
+require 'ripple/i18n'
+require 'riak/util/translation'
+
+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
+  end
+
+  # A dummy object so translations can be accessed without module
+  # inclusion.
+  Translator = Object.new.tap {|o| o.extend Translation }
+end

data/lib/ripple/validations.rb

@@ -0,0 +1,65 @@
+require 'active_support/concern'
+require 'active_model/validations'
+require 'ripple/translation'
+require 'ripple/validations/associated_validator'
+
+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
+  #     invalid_document.save!
+  #   rescue Ripple::DocumentInvalid => invalid
+  #     puts invalid.document.errors
+  #   end
+  class DocumentInvalid < StandardError
+    include Translation
+    attr_reader :document
+    def initialize(document)
+      @document = document
+      errors = @document.errors.full_messages.join(", ")
+      super(t("document_invalid", :errors => errors))
+    end
+  end
+
+  # Adds validations to {Ripple::Document} models. Validations are
+  # executed before saving the 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
+
+      # Instantiates a new document, applies attributes from a block, and saves it
+      # Raises Ripple::DocumentInvalid if the record did not save
+      def create!(*args, &block)
+        obj = create(*args, &block)
+        (raise Ripple::DocumentInvalid.new(obj) if obj.new?) || obj
+      end
+    end
+
+    # @private
+    def save(options={:validate => true})
+      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!
+    end
+  end
+end
+

data/lib/ripple/validations/associated_validator.rb

@@ -0,0 +1,43 @@
+require 'active_model/validator'
+
+module Ripple
+  module Validations
+    class AssociatedValidator < ActiveModel::EachValidator
+      include Translation
+      def validate_each(record, attribute, value)
+        return if (value.is_a?(Array) ? value : [value]).collect{ |r| r.nil? || r.valid? }.all?
+        record.errors.add(attribute, error_message_for(attribute, value))
+      end
+
+      private
+
+        def error_message_for(attribute, associated_records)
+          if associated_records.respond_to?(:each_with_index)
+            record_errors = associated_records.enum_for(:each_with_index).collect do |record, index|
+              next unless record.errors.any?
+
+              t("associated_document_error_summary",
+                :doc_type => attribute.to_s.singularize,
+                :doc_id => index + 1,
+                :errors => record.errors.full_messages.to_sentence
+              )
+            end
+            record_errors.compact!
+            record_errors.flatten!
+
+            t("many_association_validation_error",
+              :association_errors => record_errors.join('; '))
+          else
+            t("one_association_validation_error",
+              :association_errors => associated_records.errors.full_messages.to_sentence)
+          end
+        end
+    end
+
+    module ClassMethods
+      def validates_associated(*attr_names)
+        validates_with AssociatedValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/ripple/version.rb

@@ -0,0 +1,3 @@
+module Ripple
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,310 @@
+--- !ruby/object:Gem::Specification
+name: better-ripple
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jon Frisby
+- Sean Cribbs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: !binary |-
+    YmV0dGVyLXJpYWstY2xpZW50
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - !binary |-
+        fj4=
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MS4wLjA=
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - !binary |-
+        fj4=
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MS4wLjA=
+- !ruby/object:Gem::Dependency
+  name: !binary |-
+    YWN0aXZlc3VwcG9ydA==
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - !binary |-
+        Pj0=
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          My4wLjA=
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - !binary |-
+        Pj0=
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          My4wLjA=
+- !ruby/object:Gem::Dependency
+  name: !binary |-
+    YWN0aXZlc3VwcG9ydA==
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - !binary |-
+        Pj0=
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          My4wLjA=
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - !binary |-
+        Pj0=
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          My4wLjA=
+- !ruby/object:Gem::Dependency
+  name: !binary |-
+    YWN0aXZlbW9kZWw=
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - !binary |-
+        Pj0=
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          My4wLjA=
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - !binary |-
+        Pj0=
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          My4wLjA=
+- !ruby/object:Gem::Dependency
+  name: !binary |-
+    YWN0aXZlbW9kZWw=
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - !binary |-
+        Pj0=
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          My4wLjA=
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - !binary |-
+        Pj0=
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          My4wLjA=
+- !ruby/object:Gem::Dependency
+  name: !binary |-
+    dHppbmZv
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: !binary |-
+    cnNwZWM=
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - !binary |-
+        fj4=
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          Mi44LjA=
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - !binary |-
+        fj4=
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          Mi44LjA=
+- !ruby/object:Gem::Dependency
+  name: !binary |-
+    cmFrZQ==
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: !binary |-
+    YW1tZXRlcg==
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - !binary |-
+        fj4=
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MC4yLjI=
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - !binary |-
+        fj4=
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MC4yLjI=
+description: better-ripple is an improved version of ripple, an object-mapper library
+  for Riak.  It uses ActiveModel to provide an experience that integrates well with
+  Rails 3 applications.
+email:
+- jon@cloudability.com
+- sean@basho.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- RELEASE_NOTES.md
+- better-ripple.gemspec
+- lib/rails/generators/ripple/configuration/configuration_generator.rb
+- lib/rails/generators/ripple/configuration/templates/ripple.yml
+- lib/rails/generators/ripple/js/js_generator.rb
+- lib/rails/generators/ripple/js/templates/js/contrib.js
+- lib/rails/generators/ripple/js/templates/js/iso8601.js
+- lib/rails/generators/ripple/js/templates/js/ripple.js
+- lib/rails/generators/ripple/model/model_generator.rb
+- lib/rails/generators/ripple/model/templates/model.rb.erb
+- lib/rails/generators/ripple/observer/observer_generator.rb
+- lib/rails/generators/ripple/observer/templates/observer.rb.erb
+- lib/rails/generators/ripple/test/templates/cucumber.rb.erb
+- lib/rails/generators/ripple/test/test_generator.rb
+- lib/rails/generators/ripple_generator.rb
+- lib/ripple.rb
+- lib/ripple/associations.rb
+- lib/ripple/associations/embedded.rb
+- lib/ripple/associations/instantiators.rb
+- lib/ripple/associations/linked.rb
+- lib/ripple/associations/many.rb
+- lib/ripple/associations/many_embedded_proxy.rb
+- lib/ripple/associations/many_linked_proxy.rb
+- lib/ripple/associations/many_reference_proxy.rb
+- lib/ripple/associations/many_stored_key_proxy.rb
+- lib/ripple/associations/one.rb
+- lib/ripple/associations/one_embedded_proxy.rb
+- lib/ripple/associations/one_key_proxy.rb
+- lib/ripple/associations/one_linked_proxy.rb
+- lib/ripple/associations/one_stored_key_proxy.rb
+- lib/ripple/associations/proxy.rb
+- lib/ripple/attribute_methods.rb
+- lib/ripple/attribute_methods/dirty.rb
+- lib/ripple/attribute_methods/query.rb
+- lib/ripple/attribute_methods/read.rb
+- lib/ripple/attribute_methods/write.rb
+- lib/ripple/callbacks.rb
+- lib/ripple/conflict/basic_resolver.rb
+- lib/ripple/conflict/document_hooks.rb
+- lib/ripple/conflict/resolver.rb
+- lib/ripple/conflict/test_helper.rb
+- lib/ripple/conversion.rb
+- lib/ripple/core_ext.rb
+- lib/ripple/core_ext/casting.rb
+- lib/ripple/core_ext/indexes.rb
+- lib/ripple/core_ext/object.rb
+- lib/ripple/document.rb
+- lib/ripple/document/bucket_access.rb
+- lib/ripple/document/finders.rb
+- lib/ripple/document/key.rb
+- lib/ripple/document/link.rb
+- lib/ripple/document/persistence.rb
+- lib/ripple/embedded_document.rb
+- lib/ripple/embedded_document/around_callbacks.rb
+- lib/ripple/embedded_document/finders.rb
+- lib/ripple/embedded_document/persistence.rb
+- lib/ripple/i18n.rb
+- lib/ripple/indexes.rb
+- lib/ripple/inspection.rb
+- lib/ripple/locale/en.yml
+- lib/ripple/locale/fr.yml
+- lib/ripple/nested_attributes.rb
+- lib/ripple/observable.rb
+- lib/ripple/properties.rb
+- lib/ripple/property_type_mismatch.rb
+- lib/ripple/railtie.rb
+- lib/ripple/railties/ripple.rake
+- lib/ripple/serialization.rb
+- lib/ripple/test_server.rb
+- lib/ripple/timestamps.rb
+- lib/ripple/translation.rb
+- lib/ripple/validations.rb
+- lib/ripple/validations/associated_validator.rb
+- lib/ripple/version.rb
+homepage: http://github.com/cloudability/better-ripple
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2064328604662960294
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: better-ripple is an improved version of ripple, an object-mapper library
+  for Riak.
+test_files: []