memo_wise 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcbf16d5dbb7dcebd8181d89b17e550f493afb08e8c3f46c2e56d1c6d224a71d
-  data.tar.gz: bff1adee597c5a29fea1223604733a23b5b10e800e217d7b7e73d715b0c221cf
+  metadata.gz: e8952e8502c321491683a97a919c0602525679ec9a31e8e8df7262e99c3dd7d7
+  data.tar.gz: 45f435f7ed3849ff5c5428f9f87889f0ae9174e3d86acf932b1dfad997b96e9f
 SHA512:
-  metadata.gz: 477aac5ab8f66cf7287ff976a484d8ba06447587f997e612fccee952d003b688c79d9d934f28d730443d7c23fdeca4d90ec0adb79f6dea9f5bdc11b0b9d3820e
-  data.tar.gz: 99175b330fd6235bab7967545177298d2ccaa3fbab2c2d860aaa7f686f48e581ec7d5ef2e036a760759e48bec8618b24b1784227e9eb762052dac4649f102813
+  metadata.gz: 89e03eef772cbf1ac2ba3e8e465b163a8486fcac2d63dd07c7e840c9455efbef66ae728c05210ca78fabe22ea8b0d397c671ba2aa8e596c5239e8da868535967
+  data.tar.gz: 10592d9814aa8085e140e79f90174ef93b627d54330294bc0427f0a6316464d4fa3d01f5a25b84aa59f8e98a7bf9c5511d9d0087f82efd4a3519b0e47637e6ab

data/CHANGELOG.md

@@ -5,7 +5,7 @@ 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.9.0...HEAD)
+## [Unreleased](https://github.com/panorama-ed/memo_wise/compare/v1.10.0...HEAD)
 
 **Gem enhancements:**
 
@@ -13,6 +13,18 @@ _No breaking changes!_
 
 **Project enhancements:**
 
