atomic_cache 0.1.0.rc1 → 0.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a6de69eb6ef0c02cbe647a36487ee3e5ef051c63
-  data.tar.gz: 140e5dacb3a85b7e67259b9789599f8d73c9d9d0
+SHA256:
+  metadata.gz: 86d21873e0440ffb327b3d9e6de724ffff524d7075c5f4588e4a4c46042cf47a
+  data.tar.gz: 956391de071f7997ccd078157449634436e3ed6316215bf6319e830c979fe0d0
 SHA512:
-  metadata.gz: 604b436749bba999493381af064d0011a6cd5197bc191267873415370e8f8484e523780ca89ad5ed302ab40bf96b784f6df505bb0ffb14a40a72e17377f049ca
-  data.tar.gz: 3abb13a75e2fb3f426ac8ea9907ca7591692f7e8219b3516009522da6f5a044fe75a360a5ac876d68c45c26e8842f6326a1a90d5b38dbd4ac1bff1b3bc23cb75
+  metadata.gz: 72eca9fdf5c4018f8934917219abb4ccde4cba7fae17482550b2087673eacec18cae5e5cb6686a00fb317424bae379ddb83cfc50f767ae456b936ac71fe8a702
+  data.tar.gz: 4739607a81c343ba2b73de9f7e36d18d4c1a76969f51d7ab4c3cbbdf54fb3274e6bc9d0244a75e8b4a8fada4aea59aa0ce5b05ed397085a5ef606fe801afd233

data/README.md

@@ -1,4 +1,5 @@
 # atomic_cache Gem
