Sha256: d3a25ba0bbe43025009d3faac9d6260a03fb507f13e54c7db91d575c7032a012

Contents?: true

Size: 1.82 KB

Versions: 9

Compression:

Stored size: 1.82 KB

Contents

# encoding: utf-8
#
# This file is part of the elephas gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
# 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 = {})
        entry = ::Elephas::Entry.ensure(value, key, options)
        entry.refresh
        Rails.cache.write(key, entry, expires_in: entry.ttl)
        entry
      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)
        key = key.ensure_string
        rv = Rails.cache.exist?(key)
        Rails.cache.delete(key)
        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)
        key = key.ensure_string
        Rails.cache.exist?(key) && Rails.cache.read(key).valid?
      end
    end
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
elephas-2.2.0 lib/elephas/providers/ruby_on_rails.rb
elephas-2.1.3 lib/elephas/providers/ruby_on_rails.rb
elephas-2.1.2 lib/elephas/providers/ruby_on_rails.rb
elephas-2.1.1 lib/elephas/providers/ruby_on_rails.rb
elephas-2.1.0 lib/elephas/providers/ruby_on_rails.rb
elephas-2.0.3 lib/elephas/providers/ruby_on_rails.rb
elephas-2.0.2 lib/elephas/providers/ruby_on_rails.rb
elephas-2.0.1 lib/elephas/providers/ruby_on_rails.rb
elephas-2.0.0 lib/elephas/providers/ruby_on_rails.rb