memoist2 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 829d1ae3d37827ff9822e3435752208f5d96c376
-  data.tar.gz: 399d3e864904a801173ac73416e9fac4f86dad09
+  metadata.gz: 7e42697bf2e5d3807d6075bf5498bf849b86353c
+  data.tar.gz: 80b78cee05bd57d58ccfd7afd5e46b4a6e4b79c3
 SHA512:
-  metadata.gz: 437e09101708635c4861064ed156cd5d6a419468f4da942395deb7c90b0c19569dd04515c6ad635d6d41a1c620a72084175b4b277e0c1ca3517baf23e8614f50
-  data.tar.gz: e84bae0e10a00897fe7afb5eabfa81b9d2d88294664896f0c7b5df1655fa0d514f5dbb9d2b5062dcb239e72fed40e48a23e6c1c4badc9574c9f53987a3da68ae
+  metadata.gz: 66d8dd9039e1f2ac5c724bbc01946cafda39c3d1d5201564f42a2cbe33f37e2ce087f1836b8ee130d408403862245f25bf68e614f1e50b25ce8fc424aa4c2786
+  data.tar.gz: 2ad308d69a84799e565257ec2e4dedcfac853fc2039346b22abcaa38045859c2aea3d8347435f0d2444d2dace75124e2db7f3112fad440664f6afb734d1f9eec

data/README.md

@@ -1,6 +1,8 @@
 memoist2
 ========
 
