memo_wise 0.3.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1b98d394deb079784021cd44f5c7b41abdbf1cce2b0ce14b0a3957b12bfdabe
-  data.tar.gz: 45b6796cf708b5401a56edfd68156587f92826a71d833b7fe3bec24985d81ac9
+  metadata.gz: 3a2fbbb2a403502d6a492068a9a0c8c103f717ea5b32e5029ba1a0aebab61db6
+  data.tar.gz: c2c8118caa1621670b6cd666f92147eb5c3f069c7b910062ed0f635568764dd7
 SHA512:
-  metadata.gz: 9ba145822aef3d07b2385daffaef15c22f5ffd4604e68d1fbad5d2bdf682c7723bb9a109cdda69d26efd6e5c05a21c1f0310ae70a1dbfd0f18a28cbe92d13d6f
-  data.tar.gz: 210c34c42f11e9d761c0fda0512daf62a533ec0fe2f19609a6cf0e052a1f2e2fdf22a55711764865616a319e387bff83fc5a6505973a4d89483ef383af008d13
+  metadata.gz: 699415e3445e60bf6037fdb6887a064a4d082159be15c8c52a0711be5b3b233e3a7caa974f6d31df769d9bd0c3825d7a9f11b17b1e3b98ec9202ee8224801204
+  data.tar.gz: f6f377da39902d30310e7304e0caa7195e372c5fe0666e05ea30d2c2f936f3cc7d00c3588e453d5ab4ba7393a4f747f5c328acd4f4024cfa126ecb5f683fd24c

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

@@ -5,8 +5,53 @@ All notable changes to this project will be documented in this file.
 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!)
+## Unreleased
+- Nothing yet!
+
+## [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
+- Documentation of confusing module test behavior
+- Support using MemoWise in classes with keyword arguments in the initializer
+- Support Marshal dump/load of classes using MemoWise
 
 ## [0.3.0] - 2021-02-11
 ### Added
@@ -48,7 +93,10 @@ 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.3.0...HEAD
+[Unreleased]: https://github.com/panorama-ed/memo_wise/compare/v1.1.0...HEAD
+[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
 [0.1.2]: https://github.com/panorama-ed/memo_wise/compare/v0.1.1...v0.1.2

data/Gemfile

@@ -14,11 +14,12 @@ end
 # Excluded from CI except on latest MRI Ruby, to reduce compatibility burden
 group :checks do
   gem "codecov"
-  gem "panolint", github: "panorama-ed/panolint"
+  gem "panolint", github: "panorama-ed/panolint", branch: "main"
 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,8 +1,9 @@
 GIT
   remote: https://github.com/panorama-ed/panolint.git
-  revision: ca5edaa1f6985e2812998a937229f972c07bce56
+  revision: c709ebcc5fd9593db959df4a92c12cae1d1fb9af
+  branch: main
   specs:
-    panolint (0.1.2)
+    panolint (0.1.3)
       brakeman (>= 4.8, < 6.0)
       rubocop (>= 0.83, < 2.0)
       rubocop-performance (~> 1.5)
@@ -13,35 +14,41 @@ GIT
 PATH
   remote: .
   specs:
-    memo_wise (0.3.0)
+    memo_wise (1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.4.4)
+    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.4.3)
+    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)
-    i18n (1.8.8)
+    dokaz (0.0.4)
+      ansi
+      rouge
+      slop (~> 3)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.3)
+    minitest (5.14.4)
     parallel (1.20.1)
-    parser (3.0.0.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.0.3)
-    rexml (3.2.4)
+    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)
@@ -55,7 +62,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
-    rubocop (1.9.1)
+    rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -66,7 +73,7 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
-    rubocop-performance (1.9.2)
+    rubocop-performance (1.10.2)
       rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rails (2.9.1)
@@ -83,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)
@@ -98,6 +106,7 @@ PLATFORMS
 
 DEPENDENCIES
   codecov
+  dokaz
   memo_wise!
   panolint!
   rake
@@ -108,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

