memery 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fee1d8473d6873f228f16f5f9a0b3dce5f3e54350101b69be7d2842a2d4fc1f
-  data.tar.gz: 24eb3da54355028d92664c734a2c28ea5a52462351b6a598c6acd80a5b3cca7c
+  metadata.gz: 56c60aff8199aebc5f2b15e9b777937eea73a7246c61b265c2f6ee980b6dbcd1
+  data.tar.gz: f16d9b904ded0d29ca13a7a3690f07e4ecec2cb681e56fce6c390db75a20e4cc
 SHA512:
-  metadata.gz: fe66f7ef175fae643de7382ad2b311a546c079f9f105118f2907437a439ccde57b86143b46d063f868805921d72a33eb790625610c43f111268eeb21b8b5821c
-  data.tar.gz: 28120e605bbf3627d09376f081ba1071745e0d8d0a32ccef9675012c12596baf695aaa37275bcce27bbf6998e4b22b92c0787e2b973decd87f15e201a6fa1294
+  metadata.gz: 55a891049c8df688bad894e69ece34b11e4319ce1e00c63a081b01df728918661ff1bc7148f0278c20f1c5fa150eca036fcb3b3f7a35b13c859a7552e5f2d39f
+  data.tar.gz: 491214a08cf1286d6dc908f8972c02c9273b5b8e571cc894e377ab425a965fe0997a5053cd6ab3faae240af0a78159e2cc3418d08b74d8639e2f133d6f54dc27

data/.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0", "3.1", "3.2", "3.3"]
+        ruby: ["3.0", "3.1", "3.2", "3.3", "3.4"]
 
     name: ${{ matrix.ruby }}
 

data/.rubocop.yml

@@ -3,7 +3,7 @@ inherit_gem:
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
 
 Naming/MethodParameterName:
   AllowedNames: ["x", "y", "z"]

data/Gemfile.lock

@@ -1,111 +1,109 @@
 PATH
   remote: .
   specs:
-    memery (1.6.0)
+    memery (1.7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.4)
+    activesupport (7.1.5.1)
       base64
+      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
       mutex_m
+      securerandom (>= 0.3)
       tzinfo (~> 2.0)
     ast (2.4.2)
     base64 (0.2.0)
+    benchmark (0.4.0)
     benchmark-ips (2.14.0)
     benchmark-memory (0.2.0)
       memory_profiler (~> 1)
-    bigdecimal (3.1.8)
+    bigdecimal (3.1.9)
     coderay (1.1.3)
     concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     diff-lcs (1.5.1)
     docile (1.4.1)
     drb (2.2.1)
-    i18n (1.14.5)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
-    json (2.7.2)
+    json (2.9.1)
     language_server-protocol (3.17.0.3)
+    logger (1.6.4)
     memory_profiler (1.0.2)
     method_source (1.1.0)
-    minitest (5.25.1)
-    mutex_m (0.2.0)
+    minitest (5.25.4)
+    mutex_m (0.3.0)
     parallel (1.26.3)
-    parser (3.3.5.0)
+    parser (3.3.6.0)
       ast (~> 2.4.1)
       racc
-    pry (0.14.2)
+    pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     racc (1.8.1)
-    rack (3.1.7)
+    rack (3.1.8)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.9.2)
-    rexml (3.3.7)
+    regexp_parser (2.10.0)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.1)
+    rspec-core (3.13.2)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.63.5)
+    rspec-support (3.13.2)
+    rubocop (1.69.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.3)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.37.0)
       parser (>= 3.3.1.0)
-    rubocop-capybara (2.21.0)
-      rubocop (~> 1.41)
-    rubocop-config-umbrellio (1.63.0.93)
-      rubocop (~> 1.63.0)
-      rubocop-performance (~> 1.21.0)
-      rubocop-rails (~> 2.24.0)
+    rubocop-config-umbrellio (1.69.0.101)
+      rubocop (~> 1.69.0)
+      rubocop-factory_bot (~> 2.26.0)
+      rubocop-performance (~> 1.23.0)
+      rubocop-rails (~> 2.28.0)
       rubocop-rake (~> 0.6.0)
-      rubocop-rspec (~> 2.29.0)
-      rubocop-sequel (~> 0.3.3)
+      rubocop-rspec (~> 3.3.0)
+      rubocop-sequel (~> 0.3.0)
     rubocop-factory_bot (2.26.1)
       rubocop (~> 1.61)
-    rubocop-performance (1.21.1)
+    rubocop-performance (1.23.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rails (2.24.1)
+    rubocop-rails (2.28.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 1.33.0, < 2.0)
+      rubocop (>= 1.52.0, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.29.2)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
-      rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.29.1)
+    rubocop-rspec (3.3.0)
       rubocop (~> 1.61)
-    rubocop-sequel (0.3.4)
+    rubocop-sequel (0.3.8)
       rubocop (~> 1.0)
     ruby-progressbar (1.13.0)
+    securerandom (0.3.2)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -115,7 +113,9 @@ GEM
     simplecov_json_formatter (0.1.4)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (3.1.3)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
 
 PLATFORMS
   ruby
@@ -134,4 +134,4 @@ DEPENDENCIES
   simplecov-lcov
 
 BUNDLED WITH
