memoist 0.11.0 → 0.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ae4871b19ddf0826d00aed6706f6d4e18e87b1fc
-  data.tar.gz: 9f51de9a63090ec5e42ec3e17ca3188776f537a7
+SHA256:
+  metadata.gz: '058dae917e46d13306497f0bcd18df607cb1d5dca2d85ee6f9cbc18739172e27'
+  data.tar.gz: c0874b135f70db573a863e4b54bb141905c003d9e451d7c3637d8f67c96a0696
 SHA512:
-  metadata.gz: e2d53081c9d2c4041458aedd80ef01f4ac4933882edb08315081a8ec7846ef9dcad9730a8a21458a78ad78bc913c94ca6fd06f55376706b1c0ead43254090b91
-  data.tar.gz: 5ae1ffcf79b52f2d9b52aa59d66eeeaf7f1b1ad80a247d4549ac902ef1e2e7bdcc70c6429974faba32f085d5a5b0d859d5288927a043528718ce00d7c0ad0f55
+  metadata.gz: 409f37c0861015cc81704bf4fbbb1002d7a011a5f3dccb0e1430baf8b5eac601f5caae99cf4e1634fe044ea01123c1a0319692fad6d64c848026329f9a4dfa7a
+  data.tar.gz: 7f3134101c02c37ce88fd6a814c6bce19f5ffc4085fcfbb08e22ce720f125b7f8c2c2644c6a694cf4bb5dc4feb40974785f1209d598c18ba098bc055bca33146

data/.travis.yml

@@ -1,17 +1,21 @@
+sudo: false
+cache: bundler
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - 2.1.0
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-2
+  - 2.1.10
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+  - 2.5.1
+  - 2.6.0
   - ruby-head
+  - jruby-19mode
+  - jruby-9.1.9.0
   - jruby-head
-  - ree
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
+
+before_install:
+  - gem install bundler --no-document -v '~> 1.13'
+before_script:
+  - unset JRUBY_OPTS

data/CHANGELOG.md

