flipper 0.11.0.beta5 → 0.11.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d6d3fb5a81f8e36791a48a6475dfdbfc56ba65e
-  data.tar.gz: 82e678db59d539f2230fdc585511e6116495f682
+  metadata.gz: fc657f1ced7ca41760051223843e487c3c820277
+  data.tar.gz: '0520502010855501979601516821cac277ce3891'
 SHA512:
-  metadata.gz: d986d350d0f87bfb6e36db9ffd347fb69e79bbae6656df0266b2b58186b8d794032fc3e08f9f3572de33dc32c09e33d1b3429ca5c787531c1259cd6f90f0b8b5
-  data.tar.gz: 9defcfe3b411db0252793d35a96cffb1979a8d42b12f533a3ed15f37e7e0fa2afe25262eb3353ea4a58be0d82d6d927e242a6b1325fe184fda3ad7865fdc35af
+  metadata.gz: b9afe59c11ad41ec976ed8cb804929985afdb9e737146d9639510c75298ee88f1fb1573d92580f3504840a453e3cf84ed1a4b9d9c61ad5975fc1471d8096d34f
+  data.tar.gz: a1c682c40e47feb582e74069aad67f261b9a2cb14b3cd0978a175a305e6fd31a062804514608c60dffe743a635d4037b7aba55a6410b12a68eaef8a9343506a1

data/Changelog.md

