riak-ruby-client / ripple / lib / ripple.rb

The default branch has multiple heads

# 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
#    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 'riak'
require 'active_support/all'
require 'active_model'
require 'ripple/i18n'
require 'ripple/core_ext'

# Contains the classes and modules related to the ODM built on top of
# the basic Riak client.
module Ripple
  extend ActiveSupport::Autoload

  # Primary models
  autoload :EmbeddedDocument
  autoload :Document

  # Model mixins and support classes
  autoload :Association, "ripple/associations"
  autoload :Associations
  autoload :AttributeMethods
  autoload :Callbacks
  autoload :Conversion
  autoload :Properties
  autoload :Property, "ripple/properties"
  autoload :Timestamps
  autoload :Validations
  autoload :NestedAttributes

  # Exceptions
  autoload :PropertyTypeMismatch

  # Utilities
  autoload :Inspection
  autoload :Translation

  class << self
    # @return [Riak::Client] The client for the current thread.
    def client
      Thread.current[:ripple_client] ||=

    # Sets the client for the current thread.
    # @param [Riak::Client] value the client
    def client=(value)
      Thread.current[:ripple_client] = value

    # Sets the global Ripple configuration.
    def config=(hash)
      self.client = nil
      @config = hash.symbolize_keys

    # Reads the global Ripple configuration.
    def config
      @config ||= {}

    # 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(
      config_keys.each {|k| config_hash = config_hash[k]}
      self.config = config_hash || {}
    rescue Errno::ENOENT
    alias_method :load_config, :load_configuration

  # 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)
      super(t("missing_configuration", :file => file_path))

require 'ripple/railtie' if defined? Rails::Railtie