Contents

# encoding: utf-8
#
# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <[e-mail]>.
# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
#

module Elephas
  module Providers
    # This is a Ruby on Rails providers, which uses Rails.cache.
    class RubyOnRails
      include Elephas::Providers::Base

      # Reads a value from the cache.
      #
      # @param key [String] The key to lookup.
      # @return [Entry|NilClass] The read value or `nil`.
      def read(key)
        self.exists?(key) ? Rails.cache.read(key) : nil
      end

      # Writes a value to the cache.
      #
      # @param key [String] The key to associate the value with.
      # @param value [Object] The value to write. **Setting a value to `nil` **doesn't** mean *deleting* the value.
      # @param options [Hash] A list of options for writing.
      # @see Elephas::Cache.setup_options
      # @return [Object] The value itself.
      def write(key, value, options = {})
        fvalue = ::Elephas::Entry.ensure(value, key, options)
        fvalue.refresh

        Rails.cache.write(key, value, :expires_in => fvalue.ttl)
        value
      end

      # Deletes a value from the cache.
      #
      # @param key [String] The key to delete.
      # @return [Boolean] `true` if the key was in the cache, `false` otherwise.
      def delete(key)
        fkey = key.ensure_string
        rv = Rails.cache.exist?(fkey)
        Rails.cache.delete(fkey)
        rv
      end

      # Checks if a key exists in the cache.
      #
      # @param key [String] The key to lookup.
      # @return [Boolean] `true` if the key is in the cache, `false` otherwise.
      def exists?(key)
        fkey = key.ensure_string
        Rails.cache.exist?(fkey) && Rails.cache.read(fkey).valid?
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
elephas-1.1.3	lib/elephas/providers/ruby_on_rails.rb
elephas-1.1.2	lib/elephas/providers/ruby_on_rails.rb
elephas-1.1.1	lib/elephas/providers/ruby_on_rails.rb
elephas-1.1.0	lib/elephas/providers/ruby_on_rails.rb
elephas-1.0.0	lib/elephas/providers/ruby_on_rails.rb