+## [v1.10.0](https://github.com/panorama-ed/memo_wise/compare/v1.9.0...v1.10.0)
+
+**Gem enhancements:**
+
+- Reduced gem size from 173 kB compressed (312 kB unpacked) to 20 kB (68 kB unpacked) [[#345](https://github.com/panorama-ed/memo_wise/pull/345)]
+
+_No breaking changes!_
+
+**Project enhancements:**
+
+- Updated official test coverage to support Ruby 3.3 [[#335](https://github.com/panorama-ed/memo_wise/pull/335)]
+
 ## [v1.9.0](https://github.com/panorama-ed/memo_wise/compare/v1.8.0...v1.9.0)
 
 **Gem enhancements:**
@@ -70,7 +82,7 @@ _No breaking changes!_
 
 **Project enhancements:**
 
-- Update official test coverage to support Ruby 3.1 [[#263](https://github.com/panorama-ed/memo_wise/pull/263)]
+- Updated official test coverage to support Ruby 3.1 [[#263](https://github.com/panorama-ed/memo_wise/pull/263)]
 
 ## [v1.5.0](https://github.com/panorama-ed/memo_wise/compare/v1.4.0...v1.5.0) - 2021-12-17
 

data/README.md

@@ -114,19 +114,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.11.0).
 
-Results using Ruby 3.2.2:
+Results using Ruby 3.3.2:
 
 |Method arguments|`Dry::Core`\* (1.0.1)|`Memery` (1.5.0)|
 |--|--|--|
-|`()` (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|
+|`()` (none)|0.60x|3.17x|
+|`(a)`|1.01x|7.94x|
+|`(a, b)`|0.85x|6.38x|
+|`(a:)`|1.00x|11.78x|
+|`(a:, b:)`|0.88x|9.67x|
+|`(a, b:)`|0.83x|9.44x|
+|`(a, *args)`|0.67x|1.45x|
+|`(a:, **kwargs)`|0.68x|1.88x|
+|`(a, *args, b:, **kwargs)`|0.64x|1.29x|
 
 \* `Dry::Core`
 [may cause incorrect behavior caused by hash collisions](https://github.com/dry-rb/dry-core/issues/63).
@@ -180,7 +180,7 @@ versions:
 
 We maintain API documentation using [YARD](https://yardoc.org/), which is
 published automatically at
-[RubyDoc.info](https://rubydoc.info/gems/memo_wise). 
+[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:

data/lib/memo_wise/version.rb

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

data/lib/memo_wise.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-# Disable RuboCop here because Ruby < 3.2 does not load `set` by default.
-require "set" # rubocop:disable Lint/RedundantRequireStatement
+require "set" # Ruby < 3.2 does not load `set` by default.
 
 require "memo_wise/internal_api"
 require "memo_wise/version"
@@ -31,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/3.2.2/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/3.2.2/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
@@ -101,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/3.2.2/Module.html#method-i-prepend
+  # @see https://ruby-doc.org/3.3.1/Module.html#method-i-prepend
   #
   # @example
   #   class Example
@@ -116,7 +115,7 @@ module MemoWise
       #
       # This is necessary in addition to the `#initialize` method definition
       # above because
-      # [`Class#allocate`](https://ruby-doc.org/3.2.2/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
@@ -268,7 +267,7 @@ module MemoWise
         )
       end
 
-      # Override [Module#instance_method](https://ruby-doc.org/3.2.2/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.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Panorama Education
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-04 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -23,32 +23,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".dokaz"
-- ".github/PULL_REQUEST_TEMPLATE.md"
-- ".github/dependabot.yml"
-- ".github/workflows/dependency-review.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
@@ -71,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 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/dependency-review.yml

@@ -1,23 +0,0 @@
-# Dependency Review Action
-  #
-  # This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
-  #
-  # Source repository: https://github.com/actions/dependency-review-action
-  # Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
-  name: 'Dependency Review'
-  on: [pull_request]
-
-  permissions:
-    contents: read
-
-  jobs:
-    dependency-review:
-      runs-on: ubuntu-latest
-      steps:
-        - name: 'Checkout Repository'
-          uses: actions/checkout@v4
-        - name: 'Dependency Review'
-          uses: actions/dependency-review-action@v4
-          with:
-            # Possible values: "critical", "high", "moderate", "low" 
-            fail-on-severity: high

data/.github/workflows/main.yml

@@ -1,58 +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.5, 2.6, 2.7, '3.0', 3.1, 3.2, jruby, truffleruby-head]
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-
-    # Conditionally configure bundler via environment variables as advised
-    #   * https://github.com/ruby/setup-ruby#bundle-config
-    - name: Set bundler environment variables
-      run: |
-        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
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-
-    - run: bundle exec rspec
-
-    - 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
-
-    - run: bundle exec rubocop
-      if: matrix.ruby == 3.2
-
-    - run: |
-        bundle exec yard doctest
-        bundle exec dokaz
-      if: matrix.ruby == 3.2
-
-    - name: Run benchmarks on Ruby 2.7 or 3.2
-      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.2'

data/.gitignore

@@ -1,16 +0,0 @@
-/.bundle/
-/benchmarks/.bundle/
-/benchmarks/Gemfile.lock
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-# Jetbrains Rubymine IDE files
-.idea

data/.rspec

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

data/.rubocop.yml

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

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,37 +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.13"
-  gem "values", "~> 1"
-end
-
-# Excluded from CI except on latest MRI Ruby, to reduce compatibility burden
-group :checks, optional: true do
-  gem "panolint-ruby", github: "panorama-ed/panolint-ruby", 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, 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
-
-# Optional, only used locally to release to rubygems.org
-group :release, optional: true do
-  gem "rake"
-end

data/Gemfile.lock

@@ -1,113 +0,0 @@
-GIT
-  remote: https://github.com/panorama-ed/panolint-ruby.git
-  revision: a93988ea554177cf0ec9ef636c442f9d3af49a10
-  branch: main
-  specs:
-    panolint-ruby (0)
-      rubocop (= 1.51.0)
-      rubocop-performance (= 1.18.0)
-      rubocop-rspec (= 2.22.0)
-
-PATH
-  remote: .
-  specs:
-    memo_wise (1.9.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    ast (2.4.2)
-    diff-lcs (1.5.1)
-    docile (1.4.0)
-    dokaz (0.0.5)
-      ansi
-      rouge (~> 4)
-      slop (~> 3)
-    json (2.6.3)
-    minitest (5.18.0)
-    parallel (1.23.0)
-    parser (3.2.2.1)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.1.0)
-    redcarpet (3.6.0)
-    regexp_parser (2.8.0)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
-    rouge (4.1.0)
-    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.13.0)
-    rspec-mocks (3.13.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.51.0)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.18.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.23.1)
-      rubocop (~> 1.33)
-    rubocop-performance (1.18.0)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.22.0)
-      rubocop (~> 1.33)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
-    ruby-progressbar (1.13.0)
-    simplecov (0.22.0)
-      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)
-    strscan (3.1.0)
-    unicode-display_width (2.4.2)
-    values (1.8.0)
-    webrick (1.8.1)
-    yard (0.9.36)
-    yard-doctest (0.1.17)
-      minitest
-      yard
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  dokaz (~> 0.0.5)
-  memo_wise!
-  panolint-ruby!
-  rake
-  redcarpet (~> 3.6)
-  rspec (~> 3.13)
-  simplecov
-  simplecov-cobertura
-  values (~> 1)
-  webrick (~> 1.8)
-  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.7"
-
-gem "benchmark-ips", "2.13.0"
-
-if RUBY_VERSION > "3"
-  gem "dry-core", "1.0.1"
-  gem "memery", "1.5.0"
-else
-  gem "ddmemoize", "1.0.0"
-  gem "memoist", "0.16.2"
-  gem "memoized", "1.1.1"
-  gem "memoizer", "1.0.3"
-end
-
-gem "memo_wise", github: "panorama-ed/memo_wise", branch: "main"

data/benchmarks/benchmarks.rb

@@ -1,274 +0,0 @@
-# frozen_string_literal: true
-
-require "benchmark/ips"
-
-require "tempfile"
-
-github_memo_wise_path = Gem.loaded_specs["memo_wise"].full_gem_path
-
-# This string is both used for temp filepaths necessary to separate the GitHub
-# version of MemoWise and the local version, and used for the reported results
-GITHUB_MAIN = "MemoWise_GitHubMain"
-
-# We download a the main branch of MemoWise on GitHub into a tmp directory to
-# compare against the local version when we run benchmarks
-Dir.mktmpdir do |directory|
-  Dir["#{github_memo_wise_path}/lib/**/*.rb"].each do |file|
-    Tempfile.open([File.basename(file)[0..-4], ".rb"], directory) do |tempfile|
-      tempfile.write(File.read(file).gsub("MemoWise", GITHUB_MAIN))
-      tempfile.rewind
-      require tempfile.path
-    end
-  end
-end
-
-require_relative "../lib/memo_wise"
-
-# Some gems do not yet work in Ruby 3 so we only require them if they're loaded
-# in the Gemfile.
-%w[memery memoist memoized memoizer ddmemoize dry-core].
-  each { |gem| require gem if Gem.loaded_specs.key?(gem) }
-
-# The VERSION constant does not get loaded above for these gems.
-%w[memoized memoizer].
-  each { |gem| require "#{gem}/version" if Gem.loaded_specs.key?(gem) }
-
-# The Memoizable module from dry-core needs to be required manually
-require "dry/core/memoizable" if Gem.loaded_specs.key?("dry-core")
-
-class BenchmarkSuiteWithoutGC
-  def warming(*)
-    run_gc
-  end
-
-  def running(*)
-    run_gc
-  end
-
-  def warmup_stats(*); end
-
-  def add_report(*); end
-
-  private
-
-  def run_gc
-    GC.enable
-    GC.start
-    GC.disable
-  end
-end
-suite = BenchmarkSuiteWithoutGC.new
-
-BenchmarkGem = Struct.new(:klass, :activation_code, :memoization_method) do
-  def benchmark_name
-    "#{klass} (#{klass::VERSION})"
-  end
-end
-
-# We alphabetize this list for easier readability, but shuffle the list before
-# using it to minimize the chance that our benchmarks are affected by ordering.
-# NOTE: Some gems do not yet work in Ruby 3 so we only test with them if they've
-# been `require`d.
-BENCHMARK_GEMS = [
-  BenchmarkGem.new(MemoWise_GitHubMain, "prepend #{GITHUB_MAIN}", :memo_wise),
-  BenchmarkGem.new(MemoWise, "prepend MemoWise", :memo_wise),
-  (BenchmarkGem.new(DDMemoize, "DDMemoize.activate(self)", :memoize) if defined?(DDMemoize)),
-  (BenchmarkGem.new(Dry::Core, "include Dry::Core::Memoizable", :memoize) if defined?(Dry::Core)),
-  (BenchmarkGem.new(Memery, "include Memery", :memoize) if defined?(Memery)),
-  (BenchmarkGem.new(Memoist, "extend Memoist", :memoize) if defined?(Memoist)),
-  (BenchmarkGem.new(Memoized, "include Memoized", :memoize) if defined?(Memoized)),
-  (BenchmarkGem.new(Memoizer, "include Memoizer", :memoize) if defined?(Memoizer))
-].compact.shuffle
-
-# Use metaprogramming to ensure that each class is created in exactly the
-# the same way.
-BENCHMARK_GEMS.each do |benchmark_gem|
-  eval <<~HEREDOC, binding, __FILE__, __LINE__ + 1 # rubocop:disable Security/Eval
-    class #{benchmark_gem.klass}Example
-      #{benchmark_gem.activation_code}
-
-      def no_args
-        100
-      end
-      #{benchmark_gem.memoization_method} :no_args
-
-      def one_positional_arg(a)
-        100
-      end
-      #{benchmark_gem.memoization_method} :one_positional_arg
-
-      def positional_args(a, b)
-        100
-      end
-      #{benchmark_gem.memoization_method} :positional_args
-
-      def one_keyword_arg(a:)
-        100
-      end
-      #{benchmark_gem.memoization_method} :one_keyword_arg
-
-      def keyword_args(a:, b:)
-        100
-      end
-      #{benchmark_gem.memoization_method} :keyword_args
-
-      def positional_and_keyword_args(a, b:)
-        100
-      end
-      #{benchmark_gem.memoization_method} :positional_and_keyword_args
-
-      def positional_and_splat_args(a, *args)
-        100
-      end
-      #{benchmark_gem.memoization_method} :positional_and_splat_args
-
-      def keyword_and_double_splat_args(a:, **kwargs)
-        100
-      end
-      #{benchmark_gem.memoization_method} :keyword_and_double_splat_args
-
-      def positional_splat_keyword_and_double_splat_args(a, *args, b:, **kwargs)
-        100
-      end
-      #{benchmark_gem.memoization_method} :positional_splat_keyword_and_double_splat_args
-    end
-  HEREDOC
-end
-
-N_RESULT_DECIMAL_DIGITS = 2
-
-# Each method within these benchmarks is initially run once to memoize the
-# result value, so our benchmark only tests memoized retrieval time.
-benchmark_lambdas = [
-  lambda do |x, instance, benchmark_gem|
-    instance.no_args
-
-    x.report("#{benchmark_gem.benchmark_name}: ()") do
-      instance.no_args
-    end
-  end,
-  lambda do |x, instance, benchmark_gem|
-    instance.one_positional_arg(1)
-
-    x.report("#{benchmark_gem.benchmark_name}: (a)") do
-      instance.one_positional_arg(1)
-    end
-  end,
-  lambda do |x, instance, benchmark_gem|
-    instance.positional_args(1, 2)
-
-    x.report("#{benchmark_gem.benchmark_name}: (a, b)") do
-      instance.positional_args(1, 2)
-    end
-  end,
-  lambda do |x, instance, benchmark_gem|
-    instance.one_keyword_arg(a: 1)
-
-    x.report("#{benchmark_gem.benchmark_name}: (a:)") do
-      instance.one_keyword_arg(a: 1)
-    end
-  end,
-  lambda do |x, instance, benchmark_gem|
-    instance.keyword_args(a: 1, b: 2)
-
-    x.report("#{benchmark_gem.benchmark_name}: (a:, b:)") do
-      instance.keyword_args(a: 1, b: 2)
-    end
-  end,
-  lambda do |x, instance, benchmark_gem|
-    instance.positional_and_keyword_args(1, b: 2)
-
-    x.report("#{benchmark_gem.benchmark_name}: (a, b:)") do
-      instance.positional_and_keyword_args(1, b: 2)
-    end
-  end,
-  lambda do |x, instance, benchmark_gem|
-    instance.positional_and_splat_args(1, 2)
-
-    x.report("#{benchmark_gem.benchmark_name}: (a, *args)") do
-      instance.positional_and_splat_args(1, 2)
-    end
-  end,
-  lambda do |x, instance, benchmark_gem|
-    instance.keyword_and_double_splat_args(a: 1, b: 2)
-
-    x.report("#{benchmark_gem.benchmark_name}: (a:, **kwargs)") do
-      instance.keyword_and_double_splat_args(a: 1, b: 2)
-    end
-  end,
-  lambda do |x, instance, benchmark_gem|
-    instance.positional_splat_keyword_and_double_splat_args(1, 2, b: 3, a: 4)
-
-    x.report("#{benchmark_gem.benchmark_name}: (a, *args, b:, **kwargs)") do
-      instance.positional_splat_keyword_and_double_splat_args(1, 2, b: 3, a: 4)
-    end
-  end
-]
-
-# We benchmark different cases separately, to ensure that slow performance in
-# one method or code path isn't hidden by fast performance in another.
-benchmark_jsons = benchmark_lambdas.map do |benchmark|
-  json_file = Tempfile.new
-
-  Benchmark.ips do |x|
-    x.config(suite: suite)
-    BENCHMARK_GEMS.each do |benchmark_gem|
-      instance = Object.const_get("#{benchmark_gem.klass}Example").new
-
-      benchmark.call(x, instance, benchmark_gem)
-    end
-
-    x.compare!
-    x.json! json_file.path
-  end
-
-  JSON.parse(json_file.read)
-end
-
-[true, false].each do |github_comparison|
-  benchmark_jsons.each_with_index do |benchmark_json, i|
-    # We print a comparison table after we run each benchmark to copy into our
-    # README.md
-
-    # MemoWise will not appear in the comparison table, but we will use it to
-    # compare against other gems' benchmarks
-    memo_wise = benchmark_json.find { |json| json["name"].split.first == "MemoWise" }
-    benchmark_json -= [memo_wise]
-
-    github_main = benchmark_json.find { |json| json["name"].split.first == GITHUB_MAIN }
-    benchmark_json = github_comparison ? [github_main] : benchmark_json - [github_main]
-
-    # Sort benchmarks by gem name to alphabetize our final output table.
-    benchmark_json.sort_by! { |json| json["name"] }
-
-    # Print headers based on the first benchmark_json
-    if i.zero?
-      benchmark_headers = benchmark_json.map do |benchmark_gem|
-        # Gem name is of the form:
-        # "MemoWise (1.1.0): ()"
-        # We use this mapping to get a header of the form
-        # "`MemoWise` (1.1.0)
-        gem_name_parts = benchmark_gem["name"].split
-        "`#{gem_name_parts[0]}` #{gem_name_parts[1][...-1]}"
-      end.join("|")
-      puts "|Method arguments|#{benchmark_headers}|"
-      puts "#{'|--' * (benchmark_json.size + 1)}|"
-    end
-
-    output_str = benchmark_json.map do |bgem|
-      # "%.2f" % 12.345 => "12.34" (instead of "12.35")
-      #   See: https://bugs.ruby-lang.org/issues/12548
-      # 1.00.round(2).to_s => "1.0" (instead of "1.00")
-      #
-      # So to round and format correctly, we first use Float#round and then %
-      "%.#{N_RESULT_DECIMAL_DIGITS}fx" %
-        (memo_wise["central_tendency"] / bgem["central_tendency"]).round(N_RESULT_DECIMAL_DIGITS)
-    end.join("|")
-
-    name = memo_wise["name"].partition(": ").last
-    puts "|`#{name}`#{' (none)' if name == '()'}|#{output_str}|"
-  end
-
-  # Output a blank line between sections
-  puts ""
-end

data/bin/console

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "memo_wise"
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/memo_wise.gemspec

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/memo_wise/version"
-
-Gem::Specification.new do |spec|
-  spec.name     = "memo_wise"
-  spec.version  = MemoWise::VERSION
-  spec.summary  = "The wise choice for Ruby memoization"
-  spec.homepage = "https://github.com/panorama-ed/memo_wise"
-  spec.license  = "MIT"
-
-  spec.authors = [
-    "Panorama Education",
-    "Jacob Evelyn",
-    "Jemma Issroff",
-    "Marc Siegel",
-  ]
-
-  spec.email = [
-    "engineering@panoramaed.com",
-    "jacobevelyn@gmail.com",
-    "jemmaissroff@gmail.com",
-    "marc@usainnov.com",
-  ]
-
-  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
-  # into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{^(test|spec|features)/})
-    end
-  end
-  spec.require_paths = ["lib"]
-
-  spec.metadata = {
-    "rubygems_mfa_required" => "true",
-    "changelog_uri" => "https://github.com/panorama-ed/memo_wise/blob/main/CHANGELOG.md",
-    "source_code_uri" => "https://github.com/panorama-ed/memo_wise"
-  }
-end