memoizer 1.0.1

data/CHANGELOG.txt

@@ -0,0 +1,4 @@
+== 1.0.1
+* Bump version to avoid conflict with old memoizer gem
+== 1.0.0
+* Initial release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+Copyright (c) 2011 Wegowise Inc.
+
+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.md

@@ -0,0 +1,63 @@
+Description
+===========
+
+Memoizer will memoize the results of your methods. It acts much like
+ActiveSupport::Memoizable without all of that freezing business. The API for unmemoizing
+is also a bit more expicit.
+
+Install
+=======
+
+    $ gem install memoizer
+
+Usage
+=====
+
+To memoize an instance method:
+
+    class A
+      include Memoizer
+      def hello() 'hello!'; end
+      memoize :hello
+    end
+
+Or you can memoize many methods at once:
+
+    class B
+      extend Memoizer
+      def hello() 'hello!'; end
+      def goodbye() 'goodbye :('; end
+      memoize :hello, :goodbye
+    end
+
+Memoizing class methods works the same way:
+
+    class C
+      class << self
+        include Memoizer
+        def hello() 'hello!'; end
+        memoize :hello
+      end
+    end
+
+
+To unmemoize a specific method:
+
+    instance = A.new
+    instance.hello  # the hello method is now memoized
+    instance.unmemoize(:hello)    # the hello method is no longer memoized
+    instance.hello  # the hello method is run again and re-memoized
+
+
+To unmemoize all methods for an instance:
+
+    instance = B.new
+    instance.hello    # the hello method is now memoized
+    instance.goodbye  # the goodbye method is now memoized
+    instance.unmemoize_all    # neither hello nor goodbye are memoized anymore
+
+
+License
+=======
+
+See LICENSE.txt

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'fileutils'
+
+def gemspec_name
+  @gemspec_name ||= Dir['*.gemspec'][0]
+end
+
+def gemspec
+  @gemspec ||= eval(File.read(gemspec_name), binding, gemspec_name)
+end
+
+desc "Build the gem"
+task :gem=>:gemspec do
+  sh "gem build #{gemspec_name}"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
+end
+
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc 'Run tests'
+task :test do |t|
+  sh 'rspec spec'
+end
+
+task :default => :test

data/lib/memoizer.rb

@@ -0,0 +1,74 @@
+module Memoizer
+  def self.included(base)
+    base.extend ClassMethods
+    base.send :include, InstanceMethods
+  end
+
+  def self.safe_name(method_name)
+    method_name.to_s.sub(/\?\Z/, '_query').sub(/!\Z/, '_bang').to_sym
+  end
+
+  def self.ivar_name(method_name)
+    "_memoized_#{self.safe_name(method_name)}"
+  end
+
+  module ClassMethods
+    def memoize(*method_names)
+      method_names.each do |method_name|
+        safe_method_name = Memoizer.safe_name(method_name)
+        memoized_ivar_name = Memoizer.ivar_name(method_name)
+        unmemoized_method = "_unmemoized_#{method_name}"
+
+        attr_accessor memoized_ivar_name
+        alias_method unmemoized_method, method_name
+
+        no_args = self.instance_method(unmemoized_method).arity == 0
+
+        define_method method_name do |*args|
+          memoized_value = self.instance_variable_get("@#{memoized_ivar_name}")
+
+          # if the method takes no inputs, store the value in an array
+          if no_args
+            if !memoized_value.is_a?(Array)
+              memoized_value = [self.send(unmemoized_method)]
+              self.instance_variable_set("@#{memoized_ivar_name}", memoized_value)
+            end
+            memoized_value.first
+
+          #otherwise store in a hash indexed by the arguments
+          else
+            if !memoized_value.is_a?(Hash)
+              memoized_value = {args => self.send(unmemoized_method, *args)}
+              self.instance_variable_set("@#{memoized_ivar_name}", memoized_value)
+            elsif !memoized_value.has_key?(args)
+              memoized_value[args] = self.send(unmemoized_method, *args)
+            end
+            memoized_value[args]
+          end
+        end
+
+        if self.private_method_defined?(unmemoized_method)
+          private method_name
+        elsif self.protected_method_defined?(unmemoized_method)
+          protected method_name
+        end
+
+      end
+    end
+  end
+
+  module InstanceMethods
+    def unmemoize(method_name)
+      self.instance_variable_set("@#{Memoizer.ivar_name(method_name)}", nil)
+    end
+
+    def unmemoize_all
+      (methods + private_methods + protected_methods).each do |method|
+        if method.to_s =~ /^_unmemoized_(.*)/
+          unmemoize($1)
+        end
+      end
+    end
+  end
+
+end

