ttl_memoizeable 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e905652905199d704403098c3e9ac0ff4c6e405cd1a888a949134a434a030856
-  data.tar.gz: b21c2af2bddddbcb19e83887c3d0f20e482d80e53835b92ea406d3e0f5ae54e6
+  metadata.gz: 9bfd9bff4af04e7d281a909a72599a275248c9383d47b41a24070d6bf81e078d
+  data.tar.gz: ffeebfbd0819b10edcdb81cee518230d8e09365778502b20a4a4b57cf33c31f3
 SHA512:
-  metadata.gz: 37c2e2d28b4c4b3f5ffaa8143228db8f5063353dbcdb65c0265ef856bc6b473661069b10e183965db23dd8e1cc92dca978b8517e1f99bdb5f34c4809d228fcc2
-  data.tar.gz: c73e41dee8ac3a01a8ede3c8783dc7424739fa489abfa4a661c9a72b126b70cb92e52f93fee7de773525aeede26460cd287198e22ace5b269b148ed77744873e
+  metadata.gz: c495822e3eedad2c355104485013add856feb652ae8dd471a2352ff7db46081895586318a460e81a579a10301c40f28675f3df1c9beadab6b54794a1c14fe659
+  data.tar.gz: 8b96325db978539ba5c0cf82f775babbd15ef242ca870784b2997a8a6da42d013604e35adf6bf0f7dd6982b27d491070419882ddfcf0d3e5f30cf9f096c4bed3

data/CHANGELOG.md

@@ -1,4 +1,6 @@
 ## [Unreleased]
+## [0.2.1] - 2024-01-03
+- Fix bugs that could result in memoizing nil values
 ## [0.2.0] - 2023-11-27
 - Publish to rubygems
 

data/README.md

@@ -81,15 +81,16 @@ ttl_memoized:  0.008847   0.000755   0.009602 (  0.221783)
 
 ### TTL Types:
   Two methods of TTL expiration are available
-    1. Time Duration (i.e `5.minutes`). This will ensure the process will cache your method
-       for that given amount of time. This option is likely best when you can quantify the
-       acceptable threshold for stale data. Every time the memoized method is called, the date
-       the current memoized value was fetched + your ttl value will be compared to the current time.
 
-    2. Accessor count (i.e. 10_000). This will ensure the process will cache your method
-       for that number of attempts to access the data. This option is likely best when you
-       want to TTL to expire based of volume. Every time the memoized method is called, the counter
-       will decrement by 1.
+  1. Time Duration (i.e `5.minutes`). This will ensure the process will cache your method
+     for that given amount of time. This option is likely best when you can quantify the
+     acceptable threshold for stale data. Every time the memoized method is called, the date
+     the current memoized value was fetched + your ttl value will be compared to the current time.
+
+  2. Accessor count (i.e. 10_000). This will ensure the process will cache your method
+     for that number of attempts to access the data. This option is likely best when you
+     want to TTL to expire based of volume. Every time the memoized method is called, the counter
+     will decrement by 1.
 
 
 ### Dont's
@@ -98,6 +99,8 @@ ttl_memoized:  0.008847   0.000755   0.009602 (  0.221783)
 2. Use this library on methods that accept parameters, as that introduces state; see above
 
 
+## How to use
+
 Using this library is most effective on class methods.
 
 ```ruby

data/lib/ttl_memoizeable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TTLMemoizeable
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/ttl_memoizeable.rb

@@ -7,6 +7,7 @@ require_relative "ttl_memoizeable/version"
 
 module TTLMemoizeable
   TTLMemoizationError = Class.new(StandardError)
+  SetupMutex = Mutex.new
 
   def ttl_memoized_method(method_name, ttl: 1000)
     raise TTLMemoizationError, "Method not defined: #{method_name}" unless method_defined?(method_name) || private_method_defined?(method_name)
@@ -15,15 +16,15 @@ module TTLMemoizeable
     time_based_ttl = ttl.is_a?(ActiveSupport::Duration)
     expired_ttl = time_based_ttl ? 1.year.ago : 1
 
-    ttl_variable_name = "@_ttl_for_#{ivar_name}".to_sym
-    mutex_variable_name = "@_mutex_for_#{ivar_name}".to_sym
-    value_variable_name = "@_value_for_#{ivar_name}".to_sym
+    ttl_variable_name = :"@_ttl_for_#{ivar_name}"
+    mutex_variable_name = :"@_mutex_for_#{ivar_name}"
+    value_variable_name = :"@_value_for_#{ivar_name}"
 
-    reset_memoized_value_method_name = "reset_memoized_value_for_#{method_name}".to_sym
-    setup_memoization_method_name = "_setup_memoization_for_#{method_name}".to_sym
-    decrement_ttl_method_name = "_decrement_ttl_for_#{method_name}".to_sym
-    ttl_exceeded_method_name = "_ttl_exceeded_for_#{method_name}".to_sym
-    extend_ttl_method_name = "_extend_ttl_for_#{method_name}".to_sym
+    reset_memoized_value_method_name = :"reset_memoized_value_for_#{method_name}"
+    setup_memoization_method_name = :"_setup_memoization_for_#{method_name}"
+    decrement_ttl_method_name = :"_decrement_ttl_for_#{method_name}"
+    ttl_exceeded_method_name = :"_ttl_exceeded_for_#{method_name}"
+    extend_ttl_method_name = :"_extend_ttl_for_#{method_name}"
 
     [
       reset_memoized_value_method_name, setup_memoization_method_name,
@@ -44,9 +45,12 @@ module TTLMemoizeable
       end
 
       define_method setup_memoization_method_name do
-        instance_variable_set(ttl_variable_name, expired_ttl) unless instance_variable_defined?(ttl_variable_name)
-        instance_variable_set(mutex_variable_name, Mutex.new) unless instance_variable_defined?(mutex_variable_name)
-        instance_variable_set(value_variable_name, nil) unless instance_variable_defined?(value_variable_name)
+        return if instance_variable_defined?(ttl_variable_name) && instance_variable_defined?(mutex_variable_name)
+
+        ::TTLMemoizeable::SetupMutex.synchronize do
+          instance_variable_set(ttl_variable_name, expired_ttl) unless instance_variable_defined?(ttl_variable_name)
+          instance_variable_set(mutex_variable_name, Mutex.new) unless instance_variable_defined?(mutex_variable_name)
+        end
       end
 
       define_method decrement_ttl_method_name do
@@ -56,11 +60,10 @@ module TTLMemoizeable
       end
 
       define_method ttl_exceeded_method_name do
-        instance_variable_get(ttl_variable_name) <= if time_based_ttl
-          ttl.ago
-        else
-          0
-        end
+        return true unless instance_variable_defined?(value_variable_name)
+
+        compared_to = time_based_ttl ? ttl.ago : 0
+        instance_variable_get(ttl_variable_name) <= compared_to
       end
 
       define_method extend_ttl_method_name do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttl_memoizeable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Daniel Westendorf
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-28 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport