flipper-redis 0.10.2 → 0.11.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a13a83c0fcc0c673d0ec7f0eb384006701dda61
-  data.tar.gz: bd58070c270efaa9b84621e654e1f61e3dc2b027
+  metadata.gz: fdeb25654096e05e254effadaec3e4172f5017a4
+  data.tar.gz: 3ce4cde5901b75e961137eddc00023e0d7ee6f5b
 SHA512:
-  metadata.gz: 5fbbb7cb31fd3007f6afbfeb0db8915a9b067c2b977675bea6d127bb6bc32e070e837a1572e56e8099b1b998958de4526acb72d97407267470331805df5aa938
-  data.tar.gz: 4bb7a22274f4c5666f02e9f887d5ecaaa9de717f1c823f317f5160be548e9138d2b0d427b6a342c1626c7124643199813a61946ec904f3d424a0c01fd0f7e4a5
+  metadata.gz: b5c985b97209b5b20cbe053da4c0c2fecdf40ab1f9287fdefc9094b198d3457e8f0464527a2b79098ada13f6eb5e07ec461eac2698c3a76529710f5bc81709ce
+  data.tar.gz: ec607bd967b5d16568b4507bca7b80d2d11937b8feaf4776a38258764202207d878c4e49d5901fbe61b688f4e6e40939ea651db2c49484068cd204b2afc1ff10

data/flipper-redis.gemspec

@@ -1,22 +1,22 @@
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/flipper/version', __FILE__)
 
-flipper_redis_files = lambda { |file|
+flipper_redis_files = lambda do |file|
   file =~ /redis/
-}
+end
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["John Nunemaker"]
-  gem.email         = ["nunemaker@gmail.com"]
-  gem.summary       = "Redis adapter for Flipper"
-  gem.description   = "Redis adapter for Flipper"
-  gem.license       = "MIT"
-  gem.homepage      = "https://github.com/jnunemaker/flipper"
+  gem.authors       = ['John Nunemaker']
+  gem.email         = ['nunemaker@gmail.com']
+  gem.summary       = 'Redis adapter for Flipper'
+  gem.description   = 'Redis adapter for Flipper'
+  gem.license       = 'MIT'
+  gem.homepage      = 'https://github.com/jnunemaker/flipper'
 
-  gem.files         = `git ls-files`.split("\n").select(&flipper_redis_files) + ["lib/flipper/version.rb"]
+  gem.files         = `git ls-files`.split("\n").select(&flipper_redis_files) + ['lib/flipper/version.rb']
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_redis_files)
-  gem.name          = "flipper-redis"
-  gem.require_paths = ["lib"]
+  gem.name          = 'flipper-redis'
+  gem.require_paths = ['lib']
   gem.version       = Flipper::VERSION
 
   gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"

data/lib/flipper/adapters/redis.rb

@@ -68,7 +68,7 @@ module Flipper
       #
       # feature - The Flipper::Feature for the gate.
       # gate - The Flipper::Gate to disable.
-      # thing - The Flipper::Type being disabled for the gate.
+      # thing - The Flipper::Type being enabled for the gate.
       #
       # Returns true.
       def enable(feature, gate, thing)
@@ -126,14 +126,15 @@ module Flipper
         fields = doc.keys
 
         feature.gates.each do |gate|
-          result[gate.key] = case gate.data_type
-          when :boolean, :integer
-            doc[gate.key.to_s]
-          when :set
-            fields_to_gate_value fields, gate
-          else
-            unsupported_data_type gate.data_type
-          end
+          result[gate.key] =
+            case gate.data_type
+            when :boolean, :integer
+              doc[gate.key.to_s]
+            when :set
+              fields_to_gate_value fields, gate
+            else
+              unsupported_data_type gate.data_type
+            end
         end
 
         result
@@ -148,7 +149,7 @@ module Flipper
       #
       # Returns a Set of the values enabled for the gate.
       def fields_to_gate_value(fields, gate)
-        regex = /^#{Regexp.escape(gate.key.to_s)}\//
+        regex = %r{^#{Regexp.escape(gate.key.to_s)}/}
         keys = fields.grep(regex)
         values = keys.map { |key| key.split('/', 2).last }
         values.to_set

data/lib/flipper/adapters/redis_cache.rb

@@ -0,0 +1,129 @@
+require 'redis'
+
+module Flipper
+  module Adapters
+    # Public: Adapter that wraps another adapter with the ability to cache
+    # adapter calls in Redis
+    class RedisCache
+      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, ttl = 3600)
+        @adapter = adapter
+        @name = :redis_cache
+        @cache = cache
+        @ttl = ttl
+      end
+
+      # Public
+      def features
+        fetch(FeaturesKey) do
+          @adapter.features
+        end
+      end
+
+      # Public
+      def add(feature)
+        result = @adapter.add(feature)
+        @cache.del(FeaturesKey)
+        result
+      end
+
+      # Public
+      def remove(feature)
+        result = @adapter.remove(feature)
+        @cache.del(FeaturesKey)
+        @cache.del(key_for(feature.key))
+        result
+      end
+
+      # Public
+      def clear(feature)
+        result = @adapter.clear(feature)
+        @cache.del(key_for(feature.key))
+        result
+      end
+
+      # Public
+      def get(feature)
+        fetch(key_for(feature.key)) do
+          @adapter.get(feature)
+        end
+      end
+
+      def get_multi(features)
+        keys = features.map(&:key)
+        result = Hash[keys.zip(multi_cache_get(keys))]
+        uncached_features = features.reject do |feature|
+          result[feature.key]
+        end
+
+        if uncached_features.any?
+          response = @adapter.get_multi(uncached_features)
+          response.each do |key, value|
+            set_with_ttl(key_for(key), value)
+            result[key] = value
+          end
+        end
+        result
+      end
+
+      # Public
+      def enable(feature, gate, thing)
+        result = @adapter.enable(feature, gate, thing)
+        @cache.del(key_for(feature.key))
+        result
+      end
+
+      # Public
+      def disable(feature, gate, thing)
+        result = @adapter.disable(feature, gate, thing)
+        @cache.del(key_for(feature.key))
+        result
+      end
+
+      private
+
+      def key_for(key)
+        self.class.key_for(key)
+      end
+
+      def fetch(key)
+        cached = @cache.get(key)
+        if cached
+          Marshal.load(cached)
+        else
+          to_cache = yield
+          set_with_ttl(key, to_cache)
+          to_cache
+        end
+      end
+
+      def set_with_ttl(key, value)
+        @cache.setex(key, @ttl, Marshal.dump(value))
+      end
+
+      def multi_cache_get(keys)
+        cache_keys = keys.map { |key| key_for(key) }
+        @cache.mget(cache_keys).map do |value|
+          value ? Marshal.load(value) : nil
+        end
+      end
+    end
+  end
+end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = "0.10.2".freeze
+  VERSION = '0.11.0.beta1'.freeze
 end

