methodhash 0.5.0

data/README

@@ -0,0 +1,121 @@
+NAME
+
+  methodhash
+
+SYNOPSIS
+
+  A Hash subclass for automatic storage of values obtained from a method 
+  defined by the user. Useful for lengthy calculations on large datasets.
+
+URI
+
+  http://rubyforge.org/projects/methodhash
+  http://github.com/fredrikj/methodhash
+
+INSTALL
+
+  gem install methodhash
+
+DESCRIPTION
+
+  A Hash subclass that defines its values from a specified method.
+  Use it by creating a subclass of MethodHash, and define a method
+  with the name "mymethod" in it. Like this (same code in samples/samples.rb):
+  
+  # 1. Simple use
+  class AddOne < MethodHash
+    def mymethod(a)
+      sleep 3
+      a + 1
+    end
+  end 
+  
+  a = AddOne.new
+  a            #  {}
+  a[1]         #  2
+  a[7]         #  8
+  a            #  {1=>2, 7=>8}
+  puts a.dump  #  --- !map:AddOne 
+               #  1: 2
+               #  7: 8
+  
+  
+  # 2. With a file
+  b = AddOne.new '/tmp/one.yml'
+  b            #  {}
+  b[1]         #  2
+  b.dump       #  '/tmp/one.yml' 
+  c = AddOne.new '/tmp/one.yml'
+  puts c.inspect #  {1=>2}
+  
+  
+  # 3. Some protection against data corruption.
+  class AddTwo < MethodHash
+    def mymethod(a)
+      a + 2
+    end
+  end 
+  
+  begin
+    d = AddTwo.new '/tmp/one.yml' #  ArgumentError: Path holds class AddOne
+  rescue
+    puts $!
+  end
+  
+  
+  # 4. Saving exceptions arising from mymethod.
+  class AddOneFaulty < MethodHash
+    def mymethod(a)
+      rand(2)==0 ? raise("Epic Fail!") : a+1
+    end
+  end 
+  
+  e = AddOneFaulty.new
+  e[1]                 #  RuntimeError: Epic Fail!  # If something bad happened
+  e                    #  {1=>"ERROR: Epic Fail!"}
+  e.retry_errors       #  false
+  e[1]                 #  RuntimeError: Epic Fail!  # Still keeping the error
+  e.retry_errors=true  #  true
+  e[1]                 #  2                         # If better luck this time
+  e                    #  {1=>2}
+   
+  
+  # 5. A more complex setting
+  class AddThree < MethodHash
+    def initialize(path1=nil, path2=nil, mypath=nil)
+      @one = AddOne.new(path1)
+      @two = AddTwo.new(path2)
+      super(mypath)
+    end
+    
+    def mymethod(a)
+      @one[a] + @two[a] - a
+    end
+     
+    def dump
+      @one.dump
+      @two.dump
+      super
+    end
+  end
+  
+  f = AddThree.new( '/tmp/one.yml', '/tmp/two.yml')
+  puts f[3]
+  f.dump
+  
+  
+  # 6. With two arguments
+  class Add < MethodHash
+    def mymethod(a,b)
+      a + b
+    end
+  end
+
+  
+
+
+HISTORY
+  0.5.0
+
+    Initial version
+

data/lib/methodhash.rb

@@ -0,0 +1,93 @@
+require 'yaml'
+
+class MethodHash < Hash
+
+  attr_accessor :retry_errors, :force_calc
+  attr_reader :changed, :path
+  alias_method :originalassign, :[]=
+
+  # --- initialize ---
+  # A path is optional but necessary if you want to store the Hash to disk.
+  def initialize(path=nil)
+    unless self.respond_to? :mymethod
+      raise ArgumentError, 
+            "No calculation method (with name 'mymethod') defined for #{self.class}"
+    end
+    if self.class.to_s == 'MethodHash'
+      raise ArgumentError, "Make a subclass. Don't use MethodHash directly."
+    end
+    @path = path
+    @changed = false 
+    @retry_errors = false
+    @force_calc = false
+    if @path and File.exists? @path
+      hash = YAML.load open(@path)
+      raise ArgumentError, "Path holds class #{hash.class}" if hash.class != self.class
+      self.merge! hash
+    end
+  end
+
+  # --- [] ---
+  # If not previously called with given arguments, calls 'mymethod' 
+  # with the arguments and inserts the answer in the Hash.
+  # If force_calc is set to true, mymethod is always called.
+  # If retry_errors is set to true, mymethod is also called if value 
+  # has previously been retrieved but raised an error at that time.
+  def [](*arg)
+    arg = arg.first if arg.size==1
+    if !force_calc and s=super(arg)
+      if s.is_a? String and s[0,6]=='ERROR:'
+        if @retry_errors
+          self.delete arg
+          self.[](*arg)
+        else
+          raise s[7..-1]
+        end
+      else
+        s
+      end
+    else
+      @changed = true
+      begin
+        originalassign(arg,self.mymethod(*arg))
+      rescue
+        originalassign(arg,"ERROR: #{$!}")
+        raise
+      end
+    end
+  end
+
+  # --- []= ---
+  # This method cannot be used.
+  def []=(key, value)
+    raise "You can't just put values into a #{self.class}."
+  end
+
+  # --- dump ---
+  # If a path has been given, writes self to that file and returns the path.
+  # Otherwise, returns a string containing the dump.
+  def dump
+    if @path
+      if self.changed?
+        open(@path,'w'){|f| YAML.dump(self,f) }
+        @changed = false
+      end
+      @path
+    elsif !path
+      @changed = false
+      YAML.dump(self)
+    end
+  end
+
+  def delete(arg)
+    @changed = true
+    super
+  end
+
+  # --- changed? ---
+  # Has something changed since the last call to dump?
+  def changed?
+    @changed
+  end
+
+end