@@ -12,7 +12,6 @@
 [![Gem Version](https://img.shields.io/gem/v/memo_wise.svg)](https://rubygems.org/gems/memo_wise)
 [![Gem Downloads](https://img.shields.io/gem/dt/memo_wise.svg)](https://rubygems.org/gems/memo_wise)
 
-
 ## Why `MemoWise`?
 
 `MemoWise` is **the wise choice for Ruby memoization**, featuring:
@@ -51,11 +50,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
@@ -72,29 +81,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
 
-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.class_slow_value(2) # => 2 # Sleeps for 2 seconds before returning
+Example.class_slow_value(2) # => 2 # Returns immediately because the result is 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**|14.69x slower|2.59x slower|1.15x slower|2.91x slower|
-|`(a, b)`|**baseline**|1.93x slower|2.20x slower|1.79x slower|1.96x slower|
-|`(a:, b:)`|**baseline**|3.01x slower|2.41x slower|2.18x slower|2.28x slower|
-|`(a, b:)`|**baseline**|1.49x slower|1.75x slower|1.51x slower|1.60x slower|
-|`(a, *args)`|**baseline**|1.92x slower|2.23x slower|1.94x slower|1.98x slower|
-|`(a:, **kwargs)`|**baseline**|3.08x slower|2.48x slower|2.17x slower|2.28x slower|
-|`(a, *args, b:, **kwargs)`|**baseline**|1.55x slower|1.73x slower|1.65x slower|1.67x slower|
+Example.reset_memo_wise(:class_slow_value) # Resets all memoized results for class_slow_value
 
-_\*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._
+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.
+
+For more usage details, see our detailed [documentation](#documentation).
+
+## Benchmarks
+
+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.51x|19.82x|
+|`(a)`|2.30x|11.38x|
+|`(a, b)`|0.45x|2.10x|
+|`(a:)`|2.20x|22.83x|
+|`(a:, b:)`|0.49x|4.53x|
+|`(a, b:)`|0.46x|4.35x|
+|`(a, *args)`|0.89x|2.03x|
+|`(a:, **kwargs)`|0.82x|3.18x|
+|`(a, *args, b:, **kwargs)`|0.60x|1.62x|
+
+\* `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)|35.29x|3.46x|1.67x|4.27x|
+|`(a)`|25.04x|16.96x|12.83x|14.68x|
+|`(a, b)`|3.20x|2.28x|1.84x|2.04x|
+|`(a:)`|34.17x|27.77x|24.07x|25.39x|
+|`(a:, b:)`|5.22x|4.29x|3.74x|4.00x|
+|`(a, b:)`|4.81x|3.99x|3.49x|3.66x|
+|`(a, *args)`|3.21x|2.30x|1.97x|2.00x|
+|`(a:, **kwargs)`|2.84x|2.39x|2.12x|2.19x|
+|`(a, *args, b:, **kwargs)`|2.10x|1.80x|1.67x|1.66x|
 
 You can run benchmarks yourself with:
 
@@ -107,18 +155,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
@@ -141,6 +177,41 @@ 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
+reuse the same instance (which `include`s/`extend`s/`prepend`s the module)
+across tests, which can result in confusing test failures when this differs from
+how you use the code in production.
+
+For example, Rails view helpers are modules that are commonly tested with a
+[shared `view` instance](https://github.com/rails/rails/blob/291a3d2ef29a3842d1156ada7526f4ee60dd2b59/actionview/lib/action_view/test_case.rb#L203-L214). Rails initializes a new view instance for each web request so any view helper
+methods would only be memoized for the duration of that web request, but in
+tests (such as when using
+[`rspec-rails`'s `helper`](https://github.com/rspec/rspec-rails/blob/main/lib/rspec/rails/example/helper_example_group.rb#L22-L27)),
+the memoization may persist across tests. In this case, simply reset the
+memoization between your tests with something like:
+
+```ruby
+after(:each) { helper.reset_memo_wise }
+```
+
+## Further Reading
+
+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
@@ -162,7 +233,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
 ```
 

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"