ttl_memoizeable 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bfd9bff4af04e7d281a909a72599a275248c9383d47b41a24070d6bf81e078d
-  data.tar.gz: ffeebfbd0819b10edcdb81cee518230d8e09365778502b20a4a4b57cf33c31f3
+  metadata.gz: 3b581b14f0f85cb39ade5f62d67f65406da66b93c781949df441d29f0674a109
+  data.tar.gz: 18c9172f7a764aefd95372bfc7b4d2ed2d44b110bd1dfc3aff306bcec37be9b3
 SHA512:
-  metadata.gz: c495822e3eedad2c355104485013add856feb652ae8dd471a2352ff7db46081895586318a460e81a579a10301c40f28675f3df1c9beadab6b54794a1c14fe659
-  data.tar.gz: 8b96325db978539ba5c0cf82f775babbd15ef242ca870784b2997a8a6da42d013604e35adf6bf0f7dd6982b27d491070419882ddfcf0d3e5f30cf9f096c4bed3
+  metadata.gz: fa200db2d8e1c62773f338a8496a17e169717a1581b7922c96ce2b45359f702920aff7f9ae724cdabf9124161bbecc38c844f1233ab596afa91bb7dc3243565f
+  data.tar.gz: 9ed75c14082a23065875df1beee159725806f895f8da147b96c3cbd13e9ac2b5b1b230fafd47b4c169eba6f190a6e8e59bd924be3a9f2d6ba9150b30edbb9517

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 ## [Unreleased]
-## [0.2.1] - 2024-01-03
-- Fix bugs that could result in memoizing nil values
+## [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
 - Publish to rubygems
 

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.2.1"
+  VERSION = "0.4.0"
 end

data/lib/ttl_memoizeable.rb

@@ -9,6 +9,17 @@ module TTLMemoizeable
   TTLMemoizationError = Class.new(StandardError)
   SetupMutex = Mutex.new
 
+  @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)
 
@@ -17,6 +28,7 @@ module TTLMemoizeable
     expired_ttl = time_based_ttl ? 1.year.ago : 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,6 +72,8 @@ 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
@@ -85,6 +99,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,14 @@
 --- !ruby/object:Gem::Specification
 name: ttl_memoizeable
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel Westendorf
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Cross-thread memoization in ruby with eventual consistency.