ecomba-memoizable 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Enrique Comba Riepenhausen
+
+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.

data/README.rdoc

@@ -0,0 +1,64 @@
+= Memoizable
+
+== Introduction
+
+When doing recursion sometimes we are faced with the problem of performance
+versus the beauty of the code we are implementing, specially when, due to 
+the recursive nature of the method we have written we seem to be computing
+over and over the same.
+
+The concept of memoization comes from the idea of capturing a certain
+method call and saving it's result to an internal cache, so that, if this
+particular method (with the same parameters) is called, it will return the
+previously computed result.
+
+I was inspired in writing this little module after reading an article
+on James Edward Grey II'2 blog (http://blog.grayproductions.net/articles/caching_and_memoization)
+
+== Example
+
+Imagine we want to compute the Fibonacci sequence:
+
+  class Fibonacci
+    def fib(num)
+      return num if num < 2
+      fib(num -1) + fib(num - 2)
+    end
+  end
+
+As you can see immediately is that this will result in poor performance the
+higher the number in the sequence we request as the algorithm will compute
+over and over same method calls.
+
+You could add some cache functionallity into your method and class, although
+you would add new behaviour that the class and method shouldn't really have
+as they should be dealing exclusively with the logic they are supposed to 
+execute; in this case the computation of the Fibonacci sequence.
+
+Here is how the class would look like when we Memonize it:
+
+  class Fibonacci
+    include Memoizable
+
+    def fib(num)
+      return num if num < 2
+      fib(num -1) + fib(num - 2)
+    end
+  
+    memoize :fib
+  end
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Enrique Comba Riepenhausen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "memoizable"
+    gem.summary = %Q{Memoize method calls}
+    gem.description = %Q{Memoizes calls to method to boost the performance of recursive calls}
+    gem.email = "ecomba@nexwerk.com"
+    gem.homepage = "http://github.com/ecomba/memoizable"
+    gem.authors = ["Enrique Comba Riepenhausen"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "memoizable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/lib/memoizable.rb

@@ -0,0 +1,17 @@
+module Memoizable
+  CACHE = Hash.new
+  module ClassMethods
+    def memoize(name)
+      original = "__original__#{name}"
+      alias_method original, name
+      define_method(name) do |*args|
+        CACHE[self.to_s.unpack("a*")<<name.to_s.unpack("a*")<<args] ||= 
+          send(original, *args)
+      end
+    end
+  end
+  
+  def self.included(receiver)
+    receiver.extend ClassMethods
+  end
+end

data/spec/fibonacci_sample_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'benchmark'
+
+describe "Fibonacci" do
+  class Fibonacci
+    def fib(number)
+      return number if number < 2
+      fib(number -1) + fib(number - 2)
+    end
+  end
+  
+  context "context" do
+    it "should run faster" do
+      fibo = Fibonacci.new
+      bm = Benchmark.measure { fibo.fib(30) }
+      class Fibonacci; include Memoizable; memoize :fib; end;
+      fibo2 = Fibonacci.new
+      bm2 = Benchmark.measure { fibo2.fib(30) }
+      
+      # This test is flakey, I know... How to test the real speed? 
+      bm.to_a[5].should > bm2.to_a[5]
+      bm2.to_a[5].should < 0.01
+    end
+  end
+end

data/spec/memoizable_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Memoizable" do
+  before(:all) do
+    class Foo; def a; return "blaah" end; end;
+  end
+  
+  context "Module structure" do
+    it "should have a ClassMethods module" do
+      Memoizable::ClassMethods.class.should be(Module)
+    end
+    
+    it "should contain a memonize method" do
+      Memoizable::ClassMethods.public_method_defined?(:memoize).should be_true
+    end
+    
+    context ": Cache" do
+      it "should be present" do
+        Memoizable::CACHE.should_not be_nil
+      end
+      
+      it "should be a hash" do
+        Memoizable::CACHE.should be_instance_of(Hash)
+      end
+    end
+  end
+  
+  context "Class Inclusion" do
+    it "should extend a given class with the memoize method" do
+      class Foo; include Memoizable; end;
+      Foo.respond_to?(:memoize).should be_true
+    end
+    
+    it "should alias the original method" do
+      Foo.memoize :a
+      foo = Foo.new
+      foo.respond_to?("__original__a").should be_true
+    end
+    
+    it "should modify the method" do
+      method_a = Foo.instance_method(:a)
+      Foo.memoize :a
+      method_a.should_not == Foo.instance_method(:a)
+    end
+  end
+  
+  context "Method calls" do  
+    it "should return the same values" do
+      foo = Foo.new
+      first_return = foo.a
+      Foo.memoize :a
+      first_return.should == foo.a
+    end
+    
+    it "should put the method call into the cache" do
+      Foo.memoize :a
+      foo = Foo.new
+      Memoizable::CACHE.size.should > 0
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'memoizable'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: ecomba-memoizable
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Enrique Comba Riepenhausen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Memoizes calls to method to boost the performance of recursive calls
+email: ecomba@nexwerk.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/memoizable.rb
+- spec/fibonacci_sample_spec.rb
+- spec/memoizable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/ecomba/memoizable
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Memoize method calls
+test_files: 
+- spec/fibonacci_sample_spec.rb
+- spec/memoizable_spec.rb
+- spec/spec_helper.rb