diskcached 1.0.1 → 1.1.0

data/Benchmark.md

@@ -12,8 +12,6 @@ it holds up will and even should provide slightly faster reads.
 **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
 

data/Gemfile

@@ -6,8 +6,11 @@ end
 
 group :development do
   gem 'rdoc'
+end
 
+group :benchmark do
   # for benchmark only
+  # requires sudo apt-get install libsasl2-dev
   gem 'memcached'
 end
 
@@ -16,3 +19,4 @@ group :test do
   gem 'simplecov', :require => false
 end
 
+

data/HISTORY.md

@@ -0,0 +1,11 @@
+### 1.1.0
+
+* refactored garbage collection
+  * fixed bug where auto gc happens every time once initial timeout duration has past
+  * allow for turning auto gc on and off
+  * cap auto gc timeout at 600 seconds
+  * other optimizations
+* removed 'expire!' for 'delete'
+* removed 'expire_all!' for 'flush'
+* removed 'set_or_get' and 'sog' aliases
+

data/README.md

@@ -1,17 +1,3 @@
 # 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.
-
+See: http://rubyops.net/2012/07/06/diskcached_simple_disk_cacheing_for_ruby

data/lib/diskcached.rb

@@ -1,8 +1,7 @@
 # @author Joshua P. Mervine <joshua@mervine.net>
-# 
 class Diskcached
   # version for gem
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 
   # disk location for cache store
   attr_reader :store
@@ -10,47 +9,76 @@ class Diskcached
   # cache timeout
   attr_reader :timeout
  
-  # time of last #garbage_collect_expired_caches
-  attr_reader :last_gc
+  # time of last #garbage_collect
+  attr_reader :gc_last
+
+  # should auto_garbage_collect
+  attr_reader :gc_auto
+
+  # how often to auto_garbage_collect
+  attr_reader :gc_time
 
   # initialize object
   # - set #store to passed or default ('/tmp/cache')
   # - set #timeout to passed or default ('600')
-  # - set #last_gc to current time
+  # - set #gc_last to current time
   # - run #ensure_store_directory
-  def initialize store="/tmp/cache", timeout=600
+  def initialize store="/tmp/cache", timeout=600, autogc=true
     @store   = store
     @timeout = timeout
-    @last_gc = Time.now
+    if timeout.nil?
+      @gc_last, @gc_time = nil
+      @gc_auto = false
+    else
+      @gc_last = Time.now
+      @gc_auto = autogc
+      @gc_time = (timeout < 600 ? timeout : 600)
+    end
     ensure_store_directory
   end
 
   # return true if cache with 'key' is expired
   def expired? key
+    return false if timeout.nil?
     mtime = read_cache_mtime(key)
     return (mtime.nil? || mtime+timeout <= Time.now)
   end
 
   # expire cache with 'key'
-  def expire! key
+  def delete 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! 
+  def flush
     Dir[ File.join( store, '*.cache' ) ].each do |file|
       File.delete(file) 
     end
   end
-  alias :flush :expire_all!
+
+  # flush expired caches if garbage collection
+  # hasn't been run recently
+  def flush_expired 
+    if gc_last && gc_time && gc_last+gc_time <= Time.now 
+      flush_expired!
+    end
+  end
+
+  # flash expired caches, ingoring when garbage
+  # collection was last run
+  def flush_expired!
+    Dir[ File.join( store, "*.cache" ) ].each do |f| 
+      if (File.mtime(f)+timeout) <= Time.now
+        File.delete(f) 
+      end
+    end
+    @gc_last = Time.now
+  end
 
   # 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
@@ -62,23 +90,22 @@ class Diskcached
       return nil
     end
   end
-  alias :set_or_get :cache
-  alias :sog :cache
 
   # set cache with 'key'
-  # - run #garbage_collect_expired_caches 
+  # - run #auto_garbage_collect
   # - creates cache if it doesn't exist
   def set key, value
-    garbage_collect_expired_caches
     begin
       write_cache_file( key, Marshal::dump(value) )
+      flush_expired if gc_auto
       return true
     rescue
+      flush_expired if gc_auto
       return false
     end
   end
-  alias :add :set
-  alias :replace :set
+  alias :add :set        # for memcached compatability
+  alias :replace :set    # for memcached compatability
 
   # get cache with 'key'
   # - reads cache if it exists and isn't expired 
@@ -87,15 +114,16 @@ class Diskcached
   #   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
+        flush_expired if gc_auto
         return hash unless hash.empty?
       else
+        flush_expired if gc_auto
         return Marshal::load(read_cache_file(key)) unless expired?(key)
       end
       raise Diskcached::NotFound
@@ -109,20 +137,7 @@ class Diskcached
     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+" )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diskcached
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-06 00:00:00.000000000 Z
+date: 2012-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -69,10 +69,11 @@ extra_rdoc_files: []
 files:
 - lib/diskcached.rb
 - README.md
+- HISTORY.md
 - Benchmark.md
 - Gemfile
 - Rakefile
-homepage: http://jmervine.github.com/diskcached/
+homepage: http://diskcached.rubyops.net/
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -84,9 +85,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4576607150070484010
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: