csd 0.0.15 → 0.0.16

data/lib/active_support.rb

@@ -0,0 +1,75 @@
+#--
+# Copyright (c) 2005 David Heinemeier Hansson
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+module ActiveSupport
+  class << self
+    attr_accessor :load_all_hooks
+    def on_load_all(&hook) load_all_hooks << hook end
+    def load_all!; load_all_hooks.each { |hook| hook.call } end
+  end
+  self.load_all_hooks = []
+
+  on_load_all do
+    [Dependencies, Deprecation, Gzip, MessageVerifier, Multibyte, SecureRandom]
+  end
+end
+
+require "active_support/dependencies/autoload"
+
+module ActiveSupport
+  extend ActiveSupport::Autoload
+
+  # TODO: Narrow this list down
+  eager_autoload do
+    autoload :BacktraceCleaner
+    autoload :Base64
+    autoload :BasicObject
+    autoload :Benchmarkable
+    autoload :BufferedLogger
+    autoload :Cache
+    autoload :Callbacks
+    autoload :Concern
+    autoload :Configurable
+    autoload :Deprecation
+    autoload :Gzip
+    autoload :Inflector
+    autoload :JSON
+    autoload :Memoizable
+    autoload :MessageEncryptor
+    autoload :MessageVerifier
+    autoload :Multibyte
+    autoload :OptionMerger
+    autoload :OrderedHash
+    autoload :OrderedOptions
+    autoload :Notifications
+    autoload :Rescuable
+    autoload :SecureRandom
+    autoload :StringInquirer
+    autoload :XmlMini
+  end
+
+  autoload :SafeBuffer, "active_support/core_ext/string/output_safety"
+  autoload :TestCase
+end
+
+autoload :I18n, "active_support/i18n"

data/lib/active_support/all.rb

@@ -0,0 +1,3 @@
+require 'active_support'
+require 'active_support/time'
+require 'active_support/core_ext'

data/lib/active_support/backtrace_cleaner.rb

@@ -0,0 +1,94 @@
+module ActiveSupport
+  # Many backtraces include too much information that's not relevant for the context. This makes it hard to find the signal
+  # in the backtrace and adds debugging time. With a BacktraceCleaner, you can setup filters and silencers for your particular
+  # context, so only the relevant lines are included.
+  #
+  # If you need to reconfigure an existing BacktraceCleaner, like the one in Rails, to show as much as possible, you can always
+  # call BacktraceCleaner#remove_silencers! Also, if you need to reconfigure an existing BacktraceCleaner so that it does not
+  # filter or modify the paths of any lines of the backtrace, you can call BacktraceCleaner#remove_filters! These two methods
+  # will give you a completely untouched backtrace.
+  #
+  # Example:
+  #
+  #   bc = BacktraceCleaner.new
+  #   bc.add_filter   { |line| line.gsub(Rails.root, '') }
+  #   bc.add_silencer { |line| line =~ /mongrel|rubygems/ }
+  #   bc.clean(exception.backtrace) # will strip the Rails.root prefix and skip any lines from mongrel or rubygems
+  #
+  # Inspired by the Quiet Backtrace gem by Thoughtbot.
+  class BacktraceCleaner
+    def initialize
+      @filters, @silencers = [], []
+    end
+
+    # Returns the backtrace after all filters and silencers has been run against it. Filters run first, then silencers.
+    def clean(backtrace, kind = :silent)
+      filtered = filter(backtrace)
+
+      case kind
+      when :silent
+        silence(filtered)
+      when :noise
+        noise(filtered)
+      else
+        filtered
+      end
+    end
+
+    # Adds a filter from the block provided. Each line in the backtrace will be mapped against this filter.
+    #
+    # Example:
+    #
+    #   # Will turn "/my/rails/root/app/models/person.rb" into "/app/models/person.rb"
+    #   backtrace_cleaner.add_filter { |line| line.gsub(Rails.root, '') }
+    def add_filter(&block)
+      @filters << block
+    end
+
+    # Adds a silencer from the block provided. If the silencer returns true for a given line, it'll be excluded from the
+    # clean backtrace.
+    #
+    # Example:
+    #
+    #   # Will reject all lines that include the word "mongrel", like "/gems/mongrel/server.rb" or "/app/my_mongrel_server/rb"
+    #   backtrace_cleaner.add_silencer { |line| line =~ /mongrel/ }
+    def add_silencer(&block)
+      @silencers << block
+    end
+
+    # Will remove all silencers, but leave in the filters. This is useful if your context of debugging suddenly expands as
+    # you suspect a bug in the libraries you use.
+    def remove_silencers!
+      @silencers = []
+    end
+
+    def remove_filters!
+      @filters = []
+    end
+
+    private
+      def filter(backtrace)
+        @filters.each do |f|
+          backtrace = backtrace.map { |line| f.call(line) }
+        end
+
+        backtrace
+      end
+
+      def silence(backtrace)
+        @silencers.each do |s|
+          backtrace = backtrace.reject { |line| s.call(line) }
+        end
+
+        backtrace
+      end
+
+      def noise(backtrace)
+        @silencers.each do |s|
+          backtrace = backtrace.select { |line| s.call(line) }
+        end
+
+        backtrace
+      end
+  end
+end

