rufus-lru 1.0

data/README.txt

@@ -0,0 +1,59 @@
+
+= rufus-lru
+
+LruHash class, a Hash with a max size, controlled by a LRU mechanism
+
+
+== getting it
+
+    sudo gem install rufus-lru
+
+or at
+
+    http://rubyforge.org/frs/?group_id=4812
+
+
+== usage
+
+It's a regular hash, but you have to set a maxsize at instantiation.
+
+Once the maxsize is reached, the hash will discard the element that was the
+least recently used (hence LRU).
+
+    require 'rubygems'
+    require 'rufus/lru'
+
+    h = LruHash.new 3
+
+    5.times { |i| h[i] = "a" * i }
+
+    puts h.inspect # >> {2=>"aa", 3=>"aaa", 4=>"aaaa"}
+
+    h[:newer] = "b"
+
+    puts h.inspect # >> {:newer=>"b", 3=>"aaa", 4=>"aaaa"}
+
+
+== mailing list
+
+On the OpenWFEru-user for now : 
+
+    http://groups.google.com/group/openwferu-users
+
+
+== source
+
+    http://rufus.rubyforge.org/svn/trunk/lru
+
+    svn checkout http://rufus.rubyforge.org/svn/trunk/lru
+
+
+== author
+
+John Mettraux, jmettraux@gmail.com
+
+
+== license
+
+MIT
+

data/lib/rufus/lru.rb

@@ -0,0 +1,124 @@
+#
+#--
+# Copyright (c) 2008, John Mettraux, jmettraux@gmail.com
+#
+# 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.
+#++
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux
+#
+
+#require 'monitor'
+
+
+#
+# A Hash that has a max size. After the maxsize has been reached, the
+# least recently used entries (LRU hence), will be discared to make
+# room for the new entries.
+#
+class LruHash < Hash
+
+    #include MonitorMixin
+        #
+        # seems not necessary for now, and it collides with expool's
+        # @monitors own sync
+
+    attr_reader :maxsize
+
+    def initialize (maxsize)
+
+        super()
+
+        @maxsize = maxsize
+        @lru_keys = []
+    end
+
+    def maxsize= (s)
+
+        @maxsize = s
+        remove_lru while size > @maxsize
+    end
+
+    def clear
+
+        super
+        @lru_keys.clear
+    end
+
+    #
+    # Returns the keys with the lru in front.
+    #
+    def ordered_keys
+
+        @lru_keys
+    end
+
+    def [] (key)
+
+        value = super
+        return nil unless value
+        touch(key)
+
+        value
+    end
+
+    def []= (key, value)
+
+        remove_lru while size >= @maxsize
+        super
+        touch(key)
+
+        value
+    end
+
+    def delete (key)
+
+        value = super
+        @lru_keys.delete(key)
+
+        value
+    end
+
+    protected
+
+        #
+        # Puts the key on top of the lru 'stack'.
+        # The bottom being the lru place.
+        #
+        def touch (key)
+
+            @lru_keys.delete(key)
+            @lru_keys << key
+        end
+
+        #
+        # Removes the lru value and returns it.
+        # Returns nil if the cache is currently empty.
+        #
+        def remove_lru
+
+            key = @lru_keys.delete_at 0
+            delete key
+        end
+end
+

data/test/test.rb

@@ -0,0 +1,73 @@
+
+#
+# Testing rufus-lru
+#
+# jmettraux@gmail.com
+#
+#      Sun Oct 29 16:18:25 JST 2006
+# then Tue Jan 15 12:53:04 JST 2008
+#
+
+require 'test/unit'
+require 'rufus/lru'
+
+
+class LruTest < Test::Unit::TestCase
+
+    #def setup
+    #end
+
+    #def teardown
+    #end
+
+    def test_lru_0
+
+        h = LruHash.new 3
+
+        assert_equal 0, h.size
+
+        h[:a] = "A"
+
+        assert_equal 1, h.size
+
+        h[:b] = "B"
+        h[:c] = "C"
+
+        assert_equal [ :a, :b, :c ], h.ordered_keys
+
+        h[:d] = "D"
+
+        assert_equal 3, h.size
+        assert_equal [ :b, :c, :d ], h.ordered_keys
+        assert_equal nil, h[:a]
+        assert_equal "B", h[:b]
+        assert_equal [ :c, :d, :b ], h.ordered_keys
+
+        h.delete :d
+
+        #require 'pp'
+        #puts "lru keys :"
+        #pp h.ordered_keys
+
+        assert_equal 2, h.size
+        assert_equal [ :c, :b ], h.ordered_keys
+
+        h[:a] = "A"
+
+        assert_equal 3, h.size
+        assert_equal [ :c, :b, :a ], h.ordered_keys
+
+        h[:d] = "D"
+
+
+        assert_equal 3, h.size
+        assert_equal [ :b, :a, :d ], h.ordered_keys
+
+        assert_equal "B", h[:b]
+        assert_equal "A", h[:a]
+        assert_equal "D", h[:d]
+        assert_equal nil, h[:c]
+        assert_equal [ :b, :a, :d ], h.ordered_keys
+    end
+
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+name: rufus-lru
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- John Mettraux
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-15 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: 
+email: john at gmail dot com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- lib/rufus
+- lib/rufus/lru.rb
+- test/test.rb
+- README.txt
+has_rdoc: true
+homepage: http://rufus.rubyforge.org/rufus-lru
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 0.9.5
+signing_key: 
+specification_version: 2
+summary: LruHash class, a Hash with a max size, controlled by a LRU mechanism
+test_files: 
+- test/test.rb