flipper-active_support_cache_store 0.21.0.rc1 → 0.21.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69675aef1db8485e9f3cb21398969b3031a3d3040b37356861c963d28acc4dff
-  data.tar.gz: aefece2a0e08906eedec01aae748c3abcb7b1e6b5ff1dd8366a6c569068dd7d7
+  metadata.gz: 4f12adc3f156610eebdaffc6a039d7dba84751fad860e234f6dd187c6335df6a
+  data.tar.gz: '09e8c057928a894574dc62104e08ab6ec58f1baea9bac8a96f69c2035cabce8e'
 SHA512:
-  metadata.gz: 4a4d65cb32750bd93c37dce86702e7b11e3d945a4cfe1c385c452f5ee8306ff3be2f29163d704f94a19d3462518f4a00f7db77ed8a0cb84acb4130208595ee23
-  data.tar.gz: fa9d79f5c02b4a053242fdbc7dec9c63630aa905c1beca9f3319d4520598fe46887438162104b008620ef92c8c8feb666948868966153ead918ad9b43b5f7a32
+  metadata.gz: c9015ed24e352c961e522dfa5ec0595fdda7d09dadb52551fa611b33177a436324061524282e421c6fd1529222feb36f9d41300a7b07cb440c299ee23d076d45
+  data.tar.gz: b609e58938ef8ac86d4b53d0d1d97087fef87e982881745549be5e1f021a738fcaed78b3f7d1fecd82a78ec1acac5ba50ed4b046d9ad14434ffb24ca904ea3d0

data/docs/active_support_cache_store/README.md

@@ -22,11 +22,17 @@ Or install it yourself with:
 require 'active_support/cache'
 require 'flipper/adapters/active_support_cache_store'
 
