short_circu_it 0.29.1 → 0.29.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e0e9cd02585abda82a6d4c0fa3dfa6b492c4aa22eee9b8dbb17d1dd2867728e
-  data.tar.gz: 7c8b0bbd63cd82b46dbc056066157fef8cceeebbfff31f5173e7050166fd66e0
+  metadata.gz: ce12ac822aed393836ee26072bd9b0eade6df9d9aee2811a735bd217b2ede2ca
+  data.tar.gz: f3fd42c11368138e035955190d00aca55d5754067a8083173d952aac39d0ea6c
 SHA512:
-  metadata.gz: ee46e23aadf0ef846f967872167ce7ed11326d0d1ec7b2550eb615051c18a1e40aff40bff03de8f298641781e3760b2b576f1b36ef53ddafd1337da5a8007deb
-  data.tar.gz: e028fc7cdbe3cf54f120a44bee164a880a51a846e97c4ba99ee6509b93fd869f9058664163ccc4b52f1a9b0853a0a0cddce49c21b9faec8099b0371791fe25d8
+  metadata.gz: d7d05900cf5a4a20afee6f405bda95ff2e22523f048a23134734979ea7c29723c4dac6a01134241cd0bc637a8c958b3b3ed23ac3575cea4e7a28d84a87f63603
+  data.tar.gz: 16c5e13cf88cd8bca999340be8c2f6a2fa6e6ea8abb60a11eb18d73cdc023f8440ccc4131cb3bb2b444a56578f62ecfbb8a8de61d92062db9967fe17340df4f0

data/lib/short_circu_it/memoization_store.rb

@@ -4,6 +4,9 @@ require "active_support/core_ext/module"
 
 module ShortCircuIt
   class MemoizationStore
+    NOT_MEMOIZED = Object.new
+    private_constant :NOT_MEMOIZED
+
     delegate :memoization_observers, to: :owner
 
     # @param owner [*] The object being memoized
@@ -12,16 +15,23 @@ module ShortCircuIt
     end
 
     # @param method_name [Symbol] The name of the method being memoized.
-    # @param argument_hash [Integer] The hash value of the arguments passed to the method.
+    # @param args [Array<*>] Arguments passed to the method being memoized.
+    # @param kwargs [Hash] Keyword arguments passed to the method being memoized.
     # @yield [] Yields to a given block with no arguments. Memoizes the value returned by the block.
     # @return [*] The value returned either from the memoization cache if present, or yielded block if not.
-    def memoize(method_name, argument_hash)
-      return memoized_value(method_name, argument_hash) if memoized?(method_name, argument_hash)
+    def memoize(method_name, args, kwargs)
+      argument_hash = [ *args, kwargs ].hash
+
+      value = memoized_value(method_name, argument_hash)
+
+      return value unless value == NOT_MEMOIZED
 
-      clear_memoization(method_name) unless current_memoization_for_method?(method_name)
+      state_hash = state_hash(method_name)
+
+      clear_memoization(method_name) unless current_memoization_for_method?(method_name, state_hash)
 
       yield.tap do |returned_value|
-        current_memoization_for_method(method_name)[argument_hash] = returned_value
+        current_memoization_for_method(method_name, state_hash)[argument_hash] = returned_value
       end
     end
 
@@ -30,7 +40,7 @@ module ShortCircuIt
     # @param *method_names [Symbol] The name of a memoized method
     # @return [Boolean] True if a value was cleared, false if not
     def clear_memoization(*method_names)
-      method_names.all? { |method_name| memoized_hash.delete(method_name.to_sym) }
+      method_names.all? { |method_name| memoized_hash.delete(method_name) }
     end
 
     # Clears all memoized values on the object
@@ -52,32 +62,28 @@ module ShortCircuIt
       memoized_hash[method_name] ||= {}
     end
 
