flipper-redis 0.28.0 → 0.28.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fde720fc29090ac49eaaf60631378eae9e000a7f3bcf8c3645c30eff0ccc527
-  data.tar.gz: c4256eeece41abb26f4c57f057ffcb05bd139bb488b1323601fd94b876f415db
+  metadata.gz: da947e5db80b4463e7c86ff89737646c6906a40655cc6e645d72034c54c5a668
+  data.tar.gz: 1b986261a557e1ebc6960e1143dc508329f51e62b60ac8e15647a941ea85e881
 SHA512:
-  metadata.gz: 558fb3ce2ecebd37567bb7ae0f2e2fcfc8811cc63bf8bfd7e41ec5c3941b0648935aa16bb672bcc882de2cc84e62ded9c054d44a2d563d873de3929efdf2c0c3
-  data.tar.gz: dfd52f6ea9539c620f517373be2fe39a73189942d38bf8c56ac3d86da15fb3a870a1754090374d75b376b114d215a217cfa77196780804749ade607cf60a734d
+  metadata.gz: 6694f4bdc0a4ab3c2a4efaf77c7cef61f4934e2274ba0942968fd9fb87d3feeb65353c43c8e46b76b15bad5fd22db6cefd976e77f0a48f0eaa80ddc6d8059e53
+  data.tar.gz: b7a853325307fa9ca03a063a70194860dcc0abab55bca29d2e4114fa12d240748a6563bb601839324ebc49f60bc7f87ae1000d13f17285a654c8670ec425cb28

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.28.0'.freeze
+  VERSION = '0.28.2'.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.28.0
+  version: 0.28.2
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-21 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: 0.28.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: 0.28.2
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement