ardm-core 1.2.1

data/lib/dm-core/support/local_object_space.rb

@@ -0,0 +1,12 @@
+module DataMapper
+  module LocalObjectSpace
+    def self.extended(klass)
+      (class << klass; self; end).send :attr_accessor, :hook_scopes
+      klass.hook_scopes = []
+    end
+
+    def object_by_id(object_id)
+      self.hook_scopes.detect { |object| object.object_id == object_id }
+    end
+  end
+end

data/lib/dm-core/support/logger.rb

@@ -0,0 +1,199 @@
+# ==== Public DataMapper Logger API
+#
+# To replace an existing logger with a new one:
+#  DataMapper::Logger.set_log(log{String, IO},level{Symbol, String})
+#
+# Available logging levels are
+#   DataMapper::Logger::{ Fatal, Error, Warn, Info, Debug }
+#
+# Logging via:
+#   DataMapper.logger.fatal(message<String>,&block)
+#   DataMapper.logger.error(message<String>,&block)
+#   DataMapper.logger.warn(message<String>,&block)
+#   DataMapper.logger.info(message<String>,&block)
+#   DataMapper.logger.debug(message<String>,&block)
+#
+# Logging with autoflush:
+#   DataMapper.logger.fatal!(message<String>,&block)
+#   DataMapper.logger.error!(message<String>,&block)
+#   DataMapper.logger.warn!(message<String>,&block)
+#   DataMapper.logger.info!(message<String>,&block)
+#   DataMapper.logger.debug!(message<String>,&block)
+#
+# Flush the buffer to
+#   DataMapper.logger.flush
+#
+# Remove the current log object
+#   DataMapper.logger.close
+#
+# ==== Private DataMapper Logger API
+#
+# To initialize the logger you create a new object, proxies to set_log.
+#   DataMapper::Logger.new(log{String, IO},level{Symbol, String})
+module DataMapper
+
+  class << self
+    attr_accessor :logger
+  end
+
+  class Logger
+
+    attr_accessor :level
+    attr_accessor :delimiter
+    attr_accessor :auto_flush
+    attr_reader   :buffer
+    attr_reader   :log
+    attr_reader   :init_args
+
+    # ==== Notes
+    # Ruby (standard) logger levels:
+    # :fatal:: An unhandleable error that results in a program crash
+    # :error:: A handleable error condition
+    # :warn:: A warning
+    # :info:: generic (useful) information about system operation
+    # :debug:: low-level information for developers
+    Levels =
+    {
+      :fatal => 7,
+      :error => 6,
+      :warn  => 4,
+      :info  => 3,
+      :debug => 0
+    }
+
+    private
+
+    # Readies a log for writing.
+    #
+    # ==== Parameters
+    # log<IO, String>:: Either an IO object or a name of a logfile.
+    def initialize_log(log)
+      close if @log # be sure that we don't leave open files laying around.
+
+      if log.respond_to?(:write)
+        @log = log
+      elsif File.exist?(log)
+        @log = open(log, (File::WRONLY | File::APPEND))
+        @log.sync = true
+      else
+        FileUtils.mkdir_p(File.dirname(log)) unless File.directory?(File.dirname(log))
+        @log = open(log, (File::WRONLY | File::APPEND | File::CREAT))
+        @log.sync = true
+        @log.write("#{Time.now.httpdate} #{delimiter} info #{delimiter} Logfile created\n")
+      end
+    end
+
+    public
+
+    # To initialize the logger you create a new object, proxies to set_log.
+    #
+    # ==== Parameters
+    # *args:: Arguments to create the log from. See set_logs for specifics.
+    def initialize(*args)
+      @init_args = args
+      set_log(*args)
+      self.auto_flush = true
+      DataMapper.logger = self
+    end
+
+    # Replaces an existing logger with a new one.
+    #
+    # ==== Parameters
+    # log<IO, String>:: Either an IO object or a name of a logfile.
+    # log_level<~to_sym>::
+    #   The log level from, e.g. :fatal or :info. Defaults to :error in the
+    #   production environment and :debug otherwise.
+    # delimiter<String>::
+    #   Delimiter to use between message sections. Defaults to " ~ ".
+    # auto_flush<Boolean>::
+    #   Whether the log should automatically flush after new messages are
+    #   added. Defaults to false.
+    def set_log(log, log_level = nil, delimiter = " ~ ", auto_flush = false)
+      if log_level && Levels[log_level.to_sym]
+        @level = Levels[log_level.to_sym]
+      else
+        @level = Levels[:debug]
+      end
+      @buffer     = []
+      @delimiter  = delimiter
+      @auto_flush = auto_flush
+
+      initialize_log(log)
+    end
+
+    # Flush the entire buffer to the log object.
+    def flush
+      return unless @buffer.size > 0
+      @log.write(@buffer.slice!(0..-1).join)
+    end
+
+    # Close and remove the current log object.
+    def close
+      flush
+      @log.close if @log.respond_to?(:close) && !@log.tty?
+      @log = nil
+    end
+
+    # Appends a message to the log. The methods yield to an optional block and
+    # the output of this block will be appended to the message.
+    #
+    # ==== Parameters
+    # string<String>:: The message to be logged. Defaults to nil.
+    #
+    # ==== Returns
+    # String:: The resulting message added to the log file.
+    def <<(string = nil)
+      message = ""
+      message << delimiter
+      message << string if string
+      message << "\n" unless message[-1] == ?\n
+      @buffer << message
+      flush if @auto_flush
+
+      message
+    end
+    alias_method :push, :<<
+
+    # Generate the logging methods for DataMapper.logger for each log level.
+    Levels.each_pair do |name, number|
+      class_eval <<-LEVELMETHODS, __FILE__, __LINE__
+
+      # Appends a message to the log if the log level is at least as high as
+      # the log level of the logger.
+      #
+      # ==== Parameters
+      # string<String>:: The message to be logged. Defaults to nil.
+      #
+      # ==== Returns
+      # self:: The logger object for chaining.
+      def #{name}(message = nil)
+        self << message if #{number} >= level
+        self
+      end
+
+      # Appends a message to the log if the log level is at least as high as
+      # the log level of the logger. The bang! version of the method also auto
+      # flushes the log buffer to disk.
+      #
+      # ==== Parameters
+      # string<String>:: The message to be logged. Defaults to nil.
+      #
+      # ==== Returns
+      # self:: The logger object for chaining.
+      def #{name}!(message = nil)
+        self << message if #{number} >= level
+        flush if #{number} >= level
+        self
+      end
+
+      # ==== Returns
+      # Boolean:: True if this level will be logged by this logger.
+      def #{name}?
+        #{number} >= level
+      end
+      LEVELMETHODS
+    end
+
+  end
+
+end

