memo_wise 1.1.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fa12aeb35a6c4ca923eb23d70867b41600795143570f3d7c5b6444c76547980
-  data.tar.gz: bac4074e758731ac5d20925ab32ef3cd78d10a1c030228df76c1868e104e1a40
+  metadata.gz: 9d94c6c36ed049177dffb78f2bc5b0196d06e7b334643770163b7140ee2e77e2
+  data.tar.gz: 2be9bd8578a7357aabe70d9f748cb57fedf50708028ca7c3ed55815814b7ddc2
 SHA512:
-  metadata.gz: 52e8b1543bca54371a2743fbc22b3cee32ba68a050ac414e373ca2027faba214956bca3aef61a05d25ca1d339b3e4ae01a417cdb5d1a4a407fba16b0a3cae56e
-  data.tar.gz: 1bc40ccaab12ed598cc86d62d51ca8081a386b208559ac49788ff87601c45809958c2e936692fbb2e78f3ff0f04b124636f795d941558239fc20edf04f7b979b
+  metadata.gz: 848080fdd9596f0a0f477464ddbc2009ab2c5f3caec56d3fa3c97dd275aca7687c94793af8124a7dd567a1c33abcdf3474cb2e13ab6b8b91f47302a0059b6916
+  data.tar.gz: e79de4347bbc5cd0701095574dfb7faafb320dc3f6e1de1cb0978ebd1fcdce5e65ca0c8fa2e0079d72385acabea582caac41a0c6c553078f69d1337006422e0e

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,4 @@
 **Before merging:**
 
