flipper-redis 0.26.2 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07f785e46ede10238e72265b2db164520c385c6707652b61ac26e8f3571f198a
-  data.tar.gz: 65c0f228d8427145fae22f3ea9d73856f4ef22cdf363a470b28975c41b67b358
+  metadata.gz: e55b034a67c36b705521502c717a6a702e20fe7339571700e7a9250f49f21781
+  data.tar.gz: 95633728475c7a39bd88fd59b17ba4924dbbf9c98e2f7a2b0f196722302b1b19
 SHA512:
-  metadata.gz: 44261262d8159b0ac8d27630d40e326a0bf6eacefc663adede5f7f59bea1014504471a0c8169ec01b7e50e666388aaecaebc2ee1421dd2a7688dde4692eb12d3
-  data.tar.gz: 4eb84f9a382046ced62a0d4140697fc8c500d0689c9ba4d2725d17bb9cabc0557262933e1d4a4e5f089436520b638570a6d767bea2f37f071ffa13b69ac3a950
+  metadata.gz: 4cf728abd260addff1b057c68b0ea401458bc53fe8aa1ec4247d322dd1f1083fdbec76d20a4d3fc3bd123c4babde353d5a5be1d66ff07be1881e5430e794d21f
+  data.tar.gz: af6843a3bb222f418ae9917bde9b7d4d9d5f37bcb88371950ad834a7f6d557c0bf7ee8779bcfba8ee57fe6f6144bb1ab928ecbac04fdd3d7290dd70c441f28d0

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/flipper-redis.gemspec

@@ -8,10 +8,10 @@ end
 
 Gem::Specification.new do |gem|
   gem.authors       = ['John Nunemaker']
-  gem.email         = ['nunemaker@gmail.com']
-  gem.summary       = 'Redis adapter for Flipper'
+  gem.email         = 'support@flippercloud.io'
+  gem.summary       = 'Redis feature flag 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)

data/lib/flipper/adapters/redis.rb

@@ -7,18 +7,24 @@ module Flipper
     class Redis
       include ::Flipper::Adapter
 
-      # Private: The key that stores the set of known features.
-      FeaturesKey = :flipper_features
+      attr_reader :key_prefix
 
-      # Public: The name of the adapter.
-      attr_reader :name
+      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 +35,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 +45,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
 
@@ -73,19 +79,22 @@ module Flipper
       # Public: Enables a gate for a given thing.
       #
       # feature - The Flipper::Feature for the gate.
-      # gate - The Flipper::Gate to disable.
+      # gate - The Flipper::Gate to enable.
       # thing - The Flipper::Type being enabled for the gate.
       #
       # 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
+        when :json
+          @client.hset feature_key, gate.key, Typecast.to_json(thing.value)
         else
           unsupported_data_type gate.data_type
         end
@@ -101,13 +110,16 @@ 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)
+        when :json
+          @client.hdel feature_key, gate.key
         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)
@@ -160,6 +172,9 @@ module Flipper
               doc[gate.key.to_s]
             when :set
               fields_to_gate_value fields, gate
+            when :json
+              value = doc[gate.key.to_s]
+              Typecast.from_json(value)
             else
               unsupported_data_type gate.data_type
             end

data/lib/flipper/adapters/redis_cache.rb

@@ -8,28 +8,19 @@ module Flipper
     class RedisCache
       include ::Flipper::Adapter
 
-      Version = 'v1'.freeze
-      Namespace = "flipper/#{Version}".freeze
-      FeaturesKey = "#{Namespace}/features".freeze
-      GetAllKey = "#{Namespace}/get_all".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
+
+        @version = 'v1'.freeze
+        @namespace = "flipper/#{@version}".freeze
+        @features_key = "#{@namespace}/features".freeze
+        @get_all_key = "#{@namespace}/get_all".freeze
       end
 
       # Public
@@ -40,14 +31,14 @@ module Flipper
       # Public
       def add(feature)
         result = @adapter.add(feature)
-        @cache.del(FeaturesKey)
+        @cache.del(@features_key)
         result
       end
 
       # Public
       def remove(feature)
         result = @adapter.remove(feature)
-        @cache.del(FeaturesKey)
+        @cache.del(@features_key)
         @cache.del(key_for(feature.key))
         result
       end
@@ -71,13 +62,13 @@ module Flipper
       end
 
       def get_all
-        if @cache.setnx(GetAllKey, Time.now.to_i)
-          @cache.expire(GetAllKey, @ttl)
+        if @cache.setnx(@get_all_key, Time.now.to_i)
+          @cache.expire(@get_all_key, @ttl)
           response = @adapter.get_all
           response.each do |key, value|
             set_with_ttl key_for(key), value
           end
-          set_with_ttl FeaturesKey, response.keys.to_set
+          set_with_ttl @features_key, response.keys.to_set
           response
         else
           features = read_feature_keys.map { |key| Flipper::Feature.new(key, self) }
@@ -102,11 +93,11 @@ module Flipper
       private
 
       def key_for(key)
