memo_wise 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07ea8ff9f5bbe537cceded02e2379f22145b2ca0023ee745cca77d503875884c
-  data.tar.gz: 43a1683798319eccc7fb0781519b84575c1096d938f7076b6dc5747370e5849e
+  metadata.gz: bcbf16d5dbb7dcebd8181d89b17e550f493afb08e8c3f46c2e56d1c6d224a71d
+  data.tar.gz: bff1adee597c5a29fea1223604733a23b5b10e800e217d7b7e73d715b0c221cf
 SHA512:
-  metadata.gz: 0d40f55683a9dd45e81ffc16ac0c4678294cf0d0668c18e676717b9146709b538a7ed9c58b6b3d75f78e262e71f27267228ee2271e47994674d32967f7ff167f
-  data.tar.gz: 92ad0acb0712b0cb122c77a0a8901003b79d73253adc1db8d27fedb42ec07ba49d4706ccf4be8b44a79d18856be909235ec4b4673bf576db69d7dc4643e23770
+  metadata.gz: 477aac5ab8f66cf7287ff976a484d8ba06447587f997e612fccee952d003b688c79d9d934f28d730443d7c23fdeca4d90ec0adb79f6dea9f5bdc11b0b9d3820e
+  data.tar.gz: 99175b330fd6235bab7967545177298d2ccaa3fbab2c2d860aaa7f686f48e581ec7d5ef2e036a760759e48bec8618b24b1784227e9eb762052dac4649f102813

data/.github/workflows/dependency-review.yml

@@ -17,7 +17,7 @@
         - name: 'Checkout Repository'
           uses: actions/checkout@v4
         - name: 'Dependency Review'
-          uses: actions/dependency-review-action@v3
+          uses: actions/dependency-review-action@v4
           with:
             # Possible values: "critical", "high", "moderate", "low" 
             fail-on-severity: high

data/.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
       matrix:
         # Due to https://github.com/actions/runner/issues/849, we have to use
         # quotes for '3.0' -- without quotes, CI sees '3' and runs the latest.
-        ruby: [2.4, 2.5, 2.6, 2.7, '3.0', 3.1, 3.2, jruby, truffleruby-head]
+        ruby: [2.5, 2.6, 2.7, '3.0', 3.1, 3.2, jruby, truffleruby-head]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
@@ -23,8 +23,8 @@ jobs:
     #   * 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.2
+        echo "BUNDLE_WITH=checks:docs" >> $GITHUB_ENV
+      if: matrix.ruby == 3.2
 
     # Use 'bundler-cache: true' instead of actions/cache as advised:
     #   * https://github.com/actions/cache/blob/main/examples.md#ruby---bundler
@@ -35,10 +35,11 @@ jobs:
 
     - run: bundle exec rspec
 
-    - uses: codecov/codecov-action@v3
+    - uses: codecov/codecov-action@v4
       with:
         files: ./coverage/coverage.xml
         fail_ci_if_error: true # optional (default = false)
+        token: ${{ secrets.CODECOV_TOKEN }}
         verbose: true # optional (default = false)
       if: matrix.ruby == 3.2
 

data/.ruby-version

@@ -1 +1 @@
-3.2.1
+3.2.2

data/CHANGELOG.md

@@ -5,13 +5,28 @@ follows a format inspired by [Keep a Changelog](https://keepachangelog.com/en/1.
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/panorama-ed/memo_wise/compare/v1.8.0...HEAD)
+## [Unreleased](https://github.com/panorama-ed/memo_wise/compare/v1.9.0...HEAD)
 
-**Gem enhancements:** none
+**Gem enhancements:**
 
 _No breaking changes!_
 