data/lib/memoizer/version.rb

@@ -0,0 +1,3 @@
+module Memoizer
+  VERSION = '1.0.1'
+end

data/memoizer.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems' unless defined? Gem
+require File.dirname(__FILE__) + "/lib/memoizer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "memoizer"
+  s.version     = Memoizer::VERSION
+  s.authors     = ["Barun Singh"]
+  s.email       = "bsingh@wegowise.com"
+  s.homepage    = "http://github.com/wegowise/memoizer"
+  s.summary = "Memoizes (caches the results of) your methods"
+  s.description =  "Memoizer caches the results of your method calls, works well with methods that accept arguments or return nil. It's a simpler and more expicit alternative to ActiveSupport::Memoizable"
+  s.required_rubygems_version = ">= 1.3.6"
+  s.files = Dir.glob(%w[{lib,spec}/**/*.rb [A-Z]*.{txt,rdoc,md} *.gemspec]) + %w{Rakefile}
+  s.extra_rdoc_files = ["README.md", "LICENSE.txt"]
+  s.license = 'MIT'
+end

data/spec/memoizer_spec.rb

@@ -0,0 +1,209 @@
+require 'memoizer'
+require 'spec_helper'
+
+class MemoizerSpecClass
+  include Memoizer
+  def no_params() Date.today; end
+  def with_params?(ndays, an_array) Date.today + ndays + an_array.length; end
+  def returning_nil!() Date.today; nil; end
+  memoize :no_params, :with_params?, :returning_nil!
+end
+class Beepbop < MemoizerSpecClass; end
+
+
+describe Memoizer do
+  let(:today) { Date.today }
+
+  describe '.memoize' do
+    let(:object) { MemoizerSpecClass.new }
+    let(:tomorrow) { Date.today + 1 }
+
+    context "for a method with no params" do
+      it "stores memoized value" do
+        Timecop.freeze(today)
+        object.no_params.should == today
+        Timecop.freeze(tomorrow)
+        object.no_params.should == today
+      end
+    end
+
+    context "for a method with params (and ending in ?)" do
+      it "stores memoized value" do
+        Timecop.freeze(today)
+        object.with_params?(1, [1,2]).should == (today + 3)
+        Timecop.freeze(tomorrow)
+        object.with_params?(1, [1,2]).should == (today + 3)
+      end
+      it "does not confuse one set of inputs for another" do
+        Timecop.freeze(today)
+        object.with_params?(1, [1,2]).should == (today + 3)
+        object.with_params?(2, [1,2]).should == (today + 4)
+        Timecop.freeze(tomorrow)
+        object.with_params?(1, [1,2]).should == (today + 3)
+        object.with_params?(1, [2,2]).should == (today + 4)
+      end
+    end
+
+    context "for a method that returns nil (and ends in !)" do
+      it "stores the memoized value" do
+        object.returning_nil!
+        Date.stub!(:today).and_raise(ArgumentError)
+        object.returning_nil!.should be_nil
+      end
+    end
+
+    context "for subclasses" do
+      let(:object) { Beepbop.new }
+      it "still memoizes things" do
+        Timecop.freeze(today)
+        object.no_params.should == today
+        Timecop.freeze(tomorrow)
+        object.no_params.should == today
+      end
+    end
+
+    context 'for private methods' do
+      class Beirut < MemoizerSpecClass
+        def foo() bar; end
+        private
+        def bar() Date.today; end
+        memoize :bar
+      end
+      let(:object) { Beirut.new }
+
+      it "respects the privacy of the memoized method" do
+        Beirut.private_method_defined?(:bar).should be_true
+        Beirut.private_method_defined?(:_unmemoized_bar).should be_true
+      end
+
+      it "memoizes things" do
+        Timecop.freeze(today)
+        object.foo.should == today
+        Timecop.freeze(today + 1)
+        object.foo.should == today
+      end
+    end
+
+    context 'for protected methods' do
+      class Wonka < MemoizerSpecClass
+        def foo() bar; end
+        protected
+        def bar() Date.today; end
+        memoize :bar
+      end
+      let(:object) { Wonka.new }
+
+      it "respects the privacy of the memoized method" do
+        Wonka.protected_method_defined?(:bar).should be_true
+        Wonka.protected_method_defined?(:_unmemoized_bar).should be_true
+      end
+
+      it "memoizes things" do
+        Timecop.freeze(today)
+        object.foo.should == today
+        Timecop.freeze(today + 1)
+        object.foo.should == today
+      end
+    end
+
+  end
+
+
+  describe 'instance methods' do
+    class MemoizerSpecClass
+      def today() Date.today; end
+      def plus_ndays(ndays) Date.today + ndays; end
+      memoize :today, :plus_ndays
+    end
+
+    let(:object) { MemoizerSpecClass.new }
+    before do
+      Timecop.freeze(today)
+      object.today.should == today
+      object.plus_ndays(1).should == today + 1
+      object.plus_ndays(3).should == today + 3
+    end
+
+    describe '#unmemoize' do
+      context "for a method with no arguments" do
+        it "clears the memoized value so it can be rememoized" do
+          Timecop.freeze(today + 1)
+          object.today.should == today
+
+          object.unmemoize(:today)
+          object.today.should == today + 1
+
+          Timecop.freeze(today + 2)
+          object.today.should == today + 1
+        end
+      end
+
+      context "for a method with arguments" do
+        it "unmemoizes for all inupts" do
+          Timecop.freeze(today + 1)
+          object.plus_ndays(1).should == today + 1
+          object.plus_ndays(3).should == today + 3
+
+          object.unmemoize(:plus_ndays)
+          object.plus_ndays(1).should == today + 2
+          object.plus_ndays(3).should == today + 4
+
+          Timecop.freeze(today + 2)
+          object.plus_ndays(1).should == today + 2
+          object.plus_ndays(3).should == today + 4
+        end
+      end
+
+      it "only affects the method specified" do
+        Timecop.freeze(today + 1)
+        object.today.should == today
+
+        object.unmemoize(:plus_ndays)
+        object.today.should == today
+
+        object.unmemoize(:today)
+        object.today.should == today + 1
+      end
+
+      context "for subclasses" do
+        let(:object) { Beepbop.new }
+        it "clears the memoized value" do
+          Timecop.freeze(today + 1)
+          object.today.should == today
+
+          object.unmemoize(:today)
+          object.today.should == today + 1
+
+          Timecop.freeze(today + 2)
+          object.today.should == today + 1
+        end
+      end
+    end
+
+    describe '#unmemoize_all' do
+      shared_examples_for "unmemoizing methods" do
+        it "clears all memoized values" do
+          Timecop.freeze(today + 1)
+          object.today.should == today
+          object.plus_ndays(1).should == today + 1
+          object.plus_ndays(3).should == today + 3
+
+          object.unmemoize_all
+
+          object.today.should == today + 1
+          object.plus_ndays(1).should == today + 2
+          object.plus_ndays(3).should == today + 4
+        end
+      end
+
+      it_should_behave_like "unmemoizing methods"
+
+      context "for subclasses" do
+        let(:object) { Beepbop.new }
+        it_should_behave_like "unmemoizing methods"
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'timecop'

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: memoizer
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Barun Singh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-02 00:00:00.000000000Z
+dependencies: []
+description: Memoizer caches the results of your method calls, works well with methods
+  that accept arguments or return nil. It's a simpler and more expicit alternative
+  to ActiveSupport::Memoizable
+email: bsingh@wegowise.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- lib/memoizer/version.rb
+- lib/memoizer.rb
+- spec/memoizer_spec.rb
+- spec/spec_helper.rb
+- CHANGELOG.txt
+- LICENSE.txt
+- README.md
+- memoizer.gemspec
+- Rakefile
+homepage: http://github.com/wegowise/memoizer
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Memoizes (caches the results of) your methods
+test_files: []