data/lib/active_support/base64.rb

@@ -0,0 +1,42 @@
+begin
+  require 'base64'
+rescue LoadError
+end
+
+module ActiveSupport
+  if defined? ::Base64
+    Base64 = ::Base64
+  else
+    # Base64 provides utility methods for encoding and de-coding binary data 
+    # using a base 64 representation. A base 64 representation of binary data
+    # consists entirely of printable US-ASCII characters. The Base64 module
+    # is included in Ruby 1.8, but has been removed in Ruby 1.9.
+    module Base64
+      # Encodes a string to its base 64 representation. Each 60 characters of
+      # output is separated by a newline character.
+      #
+      #  ActiveSupport::Base64.encode64("Original unencoded string") 
+      #  # => "T3JpZ2luYWwgdW5lbmNvZGVkIHN0cmluZw==\n"
+      def self.encode64(data)
+        [data].pack("m")
+      end
+
+      # Decodes a base 64 encoded string to its original representation.
+      #
+      #  ActiveSupport::Base64.decode64("T3JpZ2luYWwgdW5lbmNvZGVkIHN0cmluZw==") 
+      #  # => "Original unencoded string"
+      def self.decode64(data)
+        data.unpack("m").first
+      end
+    end
+  end
+
+  # Encodes the value as base64 without the newline breaks. This makes the base64 encoding readily usable as URL parameters
+  # or memcache keys without further processing.
+  #
+  #  ActiveSupport::Base64.encode64s("Original unencoded string")
+  #  # => "T3JpZ2luYWwgdW5lbmNvZGVkIHN0cmluZw=="
+  def Base64.encode64s(value)
+    encode64(value).gsub(/\n/, '')
+  end
+end

data/lib/active_support/basic_object.rb

@@ -0,0 +1,21 @@
+module ActiveSupport
+  if defined? ::BasicObject
+    # A class with no predefined methods that behaves similarly to Builder's
+    # BlankSlate. Used for proxy classes.
+    class BasicObject < ::BasicObject
+      undef_method :==
+      undef_method :equal?
+
+      # Let ActiveSupport::BasicObject at least raise exceptions.
+      def raise(*args)
+        ::Object.send(:raise, *args)
+      end
+    end
+  else
+    class BasicObject #:nodoc:
+      instance_methods.each do |m|
+        undef_method(m) if m.to_s !~ /(?:^__|^nil\?$|^send$|^object_id$)/
+      end
+    end
+  end
+end

data/lib/active_support/benchmarkable.rb

@@ -0,0 +1,60 @@
+require 'active_support/core_ext/benchmark'
+require 'active_support/core_ext/hash/keys'
+
+module ActiveSupport
+  module Benchmarkable
+    # Allows you to measure the execution time of a block 
+    # in a template and records the result to the log. Wrap this block around
+    # expensive operations or possible bottlenecks to get a time reading
+    # for the operation.  For example, let's say you thought your file 
+    # processing method was taking too long; you could wrap it in a benchmark block.
+    #
+    #  <% benchmark "Process data files" do %>
+    #    <%= expensive_files_operation %>
+    #  <% end %>
+    #
+    # That would add something like "Process data files (345.2ms)" to the log,
+    # which you can then use to compare timings when optimizing your code.
+    #
+    # You may give an optional logger level as the :level option.
+    # (:debug, :info, :warn, :error); the default value is :info.
+    #
+    #  <% benchmark "Low-level files", :level => :debug do %>
+    #    <%= lowlevel_files_operation %>
+    #  <% end %>
+    #
+    # Finally, you can pass true as the third argument to silence all log activity 
+    # inside the block. This is great for boiling down a noisy block to just a single statement:
+    #
+    #  <% benchmark "Process data files", :level => :info, :silence => true do %>
+    #    <%= expensive_and_chatty_files_operation %>
+    #  <% end %>
+    def benchmark(message = "Benchmarking", options = {})
+      if logger
+        if options.is_a?(Symbol)
+          ActiveSupport::Deprecation.warn("use benchmark('#{message}', :level => :#{options}) instead", caller)
+          options = { :level => options, :silence => false }
+        else
+          options.assert_valid_keys(:level, :silence)
+          options[:level] ||= :info
+        end
+
+        result = nil
+        ms = Benchmark.ms { result = options[:silence] ? logger.silence { yield } : yield }
+        logger.send(options[:level], '%s (%.1fms)' % [ message, ms ])
+        result
+      else
+        yield
+      end
+    end
+
+    # Silence the logger during the execution of the block.
+    #
+    def silence
+      old_logger_level, logger.level = logger.level, ::Logger::ERROR if logger
+      yield
+    ensure
+      logger.level = old_logger_level if logger
+    end
+  end
+end

