diskcached 1.0.1

data/Benchmark.md

@@ -0,0 +1,81 @@
+# Benchmarks
+
+## Comments
+
+Diskcached wasn't designed to be a faster solution, just a simpler
+one when compaired to Memcached. However, from these benchmarks,
+it holds up will and even should provide slightly faster reads.
+
+
+## Ruby 1.8.7
+ 
+**Warning:** Tests do not pass and therefore this isn't expected 
+to actaully work on ruby 1.8.7 at this point. I'm including the
+benchmarks for it as an academic excercise.
+
+## Ruby 1.8.7
+ 
+#### small string * 100000
+
+<pre>
+                  user     system      total        real
+  diskcached set  3.260000   5.630000   8.890000 ( 21.660488)
+  memcached  set  1.460000   1.280000   2.740000 (  4.070615)
+  diskcached get  1.800000   0.720000   2.520000 (  2.541142)
+  memcached  get  1.160000   1.410000   2.570000 (  3.609896)
+</pre> 
+ 
+#### large hash * 100000
+
+<pre>
+                 user     system      total        real
+  diskcached set 17.740000   8.140000  25.880000 ( 59.677151)
+  memcached  set 13.840000   1.960000  15.800000 ( 18.235553)
+  diskcached get 11.860000   1.100000  12.960000 ( 13.003900)
+  memcached  get  9.270000   1.880000  11.150000 ( 12.346795)
+</pre>
+
+## Ruby 1.9.2p318
+ 
+#### small string * 100000
+
+<pre>
+                  user     system      total        real
+  diskcached set  3.370000   4.980000   8.350000 ( 20.467971)
+  memcached  set  1.340000   1.300000   2.640000 (  3.962354)
+  diskcached get  1.570000   0.350000   1.920000 (  1.939561)
+  memcached  get  1.330000   1.250000   2.580000 (  3.604914)
+</pre>
+ 
+#### large hash * 100000
+
+<pre>
+                 user     system      total        real
+  diskcached set 21.460000   6.950000  28.410000 ( 58.982826)
+  memcached  set 16.510000   1.920000  18.430000 ( 20.862692)
+  diskcached get 16.570000   0.690000  17.260000 ( 17.306181)
+  memcached  get 12.120000   1.630000  13.750000 ( 14.967464)
+</pre>
+
+
+## Ruby 1.9.3p194
+ 
+#### small string * 100000
+
+<pre>
+                  user     system      total        real
+  diskcached set  3.520000   5.220000   8.740000 ( 21.928190)
+  memcached  set  1.350000   1.480000   2.830000 (  4.178223)
+  diskcached get  1.830000   0.370000   2.200000 (  2.215781)
+  memcached  get  1.570000   1.710000   3.280000 (  4.662109)
+</pre> 
+ 
+#### large hash * 100000
+
+<pre>
+                 user     system      total        real
+  diskcached set 20.670000   7.170000  27.840000 ( 59.877671)
+  memcached  set 15.310000   2.790000  18.100000 ( 21.132083)
+  diskcached get 14.950000   0.700000  15.650000 ( 15.720669)
+  memcached  get 14.850000   1.840000  16.690000 ( 17.971276)
+</pre>

data/Gemfile

@@ -0,0 +1,18 @@
+source :rubygems
+
+group :development, :test do
+  gem 'rake'
+end
+
+group :development do
+  gem 'rdoc'
+
+  # for benchmark only
+  gem 'memcached'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov', :require => false
+end
+

data/README.md

@@ -0,0 +1,17 @@
+# Diskcached
+
+#### Test Status [![Build Status](https://secure.travis-ci.org/jmervine/diskcached.png?branch=master)](http://travis-ci.org/jmervine/diskcached)
+
+#### Installation
+
+    gem install diskcached
+
+#### [Documentation](http://jmervine.github.com/diskcached/doc/index.html)
+
+#### [Coverage](http://jmervine.github.com/diskcached/coverage/index.html)
+
+#### History
+
+* 1.0.0 / 2012-07-03
+  * Pre-release version, widely untested outside of the actual tests.
+

data/Rakefile

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+
+task :benchmark do
+  load './spec/benchmarks.rb'
+end
+
+task :package do
+  puts %x{ gem build diskcached.gemspec && (mkdir ./pkg; mv *.gem ./pkg/ ) }
+end
+
+# vim: syntax=ruby

data/lib/diskcached.rb