-   2.4.22
+   2.5.23

data/README.md

@@ -190,6 +190,36 @@ a.memoized?(:call) # => true
 a.memoized?(:execute) # => false
 ```
 
+### Marshal-compatible Memoization
+
+In order for objects to be marshaled and loaded in a different Ruby process,
+hashed arguments must be disabled in order for memoized values to be retained.
+Note that this can have a performance impact if the memoized method contains
+arguments.
+
+```ruby
+Memery.use_hashed_arguments = false
+
+class A
+  include Memery
+
+  memoize def call
+    puts "calculating"
+    42
+  end
+end
+
+a = A.new
+a.call
+
+Marshal.dump(a)
+# => "\x04\bo:\x06A\x06:\x1D@_memery_memoized_values{\x06:\tcallS:3Memery::ClassMethods::MemoizationModule::Cache\a:\vresulti/:\ttimef\x14663237.14822323"
+
+# ...in another Ruby process:
+a = Marshal.load("\x04\bo:\x06A\x06:\x1D@_memery_memoized_values{\x06:\tcallS:3Memery::ClassMethods::MemoizationModule::Cache\a:\vresulti/:\ttimef\x14663237.14822323")
+a.call # => 42
+```
+
 ## Differences from Other Gems
 
 Memery is similar to [Memoist](https://github.com/matthewrudy/memoist), but it doesn't override methods. Instead, it uses Ruby 2's `Module.prepend` feature. This approach is cleaner, allowing you to inspect the original method body with `method(:x).super_method.source`, and it ensures that subclasses' methods function properly. If you redefine a memoized method in a subclass, it won't be memoized by default. You can memoize it normally without needing an awkward `identifier: ` argument, and it will just work:

data/benchmark.rb

@@ -32,6 +32,10 @@ class Foo
     memoize def find_new(char)
       base_find(char)
     end
+
+    memoize def find_optional(*)
+      base_find("z")
+    end
   end
 end
 
@@ -43,6 +47,10 @@ def test_with_args
   Foo.find_new("d")
 end
 
+def test_empty_args
+  Foo.find_optional
+end
+
 Benchmark.ips do |x|
   x.report("test_no_args") { test_no_args }
 end
@@ -51,6 +59,14 @@ Benchmark.memory do |x|
   x.report("test_no_args") { 100.times { test_no_args } }
 end
 
+Benchmark.ips do |x|
+  x.report("test_empty_args") { test_empty_args }
+end
+
+Benchmark.memory do |x|
+  x.report("test_empty_args") { 100.times { test_empty_args } }
+end
+
 Benchmark.ips do |x|
   x.report("test_with_args") { test_with_args }
 end
@@ -59,4 +75,14 @@ Benchmark.memory do |x|
   x.report("test_with_args") { 100.times { test_with_args } }
 end
 
+Memery.use_hashed_arguments = false
+Benchmark.ips do |x|
+  x.report("test_with_args_no_hash") { test_with_args }
+end
+
+Benchmark.memory do |x|
+  x.report("test_with_args_no_hash") { 100.times { test_with_args } }
+end
+Memery.use_hashed_arguments = true
+
 puts "```"

data/lib/memery/version.rb

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

data/lib/memery.rb

@@ -4,11 +4,15 @@ require "memery/version"
 
 module Memery
   class << self
+    attr_accessor :use_hashed_arguments
+
     def monotonic_clock
       Process.clock_gettime(Process::CLOCK_MONOTONIC)
     end
   end
 
+  @use_hashed_arguments = true
+
   OUR_BLOCK = lambda do
     extend(ClassMethods)
     include(InstanceMethods)
@@ -68,11 +72,12 @@ module Memery
         end
       end
 
+      # rubocop:disable Metrics/MethodLength
       def define_memoized_method!(klass, method_name, condition: nil, ttl: nil)
-        method_key = "#{method_name}_#{object_id}"
-
+        # Include a suffix in the method key to differentiate between methods of the same name
+        # being memoized throughout a class inheritance hierarchy
+        method_key = "#{method_name}_#{klass.name || object_id}"
         original_visibility = method_visibility(klass, method_name)
-        original_arity = klass.instance_method(method_name).arity
 
         define_method(method_name) do |*args, &block|
           if block || (condition && !instance_exec(&condition))
@@ -80,7 +85,12 @@ module Memery
           end
 
           cache_store = (@_memery_memoized_values ||= {})
-          cache_key = original_arity.zero? ? method_key : [method_key, *args].hash
+          cache_key = if args.empty?
+                        method_key
+                      else
+                        key_parts = [method_key, *args]
+                        Memery.use_hashed_arguments ? key_parts.hash : key_parts
+                      end
           cache = cache_store[cache_key]
 
           return cache.result if cache&.fresh?(ttl)
@@ -95,6 +105,7 @@ module Memery
         ruby2_keywords(method_name)
         send(original_visibility, method_name)
       end
+      # rubocop:enable Metrics/MethodLength
 
       private
 

data/memery.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "memery/version"
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.name          = "memery"
   spec.version       = Memery::VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memery
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Yuri Smirnov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2025-03-04 00:00:00.000000000 Z
 dependencies: []
 description: Memery is a gem for memoization.
 email:
@@ -43,14 +43,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: A gem for memoization.