+[![Gem Version](https://badge.fury.io/rb/atomic_cache.svg)](https://badge.fury.io/rb/atomic_cache)
 [![Build Status](https://travis-ci.org/Ibotta/atomic_cache.svg?branch=master)](https://travis-ci.org/Ibotta/atomic_cache)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/790faad5866d2a00ca6c/test_coverage)](https://codeclimate.com/github/Ibotta/atomic_cache/test_coverage)
 
@@ -42,8 +43,15 @@ For further details and examples see [Usage & Testing](docs/USAGE.md)
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ibotta/atomic_cache
+
+## Releasing
+
+Releases are automatically handled via the Travis CI build. When a version greater than
+the version published on rubygems.org is pushed to the `master` branch, Travis will:
+
+- re-generate the CHANGELOG file
+- tag the release with GitHub
+- release to rubygems.org

data/docs/PROJECT_SETUP.md

@@ -1,7 +1,4 @@
 ## Gem Installation
-
-You will need to ensure you have the correct deploy credentials
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -28,6 +25,8 @@ AtomicCache::DefaultConfig.configure do |config|
 end
 ```
 
+Note that `Datadog::Statsd` is not _required_.  Adding it, however, will enable metrics support.
+
 #### Required
   * `cache_storage` - Storage adapter for cache (see below)
   * `key_storage` - Storage adapter for key manager (see below)

data/docs/USAGE.md

@@ -39,7 +39,7 @@ The danger with `quick_retry_ms` is that when enabled it applies a delay to all
 
 `quick_retry_ms` is most effective for caches that are quick to generate but whose values are slow to change.  `quick_retry_ms` is least effective for caches that are slow to update but quick to change.
 
-![quick_retry_ms graph](img/quick_retry_ms_graph.png)
+![quick_retry_ms graph](https://github.com/Ibotta/atomic_cache/raw/ca473f28e179da8c24f638eeeeb48750bc8cbe64/docs/img/quick_retry_graph.png)
 
 #### `max_retries` & `backoff_duration_ms`
 _`max_retries` defaults to 5._

data/lib/atomic_cache/version.rb

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

data/spec/atomic_cache/atomic_cache_client_spec.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'AtomicCacheClient' do
+  subject { AtomicCache::AtomicCacheClient.new(storage: cache_storage, timestamp_manager: timestamp_manager) }
+
+  let(:formatter) { Proc.new { |time| time.to_i } }
+  let(:keyspace) { AtomicCache::Keyspace.new(namespace: ['foo', 'bar'], root: 'bar') }
+  let(:key_storage) { AtomicCache::Storage::InstanceMemory.new }
+  let(:cache_storage) { AtomicCache::Storage::InstanceMemory.new }
+
+  let(:timestamp_manager) do
+    AtomicCache::LastModTimeKeyManager.new(
+      keyspace: keyspace,
+      storage: key_storage,
+      timestamp_formatter: formatter,
+    )
+  end
+
+  before(:each) do
+    AtomicCache::DefaultConfig.reset
+  end
+
+  describe '#fetch' do
+
+    context 'when the value is present' do
+      before(:each) do
+        timestamp_manager.last_modified_time = 1420090000
+      end
+
+      it 'returns the cached value' do
+        cache_storage.set(timestamp_manager.current_key(keyspace), 'value')
+        expect(subject.fetch(keyspace)).to eq('value')
+      end
+
+      it 'returns 0 as a cached value' do
+        cache_storage.set(timestamp_manager.current_key(keyspace), '0')
+        expect(subject.fetch(keyspace)).to eq('0')
+      end
+
+      it 'returns empty strings as a cached value' do
+        cache_storage.set(timestamp_manager.current_key(keyspace), '')
+        expect(subject.fetch(keyspace)).to eq('')
+      end
+    end
+
+    context 'when the value is NOT present' do
+      context 'and when a block is given' do
+        context 'and when another thread is NOT generating,' do
+
+          it 'returns the new value' do
+            result = subject.fetch(keyspace) { 'value from block' }
+            expect(result).to eq('value from block')
+          end
+
+          it 'returns the new value when it is an empty string' do
+            result = subject.fetch(keyspace) { '' }
+            expect(result).to eq('')
+          end
+
+          it 'does not store the value if the generator returns nil' do
+            # create a fallback value to make sure we don't use the value from the block
+            key_storage.set(keyspace.last_known_key_key, 'foo_value')
+            cache_storage.set('foo', 'last known value')
+
+            timestamp_manager.promote(keyspace, last_known_key: 'foo', timestamp: Time.now)
+            subject.fetch(keyspace) { nil }
+            expect(subject.fetch(keyspace)).to eq('last known value')
+          end
+
+          it 'unlocks if the generate block returns nil' do
+            subject.fetch(keyspace) { nil }
+            expect(key_storage.store).to_not have_key(:'foo:bar:lock')
+          end
+
+          it 'stores the new value' do
+            subject.fetch(keyspace) { 'value from block' }
+            expect(subject.fetch(keyspace)).to eq('value from block')
+          end
+
+          it 'stores the updated last mod time' do
+            time = Time.local(2018, 1, 1, 15, 30, 0)
+            timestamp_manager.promote(keyspace, timestamp: (time - 10).to_i, last_known_key: 'lkk')
+
+            Timecop.freeze(time) do
+              subject.fetch(keyspace) { 'value from block' }
+              lmt = key_storage.read(timestamp_manager.last_modified_time_key)
+              expect(lmt).to eq(time.to_i.to_s)
+            end
+          end
+
+          it 'stores the current key as the last known key' do
+            time = Time.local(2018, 1, 1, 15, 30, 0)
+            timestamp_manager.promote(keyspace, last_known_key: "test:#{(time - 10).to_i}", timestamp: time.to_i)
+
+            Timecop.freeze(time) do
+              subject.fetch(keyspace) { 'value from block' }
+              lkk = key_storage.read(keyspace.last_known_key_key)
+              new_key = timestamp_manager.next_key(keyspace, time)
+              expect(lkk).to eq(new_key)
+            end
+          end
+
+          it 'sets a TTL on the build key when a TTL is not explicitly given' do
+            subject.fetch(keyspace) { 'value from block' }
+            lock_entry = key_storage.store[keyspace.lock_key.to_sym]
+            expect(lock_entry[:ttl]).to eq(30)
+          end
+
+          it 'sets a TTL on the build key when a TTL is given at fetch time' do
+            subject.fetch(keyspace, generate_ttl_ms: 1100) { 'value from block' }
+            lock_entry = key_storage.store[keyspace.lock_key.to_sym]
+            expect(lock_entry[:ttl]).to eq(1.1)
+          end
+
+          it 'sets a TTL on the build key when a value less than a second is given' do
+            subject.fetch(keyspace, generate_ttl_ms: 500) { 'value from block' }
+            lock_entry = key_storage.store[keyspace.lock_key.to_sym]
+            expect(lock_entry[:ttl]).to eq(0.5)
+          end
+
+          it 'sets a TTL on the build key when there is a TTL in the default options' do
+            subject = AtomicCache::AtomicCacheClient.new(
+              storage: cache_storage,
+              timestamp_manager: timestamp_manager,
+              default_options: { generate_ttl_ms: 600 }
+            )
+
+            subject.fetch(keyspace) { 'value from block' }
+            lock_entry = key_storage.store[keyspace.lock_key.to_sym]
+            expect(lock_entry[:ttl]).to eq(0.6)
+          end
+        end
+
+        context 'and when another thread is generating the new value,' do
+          before(:each) do
+            timestamp_manager.lock(keyspace, 100)
+          end
+
+          it 'waits for a short duration to see if the other thread generated the value' do
+            timestamp_manager.promote(keyspace, last_known_key: 'lkk', timestamp: 1420090000)
+            key_storage.set('lkk', 'old:value')
+            new_value = 'value from another thread'
+            allow(cache_storage).to receive(:read)
+              .with(timestamp_manager.current_key(keyspace), anything)
+              .and_return(nil, new_value)
+
+            expect(subject.fetch(keyspace, quick_retry_ms: 5) { 'value' }).to eq(new_value)
+          end
+
+          context 'when the last known value is present' do
+            it 'returns the last known value' do
+              timestamp_manager.promote(keyspace, last_known_key: 'lkk', timestamp: 1420090000)
+              cache_storage.set('lkk', 'old value')
+
+              result = subject.fetch(keyspace, backoff_duration_ms: 5) { 'value from generate' }
+              expect(result).to eq('old value')
+            end
+          end
+
+          context 'when the last known value is NOT present' do
+            it 'waits for another thread to generate the new value' do
+              key_storage.set(timestamp_manager.last_modified_time_key, '1420090000')
+              new_value = 'value from another thread'
+
+              # multiple returned values here are faking what it would look like to
+              # the client if another thread suddenly wrote a value into the cache
+              allow(cache_storage).to receive(:read)
+                .with(timestamp_manager.current_key(keyspace), anything)
+                .and_return(nil, nil, nil, nil, new_value)
+
+              result = subject.fetch(keyspace, backoff_duration_ms: 5) { 'value from generate' }
+              expect(result).to eq(new_value)
+            end
+
+            it 'stops waiting when the max retry count is reached' do
+              timestamp_manager.promote(keyspace, last_known_key: 'asdf', timestamp: 1420090000)
+              result = subject.fetch(keyspace, backoff_duration_ms: 5) { 'value from generate' }
+              expect(result).to eq(nil)
+            end
+
+            it 'deletes the last known key' do
+              key_storage.set(keyspace.last_known_key_key, :oldkey)
+              cache_storage.set(:oldkey, nil)
+              subject.fetch(keyspace, backoff_duration_ms: 5) { 'value from generate' }
+              expect(cache_storage.store).to_not have_key(:oldkey)
+            end
+          end
+        end
+      end
+
+      context 'and when a block is NOT given' do
+        it 'waits for a short duration to see if the other thread generated the value' do
+          timestamp_manager.promote(keyspace, last_known_key: 'asdf', timestamp: 1420090000)
+          new_value = 'value from another thread'
+          allow(cache_storage).to receive(:read)
+            .with(timestamp_manager.current_key(keyspace), anything)
+            .and_return(nil, new_value)
+
+          result = subject.fetch(keyspace, quick_retry_ms: 50)
+          expect(result).to eq(new_value)
+        end
+
+        it 'returns nil if nothing is present' do
+          expect(subject.fetch(keyspace)).to eq(nil)
+        end
+      end
+    end
+
+  end
+
+end

data/spec/atomic_cache/concerns/global_lmt_cache_concern_spec.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'AtomicCacheConcern' do
+  let(:key_storage) { DefaultConfig.instance.key_storage }
+  let(:cache_storage) { DefaultConfig.instance.cache_storage }
+
+  subject do
+    class Foo1
+      include AtomicCache::GlobalLMTCacheConcern
+    end
+  end
+
+  before(:context) do
+    DefaultConfig.instance.reset
+    DefaultConfig.configure do |cfg|
+      cfg.cache_storage = AtomicCache::Storage::SharedMemory.new
+      cfg.key_storage = AtomicCache::Storage::SharedMemory.new
+      cfg.timestamp_formatter = Proc.new { |time| time.to_i }
+    end
+  end
+
+  before(:each) do
+    key_storage.reset
+    cache_storage.reset
+  end
+
+  context 'AtomicCache' do
+    it 'initializes a cache client' do
+      expect(subject).to respond_to(:AtomicCache)
+      expect(subject.AtomicCache).to be_a(AtomicCacheClient)
+      expect(subject.new.AtomicCache).to be_a(AtomicCacheClient)
+    end
+
+    it 'uses the name of the class in the default keyspace' do
+      subject.expire_cache
+      expect(key_storage.store).to have_key(:'foo1:lmt')
+    end
+  end
+
+  context '#expire_cache' do
+    it 'updates the last modified time' do
+      time = Time.local(2018, 1, 1, 15, 30, 0)
+      subject.expire_cache(time)
+      expect(key_storage.store).to have_key(:'foo1:lmt')
+      expect(key_storage.store[:'foo1:lmt'][:value]).to eq(time.to_i.to_s)
+    end
+
+    it 'expires all the keyspaces for this class' do
+      old_time = Time.local(2018, 1, 1, 15, 30, 0)
+      new_time = Time.local(2018, 1, 1, 15, 40, 0)
+      ns1 = subject.cache_keyspace(:bar)
+      ns2 = subject.cache_keyspace(:buz)
+
+      Timecop.freeze(old_time) do
+        subject.AtomicCache.fetch(ns1) { 'bar' }
+        subject.AtomicCache.fetch(ns2) { 'buz' }
+      end
+
+      Timecop.freeze(new_time) do
+        subject.expire_cache
+        lmt = subject.last_modified_time
+
+        # some other process writes new values
+        cache_storage.set("foo1:bar:#{lmt}", 'new-bar')
+        cache_storage.set("foo1:buz:#{lmt}", 'new-buz')
+
+        ns1_value = subject.AtomicCache.fetch(ns1)
+        ns2_value = subject.AtomicCache.fetch(ns2)
+
+        expect(ns1_value).to eq('new-bar')
+        expect(ns2_value).to eq('new-buz')
+      end
+    end
+  end
+
+  context '#cache_keyspace' do
+    it 'returns a child keyspace of the class keyspace' do
+      ns = subject.cache_keyspace(:fuz, :baz)
+      expect(ns).to be_a(Keyspace)
+      expect(ns.namespace).to eq(['foo1', :fuz, :baz])
+    end
+  end
+
+  context 'keyspace macros' do
+    subject do
+      class Foo2
+        include AtomicCache::GlobalLMTCacheConcern
+        cache_version(3)
+        cache_class('foo')
+      end
+      Foo2
+    end
+
+    it 'uses the given version and cache_class become part of the cache keyspace' do
+      subject.expire_cache
+      expect(key_storage.store).to have_key(:'foo:v3:lmt')
+    end
+  end
+
+  context 'storage macros' do
+    subject do
+      class Foo3
+        include AtomicCache::GlobalLMTCacheConcern
+        cache_key_storage('keystore')
+        cache_value_storage('valuestore')
+      end
+      Foo3
+    end
+
+    it 'sets the storage for the class' do
+      cache_store = subject.AtomicCache.instance_variable_get(:@storage)
+      expect(cache_store).to eq('valuestore')
+
+      key_store = subject.instance_variable_get(:@timestamp_manager).instance_variable_get(:@storage)
+      expect(key_store).to eq('keystore')
+    end
+  end
+
+end

data/spec/atomic_cache/default_config_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'DefaultConfig' do
+  subject { DefaultConfig }
+
+  context '#configure' do
+    it 'configures the singleton' do
+      subject.configure do |manager|
+        manager.namespace = 'foo'
+      end
+
+      expect(subject.instance.namespace).to eq('foo')
+    end
+  end
+end

data/spec/atomic_cache/key/keyspace_spec.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Keyspace' do
+  subject { AtomicCache::Keyspace.new(namespace: ['foo', 'bar'], root: 'foo') }
+
+  context '#initialize' do
+    it 'hashes non-primitive types' do
+      ids = [1,2,3]
+      ns1 = AtomicCache::Keyspace.new(namespace: ['foo', ids])
+      hash = ns1.send(:hexhash, ids)
+      expect(ns1.namespace).to eq(['foo', hash])
+    end
+
+    it 'leaves primitives alone' do
+      ns1 = AtomicCache::Keyspace.new(namespace: ['foo', :foo, 5])
+      expect(ns1.namespace).to eq(['foo', :foo, 5])
+    end
+
+    it 'sorts sortable values before hashing' do
+      ns1 = AtomicCache::Keyspace.new(namespace: ['foo', [1, 2, 3]])
+      ns2 = AtomicCache::Keyspace.new(namespace: ['foo', [3, 2, 1]])
+      expect(ns1.namespace).to eq(ns2.namespace)
+    end
+  end
+
+  context '#child' do
+    it 'extends the keyspace' do
+      ns2 = subject.child([:buz, :baz])
+      expect(ns2.namespace).to eq(['foo', 'bar', :buz, :baz])
+    end
+  end
+
+  context '#key' do
+    it 'return a key of the segments' do
+      expect(subject.key).to eq('foo:bar')
+    end
+
+    it 'return the key with the suffix' do
+      expect(subject.key('baz')).to eq('foo:bar:baz')
+    end
+  end
+
+end

data/spec/atomic_cache/key/last_mod_time_key_manager_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'LastModTimeKeyManager' do
+  let(:id) { :foo }
+  let(:timestamp) { 1513720308 }
+  let(:storage) { AtomicCache::Storage::InstanceMemory.new }
+  let(:timestamp_keyspace) { Keyspace.new(namespace: ['ts'], root: 'foo') }
+  let(:req_keyspace) { Keyspace.new(namespace: ['ns'], root: 'bar') }
+
+  subject do
+    AtomicCache::LastModTimeKeyManager.new(
+      keyspace: timestamp_keyspace,
+      storage: storage,
+      timestamp_formatter: Proc.new { |t| t.to_i }
+    )
+  end
+
+  it 'returns the #next_key' do
+    expect(subject.next_key(req_keyspace, timestamp)).to eq('ns:1513720308')
+  end
+
+  it 'gets and sets the #last_known_key' do
+    subject.promote(req_keyspace, last_known_key: 'bar:foo:1513600308', timestamp: timestamp)
+    expect(subject.last_known_key(req_keyspace)).to eq('bar:foo:1513600308')
+    expect(storage.store).to have_key(:'ns:lkk')
+  end
+
+  it 'returns the #last_mod_time_key' do
+    expect(subject.last_modified_time_key).to eq('ts:lmt')
+  end
+
+  it 'locks and unlocks' do
+    locked = subject.lock(req_keyspace, 100)
+    expect(storage.store).to have_key(:'ns:lock')
+    expect(locked).to eq(true)
+
+    subject.unlock(req_keyspace)
+    expect(storage.store).to_not have_key(:'ns:lock')
+  end
+
+  it 'promotes a timestamp and last known key' do
+    subject.promote(req_keyspace, last_known_key: 'asdf', timestamp: timestamp)
+    expect(storage.store[:'ns:lkk'][:value]).to eq('asdf')
+    expect(storage.store[:'ts:lmt'][:value]).to eq(timestamp.to_s)
+    expect(subject.last_modified_time).to eq(timestamp.to_s)
+  end
+
+  context '#last_modified_time=' do
+    it 'returns the last modified time' do
+      subject.last_modified_time = timestamp
+      expect(storage.store[:'ts:lmt'][:value]).to eq(timestamp.to_s)
+      expect(subject.last_modified_time).to eq(timestamp.to_s)
+    end
+
+    it 'formats Time' do
+      now = Time.now
+      subject.last_modified_time = now
+      expect(subject.last_modified_time).to eq(now.to_i.to_s)
+    end
+  end
+
+end

data/spec/atomic_cache/storage/dalli_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+class FakeDalli
+  def add(key, new_value, ttl, user_options); end
+  def read(key, user_options); end
+  def set(key, new_value, user_options); end
+  def delete(key, user_options); end
+end
+
+describe 'Dalli' do
+  let(:dalli_client) { FakeDalli.new }
+  subject { AtomicCache::Storage::Dalli.new(dalli_client) }
+
+  it 'delegates #set without options' do
+    expect(dalli_client).to receive(:set).with('key', 'value', {})
+    subject.set('key', 'value')
+  end
+
+  it 'delegates #read without options' do
+    expect(dalli_client).to receive(:read).with('key', {})
+    subject.read('key')
+  end
+
+  it 'delegates #delete' do
+    expect(dalli_client).to receive(:delete).with('key')
+    subject.delete('key')
+  end
+
+  context '#add' do
+    before(:each) do
+      allow(dalli_client).to receive(:add).and_return('NOT_STORED\r\n')
+    end
+
+    it 'delegates to #add with the raw option set' do
+      expect(dalli_client).to receive(:add)
+        .with('key', 'value', 100, { foo: 'bar', raw: true })
+      subject.add('key', 'value', 100, { foo: 'bar' })
+    end
+
+    it 'returns true when the add is successful' do
+      expect(dalli_client).to receive(:add).and_return('STORED\r\n')
+      result = subject.add('key', 'value', 100)
+      expect(result).to eq(true)
+    end
+
+    it 'returns false if the key already exists' do
+      expect(dalli_client).to receive(:add).and_return('EXISTS\r\n')
+      result = subject.add('key', 'value', 100)
+      expect(result).to eq(false)
+    end
+
+    it 'returns false if the add fails' do
+      expect(dalli_client).to receive(:add).and_return('NOT_STORED\r\n')
+      result = subject.add('key', 'value', 100)
+      expect(result).to eq(false)
+    end
+  end
+
+end

data/spec/atomic_cache/storage/instance_memory_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require_relative 'memory_spec'
+
+describe 'InstanceMemory' do
+  subject { AtomicCache::Storage::InstanceMemory.new }
+  it_behaves_like 'memory storage'
+end

data/spec/atomic_cache/storage/memory_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+shared_examples 'memory storage' do
+  before(:each) do
+    subject.reset
+  end
+
+  context '#add' do
+    it 'writes the new key if it does not already exist' do
+      result = subject.add('key', 'value', 100)
+
+      expect(subject.store).to have_key(:key)
+      expect(subject.store[:key][:value]).to eq('value')
+      expect(subject.store[:key][:ttl]).to eq(100)
+      expect(result).to eq(true)
+    end
+
+    it 'does not write the key if it exists' do
+      entry = { value: 'foo', ttl: 100, written_at: 100 }
+      subject.store[:key] = entry
+
+      result = subject.add('key', 'value', 200)
+      expect(result).to eq(false)
+
+      # stored values should not have changed
+      expect(subject.store).to have_key(:key)
+      expect(subject.store[:key][:value]).to eq('foo')
+      expect(subject.store[:key][:ttl]).to eq(100)
+    end
+  end
+
+  context '#read' do
+    it 'returns values' do
+      subject.store[:sugar] = { value: 'foo' }
+      expect(subject.read('sugar')).to eq('foo')
+    end
+
+    it 'respects TTL' do
+      subject.store[:sugar] = { value: 'foo', ttl: 100, written_at: Time.now - 1000 }
+      expect(subject.read('sugar')).to eq(nil)
+    end
+  end
+
+  context '#set' do
+    it 'adds the value when not present' do
+      subject.set(:cane, 'v', expires_in: 100)
+      expect(subject.store).to have_key(:cane)
+      expect(subject.store[:cane][:value]).to eq('v')
+      expect(subject.store[:cane][:ttl]).to eq(100)
+    end
+
+    it 'overwrites existing values' do
+      subject.store[:cane] = { value: 'foo', ttl: 500, written_at: 500 }
+
+      subject.set(:cane, 'v', expires_in: 100)
+      expect(subject.store).to have_key(:cane)
+      expect(subject.store[:cane][:value]).to eq('v')
+      expect(subject.store[:cane][:ttl]).to eq(100)
+    end
+  end
+
+  context '#delete' do
+    it 'deletes the key' do
+      subject.store[:record] = { value: 'foo', written_at: 500 }
+      subject.delete('record')
+      expect(subject.store).to_not have_key(:record)
+    end
+  end
+
+end

data/spec/atomic_cache/storage/shared_memory_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require_relative 'memory_spec'
+
+describe 'InstanceMemory' do
+  subject { AtomicCache::Storage::SharedMemory.new }
+  it_behaves_like 'memory storage'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'bundler/setup'
+require 'atomic_cache'
+require 'timecop'
+
+DefaultConfig = AtomicCache::DefaultConfig
+AtomicCacheClient = AtomicCache::AtomicCacheClient
+Keyspace = AtomicCache::Keyspace
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    expectations.syntax = :expect
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atomic_cache
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc1
+  version: 0.1.0.rc2
 platform: ruby
 authors:
 - Ibotta Developers
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-16 00:00:00.000000000 Z
+date: 2018-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -27,18 +27,60 @@ dependencies:
         version: '1.14'
 - !ruby/object:Gem::Dependency
   name: gems
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.15.0.pre.rc
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.15.0.pre.rc
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +144,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -109,6 +154,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: murmurhash3
   requirement: !ruby/object:Gem::Requirement
@@ -129,17 +177,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".ruby_version"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- atomic_cache.gemspec
-- bin/console
-- bin/setup
 - docs/ARCH.md
 - docs/INTERFACES.md
 - docs/MODEL_SETUP.md
@@ -158,9 +197,19 @@ files:
 - lib/atomic_cache/storage/shared_memory.rb
 - lib/atomic_cache/storage/store.rb
 - lib/atomic_cache/version.rb
+- spec/atomic_cache/atomic_cache_client_spec.rb
+- spec/atomic_cache/concerns/global_lmt_cache_concern_spec.rb
+- spec/atomic_cache/default_config_spec.rb
+- spec/atomic_cache/key/keyspace_spec.rb
+- spec/atomic_cache/key/last_mod_time_key_manager_spec.rb
+- spec/atomic_cache/storage/dalli_spec.rb
+- spec/atomic_cache/storage/instance_memory_spec.rb
+- spec/atomic_cache/storage/memory_spec.rb
+- spec/atomic_cache/storage/shared_memory_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/ibotta/atomic_cache
 licenses:
-- apache 2.0
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -178,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: summary

data/.gitignore

@@ -1,51 +0,0 @@
-*.gem
-*.rbc
-.rspec_status
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc

data/.ruby_version

@@ -1 +0,0 @@
-2.4.3

data/.travis.yml

@@ -1,26 +0,0 @@
-language: ruby
-
-stages:
-  - test-2.4
-  - test-2.5
-  - publish-gem
-
-jobs:
-  include:
-    - stage: test-2.4
-      rvm: 2.4.3
-      script:
-        - bundle exec rake spec
-
-    - stage: test-2.5
-      rvm: 2.5.0
-      before_script:
-        - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-        - chmod +x ./cc-test-reporter
-        - ./cc-test-reporter before-build
-      script:
-        - bundle exec rake spec
-      after_script:
-        - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-
-    - stage: publish-gem

data/CODE_OF_CONDUCT.md

@@ -1,46 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at osscompliance@ibotta.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify gem's dependencies in atomic_cache.gemspec
-gemspec

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/atomic_cache.gemspec

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'atomic_cache/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'atomic_cache'
-  spec.version       = AtomicCache::VERSION
-  spec.authors       = ['Ibotta Developers', 'Titus Stone']
-  spec.email         = 'osscompliance@ibotta.com'
-
-  spec.summary       = 'summary'
-  spec.description   = 'desc'
-
-  spec.licenses      = ['apache 2.0']
-  spec.homepage      = 'https://github.com/ibotta/atomic_cache'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-
-  spec.require_paths = ['lib']
-
-  # Dev dependencies
-  spec.add_development_dependency 'bundler', '~> 1.14'
-  spec.add_development_dependency 'gems', '>= 1.0.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov', '~> 0.15'
-  spec.add_development_dependency 'timecop', '~> 0.8.1'
-
-  # Dependencies
-  spec.add_dependency 'activesupport', '>= 4.2'
-  spec.add_dependency 'murmurhash3', '~> 0.1'
-end

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "atomic_cache"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here