memo_wise 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1b98d394deb079784021cd44f5c7b41abdbf1cce2b0ce14b0a3957b12bfdabe
-  data.tar.gz: 45b6796cf708b5401a56edfd68156587f92826a71d833b7fe3bec24985d81ac9
+  metadata.gz: 634bee32d07ccd97dc7670c67521a4091ebc0df0deae1479cc054aaa7a246e6c
+  data.tar.gz: 59523369b3373389481388962039486b4f0f5cf002d24091ad2244048f100bbc
 SHA512:
-  metadata.gz: 9ba145822aef3d07b2385daffaef15c22f5ffd4604e68d1fbad5d2bdf682c7723bb9a109cdda69d26efd6e5c05a21c1f0310ae70a1dbfd0f18a28cbe92d13d6f
-  data.tar.gz: 210c34c42f11e9d761c0fda0512daf62a533ec0fe2f19609a6cf0e052a1f2e2fdf22a55711764865616a319e387bff83fc5a6505973a4d89483ef383af008d13
+  metadata.gz: 3896bf8b001ad52afda6b14c5170d902d85a88c9faaa60d6c9097a01045e0ef90a379c130834b2a2fcbec356b51346f975fc96493dcb3d3c04943200eb7274a3
+  data.tar.gz: 72718456d986ed21d593a6a99117ee74a0a385f94ba0b1a00fadb38cbad977202cea5d8e32325bdaa2e5eb273808a52ca9d62997cd927a6a98ffd31174bdcc6f

data/CHANGELOG.md

@@ -8,6 +8,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 (nothing yet!)
 
+## [0.4.0] - 2021-04-30
+### Added
+- Documentation of confusing module test behavior
+- Support using MemoWise in classes with keyword arguments in the initializer
+- Support Marshal dump/load of classes using MemoWise
+
 ## [0.3.0] - 2021-02-11
 ### Added
 - Changelog and tags
@@ -48,7 +54,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/v0.3.0...HEAD
+[Unreleased]: https://github.com/panorama-ed/memo_wise/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/panorama-ed/memo_wise/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/panorama-ed/memo_wise/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/panorama-ed/memo_wise/compare/v0.1.2...v0.2.0
 [0.1.2]: https://github.com/panorama-ed/memo_wise/compare/v0.1.1...v0.1.2

data/Gemfile

@@ -14,7 +14,7 @@ end
 # Excluded from CI except on latest MRI Ruby, to reduce compatibility burden
 group :checks do
   gem "codecov"
-  gem "panolint", github: "panorama-ed/panolint"
+  gem "panolint", github: "panorama-ed/panolint", branch: "main"
 end
 
 # Excluded from CI except on latest MRI Ruby, to reduce compatibility burden

data/Gemfile.lock

@@ -1,8 +1,9 @@
 GIT
   remote: https://github.com/panorama-ed/panolint.git
-  revision: ca5edaa1f6985e2812998a937229f972c07bce56
+  revision: e2f76aa2482f02e68826eb8643a41998a09fc7ab
+  branch: main
   specs:
-    panolint (0.1.2)
+    panolint (0.1.3)
       brakeman (>= 4.8, < 6.0)
       rubocop (>= 0.83, < 2.0)
       rubocop-performance (~> 1.5)
@@ -13,35 +14,35 @@ GIT
 PATH
   remote: .
   specs:
-    memo_wise (0.3.0)
+    memo_wise (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.4.4)
+    activesupport (5.2.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     ast (2.4.2)
     brakeman (5.0.0)
-    codecov (0.4.3)
+    codecov (0.5.2)
       simplecov (>= 0.15, < 0.22)
     concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
     docile (1.3.5)
-    i18n (1.8.8)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.3)
+    minitest (5.14.4)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.0)
       ast (~> 2.4.1)
     rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.3)
     redcarpet (3.5.1)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -55,7 +56,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
-    rubocop (1.9.1)
+    rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -66,7 +67,7 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
-    rubocop-performance (1.9.2)
+    rubocop-performance (1.10.2)
       rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rails (2.9.1)

data/README.md