-    # @param method_name [Symbol] The name of the method to memoize
-    # @param argument_hash [Integer] The hash value of the arguments passed to the method
-    # @return [Boolean] True if the method has a current memoized value with the given arguments
-    def memoized?(method_name, argument_hash)
-      current_memoization_for_method?(method_name) && current_memoization_for_method(method_name).key?(argument_hash)
-    end
-
     # @param method_name [String] The name of the method to memoize
     # @param argument_hash [Integer] The hash value of the arguments passed to the method
     # @return [*] The value that has been memoized for the method/argument combination
     def memoized_value(method_name, argument_hash)
-      raise NotMemoizedError unless memoized?(method_name, argument_hash)
-
       current_memoization_for_method(method_name)[argument_hash]
     end
 
     # @param method_name [Symbol] The name of a memoized method
     # @return [Hash] A hash of memoized values for the current state of the observed objects for the given method.
-    def current_memoization_for_method(method_name)
-      memoization_for_method(method_name)[state_hash(method_name)] ||= {}
+    def current_memoization_for_method(method_name, state_hash = nil)
+      state_hash ||= state_hash(method_name)
+
+      # Memoize values inside a hash with default value of NOT_MEMOIZED
+      memoization_for_method(method_name)[state_hash] ||= Hash.new(NOT_MEMOIZED)
     end
 
     # @param method_name [Symbol] The name of a memoized method
     # @return [Boolean] True if there are any memoized values for the current state of the observed objects.
-    def current_memoization_for_method?(method_name)
-      memoization_for_method(method_name).key?(state_hash(method_name))
+    def current_memoization_for_method?(method_name, state_hash = nil)
+      state_hash ||= state_hash(method_name)
+
+      memoization_for_method(method_name).key?(state_hash)
     end
 
     # @param method_name [Symbol] The name of a memoized method

data/lib/short_circu_it/version.rb

@@ -2,5 +2,5 @@
 
 module ShortCircuIt
   # This constant is managed by spicerack
-  VERSION = "0.29.1"
+  VERSION = "0.29.2"
 end

data/lib/short_circu_it.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-require "short_circu_it/version"
-require "short_circu_it/errors"
-require "short_circu_it/memoization_store"
 require "active_support/core_ext/module"
 require "active_support/core_ext/array"
 require "active_support/concern"
 require "around_the_world"
 
+require_relative "short_circu_it/version"
+require_relative "short_circu_it/errors"
+require_relative "short_circu_it/memoization_store"
+
 module ShortCircuIt
   extend ActiveSupport::Concern
   include AroundTheWorld
@@ -80,13 +81,8 @@ module ShortCircuIt
           method_name,
           prevent_double_wrapping_for: ShortCircuIt,
         ) do |*args, **opts|
-          memoization_store.memoize(method_name, (args + [ opts ]).hash) do
-            # TODO: replace with `super(*args, **opts)` when <= 2.6 support is dropped
-            if RUBY_VERSION < "2.7" && opts.blank?
-              super(*args)
-            else
-              super(*args, **opts)
-            end
+          memoization_store.memoize(method_name, args, opts) do
+            super(*args, **opts)
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: short_circu_it
 version: !ruby/object:Gem::Version
-  version: 0.29.1
+  version: 0.29.2
 platform: ruby
 authors:
 - Allen Rettberg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: around_the_world
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: 0.29.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: 0.29.2
 description: Memoize methods safely with parameter and dependency observation
 email:
 - allen.rettberg@freshly.com
@@ -59,7 +59,7 @@ metadata:
   homepage_uri: https://github.com/RubyAfterAll/spicerack/tree/main/short_circu_it
   source_code_uri: https://github.com/RubyAfterAll/spicerack/tree/main/short_circu_it
   changelog_uri: https://github.com/RubyAfterAll/spicerack/blob/main/short_circu_it/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/short_circu_it/0.29.1
+  documentation_uri: https://www.rubydoc.info/gems/short_circu_it/0.29.2
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.15
 signing_key:
 specification_version: 4
 summary: An intelligent and feature rich memoization gem