flipper-active_support_cache_store 0.20.2 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f250c3499d7a42de7ff01b6597fcd1e38dd7948d2a25b86c34b9145124761a7
-  data.tar.gz: 68a89b278741554f57663aab1d3403c65e525f4c56406d2eb1e65d9113cc0841
+  metadata.gz: 97291b08435046173139c9733f168b6c8a781777b2a621f849612932eb6ea4ba
+  data.tar.gz: 54593f4f4d2911fa09163653ad2d0f6e121219bb7b84f202ad444d8f49b1bfa1
 SHA512:
-  metadata.gz: 5d0c4d294f49d1725144fa186bb0b912aa1bb7350b1ebce6055ec1b4075c4e3d6c5c2dea6f6a29a0ca395588e29a4ffd8822afede501ed5b70b2e67cfd582558
-  data.tar.gz: e3ef019c41200d5e0a55a8397ba42457a0a62f634e351ecb6b572051cb07aff5ce322a582bcf76aa2902b99d7b5dbe7f9794b5fb643f42ab72f3ea15e6582569
+  metadata.gz: 47719dc1606c7312f0f4e1363ed3af8e1ea71951ce992f3f3acbf30a48da07d1f1b753b331e36abad760c5258c3a04ecccbb09134308361942df862b36af2275
+  data.tar.gz: 26daa127ded637885513267c7502e982b8ce533a688ee916344ed04d87fa842f0008b648a47bcf5fe01eedf026b31cd906f142410663c884df786ff6ab17da2d

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.20.2'.freeze
+  VERSION = '0.21.0'.freeze
 end

data/spec/flipper/adapters/active_support_cache_store_spec.rb

@@ -9,8 +9,9 @@ RSpec.describe Flipper::Adapters::ActiveSupportCacheStore do
   let(:memory_adapter) do
     Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
   end
-  let(:cache) { ActiveSupport::Cache::DalliStore.new(ENV['MEMCACHED_URL']) }
-  let(:adapter) { described_class.new(memory_adapter, cache, expires_in: 10.seconds) }
+  let(:cache) { ActiveSupport::Cache::MemoryStore.new }
+  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.20.2
+  version: 0.21.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-08 00:00:00.000000000 Z
+date: 2021-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.2
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.2
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement