volatile_hash 0.0.1 → 0.0.2

data/.rvmrc

@@ -1,2 +1,2 @@
-rvm use ruby-1.9.2-p180@colorize --create
+rvm use ruby-1.9.2-p180@volatile_hash --create
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    volatile_hash (0.0.0)
+    volatile_hash (0.0.1)
 
 GEM
   remote: http://rubygems.org/

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2012 Satya P
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README

@@ -1,8 +1,35 @@
 Implements a Time-to-live based cache and a Least-recently-used cache.
 
+= Usage
+
+cache = VolatileHash.new(:strategy => 'ttl', :ttl => 3600)
+#  TTL-based, default TTL is 3600 seconds. The value will be cached no longer
+#  than 3600 seconds after it is inserted into the cache.
+
+cache = VolatileHash.new(:strategy => 'ttl', :ttl => 3600, :refresh => true)
+#  TTL-based, default TTL is 3600 seconds. The value will be cached no longer
+#  than 3600 seconds after it is inserted or accessed.
+
+cache = VolatileHash.new(:strategy => 'lru', :max => 10)
+#  LRU-based, default max is 10. That's the maximum keys to remember.
+
+cache[:key] = "some expensive-to-calculate value, like a database query result"
+cache["any key"] = "or a remote api call"
+
+#  memo-ization:
+def get_value_for(key)
+    @cache ||= VolatileHash.new(:strategy => 'ttl', :ttl => 3600)
+    @cache[key] ||= get_from_api(key)
+end
 
 = Test/Development
 
 gem install bundler
 bundle install
 rake
+
+= Credits
+
+Based on a gist by github.com user joshaven at https://gist.github.com/184837
+
+Some input from github user supertaz, considerable help on the TTL-based version.

data/lib/volatile_hash.rb

@@ -9,6 +9,7 @@ class VolatileHash
             @max_items = options[:max] || 10
             @item_order = []
         end
+        @refresh = options[:refresh] or false
     end
 
     def [](key)
@@ -19,6 +20,9 @@ class VolatileHash
                 @registry.delete key
                 value = nil
             end
+            if @refresh and @registry[key]
+                set_ttl(key)
+            end
         else
             lru_update key if @cache.has_key?(key)
         end
@@ -27,7 +31,7 @@ class VolatileHash
 
     def []=(key, value)
         if @strategy == 'ttl'
-            @registry[key] = Time.now + @ttl.to_f
+            set_ttl(key)
             @cache[key] = value
         else
             @item_order.unshift key
@@ -37,6 +41,10 @@ class VolatileHash
     end
 
     private
+    def set_ttl(key)
+        @registry[key] = Time.now + @ttl.to_f
+    end
+
     def expired?(key)
         Time.now > @registry[key]
     end

data/spec/volatile_hash_spec.rb

@@ -1,9 +1,13 @@
 require 'spec_helper'
 
 describe VolatileHash do
+    class Volatilehash
+        attr_reader :cache
+    end
+
     describe "TTL mode" do
         before do
-            @cache = VolatileHash.new(:strategy => 'ttl', :ttl => 0.5, :max => 1)
+            @cache = VolatileHash.new(:strategy => 'ttl', :ttl => 0.7, :max => 1)
             @x = Object.new
             @cache[:x] = @x.to_s
         end
@@ -20,17 +24,36 @@ describe VolatileHash do
         it "should forget cached values after the TTL expires" do
             @cache[:x].should == @x.to_s
 
-            sleep(0.6)
+            sleep(0.8)
 
             @cache[:x].should be_nil
         end
 
         it "should not throw out least-recently used value" do
-            @cache[:y] =1
+            @cache[:y] = 1
 
             @cache[:x].should_not be_nil
             @cache[:y].should_not be_nil
         end
+        
+        it "should not reset TTL when an item is accessed" do
+            sleep(0.4)
+            @cache[:x].should == @x.to_s
+            sleep(0.4)
+            @cache[:x].should be_nil
+        end
+
+        context "when asked to refresh TTL on access" do
+            it "should not forget cached values after TTL expires" do
+                cache = VolatileHash.new(:strategy => 'ttl', :ttl => 0.7, :refresh => true)
+                x = Object.new
+                cache[:x] = @x.to_s
+                sleep(0.4)
+                cache[:x].should == @x.to_s
+                sleep(0.4)
+                cache[:x].should == @x.to_s
+            end
+        end
     end
 
     describe "LRU mode" do

data/volatile_hash.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
     s.name        = 'volatile_hash'
-    s.version     = '0.0.1'
+    s.version     = '0.0.2'
     s.date        = '2012-02-22'
     s.summary     = "Implements LRU and TTL caches"
     s.description = "Implements key-based cache that can have a least-recently-used or time-to-live expiration strategy"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: volatile_hash
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-22 00:00:00.000000000Z
+date: 2012-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &74297420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *74297420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &74297180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: 1.0.4
   type: :development
   prerelease: false
-  version_requirements: *74297180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &74296950 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +53,12 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *74296950
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 description: Implements key-based cache that can have a least-recently-used or time-to-live
   expiration strategy
 email: github@thesatya.com
@@ -54,6 +69,7 @@ files:
 - .rvmrc
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README
 - Rakefile
 - lib/volatile_hash.rb
@@ -80,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Implements LRU and TTL caches