Keyed

Everything-agnostic, pluggable-backend, threadsafe, lightweight Ruby cache interface library

Usage

  cache = 
    Keyed::MemoryStore.new, 
  # Keyed::FileStore.new(:cache_dir => "/tmp/my_cache")
  # Keyed::MemcachedStore.new(:host => "127.0.0.1:11211")
  => #<Keyed::MemoryStore:0x8bd44 @hash={} @mutex=#<Mutex:0x87708>>

  cache.get("foo")         
  => nil

  cache.set("foo", "foo-cached")
  => "bar" 

  cache.get("foo")
  => "foo-cached" 

  cache.fetch("bar") { puts "caching"; "bar-cached"}
  caching
  => "bar-cached" 

  cache.fetch("bar") { puts "caching"; "bar-cached" }
  => "bar-cached" 

  cache.expire("bar")
  cache.get("bar")
  => nil

  cache.expire_all
  cache.get("foo")
  => nil

The initializers for the cache store classes are documented in their respective class files.

The instance methods to manipulate the resulting classes are all documented in abstract_store.rb.

Threadsaftey

Multiple threads can share a single keyed cache instance. Each stores use different mechanism to handle concurrency: the MemoryStore uses a mutex, the FileStore uses file locks, and the MemcachedStore uses a shared pool of single-threaded Memcached instances.

Dependencies

Keyed::MemcachedStore requires the memcached gem and connection_pool library, the other stores have no dependencies.