@@ -0,0 +1,159 @@
+# @author Joshua P. Mervine <joshua@mervine.net>
+# 
+class Diskcached
+  # version for gem
+  VERSION = '1.0.1'
+
+  # disk location for cache store
+  attr_reader :store
+  
+  # cache timeout
+  attr_reader :timeout
+ 
+  # time of last #garbage_collect_expired_caches
+  attr_reader :last_gc
+
+  # initialize object
+  # - set #store to passed or default ('/tmp/cache')
+  # - set #timeout to passed or default ('600')
+  # - set #last_gc to current time
+  # - run #ensure_store_directory
+  def initialize store="/tmp/cache", timeout=600
+    @store   = store
+    @timeout = timeout
+    @last_gc = Time.now
+    ensure_store_directory
+  end
+
+  # return true if cache with 'key' is expired
+  def expired? key
+    mtime = read_cache_mtime(key)
+    return (mtime.nil? || mtime+timeout <= Time.now)
+  end
+
+  # expire cache with 'key'
+  def expire! key
+    File.delete( cache_file(key) ) if File.exists?( cache_file(key) )
+  end
+  alias :delete :expire!
+
+  # expire (delete) all caches in #store directory
+  def expire_all! 
+    Dir[ File.join( store, '*.cache' ) ].each do |file|
+      File.delete(file) 
+    end
+  end
+  alias :flush :expire_all!
+
+  # create and read cache with 'key'
+  # - run #garbage_collect_expired_caches 
+  # - creates cache if it doesn't exist
+  # - reads cache if it exists
+  def cache key
+    garbage_collect_expired_caches
+    begin
+      if expired?(key)
+        content = Proc.new { yield }.call
+        set( key, content )
+      end
+      content ||= get( key )
+      return content
+    rescue LocalJumpError
+      return nil
+    end
+  end
+  alias :set_or_get :cache
+  alias :sog :cache
+
+  # set cache with 'key'
+  # - run #garbage_collect_expired_caches 
+  # - creates cache if it doesn't exist
+  def set key, value
+    garbage_collect_expired_caches
+    begin
+      write_cache_file( key, Marshal::dump(value) )
+      return true
+    rescue
+      return false
+    end
+  end
+  alias :add :set
+  alias :replace :set
+
+  # get cache with 'key'
+  # - reads cache if it exists and isn't expired 
+  #   or raises Diskcache::NotFound
+  # - if 'key' is an Array returns only keys 
+  #   which exist and aren't expired, it raises
+  #   Diskcache::NotFound if none are available
+  def get key
+    garbage_collect_expired_caches
+    begin
+      if key.is_a? Array
+        hash = {}
+        key.each do |k|
+          hash[k] = Marshal::load(read_cache_file(k)) unless expired?(k)
+        end
+        return hash unless hash.empty?
+      else
+        return Marshal::load(read_cache_file(key)) unless expired?(key)
+      end
+      raise Diskcached::NotFound
+    rescue
+      raise Diskcached::NotFound
+    end
+  end
+
+  # returns path to cache file with 'key'
+  def cache_file key
+    File.join( store, key+".cache" )
+  end
+
+
+  private
+  # delete all expired caches every #timeout seconds
+  # on being called
+  def garbage_collect_expired_caches
+    if last_gc+timeout <= Time.now
+      Dir[ File.join( store, "*.cache" ) ].each do |f| 
+        if (File.mtime(f)+timeout) <= Time.now
+          File.delete(f) 
+        end
+      end
+    end
+  end
+
+  # creates the actual cache file
+  def write_cache_file key, content
+    f = File.open( cache_file(key), "w+" )
+    f.flock(File::LOCK_EX)
+    f.write( content )
+    f.close
+    return content
+  end
+
+  # reads the actual cache file
+  def read_cache_file key
+    f = File.open( cache_file(key), "r" )
+    f.flock(File::LOCK_SH)
+    out = f.read 
+    f.close
+    return out
+  end
+
+  # returns mtime of cache file or nil if 
+  # file doesn't exist
+  def read_cache_mtime key
+    return nil unless File.exists?(cache_file(key))
+    File.mtime( cache_file(key) )
+  end
+
+  # creates #store directory if it doesn't exist
+  def ensure_store_directory
+    Dir.mkdir( store ) unless File.directory?( store )
+  end
+
+  class NotFound < Exception
+  end
+
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: diskcached
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joshua Mervine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple disk cache for things like Sinatra which is implemented much like
+  Memcached in hopes that in some cases they're interchangeable.
+email:
+- joshua@mervine.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/diskcached.rb
+- README.md
+- Benchmark.md
+- Gemfile
+- Rakefile
+homepage: http://jmervine.github.com/diskcached/
+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'
+      segments:
+      - 0
+      hash: -4576607150070484010
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple disk cache
+test_files: []