lrucache 0.1.3 → 0.1.4

data/.gitignore

@@ -2,4 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
-coverage/*
+coverage/*
+tmp/*

data/.rvmrc

@@ -1 +1 @@
-rvm use ruby-1.9.2@lrucache --create
+rvm use ruby-1.9.3@lrucache --create

data/README.md

@@ -34,7 +34,7 @@ TTL (time-to-live)
     # Three hours later ...
     cache.fetch("banana") # nil
     cache.fetch("monkey") # "banana"
-    
+
     # Three days later ...
     cache.fetch("banana") # nil
     cache.fetch("monkey") # nil
@@ -64,6 +64,19 @@ expires and the block is called for a new value, but exceptions are not handled.
     cache.fetch("banana") { "george" } # "george"
     cache.fetch("banana") { "barney" } # "george"
 
+Eviction Handler
+================
+Allows you to specify a block that gets called whenever a value gets evicted
+from the cache because it is the least recently used.
+
+    cache = LRUCache.new(:max_size => 2,
+                         :eviction_handler => lambda { |value| value.shave! })
+    cache.store(:yak) { yak }
+    cache.store(:dog) { dog }
+    cache.store(:cat) { cat } # --> shaves the yak as you would expect!
+    cache.delete(:cat)        # --> does not shave the cat
+    cache.clear               # --> no shaving involved
+
 ## Contributing
 
 1. Fork it

data/lib/lrucache.rb

@@ -9,6 +9,7 @@ class LRUCache
   def initialize(opts={})
     @max_size = Integer(opts[:max_size] || 100)
     @default = opts[:default]
+    @eviction_handler = opts[:eviction_handler]
     @ttl = Float(opts[:ttl] || 0)
     @soft_ttl = Float(opts[:soft_ttl] || 0)
     @retry_delay = Float(opts[:retry_delay] || 0)
@@ -103,7 +104,8 @@ class LRUCache
 
   def delete(key)
     @pqueue.delete(key)
-    @data.delete(key)
+    datum = @data.delete(key)
+    datum.value unless datum.nil?
   end
 
   private
@@ -150,7 +152,10 @@ class LRUCache
 
   def evict_lru!
     key, priority = @pqueue.delete_min
-    @data.delete(key) unless priority.nil?
+    unless priority.nil?
+      datum = @data.delete(key)
+      @eviction_handler.call(datum.value) if @eviction_handler && datum
+    end
   end
 
   def access(key)

data/lib/lrucache/version.rb

@@ -1,3 +1,3 @@
 class LRUCache
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lrucache.gemspec

@@ -19,12 +19,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.add_dependency "PriorityQueue", '~> 0.1.2'
-  
-  s.add_development_dependency "rspec", "~> 2.6.0"
-  s.add_development_dependency "simplecov", "~> 0.4.2"
-  s.add_development_dependency("rb-fsevent", "~> 0.4.3") if RUBY_PLATFORM =~ /darwin/i
-  s.add_development_dependency "guard", "~> 0.6.2"
-  s.add_development_dependency "guard-bundler", "~> 0.1.3"
-  s.add_development_dependency "guard-rspec", "~> 0.4.2"
-  s.add_development_dependency "timecop", "~> 0.3.5"
+
+  s.add_development_dependency "rspec", "~> 2.12.0"
+  s.add_development_dependency "simplecov", "~> 0.7.1"
+  s.add_development_dependency("rb-fsevent", "~> 0.9.2") if RUBY_PLATFORM =~ /darwin/i
+  s.add_development_dependency "guard", "~> 1.5.4"
+  s.add_development_dependency "guard-bundler", "~> 1.0.0"
+  s.add_development_dependency "guard-rspec", "~> 2.2.1"
+  s.add_development_dependency "timecop", "~> 0.5.3"
 end

data/spec/lrucache_spec.rb

@@ -54,6 +54,12 @@ describe LRUCache do
       c.instance_variable_get(:@data).should be_empty
       c.instance_variable_get(:@pqueue).should be_empty
     end
+
+    it "should not call the eviction handler" do
+      c = LRUCache.new(:eviction_handler => lambda { raise 'test failed' })
+      c[:a] = 'a'
+      expect { c.clear }.to_not raise_exception
+    end
   end
 
   describe ".include?(key)" do
@@ -156,9 +162,11 @@ describe LRUCache do
       end
       context "when the cache is full" do
         before(:each) do
-          @cache = LRUCache.new(:max_size => 2)
-          @cache[:b] = 'b'
-          @cache[:c] = 'c'
+          @cache = LRUCache.new(
+            :max_size => 2,
+            :eviction_handler => lambda {|value| value << ' evicted' })
+          @cache[:b] = @b = 'b'
+          @cache[:c] = @c = 'c'
           @lru = :b
         end
         context "and the key is not present" do
@@ -175,6 +183,10 @@ describe LRUCache do
             @cache.should_receive(:access).with(:a)
             @cache.store(:a, 'a')
           end
+          it "should call the eviction handler" do
+            @cache.store(:a, 'a')
+            @b.should == 'b evicted'
+          end
         end
         context "and the key is present" do
           it "should not evict an entry" do
@@ -208,7 +220,7 @@ describe LRUCache do
         Timecop.freeze(now) { c.store(:a,'a') }
         stored = c.instance_variable_get(:@data)[:a]
         stored.value.should == 'a'
-        stored.expiration.should == now + 1
+        stored.expiration.to_f.should == (now + 1).to_f
       end
     end
     context "when ttl is a Time" do
@@ -228,7 +240,7 @@ describe LRUCache do
         Timecop.freeze(now) { c.store(:a, 'a', "98.6") }
         stored = c.instance_variable_get(:@data)[:a]
         stored.value.should == 'a'
-        stored.expiration.should == now + 98.6
+        stored.expiration.to_f.should == (now + 98.6).to_f
       end
     end
     context "when ttl cannot be parsed as a float" do
@@ -464,6 +476,20 @@ describe LRUCache do
       c.instance_variable_get(:@data).should_not include(:a)
       c.instance_variable_get(:@pqueue).should_not include([:a,1])
     end
+
+    it "should return the value associated with the key" do
+      c = LRUCache.new
+      c[:a] = 'a'
+      c.delete(:a).should == 'a'
+      c.delete(:a).should be_nil
+      c.delete(:b).should be_nil
+    end
+
+    it "should not call the eviction handler" do
+      c = LRUCache.new(:eviction_handler => lambda { raise 'test failed' })
+      c[:a] = 'a'
+      expect { c.delete(:a) }.to_not raise_exception
+    end
   end
 
   describe ".evict_lru!" do
@@ -509,4 +535,4 @@ describe LRUCache do
       end
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lrucache
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-11 00:00:00.000000000Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: PriorityQueue
-  requirement: &70313120984040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,84 +21,124 @@ dependencies:
         version: 0.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70313120984040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70313120983540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *70313120983540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70313120983080 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.7.1
   type: :development
   prerelease: false
-  version_requirements: *70313120983080
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70313120982580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70313120982580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70313120982120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 1.5.4
   type: :development
   prerelease: false
-  version_requirements: *70313120982120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.4
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: &70313120981660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70313120981660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70313120981200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 2.2.1
   type: :development
   prerelease: false
-  version_requirements: *70313120981200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70313120980740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: 0.5.3
   type: :development
   prerelease: false
-  version_requirements: *70313120980740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.3
 description: A simple LRU-cache based on a hash and priority queue
 email:
 - chris@kindkid.com
@@ -139,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: lrucache
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A simple LRU-cache based on a hash and priority queue