flipper-active_support_cache_store 0.19.1 → 0.22.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0842eb7df3ad9536fc3080730f1573b85671ad6c6e45de688eda74636984c7d0'
-  data.tar.gz: 6107fe93bae45f0b24f6ecff0b315f1e418e61bf5ad154de232ddd8cf7430e59
+  metadata.gz: 45265663875ae97425d866e2eafa4637fed57fb84111ac5085c4ed04bbcb4ea3
+  data.tar.gz: 6442b5fe507934f2b5d167e43d9327bb92cd27fff82c2a5e887ab214cdf1e66f
 SHA512:
-  metadata.gz: 737d093498bb9abccfd2f87a17c85db67626cd0152aed5b950052806079f7d354760d35562bb3547f3b7621eca193692ef4b856be59f393c047068c6eb2e9ef0
-  data.tar.gz: 827657887c95e6887925f159bf4b0cfa949b270df9c604baa2b5b78a910c39e6cb78404f5b8d896b09a7bee22ec33954227972c6b3954b758a51ada4e0410d4d
+  metadata.gz: bcd921ad517451ba95423b6394af8069f30712b847d7eac450f7e28a34feb0a4ab0501053a488c229784a933d9e7d924c7b356cbca3c0258a9a42ebc862609fb
+  data.tar.gz: 254688c8802f37d69c7ad46272c30c84d1fc17769447950cef63e979d09078e6976b79c9ddbbc6195f913ed2cca60ec8fe2961f390aa21a1fd7d2816c91ae0a7

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/flipper-active_support_cache_store.gemspec

@@ -21,5 +21,5 @@ Gem::Specification.new do |gem|
   gem.metadata      = Flipper::METADATA
 
   gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
-  gem.add_dependency 'activesupport', '>= 5.0', '< 7'
+  gem.add_dependency 'activesupport', '>= 4.2', '< 7'
 end

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.19.1'.freeze
+  VERSION = '0.22.2'.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.19.1
+  version: 0.22.2
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,21 +16,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.22.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.22.2
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -40,7 +40,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'