flipper-redis 0.27.1 → 0.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab4f6e70ec9c26096a9f6272a113866f0850fe7af26a96108e269892a45dc06e
-  data.tar.gz: 0bce2150cbe6bf327a1e3410bb8c2fed3928b4cf7d78ccb4926758d995492fa7
+  metadata.gz: f32d46dfcd16583c05e480c9ef51d79b938e5d56b2511a035917bd2964713846
+  data.tar.gz: 0557da15aa96cb415a03854ecb41e06c9ef3b873a4b1dfb86e3fe044c980c7d4
 SHA512:
-  metadata.gz: 7d128477420d8b838e63555cc3cb2cdfd44f2af4c2de2c60b49a4b2dd37f7168a09f22aebc2224338523f3d97db72f48774143ff4570bdc71d130a4c7c00919c
-  data.tar.gz: 31670614c717e823ce19d209d8125b72029bbbb83df9949106b6706d2eee2ff66dc06dc1a3000375d7773adb2d355bc7be13185f6bc5a3d0a1e4fd6c3ad0e23d
+  metadata.gz: b693aa4557dd1f61737e11c43c74982f2b629e3efddf9ddec55633f29c81715635b1ca8ca743e79facd5c30f3d104b774dcdd84e9381b9ed229a7509ddde2d32
+  data.tar.gz: be3676c53c6e42e5a25304605a3243e32a85d096681015217e4dbac822823f6642b122a551c9b3010abc79fdb664b1882f26b6e57295e16d333f7f670b64ec55

data/examples/redis/internals.rb

@@ -6,8 +6,8 @@ require 'flipper/adapters/redis'
 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)

data/examples/redis/namespaced.rb

@@ -12,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/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.
@@ -29,9 +39,9 @@ module Flipper
       # Public: Adds a feature to the set of known features.
       def add(feature)
         if redis_sadd_returns_boolean?
-          @client.sadd? FeaturesKey, feature.key
+          @client.sadd? features_key, feature.key
         else
-          @client.sadd FeaturesKey, feature.key
+          @client.sadd features_key, feature.key
         end
         true
       end
@@ -39,17 +49,17 @@ module Flipper
       # Public: Removes a feature from the set of known features.
       def remove(feature)
         if redis_sadd_returns_boolean?
-          @client.srem? FeaturesKey, feature.key
+          @client.srem? features_key, feature.key
         else
-          @client.srem FeaturesKey, feature.key
+          @client.srem features_key, feature.key
         end
-        @client.del feature.key
+        @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
 
@@ -78,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
@@ -101,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
@@ -131,14 +143,14 @@ 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, pipeline: @client)
-        pipeline.hgetall(feature.key)
+        pipeline.hgetall(key_for(feature.key))
       end
 
       def docs_for(features)

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.27.1'.freeze
+  VERSION = '0.28.1'.freeze
 end

data/spec/flipper/adapters/redis_spec.rb

@@ -28,4 +28,28 @@ RSpec.describe Flipper::Adapters::Redis do
 
     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-redis
 version: !ruby/object:Gem::Version
-  version: 0.27.1
+  version: 0.28.1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-20 00:00:00.000000000 Z
+date: 2023-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.27.1
+        version: 0.28.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.27.1
+        version: 0.28.1
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement