simple_memoize 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-03-25
+
+* 1 major enhancement
+
+  * Clean little gem
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/simple_memoize.rb
+test/test_simple_memoize.rb

data/README.txt

@@ -0,0 +1,110 @@
+= SimpleMemoize
+
+* http://github.com/JackDanger/simple_memoize/
+
+== DESCRIPTION:
+
+Provides in-memory caching of any Ruby method.  It's dead simple and won't get in the way of any of your code.
+For something more robust that offers persistence try http://github.com/JackDanger/cached_values/
+
+== USAGE:
+
+There's only one method and it's usage is completely manual.
+
+  class Location
+    def geocoding(lat, long)
+      ... complicated stuff goes here ..
+    end
+    
+    memoize :geocoding
+  end
+  
+Now, when you try calling the geocoding method it might take a while the first time but the results of
+that initial method call will be memoized (cached) into memory.  The second time you call it the
+results will return instantly.
+
+Note: there is a separate memo of the method for each combination of arguments.  So calling the
+method a second time with different arguments will cause the method to execute fully.
+  
+  location = Location.new
+  location.geocoding(45.123, 123.45) # will take a while
+  location.geocoding(45.123, 123.45) # will return immediately
+  location.geocoding(12.876, 76.914) # will take a while because these arguments haven't been memoized
+  location.geocoding(12.876, 76.914) # will return immediately
+  location.geocoding(45.123, 123.45) # will return immediately because it's still memoized from before
+  
+You can use this on all classes and modules.
+
+  Module Colorizable
+  
+    def preferred_color
+      :blue
+    end
+    memoize :preferred_color
+  
+    class << self
+      def colors
+        [:blue, :green]
+      end
+      memoize :colors
+    end
+  end
+  
+  class House
+    include Colorizable
+    
+    def paint
+      'do painting'
+    end
+    memoize :paint
+    
+    class << self
+      def find_blues
+        .. find blue houses..
+      end
+      memoize :find_blues
+    end
+  end
+  
+  # the following are all memoized:
+  Colorizable.colors
+  House.new.preferred_color
+  House.find_blues
+  House.new.paint
+  
+That's it.  If you need anything different I recommend forking this library and bending it to your will.
+
+== INSTALL:
+
+In Rails: 
+
+  ruby script/plugin install git://github.com/JackDanger/simple_memoize.git
+  
+As a gem:
+
+  sudo gem install simple_memoize
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/simple_memoize.rb'
+
+Hoe.new('simple_memoize', SimpleMemoize::VERSION) do |p|
+  p.rubyforge_name = 'objectproxy' # if different than lowercase project name
+  p.developer('Jack Danger Canty', 'rubyforge@6brand.com')
+end
+
+# vim: syntax=Ruby

data/lib/simple_memoize.rb

@@ -0,0 +1,36 @@
+module SimpleMemoize
+  VERSION = '1.0.0'
+
+  module Module
+    def memoize(*method_names)
+      method_names.each do |method_name|
+        method_name = method_name.to_s
+        memoized_method_name = "#{method_name}_with_memo"
+        regular_method_name  = "#{method_name}_without_memo"
+
+        unless (instance_methods + private_instance_methods).include?(method_name)
+          raise NoMethodError, "The Method '#{method_name}' cannot be memoized because it doesn't exist in #{self}"
+        end
+        return if self.method_defined?(memoized_method_name)
+    
+        self.class_eval do
+
+          define_method memoized_method_name do |*args|
+            @simple_memoize ||= {}
+            @simple_memoize[method_name] ||= {}
+            @simple_memoize[method_name][args] ||= send(regular_method_name, *args)
+          end
+
+          alias_method regular_method_name, method_name
+          alias_method method_name, memoized_method_name
+
+          protected method_name if protected_instance_methods.include?(regular_method_name)
+          private   method_name if private_instance_methods.include?(regular_method_name)
+
+        end
+      end
+    end
+  end
+end
+
+Module.send :include, SimpleMemoize::Module

data/test/test_simple_memoize.rb

@@ -0,0 +1,114 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/simple_memoize'
+require 'rubygems'
+require 'mocha'
+
+module Barks
+  def growl
+    'Grrrrr'
+  end
+  memoize :growl
+  
+  def protected_growl
+    'Grrrrr'
+  end
+  protected :protected_growl
+  memoize   :protected_growl
+  
+  def private_growl
+    'Grrrrr'
+  end
+  private :private_growl
+  memoize :private_growl
+  
+  class << self
+    def sounds
+      ['woof', 'ruff']
+    end
+    memoize :sounds
+  end
+end
+
+class Dog
+  include Barks
+  
+  def drink
+    'slurp'
+  end
+  memoize :drink
+  
+  class << self
+    def breeds
+      ['doberman', 'dalmatian']
+    end
+    memoize :breeds
+  end
+end
+
+class SimpleMemoizeTest < Test::Unit::TestCase
+  def test_module_method_only_calls_memoized_once
+    dog = Dog.new
+    dog.expects(:growl_without_memo).returns('Grrrrr').once
+    4.times { dog.growl }
+  end
+
+  def test_module_method_calls_method_several_times
+    dog = Dog.new
+    dog.expects(:growl).returns('Grrrrr').times(4)
+    4.times { dog.growl }
+  end
+
+  def test_module_class_method_only_calls_memoized_once
+    sounds = Barks.sounds_without_memo
+    Barks.expects(:sounds_without_memo).returns(sounds).once
+    4.times { Barks.sounds }
+  end
+
+  def test_module_class_method_calls_method_several_times
+    sounds = Barks.sounds_without_memo
+    Barks.expects(:sounds).returns(sounds).times(4)
+    4.times { Barks.sounds }
+  end
+  
+  def test_object_method_calls_memoized_once
+    dog = Dog.new
+    drink = dog.drink_without_memo
+    dog.expects(:drink_without_memo).returns(drink).once
+    4.times { dog.drink }
+  end
+  
+  def test_object_method_calls_method_several_times
+    dog = Dog.new
+    drink = dog.drink_without_memo
+    dog.expects(:drink).returns(drink).times(4)
+    4.times { dog.drink }
+  end
+  
+  def test_class_method_calls_memoized_once
+    breeds = Dog.breeds_without_memo
+    Dog.expects(:breeds_without_memo).returns(breeds).once
+    4.times { Dog.breeds }
+  end
+  
+  def test_class_method_calls_method_several_times
+    breeds = Dog.breeds_without_memo
+    Dog.expects(:breeds).returns(breeds).times(4)
+    4.times { Dog.breeds }
+  end
+  
+  def test_protected_methods_remain_protected
+    dog = Dog.new
+    assert dog.protected_methods.include?('protected_growl_without_memo')
+    assert dog.protected_methods.include?('protected_growl')
+  end
+  
+  def test_private_methods_remain_private
+    dog = Dog.new
+    assert dog.private_methods.include?('private_growl_without_memo')
+    assert dog.private_methods.include?('private_growl')
+  end
+  
+  def test_cant_memoize_a_missing_method
+    assert_raises(NoMethodError) { Barks.memoize :totally_bad_method_name }
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: simple_memoize
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jack Danger Canty
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: Provides in-memory caching of any Ruby method.  It's dead simple and won't get in the way of any of your code. For something more robust that offers persistence try http://github.com/JackDanger/cached_values/
+email: 
+- rubyforge@6brand.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/simple_memoize.rb
+- test/test_simple_memoize.rb
+has_rdoc: true
+homepage: http://github.com/JackDanger/simple_memoize/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: objectproxy
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Provides in-memory caching of any Ruby method
+test_files: 
+- test/test_simple_memoize.rb