cacher 0.0.1

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'minitest'
+gem 'wrong'
+gem 'rake'

data/cacher.gemspec

@@ -0,0 +1,15 @@
+require './lib/cacher/version'
+
+Gem::Specification.new do |s|
+  s.name = "cacher"
+  s.version = Cacher.version
+  s.authors = ["Jay Adkisson"]
+  s.email = ["jay@goodguide.com"]
+  s.summary = "All your cache are belong to us"
+  s.description = "A nifty configurable frontend to any cache"
+  s.homepage = "http://github.com/jayferd/cacher"
+  s.rubyforge_project = "cacher"
+  s.files = Dir['Gemfile', 'cacher.gemspec', 'lib/**/*.rb']
+
+  # no dependencies
+end

data/lib/cacher.rb

@@ -0,0 +1,158 @@
+require 'digest/sha1'
+
+require File.expand_path('cacher/version', File.dirname(__FILE__))
+
+module Cacher
+  extend self
+
+  class Base
+    include Cacher
+  end
+
+  #### configuration methods ####
+  attr_reader :options
+  def initialize(opts={})
+    opts.each do |k, v|
+      send(:"#{k}=", v)
+    end
+  end
+
+  attr_writer :cache
+  def cache
+    @cache ||= Rails.cache
+  end
+
+  attr_accessor :namespace
+  def namespaced?
+    !!namespace
+  end
+
+  attr_writer :max_key_size
+  def max_key_size
+    @max_key_size ||= 100
+  end
+
+  attr_writer :marshal
+  def marshal?
+    return @marshal if instance_variable_defined? :@marshal
+
+    # default to false because Rails.cache handles marshalling for us
+    @marshal = false
+  end
+
+  def enabled?
+    return @enabled if instance_variable_defined? :@enabled
+    @enabled = false
+  end
+
+  def enable!
+    @enabled = true
+  end
+
+  def disable!
+    @enabled = false
+  end
+
+  #### core api ####
+  def key?(key)
+    return false unless enabled?
+
+    !!cache_get(key)
+  end
+
+  def get(key, options={}, &blk)
+    return set(key, options, &blk) if options.delete(:break)
+
+    cached = cache_get(key)
+
+    if cached.nil?
+      return blk && set(key, options, &blk)
+    end
+
+    unmarshal_value(cached)
+  end
+
+  def set(key, options={}, &blk)
+    val = do_block(&blk)
+    cache_set(key, marshal_value(val))
+    val
+  end
+
+private
+  def decorate_key(key)
+    if namespaced?
+      key = "#{namespace}/#{key}"
+    end
+
+    key += "/marshal" if marshal?
+
+    key
+  end
+
+  def prepare_key(key)
+    decorated = decorate_key(key)
+
+    if decorated.size > max_key_size
+      decorated = decorate_key("sha1/#{Digest::SHA1.hexdigest(key)}")
+    end
+
+    decorated
+  end
+
+  def cache_get(key)
+    return nil unless enabled?
+
+    key = prepare_key(key)
+
+    if cache.respond_to? :get
+      cache.get(key)
+    else
+      cache.read(key)
+    end
+  end
+
+  def cache_set(key, val)
+    return val unless enabled?
+
+    key = prepare_key(key)
+
+    if cache.respond_to? :set
+      cache.set(key, val)
+    else
+      cache.write(key, val)
+    end
+
+    val
+  end
+
+  def do_block(&block)
+    return nil unless block_given?
+
+    if block.arity > 0
+      response = {}
+      block.call(response)
+      response
+    else
+      block.call
+    end
+  end
+
+  CACHER_NIL = 'cacher/nil'
+  def marshal_value(val)
+    if marshal?
+      Marshal.dump(val)
+    else
+      return CACHER_NIL if val.nil?
+      val
+    end
+  end
+
+  def unmarshal_value(val)
+    if marshal?
+      Marshal.load(val)
+    else
+      return nil if val == CACHER_NIL
+      val
+    end
+  end
+end

data/lib/cacher/version.rb

@@ -0,0 +1,5 @@
+module Cacher
+  def self.version
+    '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: cacher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jay Adkisson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-26 00:00:00.000000000Z
+dependencies: []
+description: A nifty configurable frontend to any cache
+email:
+- jay@goodguide.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- cacher.gemspec
+- lib/cacher/version.rb
+- lib/cacher.rb
+homepage: http://github.com/jayferd/cacher
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: cacher
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: All your cache are belong to us
+test_files: []