-        self.class.key_for(key)
+        "#{@namespace}/feature/#{key}"
       end
 
       def read_feature_keys
-        fetch(FeaturesKey) { @adapter.features }
+        fetch(@features_key) { @adapter.features }
       end
 
       def read_many_features(features)

data/lib/flipper/version.rb

@@ -1,3 +1,13 @@
 module Flipper
-  VERSION = '0.26.2'.freeze
+  VERSION = '1.2.2'.freeze
+
+  REQUIRED_RUBY_VERSION = '2.6'.freeze
+  NEXT_REQUIRED_RUBY_VERSION = '3.0'.freeze
+
+  REQUIRED_RAILS_VERSION = '5.2'.freeze
+  NEXT_REQUIRED_RAILS_VERSION = '6.1.0'.freeze
+
+  def self.deprecated_ruby_version?
+    Gem::Version.new(RUBY_VERSION) < Gem::Version.new(NEXT_REQUIRED_RUBY_VERSION)
+  end
 end

data/spec/flipper/adapters/redis_cache_spec.rb

@@ -17,10 +17,8 @@ RSpec.describe Flipper::Adapters::RedisCache do
   subject { adapter }
 
   before do
-    begin
+    skip_on_error(Redis::CannotConnectError, 'Redis not available') do
       client.flushdb
-    rescue Redis::CannotConnectError
-      ENV['CI'] ? raise : skip('Redis not available')
     end
   end
 
@@ -31,7 +29,7 @@ RSpec.describe Flipper::Adapters::RedisCache do
       feature = flipper[:stats]
       adapter.get(feature)
       adapter.remove(feature)
-      expect(client.get(described_class.key_for(feature))).to be(nil)
+      expect(client.get("flipper/v1/feature/#{feature.key}")).to be(nil)
     end
   end
 
@@ -39,7 +37,7 @@ RSpec.describe Flipper::Adapters::RedisCache do
     it 'uses correct cache key' do
       stats = flipper[:stats]
       adapter.get(stats)
-      expect(client.get(described_class.key_for(stats))).not_to be_nil
+      expect(client.get("flipper/v1/feature/#{stats.key}")).not_to be_nil
     end
   end
 
@@ -54,13 +52,13 @@ RSpec.describe Flipper::Adapters::RedisCache do
       memory_adapter.reset
 
       adapter.get(stats)
-      expect(client.get(described_class.key_for(search))).to be(nil)
-      expect(client.get(described_class.key_for(other))).to be(nil)
+      expect(client.get("flipper/v1/feature/#{search.key}")).to be(nil)
+      expect(client.get("flipper/v1/feature/#{other.key}")).to be(nil)
 
       adapter.get_multi([stats, search, other])
 
       search_cache_value, other_cache_value = [search, other].map do |f|
-        Marshal.load(client.get(described_class.key_for(f)))
+        Marshal.load(client.get("flipper/v1/feature/#{f.key}"))
       end
       expect(search_cache_value[:boolean]).to eq('true')
       expect(other_cache_value[:boolean]).to be(nil)
@@ -82,9 +80,9 @@ RSpec.describe Flipper::Adapters::RedisCache do
 
     it 'warms all features' do
       adapter.get_all
-      expect(Marshal.load(client.get(described_class.key_for(stats.key)))[:boolean]).to eq('true')
-      expect(Marshal.load(client.get(described_class.key_for(search.key)))[:boolean]).to be(nil)
-      expect(client.get(described_class::GetAllKey).to_i).to be_within(2).of(Time.now.to_i)
+      expect(Marshal.load(client.get("flipper/v1/feature/#{stats.key}"))[:boolean]).to eq('true')
+      expect(Marshal.load(client.get("flipper/v1/feature/#{search.key}"))[:boolean]).to be(nil)
+      expect(client.get("flipper/v1/get_all").to_i).to be_within(2).of(Time.now.to_i)
     end
 
     it 'returns same result when already cached' do

data/spec/flipper/adapters/redis_spec.rb

@@ -13,10 +13,8 @@ RSpec.describe Flipper::Adapters::Redis do
   subject { described_class.new(client) }
 
   before do
-    begin
+    skip_on_error(Redis::CannotConnectError, 'Redis not available') do
       client.flushdb
-    rescue Redis::CannotConnectError
-      ENV['CI'] ? raise : skip('Redis not available')
     end
   end
 
@@ -30,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.26.2
+  version: 1.2.2
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2024-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.2
+        version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.2
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -45,8 +45,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6'
 description:
-email:
-- nunemaker@gmail.com
+email: support@flippercloud.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -63,11 +62,15 @@ 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/main/Changelog.md
+  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/releases/tag/v1.2.2
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -83,10 +86,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: Redis adapter for Flipper
+summary: Redis feature flag adapter for Flipper
 test_files:
 - spec/flipper/adapters/redis_cache_spec.rb
 - spec/flipper/adapters/redis_spec.rb