data/spec/flipper/adapters/redis_cache_spec.rb

@@ -0,0 +1,64 @@
+require 'helper'
+require 'flipper/adapters/memory'
+require 'flipper/adapters/redis_cache'
+require 'flipper/spec/shared_adapter_specs'
+
+RSpec.describe Flipper::Adapters::RedisCache do
+  let(:client) do
+    options = {}
+
+    options[:url] = ENV['BOXEN_REDIS_URL'] if ENV['BOXEN_REDIS_URL']
+
+    Redis.new(options)
+  end
+
+  let(:memory_adapter) { Flipper::Adapters::Memory.new }
+  let(:cache)   { Redis.new(url: ENV.fetch('BOXEN_REDIS_URL', 'redis://localhost:6379')) }
+  let(:adapter) { described_class.new(memory_adapter, cache) }
+  let(:flipper) { Flipper.new(adapter) }
+
+  subject { adapter }
+
+  before do
+    client.flushdb
+  end
+
+  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.get(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.get(described_class.key_for(search))).to be(nil)
+      expect(cache.get(described_class.key_for(other))).to be(nil)
+
+      adapter.get_multi([stats, search, other])
+
+      search_cache_value, other_cache_value = [search, other].map do |f|
+        Marshal.load(cache.get(described_class.key_for(f)))
+      end
+      expect(search_cache_value[:boolean]).to eq('true')
+      expect(other_cache_value[:boolean]).to be(nil)
+    end
+  end
+
+  describe '#name' do
+    it 'is redis_cache' do
+      expect(subject.name).to be(:redis_cache)
+    end
+  end
+end

data/spec/flipper/adapters/redis_spec.rb

@@ -3,15 +3,13 @@ require 'flipper/adapters/redis'
 require 'flipper/spec/shared_adapter_specs'
 
 RSpec.describe Flipper::Adapters::Redis do
-  let(:client) {
+  let(:client) do
     options = {}
 
-    if ENV['BOXEN_REDIS_URL']
-      options[:url] = ENV['BOXEN_REDIS_URL']
-    end
+    options[:url] = ENV['BOXEN_REDIS_URL'] if ENV['BOXEN_REDIS_URL']
 
     Redis.new(options)
-  }
+  end
 
   subject { described_class.new(client) }
 

data/test/adapters/redis_cache_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+require 'flipper/adapters/memory'
+require 'flipper/adapters/redis_cache'
+
+class DalliTest < MiniTest::Test
+  prepend Flipper::Test::SharedAdapterTests
+
+  def setup
+    url = ENV.fetch('BOXEN_REDIS_URL', 'redis://localhost:6379')
+    @cache = Redis.new(url: url).tap(&:flushdb)
+    memory_adapter = Flipper::Adapters::Memory.new
+    @adapter = Flipper::Adapters::RedisCache.new(memory_adapter, @cache)
+  end
+
+  def teardown
+    @cache.flushdb
+  end
+end

data/test/adapters/redis_test.rb

@@ -5,7 +5,8 @@ class RedisTest < MiniTest::Test
   prepend Flipper::Test::SharedAdapterTests
 
   def setup
-   client = Redis.new({}).tap { |c| c.flushdb }
-   @adapter = Flipper::Adapters::Redis.new(client)
+    url = ENV.fetch('BOXEN_REDIS_URL', 'redis://localhost:6379')
+    client = Redis.new(url: url).tap(&:flushdb)
+    @adapter = Flipper::Adapters::Redis.new(client)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-redis
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0.beta1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-08 00:00:00.000000000 Z
+date: 2017-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.2
+        version: 0.11.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.2
+        version: 0.11.0.beta1
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -58,8 +58,11 @@ files:
 - flipper-redis.gemspec
 - lib/flipper-redis.rb
 - lib/flipper/adapters/redis.rb
+- lib/flipper/adapters/redis_cache.rb
 - lib/flipper/version.rb
+- spec/flipper/adapters/redis_cache_spec.rb
 - spec/flipper/adapters/redis_spec.rb
+- test/adapters/redis_cache_test.rb
 - test/adapters/redis_test.rb
 homepage: https://github.com/jnunemaker/flipper
 licenses:
@@ -76,15 +79,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Redis adapter for Flipper
 test_files:
+- spec/flipper/adapters/redis_cache_spec.rb
 - spec/flipper/adapters/redis_spec.rb
+- test/adapters/redis_cache_test.rb
 - test/adapters/redis_test.rb