-**Project enhancements:** none
+**Project enhancements:**
+
+## [v1.9.0](https://github.com/panorama-ed/memo_wise/compare/v1.8.0...v1.9.0)
+
+**Gem enhancements:**
+
+- Fixed a bug that overwrote existing self.extended method definitions. [[#324]](https://github.com/panorama-ed/memo_wise/pull/314)
+- Fixed a bug that overwrote existing self.inherited method definitions. [[#325]](https://github.com/panorama-ed/memo_wise/pull/315)
+
+_Breaking changes:_
+- Removed Ruby 2.4 (EOL) support to allow upgrading rexml dependency version from a version that includes a [CVE](https://www.ruby-lang.org/en/news/2024/05/16/dos-rexml-cve-2024-35176/) [[#336]](https://github.com/panorama-ed/memo_wise/pull/336)
+
+**Project enhancements:**
+
+- Fixed `bundle exec yard server --reload` and related documentation [[#333]](https://github.com/panorama-ed/memo_wise/pull/333)
+- Fixed Codecov rate limiting errors affecting pull requests by upgrading `codecov/codecov-action` and using a Codecov token [[#317]](https://github.com/panorama-ed/memo_wise/pull/317)
 
 ## [v1.8.0](https://github.com/panorama-ed/memo_wise/compare/v1.7.0...v1.8.0) - 2023-10-25
 

data/Gemfile

@@ -7,12 +7,12 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 gemspec
 
 group :test do
-  gem "rspec", "~> 3.12"
+  gem "rspec", "~> 3.13"
   gem "values", "~> 1"
 end
 
 # Excluded from CI except on latest MRI Ruby, to reduce compatibility burden
-group :checks do
+group :checks, optional: true do
   gem "panolint-ruby", github: "panorama-ed/panolint-ruby", branch: "main"
 
   # Simplecov to generate coverage info
@@ -23,9 +23,10 @@ group :checks do
 end
 
 # Excluded from CI except on latest MRI Ruby, to reduce compatibility burden
-group :docs do
+group :docs, optional: true do
   gem "dokaz", "~> 0.0.5"
   gem "redcarpet", "~> 3.6"
+  gem "webrick", "~> 1.8"
   gem "yard", "~> 0.9"
   gem "yard-doctest", "~> 0.1"
 end

data/Gemfile.lock

@@ -11,14 +11,14 @@ GIT
 PATH
   remote: .
   specs:
-    memo_wise (1.8.0)
+    memo_wise (1.9.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
     ast (2.4.2)
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     docile (1.4.0)
     dokaz (0.0.5)
       ansi
@@ -30,24 +30,25 @@ GEM
     parser (3.2.2.1)
       ast (~> 2.4.1)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (13.1.0)
     redcarpet (3.6.0)
     regexp_parser (2.8.0)
-    rexml (3.2.5)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rouge (4.1.0)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     rubocop (1.51.0)
       json (~> 2.3)
       parallel (~> 1.10)
@@ -82,9 +83,11 @@ GEM
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
     slop (3.6.0)
+    strscan (3.1.0)
     unicode-display_width (2.4.2)
     values (1.8.0)
-    yard (0.9.34)
+    webrick (1.8.1)
+    yard (0.9.36)
     yard-doctest (0.1.17)
       minitest
       yard
@@ -98,10 +101,11 @@ DEPENDENCIES
   panolint-ruby!
   rake
   redcarpet (~> 3.6)
-  rspec (~> 3.12)
+  rspec (~> 3.13)
   simplecov
   simplecov-cobertura
   values (~> 1)
+  webrick (~> 1.8)
   yard (~> 0.9)
   yard-doctest (~> 0.1)
 

data/README.md

@@ -118,15 +118,15 @@ Results using Ruby 3.2.2:
 
 |Method arguments|`Dry::Core`\* (1.0.1)|`Memery` (1.5.0)|
 |--|--|--|
-|`()` (none)|0.54x|3.62x|
-|`(a)`|1.54x|7.74x|
-|`(a, b)`|1.29x|5.58x|
-|`(a:)`|1.55x|12.37x|
-|`(a:, b:)`|1.15x|8.76x|
-|`(a, b:)`|1.15x|8.75x|
-|`(a, *args)`|0.84x|1.54x|
-|`(a:, **kwargs)`|0.79x|2.13x|
-|`(a, *args, b:, **kwargs)`|0.69x|1.38x|
+|`()` (none)|0.66x|3.54x|
+|`(a)`|1.48x|8.49x|
+|`(a, b)`|1.18x|6.52x|
+|`(a:)`|1.53x|13.57x|
+|`(a:, b:)`|1.27x|10.56x|
+|`(a, b:)`|1.26x|10.44x|
+|`(a, *args)`|0.78x|1.60x|
+|`(a:, **kwargs)`|0.77x|2.12x|
+|`(a, *args, b:, **kwargs)`|0.69x|1.40x|
 
 \* `Dry::Core`
 [may cause incorrect behavior caused by hash collisions](https://github.com/dry-rb/dry-core/issues/63).
@@ -135,15 +135,15 @@ Results using Ruby 2.7.8 (because these gems raise errors in Ruby 3.x):
 
 |Method arguments|`DDMemoize` (1.0.0)|`Memoist` (0.16.2)|`Memoized` (1.1.1)|`Memoizer` (1.0.3)|
 |--|--|--|--|--|
-|`()` (none)|24.22x|2.42x|26.43x|2.70x|
-|`(a)`|22.08x|15.19x|22.03x|13.67x|
-|`(a, b)`|19.12x|14.01x|18.60x|12.80x|
-|`(a:)`|30.21x|24.29x|26.43x|23.11x|
-|`(a:, b:)`|27.73x|22.97x|25.11x|21.89x|
-|`(a, b:)`|26.87x|22.76x|23.71x|21.26x|
-|`(a, *args)`|3.15x|2.30x|3.18x|2.11x|
-|`(a:, **kwargs)`|2.89x|2.40x|2.69x|2.28x|
-|`(a, *args, b:, **kwargs)`|2.12x|1.82x|1.96x|1.74x|
+|`()` (none)|22.57x|2.27x|23.46x|2.63x|
+|`(a)`|20.96x|14.29x|20.54x|11.97x|
+|`(a, b)`|18.22x|13.21x|17.76x|11.34x|
+|`(a:)`|30.66x|23.52x|25.37x|21.61x|
+|`(a:, b:)`|27.31x|21.98x|23.02x|20.31x|
+|`(a, b:)`|26.21x|20.85x|21.57x|19.20x|
+|`(a, *args)`|3.06x|2.23x|3.10x|1.92x|
+|`(a:, **kwargs)`|2.67x|2.18x|2.39x|2.02x|
+|`(a, *args, b:, **kwargs)`|2.14x|1.80x|1.89x|1.70x|
 
 You can run benchmarks yourself with:
 
@@ -176,18 +176,42 @@ versions:
 
 ## Documentation
 
-### Documentation is Automatically Generated
+### Automatically Generated Docs
 
 We maintain API documentation using [YARD](https://yardoc.org/), which is
 published automatically at
-[RubyDoc.info](https://rubydoc.info/gems/memo_wise). To
-edit documentation locally and see it rendered in your browser, run:
+[RubyDoc.info](https://rubydoc.info/gems/memo_wise). 
+
+To generate documentation locally or run documentation tests,
+first install the `docs` dependencies (e.g. `yard`) as follows:
 
 ```bash
-bundle exec yard server
+BUNDLE_WITH=docs bundle install
 ```
 
-### Documentation Examples are Automatically Tested
+### Hot Reloading Docs Locally
+
+To edit documentation locally and see it rendered in your browser
+using hot reloading, run:
+
+```bash
+bundle exec yard server --reload
+```
+
+You can then open your web browser to `http://127.0.0.1:8808/`. As you
+edit documentation locally, reload your browser to see it generated.
+
+### Static Generate Docs Locally
+
+To statically generate documentation locally, run:
+
+```bash
+bundle exec yard
+```
+
+You can then open the generated documentation at `docs/index.html`.
+
+### Test all Docs Examples
 
 We use [yard-doctest](https://github.com/p0deje/yard-doctest) to test all
 code examples in our YARD documentation. To run `doctest` locally:
@@ -204,7 +228,7 @@ locally:
 bundle exec dokaz
 ```
 
-### A Note on Testing
+## 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)
@@ -254,12 +278,11 @@ the [code of conduct](https://github.com/panorama-ed/memo_wise/blob/main/CODE_OF
 ## Releasing
 
 To make a new release of `MemoWise` to
-[RubyGems](https://rubygems.org/gems/memo_wise), first install the release
+[RubyGems](https://rubygems.org/gems/memo_wise), first install the `release`
 dependencies (e.g. `rake`) as follows:
 
 ```shell
-bundle config --local with 'release'
-bundle install
+BUNDLE_WITH=release bundle install
 ```
 
 Then carry out these steps:

data/benchmarks/Gemfile

@@ -6,7 +6,7 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 ruby ">= 2.7.7"
 
-gem "benchmark-ips", "2.12.0"
+gem "benchmark-ips", "2.13.0"
 
 if RUBY_VERSION > "3"
   gem "dry-core", "1.0.1"

data/lib/memo_wise/version.rb

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

data/lib/memo_wise.rb

@@ -31,12 +31,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/3.2.1/Module.html#method-i-prepend)
+  # - **Q:** Why is [Module#prepend](https://ruby-doc.org/3.2.2/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/3.2.1/Object.html#method-i-freeze).
+  #          [Object#freeze](https://ruby-doc.org/3.2.2/Object.html#method-i-freeze).
   #
   # This approach supports memoization on frozen (immutable) objects -- for
   # example, classes created by the
@@ -78,6 +78,22 @@ module MemoWise
     end
   HEREDOC
 
+  module CreateMemoWiseStateOnExtended
+    def extended(base)
+      MemoWise::InternalAPI.create_memo_wise_state!(base)
+      super
+    end
+  end
+  private_constant(:CreateMemoWiseStateOnExtended)
+
+  module CreateMemoWiseStateOnInherited
+    def inherited(subclass)
+      MemoWise::InternalAPI.create_memo_wise_state!(subclass)
+      super
+    end
+  end
+  private_constant(:CreateMemoWiseStateOnInherited)
+
   # @private
   #
   # Private setup method, called automatically by `prepend MemoWise` in a class.
@@ -85,7 +101,7 @@ module MemoWise
   # @param target [Class]
   #   The `Class` into to prepend the MemoWise methods e.g. `memo_wise`
   #
-  # @see https://ruby-doc.org/3.2.1/Module.html#method-i-prepend
+  # @see https://ruby-doc.org/3.2.2/Module.html#method-i-prepend
   #
   # @example
   #   class Example
@@ -100,7 +116,7 @@ module MemoWise
       #
       # This is necessary in addition to the `#initialize` method definition
       # above because
-      # [`Class#allocate`](https://ruby-doc.org/3.2.1/Class.html#method-i-allocate)
+      # [`Class#allocate`](https://ruby-doc.org/3.2.2/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
@@ -136,9 +152,7 @@ module MemoWise
             #
             # On method call `@_memo_wise` would still be `nil`
             # causing error when fetching cache from `@_memo_wise`
-            def klass.extended(base)
-              MemoWise::InternalAPI.create_memo_wise_state!(base)
-            end
+            klass.singleton_class.prepend(CreateMemoWiseStateOnExtended)
           end
         when Hash
           unless method_name_or_hash.keys == [:self]
@@ -159,12 +173,11 @@ module MemoWise
 
         # 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
+        if klass.is_a?(Class) && !klass.singleton_class?
+          klass.singleton_class.prepend(CreateMemoWiseStateOnInherited)
+        else
+          klass.prepend(CreateMemoWiseStateOnInherited)
+        end
 
         raise ArgumentError, "#{method_name.inspect} must be a Symbol" unless method_name.is_a?(Symbol)
 
@@ -255,7 +268,7 @@ module MemoWise
         )
       end
 
-      # Override [Module#instance_method](https://ruby-doc.org/3.2.1/Module.html#method-i-instance_method)
+      # Override [Module#instance_method](https://ruby-doc.org/3.2.2/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,

data/memo_wise.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
     "marc@usainnov.com",
   ]
 
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memo_wise
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Panorama Education
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -64,14 +64,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: The wise choice for Ruby memoization