memo_wise 1.7.0 → 1.11.0

data/lib/memo_wise/internal_api.rb

@@ -126,18 +126,7 @@ module MemoWise
     def self.original_class_from_singleton(klass)
       raise ArgumentError, "Must be a singleton class: #{klass.inspect}" unless klass.singleton_class?
 
-      # Since we call this method a lot, we memoize the results. This can have a
-      # huge impact; for example, in our test suite this drops our test times
-      # from over five minutes to just a few seconds.
-      @original_class_from_singleton ||= {}
-
-      # Search ObjectSpace
-      #   * 1:1 relationship of singleton class to original class is documented
-      #   * Performance concern: searches all Class objects
-      #     But, only runs at load time and results are memoized
-      @original_class_from_singleton[klass] ||= ObjectSpace.each_object(Module).find do |cls|
-        cls.singleton_class == klass
-      end
+      find_attached_object(klass)
     end
 
     # Convention we use for renaming the original method when we replace with
@@ -199,7 +188,7 @@ module MemoWise
     #   The class to which we are prepending MemoWise to provide memoization.
     # @return [Class] where we look for method definitions
     def self.target_class(target)
-      if target.instance_of?(Class)
+      if target.instance_of?(Class) || target.instance_of?(Module)
         # A class's methods are defined in its singleton class
         target.singleton_class
       else
@@ -208,5 +197,42 @@ module MemoWise
       end
     end
     private_class_method :target_class
+
+    if Module.singleton_class.respond_to?(:attached_object)
+      # In Ruby3.2+, for singleton classes, `#attached_object` returns the object this class is for
+      # https://bugs.ruby-lang.org/issues/12084
+      #
+      # @param klass [Class]
+      #   Singleton class to find the original class of
+      #
+      # @return Class
+      #   Original class for which `klass` is the singleton class.
+      def self.find_attached_object(klass)
+        klass.attached_object
+      end
+    else
+      # :nocov:
+      # @param klass [Class]
+      #   Singleton class to find the original class of
+      #
+      # @return Class
+      #   Original class for which `klass` is the singleton class.
+      def self.find_attached_object(klass)
+        # Since we call this method a lot, we memoize the results. This can have a
+        # huge impact; for example, in our test suite this drops our test times
+        # from over five minutes to just a few seconds.
+        @original_class_from_singleton ||= {}
+
+        # Search ObjectSpace
+        #   * 1:1 relationship of singleton class to original class is documented
+        #   * Performance concern: searches all Class objects
+        #     But, only runs at load time and results are memoized
+        @original_class_from_singleton[klass] ||= ObjectSpace.each_object(Module).find do |cls|
+          cls.singleton_class == klass
+        end
+      end
+      # :nocov:
+    end
+    private_class_method :find_attached_object
   end
 end

data/lib/memo_wise/version.rb

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

data/lib/memo_wise.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require "set"
+require "set" # Ruby < 3.2 does not load `set` by default.
 
-require "memo_wise/internal_api"
-require "memo_wise/version"
+require_relative "memo_wise/internal_api"
+require_relative "memo_wise/version"
 
 # MemoWise is the wise choice for memoization in Ruby.
 #
@@ -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.1.0/Module.html#method-i-prepend)
+  # - **Q:** Why is [Module#prepend](https://ruby-doc.org/3.3.1/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.1.0/Object.html#method-i-freeze).
+  #          [Object#freeze](https://ruby-doc.org/3.3.1/Object.html#method-i-freeze).
   #
   # This approach supports memoization on frozen (immutable) objects -- for
   # example, classes created by the
@@ -77,6 +77,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.
@@ -84,7 +100,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.1.0/Module.html#method-i-prepended
+  # @see https://ruby-doc.org/3.3.1/Module.html#method-i-prepend
   #
   # @example
   #   class Example
@@ -99,7 +115,7 @@ module MemoWise
       #
       # This is necessary in addition to the `#initialize` method definition
       # above because
-      # [`Class#allocate`](https://ruby-doc.org/core-3.1.0/Class.html#method-i-allocate)
+      # [`Class#allocate`](https://ruby-doc.org/3.3.1/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
@@ -135,9 +151,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]
@@ -158,12 +172,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)
 
@@ -254,7 +267,7 @@ module MemoWise
         )
       end
 
-      # Override [Module#instance_method](https://ruby-doc.org/core-3.1.0/Module.html#method-i-instance_method)
+      # Override [Module#instance_method](https://ruby-doc.org/3.3.1/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.7.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Panorama Education
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2025-02-26 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -23,31 +23,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".dokaz"
-- ".github/PULL_REQUEST_TEMPLATE.md"
-- ".github/dependabot.yml"
-- ".github/workflows/main.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".yardopts"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- benchmarks/Gemfile
-- benchmarks/benchmarks.rb
-- bin/console
-- bin/setup
 - lib/memo_wise.rb
 - lib/memo_wise/internal_api.rb
 - lib/memo_wise/version.rb
-- logo/logo.png
-- memo_wise.gemspec
 homepage: https://github.com/panorama-ed/memo_wise
 licenses:
 - MIT