data/methodhash.gemspec

@@ -0,0 +1,24 @@
+## methodhash.gemspec
+#
+
+Gem::Specification::new do |spec|
+  spec.name = "methodhash"
+  spec.description = 'A Hash for automatic storage of values obtained from a method defined by the user.' 
+  spec.version = "0.5.0"
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = 'methodhash'
+
+  spec.files = ["methodhash.gemspec", "lib", "lib/methodhash.rb", "README", "samples", "samples/samples.rb"]
+  spec.executables = []
+  
+  spec.require_path = "lib"
+
+  spec.has_rdoc = true
+
+  spec.extensions.push(*[])
+
+  spec.rubyforge_project = "methodhash"
+  spec.author = "Fredrik Johansson"
+  spec.email = "fredjoha@gmail.com"
+  spec.homepage = "http://github.com/fredrikj/methodhash/tree/master"
+end

data/samples/samples.rb

@@ -0,0 +1,88 @@
+# 1. Simple use
+class AddOne < MethodHash
+  def mymethod(a)
+    sleep 3
+    a + 1
+  end
+end 
+
+a = AddOne.new
+a            #  {}
+a[1]         #  2
+a[7]         #  8
+a            #  {1=>2, 7=>8}
+puts a.dump  #  --- !map:AddOne 
+             #  1: 2
+             #  7: 8
+
+
+# 2. With a file
+b = AddOne.new '/tmp/one.yml'
+b            #  {}
+b[1]         #  2
+b.dump       #  '/tmp/one.yml' 
+c = AddOne.new '/tmp/one.yml'
+puts c.inspect #  {1=>2}
+
+
+# 3. Some protection against data corruption.
+class AddTwo < MethodHash
+  def mymethod(a)
+    a + 2
+  end
+end 
+
+begin
+  d = AddTwo.new '/tmp/one.yml' #  ArgumentError: Path holds class AddOne
+rescue
+  puts $!
+end
+
+
+# 4. Saving exceptions arising from mymethod.
+class AddOneFaulty < MethodHash
+  def mymethod(a)
+    rand(2)==0 ? raise("Epic Fail!") : a+1
+  end
+end 
+
+e = AddOneFaulty.new
+e[1]                 #  RuntimeError: Epic Fail!  # If something bad happened
+e                    #  {1=>"ERROR: Epic Fail!"}
+e.retry_errors       #  false
+e[1]                 #  RuntimeError: Epic Fail!  # Still keeping the error
+e.retry_errors=true  #  true
+e[1]                 #  2                         # If better luck this time
+e                    #  {1=>2}
+ 
+
+# 5. A more complex setting
+class AddThree < MethodHash
+  def initialize(path1=nil, path2=nil, mypath=nil)
+    @one = AddOne.new(path1)
+    @two = AddTwo.new(path2)
+    super(mypath)
+  end
+  
+  def mymethod(a)
+    @one[a] + @two[a] - a
+  end
+   
+  def dump
+    @one.dump
+    @two.dump
+    super
+  end
+end
+
+f = AddThree.new( '/tmp/one.yml', '/tmp/two.yml')
+puts f[3]
+f.dump
+
+
+# 6. With two arguments
+class Add < MethodHash
+  def mymethod(a,b)
+    a + b
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: methodhash
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Fredrik Johansson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-02 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: A Hash for automatic storage of values obtained from a method defined by the user.
+email: fredjoha@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- methodhash.gemspec
+- lib/methodhash.rb
+- README
+- samples/samples.rb
+has_rdoc: true
+homepage: http://github.com/fredrikj/methodhash/tree/master
+licenses: []
+
+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: methodhash
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: methodhash
+test_files: []
+