volatile_hash 0.0.1

data/.rvmrc

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    volatile_hash (0.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rr (1.0.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 0.9.2)
+  rr (~> 1.0.4)
+  rspec (~> 2.8.0)
+  volatile_hash!

data/README

@@ -0,0 +1,8 @@
+Implements a Time-to-live based cache and a Least-recently-used cache.
+
+
+= Test/Development
+
+gem install bundler
+bundle install
+rake

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+task :default => :spec
+
+RSpec::Core::RakeTask.new do |t|
+    # t.pattern = 'spec/**/*_spec.rb'
+end
+

data/lib/volatile_hash.rb

@@ -0,0 +1,54 @@
+class VolatileHash
+    def initialize(options)
+        @strategy = options[:strategy] || 'ttl'
+        @cache = {}
+        if @strategy == 'ttl'
+            @registry = {}
+            @ttl = options[:ttl] || 3600
+        else #lru
+            @max_items = options[:max] || 10
+            @item_order = []
+        end
+    end
+
+    def [](key)
+        value = @cache[key]
+        if @strategy == 'ttl'
+            if expired?(key)
+                @cache.delete key
+                @registry.delete key
+                value = nil
+            end
+        else
+            lru_update key if @cache.has_key?(key)
+        end
+        value #in case of LRU, just return the value that was read
+    end
+
+    def []=(key, value)
+        if @strategy == 'ttl'
+            @registry[key] = Time.now + @ttl.to_f
+            @cache[key] = value
+        else
+            @item_order.unshift key
+            @cache[key] = value
+            lru_invalidate if @max_items < @item_order.length
+        end
+    end
+
+    private
+    def expired?(key)
+        Time.now > @registry[key]
+    end
+
+    def lru_invalidate
+        while @max_items < @item_order.length
+            @cache.delete @item_order.pop
+        end
+    end
+
+    def lru_update(key)
+        @item_order.delete key
+        @item_order.unshift key
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'volatile_hash'
+
+RSpec.configure do |config|
+      # some (optional) config here
+      config.mock_with :rr
+end
+

data/spec/volatile_hash_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe VolatileHash do
+    describe "TTL mode" do
+        before do
+            @cache = VolatileHash.new(:strategy => 'ttl', :ttl => 0.5, :max => 1)
+            @x = Object.new
+            @cache[:x] = @x.to_s
+        end
+
+        it "should remember cached values" do
+            @cache[:x].should == @x.to_s
+        end
+        
+        it "should not have to re-calculate cached values" do
+            dont_allow(@x).to_s
+            @cache[:x] ||= @x.to_s
+        end
+
+        it "should forget cached values after the TTL expires" do
+            @cache[:x].should == @x.to_s
+
+            sleep(0.6)
+
+            @cache[:x].should be_nil
+        end
+
+        it "should not throw out least-recently used value" do
+            @cache[:y] =1
+
+            @cache[:x].should_not be_nil
+            @cache[:y].should_not be_nil
+        end
+    end
+
+    describe "LRU mode" do
+        before do
+            @cache = VolatileHash.new(:strategy => 'lru', :max => 3, :ttl => 0.1)
+            @x = Object.new
+            @y = Object.new
+            @z = Object.new
+            @cache[:x] = @x.to_s
+        end
+
+        it "should remember cached values" do
+            @cache[:x].should == @x.to_s
+        end
+
+        it "should not have to re-calculate cached values" do
+            dont_allow(@x).to_s
+            @cache[:x] ||= @x.to_s
+        end
+
+        it "should have only up to the last max values" do
+            @cache[:x].should == @x.to_s
+            @cache[:y].should be_nil
+            @cache[:z].should be_nil
+            @cache[:w].should be_nil
+
+            @cache[:y] = @y.to_s
+            @cache[:z] = @z.to_s
+            @cache[:w] = @z.to_s
+
+            @cache[:x].should be_nil
+            @cache[:y].should == @y.to_s
+            @cache[:z].should == @z.to_s
+            @cache[:w].should == @z.to_s
+        end
+
+        it "should throw out the least recently accessed value" do
+            @cache[:y] = @y.to_s
+            @cache[:z] = @z.to_s
+            @cache[:y].should == @y.to_s
+            @cache[:x].should == @x.to_s
+            @cache[:z].should == @z.to_s
+
+            @cache[:w] = @x.to_s
+
+            @cache[:x].should == @x.to_s
+            @cache[:y].should be_nil
+            @cache[:z].should == @z.to_s
+            @cache[:w].should == @x.to_s
+        end
+
+        it "should not expire by ttl" do
+            sleep(0.3)
+            @cache[:x].should_not be_nil
+        end
+
+    end
+end
+

data/volatile_hash.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+    s.name        = 'volatile_hash'
+    s.version     = '0.0.1'
+    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"
+    s.authors     = ["Satya P"]
+    s.email       = 'github@thesatya.com'
+    s.files         = `git ls-files`.split("\n")
+    s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+    s.require_paths = ["lib"]
+
+    s.homepage    = 'http://github.com/satyap/volatile_hash'
+
+    s.add_development_dependency 'rspec', '~> 2.8.0'
+    s.add_development_dependency 'rr', '~> 1.0.4'
+    s.add_development_dependency 'rake', '~> 0.9.2'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: volatile_hash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Satya P
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &74297420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *74297420
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &74297180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :development
+  prerelease: false
+  version_requirements: *74297180
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &74296950 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *74296950
+description: Implements key-based cache that can have a least-recently-used or time-to-live
+  expiration strategy
+email: github@thesatya.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- lib/volatile_hash.rb
+- spec/spec_helper.rb
+- spec/volatile_hash_spec.rb
+- volatile_hash.gemspec
+homepage: http://github.com/satyap/volatile_hash
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Implements LRU and TTL caches
+test_files: []