@@ -12,7 +12,6 @@
 [![Gem Version](https://img.shields.io/gem/v/memo_wise.svg)](https://rubygems.org/gems/memo_wise)
 [![Gem Downloads](https://img.shields.io/gem/dt/memo_wise.svg)](https://rubygems.org/gems/memo_wise)
 
-
 ## Why `MemoWise`?
 
 `MemoWise` is **the wise choice for Ruby memoization**, featuring:
@@ -85,13 +84,13 @@ run in GitHub Actions and updated in every PR that changes code.
 
 |Method arguments|**`memo_wise` (0.1.0)**|`memery` (1.3.0)|`memoist`\* (0.16.2)|`memoized`\* (1.0.2)|`memoizer`\* (1.0.3)|
 |--|--|--|--|--|--|
-|`()` (none)|**baseline**|14.69x slower|2.59x slower|1.15x slower|2.91x slower|
-|`(a, b)`|**baseline**|1.93x slower|2.20x slower|1.79x slower|1.96x slower|
-|`(a:, b:)`|**baseline**|3.01x slower|2.41x slower|2.18x slower|2.28x slower|
-|`(a, b:)`|**baseline**|1.49x slower|1.75x slower|1.51x slower|1.60x slower|
-|`(a, *args)`|**baseline**|1.92x slower|2.23x slower|1.94x slower|1.98x slower|
-|`(a:, **kwargs)`|**baseline**|3.08x slower|2.48x slower|2.17x slower|2.28x slower|
-|`(a, *args, b:, **kwargs)`|**baseline**|1.55x slower|1.73x slower|1.65x slower|1.67x slower|
+|`()` (none)|**baseline**|13.17x slower|2.85x slower|1.30x slower|3.05x slower|
+|`(a, b)`|**baseline**|1.93x slower|2.20x slower|1.97x slower|1.86x slower|
+|`(a:, b:)`|**baseline**|3.05x slower|2.34x slower|2.27x slower|2.14x slower|
+|`(a, b:)`|**baseline**|1.50x slower|1.63x slower|1.56x slower|1.48x slower|
+|`(a, *args)`|**baseline**|1.91x slower|2.13x slower|1.90x slower|1.88x slower|
+|`(a:, **kwargs)`|**baseline**|3.08x slower|2.37x slower|2.24x slower|2.09x slower|
+|`(a, *args, b:, **kwargs)`|**baseline**|1.72x slower|1.61x slower|1.56x slower|1.67x slower|
 
 _\*Indicates a benchmark run on Ruby 2.7.2 because the gem raises errors in Ruby
 3.0.0 due to its incorrect handling of keyword arguments._
@@ -141,6 +140,25 @@ code examples in our YARD documentation. To run `doctest` locally:
 bundle exec yard doctest
 ```
 
+### 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)
+across tests, which can result in confusing test failures when this differs from
+how you use the code in production.
+
+For example, Rails view helpers are modules that are commonly tested with a
+[shared `view` instance](https://github.com/rails/rails/blob/291a3d2ef29a3842d1156ada7526f4ee60dd2b59/actionview/lib/action_view/test_case.rb#L203-L214). Rails initializes a new view instance for each web request so any view helper
+methods would only be memoized for the duration of that web request, but in
+tests (such as when using
+[`rspec-rails`'s `helper`](https://github.com/rspec/rspec-rails/blob/main/lib/rspec/rails/example/helper_example_group.rb#L22-L27)),
+the memoization may persist across tests. In this case, simply reset the
+memoization between your tests with something like:
+
+```ruby
+after(:each) { helper.reset_memo_wise }
+```
+
 ## Logo
 
 `MemoWise`'s logo was created by [Luci Cooke](https://www.lucicooke.com/). The

data/lib/memo_wise.rb

@@ -39,10 +39,40 @@ module MemoWise # rubocop:disable Metrics/ModuleLength
   # [Values](https://github.com/tcrayford/Values)
   # [gem](https://rubygems.org/gems/values).
   #
-  def initialize(*)
-    MemoWise.create_memo_wise_state!(self)
-    super
-  end
+  # 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 <<-END_OF_METHOD, __FILE__, __LINE__ + 1
+    # On Ruby 2.7 or greater:
+    #
+    # def initialize(...)
+    #   MemoWise.create_memo_wise_state!(self)
+    #   super
+    # end
+    #
+    # On Ruby 2.6 or lower:
+    #
+    # def initialize(*)
+    #   MemoWise.create_memo_wise_state!(self)
+    #   super
+    # end
+
+    def initialize(#{all_args})
+      MemoWise.create_memo_wise_state!(self)
+      super
+    end
+  END_OF_METHOD
 
   # @private
   #
@@ -182,10 +212,7 @@ module MemoWise # rubocop:disable Metrics/ModuleLength
   # @return [Object] the passed-in obj
   def self.create_memo_wise_state!(obj)
     unless obj.instance_variables.include?(:@_memo_wise)
-      obj.instance_variable_set(
-        :@_memo_wise,
-        Hash.new { |h, k| h[k] = {} }
-      )
+      obj.instance_variable_set(:@_memo_wise, {})
     end
 
     obj
@@ -269,7 +296,7 @@ module MemoWise # rubocop:disable Metrics/ModuleLength
         if method.arity.zero?
           klass.module_eval <<-END_OF_METHOD, __FILE__, __LINE__ + 1
             # def foo
-            #   @_memo_wise.fetch(:foo}) do
+            #   @_memo_wise.fetch(:foo) do
             #     @_memo_wise[:foo] = _memo_wise_original_foo
             #   end
             # end
@@ -303,14 +330,18 @@ module MemoWise # rubocop:disable Metrics/ModuleLength
           # because Ruby always copies argument arrays when splatted.
           klass.module_eval <<-END_OF_METHOD, __FILE__, __LINE__ + 1
             # def foo(*args, **kwargs)
-            #   hash = @_memo_wise[:foo]
+            #   hash = @_memo_wise.fetch(:foo) do
+            #     @_memo_wise[:foo] = {}
+            #   end
             #   hash.fetch([args, kwargs].freeze) do
             #     hash[[args, kwargs].freeze] = _memo_wise_original_foo(*args, **kwargs)
             #   end
             # end
 
             def #{method_name}#{args_str}
-              hash = @_memo_wise[:#{method_name}]
+              hash = @_memo_wise.fetch(:#{method_name}) do
+                @_memo_wise[:#{method_name}] = {}
+              end
               hash.fetch(#{fetch_key}) do
                 hash[#{fetch_key}] = #{original_memo_wised_name}#{args_str}
               end
@@ -373,7 +404,7 @@ module MemoWise # rubocop:disable Metrics/ModuleLength
   # valid for the given method.
   #
   # @param method_name [Symbol]
-  #   Name of a method previously setup with `#memo_wise`.
+  #   Name of a method previously set up with `#memo_wise`.
   #
   # @param args [Array]
   #   (Optional) If the method takes positional args, these are the values of
@@ -424,7 +455,10 @@ module MemoWise # rubocop:disable Metrics/ModuleLength
     if method(method_name).arity.zero?
       @_memo_wise[method_name] = yield
     else
-      @_memo_wise[method_name][fetch_key(method_name, *args, **kwargs)] = yield
+      hash = @_memo_wise.fetch(method_name) do
+        @_memo_wise[method_name] = {}
+      end
+      hash[fetch_key(method_name, *args, **kwargs)] = yield
     end
   end
 
@@ -449,7 +483,7 @@ module MemoWise # rubocop:disable Metrics/ModuleLength
   # - Resets all memoized results of calling *all methods*.
   #
   # @param method_name [Symbol, nil]
-  #   (Optional) Name of a method previously setup with `#memo_wise`. If not
+  #   (Optional) Name of a method previously set up with `#memo_wise`. If not
   #   given, will reset *all* memoized results for *all* methods.
   #
   # @param args [Array]
@@ -521,7 +555,7 @@ module MemoWise # rubocop:disable Metrics/ModuleLength
     if args.empty? && kwargs.empty?
       @_memo_wise.delete(method_name)
     else
-      @_memo_wise[method_name].delete(fetch_key(method_name, *args, **kwargs))
+      @_memo_wise[method_name]&.delete(fetch_key(method_name, *args, **kwargs))
     end
   end
 

data/lib/memo_wise/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memo_wise
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Panorama Education
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2021-04-30 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: The wise choice for Ruby memoization