memo_wise 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d94c6c36ed049177dffb78f2bc5b0196d06e7b334643770163b7140ee2e77e2
-  data.tar.gz: 2be9bd8578a7357aabe70d9f748cb57fedf50708028ca7c3ed55815814b7ddc2
+  metadata.gz: aee2439aaa86140659e102e2269e4d773e34a933e73ff604b449918948b9cd29
+  data.tar.gz: bff512646d578b936d45267408be8681479c7316fa7ae16c683fc3b47261577a
 SHA512:
-  metadata.gz: 848080fdd9596f0a0f477464ddbc2009ab2c5f3caec56d3fa3c97dd275aca7687c94793af8124a7dd567a1c33abcdf3474cb2e13ab6b8b91f47302a0059b6916
-  data.tar.gz: e79de4347bbc5cd0701095574dfb7faafb320dc3f6e1de1cb0978ebd1fcdce5e65ca0c8fa2e0079d72385acabea582caac41a0c6c553078f69d1337006422e0e
+  metadata.gz: a820daf7cbc735f0bc586cc7e2b73c507f01592f8666ed3837b83584537466b4d06aee3202aa7c31b4545558f3e24a45ccc4063e315479fbbc4f3ece1606f7d8
+  data.tar.gz: 6349b73c2cec18df74259b79dceef15f7f9303001deffb94146c00abcc5e9f0d6be9ab82c0aa0adab0dc528dd75de4e5c8450df389f64c88c24bea50dead15ce

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, truffleruby-head]
+        ruby: [jruby, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, truffleruby-head]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
@@ -22,7 +22,7 @@ jobs:
     - name: Set bundler environment variables
       run: |
         echo "BUNDLE_WITHOUT=checks:docs" >> $GITHUB_ENV
-      if: matrix.ruby != 3.0
+      if: matrix.ruby != 3.1
 
     # Use 'bundler-cache: true' instead of actions/cache as advised:
     #   * https://github.com/actions/cache/blob/main/examples.md#ruby---bundler
@@ -34,15 +34,15 @@ jobs:
     - run: bundle exec rspec
 
     - run: bundle exec rubocop
-      if: matrix.ruby == 3.0
+      if: matrix.ruby == 3.1
 
     - run: |
         bundle exec yard doctest
         bundle exec dokaz
-      if: matrix.ruby == 3.0
+      if: matrix.ruby == 3.1
 
-    - name: Run benchmarks on Ruby 2.7 or 3.0
+    - name: Run benchmarks on Ruby 2.7 or 3.1
       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'
+      if: matrix.ruby == '2.7' || matrix.ruby == '3.1'

data/.ruby-version

@@ -1 +1 @@
-3.0.0
+3.1.0

data/CHANGELOG.md