-- [ ] Copy the latest benchmark results into the `README.md` and update this PR
-- [ ] If this change merits an update to `CHANGELOG.md`, add an entry following Keep a Changelog [guidelines](https://keepachangelog.com/en/1.0.0/) with [semantic versioning](https://semver.org/)
+- [ ] Copy the table printed at the end of the latest benchmark results into the `README.md` and update this PR
+- [ ] If this change merits an update to `CHANGELOG.md`, add an entry following Keep a Changelog [guidelines](https://keepachangelog.com/en/1.0.0/) with [semantic versioning](https://semver.org/)

data/.github/workflows/main.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [jruby, 2.4, 2.5, 2.6, 2.7, 3.0]
+        ruby: [jruby, 2.4, 2.5, 2.6, 2.7, 3.0, truffleruby-head]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -1,5 +1,17 @@
 inherit_gem:
-  panolint: rubocop.yml
+  panolint: panolint-rubocop.yml
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
 
 Style/DocumentDynamicEvalDefinition:
   Enabled: false
+
+Style/MultipleComparison:
+  Enabled: false

data/CHANGELOG.md

@@ -6,24 +6,59 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+
+- Nothing yet!
+
+## [1.5.0] - 2021-12-17
+
+- Remove optimization for truthy results to fix race condition bugs
+- Switch to a simpler internal data structure to fix several classes of bugs
+  that the previous few versions were unable to sufficiently address
+
+## [1.4.0] - 2021-12-10
+
+### Fixed
+
+- Fix several bugs related to classes inheriting memoized methods
+  from multiple modules or a parent class ([#241](https://github.com/panorama-ed/memo_wise/pull/241))
+
+## [1.3.0] - 2021-11-22
+
+### Fixed
+
+- Fix thread-safety issue in concurrent calls to zero-arg method in unmemoized
+  state which resulted in a `nil` value being accidentally returned in one thread
+- Fix bugs related to child classes inheriting from parent classes that use
+  `MemoWise`
+
+## [1.2.0] - 2021-11-10
+
 ### Updated
-- (Nothing, yet)
+- Improved performance of all methods by using an outer Array instead of a Hash
+- Improved performance for multi-argument methods and simplify internal data
+  structures
+
 ### Fixed
-- (Nothing, yet)
+- Removed use of #hash due to potential of hash collisions
+- Updated internal local variable names to avoid name collisions with method
+  arguments
+
 ### Breaking Changes
 - None
 
 ## [1.1.0] - 2021-07-29
 ### Updated
-- Improve performance across the board by:
+- Improved performance across the board by:
   - removing `Hash#fetch`
   - using `Array#hash`
   - avoiding multi-layer hash lookups for multi-argument methods
   - optimizing for truthy results
 - Add `dry-core` to benchmarks in README
+
 ### Fixed
-- Fix usage on module singleton classes
-- Fix usage on module which would be extended by other classes
+- Fixed usage on module singleton classes
+- Fixed usage on module which would be extended by other classes
+
 ### Breaking Changes
 - None
 
@@ -31,6 +66,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Support for `.preset_memo_wise` on class methods
 - Support for `.reset_memo_wise` on class methods
+
 ### Updated
 - Improved performance for common cases by reducing array allocations
 
@@ -80,7 +116,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Panolint
 - Dependabot setup
 
-[Unreleased]: https://github.com/panorama-ed/memo_wise/compare/v1.1.0...HEAD
+[Unreleased]: https://github.com/panorama-ed/memo_wise/compare/v1.5.0...HEAD
+[1.5.0]: https://github.com/panorama-ed/memo_wise/compare/v1.4.0...v1.5.0
+[1.4.0]: https://github.com/panorama-ed/memo_wise/compare/v1.3.0...v1.4.0
+[1.3.0]: https://github.com/panorama-ed/memo_wise/compare/v1.2.0...v1.3.0
+[1.2.0]: https://github.com/panorama-ed/memo_wise/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/panorama-ed/memo_wise/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/panorama-ed/memo_wise/compare/v0.4.0...v1.0.0
 [0.4.0]: https://github.com/panorama-ed/memo_wise/compare/v0.3.0...v0.4.0

data/Gemfile.lock

@@ -1,9 +1,9 @@
 GIT
   remote: https://github.com/panorama-ed/panolint.git
-  revision: c709ebcc5fd9593db959df4a92c12cae1d1fb9af
+  revision: 5850a218b96da7dd196438fb65d41169cd6747e5
   branch: main
   specs:
-    panolint (0.1.3)
+    panolint (0.1.4)
       brakeman (>= 4.8, < 6.0)
       rubocop (>= 0.83, < 2.0)
       rubocop-performance (~> 1.5)
@@ -14,20 +14,21 @@ GIT
 PATH
   remote: .
   specs:
-    memo_wise (1.1.0)
+    memo_wise (1.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.6)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ansi (1.5.0)
     ast (2.4.2)
-    brakeman (5.1.1)
-    codecov (0.5.2)
+    brakeman (5.1.2)
+    codecov (0.6.0)
       simplecov (>= 0.15, < 0.22)
     concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
@@ -36,11 +37,11 @@ GEM
       ansi
       rouge
       slop (~> 3)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     minitest (5.14.4)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    parallel (1.21.0)
+    parser (3.0.3.1)
       ast (~> 2.4.1)
     rack (2.2.3)
     rainbow (3.0.0)
@@ -62,44 +63,43 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
-    rubocop (1.12.1)
+    rubocop (1.23.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.10.2)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.12.0)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
+    rubocop-rails (2.12.4)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.0)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     simplecov (0.18.5)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.3)
     slop (3.6.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
-    unicode-display_width (2.0.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
     values (1.8.0)
     yard (0.9.26)
     yard-doctest (0.1.17)
       minitest
       yard
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -117,4 +117,4 @@ DEPENDENCIES
   yard-doctest (~> 0.1)
 
 BUNDLED WITH
-   2.2.3
+   2.2.32

data/README.md

@@ -20,6 +20,8 @@
   * Support for [resetting](https://rubydoc.info/github/panorama-ed/memo_wise/MemoWise#reset_memo_wise-instance_method) and [presetting](https://rubydoc.info/github/panorama-ed/memo_wise/MemoWise#preset_memo_wise-instance_method) memoized values
   * Support for memoization on frozen objects
   * Support for memoization of class and module methods
+  * Support for inheritance of memoized class and instance methods
+  * Documented and tested [thread-safety guarantees](#thread-safety)
   * Full [documentation](https://rubydoc.info/github/panorama-ed/memo_wise/MemoWise) and [test coverage](https://codecov.io/gh/panorama-ed/memo_wise)!
 
 ## Installation
@@ -56,6 +58,15 @@ class Example
     x
   end
   memo_wise :slow_value
+
+  private
+
+  # maintains privacy of the memoized method
+  def private_slow_method(x)
+    sleep x
+    x
+  end
+  memo_wise :private_slow_method
 end
 
 ex = Example.new
@@ -102,44 +113,38 @@ For more usage details, see our detailed [documentation](#documentation).
 
 ## Benchmarks
 
-Benchmarks measure memoized value retrieval time using
-[`benchmark-ips`](https://github.com/evanphx/benchmark-ips). Benchmarks are
-run in GitHub Actions and updated in every PR that changes code.
-
-**Values >1.00x represent how much _slower_ each gem’s memoized value retrieval
-is than the baseline.**
-
-Benchmarks using Ruby 3.0.2:
-
-|Method arguments|`memo_wise` (latest)|`dry-core` (0.7.1)|`memery` (1.4.0)|
-|--|--|--|--|
-|`()` (none)|baseline|0.98-1.44x|10.40-14.95x|
-|`(a)`|baseline|2.10x|8.39x|
-|`(a, b)`|baseline|baseline\*|4.45x|
-|`(a:)`|baseline|1.89x|17.37x|
-|`(a:, b:)`|baseline|baseline\*|9.66x|
-|`(a, b:)`|baseline|baseline\*|8.78x|
-|`(a, *args)`|baseline|1.88x|4.07x|
-|`(a:, **kwargs)`|baseline|1.41x|4.98x|
-|`(a, *args, b:, **kwargs)`|baseline|baseline\*|2.50x|
-
-\*Indicates a run that was slower than the baseline but the difference was not
-significant.
-
-The following benchmarks are run on Ruby 2.7.4 because these gems raise errors
-in Ruby 3.0.2 due to their incorrect handling of keyword arguments:
-
-|Method arguments|`memo_wise` (latest)|`ddmemoize` (1.0.0)|`memoist` (0.16.2)|`memoized` (1.0.2)|`memoizer` (1.0.3)|
-|--|--|--|--|--|--|
-|`()` (none)|baseline|20.96-25.44x|2.49-3.31x|1.06-1.48x|2.96-3.83x|
-|`(a)`|baseline|19.37x|13.28x|9.31x|10.78x|
-|`(a, b)`|baseline|3.65x|2.64x|2.00x|2.28x|
-|`(a:)`|baseline|25.88x|21.74x|17.68x|19.17x|
-|`(a:, b:)`|baseline|5.72x|4.57x|3.90x|4.42x|
-|`(a, b:)`|baseline|5.63x|5.06x|4.20x|4.18x|
-|`(a, *args)`|baseline|5.13x|3.89x|3.25x|3.31x|
-|`(a:, **kwargs)`|baseline|3.23x|2.55x|2.33x|2.47x|
-|`(a, *args, b:, **kwargs)`|baseline|2.51x|2.00x|1.84x|1.88x|
+Benchmarks are run in GitHub Actions, and the tables below are updated with every code change. **Values >1.00x represent how much _slower_ each gem’s memoized value retrieval is than the latest commit of `MemoWise`**, according to [`benchmark-ips`](https://github.com/evanphx/benchmark-ips) (2.9.2).
+
+Results using Ruby 3.0.3:
+
+|Method arguments|`Dry::Core`\* (0.7.1)|`Memery` (1.4.0)|
+|--|--|--|
+|`()` (none)|1.06x|11.96x|
+|`(a)`|1.99x|10.19x|
+|`(a, b)`|0.39x|1.94x|
+|`(a:)`|1.80x|19.36x|
+|`(a:, b:)`|0.43x|4.26x|
+|`(a, b:)`|0.39x|3.97x|
+|`(a, *args)`|0.83x|1.85x|
+|`(a:, **kwargs)`|0.77x|2.94x|
+|`(a, *args, b:, **kwargs)`|0.59x|1.57x|
+
+\* `Dry::Core`
+[may cause incorrect behavior caused by hash collisions](https://github.com/dry-rb/dry-core/issues/63).
+
+Results using Ruby 2.7.5 (because these gems raise errors in Ruby 3.x):
+
+|Method arguments|`DDMemoize` (1.0.0)|`Memoist` (0.16.2)|`Memoized` (1.0.2)|`Memoizer` (1.0.3)|
+|--|--|--|--|--|
+|`()` (none)|24.30x|2.57x|1.19x|2.98x|
+|`(a)`|21.68x|14.63x|11.13x|12.71x|
+|`(a, b)`|3.18x|2.36x|1.86x|2.06x|
+|`(a:)`|30.62x|24.52x|21.44x|22.61x|
+|`(a:, b:)`|5.25x|4.40x|3.80x|4.04x|
+|`(a, b:)`|4.91x|4.06x|3.55x|3.83x|
+|`(a, *args)`|3.10x|2.31x|1.96x|1.98x|
+|`(a:, **kwargs)`|2.87x|2.40x|2.09x|2.20x|
+|`(a, *args, b:, **kwargs)`|2.08x|1.82x|1.67x|1.70x|
 
 You can run benchmarks yourself with:
 
@@ -152,6 +157,24 @@ $ bundle exec ruby benchmarks.rb
 If your results differ from what's posted here,
 [let us know](https://github.com/panorama-ed/memo_wise/issues/new)!
 
+## Thread Safety
+
+MemoWise makes the following **thread safety** guarantees on all supported Ruby
+versions:
+
+1. **Before** a value has been memoized
+
+   * Contended calls from multiple threads...
+      * May each call the original method
+      * May return different valid results (when the method is nondeterministic,
+        like `rand`)
+      * Will memoize exactly one valid return value
+
+2. **After** a value has been memoized
+
+   * Contended calls from multiple threads...
+     * Always return the same memoized value
+
 ## Documentation
 
 ### Documentation is Automatically Generated
@@ -203,10 +226,17 @@ after(:each) { helper.reset_memo_wise }
 
 ## Further Reading
 
-We've written more about MemoWise in a series of blog posts:
+We presented at RubyConf 2021:
+
+- Achieving Fast Method Metaprogramming: Lessons from `MemoWise`
+  ([slides](https://docs.google.com/presentation/d/1XgERQ0YHplwJKM3wNQwZn584d_9szYZp2WsDEXoY_7Y/edit?usp=sharing) /
+  [benchmarks](https://gist.github.com/JacobEvelyn/17b7b000e50151c30eaea928f1fcdc11))
+
+And we've written more about `MemoWise` in a series of blog posts:
 
 - [Introducing: MemoWise](https://medium.com/building-panorama-education/introducing-memowise-51a5f0523489)
 - [Optimizing MemoWise Performance](https://ja.cob.land/optimizing-memowise-performance)
+- [Esosteric Ruby in MemoWise](https://jemma.dev/blog/esoteric-ruby-in-memowise)
 
 ## Logo
 
@@ -237,11 +267,14 @@ Then carry out these steps:
 
 1. Update `CHANGELOG.md`:
    - Add an entry for the upcoming version _x.y.z_
+   - Add a link for this version's comparison to the bottom of `CHANGELOG.md`
    - Move content from _Unreleased_ to the upcoming version _x.y.z_
+   - Change _Unreleased_ section to say `- Nothing yet!`
    - Commit with title `Update CHANGELOG.md for x.y.z`
 
 2. Update `lib/memo_wise/version.rb`
    - Replace with upcoming version _x.y.z_
+   - Run `bundle install` to update `Gemfile.lock`
    - Commit with title `Bump version to x.y.z`
 
 3. `bundle exec rake release`

data/benchmarks/Gemfile

@@ -2,9 +2,9 @@
 
 source "https://rubygems.org"
 
-ruby ">= 2.7.4"
+ruby ">= 2.7.5"
 
-gem "benchmark-ips", "2.9.1"
+gem "benchmark-ips", "2.9.2"
 
 if RUBY_VERSION > "3"
   gem "dry-core", "0.7.1"