flipper-redis 0.20.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38ed937a4141ea4dd894c5b12894a117d5117309106993ae73f541bbabf4ca52
-  data.tar.gz: 79c9e9e33ff30120149967724ab170417cba12431cbae1dc46d243e4f2a4043c
+  metadata.gz: d75794c8cf100a5df75ec07ec97123cda83eb195ee7eab7d91b58b1aab04354e
+  data.tar.gz: 78ae668ed8767209136cfe09d05e8c6a67fc3e7bc9466f4a5637403a99c43706
 SHA512:
-  metadata.gz: 12e3459fc127df7292e9288dd4a63cf7a8c6332dcefc2f0bdfd80e145b1966dd1cdbb95913616f998a602b26e7e8b1c71f59052fdccccdca68ab66ce00a683c5
-  data.tar.gz: c7215cefbff7c825dca2a15d2e10b49c021aad72ff4b4d51ac8131b32173b42aad70f4f2a10da724431121bf19ce71dd10b6e912e6525c0c09a27aca7dc99901
+  metadata.gz: 513f65a411e1be74144e3870e3149724a78c5ce25692122f85657f50b149b95715473e01b5f423d74edec58d141fe45235246dbf206354b7747d9ad3bfecfd62
+  data.tar.gz: f1a5a543226d2d0fd55c2c817207541ded0bb09f49e152ca5bb40fbf0069c6e2d9a9d0c9cee0a1b4903177cdbc50f9fb2841e8b778dcc8e98d877792760d447a

data/examples/redis/basic.rb

@@ -1,30 +1,19 @@
-require 'pathname'
+require 'bundler/setup'
 require 'logger'
 
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
-$:.unshift(lib_path)
-
 require 'flipper/adapters/redis'
-options = {}
-if ENV['REDIS_URL']
-  options[:url] = ENV['REDIS_URL']
-end
-client = Redis.new(options)
-adapter = Flipper::Adapters::Redis.new(client)
-flipper = Flipper.new(adapter)
 
-flipper[:stats].enable
+Flipper[:stats].enable
 
-if flipper[:stats].enabled?
+if Flipper[:stats].enabled?
   puts "Enabled!"
 else
   puts "Disabled!"
 end
 
-flipper[:stats].disable
+Flipper[:stats].disable
 
-if flipper[:stats].enabled?
+if Flipper[:stats].enabled?
   puts "Enabled!"
 else
   puts "Disabled!"

data/examples/redis/internals.rb

@@ -1,38 +1,27 @@
+require 'bundler/setup'
 require 'pp'
-require 'pathname'
 require 'logger'
-
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
-$:.unshift(lib_path)
-
 require 'flipper/adapters/redis'
 
-options = {}
-if ENV['REDIS_URL']
-  options[:url] = ENV['REDIS_URL']
-end
-client = Redis.new(options)
-adapter = Flipper::Adapters::Redis.new(client)
-flipper = Flipper.new(adapter)
+client = Redis.new
 
 # Register a few groups.
