atomic_cache 0.4.1.rc1 → 0.5.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db2b157ed872e6cb90af8cf2ef61a97f237485bc763998464eb4faf488d26c11
-  data.tar.gz: 48e13e212479454f2ece192c81c8f755a4aa039a2cf5930cf1cdfea2eaae438d
+  metadata.gz: 7362eab306c19b619c6eb4bd30501b2b18194cd9e870a344e45b39c6ff18b4ae
+  data.tar.gz: cce7666dec7a66bca3717cb7278bcdb9d7b81aaffc8c68fb020e15e02820f921
 SHA512:
-  metadata.gz: 5fb9aba2eaeb20e9e3206c80039941b005c7f6e82c05bfddd59482783b028706f706a6843a8ea8261d18895732035d1deeabda178e5437620f33ca9abf88b54e
-  data.tar.gz: 06511e8a0ec9b33de005994f6938877f85b053c03072f52b6cc0dbd22a99389dfb36245f7002d59ea364d1ea583eec0b440c6bd2a5e1b84604434474275d6fe2
+  metadata.gz: b418f307870a20aa99b326644c14066d3baba30287138ce2a4b533582d788231058c0f3f66737fcf19225cdadbcf5dbb78653d7969ade7eb7555a7c3f849b4c2
+  data.tar.gz: c9f48abddc3b0f9d623db83bd493df4fd555ae468710251dd13db6ed684399052b52a48ffec516f96ae17a1ccc747416688b2234f514ef8278bba0fd4ed550d2

data/docs/USAGE.md

@@ -72,6 +72,13 @@ All incoming keys are normalized to symbols.  All values are stored with a `valu
 
 It's likely preferable to use an environments file to configure the `key_storage` and `cache_storage` to always be an in-memory adapter when running in the test environment instead of manually configuring the storage adapter per spec.
 
+#### TTL in Tests
+In a test environment, unlike in a production environment, database queries are fast, and time doesn't elapse quite like it does in the real world. As tests get more complex, they perform changes for which they expect the cache to expire. However, because of the synthetic nature of testing, TTLs, particularly those on locks, don't quite work the same either.
+
+There are a few approaches to address this, for example, using `sleep` to cause real time to pass (not preferable) or wrapping each test in a TimeCop, forcing time to pass (works but quite manual).
+
+Since this situation is highly likely to arise, `atomic_cache` provides a feature to globally disable enforcing TTL on locks for the `SharedMemory` implementation. Set `enforce_ttl = false` to disable TTL checking on locks within SharedMemory in a test context. This will prevent tests from failing due to unexpired TTLs on locks. 
+
 #### ★ Testing Tip ★
 If using `SharedMemory` for integration style tests, a global `before(:each)` can be configured in `spec_helper.rb`.
 
@@ -79,9 +86,10 @@ If using `SharedMemory` for integration style tests, a global `before(:each)` ca
 # spec/spec_helper.rb
 RSpec.configure do |config|
 
-  #your other config
+  # your other config
 
   config.before(:each) do
+    AtomicCache::Storage::SharedMemory.enforce_ttl = false
     AtomicCache::Storage::SharedMemory.reset
   end
 end

data/lib/atomic_cache/storage/shared_memory.rb

@@ -10,6 +10,21 @@ module AtomicCache
       STORE = {}
       SEMAPHORE = Mutex.new
 
+      @enforce_ttl = true
+      class << self
+        attr_accessor :enforce_ttl
+      end
+
+      def add(raw_key, new_value, ttl, user_options={})
+        if self.class.enforce_ttl
+          super(raw_key, new_value, ttl, user_options)
+        else
+          store_op(raw_key, user_options) do |key, options|
+            write(key, new_value, ttl, user_options)
+          end
+        end
+      end
+
       def self.reset
         STORE.clear
       end

data/lib/atomic_cache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AtomicCache
-  VERSION = "0.4.1.rc1"
+  VERSION = "0.5.0.rc1"
 end

data/spec/atomic_cache/storage/memory_spec.rb

@@ -17,8 +17,6 @@ shared_examples 'memory storage' do
       expect(result).to eq(true)
     end
 
-    # SharedMemory.new.add("foo", ttl: 100)
-
     it 'does not write the key if it exists but expiration time is NOT up' do
       entry = { value: Marshal.dump('foo'), ttl: 5000, written_at: Time.local(2021, 1, 1, 12, 0, 0) }
       subject.store[:key] = entry

data/spec/atomic_cache/storage/shared_memory_spec.rb

@@ -6,4 +6,18 @@ require_relative 'memory_spec'
 describe 'SharedMemory' do
   subject { AtomicCache::Storage::SharedMemory.new }
   it_behaves_like 'memory storage'
+
+  context 'enforce_ttl disabled' do
+    before(:each) do
+      AtomicCache::Storage::SharedMemory.enforce_ttl = false
+    end
+
+    it 'allows instantly `add`ing keys' do
+      subject.add("foo", 1, ttl: 100000)
+      subject.add("foo", 2, ttl: 1)
+
+      expect(subject.store).to have_key(:foo)
+      expect(Marshal.load(subject.store[:foo][:value])).to eq(2)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -17,4 +17,8 @@ RSpec.configure do |config|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
     expectations.syntax = :expect
   end
+
+  config.before(:each) do
+    AtomicCache::Storage::SharedMemory.enforce_ttl = true
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atomic_cache
 version: !ruby/object:Gem::Version
-  version: 0.4.1.rc1
+  version: 0.5.0.rc1
 platform: ruby
 authors:
 - Ibotta Developers
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler