ttl_memoizeable 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5763160f9370ac1bc7695b8299a6528953e6b90cd30806784b45763be6eae8c
-  data.tar.gz: 04e05378018dc76ad58718a170d2212f554a8838b53d071ec9ac2943f8a2bdf3
+  metadata.gz: c5d04e1b3ea5834552d353149bdecbe3e34e665ff81309cf2ec235c0a1948b0d
+  data.tar.gz: 10f4a41c7671cb6ed3b8a82006b9f21610d9e6a74b22a4808e2ae99e60ed9704
 SHA512:
-  metadata.gz: 358dde19960ec800c5f58eddbd414a2126a866302c12c350714f355e0f29e049dadd055aa7584ba83e6e89717d5713e1f073718dc17276efb0827238340a89a4
-  data.tar.gz: 77486fa2db3df97f9c2b68217838ad36ed75c678f8c1e67b781f2618eacaf3253406e8344aba51f973b85afed2ac4bd26c5aec1c48b13839aa53e0957e4b810c
+  metadata.gz: 773703b9c7190e19474cef1b049a26ec0458c9a9ab4393e72364b96ec2fb913d3e3efdb19885f02eed2ca1ece6bebb42614b6edf297551d4b36ce48247c9ff6b
+  data.tar.gz: 709f01839f542b3c7c82ad828d0ffd5533286840bc0769c2e113be739ab9843a5b737a5ed346b3944722faaea4ebf494dea14401bb1a3cae4f0a78c765555083

data/CHANGELOG.md

@@ -1,4 +1,9 @@
 ## [Unreleased]
+## [0.4.1] - 2026-09-25
+- Calculate TTL using monotonic time, which is much more performant (#16) @kbennoune
+## [0.4.0] - 2024-09-18
+- Add support for globally disabling TTLMemoizeable (#15) @danielwestendorf
+- Add support for globally resetting all ttls (#13) @danielwestendorf
 ## [0.3.0] - 2024-01-04
 - Bug fixes
 ## [0.2.0] - 2023-11-27

data/Gemfile

@@ -7,4 +7,4 @@ gemspec
 
 gem "rake"
 gem "rspec"
-gem "standard"
+gem "standard", "1.40.0"

data/README.md

@@ -151,7 +151,7 @@ application_config.config # => {...} Redis/JSON.parse will be called
 
 ## Testing a TTLMemoized Method
 
-You likely don't want to test the implementation of this library, but the logic of your memoized method. In that case you probably want "fresh" data on every invocation of the method. There are two approaches, depending on your preference of flavor.
+You likely don't want to test the implementation of this library, but the logic of your memoized method. In that case you probably want "fresh" data on every invocation of the method. There are a few approaches, depending on your preference of flavor.
 
 1. Use the reset method provided for you. It follows the pattern of `reset_memoized_value_for_#{method_name}`. Note that this will only reset the value for the current thread, and shouldn't be used to try and create consistent data state across processes.
 ```ruby
@@ -162,7 +162,31 @@ def test_config
 end
 ```
 
-2. Conditionally TTL memoize the method based on test environment or some other condition.
+2. Disable ttl memoization globally in your tests. This will prevent a memoized value from ever being returned.
+
+```ruby
+TTLMemoizeable.disable!
+```
+
+3. Reset ttl memoization values before/after your test runs.
+
+```ruby
+# RSpec
+RSpec.configure do |config|
+  config.around { TTLMemoizeable.reset!; _1.run; TTLMemoizeable.reset! }
+end
+
+# minitest
+def setup
+  TTLMemoizeable.reset!
+end
+
+def teardown
+  TTLMemoizeable.reset!
+end
+```
+
+4. Conditionally TTL memoize the method based on test environment or some other condition.
 ```ruby
 def config
   JSON.parse($redis.get("some_big_json_string"))

data/lib/ttl_memoizeable/version.rb

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

data/lib/ttl_memoizeable.rb

@@ -8,15 +8,29 @@ require_relative "ttl_memoizeable/version"
 module TTLMemoizeable
   TTLMemoizationError = Class.new(StandardError)
   SetupMutex = Mutex.new
+  EXPIRED_MONOTONIC_TIME = -365.0 * 24 * 60 * 60 # one year before the monotonic clock origin
+
+  @ttl_index = 0
+  @disabled = false
+
+  def self.disable!
+    @disabled = true
+  end
+
+  def self.reset!
+    @ttl_index += 1
+  end
 
   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)
 
     ivar_name = method_name.to_s.gsub(/\??/, "") # remove trailing question marks
     time_based_ttl = ttl.is_a?(ActiveSupport::Duration)
-    expired_ttl = time_based_ttl ? 1.year.ago : 1
+    ttl_seconds = ttl.to_f if time_based_ttl
+    expired_ttl = time_based_ttl ? EXPIRED_MONOTONIC_TIME : 1
 
     ttl_variable_name = :"@_ttl_for_#{ivar_name}"
+    ttl_index_variable_name = :"@_ttl_index_for_#{ivar_name}"
     mutex_variable_name = :"@_mutex_for_#{ivar_name}"
     value_variable_name = :"@_value_for_#{ivar_name}"
 
@@ -60,15 +74,20 @@ module TTLMemoizeable
       end
 
       define_method ttl_exceeded_method_name do
+        return true if TTLMemoizeable.instance_variable_get(:@disabled)
+        return true if TTLMemoizeable.instance_variable_get(:@ttl_index) != instance_variable_get(ttl_index_variable_name)
         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
+        if time_based_ttl
+          Process.clock_gettime(Process::CLOCK_MONOTONIC) - instance_variable_get(ttl_variable_name) >= ttl_seconds
+        else
+          instance_variable_get(ttl_variable_name) <= 0
+        end
       end
 
       define_method extend_ttl_method_name do
         if time_based_ttl
-          instance_variable_set(ttl_variable_name, Time.current)
+          instance_variable_set(ttl_variable_name, Process.clock_gettime(Process::CLOCK_MONOTONIC))
         else
           instance_variable_set(ttl_variable_name, ttl)
         end
@@ -85,6 +104,9 @@ module TTLMemoizeable
           if send(ttl_exceeded_method_name)
             send(extend_ttl_method_name)
 
+            # Synchronize the ttl index to match the module's value
+            instance_variable_set(ttl_index_variable_name, TTLMemoizeable.instance_variable_get(:@ttl_index))
+
             # Refresh value from the original method
             instance_variable_set(value_variable_name, super())
           end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ttl_memoizeable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Daniel Westendorf
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -61,7 +60,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/huntresslabs/ttl_memoizeable
   source_code_uri: https://github.com/huntresslabs/ttl_memoizeable
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,8 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Cross-thread memoization in ruby with eventual consistency.
 test_files: []