data/lib/dm-core/support/mash.rb

@@ -0,0 +1,176 @@
+module DataMapper
+  # This class has dubious semantics and we only have it so that people can write
+  # params[:key] instead of params['key'].
+  class Mash < Hash
+
+    # Initializes a new mash.
+    #
+    # @param [Hash, Object] constructor
+    #   The default value for the mash. If +constructor+ is a Hash, a new mash
+    #   will be created based on the keys of the hash and no default value will
+    #   be set.
+    def initialize(constructor = {})
+      if constructor.is_a?(Hash)
+        super()
+        update(constructor)
+      else
+        super(constructor)
+      end
+    end
+
+    # Gets the default value for the mash.
+    #
+    # @param [Object] key
+    #   The default value for the mash. If +key+ is a Symbol and it is a key in
+    #   the mash, then the default value will be set to the value matching the
+    #   key.
+    def default(key = nil)
+      if key.is_a?(Symbol) && include?(key = key.to_s)
+        self[key]
+      else
+        super
+      end
+    end
+
+    alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
+    alias_method :regular_update, :update unless method_defined?(:regular_update)
+
+    # Sets the +value+ associated with the specified +key+.
+    #
+    # @param [Object] key The key to set.
+    # @param [Object] value The value to set the key to.
+    def []=(key, value)
+      regular_writer(convert_key(key), convert_value(value))
+    end
+
+    # Updates the mash with the key/value pairs from the specified hash.
+    #
+    # @param [Hash] other_hash
+    #   A hash to update values in the mash with. The keys and the values will be
+    #   converted to Mash format.
+    #
+    # @return [Mash] The updated mash.
+    def update(other_hash)
+      other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
+      self
+    end
+
+    alias_method :merge!, :update
+
+    # Determines whether the mash contains the specified +key+.
+    #
+    # @param [Object] key The key to check for.
+    # @return [Boolean] True if the key exists in the mash.
+    def key?(key)
+      super(convert_key(key))
+    end
+
+    alias_method :include?, :key?
+    alias_method :has_key?, :key?
+    alias_method :member?, :key?
+
+    # @param [Object] key The key to fetch.
+    # @param [Array] *extras Default value.
+    #
+    # @return [Object] The value at key or the default value.
+    def fetch(key, *extras)
+      super(convert_key(key), *extras)
+    end
+
+    # @param [Array] *indices
+    #   The keys to retrieve values for.
+    #
+    # @return [Array] The values at each of the provided keys.
+    def values_at(*indices)
+      indices.collect {|key| self[convert_key(key)]}
+    end
+
+    # @param [Hash] hash The hash to merge with the mash.
+    #
+    # @return [Mash] A new mash with the hash values merged in.
+    def merge(hash)
+      self.dup.update(hash)
+    end
+
+    # @param [Object] key The key to delete from the mash.
+    def delete(key)
+      super(convert_key(key))
+    end
+
+    # Returns a mash that includes everything but the given +keys+.
+    #
+    # @param [Array<String, Symbol>] *keys The mash keys to exclude.
+    #
+    # @return [Mash] A new mash without the selected keys.
+    #
+    # @example
+    #   { :one => 1, :two => 2, :three => 3 }.except(:one)
+    #     #=> { "two" => 2, "three" => 3 }
+    def except(*keys)
+      self.dup.except!(*keys.map {|k| convert_key(k)})
+    end
+
+    # Removes the specified +keys+ from the mash.
+    #
+    # @param [Array] *keys The mash keys to exclude.
+    #
+    # @return [Hash] +hash+
+    #
+    # @example
+    #   mash = { :one => 1, :two => 2, :three => 3 }
+    #   mash.except!(:one, :two)
+    #   mash # => { :three => 3 }
+    def except!(*keys)
+      keys.each { |key| delete(key) }
+      self
+    end
+
+    # Used to provide the same interface as Hash.
+    #
+    # @return [Mash] This mash unchanged.
+    def stringify_keys!; self end
+
+    # @return [Hash] The mash as a Hash with symbolized keys.
+    def symbolize_keys
+      h = Hash.new(default)
+      each { |key, val| h[key.to_sym] = val }
+      h
+    end
+
+    # @return [Hash] The mash as a Hash with string keys.
+    def to_hash
+      Hash.new(default).merge(self)
+    end
+
+    protected
+    # @param [Object] key The key to convert.
+    #
+    # @param [Object]
+    #   The converted key. If the key was a symbol, it will be converted to a
+    #   string.
+    #
+    # @api private
+    def convert_key(key)
+      key.kind_of?(Symbol) ? key.to_s : key
+    end
+
+    # @param [Object] value The value to convert.
+    #
+    # @return [Object]
+    #   The converted value. A Hash or an Array of hashes, will be converted to
+    #   their Mash equivalents.
+    #
+    # @api private
+    def convert_value(value)
+      if value.class == Hash
+         mash = Mash.new(value)
+         mash.default = value.default
+         mash
+      elsif value.is_a?(Array)
+        value.collect { |e| convert_value(e) }
+      else
+        value
+      end
+    end
+  end
+end

data/lib/dm-core/support/naming_conventions.rb

@@ -0,0 +1,90 @@
+module DataMapper
+
+  # Use these modules to establish naming conventions.
+  # The default is UnderscoredAndPluralized.
+  # You assign a naming convention like so:
+  #
+  #   repository(:default).adapter.resource_naming_convention = NamingConventions::Resource::Underscored
+  #
+  # You can also easily assign a custom convention with a Proc:
+  #
+  #   repository(:default).adapter.resource_naming_convention = lambda do |value|
+  #     'tbl' + value.camelize(true)
+  #   end
+  #
+  # Or by simply defining your own module in NamingConventions that responds to
+  # ::call.
+  #
+  # NOTE: It's important to set the convention before accessing your models
+  # since the resource_names are cached after first accessed.
+  # DataMapper.setup(name, uri) returns the Adapter for convenience, so you can
+  # use code like this:
+  #
+  #   adapter = DataMapper.setup(:default, 'mock://localhost/mock')
+  #   adapter.resource_naming_convention = NamingConventions::Resource::Underscored
+  module NamingConventions
+
+    module Resource
+
+      module UnderscoredAndPluralized
+        def self.call(name)
+          DataMapper::Inflector.pluralize(DataMapper::Inflector.underscore(name)).gsub('/', '_')
+        end
+      end # module UnderscoredAndPluralized
+
+      module UnderscoredAndPluralizedWithoutModule
+        def self.call(name)
+          DataMapper::Inflector.pluralize(DataMapper::Inflector.underscore(DataMapper::Inflector.demodulize(name)))
+        end
+      end # module UnderscoredAndPluralizedWithoutModule
+
+      module UnderscoredAndPluralizedWithoutLeadingModule
+        def self.call(name)
+          UnderscoredAndPluralized.call(name.to_s.gsub(/^[^:]*::/,''))
+        end
+      end
+
+      module Underscored
+        def self.call(name)
+          DataMapper::Inflector.underscore(name)
+        end
+      end # module Underscored
+
+      module Yaml
+        def self.call(name)
+          "#{DataMapper::Inflector.pluralize(DataMapper::Inflector.underscore(name))}.yaml"
+        end
+      end # module Yaml
+
+    end # module Resource
+
+    module Field
+
+      module UnderscoredAndPluralized
+        def self.call(property)
+          DataMapper::Inflector.pluralize(DataMapper::Inflector.underscore(property.name.to_s)).gsub('/', '_')
+        end
+      end # module UnderscoredAndPluralized
+
+      module UnderscoredAndPluralizedWithoutModule
+        def self.call(property)
+          DataMapper::Inflector.pluralize(DataMapper::Inflector.underscore(DataMapper::Inflector.demodulize(property.name.to_s)))
+        end
+      end # module UnderscoredAndPluralizedWithoutModule
+
+      module Underscored
+        def self.call(property)
+          DataMapper::Inflector.underscore(property.name.to_s)
+        end
+      end # module Underscored
+
+      module Yaml
+        def self.call(property)
+          "#{DataMapper::Inflector.pluralize(DataMapper::Inflector.underscore(property.name.to_s))}.yaml"
+        end
+      end # module Yaml
+
+    end # module Field
+
+  end # module NamingConventions
+end # module DataMapper