+[![Build Status](https://travis-ci.org/matthewrudy/memoist2.png?branch=master)](https://travis-ci.org/matthewrudy/memoist2)
+
 Simple Memoization for Ruby 2.0
 
 Example
@@ -9,7 +11,7 @@ Example
 Memoize an instance method
 
   class Foo
-    extend Memoist2
+    include Memoist2
 
     def bar
       sleep 1 && 2**10
@@ -20,14 +22,12 @@ Memoize an instance method
 Memoize a class method
 
   class Foo
-    class << self
-      extend Memoist2
+    include Memoist2
 
-      def bar
-        # something expensive
-      end
-      memoize :bar
+    def self.bar
+      # something expensive
     end
+    memoize_class_method :bar
   end
 
 Licence

data/Rakefile

@@ -15,7 +15,7 @@ spec = Gem::Specification.new do |s|
 
   # Basic details
   s.name              = "memoist2"
-  s.version           = "0.1.2"
+  s.version           = "0.2.0"
   s.summary           = "Really simple memoization for ruby 2.0"
   s.author            = "Matthew Rudy Jacobs"
   s.email             = "MatthewRudyJacobs@gmail.com"

data/benchmark.rb

@@ -20,7 +20,7 @@ require 'memoist2'
 TIMES = 10_000_000
 
 class MyClass
-  extend Memoist2
+  include Memoist2
 
   def raw
     (2**10)**2 # something mildly difficult

data/lib/memoist2.rb

@@ -4,19 +4,33 @@ module Memoist2
     "@_memoized_#{symbol.to_s.sub(/\?\Z/, '_query').sub(/!\Z/, '_bang')}".to_sym
   end
 
-  def memoize(method_name)
-    memoized_ivar = Memoist2.memoized_ivar_for(method_name)
-    memoized_module = Module.new do
-      module_eval <<-EVAL
-        def #{method_name}
-          if !defined?(#{memoized_ivar}) || #{memoized_ivar}.empty?
-            #{memoized_ivar} = [super]
+  module ClassMethods
+
+    def memoize(method_name)
+      memoized_ivar = Memoist2.memoized_ivar_for(method_name)
+      memoized_module = Module.new do
+        module_eval <<-EVAL
+          def #{method_name}
+            unless #{memoized_ivar}
+              #{memoized_ivar} = [super]
+            end
+            #{memoized_ivar}[0]
           end
-          #{memoized_ivar}[0]
-        end
-      EVAL
+        EVAL
+      end
+      prepend memoized_module
+    end
+
+    def memoize_class_method(method_name)
+      singleton_class.class_eval do
+        include Memoist2 unless ancestors.include?(Memoist2)
+        memoize method_name
+      end
     end
-    prepend memoized_module
+
   end
 
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
 end

data/memoist2.gemspec

@@ -2,15 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = "memoist2"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matthew Rudy Jacobs"]
   s.date = "2013-07-19"
   s.email = "MatthewRudyJacobs@gmail.com"
   s.extra_rdoc_files = ["README.md"]
-  s.files = [".gitignore", ".rspec", ".ruby-version", ".travis.yml", "Gemfile", "README.md", "Rakefile", "example/foo.rb", "lib/memoist2.rb", "memoist2.gemspec", "spec/memoist2_spec.rb", "spec/spec_helper.rb"]
+  s.files = [".gitignore", ".rspec", ".ruby-version", ".travis.yml", "Gemfile", "LICENCE", "README.md", "Rakefile", "benchmark.rb", "example/foo.rb", "lib/memoist2.rb", "memoist2.gemspec", "spec/memoist2_spec.rb", "spec/spec_helper.rb"]
   s.homepage = "https://github.com/matthewrudy/memoist2"
+  s.licenses = ["MIT"]
   s.rdoc_options = ["--main", "README.md"]
   s.require_paths = ["lib"]
   s.required_ruby_version = Gem::Requirement.new(">= 2.0.0")

data/spec/memoist2_spec.rb

@@ -2,67 +2,144 @@ require 'memoist2'
 
 describe Memoist2 do
 
-  class Foo
-    extend Memoist2
-
-    def bar
-      count!
+  # used as base class for examples
+  class Counter
+    def initialize
+      @counter = 0
     end
-    memoize :bar
+    attr_reader :counter
 
-    def question?
-      count!
+    def count!
+      @counter += 1
     end
-    memoize :question?
+  end
 
-    def bang!
-      count!
+  describe "nil values" do
+    subject do
+      Class.new(Counter) do
+        include Memoist2
+
+        def nilly
+          count!
+          nil
+        end
+        memoize :nilly
+      end.new
     end
-    memoize :bang!
 
-    private
-
-    def count!
-      @count ||= 0
-      @count += 1
+    it "returns the expected value" do
+      5.times do
+        subject.nilly.should == nil
+      end
     end
 
-    class << self
-      extend Memoist2
-
-      def bar
-        @bar_count ||= 0
-        @bar_count += 1
-      end
-      memoize :bar
+    it "memoizes correctly" do
+      expect do
+        5.times{ subject.nilly }
+      end.to change{ subject.counter }.by(1)
     end
   end
 
   describe "instance methods" do
-    subject{ Foo.new }
+    subject do
+      Class.new(Counter) do
+        include Memoist2
+
+        def foo
+          count!
+          :bar
+        end
+        memoize :foo
+      end.new
+    end
+
+    it "returns the expected value" do
+      5.times do
+        subject.foo.should == :bar
+      end
+    end
 
-    it "can be memoized" do
-      subject.bar.should == subject.bar
+    it "memoizes correctly" do
+      expect do
+        5.times{ subject.foo }
+      end.to change{ subject.counter }.by(1)
     end
   end
 
   describe "class methods" do
-    subject{ Foo }
+    describe "using metaclass" do
+      subject do
+        Class.new do
+          class << self
+            include Memoist2
+
+            def foo
+              @counter ||= 0
+              @counter += 1
+            end
+            memoize :foo
+          end
+        end
+      end
 
-    it "can be memoized" do
-      subject.bar.should == subject.bar
+      it "works" do
+        5.times do
+          subject.foo.should == 1
+        end
+      end
+    end
+
+    describe "using memoize_class_method" do
+      subject do
+        Class.new do
+          include Memoist2
+
+          def self.foo
+            @counter ||= 0
+            @counter += 1
+          end
+          memoize_class_method :foo
+        end
+      end
+
+      it "works" do
+        5.times do
+          subject.foo.should == 1
+        end
+      end
     end
   end
 
   describe "punctuated methods" do
-    subject{ Foo.new }
+    subject do
+      Class.new do
+        include Memoist2
+
+        def question?
+          @question_calls ||= 0
+          @question_calls += 1
+        end
+        memoize :question?
+
+        def bang!
+          @bang_calls ||= 0
+          @bang_calls += 1
+        end
+        memoize :bang!
+
+      end.new
+    end
 
     it "can memoize question methods" do
-      subject.question?.should == subject.question?
+      5.times do
+        subject.question?.should == 1
+      end
     end
 
     it "can memoize bang methods" do
-      subject.bang!.should == subject.bang!
+      5.times do
+        subject.bang!.should == 1
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memoist2
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Matthew Rudy Jacobs