memoist3 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5a3431c7281f1d17a7c65861c9fb58e224b834c388774ad9a2f8e60e007b692
+  data.tar.gz: 96d5b1ba4fae250ad6b01f502041c9815e03868da2bc49cce47eb18c7ba821ea
+SHA512:
+  metadata.gz: 65c4bf3637903fb83ea41f8b0a0a2a961d4ef5e733789f6cf5bdb2df65487fb515ae2deab75de6cdf70ab8ed5c743d6d4805d6f8cb2a79c0ce9ba88885689d98
+  data.tar.gz: 7df1a03a1951477837bbe5990c10e71045766f67ade3930b498ea4c6ae7fe9fc0599fff04badeb64f3008a0aa74f9fc61c6c743f614774328ab6dee2743376e3

data/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: ci
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: 2.7.2
+          - ruby: 2.7.5
+          - ruby: 3.0.1
+          - ruby: 3.0.3
+          - ruby: ruby-head
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install rvm
+      run: |
+        curl -sSL https://get.rvm.io | bash
+    - name: Install ruby
+      run: |
+        source $HOME/.rvm/scripts/rvm
+        rvm use ${{ matrix.ruby }} --default --install --binary --fuzzy --create
+    - name: Check ruby version
+      run: |
+        source $HOME/.rvm/scripts/rvm
+        ruby --version
+    - name: Update rubygems
+      run: |
+        source $HOME/.rvm/scripts/rvm
+        gem update --system ${{ matrix.rubygems }}
+    - name: Install bundler
+      run: |
+        source $HOME/.rvm/scripts/rvm
+        gem install bundler --no-document -v '~> 1.13'
+    - name: Install gems
+      run: |
+        source $HOME/.rvm/scripts/rvm
+        bundle install --jobs 4
+    - run: unset JRUBY_OPTS
+    - name: Run rake
+      run: |
+        source $HOME/.rvm/scripts/rvm
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,136 @@
+# Changelog
+
+## [v1.0.0](https://github.com/honzasterba/memoist/tree/v0.16.2) (2022-01-09)
+
+[Full Changelog](https://github.com/matthewrudy/honzasterba/compare/v0.16.1...v1.0.0)
+
+- support for Ruby 3 kwargs
+
+## [v0.16.2](https://github.com/matthewrudy/memoist/tree/v0.16.2) (2019-12-04)
+
+[Full Changelog](https://github.com/matthewrudy/memoist/compare/v0.16.1...v0.16.2)
+
+**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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in memoist.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2012-2013 Matthew Rudy Jacobs
+
+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,172 @@
+This is a fork of the original repo by [matthewrudy](https://github.com/matthewrudy/memoist) 
+adapted for usage with Ruby 3.
+
+# Memoist
+
+[![Gem Version](https://badge.fury.io/rb/memoist3.svg)](https://badge.fury.io/rb/memoist3)
+[![Build Status](https://github.com/honzasterba/memoist/workflows/ci/badge.svg)](https://github.com/honzasterba/memoist/actions)
+
+Memoist is an extraction of ActiveSupport::Memoizable.
+
+Since June 2011 ActiveSupport::Memoizable has been deprecated.
+But I love it, and so I plan to keep it alive.
+
+## Installation
+
+```bash
+bundle add memoist3
+```
+
+or
+
+```ruby
+gem 'memoist3'
+```
+
+## Supported Rubies
+
+This library supports
+
+ - MRI Ruby 2 (>= 2.7.2)
+ - MRI Ruby 3 (>= 3.0.0)
+
+## Usage
+
+Just extend with the Memoist module
+
+```ruby
+require 'memoist'
+class Person
+  extend Memoist
+
+  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:
+
+```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.
+
+```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.
+
+```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
+
+Each memoized function comes with a way to flush the existing value.
+
+```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
+
+```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
+
+```ruby
+person.flush_cache   # returns an array of flushed memoized methods, e.g. ["social_security", "some_method"]
+```
+
+# Authors
+
+Everyone who contributed to it in the rails repository.
+
+- Joshua Peek
+- Tarmo Tänav
+- Jeremy Kemper
+- Eugene Pimenov
+- Xavier Noria
+- Niels Ganser
+- Carl Lerche & Yehuda Katz
+- jeem
+- Jay Pignata
+- Damien Mathieu
+- José Valim
+- Matthew Rudy Jacobs
+
+# Contributing
+
+1. Fork it ( https://github.com/honzasterba/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`)
+5. Create new Pull Request
+
+# License
+
+Released under the [MIT License](http://www.opensource.org/licenses/MIT), just as Ruby on Rails is.

data/Rakefile

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

data/lib/memoist/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Memoist
+  VERSION = '1.0.0'
+end

data/lib/memoist.rb

@@ -0,0 +1,238 @@
+# 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)}"
+  end
+
+  def self.unmemoized_method_for(method_name, identifier = nil)
+    "#{unmemoized_prefix(identifier)}_#{method_name}".to_sym
+  end
+
+  def self.memoized_prefix(identifier = nil)
+    if identifier
+      "_memoized_#{identifier}"
+    else
+      '_memoized'.freeze
+    end
+  end
+
+  def self.unmemoized_prefix(identifier = nil)
+    if identifier
+      "_unmemoized_#{identifier}"
+    else
+      '_unmemoized'.freeze
+    end
+  end
+
+  def self.escape_punctuation(string)
+    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, **kwargs, &block)
+    if klass.respond_to?(:class_eval)
+      klass.class_eval(*args, **kwargs, &block)
+    else
+      klass.singleton_class.class_eval(*args, **kwargs, &block)
+    end
+  end
+
+  def self.extract_reload!(method, args)
+    if args.length == method.arity.abs + 1 && (args.last == true || args.last == :reload)
+      reload = args.pop
+    end
+    reload
+  end
+
+  module InstanceMethods
+    def memoize_all
+      prime_cache
+    end
+
+    def unmemoize_all
+      flush_cache
+    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
+
+    def prime_cache(*method_names)
+      memoized_structs(method_names).each do |struct|
+        if struct.arity == 0
+          __send__(struct.memoized_method)
+        else
+          instance_variable_set(struct.ivar, {})
+        end
+      end
+    end
+
+    def flush_cache(*method_names)
+      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)
+
+  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)
+    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)
+      memoized_ivar = Memoist.memoized_ivar_for(method_name, identifier)
+
+      Memoist.memoist_eval(self) do
+        include InstanceMethods
+
+        if method_defined?(unmemoized_method)
+          warn "Already memoized #{method_name}"
+          return
+        end
+        alias_method unmemoized_method, method_name
+
+        mm = MemoizedMethod.new(method_name, memoized_ivar, instance_method(method_name).arity)
+        memoized_methods << mm
+        if mm.arity == 0
+
+          # define a method like this;
+
+          # def mime_type(reload=true)
+          #   skip_cache = reload || !instance_variable_defined?("@_memoized_mime_type")
+          #   set_cache = skip_cache && !frozen?
+          #
+          #   if skip_cache
+          #     value = _unmemoized_mime_type
+          #   else
+          #     value = @_memoized_mime_type
+          #   end
+          #
+          #   if set_cache
+          #     @_memoized_mime_type = value
+          #   end
+          #
+          #   value
+          # end
+
+          module_eval <<-EOS, __FILE__, __LINE__ + 1
+            def #{method_name}(reload = false)
+              skip_cache = reload || !instance_variable_defined?("#{memoized_ivar}")
+              set_cache = skip_cache && !frozen?
+
+              if skip_cache
+                value = #{unmemoized_method}
+              else
+                value = #{memoized_ivar}
+              end
+
+              if set_cache
+                #{memoized_ivar} = value
+              end
+
+              value
+            end
+          EOS
+        else
+
+          # define a method like this;
+
+          # def mime_type(*args)
+          #   reload = Memoist.extract_reload!(method(:_unmemoized_mime_type), args)
+          #
+          #   skip_cache = reload || !memoized_with_args?(:mime_type, args)
+          #   set_cache = skip_cache && !frozen
+          #
+          #   if skip_cache
+          #     value = _unmemoized_mime_type(*args)
+          #   else
+          #     value = @_memoized_mime_type[args]
+          #   end
+          #
+          #   if set_cache
+          #     @_memoized_mime_type ||= {}
+          #     @_memoized_mime_type[args] = value
+          #   end
+          #
+          #   value
+          # end
+
+          module_eval <<-EOS, __FILE__, __LINE__ + 1
+            def #{method_name}(*args, **kwargs)
+              reload = Memoist.extract_reload!(method(#{unmemoized_method.inspect}), args)
+
+              skip_cache = reload || !(instance_variable_defined?(#{memoized_ivar.inspect}) && #{memoized_ivar} && #{memoized_ivar}.has_key?(args+kwargs.to_a))
+              set_cache = skip_cache && !frozen?
+
+              if skip_cache
+                value = #{unmemoized_method}(*args, **kwargs)
+              else
+                value = #{memoized_ivar}[args+kwargs.to_a]
+              end
+
+              if set_cache
+                #{memoized_ivar} ||= {}
+                #{memoized_ivar}[args+kwargs.to_a] = value
+              end
+
+              value
+            end
+          EOS
+        end
+
+        if private_method_defined?(unmemoized_method)
+          private method_name
+        elsif protected_method_defined?(unmemoized_method)
+          protected method_name
+        end
+      end
+    end
+    # return a chainable method_name symbol if we can
+    method_names.length == 1 ? method_names.first : method_names
+  end
+end