flipper-cache-store 0.11.0.beta7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e05826a8bee645823d83c2fc1497001a21061cb3
+  data.tar.gz: 4b57d8c399fe0025e17ba36dc668f76fa78b77a1
+SHA512:
+  metadata.gz: 6b90ec6e64f7aeb62fef75403f52ba9c823ee3d67b9a46cdfd74a2430b2f2effba63dc343392c91348b7338dbbcb3cbd5db8bda479a2f2181224c8f0731e8c4c
+  data.tar.gz: b7b502a2905d855a4a79d060e12b96e60ebc282494ede5aa5281953f13e3b6c9181cbe52bb43964fe3e58bcad283ed42376dd749e451e94f945531c1b70f9cd9

data/docs/cache_store/README.md

@@ -0,0 +1,99 @@
+# Flipper CacheStore
+
+A [CacheStore](http://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html) adapter for [Flipper](https://github.com/jnunemaker/flipper).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flipper-cache-store'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install flipper-cache-store
+
+## Usage
+
+```ruby
+require 'active_support/cache'
+require 'flipper/adapters/memory'
+require 'flipper/adapters/cache_store'
+
+memory_adapter = Flipper::Adapters::Memory.new
+cache = ActiveSupport::Cache::MemoryStore.new
+adapter = Flipper::Adapters::CacheStore.new(memory_adapter, cache, expires_in: 5.minutes)
+flipper = Flipper.new(adapter)
+```
+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
+
+Each feature is stored in the underlying cache store.
+
+This is an example using `ActiveSupport::Cache::MemoryStore` with the [Flipper memory adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/memory.rb).
+
+Each key is namespaced under `flipper/v1/feature/`
+
+```ruby
+require 'active_support/cache'
+require 'flipper/adapters/memory'
+require 'flipper/adapters/cache_store'
+
+memory_adapter = Flipper::Adapters::Memory.new
+cache = ActiveSupport::Cache::MemoryStore.new
+adapter = Flipper::Adapters::CacheStore.new(memory_adapter, cache)
+flipper = Flipper.new(adapter)
+
+# Register a few groups.
+Flipper.register(:admins) { |thing| thing.admin? }
+Flipper.register(:early_access) { |thing| thing.early_access? }
+
+# Create a user class that has flipper_id instance method.
+User = Struct.new(:flipper_id)
+
+flipper[:stats].enable
+flipper[:stats].enable_group :admins
+flipper[:stats].enable_group :early_access
+flipper[:stats].enable_actor User.new('25')
+flipper[:stats].enable_actor User.new('90')
+flipper[:stats].enable_actor User.new('180')
+flipper[:stats].enable_percentage_of_time 15
+flipper[:stats].enable_percentage_of_actors 45
+flipper[:search].enable
+
+# reading all feature keys
+pp cache.read("flipper/v1/features")
+#<Set: {"stats", "search"}>
+
+# reading a single feature
+pp cache.read("flipper/v1/feature/stats")
+{
+  :boolean=>"true",
+  :groups=>#<Set: {"admins", "early_access"}>,
+  :actors=>#<Set: {"25", "90", "180"}>,
+  :percentage_of_actors=>"45",
+  :percentage_of_time=>"15"
+}
+
+# flipper get of feature
+pp adapter.get(flipper[:stats])
+{
+  :boolean=>"true",
+  :groups=>#<Set: {"admins", "early_access"}>,
+  :actors=>#<Set: {"25", "90", "180"}>,
+  :percentage_of_actors=>"45",
+  :percentage_of_time=>"15"
+}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

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/version.rb

@@ -0,0 +1,3 @@
+module Flipper
+  VERSION = '0.11.0.beta7'.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

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: flipper-cache-store
+version: !ruby/object:Gem::Version
+  version: 0.11.0.beta7
+platform: ruby
+authors:
+- John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flipper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0.beta7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0.beta7
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+description: ActiveSupport::Cache::Store adapter for Flipper
+email:
+- nunemaker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- docs/cache_store/README.md
+- lib/flipper/adapters/cache_store.rb
+- lib/flipper/version.rb
+- spec/flipper/adapters/cache_store_spec.rb
+homepage: https://github.com/jnunemaker/flipper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: ActiveSupport::Cache::Store adapter for Flipper
+test_files:
+- spec/flipper/adapters/cache_store_spec.rb