-Flipper.register(:admins) { |thing| thing.admin? }
-Flipper.register(:early_access) { |thing| thing.early_access? }
+Flipper.register(:admins) { |actor| actor.admin? }
+Flipper.register(:early_access) { |actor| actor.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[: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
+Flipper[:search].enable
 
 print 'all keys: '
 pp client.keys
@@ -64,7 +53,7 @@ pp client.hgetall('search')
 puts
 
 puts 'flipper get of feature'
-pp adapter.get(flipper[:stats])
+pp Flipper.adapter.get(Flipper[:stats])
 # flipper get of feature
 # {:boolean=>"true",
 #  :groups=>#<Set: {"admins", "early_access"}>,

data/examples/redis/namespaced.rb

@@ -1,18 +1,7 @@
-require 'pp'
-require 'pathname'
-require 'logger'
-begin
-  require 'redis-namespace'
-rescue LoadError
-  puts 'you must have redis-namespace gem installed'
-  exit 1
-end
-
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
-$:.unshift(lib_path)
-
+require 'bundler/setup'
+require 'redis-namespace'
 require 'flipper/adapters/redis'
+
 options = {url: 'redis://127.0.0.1:6379'}
 if ENV['REDIS_URL']
   options[:url] = ENV['REDIS_URL']
@@ -23,8 +12,8 @@ adapter = Flipper::Adapters::Redis.new(namespaced_client)
 flipper = Flipper.new(adapter)
 
 # Register a few groups.
-Flipper.register(:admins) { |thing| thing.admin? }
-Flipper.register(:early_access) { |thing| thing.early_access? }
+Flipper.register(:admins) { |actor| actor.admin? }
+Flipper.register(:early_access) { |actor| actor.early_access? }
 
 # Create a user class that has flipper_id instance method.
 User = Struct.new(:flipper_id)

data/flipper-redis.gemspec

@@ -8,10 +8,10 @@ end
 
 Gem::Specification.new do |gem|
   gem.authors       = ['John Nunemaker']
-  gem.email         = ['nunemaker@gmail.com']
+  gem.email         = 'support@flippercloud.io'
   gem.summary       = 'Redis adapter for Flipper'
   gem.license       = 'MIT'
-  gem.homepage      = 'https://github.com/jnunemaker/flipper'
+  gem.homepage      = 'https://www.flippercloud.io/docs/adapters/redis'
 
   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)
@@ -21,5 +21,5 @@ Gem::Specification.new do |gem|
   gem.metadata      = Flipper::METADATA
 
   gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
-  gem.add_dependency 'redis', '>= 2.2', '< 5'
+  gem.add_dependency 'redis', '>= 3.0', '< 6'
 end

data/lib/flipper/adapters/redis.rb

@@ -7,18 +7,28 @@ module Flipper
     class Redis
       include ::Flipper::Adapter
 
-      # Private: The key that stores the set of known features.
-      FeaturesKey = :flipper_features
-
       # Public: The name of the adapter.
       attr_reader :name
 
+      attr_reader :key_prefix
+
+      def features_key
+        "#{key_prefix}flipper_features"
+      end
+
+      def key_for(feature_name)
+        "#{key_prefix}#{feature_name}"
+      end
+
       # Public: Initializes a Redis flipper adapter.
       #
-      # client - The Redis client to use. Feel free to namespace it.
-      def initialize(client)
+      # client - The Redis client to use.
+      # key_prefix - an optional prefix with which to namespace
+      #              flipper's Redis keys
+      def initialize(client, key_prefix: nil)
         @client = client
         @name = :redis
+        @key_prefix = key_prefix
       end
 
       # Public: The set of known features.
@@ -28,20 +38,28 @@ module Flipper
 
       # Public: Adds a feature to the set of known features.
       def add(feature)
-        @client.sadd FeaturesKey, feature.key
+        if redis_sadd_returns_boolean?
+          @client.sadd? features_key, feature.key
+        else
+          @client.sadd features_key, feature.key
+        end
         true
       end
 
       # Public: Removes a feature from the set of known features.
       def remove(feature)
-        @client.srem FeaturesKey, feature.key
-        @client.del feature.key
+        if redis_sadd_returns_boolean?
+          @client.srem? features_key, feature.key
+        else
+          @client.srem features_key, feature.key
+        end
+        @client.del key_for(feature.key)
         true
       end
 
       # Public: Clears the gate values for a feature.
       def clear(feature)
-        @client.del feature.key
+        @client.del key_for(feature.key)
         true
       end
 
@@ -70,14 +88,15 @@ module Flipper
       #
       # Returns true.
       def enable(feature, gate, thing)
+        feature_key = key_for(feature.key)
         case gate.data_type
         when :boolean
           clear(feature)
-          @client.hset feature.key, gate.key, thing.value.to_s
+          @client.hset feature_key, gate.key, thing.value.to_s
         when :integer
-          @client.hset feature.key, gate.key, thing.value.to_s
+          @client.hset feature_key, gate.key, thing.value.to_s
         when :set
-          @client.hset feature.key, to_field(gate, thing), 1
+          @client.hset feature_key, to_field(gate, thing), 1
         else
           unsupported_data_type gate.data_type
         end
@@ -93,13 +112,14 @@ module Flipper
       #
       # Returns true.
       def disable(feature, gate, thing)
+        feature_key = key_for(feature.key)
         case gate.data_type
         when :boolean
-          @client.del feature.key
+          @client.del feature_key
         when :integer
-          @client.hset feature.key, gate.key, thing.value.to_s
+          @client.hset feature_key, gate.key, thing.value.to_s
         when :set
-          @client.hdel feature.key, to_field(gate, thing)
+          @client.hdel feature_key, to_field(gate, thing)
         else
           unsupported_data_type gate.data_type
         end
@@ -109,6 +129,10 @@ module Flipper
 
       private
 
+      def redis_sadd_returns_boolean?
+        @client.class.respond_to?(:sadd_returns_boolean) && @client.class.sadd_returns_boolean
+      end
+
       def read_many_features(features)
         docs = docs_for(features)
         result = {}
@@ -119,20 +143,20 @@ module Flipper
       end
 
       def read_feature_keys
-        @client.smembers(FeaturesKey).to_set
+        @client.smembers(features_key).to_set
       end
 
       # Private: Gets a hash of fields => values for the given feature.
       #
       # Returns a Hash of fields => values.
-      def doc_for(feature)
-        @client.hgetall(feature.key)
+      def doc_for(feature, pipeline: @client)
+        pipeline.hgetall(key_for(feature.key))
       end
 
       def docs_for(features)
-        @client.pipelined do
+        @client.pipelined do |pipeline|
           features.each do |feature|
-            doc_for(feature)
+            doc_for(feature, pipeline: pipeline)
           end
         end
       end
@@ -178,3 +202,10 @@ module Flipper
     end
   end
 end
+
+Flipper.configure do |config|
+  config.adapter do
+    client = Redis.new(url: ENV["FLIPPER_REDIS_URL"] || ENV["REDIS_URL"])
+    Flipper::Adapters::Redis.new(client)
+  end
+end

data/lib/flipper/adapters/redis_cache.rb

@@ -148,7 +148,7 @@ module Flipper
         return [] if keys.empty?
 
         cache_keys = keys.map { |key| key_for(key) }
-        @cache.mget(cache_keys).map do |value|
+        @cache.mget(*cache_keys).map do |value|
           value ? Marshal.load(value) : nil
         end
       end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.20.4'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/spec/flipper/adapters/redis_cache_spec.rb

@@ -1,7 +1,5 @@
-require 'helper'
 require 'flipper/adapters/operation_logger'
 require 'flipper/adapters/redis_cache'
-require 'flipper/spec/shared_adapter_specs'
 
 RSpec.describe Flipper::Adapters::RedisCache do
   let(:client) do
@@ -19,7 +17,9 @@ RSpec.describe Flipper::Adapters::RedisCache do
   subject { adapter }
 
   before do
-    client.flushdb
+    skip_on_error(Redis::CannotConnectError, 'Redis not available') do
+      client.flushdb
+    end
   end
 
   it_should_behave_like 'a flipper adapter'

data/spec/flipper/adapters/redis_spec.rb

@@ -1,6 +1,4 @@
-require 'helper'
 require 'flipper/adapters/redis'
-require 'flipper/spec/shared_adapter_specs'
 
 RSpec.describe Flipper::Adapters::Redis do
   let(:client) do
@@ -8,14 +6,50 @@ RSpec.describe Flipper::Adapters::Redis do
 
     options[:url] = ENV['REDIS_URL'] if ENV['REDIS_URL']
 
+    Redis.raise_deprecations = true
     Redis.new(options)
   end
 
   subject { described_class.new(client) }
 
   before do
-    client.flushdb
+    skip_on_error(Redis::CannotConnectError, 'Redis not available') do
+      client.flushdb
+    end
   end
 
   it_should_behave_like 'a flipper adapter'
+
+  it 'configures itself on load' do
+    Flipper.configuration = nil
+    Flipper.instance = nil
+
+    silence { load 'flipper/adapters/redis.rb' }
+
+    expect(Flipper.adapter.adapter).to be_a(Flipper::Adapters::Redis)
+  end
+
+  describe 'with a key_prefix' do
+    let(:subject) { described_class.new(client, key_prefix: "lockbox:") }
+    let(:feature) { Flipper::Feature.new(:search, subject) }
+
+    it_should_behave_like 'a flipper adapter'
+
+    it 'namespaces feature-keys' do
+      subject.add(feature)
+
+      expect(client.smembers("flipper_features")).to eq([])
+      expect(client.exists?("search")).to eq(false)
+      expect(client.smembers("lockbox:flipper_features")).to eq(["search"])
+      expect(client.hgetall("lockbox:search")).not_to eq(nil)
+    end
+
+    it "can remove namespaced keys" do
+      subject.add(feature)
+      expect(client.smembers("lockbox:flipper_features")).to eq(["search"])
+
+      subject.remove(feature)
+      expect(client.smembers("lockbox:flipper_features")).to be_empty
+    end
+  end
 end

data/test/adapters/redis_cache_test.rb

@@ -9,6 +9,8 @@ class RedisCacheTest < MiniTest::Test
     @cache = Redis.new(url: url).tap(&:flushdb)
     memory_adapter = Flipper::Adapters::Memory.new
     @adapter = Flipper::Adapters::RedisCache.new(memory_adapter, @cache)
+  rescue Redis::CannotConnectError
+    ENV['CI'] ? raise : skip('Reids not available')
   end
 
   def teardown

data/test/adapters/redis_test.rb

@@ -8,5 +8,7 @@ class RedisTest < MiniTest::Test
     url = ENV.fetch('REDIS_URL', 'redis://localhost:6379')
     client = Redis.new(url: url).tap(&:flushdb)
     @adapter = Flipper::Adapters::Redis.new(client)
+  rescue Redis::CannotConnectError
+    ENV['CI'] ? raise : skip('Redis not available')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-redis
 version: !ruby/object:Gem::Version
-  version: 0.20.4
+  version: 1.0.0
 platform: ruby
 authors:
 - John Nunemaker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-06 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,42 +16,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.4
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.4
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
-description: 
-email:
-- nunemaker@gmail.com
+        version: '6'
+description:
+email: support@flippercloud.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- docs/redis/README.md
 - examples/redis/basic.rb
 - examples/redis/internals.rb
 - examples/redis/namespaced.rb
@@ -64,12 +62,16 @@ files:
 - spec/flipper/adapters/redis_spec.rb
 - test/adapters/redis_cache_test.rb
 - test/adapters/redis_test.rb
-homepage: https://github.com/jnunemaker/flipper
+homepage: https://www.flippercloud.io/docs/adapters/redis
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://github.com/jnunemaker/flipper/blob/master/Changelog.md
-post_install_message: 
+  documentation_uri: https://www.flippercloud.io/docs
+  homepage_uri: https://www.flippercloud.io
+  source_code_uri: https://github.com/flippercloud/flipper
+  bug_tracker_uri: https://github.com/flippercloud/flipper/issues
+  changelog_uri: https://github.com/flippercloud/flipper/blob/main/Changelog.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -84,8 +86,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Redis adapter for Flipper
 test_files:

data/docs/redis/README.md

@@ -1,103 +0,0 @@
-# Flipper Redis
-
-A [Redis](https://github.com/redis/redis-rb) adapter for [Flipper](https://github.com/jnunemaker/flipper).
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'flipper-redis'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself with:
-
-    $ gem install flipper-redis
-
-## Usage
-
-```ruby
-require 'flipper/adapters/redis'
-client = Redis.new
-adapter = Flipper::Adapters::Redis.new(client)
-flipper = Flipper.new(adapter)
-# profit...
-```
-
-## Internals
-
-Each feature is stored in a redis hash, which means getting a feature is single query.
-
-```ruby
-require 'flipper/adapters/redis'
-
-client = Redis.new
-adapter = Flipper::Adapters::Redis.new(client)
-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
-
-print 'all keys: '
-pp client.keys
-# all keys: ["stats", "flipper_features", "search"]
-puts
-
-print "known flipper features: "
-pp client.smembers("flipper_features")
-# known flipper features: ["stats", "search"]
-puts
-
-puts 'stats keys'
-pp client.hgetall('stats')
-# stats keys
-# {"boolean"=>"true",
-#  "groups/admins"=>"1",
-#  "actors/25"=>"1",
-#  "percentage_of_time"=>"15",
-#  "percentage_of_actors"=>"45",
-#  "groups/early_access"=>"1",
-#  "actors/90"=>"1",
-#  "actors/180"=>"1"}
-puts
-
-puts 'search keys'
-pp client.hgetall('search')
-# search keys
-# {"boolean"=>"true"}
-puts
-
-puts 'flipper get of feature'
-pp adapter.get(flipper[:stats])
-# flipper get of feature
-# {: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