@@ -4,7 +4,7 @@
 
 * * Set flipper from env for API and UI (https://github.com/jnunemaker/flipper/pull/223 and https://github.com/jnunemaker/flipper/pull/229). It is documented, but now the memoizing middleware requires that the SetupEnv middleware is used first.
 * Drop support for Ruby 2.0 as it is end of lined (https://github.com/jnunemaker/flipper/commit/c2c81ed89938155ce91acb5173ac38580f630e3d).
-* Allow unregistered groups (https://github.com/jnunemaker/flipper/pull/244). Only break in compatiblity is that previously unregistered groups could not be enabled and now they can be.
+* Allow unregistered groups (https://github.com/jnunemaker/flipper/pull/244). Only break in compatibility is that previously unregistered groups could not be enabled and now they can be.
 
 ### Additions/Changes
 
@@ -18,6 +18,11 @@
 * Made it possible to instrument Flipper::Cloud (https://github.com/jnunemaker/flipper/commit/4b10e4d807772202f63881f5e2c00d11ac58481f).
 * Made it possible to wrap Http adapter when using Flipper::Cloud (https://github.com/jnunemaker/flipper/commit/4b10e4d807772202f63881f5e2c00d11ac58481f).
 * Instrument get_multi in instrumented adapter (https://github.com/jnunemaker/flipper/commit/951d25c5ce07d3b56b0b2337adf5f6bcbe4050e7).
+* Allow instrumenting Flipper::Cloud http adapter (https://github.com/jnunemaker/flipper/pull/253).
+* Add DSL#preload_all and Adapter#get_all to allow for making even more efficient loading of features (https://github.com/jnunemaker/flipper/pull/255).
+* Allow setting debug output of http adapter (https://github.com/jnunemaker/flipper/pull/256 and https://github.com/jnunemaker/flipper/pull/258).
+* Allow setting env key for middleware (https://github.com/jnunemaker/flipper/pull/259).
+* Added ActiveSupport cache store adapter for use with Rails.cache (https://github.com/jnunemaker/flipper/pull/265).
 
 ## 0.10.2
 

data/docs/Adapters.md

@@ -4,15 +4,15 @@ I plan on supporting the adapters in the flipper repo. Other adapters are welcom
 
 ## Officially Supported
 
+* [ActiveRecord adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_record) - Rails 3, 4, and 5.
+* [Cassanity adapter](https://github.com/jnunemaker/flipper-cassanity)
+* [Http adapter](https://github.com/jnunemaker/flipper/blob/master/docs/http)
 * [memory adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/memory.rb) – great for tests
-* [PStore adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/pstore.rb) – great for when a local file is enough
 * [Mongo adapter](https://github.com/jnunemaker/flipper/blob/master/docs/mongo)
+* [PStore adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/pstore.rb) – great for when a local file is enough
+* [read-only adapter](https://github.com/jnunemaker/flipper/blob/master/docs/read-only)
 * [Redis adapter](https://github.com/jnunemaker/flipper/blob/master/docs/redis)
-* [ActiveRecord adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_record) - Rails 3, 4, and 5.
 * [Sequel adapter](https://github.com/jnunemaker/flipper/blob/master/docs/sequel)
-* [Cassanity adapter](https://github.com/jnunemaker/flipper-cassanity)
-* [read-only adapter](https://github.com/jnunemaker/flipper/blob/master/docs/read-only)
-* [Http adapter](https://github.com/jnunemaker/flipper/blob/master/docs/http)
 
 ## Community Supported
 

data/lib/flipper/adapters/cache_store.rb

@@ -0,0 +1,104 @@
+module Flipper
+  module Adapters
+    # Public: Adapter that wraps another adapter with the ability to cache
+    # adapter calls in ActiveSupport::CacheStore caches.
+    #
+    class CacheStore
+      include ::Flipper::Adapter
+
+      Version = 'v1'.freeze
+      Namespace = "flipper/#{Version}".freeze
+      FeaturesKey = "#{Namespace}/features".freeze
+
+      # Private
+      def self.key_for(key)
+        "#{Namespace}/feature/#{key}"
+      end
+
+      # Internal
+      attr_reader :cache
+
+      # Public: The name of the adapter.
+      attr_reader :name
+
+      # Public
+      def initialize(adapter, cache, expires_in: nil)
+        @adapter = adapter
+        @name = :cache_store
+        @cache = cache
+        @write_options = {}
+        @write_options.merge!(expires_in: expires_in) if expires_in
+      end
+
+      # Public
+      def features
+        @cache.fetch(FeaturesKey, @write_options) do
+          @adapter.features
+        end
+      end
+
+      # Public
+      def add(feature)
+        result = @adapter.add(feature)
+        @cache.delete(FeaturesKey)
+        result
+      end
+
+      ## Public
+      def remove(feature)
+        result = @adapter.remove(feature)
+        @cache.delete(FeaturesKey)
+        @cache.delete(key_for(feature.key))
+        result
+      end
+
+      ## Public
+      def clear(feature)
+        result = @adapter.clear(feature)
+        @cache.delete(key_for(feature.key))
+        result
+      end
+
+      ## Public
+      def get(feature)
+        @cache.fetch(key_for(feature.key), @write_options) do
+          @adapter.get(feature)
+        end
+      end
+
+      def get_multi(features)
+        keys = features.map { |feature| key_for(feature.key) }
+        result = @cache.read_multi(keys)
+        uncached_features = features.reject { |feature| result[feature.key] }
+        if uncached_features.any?
+          response = @adapter.get_multi(uncached_features)
+          response.each do |key, value|
+            @cache.write(key_for(key), value, @write_options)
+            result[key] = value
+          end
+        end
+        result
+      end
+
+      ## Public
+      def enable(feature, gate, thing)
+        result = @adapter.enable(feature, gate, thing)
+        @cache.delete(key_for(feature.key))
+        result
+      end
+
+      ## Public
+      def disable(feature, gate, thing)
+        result = @adapter.disable(feature, gate, thing)
+        @cache.delete(key_for(feature.key))
+        result
+      end
+
+      private
+
+      def key_for(key)
+        self.class.key_for(key)
+      end
+    end
+  end
+end

data/lib/flipper/middleware/setup_env.rb

@@ -1,7 +1,7 @@
 module Flipper
   module Middleware
     class SetupEnv
-      # Public: Initializes an instance of the SetEnv middleware. Allows for
+      # Public: Initializes an instance of the SetupEnv middleware. Allows for
       # lazy initialization of the flipper instance being set in the env by
       # providing a block.
       #
@@ -14,10 +14,10 @@ module Flipper
       #   flipper = Flipper.new(...)
       #
       #   # using with a normal flipper instance
-      #   use Flipper::Middleware::SetEnv, flipper
+      #   use Flipper::Middleware::SetupEnv, flipper
       #
       #   # using with a block that yields a flipper instance
-      #   use Flipper::Middleware::SetEnv, lambda { Flipper.new(...) }
+      #   use Flipper::Middleware::SetupEnv, lambda { Flipper.new(...) }
       #
       def initialize(app, flipper_or_block, options = {})
         @app = app

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.11.0.beta5'.freeze
+  VERSION = '0.11.0.beta6'.freeze
 end

data/spec/flipper/adapters/cache_store_spec.rb

@@ -0,0 +1,50 @@
+require 'helper'
+require 'active_support/cache'
+require 'flipper/adapters/memory'
+require 'flipper/adapters/cache_store'
+require 'flipper/spec/shared_adapter_specs'
+
+RSpec.describe Flipper::Adapters::CacheStore do
+  let(:memory_adapter) { Flipper::Adapters::Memory.new }
+  let(:cache) { ActiveSupport::Cache::MemoryStore.new }
+  let(:adapter) { described_class.new(memory_adapter, cache) }
+  let(:flipper) { Flipper.new(adapter) }
+
+  subject { adapter }
+
+  it_should_behave_like 'a flipper adapter'
+
+  describe '#remove' do
+    it 'expires feature' do
+      feature = flipper[:stats]
+      adapter.get(feature)
+      adapter.remove(feature)
+      expect(cache.read(described_class.key_for(feature))).to be(nil)
+    end
+  end
+
+  describe '#get_multi' do
+    it 'warms uncached features' do
+      stats = flipper[:stats]
+      search = flipper[:search]
+      other = flipper[:other]
+      stats.enable
+      search.enable
+
+      adapter.get(stats)
+      expect(cache.read(described_class.key_for(search))).to be(nil)
+      expect(cache.read(described_class.key_for(other))).to be(nil)
+
+      adapter.get_multi([stats, search, other])
+
+      expect(cache.read(described_class.key_for(search))[:boolean]).to eq('true')
+      expect(cache.read(described_class.key_for(other))[:boolean]).to be(nil)
+    end
+  end
+
+  describe '#name' do
+    it 'is cache_store' do
+      expect(subject.name).to be(:cache_store)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.11.0.beta5
+  version: 0.11.0.beta6
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-06-11 00:00:00.000000000 Z
 dependencies: []
 description: Feature flipper is the act of enabling/disabling features in your application,
   ideally without re-deploying or changing anything in your code base. Flipper makes
@@ -55,6 +55,7 @@ files:
 - lib/flipper.rb
 - lib/flipper/actor.rb
 - lib/flipper/adapter.rb
+- lib/flipper/adapters/cache_store.rb
 - lib/flipper/adapters/http.rb
 - lib/flipper/adapters/http/client.rb
 - lib/flipper/adapters/http/error.rb
@@ -100,6 +101,7 @@ files:
 - spec/fixtures/feature.json
 - spec/flipper/actor_spec.rb
 - spec/flipper/adapter_spec.rb
+- spec/flipper/adapters/cache_store_spec.rb
 - spec/flipper/adapters/http_spec.rb
 - spec/flipper/adapters/instrumented_spec.rb
 - spec/flipper/adapters/memoizable_spec.rb
@@ -169,6 +171,7 @@ test_files:
 - spec/fixtures/feature.json
 - spec/flipper/actor_spec.rb
 - spec/flipper/adapter_spec.rb
+- spec/flipper/adapters/cache_store_spec.rb
 - spec/flipper/adapters/http_spec.rb
 - spec/flipper/adapters/instrumented_spec.rb
 - spec/flipper/adapters/memoizable_spec.rb