@@ -7,13 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-- Nothing yet!
+Nothing yet!
+
+## [1.6.0] - 2022-01-24
+
+### Fixed
+
+- Fixed a bug relating to inheritance of classes which include module which
+  prepends MemoWise ([#265](https://github.com/panorama-ed/memo_wise/pull/265))
+
+### Updated
+
+- Update official test coverage to support Ruby 3.1
 
 ## [1.5.0] - 2021-12-17
 
-- Remove optimization for truthy results to fix race condition bugs
+### Fixed
+
+- Remove optimization for truthy results to fix thread safety 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
+  related to inheritance that the previous few versions were unable to
+  sufficiently address
 
 ## [1.4.0] - 2021-12-10
 
@@ -116,7 +131,8 @@ 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.5.0...HEAD
+[Unreleased]: https://github.com/panorama-ed/memo_wise/compare/v1.6.0...HEAD
+[1.6.0]: https://github.com/panorama-ed/memo_wise/compare/v1.5.0...v1.6.0
 [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

data/Gemfile.lock

@@ -14,7 +14,7 @@ GIT
 PATH
   remote: .
   specs:
-    memo_wise (1.5.0)
+    memo_wise (1.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -41,13 +41,13 @@ GEM
       concurrent-ruby (~> 1.0)
     minitest (5.14.4)
     parallel (1.21.0)
-    parser (3.0.3.1)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.6)
     redcarpet (3.5.1)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
     rouge (3.26.0)
     rspec (3.10.0)
@@ -63,16 +63,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
-    rubocop (1.23.0)
+    rubocop (1.24.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.13.0)
+    rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
     rubocop-performance (1.12.0)
       rubocop (>= 1.7.0, < 2.0)
@@ -95,7 +95,9 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
     values (1.8.0)
-    yard (0.9.26)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
     yard-doctest (0.1.17)
       minitest
       yard

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020-2021 Panorama Education
+Copyright (c) 2020-2022 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

@@ -115,19 +115,19 @@ For more usage details, see our detailed [documentation](#documentation).
 
 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:
+Results using Ruby 3.1.0:
 
-|Method arguments|`Dry::Core`\* (0.7.1)|`Memery` (1.4.0)|
+|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|
+|`()` (none)|1.09x|11.80x|
+|`(a)`|1.64x|9.74x|
+|`(a, b)`|0.34x|2.00x|
+|`(a:)`|1.49x|18.84x|
+|`(a:, b:)`|0.35x|4.26x|
+|`(a, b:)`|0.35x|4.18x|
+|`(a, *args)`|0.83x|1.89x|
+|`(a:, **kwargs)`|0.84x|3.30x|
+|`(a, *args, b:, **kwargs)`|0.54x|1.47x|
 
 \* `Dry::Core`
 [may cause incorrect behavior caused by hash collisions](https://github.com/dry-rb/dry-core/issues/63).

data/benchmarks/benchmarks.rb

@@ -191,7 +191,7 @@ benchmark_lambdas.map do |benchmark|
   json_file = Tempfile.new
 
   Benchmark.ips do |x|
-    x.config(suite: suite)
+    x.config(suite: suite) # rubocop:disable Style/HashSyntax
     BENCHMARK_GEMS.each do |benchmark_gem|
       instance = Object.const_get("#{benchmark_gem.klass}Example").new
 

data/lib/memo_wise/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MemoWise
-  VERSION = "1.5.0"
+  VERSION = "1.6.0"
 end

data/lib/memo_wise.rb

@@ -30,12 +30,12 @@ module MemoWise
   # [calling the original](https://medium.com/@jeremy_96642/ruby-method-auditing-using-module-prepend-4f4e69aacd95)
   # constructor.
   #
-  # - **Q:** Why is [Module#prepend](https://ruby-doc.org/core-3.0.0/Module.html#method-i-prepend)
+  # - **Q:** Why is [Module#prepend](https://ruby-doc.org/core-3.1.0/Module.html#method-i-prepend)
   #          important here
   #          ([more info](https://medium.com/@leo_hetsch/ruby-modules-include-vs-prepend-vs-extend-f09837a5b073))?
   # - **A:** To set up *mutable state* inside the instance, even if the original
   #          constructor will then call
-  #          [Object#freeze](https://ruby-doc.org/core-3.0.0/Object.html#method-i-freeze).
+  #          [Object#freeze](https://ruby-doc.org/core-3.1.0/Object.html#method-i-freeze).
   #
   # This approach supports memoization on frozen (immutable) objects -- for
   # example, classes created by the
@@ -84,7 +84,7 @@ module MemoWise
   # @param target [Class]
   #   The `Class` into to prepend the MemoWise methods e.g. `memo_wise`
   #
-  # @see https://ruby-doc.org/core-3.0.0/Module.html#method-i-prepended
+  # @see https://ruby-doc.org/core-3.1.0/Module.html#method-i-prepended
   #
   # @example
   #   class Example
@@ -99,7 +99,7 @@ module MemoWise
       #
       # This is necessary in addition to the `#initialize` method definition
       # above because
-      # [`Class#allocate`](https://ruby-doc.org/core-3.0.0/Class.html#method-i-allocate)
+      # [`Class#allocate`](https://ruby-doc.org/core-3.1.0/Class.html#method-i-allocate)
       # bypasses `#initialize`, and when it's used (e.g.,
       # [in ActiveRecord](https://github.com/rails/rails/blob/a395c3a6af1e079740e7a28994d77c8baadd2a9d/activerecord/lib/active_record/persistence.rb#L411))
       # we still need to be able to access MemoWise's instance variable. Despite
@@ -156,16 +156,14 @@ module MemoWise
           klass = klass.singleton_class
         end
 
-        if klass.singleton_class?
-          # This ensures that a memoized method defined on a parent class can
-          # still be used in a child class.
-          klass.module_eval <<~HEREDOC, __FILE__, __LINE__ + 1
-            def inherited(subclass)
-              super
-              MemoWise::InternalAPI.create_memo_wise_state!(subclass)
-            end
-          HEREDOC
-        end
+        # This ensures that a memoized method defined on a parent class can
+        # still be used in a child class.
+        klass.module_eval <<~HEREDOC, __FILE__, __LINE__ + 1
+          def inherited(subclass)
+            super
+            MemoWise::InternalAPI.create_memo_wise_state!(subclass)
+          end
+        HEREDOC
 
         raise ArgumentError, "#{method_name.inspect} must be a Symbol" unless method_name.is_a?(Symbol)
 
@@ -225,7 +223,7 @@ module MemoWise
         )
       end
 
-      # Override [Module#instance_method](https://ruby-doc.org/core-3.0.0/Module.html#method-i-instance_method)
+      # Override [Module#instance_method](https://ruby-doc.org/core-3.1.0/Module.html#method-i-instance_method)
       # to proxy the original `UnboundMethod#parameters` results. We want the
       # parameters to reflect the original method in order to support callers
       # who want to use Ruby reflection to process the method parameters,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memo_wise
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Panorama Education
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-20 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: The wise choice for Ruby memoization