rufus-lru 1.0.4 → 1.0.5

data/CHANGELOG.txt

@@ -2,7 +2,12 @@
 = rufus-lru CHANGELOG.txt
 
 
-== rufus-lru - 1.0.4    not yet released
+== rufus-lru - 1.0.5    released 2012/02/28
+
+- introduced Rufus::Lru::SynchronizedHash (thread-safe)
+
+
+== rufus-lru - 1.0.4    released 2012/02/28
 
 - fixed issue issue false values
 - 2012 refresh

data/README.md

@@ -17,7 +17,7 @@ Once the maxsize is reached, the hash will discard the element that was the
 least recently used (hence LRU).
 
     require 'rubygems'
-    require 'rufus/lru'
+    require 'rufus-lru'
 
     h = Rufus::Lru::Hash.new(3)
 
@@ -29,6 +29,15 @@ least recently used (hence LRU).
 
     puts h.inspect # >> {:newer=>"b", 3=>"aaa", 4=>"aaaa"}
 
+Rufus::Lru::Hash isn't thread-safe, if you need something that is, use Rufus::Lru::SynchronizedHash
+
+    require 'rubygems'
+    require 'rufus-lru'
+
+    h = Rufus::Lru::SyncrhonizedHash.new(3)
+
+    # ...
+
 
 ## dependencies
 

data/lib/rufus/lru.rb

@@ -22,11 +22,13 @@
 # "made in Japan"
 #++
 
+require 'thread'
+
 
 module Rufus
 module Lru
 
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 
   #
   # A Hash that has a max size. After the maxsize has been reached, the
@@ -46,7 +48,8 @@ module Lru
   #
   #   puts h.inspect # >> {:newer=>"b", 3=>"aaa", 4=>"aaaa"}
   #
-  # Nota bene: this class is not threadsafe.
+  # Nota bene: this class is not thread-safe. If you need something thread-safe,
+  # use Rufus::Lru::SynchronizedHash.
   #
   class Hash < ::Hash
 
@@ -141,9 +144,34 @@ module Lru
       end
     end
   end
+
+  #
+  # A thread-safe version of the lru hash.
+  #
+  class SynchronizedHash < Hash
+
+    def initialize(maxsize)
+
+      super
+      @mutex = Mutex.new
+    end
+
+    def [](key)
+
+      @mutex.synchronize { super }
+    end
+
+    def []=(key, value)
+
+      @mutex.synchronize { super }
+    end
+  end
 end
 end
 
-class LruHash < Rufus::Lru::Hash
-end
+
+#
+# The original LruHash class, kept for backward compatibility.
+#
+class LruHash < Rufus::Lru::Hash; end
 

data/spec/synchronized_hash_spec.rb

@@ -0,0 +1,23 @@
+
+require 'spec_helper'
+
+
+describe Rufus::Lru::SynchronizedHash do
+
+  # well, you've probably seen better specs...
+
+  let(:hash) { Rufus::Lru::SynchronizedHash.new(3) }
+
+  it 'sports a mutex' do
+
+    hash.instance_variable_get(:@mutex).class.should == Mutex
+  end
+
+  it 'works' do
+
+    4.times { |i| hash[i] = i }
+
+    hash.size.should == 3
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rufus-lru
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2161499280 !ruby/object:Gem::Requirement
+  requirement: &2153411200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161499280
+  version_requirements: *2153411200
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2161498640 !ruby/object:Gem::Requirement
+  requirement: &2153410580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +33,7 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *2161498640
+  version_requirements: *2153410580
 description: LruHash class, a Hash with a max size, controlled by a LRU mechanism
 email:
 - jmettraux@gmail.com
@@ -47,6 +47,7 @@ files:
 - spec/hash_spec.rb
 - spec/lru_hash_spec.rb
 - spec/spec_helper.rb
+- spec/synchronized_hash_spec.rb
 - rufus-lru.gemspec
 - CHANGELOG.txt
 - LICENSE.txt