data/lib/active_support/buffered_logger.rb

@@ -0,0 +1,132 @@
+require 'active_support/core_ext/class/attribute_accessors'
+
+module ActiveSupport
+  # Inspired by the buffered logger idea by Ezra
+  class BufferedLogger
+    module Severity
+      DEBUG   = 0
+      INFO    = 1
+      WARN    = 2
+      ERROR   = 3
+      FATAL   = 4
+      UNKNOWN = 5
+    end
+    include Severity
+
+    MAX_BUFFER_SIZE = 1000
+
+    ##
+    # :singleton-method:
+    # Set to false to disable the silencer
+    cattr_accessor :silencer
+    self.silencer = true
+
+    # Silences the logger for the duration of the block.
+    def silence(temporary_level = ERROR)
+      if silencer
+        begin
+          old_logger_level, self.level = level, temporary_level
+          yield self
+        ensure
+          self.level = old_logger_level
+        end
+      else
+        yield self
+      end
+    end
+
+    attr_accessor :level
+    attr_reader :auto_flushing
+
+    def initialize(log, level = DEBUG)
+      @level         = level
+      @buffer        = {}
+      @auto_flushing = 1
+      @guard = Mutex.new
+
+      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))
+        @log = open(log, (File::WRONLY | File::APPEND | File::CREAT))
+        @log.sync = true
+      end
+    end
+
+    def add(severity, message = nil, progname = nil, &block)
+      return if @level > severity
+      message = (message || (block && block.call) || progname).to_s
+      # If a newline is necessary then create a new message ending with a newline.
+      # Ensures that the original message is not mutated.
+      message = "#{message}\n" unless message[-1] == ?\n
+      buffer << message
+      auto_flush
+      message
+    end
+
+    # Dynamically add methods such as:
+    # def info
+    # def warn
+    # def debug
+    for severity in Severity.constants
+      class_eval <<-EOT, __FILE__, __LINE__ + 1
+        def #{severity.downcase}(message = nil, progname = nil, &block) # def debug(message = nil, progname = nil, &block)
+          add(#{severity}, message, progname, &block)                   #   add(DEBUG, message, progname, &block)
+        end                                                             # end
+
+        def #{severity.downcase}?                                       # def debug?
+          #{severity} >= @level                                         #   DEBUG >= @level
+        end                                                             # end
+      EOT
+    end
+
+    # Set the auto-flush period. Set to true to flush after every log message,
+    # to an integer to flush every N messages, or to false, nil, or zero to
+    # never auto-flush. If you turn auto-flushing off, be sure to regularly
+    # flush the log yourself -- it will eat up memory until you do.
+    def auto_flushing=(period)
+      @auto_flushing =
+        case period
+        when true;                1
+        when false, nil, 0;       MAX_BUFFER_SIZE
+        when Integer;             period
+        else raise ArgumentError, "Unrecognized auto_flushing period: #{period.inspect}"
+        end
+    end
+
+    def flush
+      @guard.synchronize do
+        unless buffer.empty?
+          old_buffer = buffer
+          @log.write(old_buffer.join)
+        end
+
+        # Important to do this even if buffer was empty or else @buffer will
+        # accumulate empty arrays for each request where nothing was logged.
+        clear_buffer
+      end
+    end
+
+    def close
+      flush
+      @log.close if @log.respond_to?(:close)
+      @log = nil
+    end
+
+    protected
+      def auto_flush
+        flush if buffer.size >= @auto_flushing
+      end
+
+      def buffer
+        @buffer[Thread.current] ||= []
+      end
+
+      def clear_buffer
+        @buffer.delete(Thread.current)
+      end
+  end
+end

data/lib/active_support/builder.rb

@@ -0,0 +1,6 @@
+begin
+  require 'builder'
+rescue LoadError => e
+  $stderr.puts "You don't have builder installed in your application. Please add it to your Gemfile and run bundle install"
+  raise e
+end

data/lib/active_support/cache.rb

@@ -0,0 +1,626 @@
+require 'benchmark'
+require 'zlib'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/array/wrap'
+require 'active_support/core_ext/benchmark'
+require 'active_support/core_ext/exception'
+require 'active_support/core_ext/class/attribute_accessors'
+require 'active_support/core_ext/numeric/bytes'
+require 'active_support/core_ext/numeric/time'
+require 'active_support/core_ext/object/to_param'
+require 'active_support/core_ext/string/inflections'
+
+module ActiveSupport
+  # See ActiveSupport::Cache::Store for documentation.
+  module Cache
+    autoload :FileStore, 'active_support/cache/file_store'
+    autoload :MemoryStore, 'active_support/cache/memory_store'
+    autoload :MemCacheStore, 'active_support/cache/mem_cache_store'
+    autoload :SynchronizedMemoryStore, 'active_support/cache/synchronized_memory_store'
+    autoload :CompressedMemCacheStore, 'active_support/cache/compressed_mem_cache_store'
+
+    EMPTY_OPTIONS = {}.freeze
+
+    # These options mean something to all cache implementations. Individual cache
+    # implementations may support additional optons.
+    UNIVERSAL_OPTIONS = [:namespace, :compress, :compress_threshold, :expires_in, :race_condition_ttl]
+
+    module Strategy
+      autoload :LocalCache, 'active_support/cache/strategy/local_cache'
+    end
+
+    # Creates a new CacheStore object according to the given options.
+    #
+    # If no arguments are passed to this method, then a new
+    # ActiveSupport::Cache::MemoryStore object will be returned.
+    #
+    # If you pass a Symbol as the first argument, then a corresponding cache
+    # store class under the ActiveSupport::Cache namespace will be created.
+    # For example:
+    #
+    #   ActiveSupport::Cache.lookup_store(:memory_store)
+    #   # => returns a new ActiveSupport::Cache::MemoryStore object
+    #
+    #   ActiveSupport::Cache.lookup_store(:mem_cache_store)
+    #   # => returns a new ActiveSupport::Cache::MemCacheStore object
+    #
+    # Any additional arguments will be passed to the corresponding cache store
+    # class's constructor:
+    #
+    #   ActiveSupport::Cache.lookup_store(:file_store, "/tmp/cache")
+    #   # => same as: ActiveSupport::Cache::FileStore.new("/tmp/cache")
+    #
+    # If the first argument is not a Symbol, then it will simply be returned:
+    #
+    #   ActiveSupport::Cache.lookup_store(MyOwnCacheStore.new)
+    #   # => returns MyOwnCacheStore.new
+    def self.lookup_store(*store_option)
+      store, *parameters = *Array.wrap(store_option).flatten
+
+      case store
+      when Symbol
+        store_class_name = store.to_s.camelize
+        store_class = ActiveSupport::Cache.const_get(store_class_name)
+        store_class.new(*parameters)
+      when nil
+        ActiveSupport::Cache::MemoryStore.new
+      else
+        store
+      end
+    end
+
+    def self.expand_cache_key(key, namespace = nil)
+      expanded_cache_key = namespace ? "#{namespace}/" : ""
+
+      prefix = ENV["RAILS_CACHE_ID"] || ENV["RAILS_APP_VERSION"]
+      if prefix
+        expanded_cache_key << "#{prefix}/"
+      end
+
+      expanded_cache_key <<
+        if key.respond_to?(:cache_key)
+          key.cache_key
+        elsif key.is_a?(Array)
+          if key.size > 1
+            key.collect { |element| expand_cache_key(element) }.to_param
+          else
+            key.first.to_param
+          end
+        elsif key
+          key.to_param
+        end.to_s
+
+      expanded_cache_key
+    end
+
+    # An abstract cache store class. There are multiple cache store
+    # implementations, each having its own additional features. See the classes
+    # under the ActiveSupport::Cache module, e.g.
+    # ActiveSupport::Cache::MemCacheStore. MemCacheStore is currently the most
+    # popular cache store for large production websites.
+    #
+    # Some implementations may not support all methods beyond the basic cache
+    # methods of +fetch+, +write+, +read+, +exist?+, and +delete+.
+    #
+    # ActiveSupport::Cache::Store can store any serializable Ruby object.
+    #
+    #   cache = ActiveSupport::Cache::MemoryStore.new
+    #
+    #   cache.read("city")   # => nil
+    #   cache.write("city", "Duckburgh")
+    #   cache.read("city")   # => "Duckburgh"
+    #
+    # Keys are always translated into Strings and are case sensitive. When an
+    # object is specified as a key, its +cache_key+ method will be called if it
+    # is defined. Otherwise, the +to_param+ method will be called. Hashes and
+    # Arrays can be used as keys. The elements will be delimited by slashes
+    # and Hashes elements will be sorted by key so they are consistent.
+    #
+    #   cache.read("city") == cache.read(:city)   # => true
+    #
+    # Nil values can be cached.
+    #
+    # If your cache is on a shared infrastructure, you can define a namespace for
+    # your cache entries. If a namespace is defined, it will be prefixed on to every
+    # key. The namespace can be either a static value or a Proc. If it is a Proc, it
+    # will be invoked when each key is evaluated so that you can use application logic
+    # to invalidate keys.
+    #
+    #   cache.namespace = lambda { @last_mod_time }  # Set the namespace to a variable
+    #   @last_mod_time = Time.now  # Invalidate the entire cache by changing namespace
+    #
+    # All caches support auto expiring content after a specified number of seconds.
+    # To set the cache entry time to live, you can either specify +:expires_in+ as
+    # an option to the constructor to have it affect all entries or to the +fetch+
+    # or +write+ methods for just one entry.
+    #
+    #   cache = ActiveSupport::Cache::MemoryStore.new(:expire_in => 5.minutes)
+    #   cache.write(key, value, :expire_in => 1.minute)  # Set a lower value for one entry
+    #
+    # Caches can also store values in a compressed format to save space and reduce
+    # time spent sending data. Since there is some overhead, values must be large
+    # enough to warrant compression. To turn on compression either pass
+    # <tt>:compress => true</tt> in the initializer or to +fetch+ or +write+.
+    # To specify the threshold at which to compress values, set
+    # <tt>:compress_threshold</tt>. The default threshold is 32K.
+    class Store
+
+      cattr_accessor :logger, :instance_writer => true
+
+      attr_reader :silence
+      alias :silence? :silence
+
+      # Create a new cache. The options will be passed to any write method calls except
+      # for :namespace which can be used to set the global namespace for the cache.
+      def initialize (options = nil)
+        @options = options ? options.dup : {}
+      end
+
+      # Get the default options set when the cache was created.
+      def options
+        @options ||= {}
+      end
+
+      # Silence the logger.
+      def silence!
+        @silence = true
+        self
+      end
+
+      # Silence the logger within a block.
+      def mute
+        previous_silence, @silence = defined?(@silence) && @silence, true
+        yield
+      ensure
+        @silence = previous_silence
+      end
+
+      # Set to true if cache stores should be instrumented. By default is false.
+      def self.instrument=(boolean)
+        Thread.current[:instrument_cache_store] = boolean
+      end
+
+      def self.instrument
+        Thread.current[:instrument_cache_store] || false
+      end
+
+      # Fetches data from the cache, using the given key. If there is data in
+      # the cache with the given key, then that data is returned.
+      #
+      # If there is no such data in the cache (a cache miss occurred), then
+      # then nil will be returned. However, if a block has been passed, then
+      # that block will be run in the event of a cache miss. The return value
+      # of the block will be written to the cache under the given cache key,
+      # and that return value will be returned.
+      #
+      #   cache.write("today", "Monday")
+      #   cache.fetch("today")  # => "Monday"
+      #
+      #   cache.fetch("city")   # => nil
+      #   cache.fetch("city") do
+      #     "Duckburgh"
+      #   end
+      #   cache.fetch("city")   # => "Duckburgh"
+      #
+      # You may also specify additional options via the +options+ argument.
+      # Setting <tt>:force => true</tt> will force a cache miss:
+      #
+      #   cache.write("today", "Monday")
+      #   cache.fetch("today", :force => true)  # => nil
+      #
+      # Setting <tt>:compress</tt> will store a large cache entry set by the call
+      # in a compressed format.
+      #
+      # Setting <tt>:expires_in</tt> will set an expiration time on the cache
+      # entry if it is set by call.
+      #
+      # Setting <tt>:race_condition_ttl</tt> will invoke logic on entries set with
+      # an <tt>:expires_in</tt> option. If an entry is found in the cache that is
+      # expired and it has been expired for less than the number of seconds specified
+      # by this option and a block was passed to the method call, then the expiration
+      # future time of the entry in the cache will be updated to that many seconds
+      # in the and the block will be evaluated and written to the cache.
+      #
+      # This is very useful in situations where a cache entry is used very frequently
+      # under heavy load. The first process to find an expired cache entry will then
+      # become responsible for regenerating that entry while other processes continue
+      # to use the slightly out of date entry. This can prevent race conditions where
+      # too many processes are trying to regenerate the entry all at once. If the
+      # process regenerating the entry errors out, the entry will be regenerated
+      # after the specified number of seconds.
+      #
+      #   # Set all values to expire after one minute.
+      #   cache = ActiveSupport::Cache::MemoryCache.new(:expires_in => 1.minute)
+      #
+      #   cache.write("foo", "original value")
+      #   val_1 = nil
+      #   val_2 = nil
+      #   sleep 60
+      #
+      #   Thread.new do
+      #     val_1 = cache.fetch("foo", :race_condition_ttl => 10) do
+      #       sleep 1
+      #       "new value 1"
+      #     end
+      #   end
+      #
+      #   Thread.new do
+      #     val_2 = cache.fetch("foo", :race_condition_ttl => 10) do
+      #       "new value 2"
+      #     end
+      #   end
+      #
+      #   # val_1 => "new value 1"
+      #   # val_2 => "original value"
+      #   # cache.fetch("foo") => "new value 1"
+      #
+      # Other options will be handled by the specific cache store implementation.
+      # Internally, #fetch calls #read_entry, and calls #write_entry on a cache miss.
+      # +options+ will be passed to the #read and #write calls.
+      #
+      # For example, MemCacheStore's #write method supports the +:raw+
+      # option, which tells the memcached server to store all values as strings.
+      # We can use this option with #fetch too:
+      #
+      #   cache = ActiveSupport::Cache::MemCacheStore.new
+      #   cache.fetch("foo", :force => true, :raw => true) do
+      #     :bar
+      #   end
+      #   cache.fetch("foo")  # => "bar"
+      def fetch(name, options = nil, &block)
+        options = merged_options(options)
+        key = namespaced_key(name, options)
+        entry = instrument(:read, name, options) { read_entry(key, options) } unless options[:force]
+        if entry && entry.expired?
+          race_ttl = options[:race_condition_ttl].to_f
+          if race_ttl and Time.now.to_f - entry.expires_at <= race_ttl
+            entry.expires_at = Time.now + race_ttl
+            write_entry(key, entry, :expires_in => race_ttl * 2)
+          else
+            delete_entry(key, options)
+          end
+          entry = nil
+        end
+
+        if entry
+          entry.value
+        elsif block_given?
+          result = instrument(:generate, name, options, &block)
+          write(name, result, options)
+          result
+        end
+      end
+
+      # Fetches data from the cache, using the given key. If there is data in
+      # the cache with the given key, then that data is returned. Otherwise,
+      # nil is returned.
+      #
+      # Options are passed to the underlying cache implementation.
+      def read(name, options = nil)
+        options = merged_options(options)
+        key = namespaced_key(name, options)
+        instrument(:read, name, options) do
+          entry = read_entry(key, options)
+          if entry
+            if entry.expired?
+              delete_entry(key, options)
+              nil
+            else
+              entry.value
+            end
+          else
+            nil
+          end
+        end
+      end
+
+      # Read multiple values at once from the cache. Options can be passed
+      # in the last argument.
+      #
+      # Some cache implementation may optimize this method.
+      #
+      # Returns a hash mapping the names provided to the values found.
+      def read_multi(*names)
+        options = names.extract_options!
+        options = merged_options(options)
+        results = {}
+        names.each do |name|
+          key = namespaced_key(name, options)
+          entry = read_entry(key, options)
+          if entry
+            if entry.expired?
+              delete_entry(key)
+            else
+              results[name] = entry.value
+            end
+          end
+        end
+        results
+      end
+
+      # Writes the given value to the cache, with the given key.
+      #
+      # You may also specify additional options via the +options+ argument.
+      # The specific cache store implementation will decide what to do with
+      # +options+.
+      def write(name, value, options = nil)
+        options = merged_options(options)
+        instrument(:write, name, options) do
+          entry = Entry.new(value, options)
+          write_entry(namespaced_key(name, options), entry, options)
+        end
+      end
+
+      # Delete an entry in the cache. Returns +true+ if there was an entry to delete.
+      #
+      # Options are passed to the underlying cache implementation.
+      def delete(name, options = nil)
+        options = merged_options(options)
+        instrument(:delete, name) do
+          delete_entry(namespaced_key(name, options), options)
+        end
+      end
+
+      # Return true if the cache contains an entry with this name.
+      #
+      # Options are passed to the underlying cache implementation.
+      def exist?(name, options = nil)
+        options = merged_options(options)
+        instrument(:exist?, name) do
+          entry = read_entry(namespaced_key(name, options), options)
+          if entry && !entry.expired?
+            true
+          else
+            false
+          end
+        end
+      end
+
+      # Delete all entries whose keys match a pattern.
+      #
+      # Options are passed to the underlying cache implementation.
+      #
+      # Not all implementations may support +delete_matched+.
+      def delete_matched(matcher, options = nil)
+        raise NotImplementedError.new("#{self.class.name} does not support delete_matched")
+      end
+
+      # Increment an integer value in the cache.
+      #
+      # Options are passed to the underlying cache implementation.
+      #
+      # Not all implementations may support +delete_matched+.
+      def increment(name, amount = 1, options = nil)
+        raise NotImplementedError.new("#{self.class.name} does not support increment")
+      end
+
+      # Increment an integer value in the cache.
+      #
+      # Options are passed to the underlying cache implementation.
+      #
+      # Not all implementations may support +delete_matched+.
+      def decrement(name, amount = 1, options = nil)
+        raise NotImplementedError.new("#{self.class.name} does not support decrement")
+      end
+
+      # Cleanup the cache by removing expired entries. Not all cache implementations may
+      # support this method.
+      #
+      # Options are passed to the underlying cache implementation.
+      #
+      # Not all implementations may support +delete_matched+.
+      def cleanup(options = nil)
+        raise NotImplementedError.new("#{self.class.name} does not support cleanup")
+      end
+
+      # Clear the entire cache. Not all cache implementations may support this method.
+      # You should be careful with this method since it could affect other processes
+      # if you are using a shared cache.
+      #
+      # Options are passed to the underlying cache implementation.
+      #
+      # Not all implementations may support +delete_matched+.
+      def clear(options = nil)
+        raise NotImplementedError.new("#{self.class.name} does not support clear")
+      end
+
+      protected
+        # Add the namespace defined in the options to a pattern designed to match keys.
+        # Implementations that support delete_matched should call this method to translate
+        # a pattern that matches names into one that matches namespaced keys.
+        def key_matcher(pattern, options)
+          prefix = options[:namespace].is_a?(Proc) ? options[:namespace].call : options[:namespace]
+          if prefix
+            source = pattern.source
+            if source.start_with?('^')
+              source = source[1, source.length]
+            else
+              source = ".*#{source[0, source.length]}"
+            end
+            Regexp.new("^#{Regexp.escape(prefix)}:#{source}", pattern.options)
+          else
+            pattern
+          end
+        end
+
+        # Read an entry from the cache implementation. Subclasses must implement this method.
+        def read_entry(key, options) # :nodoc:
+          raise NotImplementedError.new
+        end
+
+        # Write an entry to the cache implementation. Subclasses must implement this method.
+        def write_entry(key, entry, options) # :nodoc:
+          raise NotImplementedError.new
+        end
+
+        # Delete an entry from the cache implementation. Subclasses must implement this method.
+        def delete_entry(key, options) # :nodoc:
+          raise NotImplementedError.new
+        end
+
+      private
+        # Merge the default options with ones specific to a method call.
+        def merged_options(call_options) # :nodoc:
+          if call_options
+            options.merge(call_options)
+          else
+            options.dup
+          end
+        end
+
+        # Expand a key to be a consistent string value. If the object responds to +cache_key+,
+        # it will be called. Otherwise, the to_param method will be called. If the key is a
+        # Hash, the keys will be sorted alphabetically.
+        def expanded_key(key) # :nodoc:
+          if key.respond_to?(:cache_key)
+            key = key.cache_key.to_s
+          elsif key.is_a?(Array)
+            if key.size > 1
+              key.collect{|element| expanded_key(element)}.to_param
+            else
+              key.first.to_param
+            end
+          elsif key.is_a?(Hash)
+            key = key.to_a.sort{|a,b| a.first.to_s <=> b.first.to_s}.collect{|k,v| "#{k}=#{v}"}.to_param
+          else
+            key = key.to_param
+          end
+        end
+
+        # Prefix a key with the namespace. The two values will be delimited with a colon.
+        def namespaced_key(key, options)
+          key = expanded_key(key)
+          namespace = options[:namespace] if options
+          prefix = namespace.is_a?(Proc) ? namespace.call : namespace
+          key = "#{prefix}:#{key}" if prefix
+          key
+        end
+
+        def instrument(operation, key, options = nil)
+          log(operation, key, options)
+
+          if self.class.instrument
+            payload = { :key => key }
+            payload.merge!(options) if options.is_a?(Hash)
+            ActiveSupport::Notifications.instrument("cache_#{operation}.active_support", payload){ yield }
+          else
+            yield
+          end
+        end
+
+        def log(operation, key, options = nil)
+          return unless logger && logger.debug? && !silence?
+          logger.debug("Cache #{operation}: #{key}#{options.blank? ? "" : " (#{options.inspect})"}")
+        end
+    end
+
+    # Entry that is put into caches. It supports expiration time on entries and can compress values
+    # to save space in the cache.
+    class Entry
+      attr_reader :created_at, :expires_in
+
+      DEFAULT_COMPRESS_LIMIT = 16.kilobytes
+
+      class << self
+        # Create an entry with internal attributes set. This method is intended to be
+        # used by implementations that store cache entries in a native format instead
+        # of as serialized Ruby objects.
+        def create (raw_value, created_at, options = {})
+          entry = new(nil)
+          entry.instance_variable_set(:@value, raw_value)
+          entry.instance_variable_set(:@created_at, created_at.to_f)
+          entry.instance_variable_set(:@compressed, !!options[:compressed])
+          entry.instance_variable_set(:@expires_in, options[:expires_in])
+          entry
+        end
+      end
+
+      # Create a new cache entry for the specified value. Options supported are
+      # +:compress+, +:compress_threshold+, and +:expires_in+.
+      def initialize(value, options = {})
+        @compressed = false
+        @expires_in = options[:expires_in]
+        @expires_in = @expires_in.to_f if @expires_in
+        @created_at = Time.now.to_f
+        if value
+          if should_compress?(value, options)
+            @value = Zlib::Deflate.deflate(Marshal.dump(value))
+            @compressed = true
+          else
+            @value = value
+          end
+        else
+          @value = nil
+        end
+      end
+
+      # Get the raw value. This value may be serialized and compressed.
+      def raw_value
+        @value
+      end
+
+      # Get the value stored in the cache.
+      def value
+        if @value
+          val = compressed? ? Marshal.load(Zlib::Inflate.inflate(@value)) : @value
+          unless val.frozen?
+            val.freeze rescue nil
+          end
+          val
+        end
+      end
+
+      def compressed?
+        @compressed
+      end
+
+      # Check if the entry is expired. The +expires_in+ parameter can override the
+      # value set when the entry was created.
+      def expired?
+        if @expires_in && @created_at + @expires_in <= Time.now.to_f
+          true
+        else
+          false
+        end
+      end
+
+      # Set a new time to live on the entry so it expires at the given time.
+      def expires_at=(time)
+        if time
+          @expires_in = time.to_f - @created_at
+        else
+          @expires_in = nil
+        end
+      end
+
+      # Seconds since the epoch when the cache entry will expire.
+      def expires_at
+        @expires_in ? @created_at + @expires_in : nil
+      end
+
+      # Get the size of the cached value. This could be less than value.size
+      # if the data is compressed.
+      def size
+        if @value.nil?
+          0
+        elsif @value.respond_to?(:bytesize)
+          @value.bytesize
+        else
+          Marshal.dump(@value).bytesize
+        end
+      end
+
+      private
+        def should_compress?(value, options)
+          if options[:compress] && value
+            unless value.is_a?(Numeric)
+              compress_threshold = options[:compress_threshold] || DEFAULT_COMPRESS_LIMIT
+              serialized_value = value.is_a?(String) ? value : Marshal.dump(value)
+              return true if serialized_value.size >= compress_threshold
+            end
+          end
+          false
+        end
+    end
+  end
+end