@@ -63,14 +44,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: The wise choice for Ruby memoization

data/.dokaz

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

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +0,0 @@
-**Before merging:**
-
-- [ ] 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

@@ -1,20 +0,0 @@
-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

@@ -1,57 +0,0 @@
-name: Main
-on:
-  pull_request:
-    branches:
-    - main
-  push:
-    branches:
-    - main
-jobs:
-  ci:
-    name: CI
-    strategy:
-      fail-fast: false
-      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, jruby, truffleruby-head]
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-
-    # 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.1
-
-    # 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 }}
-        bundler-cache: true
-
-    - run: bundle exec rspec
-
-    - uses: codecov/codecov-action@v2
-      with:
-        files: ./coverage/coverage.xml
-        fail_ci_if_error: true # optional (default = false)
-        verbose: true # optional (default = false)
-      if: matrix.ruby == 3.1
-
-    - run: bundle exec rubocop
-      if: matrix.ruby == 3.1
-
-    - run: |
-        bundle exec yard doctest
-        bundle exec dokaz
-      if: matrix.ruby == 3.1
-
-    - 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.1'

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/benchmarks/.bundle/
-/benchmarks/Gemfile.lock
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,17 +0,0 @@
-inherit_gem:
-  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/.ruby-version

@@ -1 +0,0 @@
-3.1.0

data/.yardopts

@@ -1,8 +0,0 @@
---readme README.md
---title 'MemoWise Documentation'
---charset utf-8
---markup markdown
---plugin yard-doctest
---no-private
-'lib/**/*.rb' - '*.md'
-LICENSE.txt

data/CODE_OF_CONDUCT.md

@@ -1,76 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at engineering@panoramaed.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an
-incident. Further details of specific enforcement policies may be posted
-separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.4, available at
-[https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-gemspec
-
-group :test do
-  gem "rspec", "~> 3.11"
-  gem "values", "~> 1"
-end
-
-# Excluded from CI except on latest MRI Ruby, to reduce compatibility burden
-group :checks do
-  gem "panolint", github: "panorama-ed/panolint", branch: "main"
-
-  # Simplecov to generate coverage info
-  gem "simplecov", require: false
-
-  # Simplecov-cobertura to generate an xml coverage file to upload to Codecov
-  gem "simplecov-cobertura", require: false
-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"
-end
-
-# Optional, only used locally to release to rubygems.org
-group :release, optional: true do
-  gem "rake"
-end

data/Gemfile.lock

@@ -1,124 +0,0 @@
-GIT
-  remote: https://github.com/panorama-ed/panolint.git
-  revision: 32da31ae800b7e16068b6495397cd98aa04c68a3
-  branch: main
-  specs:
-    panolint (0.1.4)
-      brakeman (>= 4.8, < 6.0)
-      rubocop (>= 0.83, < 2.0)
-      rubocop-performance (~> 1.5)
-      rubocop-rails (~> 2.5)
-      rubocop-rake (~> 0.5)
-      rubocop-rspec (~> 2.0)
-
-PATH
-  remote: .
-  specs:
-    memo_wise (1.7.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (7.0.2.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    ansi (1.5.0)
-    ast (2.4.2)
-    brakeman (5.2.1)
-    concurrent-ruby (1.1.9)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    dokaz (0.0.4)
-      ansi
-      rouge
-      slop (~> 3)
-    i18n (1.10.0)
-      concurrent-ruby (~> 1.0)
-    minitest (5.15.0)
-    parallel (1.21.0)
-    parser (3.1.1.0)
-      ast (~> 2.4.1)
-    rack (2.2.3)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    redcarpet (3.5.1)
-    regexp_parser (2.2.1)
-    rexml (3.2.5)
-    rouge (3.28.0)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.25.1)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.13.2)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.13.2)
-      activesupport (>= 4.2.0)
-      rack (>= 1.1)
-      rubocop (>= 1.7.0, < 2.0)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
-    rubocop-rspec (2.9.0)
-      rubocop (~> 1.19)
-    ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-cobertura (2.1.0)
-      rexml
-      simplecov (~> 0.19)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    slop (3.6.0)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    values (1.8.0)
-    webrick (1.7.0)
-    yard (0.9.27)
-      webrick (~> 1.7.0)
-    yard-doctest (0.1.17)
-      minitest
-      yard
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  dokaz
-  memo_wise!
-  panolint!
-  rake
-  redcarpet (~> 3.5)
-  rspec (~> 3.11)
-  simplecov
-  simplecov-cobertura
-  values (~> 1)
-  yard (~> 0.9)
-  yard-doctest (~> 0.1)
-
-BUNDLED WITH
-   2.3.8

data/Rakefile

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"

data/benchmarks/Gemfile

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-ruby ">= 2.7.5"
-
-gem "benchmark-ips", "2.10.0"
-
-if RUBY_VERSION > "3"
-  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"
-end
-
-gem "memo_wise", github: "panorama-ed/memo_wise", branch: "main"