-memory_adapter = Flipper::Adapters::Memory.new
-cache = ActiveSupport::Cache::MemoryStore.new
-adapter = Flipper::Adapters::ActiveSupportCacheStore.new(memory_adapter, cache, expires_in: 5.minutes)
-flipper = Flipper.new(adapter)
+Flipper.configure do |config|
+  config.adapter do
+    Flipper::Adapters::ActiveSupportCacheStore.new(
+      Flipper::Adapters::Memory.new,
+      ActiveSupport::Cache::MemoryStore.new, # Or Rails.cache
+      expires_in: 5.minutes
+    )
+  end
+end
 ```
+
 Setting `expires_in` is optional and will set an expiration time on Flipper cache keys.  If specified, all flipper keys will use this `expires_in` over the `expires_in` passed to your ActiveSupport cache constructor.
 
 ## Internals

data/lib/flipper/adapters/active_support_cache_store.rb

@@ -25,12 +25,13 @@ module Flipper
       attr_reader :name
 
       # Public
-      def initialize(adapter, cache, expires_in: nil)
+      def initialize(adapter, cache, expires_in: nil, write_through: false)
         @adapter = adapter
         @name = :active_support_cache_store
         @cache = cache
         @write_options = {}
         @write_options[:expires_in] = expires_in if expires_in
+        @write_through = write_through
       end
 
       # Public
@@ -49,7 +50,13 @@ module Flipper
       def remove(feature)
         result = @adapter.remove(feature)
         @cache.delete(FeaturesKey)
-        @cache.delete(key_for(feature.key))
+
+        if @write_through
+          @cache.write(key_for(feature.key), default_config, @write_options)
+        else
+          @cache.delete(key_for(feature.key))
+        end
+
         result
       end
 
@@ -88,14 +95,26 @@ module Flipper
       ## Public
       def enable(feature, gate, thing)
         result = @adapter.enable(feature, gate, thing)
-        @cache.delete(key_for(feature.key))
+
+        if @write_through
+          @cache.write(key_for(feature.key), @adapter.get(feature), @write_options)
+        else
+          @cache.delete(key_for(feature.key))
+        end
+
         result
       end
 
       ## Public
       def disable(feature, gate, thing)
         result = @adapter.disable(feature, gate, thing)
-        @cache.delete(key_for(feature.key))
+
+        if @write_through
+          @cache.write(key_for(feature.key), @adapter.get(feature), @write_options)
+        else
+          @cache.delete(key_for(feature.key))
+        end
+
         result
       end
 

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.21.0.rc1'.freeze
+  VERSION = '0.21.0.rc2'.freeze
 end

data/spec/flipper/adapters/active_support_cache_store_spec.rb

@@ -10,7 +10,8 @@ RSpec.describe Flipper::Adapters::ActiveSupportCacheStore do
     Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
   end
   let(:cache) { ActiveSupport::Cache::MemoryStore.new }
-  let(:adapter) { described_class.new(memory_adapter, cache, expires_in: 10.seconds) }
+  let(:write_through) { false }
+  let(:adapter) { described_class.new(memory_adapter, cache, expires_in: 10.seconds, write_through: write_through) }
   let(:flipper) { Flipper.new(adapter) }
 
   subject { adapter }
@@ -22,11 +23,75 @@ RSpec.describe Flipper::Adapters::ActiveSupportCacheStore do
   it_should_behave_like 'a flipper adapter'
 
   describe '#remove' do
-    it 'expires feature' do
-      feature = flipper[:stats]
+    let(:feature) { flipper[:stats] }
+
+    before do
       adapter.get(feature)
       adapter.remove(feature)
-      expect(cache.read(described_class.key_for(feature))).to be(nil)
+    end
+
+    it 'expires feature and deletes the cache' do
+      expect(cache.read(described_class.key_for(feature))).to be_nil
+      expect(cache.exist?(described_class.key_for(feature))).to be(false)
+      expect(feature).not_to be_enabled
+    end
+
+    context 'with write-through caching' do
+      let(:write_through) { true }
+
+      it 'expires feature and writes an empty value to the cache' do
+        expect(cache.read(described_class.key_for(feature))).to eq(adapter.default_config)
+        expect(cache.exist?(described_class.key_for(feature))).to be(true)
+        expect(feature).not_to be_enabled
+      end
+    end
+  end
+
+  describe '#enable' do
+    let(:feature) { flipper[:stats] }
+
+    before do
+      adapter.enable(feature, feature.gate(:boolean), flipper.boolean)
+    end
+
+    it 'enables feature and deletes the cache' do
+      expect(cache.read(described_class.key_for(feature))).to be_nil
+      expect(cache.exist?(described_class.key_for(feature))).to be(false)
+      expect(feature).to be_enabled
+    end
+
+    context 'with write-through caching' do
+      let(:write_through) { true }
+
+      it 'expires feature and writes to the cache' do
+        expect(cache.exist?(described_class.key_for(feature))).to be(true)
+        expect(cache.read(described_class.key_for(feature))).to include(boolean: 'true')
+        expect(feature).to be_enabled
+      end
+    end
+  end
+
+  describe '#disable' do
+    let(:feature) { flipper[:stats] }
+
+    before do
+      adapter.disable(feature, feature.gate(:boolean), flipper.boolean)
+    end
+
+    it 'disables feature and deletes the cache' do
+      expect(cache.read(described_class.key_for(feature))).to be_nil
+      expect(cache.exist?(described_class.key_for(feature))).to be(false)
+      expect(feature).not_to be_enabled
+    end
+
+    context 'with write-through caching' do
+      let(:write_through) { true }
+
+      it 'expires feature and writes to the cache' do
+        expect(cache.exist?(described_class.key_for(feature))).to be(true)
+        expect(cache.read(described_class.key_for(feature))).to include(boolean: nil)
+        expect(feature).not_to be_enabled
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_support_cache_store
 version: !ruby/object:Gem::Version
-  version: 0.21.0.rc1
+  version: 0.21.0.rc2
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-01 00:00:00.000000000 Z
+date: 2021-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0.rc1
+        version: 0.21.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0.rc1
+        version: 0.21.0.rc2
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement