memo_wise 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 580c75382ed661927635d86573723585ac070bb1b173684ca58d7c47250cdeeb
-  data.tar.gz: 8fa8aadd0eeb70bedb7e7f149942b1959ce3b807ad24c99e4b5558fe283fc669
+  metadata.gz: c5a910792fbcb5c44a6b7e82d8c62b4c11c64fef9d59ac79a326a34e8fde9b87
+  data.tar.gz: b00093fd37b3f9ff175d41db4eafde58b6af04037f07b1c02328e1aab84d674b
 SHA512:
-  metadata.gz: 8f12681421e4994476929d36d6ee7d16c7a67f4641540a8291b8fa1c939bc9d4877930ace711544ed8f9ec80d2db92ac266c3155e1e0a6fa05e4cea75630c704
-  data.tar.gz: 82094910c30c4bfbb317b285f3a7f6bd7c03c34d427d0788c58c2e7cf329ab03e37862d817b3686edcf4b03d55c084a834964aca5957137f2199927155611fe6
+  metadata.gz: 9e93861cd450870d06793d72a19452354a983f0a2211e65086d699cb3b6c710b9d34e52bf7afa3a4e26a60e831fea9cc8b7596324f4daae83d1af84dfa9095a5
+  data.tar.gz: 49855e1a33e75516493a7d6ddb89b22d5856e4a8f86ccdf32ace6adde03a1873e49e504ece5d2c10122d4eeff09967257495732006e00f8d1f01966096572e8f

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.11.0...HEAD)
+## [Unreleased](https://github.com/panorama-ed/memo_wise/compare/v1.12.0...HEAD)
 
 **Gem enhancements:** none
 
@@ -13,6 +13,22 @@ _No breaking changes!_
 
 **Project enhancements:** none
 
