memo_wise 0.4.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 634bee32d07ccd97dc7670c67521a4091ebc0df0deae1479cc054aaa7a246e6c
-  data.tar.gz: 59523369b3373389481388962039486b4f0f5cf002d24091ad2244048f100bbc
+  metadata.gz: 4ff51bfee4fcc634d50588005e79c4a74702fd0d8deb8ab23dd917134cedf42f
+  data.tar.gz: 1cb14df9bcef27a3442b48cf1aee370835bbf9070b1f44bb3d8ec8266158bdab
 SHA512:
-  metadata.gz: 3896bf8b001ad52afda6b14c5170d902d85a88c9faaa60d6c9097a01045e0ef90a379c130834b2a2fcbec356b51346f975fc96493dcb3d3c04943200eb7274a3
-  data.tar.gz: 72718456d986ed21d593a6a99117ee74a0a385f94ba0b1a00fadb38cbad977202cea5d8e32325bdaa2e5eb273808a52ca9d62997cd927a6a98ffd31174bdcc6f
+  metadata.gz: 36a3f525833af24f076568ed9bdb43a06e90441788f2f8e8d26c0303ec7e0697a56c8401a3e24c06300cb3f2df199768ae00d8cf95cc90808fb4d9940ab9a931
+  data.tar.gz: f60569c63d693272856137c179b826a598c63a5762fedd76faf630b26fd3301d6ca37756f99cb7940501d5bcfd4c375094176a617610c35fc8788b67580159ce

data/.dokaz

@@ -0,0 +1,2 @@
+README.md
+--require ./spec/dokaz_helpers.rb

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/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+
+updates:
+  # Maintain dependencies for Ruby's Bundler
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+
+  # Maintain dependencies for Ruby's Bundler (for Benchmarks!)
+  - package-ecosystem: bundler
+    directory: "/benchmarks"
+    schedule:
+      interval: daily
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/main.yml

@@ -15,26 +15,34 @@ jobs:
         ruby: [jruby, 2.4, 2.5, 2.6, 2.7, 3.0]
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@main
+    - uses: actions/checkout@v2
+
+    # Conditionally configure bundler via environment variables as advised
+    #   * https://github.com/ruby/setup-ruby#bundle-config
+    - name: Set bundler environment variables
+      run: |
+        echo "BUNDLE_WITHOUT=checks:docs" >> $GITHUB_ENV
+      if: matrix.ruby != 3.0
+
+    # Use 'bundler-cache: true' instead of actions/cache as advised:
+    #   * https://github.com/actions/cache/blob/main/examples.md#ruby---bundler
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-    - uses: actions/cache@v1
-      with:
-        path: vendor/bundle
-        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-gems-
-    - run: bundle config path vendor/bundle
-    - run: bundle config set without 'checks:docs'
-      if: matrix.ruby != 3.0
-    - run: bundle install --jobs 4 --retry 3
+        bundler-cache: true
+
     - run: bundle exec rspec
+
     - run: bundle exec rubocop
       if: matrix.ruby == 3.0
-    - run: bundle exec yard doctest
-      if: matrix.ruby == 3.0
+
     - run: |
+        bundle exec yard doctest
+        bundle exec dokaz
+      if: matrix.ruby == 3.0
+
+    - name: Run benchmarks on Ruby 2.7 or 3.0
+      run: |
         BUNDLE_GEMFILE=benchmarks/Gemfile bundle install --jobs 4 --retry 3
         BUNDLE_GEMFILE=benchmarks/Gemfile bundle exec ruby benchmarks/benchmarks.rb
       if: matrix.ruby == '2.7' || matrix.ruby == '3.0'

data/.gitignore

@@ -1,5 +1,6 @@
 /.bundle/
 /benchmarks/.bundle/
+/benchmarks/Gemfile.lock
 /.yardoc
 /_yardoc/
 /coverage/

data/.rubocop.yml

@@ -1,2 +1,17 @@
 inherit_gem:
   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,7 +6,54 @@ 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!)
+
+- Nothing yet!
+
+## [1.3.0] - 2021-11-22
+
+- 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
+- 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
+- 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
+- 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
+- Fixed usage on module singleton classes
+- Fixed usage on module which would be extended by other classes
+
+### Breaking Changes
+- None
+
+## [1.0.0] - 2021-06-24
+### 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
 
 ## [0.4.0] - 2021-04-30
 ### Added