@@ -0,0 +1,130 @@
+# Changelog
+
+## [Unreleased](https://github.com/matthewrudy/memoist/tree/HEAD)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/v0.16.1...HEAD)
+
+**Merged pull requests:**
+
+- Fix regression introduced by frozen symbol fix [\#86](https://github.com/matthewrudy/memoist/pull/86) ([sebjacobs](https://github.com/sebjacobs))
+
+## [v0.16.1](https://github.com/matthewrudy/memoist/tree/v0.16.1) (2019-11-08)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/v0.16.0...v0.16.1)
+
+**Merged pull requests:**
+
+- Remove ruby 1.9.2 from travis build matrix [\#84](https://github.com/matthewrudy/memoist/pull/84) ([unasuke](https://github.com/unasuke))
+- Make Memoist.escape\_punctuation compatible with MRI 2.7 [\#82](https://github.com/matthewrudy/memoist/pull/82) ([casperisfine](https://github.com/casperisfine))
+- add 2.5.1 to travis [\#77](https://github.com/matthewrudy/memoist/pull/77) ([matthewrudy](https://github.com/matthewrudy))
+- Remove ghit.me [\#74](https://github.com/matthewrudy/memoist/pull/74) ([matthewrudy](https://github.com/matthewrudy))
+- Place sample code for execution in README.md [\#73](https://github.com/matthewrudy/memoist/pull/73) ([3nan3](https://github.com/3nan3))
+- Require Ruby \>=1.9.2 [\#69](https://github.com/matthewrudy/memoist/pull/69) ([matthewrudy](https://github.com/matthewrudy))
+
+## [v0.16.0](https://github.com/matthewrudy/memoist/tree/v0.16.0) (2017-06-20)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/v0.15.0...v0.16.0)
+
+**Merged pull requests:**
+
+- Fix undefined `memoized\_methods` error raised when a parent class has not call `memoize` [\#68](https://github.com/matthewrudy/memoist/pull/68) ([PikachuEXE](https://github.com/PikachuEXE))
+- Add support for class-level cache flushing. [\#67](https://github.com/matthewrudy/memoist/pull/67) ([JoeMcB](https://github.com/JoeMcB))
+- Add ruby 2.4 to travis \(bump 2.2 and 2.3 versions\) [\#64](https://github.com/matthewrudy/memoist/pull/64) ([jrafanie](https://github.com/jrafanie))
+- Fix tests for Ruby \< 1.9.3 [\#56](https://github.com/matthewrudy/memoist/pull/56) ([matthewrudy](https://github.com/matthewrudy))
+- Add return in comments for `flush\_cache`. [\#55](https://github.com/matthewrudy/memoist/pull/55) ([joshuapinter](https://github.com/joshuapinter))
+- Update readme [\#53](https://github.com/matthewrudy/memoist/pull/53) ([biow0lf](https://github.com/biow0lf))
+
+## [v0.15.0](https://github.com/matthewrudy/memoist/tree/v0.15.0) (2016-08-23)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/v0.14.0...v0.15.0)
+
+**Merged pull requests:**
+
+- Remove test warnings [\#52](https://github.com/matthewrudy/memoist/pull/52) ([matthewrudy](https://github.com/matthewrudy))
+- Use SVG badge over PNG [\#44](https://github.com/matthewrudy/memoist/pull/44) ([olivierlacan](https://github.com/olivierlacan))
+
+## [v0.14.0](https://github.com/matthewrudy/memoist/tree/v0.14.0) (2015-12-15)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/v0.13.0...v0.14.0)
+
+**Merged pull requests:**
+
+- Faster2: Cache the method, ivar, and arity and the ancestry memoized methods [\#38](https://github.com/matthewrudy/memoist/pull/38) ([jrafanie](https://github.com/jrafanie))
+
+## [v0.13.0](https://github.com/matthewrudy/memoist/tree/v0.13.0) (2015-11-26)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/v0.12.0...v0.13.0)
+
+**Merged pull requests:**
+
+- Faster memoist with less object allocations [\#36](https://github.com/matthewrudy/memoist/pull/36) ([jrafanie](https://github.com/jrafanie))
+- Be optimistic about bundler version [\#35](https://github.com/matthewrudy/memoist/pull/35) ([lotyrin](https://github.com/lotyrin))
+- Add syntax highlighting for code blocks. [\#34](https://github.com/matthewrudy/memoist/pull/34) ([joshuapinter](https://github.com/joshuapinter))
+
+## [v0.12.0](https://github.com/matthewrudy/memoist/tree/v0.12.0) (2015-04-13)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/v0.11.0...v0.12.0)
+
+**Merged pull requests:**
+
+- Fix forking link [\#30](https://github.com/matthewrudy/memoist/pull/30) ([brandondrew](https://github.com/brandondrew))
+- Update README with :identifier info [\#29](https://github.com/matthewrudy/memoist/pull/29) ([fervic](https://github.com/fervic))
+
+## [v0.11.0](https://github.com/matthewrudy/memoist/tree/v0.11.0) (2014-10-10)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/v0.10.0...v0.11.0)
+
+**Merged pull requests:**
+
+- Call abs on arity when extracting reload [\#27](https://github.com/matthewrudy/memoist/pull/27) ([bradylove](https://github.com/bradylove))
+
+## [v0.10.0](https://github.com/matthewrudy/memoist/tree/v0.10.0) (2014-08-13)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/v0.9.3...v0.10.0)
+
+**Merged pull requests:**
+
+- Make memoize return a :symbol [\#24](https://github.com/matthewrudy/memoist/pull/24) ([matthewrudy](https://github.com/matthewrudy))
+- Use Minitest [\#19](https://github.com/matthewrudy/memoist/pull/19) ([matthewrudy](https://github.com/matthewrudy))
+
+## [v0.9.3](https://github.com/matthewrudy/memoist/tree/v0.9.3) (2014-06-01)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/v0.9.2...v0.9.3)
+
+**Merged pull requests:**
+
+- Remove Array caching hack [\#17](https://github.com/matthewrudy/memoist/pull/17) ([matthewrudy](https://github.com/matthewrudy))
+
+## [v0.9.2](https://github.com/matthewrudy/memoist/tree/v0.9.2) (2014-04-16)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/0.9.0...v0.9.2)
+
+**Merged pull requests:**
+
+- Give double-memoize errors their own error class [\#15](https://github.com/matthewrudy/memoist/pull/15) ([zachhale](https://github.com/zachhale))
+- Add tax-themed example for class method memoization fixes \#9 [\#10](https://github.com/matthewrudy/memoist/pull/10) ([fny](https://github.com/fny))
+
+## [0.9.0](https://github.com/matthewrudy/memoist/tree/0.9.0) (2013-03-20)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/0.2.0...0.9.0)
+
+**Merged pull requests:**
+
+- Update README.md to include memoization bypass description [\#6](https://github.com/matthewrudy/memoist/pull/6) ([andreychernih](https://github.com/andreychernih))
+- Adds a note about the MIT License [\#4](https://github.com/matthewrudy/memoist/pull/4) ([matiaskorhonen](https://github.com/matiaskorhonen))
+
+## [0.2.0](https://github.com/matthewrudy/memoist/tree/0.2.0) (2012-08-15)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/0.1.0...0.2.0)
+
+**Merged pull requests:**
+
+- Improved performance of flush\_cache and prime\_cache when parameters are passed to them. [\#2](https://github.com/matthewrudy/memoist/pull/2) ([jrafanie](https://github.com/jrafanie))
+
+## [0.1.0](https://github.com/matthewrudy/memoist/tree/0.1.0) (2012-01-24)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/7a5352d6b6c4219f37f329d2422985961c749748...0.1.0)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -1,7 +1,7 @@
 Memoist
 =============
 
-[![Build Status](https://travis-ci.org/matthewrudy/memoist.png?branch=master)](https://travis-ci.org/matthewrudy/memoist)
+[![Build Status](https://travis-ci.org/matthewrudy/memoist.svg?branch=master)](https://travis-ci.org/matthewrudy/memoist)
 
 Memoist is an extraction of ActiveSupport::Memoizable.
 
@@ -14,53 +14,91 @@ Usage
 
 Just extend with the Memoist module
 
-    require 'memoist'
-    class Person
-      extend Memoist
+```ruby
+require 'memoist'
+class Person
+  extend Memoist
 
-      def social_security
-        decrypt_social_security
-      end
-      memoize :social_security
-    end
+  def social_security
+    puts "execute!"
+    decrypt_social_security
+  end
+  memoize :social_security
+end
+
+person = Person.new
+
+person.social_security
+# execute!
+# => (returns decrypt_social_security)
+
+person.social_security
+# => (returns the memoized value)
+```
 
 And person.social_security will only be calculated once.
 
 Every memoized function (which initially was not accepting any arguments) has a ```(reload)```
 argument you can pass in to bypass and reset the memoization:
 
-    def some_method
-      Time.now
-    end
-    memoize :some_method
+```ruby
+def some_method
+  Time.now
+end
+memoize :some_method
+```
 
 Calling ```some_method``` will be memoized, but calling ```some_method(true)``` will rememoize each time.
 
 You can even memoize method that takes arguments.
 
-
-    class Person
-      def taxes_due(income)
-        income * 0.40
-      end
-      memoize :taxes_due
-    end
+```ruby
+class Person
+  def taxes_due(income)
+    income * 0.40
+  end
+  memoize :taxes_due
+end
+```
 
 This will only be calculated once per value of income.
 
 You can also memoize class methods.
 
-    class Person
-
-      class << self
-        extend Memoist
-        def with_overdue_taxes
-          # ...
-        end
-        memoize :with_overdue_taxes
-      end
+```ruby
+class Person
 
+  class << self
+    extend Memoist
+    def with_overdue_taxes
+      # ...
     end
+    memoize :with_overdue_taxes
+  end
+
+end
+```
+
+When a sub-class overrides one of its parent's methods and you need to memoize both. 
+Then you can use the `:identifier` parameter in order to help _Memoist_ distinguish between the two.
+
+```ruby
+class Clock
+  extend Memoist
+  def now
+     "The time now is #{Time.now.hour} o'clock and #{Time.now.min} minutes"
+  end
+  memoize :now
+end
+
+class AccurateClock < Clock
+  extend Memoist
+  def now
+    "#{super} and #{Time.now.sec} seconds"
+  end
+  memoize :now, :identifier => :accurate_clock
+end
+```
 
 
 Reload
@@ -68,17 +106,23 @@ Reload
 
 Each memoized function comes with a way to flush the existing value.
 
-    person.social_security       # returns the memoized value
-    person.social_security(true) # bypasses the memoized value and rememoizes it
+```ruby
+person.social_security       # returns the memoized value
+person.social_security(true) # bypasses the memoized value and rememoizes it
+```
 
 This also works with a memoized method with arguments
 
-    person.taxes_due(100_000)       # returns the memoized value
-    person.taxes_due(100_000, true) # bypasses the memoized value and rememoizes it
+```ruby
+person.taxes_due(100_000)       # returns the memoized value
+person.taxes_due(100_000, true) # bypasses the memoized value and rememoizes it
+```
 
 If you want to flush the entire memoization cache for an object
 
-    person.flush_cache
+```ruby
+person.flush_cache   # returns an array of flushed memoized methods, e.g. ["social_security", "some_method"]
+```
 
 Authors
 ===========
@@ -101,7 +145,7 @@ Everyone who contributed to it in the rails repository.
 Contributing
 ============
 
-1. Fork it ( http://github.com/<my-github-username>/memoist/fork )
+1. Fork it ( https://github.com/matthewrudy/memoist/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,11 +1,12 @@
 # encoding: utf-8
-require "bundler/gem_tasks"
 
-require "rake/testtask"
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
 Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
   t.verbose = true
 end
 
-task :default => ["test"]
+task default: ['test']

data/lib/memoist/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Memoist
-  VERSION = "0.11.0"
+  VERSION = '0.16.2'.freeze
 end

data/lib/memoist.rb

@@ -1,25 +1,53 @@
-require 'memoist/core_ext/singleton_class'
+# frozen_string_literal: true
+
+require 'memoist/version'
 
 module Memoist
+  def self.extended(extender)
+    Memoist.memoist_eval(extender) do
+      unless singleton_class.method_defined?(:memoized_methods)
+        def self.memoized_methods
+          @_memoized_methods ||= []
+        end
+      end
+    end
+  end
 
-  def self.memoized_ivar_for(method_name, identifier=nil)
-    ["@#{memoized_prefix(identifier)}", escape_punctuation(method_name.to_s)].join("_")
+  def self.memoized_ivar_for(method_name, identifier = nil)
+    "@#{memoized_prefix(identifier)}_#{escape_punctuation(method_name)}"
   end
 
-  def self.unmemoized_method_for(method_name, identifier=nil)
-    [unmemoized_prefix(identifier), method_name].join("_").to_sym
+  def self.unmemoized_method_for(method_name, identifier = nil)
+    "#{unmemoized_prefix(identifier)}_#{method_name}".to_sym
   end
 
-  def self.memoized_prefix(identifier=nil)
-    ["_memoized", identifier].compact.join("_")
+  def self.memoized_prefix(identifier = nil)
+    if identifier
+      "_memoized_#{identifier}"
+    else
+      '_memoized'.freeze
+    end
   end
 
-  def self.unmemoized_prefix(identifier=nil)
-    ["_unmemoized", identifier].compact.join("_")
+  def self.unmemoized_prefix(identifier = nil)
+    if identifier
+      "_unmemoized_#{identifier}"
+    else
+      '_unmemoized'.freeze
+    end
   end
 
   def self.escape_punctuation(string)
-    string.sub(/\?\Z/, '_query').sub(/!\Z/, '_bang')
+    string = string.is_a?(String) ? string.dup : string.to_s.dup
+
+    return string unless string.end_with?('?'.freeze, '!'.freeze)
+
+    # A String can't end in both ? and !
+    if string.sub!(/\?\Z/, '_query'.freeze)
+    else
+      string.sub!(/!\Z/, '_bang'.freeze)
+    end
+    string
   end
 
   def self.memoist_eval(klass, *args, &block)
@@ -46,47 +74,55 @@ module Memoist
       flush_cache
     end
 
-    def prime_cache(*method_names)
-      if method_names.empty?
-        prefix = Memoist.unmemoized_prefix+"_"
-        method_names = methods.collect do |method_name|
-          if method_name.to_s.start_with?(prefix)
-            method_name[prefix.length..-1]
-          end
-        end.compact
-      end
+    def memoized_structs(names)
+      ref_obj = self.class.respond_to?(:class_eval) ? singleton_class : self
+      structs = ref_obj.all_memoized_structs
+      return structs if names.empty?
+
+      structs.select { |s| names.include?(s.memoized_method) }
+    end
 
-      method_names.each do |method_name|
-        if method(Memoist.unmemoized_method_for(method_name)).arity == 0
-          __send__(method_name)
+    def prime_cache(*method_names)
+      memoized_structs(method_names).each do |struct|
+        if struct.arity == 0
+          __send__(struct.memoized_method)
         else
-          ivar = Memoist.memoized_ivar_for(method_name)
-          instance_variable_set(ivar, {})
+          instance_variable_set(struct.ivar, {})
         end
       end
     end
 
     def flush_cache(*method_names)
-      if method_names.empty?
-        prefix = Memoist.unmemoized_prefix+"_"
-        method_names = (methods + private_methods + protected_methods).collect do |method_name|
-          if method_name.to_s.start_with?(prefix)
-            method_name[prefix.length..-1]
-          end
-        end.compact
+      memoized_structs(method_names).each do |struct|
+        remove_instance_variable(struct.ivar) if instance_variable_defined?(struct.ivar)
       end
+    end
+  end
+
+  MemoizedMethod = Struct.new(:memoized_method, :ivar, :arity)
 
-      method_names.each do |method_name|
-        ivar = Memoist.memoized_ivar_for(method_name)
-        remove_instance_variable(ivar) if instance_variable_defined?(ivar)
+  def all_memoized_structs
+    @all_memoized_structs ||= begin
+      structs = memoized_methods.dup
+
+      # Collect the memoized_methods of ancestors in ancestor order
+      # unless we already have it since self or parents could be overriding
+      # an ancestor method.
+      ancestors.grep(Memoist).each do |ancestor|
+        ancestor.memoized_methods.each do |m|
+          structs << m unless structs.any? { |am| am.memoized_method == m.memoized_method }
+        end
       end
+      structs
     end
   end
 
+  def clear_structs
+    @all_memoized_structs = nil
+  end
+
   def memoize(*method_names)
-    if method_names.last.is_a?(Hash)
-      identifier = method_names.pop[:identifier]
-    end
+    identifier = method_names.pop[:identifier] if method_names.last.is_a?(Hash)
 
     method_names.each do |method_name|
       unmemoized_method = Memoist.unmemoized_method_for(method_name, identifier)
@@ -96,11 +132,14 @@ module Memoist
         include InstanceMethods
 
         if method_defined?(unmemoized_method)
-          raise AlreadyMemoizedError.new("Already memoized #{method_name}")
+          warn "Already memoized #{method_name}"
+          return
         end
         alias_method unmemoized_method, method_name
 
-        if instance_method(method_name).arity == 0
+        mm = MemoizedMethod.new(method_name, memoized_ivar, instance_method(method_name).arity)
+        memoized_methods << mm
+        if mm.arity == 0
 
           # define a method like this;
 
@@ -196,6 +235,4 @@ module Memoist
     # return a chainable method_name symbol if we can
     method_names.length == 1 ? method_names.first : method_names
   end
-
-  class AlreadyMemoizedError < RuntimeError; end
 end

data/memoist.gemspec

@@ -1,38 +1,46 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'memoist/version'
 
 AUTHORS = [
-  ["Joshua Peek",               "josh@joshpeek.com"],
-  ["Tarmo Tänav",               "tarmo@itech.ee"],
-  ["Jeremy Kemper",             "jeremy@bitsweat.net"],
-  ["Eugene Pimenov",            "libc@mac.com"],
-  ["Xavier Noria",              "fxn@hashref.com"],
-  ["Niels Ganser",              "niels@herimedia.co"],
-  ["Carl Lerche & Yehuda Katz", "wycats@gmail.com"],
-  ["jeem",                      "jeem@hughesorama.com"],
-  ["Jay Pignata",               "john.pignata@gmail.com"],
-  ["Damien Mathieu",            "42@dmathieu.com"],
-  ["José Valim",                "jose.valim@gmail.com"],
-  ["Matthew Rudy Jacobs",       "matthewrudyjacobs@gmail.com"],
-]
+  ['Joshua Peek',               'josh@joshpeek.com'],
+  ['Tarmo Tänav',               'tarmo@itech.ee'],
+  ['Jeremy Kemper',             'jeremy@bitsweat.net'],
+  ['Eugene Pimenov',            'libc@mac.com'],
+  ['Xavier Noria',              'fxn@hashref.com'],
+  ['Niels Ganser',              'niels@herimedia.co'],
+  ['Carl Lerche & Yehuda Katz', 'wycats@gmail.com'],
+  ['jeem',                      'jeem@hughesorama.com'],
+  ['Jay Pignata',               'john.pignata@gmail.com'],
+  ['Damien Mathieu',            '42@dmathieu.com'],
+  ['José Valim',                'jose.valim@gmail.com'],
+  ['Matthew Rudy Jacobs',       'matthewrudyjacobs@gmail.com']
+].freeze
 
 Gem::Specification.new do |spec|
-  spec.name          = "memoist"
+  spec.name          = 'memoist'
   spec.version       = Memoist::VERSION
-  spec.authors       = AUTHORS.map{ |name, email| name }
-  spec.email         = AUTHORS.map{ |name, email| email }
-  spec.summary       = %q{memoize methods invocation}
-  spec.homepage      = "https://github.com/matthewrudy/memoist"
-  spec.license       = "MIT"
+  spec.authors       = AUTHORS.map { |name, _email| name }
+  spec.email         = AUTHORS.map { |_name, email| email }
+  spec.summary       = 'memoize methods invocation'
+  spec.homepage      = 'https://github.com/matthewrudy/memoist'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.2'
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest", "~> 3.0"
+  spec.add_development_dependency 'benchmark-ips'
+  spec.add_development_dependency 'bundler'
+  if RUBY_VERSION < '1.9.3'
+    spec.add_development_dependency 'rake', '~> 10.4'
+  else
+    spec.add_development_dependency 'rake'
+  end
+  spec.add_development_dependency 'minitest', '~> 5.10'
 end

data/script/benchmark.rb

@@ -0,0 +1,48 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'benchmark/ips'
+
+require 'memoist'
+
+class Benchy
+  extend Memoist
+
+  def arity_0
+    'Hello World'
+  end
+  memoize :arity_0
+
+  def arity_1(name)
+    "Hello #{name}"
+  end
+  memoize :arity_1
+end
+
+OBJECT = Benchy.new
+
+puts "Benchmarking: #{Memoist::VERSION}"
+
+Benchmark.ips do |x|
+  x.report('arity 0 - memoized') do |times|
+    times.times do
+      OBJECT.arity_0
+    end
+  end
+
+  # x.report("arity 0 - unmemoized") do |times|
+  #   times.times do
+  #     OBJECT._unmemoized_arity_0
+  #   end
+  # end
+
+  x.report('arity 1 - memoized') do |times|
+    times.times do
+      OBJECT.arity_1(:World)
+    end
+  end
+
+  # x.report("arity 1 - unmemoized") do |times|
+  #   times.times do
+  #     OBJECT._unmemoized_arity_1(:World)
+  #   end
+  # end
+end

data/test/memoist_test.rb

@@ -1,10 +1,8 @@
 require 'test_helper'
 require 'memoist'
 
-class MemoistTest < Minitest::Unit::TestCase
-
+class MemoistTest < Minitest::Test
   class CallCounter
-
     def initialize
       @calls = {}
     end
@@ -17,7 +15,6 @@ class MemoistTest < Minitest::Unit::TestCase
     def count(method_name)
       @calls[method_name] ||= 0
     end
-
   end
 
   class Person
@@ -49,7 +46,7 @@ class MemoistTest < Minitest::Unit::TestCase
 
     def name
       @counter.call(:name)
-      "Josh"
+      'Josh'
     end
 
     def name?
@@ -58,8 +55,8 @@ class MemoistTest < Minitest::Unit::TestCase
     end
     memoize :name?
 
-    def update(name)
-      "Joshua"
+    def update(_name)
+      'Joshua'
     end
     memoize :update
 
@@ -70,6 +67,12 @@ class MemoistTest < Minitest::Unit::TestCase
 
     memoize :name, :age
 
+    def age?
+      @counter.call(:age?)
+      true
+    end
+    memoize 'age?'
+
     def sleep(hours = 8)
       @counter.call(:sleep)
       hours
@@ -80,7 +83,7 @@ class MemoistTest < Minitest::Unit::TestCase
       @counter.count(:sleep)
     end
 
-    def update_attributes(options = {})
+    def update_attributes(_options = {})
       @counter.call(:update_attributes)
       true
     end
@@ -101,7 +104,7 @@ class MemoistTest < Minitest::Unit::TestCase
 
     def is_developer?
       @counter.call(:is_developer?)
-      "Yes"
+      'Yes'
     end
     memoize :is_developer?
   end
@@ -111,7 +114,14 @@ class MemoistTest < Minitest::Unit::TestCase
       @counter.call(:student_name)
       "Student #{super}"
     end
-    memoize :name, :identifier => :student
+    memoize :name, identifier: :student
+  end
+
+  class Teacher < Person
+    def seniority
+      'very_senior'
+    end
+    memoize :seniority
   end
 
   class Company
@@ -122,7 +132,7 @@ class MemoistTest < Minitest::Unit::TestCase
 
     def name
       @name_calls += 1
-      "37signals"
+      '37signals'
     end
   end
 
@@ -174,16 +184,68 @@ class MemoistTest < Minitest::Unit::TestCase
     memoize :counter
   end
 
+  class Book
+    extend Memoist
+    STATUSES = %w[new used].freeze
+    CLASSIFICATION = %w[fiction nonfiction].freeze
+    GENRES = %w[humor romance reference sci-fi classic philosophy].freeze
+
+    attr_reader :title, :author
+    def initialize(title, author)
+      @title = title
+      @author = author
+    end
+
+    def full_title
+      "#{@title} by #{@author}"
+    end
+    memoize :full_title
+
+    class << self
+      extend Memoist
+
+      def all_types
+        STATUSES.product(CLASSIFICATION).product(GENRES).collect(&:flatten)
+      end
+      memoize :all_types
+    end
+  end
+
+  class Abb
+    extend Memoist
+
+    def run(*_args)
+      flush_cache if respond_to?(:flush_cache)
+      execute
+    end
+
+    def execute
+      some_method
+    end
+
+    def some_method
+      # Override this
+    end
+  end
+
+  class Bbb < Abb
+    def some_method
+      :foo
+    end
+    memoize :some_method
+  end
+
   def setup
     @person = Person.new
     @calculator = Calculator.new
+    @book = Book.new('My Life', "Brian 'Fudge' Turmuck")
   end
 
   def test_memoization
-    assert_equal "Josh", @person.name
+    assert_equal 'Josh', @person.name
     assert_equal 1, @person.name_calls
 
-    3.times { assert_equal "Josh", @person.name }
+    3.times { assert_equal 'Josh', @person.name }
     assert_equal 1, @person.name_calls
   end
 
@@ -199,13 +261,13 @@ class MemoistTest < Minitest::Unit::TestCase
   end
 
   def test_memoize_with_options_hash
-    assert_equal true, @person.update_attributes(:age => 21, :name => 'James')
+    assert_equal true, @person.update_attributes(age: 21, name: 'James')
     assert_equal 1, @person.update_attributes_calls
 
-    3.times { assert_equal true, @person.update_attributes(:age => 21, :name => 'James') }
+    3.times { assert_equal true, @person.update_attributes(age: 21, name: 'James') }
     assert_equal 1, @person.update_attributes_calls
 
-    3.times { assert_equal true, @person.update_attributes({:age => 21, :name => 'James'}, :reload) }
+    3.times { assert_equal true, @person.update_attributes({ age: 21, name: 'James' }, :reload) }
     assert_equal 4, @person.update_attributes_calls
   end
 
@@ -216,6 +278,13 @@ class MemoistTest < Minitest::Unit::TestCase
     @person.unmemoize_all
   end
 
+  def test_memoization_when_memoize_is_called_with_punctuated_string
+    assert_equal true, @person.age?
+
+    @person.memoize_all
+    @person.unmemoize_all
+  end
+
   def test_memoization_flush_with_punctuation
     assert_equal true, @person.name?
     @person.flush_cache(:name?)
@@ -224,10 +293,10 @@ class MemoistTest < Minitest::Unit::TestCase
   end
 
   def test_memoization_with_nil_value
-    assert_equal nil, @person.age
+    assert_nil @person.age
     assert_equal 1, @person.age_calls
 
-    3.times { assert_equal nil, @person.age }
+    3.times { assert_nil @person.age }
     assert_equal 1, @person.age_calls
   end
 
@@ -244,26 +313,116 @@ class MemoistTest < Minitest::Unit::TestCase
 
     assert @calculator.instance_variable_get(:@_memoized_counter)
     @calculator.flush_cache(:counter)
-    assert_nil @calculator.instance_variable_get(:@_memoized_counter)
-    assert !@calculator.instance_variable_defined?(:@_memoized_counter)
+    assert_equal false, @calculator.instance_variable_defined?(:@_memoized_counter)
 
     assert_equal 2, @calculator.counter
   end
 
+  def test_class_flush_cache
+    @book.memoize_all
+    assert_equal "My Life by Brian 'Fudge' Turmuck", @book.full_title
+
+    Book.memoize_all
+    assert_instance_of Array, Book.instance_variable_get(:@_memoized_all_types)
+    Book.flush_cache
+    assert_equal false, Book.instance_variable_defined?(:@_memoized_all_types)
+  end
+
+  def test_class_flush_cache_preserves_instances
+    @book.memoize_all
+    Book.memoize_all
+    assert_equal "My Life by Brian 'Fudge' Turmuck", @book.full_title
+
+    Book.flush_cache
+    assert_equal false, Book.instance_variable_defined?(:@_memoized_all_types)
+    assert_equal "My Life by Brian 'Fudge' Turmuck", @book.full_title
+  end
+
+  def test_flush_cache_in_child_class
+    x = Bbb.new
+
+    # This should not throw error
+    x.run
+  end
+
   def test_unmemoize_all
     assert_equal 1, @calculator.counter
 
+    assert_equal true, @calculator.instance_variable_defined?(:@_memoized_counter)
     assert @calculator.instance_variable_get(:@_memoized_counter)
     @calculator.unmemoize_all
-    assert_nil @calculator.instance_variable_get(:@_memoized_counter)
-    assert !@calculator.instance_variable_defined?(:@_memoized_counter)
+    assert_equal false, @calculator.instance_variable_defined?(:@_memoized_counter)
 
     assert_equal 2, @calculator.counter
   end
 
+  def test_all_memoized_structs
+    # Person             memoize :age, :age?, :is_developer?, :memoize_protected_test, :name, :name?, :sleep, :update, :update_attributes
+    # Student < Person   memoize :name, :identifier => :student
+    # Teacher < Person   memoize :seniority
+
+    expected = %w[age age? is_developer? memoize_protected_test name name? sleep update update_attributes]
+    structs = Person.all_memoized_structs
+    assert_equal expected, structs.collect(&:memoized_method).collect(&:to_s).sort
+    assert_equal '@_memoized_name', structs.detect { |s| s.memoized_method == :name }.ivar
+
+    # Same expected methods
+    structs = Student.all_memoized_structs
+    assert_equal expected, structs.collect(&:memoized_method).collect(&:to_s).sort
+    assert_equal '@_memoized_student_name', structs.detect { |s| s.memoized_method == :name }.ivar
+
+    expected = (expected << 'seniority').sort
+    structs = Teacher.all_memoized_structs
+    assert_equal expected, structs.collect(&:memoized_method).collect(&:to_s).sort
+    assert_equal '@_memoized_name', structs.detect { |s| s.memoized_method == :name }.ivar
+  end
+
+  def test_unmemoize_all_subclasses
+    # Person             memoize :age, :is_developer?, :memoize_protected_test, :name, :name?, :sleep, :update, :update_attributes
+    # Student < Person   memoize :name, :identifier => :student
+    # Teacher < Person   memoize :seniority
+
+    teacher = Teacher.new
+    assert_equal 'Josh', teacher.name
+    assert_equal 'Josh', teacher.instance_variable_get(:@_memoized_name)
+    assert_equal 'very_senior', teacher.seniority
+    assert_equal 'very_senior', teacher.instance_variable_get(:@_memoized_seniority)
+
+    teacher.unmemoize_all
+    assert_equal false, teacher.instance_variable_defined?(:@_memoized_name)
+    assert_equal false, teacher.instance_variable_defined?(:@_memoized_seniority)
+
+    student = Student.new
+    assert_equal 'Student Josh', student.name
+    assert_equal 'Student Josh', student.instance_variable_get(:@_memoized_student_name)
+    assert_equal false, student.instance_variable_defined?(:@_memoized_seniority)
+
+    student.unmemoize_all
+    assert_equal false, @calculator.instance_variable_defined?(:@_memoized_student_name)
+  end
+
   def test_memoize_all
     @calculator.memoize_all
-    assert @calculator.instance_variable_defined?(:@_memoized_counter)
+    assert_equal true, @calculator.instance_variable_defined?(:@_memoized_counter)
+  end
+
+  def test_memoize_all_subclasses
+    # Person             memoize :age, :is_developer?, :memoize_protected_test, :name, :name?, :sleep, :update, :update_attributes
+    # Student < Person   memoize :name, :identifier => :student
+    # Teacher < Person   memoize :seniority
+
+    teacher = Teacher.new
+    teacher.memoize_all
+
+    assert_equal 'very_senior', teacher.instance_variable_get(:@_memoized_seniority)
+    assert_equal 'Josh', teacher.instance_variable_get(:@_memoized_name)
+
+    student = Student.new
+    student.memoize_all
+
+    assert_equal 'Student Josh', student.instance_variable_get(:@_memoized_student_name)
+    assert_equal 'Student Josh', student.name
+    assert_equal false, student.instance_variable_defined?(:@_memoized_seniority)
   end
 
   def test_memoization_cache_is_different_for_each_instance
@@ -272,10 +431,20 @@ class MemoistTest < Minitest::Unit::TestCase
     assert_equal 1, Calculator.new.counter
   end
 
+  def test_memoization_class_variables
+    @book.memoize_all
+    assert_equal "My Life by Brian 'Fudge' Turmuck", @book.instance_variable_get(:@_memoized_full_title)
+    assert_equal "My Life by Brian 'Fudge' Turmuck", @book.full_title
+
+    Book.memoize_all
+    assert_instance_of Array, Book.instance_variable_get(:@_memoized_all_types)
+    assert_equal 24, Book.all_types.count
+  end
+
   def test_memoized_is_not_affected_by_freeze
     @person.freeze
-    assert_equal "Josh", @person.name
-    assert_equal "Joshua", @person.update("Joshua")
+    assert_equal 'Josh', @person.name
+    assert_equal 'Joshua', @person.update('Joshua')
   end
 
   def test_memoization_with_args
@@ -302,9 +471,9 @@ class MemoistTest < Minitest::Unit::TestCase
       company.extend Memoist
       company.memoize :name
 
-      assert_equal "37signals", company.name
+      assert_equal '37signals', company.name
       assert_equal 1, company.name_calls
-      assert_equal "37signals", company.name
+      assert_equal '37signals', company.name
       assert_equal 1, company.name_calls
     end
   end
@@ -330,20 +499,30 @@ class MemoistTest < Minitest::Unit::TestCase
     assert_equal 2, company.sales_tax_calls
   end
 
-  def test_double_memoization
-    assert_raises(Memoist::AlreadyMemoizedError) { Person.memoize :name }
-    person = Person.new
-    person.extend Memoist
-    assert_raises(Memoist::AlreadyMemoizedError) { person.memoize :name }
-
-    company = Company.new
-    company.extend Memoist
-    company.memoize :name
-    assert_raises(Memoist::AlreadyMemoizedError) { company.memoize :name }
-  end
-
   def test_double_memoization_with_identifier
-    Person.memoize :name, :identifier => :again
+    # Person             memoize :age, :is_developer?, :memoize_protected_test, :name, :name?, :sleep, :update, :update_attributes
+    # Student < Person   memoize :name, :identifier => :student
+    # Teacher < Person   memoize :seniority
+
+    Person.memoize :name, identifier: :again
+    p = Person.new
+    assert_equal 'Josh', p.name
+    assert p.instance_variable_get(:@_memoized_again_name)
+
+    # HACK: tl;dr: Don't memoize classes in test that are used elsewhere.
+    # Calling Person.memoize :name, :identifier => :again pollutes Person
+    # and descendents since we cache the memoized method structures.
+    # This populates those structs, verifies Person is polluted, resets the
+    # structs, cleans up cached memoized_methods
+    Student.all_memoized_structs
+    Person.all_memoized_structs
+    Teacher.all_memoized_structs
+    assert Person.memoized_methods.any? { |m| m.ivar == '@_memoized_again_name' }
+
+    [Student, Teacher, Person].each(&:clear_structs)
+    assert Person.memoized_methods.reject!      { |m| m.ivar == '@_memoized_again_name' }
+    assert_nil Student.memoized_methods.reject! { |m| m.ivar == '@_memoized_again_name' }
+    assert_nil Teacher.memoized_methods.reject! { |m| m.ivar == '@_memoized_again_name' }
   end
 
   def test_memoization_with_a_subclass
@@ -356,7 +535,9 @@ class MemoistTest < Minitest::Unit::TestCase
 
   def test_memoization_is_chainable
     klass = Class.new do
-      def foo; "bar"; end
+      def foo
+        'bar'
+      end
     end
     klass.extend Memoist
     chainable = klass.memoize :foo
@@ -367,17 +548,16 @@ class MemoistTest < Minitest::Unit::TestCase
     person = Person.new
 
     assert_raises(NoMethodError) { person.memoize_protected_test }
-    assert_equal "protected", person.send(:memoize_protected_test)
+    assert_equal 'protected', person.send(:memoize_protected_test)
   end
 
   def test_private_method_memoization
     person = Person.new
 
     assert_raises(NoMethodError) { person.is_developer? }
-    assert_equal "Yes", person.send(:is_developer?)
+    assert_equal 'Yes', person.send(:is_developer?)
     assert_equal 1, person.is_developer_calls
-    assert_equal "Yes", person.send(:is_developer?)
+    assert_equal 'Yes', person.send(:is_developer?)
     assert_equal 1, person.is_developer_calls
   end
-
 end

data/test/test_helper.rb

@@ -1,3 +1,3 @@
 require 'minitest/autorun'
 
-$:.unshift File.expand_path(File.dirname(__FILE__)+"/../lib")
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memoist
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.16.2
 platform: ruby
 authors:
 - Joshua Peek
@@ -19,22 +19,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2019-12-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -55,14 +69,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.10'
 description: 
 email:
 - josh@joshpeek.com
@@ -83,14 +97,15 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
 - lib/memoist.rb
-- lib/memoist/core_ext/singleton_class.rb
 - lib/memoist/version.rb
 - memoist.gemspec
+- script/benchmark.rb
 - test/memoist_test.rb
 - test/test_helper.rb
 homepage: https://github.com/matthewrudy/memoist
@@ -105,15 +120,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: memoize methods invocation

data/lib/memoist/core_ext/singleton_class.rb

@@ -1,8 +0,0 @@
-module Kernel
-  # Returns the object's singleton class.
-  def singleton_class
-    class << self
-      self
-    end
-  end unless respond_to?(:singleton_class) # exists in 1.9.2
-end