memoize 1.1.0 → 1.2.0

data/CHANGES

@@ -1,3 +1,7 @@
+= 1.2.0 - 31-Dec-2005
+* Added support for memoizing to file rather than memory
+* Corresponding changes in the test suite and example programs
+
 = 1.1.0 - 20-Oct-2005
 * Memoize#memoize now returns the cache (ruby-talk: 160870 and following)
 * Memoize#memoize now caches nil and false results

data/README

@@ -1,5 +1,5 @@
 = Description
-   A method that speeds methods up at the cost of memory.
+   A method that speeds methods up at the cost of memory (or disk space).
    
 = Prerequisites
    Ruby 1.8.0 or later
@@ -28,22 +28,33 @@
 
    memoize(:fib)
    fib(100) # Fast
+   
+   # Or store the cache to a file for later use
+   memoize(:fib, "fib.cache")
+   fib(100) # Fast
 
 = Constants
 Memoize::MEMOIZE_VERSION
    Returns the version of this package as a String.
 
 = Methods
-Memoize#memoize(method)
-   Takes a method (symbol) and caches the results of +method+ in a hash table.
-   If you call +method+ again with the same arguments, memoize gives you the
-   value from the table instead of letting the method compute the value again.
+Memoize#memoize(method, file=nil)
+   Takes a +method+ (symbol) and caches the results of +method+ in a hash
+   table. If you call +method+ again with the same arguments, memoize gives
+   you the value from the table instead of letting the method compute the
+   value again.
+   
+   If +file+ is provided, the results are cached to that file instead of
+   in memory.  Note that this uses Marshal internally, so don't expect your
+   cache to work between different versions of Ruby, should you happen to
+   upgrade.
 
    Returns the cache, which you can inspect or manipulate directly if you are
    so inclined.
 
 = Acknowledgements
    Code borrowed from Nobu Nakada (ruby-talk:155159).
+   Code borrowed from Ara Howard (ruby-talk:173428).
    Ideas taken from Brian Buckley and Sean O'Halpin.
 
 == License

data/lib/memoize.rb

@@ -1,13 +1,39 @@
 module Memoize
-   MEMOIZE_VERSION = "1.1.0"
-   def memoize(name)
+   MEMOIZE_VERSION = "1.2.0"
+   
+   # Memoize the method +name+.  If +file+ is provided, then the method results
+   # are stored on disk rather than in memory.  This consumes virtually no
+   # memory and is persistant.
+   def memoize(name, file=nil)
       meth = method(name)
-      cache = {}
-      (class << self; self; end).class_eval do
-         define_method(name) do |*args|
-            cache.has_key?(args) ? cache[args] : cache[args] ||= meth.call(*args)
+      
+      if file
+         cache = Hash.new.update(Marshal.load(File.read(file))) rescue {}
+      else
+         cache = {}
+      end
+      
+      if file
+         (class << self; self; end).class_eval do
+            define_method(name) do |*args|
+               unless cache.has_key?(args)
+                  cache[args] = meth.call(*args)
+                  File.open(file, "wb+"){|f| Marshal.dump(cache, f) }
+               end
+               cache[args]
+            end
+         end
+      else
+         (class << self; self; end).class_eval do
+            define_method(name) do |*args|
+               if cache.has_key?(args)
+                  cache[args]
+               else
+                  cache[args] ||= meth.call(*args)
+               end
+            end
          end
       end
       cache
    end
-end
+end

data/test/tc_memoize.rb

@@ -20,6 +20,7 @@ class TC_Memoize < Test::Unit::TestCase
    def setup
       @cache1 = nil
       @cache2 = nil
+      @file   = ENV["HOME"] || ENV["USERPROFILE"] + "/test.cache"
    end
 
    def fib(n)
@@ -34,7 +35,7 @@ class TC_Memoize < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal("1.1.0", Memoize::MEMOIZE_VERSION)
+      assert_equal("1.2.0", Memoize::MEMOIZE_VERSION)
    end
 
    def test_memoize
@@ -42,6 +43,14 @@ class TC_Memoize < Test::Unit::TestCase
       assert_nothing_raised{ fib(5) }
       assert_nothing_raised{ memoize(:fib) }
       assert_nothing_raised{ fib(50) }
+      assert_equal(55, fib(10))
+   end
+   
+   def test_memoize_with_file
+      assert_nothing_raised{ fib(5) }
+      assert_nothing_raised{ memoize(:fib, @file) }
+      assert_nothing_raised{ fib(50) }
+      assert_equal(55, fib(10))
    end
 
    # Ensure that a cache is returned, that it's a hash, and that each
@@ -58,4 +67,10 @@ class TC_Memoize < Test::Unit::TestCase
 
       assert_not_equal(@cache1, @cache2)
    end
+   
+   def teardown
+      @cache1 = nil
+      @cachd2 = nil
+      File.delete(@file) if File.exists?(@file)
+   end
 end

metadata

@@ -3,15 +3,15 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: memoize
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
-date: 2005-10-21
-summary: Speeds up methods at the cost of memory
+  version: 1.2.0
+date: 2005-12-31
+summary: Speeds up methods at the cost of memory (or disk space)
 require_paths: 
   - lib
 email: djberg96@gmail.com
 homepage: http://www.rubyforge.org/projects/shards
 rubyforge_project: 
-description: Speeds up methods at the cost of memory
+description: Speeds up methods at the cost of memory (or disk space)
 autorequire: 
 default_executable: 
 bindir: bin