+## [v1.12.0](https://github.com/panorama-ed/memo_wise/compare/v1.11.0...v1.12.0)
+
+**Gem enhancements:** none
+
+- Allowed memoization when `include`d modules `prepend MemoWise` and define `initialize` [[#327]](https://github.com/panorama-ed/memo_wise/pull/327)
+
+_Breaking changes:_
+- Removed Ruby 2.7 (EOL) and 3.0 (EOL) support to allow enhancement noted above [[#327]](https://github.com/panorama-ed/memo_wise/pull/327)
+
+**Project enhancements:**
+
+- Updated official test coverage to support Ruby 3.4 [[#335](https://github.com/panorama-ed/memo_wise/pull/335)]
+- Updated `memery` gem version to 1.7.0 in benchmarks [[#380](https://github.com/panorama-ed/memo_wise/pull/380)]
+- Added `short_circu_it` gem to benchmarks [[#384](https://github.com/panorama-ed/memo_wise/pull/384)]
+- Increased benchmark warmup time to reduce warmup artifacts when benchmarking locally [[#355](https://github.com/panorama-ed/memo_wise/pull/355)]
+
 ## [v1.11.0](https://github.com/panorama-ed/memo_wise/compare/v1.10.0...v1.11.0)
 
 **Gem enhancements:**
@@ -40,6 +56,7 @@ _No breaking changes!_
 
 - Updated official test coverage to support Ruby 3.3 [[#335](https://github.com/panorama-ed/memo_wise/pull/335)]
 - Added `alt_memery` and `memoist3` to benchmarks [[#339](https://github.com/panorama-ed/memo_wise/pull/339)]
+- Updated `memery` gem version to 1.6.0 in benchmarks [[#339](https://github.com/panorama-ed/memo_wise/pull/339)]
 - Updated benchmark results in `README.md` to Ruby 3.3.5 [[#339](https://github.com/panorama-ed/memo_wise/pull/339)]
 
 ## [v1.9.0](https://github.com/panorama-ed/memo_wise/compare/v1.8.0...v1.9.0)
@@ -69,9 +86,9 @@ _No breaking changes!_
 
 - Switched RuboCop configuration from `panolint` to `panolint-ruby` [[#312](https://github.com/panorama-ed/memo_wise/pull/312)]
 - Updated benchmark results in `README.md` to Ruby 3.2.2 and 2.7.8 [[#313](https://github.com/panorama-ed/memo_wise/pull/297)]
-- Updated `Dry::Core` gem version to 1.0.0 in benchmarks [[#297](https://github.com/panorama-ed/memo_wise/pull/297)]
-- Updated `Memery` gem version to 1.5.0 in benchmarks [[#313](https://github.com/panorama-ed/memo_wise/pull/313)]
-- Updated `Memoized` gem version to 1.1.1 in benchmarks [[#288](https://github.com/panorama-ed/memo_wise/pull/288)]
+- Updated `dry-core` gem version to 1.0.0 in benchmarks [[#297](https://github.com/panorama-ed/memo_wise/pull/297)]
+- Updated `memery` gem version to 1.5.0 in benchmarks [[#313](https://github.com/panorama-ed/memo_wise/pull/313)]
+- Updated `memoized` gem version to 1.1.1 in benchmarks [[#288](https://github.com/panorama-ed/memo_wise/pull/288)]
 - Reorganized `CHANGELOG.md` for improved clarity and completeness [[#282](https://github.com/panorama-ed/memo_wise/pull/282)]
 
 ## [v1.7.0](https://github.com/panorama-ed/memo_wise/compare/v1.6.0...v1.7.0) - 2022-04-04
@@ -256,7 +273,7 @@ _No breaking changes!_
 
 **Project enhancements:**
 
-- Tests now assert that memoization works with the `Values` gem
+- Tests now assert that memoization works with the `values` gem
   [[#46](https://github.com/panorama-ed/memo_wise/pull/46)]
 - Added `README.md` badges for tests, docs, and RubyGems
   [[#47](https://github.com/panorama-ed/memo_wise/pull/47)]

data/README.md

@@ -114,37 +114,23 @@ 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.14.0).
 
-Results using Ruby 3.3.6:
-
-|Method arguments|`alt_memery` (2.1.0)|`dry-core`\* (1.0.2)|`memery` (1.6.0)|`memoist3` (1.0.0)|
-|--|--|--|--|--|
-|`()` (none)|12.97x|0.63x|3.31x|2.62x|
-|`(a)`|9.62x|0.99x|3.86x|14.61x|
-|`(a, b)`|7.82x|0.85x|3.12x|11.75x|
-|`(a:)`|15.36x|1.01x|6.72x|19.70x|
-|`(a:, b:)`|13.07x|0.90x|5.61x|20.64x|
-|`(a, b:)`|12.68x|0.89x|5.63x|16.27x|
-|`(a, *args)`|1.93x|0.74x|0.78x|2.85x|
-|`(a:, **kwargs)`|2.81x|0.72x|1.19x|4.48x|
-|`(a, *args, b:, **kwargs)`|1.75x|0.66x|0.87x|2.82x|
+Results using Ruby 3.4.3:
+
+|Method arguments|`alt_memery` (2.1.0)|`dry-core`\* (1.1.0)|`memery` (1.7.0)|`memoist3` (1.0.0)|`short_circu_it` (0.29.3)|
+|--|--|--|--|--|--|
+|`()` (none)|12.27x|0.58x|3.36x|2.79x|18.43x|
+|`(a)`|9.50x|0.99x|3.79x|14.93x|14.16x|
+|`(a, b)`|7.51x|0.83x|2.96x|11.84x|11.19x|
+|`(a:)`|14.32x|1.00x|6.46x|19.60x|12.81x|
+|`(a:, b:)`|12.24x|0.86x|5.56x|20.89x|10.78x|
+|`(a, b:)`|11.98x|0.85x|5.42x|16.25x|10.76x|
+|`(a, *args)`|1.91x|0.66x|0.75x|2.96x|2.80x|
+|`(a:, **kwargs)`|2.73x|0.71x|1.22x|4.69x|2.41x|
+|`(a, *args, b:, **kwargs)`|1.76x|0.63x|0.84x|3.00x|1.52x|
 
 \* `dry-core`
 [may cause incorrect behavior caused by hash collisions](https://github.com/dry-rb/dry-core/issues/63).
 
-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.14x|2.44x|23.84x|2.59x|
-|`(a)`|22.16x|14.80x|20.70x|11.67x|
-|`(a, b)`|19.39x|13.66x|18.03x|11.46x|
-|`(a:)`|30.54x|23.68x|25.21x|21.20x|
-|`(a:, b:)`|27.75x|22.59x|23.47x|20.65x|
-|`(a, b:)`|26.72x|21.39x|21.73x|19.43x|
-|`(a, *args)`|3.26x|2.31x|3.09x|1.93x|
-|`(a:, **kwargs)`|2.87x|2.29x|2.51x|2.10x|
-|`(a, *args, b:, **kwargs)`|2.23x|1.88x|1.97x|1.73x|
-
 You can run benchmarks yourself with:
 
 ```bash
@@ -153,7 +139,8 @@ $ bundle install
 $ bundle exec ruby benchmarks.rb
 ```
 
-If your results differ from what's posted here,
+If your results differ from what's posted here, or if there's another gem we
+should be benchmarking,
 [let us know](https://github.com/panorama-ed/memo_wise/issues/new)!
 
 ## Thread Safety
@@ -299,7 +286,6 @@ Then carry out these steps:
 
      **Project enhancements:** none
      ```
-   - Commit with title `Update CHANGELOG.md for x.y.z`
 
 2. Update `lib/memo_wise/version.rb`
    - Replace with upcoming version _x.y.z_

data/lib/memo_wise/version.rb

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

data/lib/memo_wise.rb

@@ -41,37 +41,8 @@ module MemoWise
   # example, classes created by the
   # [Values](https://github.com/tcrayford/Values)
   # [gem](https://rubygems.org/gems/values).
-  #
-  # To support syntax differences with keyword and positional arguments starting
-  # with ruby 2.7, we have to set up the initializer with some slightly
-  # different syntax for the different versions.  This variance in syntax is not
-  # included in coverage reports since the branch chosen will never differ
-  # within a single ruby version.  This means it is impossible for us to get
-  # 100% coverage of this line within a single CI run.
-  #
-  # See
-  # [this article](https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/)
-  # for more information.
-  #
-  # :nocov:
-  all_args = RUBY_VERSION < "2.7" ? "*" : "..."
-  # :nocov:
   class_eval <<~HEREDOC, __FILE__, __LINE__ + 1
-    # On Ruby 2.7 or greater:
-    #
-    # def initialize(...)
-    #   MemoWise::InternalAPI.create_memo_wise_state!(self)
-    #   super
-    # end
-    #
-    # On Ruby 2.6 or lower:
-    #
-    # def initialize(*)
-    #   MemoWise::InternalAPI.create_memo_wise_state!(self)
-    #   super
-    # end
-
-    def initialize(#{all_args})
+    def initialize(...)
       MemoWise::InternalAPI.create_memo_wise_state!(self)
       super
     end
@@ -93,6 +64,13 @@ module MemoWise
   end
   private_constant(:CreateMemoWiseStateOnInherited)
 
+  module CreateMemoWiseStateOnIncluded
+    def included(base)
+      base.prepend(MemoWise)
+    end
+  end
+  private_constant(:CreateMemoWiseStateOnIncluded)
+
   # @private
   #
   # Private setup method, called automatically by `prepend MemoWise` in a class.
@@ -154,10 +132,7 @@ module MemoWise
             klass.singleton_class.prepend(CreateMemoWiseStateOnExtended)
           end
         when Hash
-          unless method_name_or_hash.keys == [:self]
-            raise ArgumentError,
-                  "`:self` is the only key allowed in memo_wise"
-          end
+          raise ArgumentError, "`:self` is the only key allowed in memo_wise" unless method_name_or_hash.keys == [:self]
 
           method_name = method_name_or_hash[:self]
 
@@ -175,6 +150,8 @@ module MemoWise
         if klass.is_a?(Class) && !klass.singleton_class?
           klass.singleton_class.prepend(CreateMemoWiseStateOnInherited)
         else
+          klass.singleton_class.prepend(CreateMemoWiseStateOnIncluded) if klass.is_a?(Module) && !klass.singleton_class?
+
           klass.prepend(CreateMemoWiseStateOnInherited)
         end
 

metadata

@@ -1,19 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: memo_wise
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Panorama Education
 - Jacob Evelyn
 - Jemma Issroff
 - Marc Siegel
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description:
 email:
 - engineering@panoramaed.com
 - jacobevelyn@gmail.com
@@ -36,7 +34,6 @@ 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
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -44,15 +41,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: The wise choice for Ruby memoization
 test_files: []