@@ -54,7 +101,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/v0.4.0...HEAD
+[Unreleased]: https://github.com/panorama-ed/memo_wise/compare/v1.3.0...HEAD
+[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
 [0.3.0]: https://github.com/panorama-ed/memo_wise/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/panorama-ed/memo_wise/compare/v0.1.2...v0.2.0

data/Gemfile

@@ -19,6 +19,7 @@ end
 
 # Excluded from CI except on latest MRI Ruby, to reduce compatibility burden
 group :docs do
+  gem "dokaz"
   gem "redcarpet", "~> 3.5"
   gem "yard", "~> 0.9"
   gem "yard-doctest", "~> 0.1"

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/panorama-ed/panolint.git
-  revision: e2f76aa2482f02e68826eb8643a41998a09fc7ab
+  revision: c709ebcc5fd9593db959df4a92c12cae1d1fb9af
   branch: main
   specs:
     panolint (0.1.3)
@@ -14,35 +14,41 @@ GIT
 PATH
   remote: .
   specs:
-    memo_wise (0.4.0)
+    memo_wise (1.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.5)
+    activesupport (5.2.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    ansi (1.5.0)
     ast (2.4.2)
-    brakeman (5.0.0)
-    codecov (0.5.2)
+    brakeman (5.1.1)
+    codecov (0.6.0)
       simplecov (>= 0.15, < 0.22)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     docile (1.3.5)
+    dokaz (0.0.4)
+      ansi
+      rouge
+      slop (~> 3)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     minitest (5.14.4)
     parallel (1.20.1)
-    parser (3.0.1.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     rack (2.2.3)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
     redcarpet (3.5.1)
     regexp_parser (2.1.1)
     rexml (3.2.5)
+    rouge (3.26.0)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -84,6 +90,7 @@ GEM
       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)
@@ -99,6 +106,7 @@ PLATFORMS
 
 DEPENDENCIES
   codecov
+  dokaz
   memo_wise!
   panolint!
   rake
@@ -109,4 +117,4 @@ DEPENDENCIES
   yard-doctest (~> 0.1)
 
 BUNDLED WITH
-   2.2.3
+   2.2.28

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Panorama Education
+Copyright (c) 2020-2021 Panorama Education
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -20,6 +20,7 @@
   * 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
   * Full [documentation](https://rubydoc.info/github/panorama-ed/memo_wise/MemoWise) and [test coverage](https://codecov.io/gh/panorama-ed/memo_wise)!
 
 ## Installation
@@ -50,11 +51,21 @@ methods:
 ```ruby
 class Example
   prepend MemoWise
+
   def slow_value(x)
     sleep x
     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
@@ -71,29 +82,68 @@ ex.slow_value(3) # => 4 # Returns immediately because the result is memoized
 ex.reset_memo_wise # Resets all memoized results for all methods on ex
 ```
 
-Methods which take implicit or explicit block arguments cannot be memoized.
+The same three methods are exposed for class methods as well:
 
-For more usage details, see our detailed [documentation](#documentation).
+```ruby
+class Example
+  prepend MemoWise
 
-## Benchmarks
+  def self.class_slow_value(x)
+    sleep x
+    x
+  end
+  memo_wise self: :class_slow_value
+end
+
+Example.class_slow_value(2) # => 2 # Sleeps for 2 seconds before returning
+Example.class_slow_value(2) # => 2 # Returns immediately because the result is memoized
+
+Example.reset_memo_wise(:class_slow_value) # Resets all memoized results for class_slow_value
 
-Benchmarks measure memoized value retrieval time using
-[`benchmark-ips`](https://github.com/evanphx/benchmark-ips). All benchmarks are
-run on Ruby 3.0.0, except as indicated below for specific gems. Benchmarks are
-run in GitHub Actions and updated in every PR that changes code.
+Example.preset_memo_wise(:class_slow_value, 3) { 4 } # Store 4 as the result for slow_value(3)
+Example.class_slow_value(3) # => 4 # Returns immediately because the result is memoized
+Example.reset_memo_wise # Resets all memoized results for all methods on class
+```
+
+**NOTE:** Methods which take implicit or explicit block arguments cannot be
+memoized.
 
-|Method arguments|**`memo_wise` (0.1.0)**|`memery` (1.3.0)|`memoist`\* (0.16.2)|`memoized`\* (1.0.2)|`memoizer`\* (1.0.3)|
-|--|--|--|--|--|--|
-|`()` (none)|**baseline**|13.17x slower|2.85x slower|1.30x slower|3.05x slower|
-|`(a, b)`|**baseline**|1.93x slower|2.20x slower|1.97x slower|1.86x slower|
-|`(a:, b:)`|**baseline**|3.05x slower|2.34x slower|2.27x slower|2.14x slower|
-|`(a, b:)`|**baseline**|1.50x slower|1.63x slower|1.56x slower|1.48x slower|
-|`(a, *args)`|**baseline**|1.91x slower|2.13x slower|1.90x slower|1.88x slower|
-|`(a:, **kwargs)`|**baseline**|3.08x slower|2.37x slower|2.24x slower|2.09x slower|
-|`(a, *args, b:, **kwargs)`|**baseline**|1.72x slower|1.61x slower|1.56x slower|1.67x slower|
+For more usage details, see our detailed [documentation](#documentation).
+
+## Benchmarks
 
-_\*Indicates a benchmark run on Ruby 2.7.2 because the gem raises errors in Ruby
-3.0.0 due to its incorrect handling of keyword arguments._
+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.1).
+
+Results using Ruby 3.0.2:
+
+|Method arguments|`Dry::Core`\* (0.7.1)|`Memery` (1.4.0)|
+|--|--|--|
+|`()` (none)|1.42x|17.84x|
+|`(a)`|2.48x|11.48x|
+|`(a, b)`|0.46x|2.05x|
+|`(a:)`|2.18x|20.50x|
+|`(a:, b:)`|0.48x|4.22x|
+|`(a, b:)`|0.48x|4.08x|
+|`(a, *args)`|0.90x|1.97x|
+|`(a:, **kwargs)`|0.80x|3.02x|
+|`(a, *args, b:, **kwargs)`|0.61x|1.54x|
+
+\* `Dry::Core`
+[may cause incorrect behavior caused by hash collisions](https://github.com/dry-rb/dry-core/issues/63).
+
+Results using Ruby 2.7.4 (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)|33.90x|3.44x|1.56x|4.03x|
+|`(a)`|24.56x|17.02x|12.94x|14.91x|
+|`(a, b)`|3.14x|2.35x|1.84x|2.03x|
+|`(a:)`|34.42x|28.14x|23.83x|25.26x|
+|`(a:, b:)`|5.13x|4.28x|3.77x|3.97x|
+|`(a, b:)`|4.83x|4.08x|3.50x|3.66x|
+|`(a, *args)`|3.03x|2.25x|1.95x|1.95x|
+|`(a:, **kwargs)`|2.90x|2.44x|2.14x|2.24x|
+|`(a, *args, b:, **kwargs)`|2.05x|1.77x|1.65x|1.64x|
 
 You can run benchmarks yourself with:
 
@@ -106,18 +156,6 @@ $ 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)!
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`rake spec` to run the tests. You can also run `bin/console` for an interactive
-prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
-
 ## Documentation
 
 ### Documentation is Automatically Generated
@@ -140,6 +178,14 @@ code examples in our YARD documentation. To run `doctest` locally:
 bundle exec yard doctest
 ```
 
+We use [dokaz](https://github.com/zverok/dokaz) to test all code examples in
+this README.md file, and all other non-code documentation. To run `dokaz`
+locally:
+
+```bash
+bundle exec dokaz
+```
+
 ### A Note on Testing
 
 When testing memoized *module* methods, note that some testing setups will
@@ -159,6 +205,20 @@ memoization between your tests with something like:
 after(:each) { helper.reset_memo_wise }
 ```
 
+## Further Reading
+
+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
 
 `MemoWise`'s logo was created by [Luci Cooke](https://www.lucicooke.com/). The
@@ -180,7 +240,7 @@ To make a new release of `MemoWise` to
 dependencies (e.g. `rake`) as follows:
 
 ```shell
-bundle config set --local with 'release'
+bundle config --local with 'release'
 bundle install
 ```
 
@@ -188,6 +248,7 @@ 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_
    - Commit with title `Update CHANGELOG.md for x.y.z`
 

data/benchmarks/Gemfile

@@ -2,13 +2,15 @@
 
 source "https://rubygems.org"
 
-ruby ">= 2.7.2"
+ruby ">= 2.7.4"
 
-gem "benchmark-ips", "2.8.4"
+gem "benchmark-ips", "2.9.1"
 
 if RUBY_VERSION > "3"
-  gem "memery", "1.3.0"
+  gem "dry-core", "0.7.1"
+  gem "memery", "1.4.0"
 else
+  gem "ddmemoize", "1.0.0"
   gem "memoist", "0.16.2"
   gem "memoized", "1.0.2"
   gem "memoizer", "1.0.3"