flipper 0.10.2 → 0.11.0.beta1

data/lib/flipper/middleware/setup_env.rb

@@ -0,0 +1,44 @@
+module Flipper
+  module Middleware
+    class SetupEnv
+      # Public: Initializes an instance of the SetEnv middleware. Allows for
+      # lazy initialization of the flipper instance being set in the env by
+      # providing a block.
+      #
+      # app - The app this middleware is included in.
+      # flipper_or_block - The Flipper::DSL instance or a block that yields a
+      #                    Flipper::DSL instance to use for all operations.
+      #
+      # Examples
+      #
+      #   flipper = Flipper.new(...)
+      #
+      #   # using with a normal flipper instance
+      #   use Flipper::Middleware::SetEnv, flipper
+      #
+      #   # using with a block that yields a flipper instance
+      #   use Flipper::Middleware::SetEnv, lambda { Flipper.new(...) }
+      #
+      def initialize(app, flipper_or_block)
+        @app = app
+
+        if flipper_or_block.respond_to?(:call)
+          @flipper_block = flipper_or_block
+        else
+          @flipper = flipper_or_block
+        end
+      end
+
+      def call(env)
+        env['flipper'.freeze] ||= flipper
+        @app.call(env)
+      end
+
+      private
+
+      def flipper
+        @flipper ||= @flipper_block.call
+      end
+    end
+  end
+end

data/lib/flipper/registry.rb

@@ -34,29 +34,27 @@ module Flipper
     def add(key, value)
       key = key.to_sym
 
-      @mutex.synchronize {
+      @mutex.synchronize do
         if @source[key]
           raise DuplicateKey, "#{key} is already registered"
         else
           @source[key] = value
         end
-      }
+      end
     end
 
     def get(key)
       key = key.to_sym
-      @mutex.synchronize {
-        @source.fetch(key) {
-          raise KeyNotFound.new(key)
-        }
-      }
+      @mutex.synchronize do
+        @source[key]
+      end
     end
 
     def key?(key)
       key = key.to_sym
-      @mutex.synchronize {
-        @source.has_key?(key)
-      }
+      @mutex.synchronize do
+        @source.key?(key)
+      end
     end
 
     def each(&block)

data/lib/flipper/spec/shared_adapter_specs.rb

@@ -10,46 +10,36 @@ RSpec.shared_examples_for 'a flipper adapter' do
   let(:group_gate)   { feature.gate(:group) }
   let(:actor_gate)   { feature.gate(:actor) }
   let(:actors_gate)  { feature.gate(:percentage_of_actors) }
-  let(:time_gate)  { feature.gate(:percentage_of_time) }
-
-  let(:default_config) {
-    {
-      :boolean => nil,
-      :groups => Set.new,
-      :actors => Set.new,
-      :percentage_of_actors => nil,
-      :percentage_of_time => nil,
-    }
-  }
+  let(:time_gate) { feature.gate(:percentage_of_time) }
 
   before do
-    Flipper.register(:admins) { |actor|
+    Flipper.register(:admins) do |actor|
       actor.respond_to?(:admin?) && actor.admin?
-    }
+    end
 
-    Flipper.register(:early_access) { |actor|
+    Flipper.register(:early_access) do |actor|
       actor.respond_to?(:early_access?) && actor.early_access?
-    }
+    end
   end
 
   after do
     Flipper.unregister_groups
   end
 
-  it "has name that is a symbol" do
-    expect(subject.name).to_not be_nil
+  it 'has name that is a symbol' do
+    expect(subject.name).not_to be_nil
     expect(subject.name).to be_instance_of(Symbol)
   end
 
-  it "has included the flipper adapter module" do
+  it 'has included the flipper adapter module' do
     expect(subject.class.ancestors).to include(Flipper::Adapter)
   end
 
-  it "returns correct default values for the gates if none are enabled" do
-    expect(subject.get(feature)).to eq(default_config)
+  it 'returns correct default values for the gates if none are enabled' do
+    expect(subject.get(feature)).to eq(subject.default_config)
   end
 
-  it "can enable, disable and get value for boolean gate" do
+  it 'can enable, disable and get value for boolean gate' do
     expect(subject.enable(feature, boolean_gate, flipper.boolean)).to eq(true)
 
     result = subject.get(feature)
@@ -61,26 +51,20 @@ RSpec.shared_examples_for 'a flipper adapter' do
     expect(result[:boolean]).to eq(nil)
   end
 
-  it "fully disables all enabled things when boolean gate disabled" do
-    actor_22 = actor_class.new('22')
+  it 'fully disables all enabled things when boolean gate disabled' do
+    actor22 = actor_class.new('22')
     expect(subject.enable(feature, boolean_gate, flipper.boolean)).to eq(true)
     expect(subject.enable(feature, group_gate, flipper.group(:admins))).to eq(true)
-    expect(subject.enable(feature, actor_gate, flipper.actor(actor_22))).to eq(true)
+    expect(subject.enable(feature, actor_gate, flipper.actor(actor22))).to eq(true)
     expect(subject.enable(feature, actors_gate, flipper.actors(25))).to eq(true)
     expect(subject.enable(feature, time_gate, flipper.time(45))).to eq(true)
 
     expect(subject.disable(feature, boolean_gate, flipper.boolean(false))).to eq(true)
 
-    expect(subject.get(feature)).to eq({
-      :boolean => nil,
-      :groups => Set.new,
-      :actors => Set.new,
-      :percentage_of_actors => nil,
-      :percentage_of_time => nil,
-    })
+    expect(subject.get(feature)).to eq(subject.default_config)
   end
 
-  it "can enable, disable and get value for group gate" do
+  it 'can enable, disable and get value for group gate' do
     expect(subject.enable(feature, group_gate, flipper.group(:admins))).to eq(true)
     expect(subject.enable(feature, group_gate, flipper.group(:early_access))).to eq(true)
 
@@ -96,17 +80,17 @@ RSpec.shared_examples_for 'a flipper adapter' do
     expect(result[:groups]).to eq(Set.new)
   end
 
-  it "can enable, disable and get value for actor gate" do
-    actor_22 = actor_class.new('22')
+  it 'can enable, disable and get value for actor gate' do
+    actor22 = actor_class.new('22')
     actor_asdf = actor_class.new('asdf')
 
-    expect(subject.enable(feature, actor_gate, flipper.actor(actor_22))).to eq(true)
+    expect(subject.enable(feature, actor_gate, flipper.actor(actor22))).to eq(true)
     expect(subject.enable(feature, actor_gate, flipper.actor(actor_asdf))).to eq(true)
 
     result = subject.get(feature)
     expect(result[:actors]).to eq(Set['22', 'asdf'])
 
-    expect(subject.disable(feature, actor_gate, flipper.actor(actor_22))).to eq(true)
+    expect(subject.disable(feature, actor_gate, flipper.actor(actor22))).to eq(true)
     result = subject.get(feature)
     expect(result[:actors]).to eq(Set['asdf'])
 
@@ -115,7 +99,7 @@ RSpec.shared_examples_for 'a flipper adapter' do
     expect(result[:actors]).to eq(Set.new)
   end
 
-  it "can enable, disable and get value for percentage of actors gate" do
+  it 'can enable, disable and get value for percentage of actors gate' do
     expect(subject.enable(feature, actors_gate, flipper.actors(15))).to eq(true)
     result = subject.get(feature)
     expect(result[:percentage_of_actors]).to eq('15')
@@ -125,7 +109,7 @@ RSpec.shared_examples_for 'a flipper adapter' do
     expect(result[:percentage_of_actors]).to eq('0')
   end
 
-  it "can enable percentage of actors gate many times and consistently return values" do
+  it 'can enable percentage of actors gate many times and consistently return values' do
     (1..100).each do |percentage|
       expect(subject.enable(feature, actors_gate, flipper.actors(percentage))).to eq(true)
       result = subject.get(feature)
@@ -133,7 +117,7 @@ RSpec.shared_examples_for 'a flipper adapter' do
     end
   end
 
-  it "can disable percentage of actors gate many times and consistently return values" do
+  it 'can disable percentage of actors gate many times and consistently return values' do
     (1..100).each do |percentage|
       expect(subject.disable(feature, actors_gate, flipper.actors(percentage))).to eq(true)
       result = subject.get(feature)
@@ -141,7 +125,7 @@ RSpec.shared_examples_for 'a flipper adapter' do
     end
   end
 
-  it "can enable, disable and get value for percentage of time gate" do
+  it 'can enable, disable and get value for percentage of time gate' do
     expect(subject.enable(feature, time_gate, flipper.time(10))).to eq(true)
     result = subject.get(feature)
     expect(result[:percentage_of_time]).to eq('10')
@@ -151,7 +135,7 @@ RSpec.shared_examples_for 'a flipper adapter' do
     expect(result[:percentage_of_time]).to eq('0')
   end
 
-  it "can enable percentage of time gate many times and consistently return values" do
+  it 'can enable percentage of time gate many times and consistently return values' do
     (1..100).each do |percentage|
       expect(subject.enable(feature, time_gate, flipper.time(percentage))).to eq(true)
       result = subject.get(feature)
@@ -159,7 +143,7 @@ RSpec.shared_examples_for 'a flipper adapter' do
     end
   end
 
-  it "can disable percentage of time gate many times and consistently return values" do
+  it 'can disable percentage of time gate many times and consistently return values' do
     (1..100).each do |percentage|
       expect(subject.disable(feature, time_gate, flipper.time(percentage))).to eq(true)
       result = subject.get(feature)
@@ -167,37 +151,37 @@ RSpec.shared_examples_for 'a flipper adapter' do
     end
   end
 
-  it "converts boolean value to a string" do
+  it 'converts boolean value to a string' do
     expect(subject.enable(feature, boolean_gate, flipper.boolean)).to eq(true)
     result = subject.get(feature)
     expect(result[:boolean]).to eq('true')
   end
 
-  it "converts the actor value to a string" do
+  it 'converts the actor value to a string' do
     expect(subject.enable(feature, actor_gate, flipper.actor(actor_class.new(22)))).to eq(true)
     result = subject.get(feature)
     expect(result[:actors]).to eq(Set['22'])
   end
 
-  it "converts group value to a string" do
+  it 'converts group value to a string' do
     expect(subject.enable(feature, group_gate, flipper.group(:admins))).to eq(true)
     result = subject.get(feature)
     expect(result[:groups]).to eq(Set['admins'])
   end
 
-  it "converts percentage of time integer value to a string" do
+  it 'converts percentage of time integer value to a string' do
     expect(subject.enable(feature, time_gate, flipper.time(10))).to eq(true)
     result = subject.get(feature)
     expect(result[:percentage_of_time]).to eq('10')
   end
 
-  it "converts percentage of actors integer value to a string" do
+  it 'converts percentage of actors integer value to a string' do
     expect(subject.enable(feature, actors_gate, flipper.actors(10))).to eq(true)
     result = subject.get(feature)
     expect(result[:percentage_of_actors]).to eq('10')
   end
 
-  it "can add, remove and list known features" do
+  it 'can add, remove and list known features' do
     expect(subject.features).to eq(Set.new)
 
     expect(subject.add(flipper[:stats])).to eq(true)
@@ -213,46 +197,40 @@ RSpec.shared_examples_for 'a flipper adapter' do
     expect(subject.features).to eq(Set.new)
   end
 
-  it "clears all the gate values for the feature on remove" do
-    actor_22 = actor_class.new('22')
+  it 'clears all the gate values for the feature on remove' do
+    actor22 = actor_class.new('22')
     expect(subject.enable(feature, boolean_gate, flipper.boolean)).to eq(true)
     expect(subject.enable(feature, group_gate, flipper.group(:admins))).to eq(true)
-    expect(subject.enable(feature, actor_gate, flipper.actor(actor_22))).to eq(true)
+    expect(subject.enable(feature, actor_gate, flipper.actor(actor22))).to eq(true)
     expect(subject.enable(feature, actors_gate, flipper.actors(25))).to eq(true)
     expect(subject.enable(feature, time_gate, flipper.time(45))).to eq(true)
 
     expect(subject.remove(feature)).to eq(true)
 
-    expect(subject.get(feature)).to eq({
-      :boolean => nil,
-      :groups => Set.new,
-      :actors => Set.new,
-      :percentage_of_actors => nil,
-      :percentage_of_time => nil,
-    })
+    expect(subject.get(feature)).to eq(subject.default_config)
   end
 
-  it "can clear all the gate values for a feature" do
-    actor_22 = actor_class.new('22')
+  it 'can clear all the gate values for a feature' do
+    actor22 = actor_class.new('22')
     subject.add(feature)
     expect(subject.features).to include(feature.key)
 
     expect(subject.enable(feature, boolean_gate, flipper.boolean)).to eq(true)
     expect(subject.enable(feature, group_gate, flipper.group(:admins))).to eq(true)
-    expect(subject.enable(feature, actor_gate, flipper.actor(actor_22))).to eq(true)
+    expect(subject.enable(feature, actor_gate, flipper.actor(actor22))).to eq(true)
     expect(subject.enable(feature, actors_gate, flipper.actors(25))).to eq(true)
     expect(subject.enable(feature, time_gate, flipper.time(45))).to eq(true)
 
     expect(subject.clear(feature)).to eq(true)
     expect(subject.features).to include(feature.key)
-    expect(subject.get(feature)).to eq(default_config)
+    expect(subject.get(feature)).to eq(subject.default_config)
   end
 
-  it "does not complain clearing a feature that does not exist in adapter" do
+  it 'does not complain clearing a feature that does not exist in adapter' do
     expect(subject.clear(flipper[:stats])).to eq(true)
   end
 
-  it "can get multiple features" do
+  it 'can get multiple features' do
     expect(subject.add(flipper[:stats])).to eq(true)
     expect(subject.enable(flipper[:stats], boolean_gate, flipper.boolean)).to eq(true)
 
@@ -262,8 +240,8 @@ RSpec.shared_examples_for 'a flipper adapter' do
     expect(result).to be_instance_of(Hash)
 
     stats, search, other = result.values
-    expect(stats).to eq(default_config.merge(boolean: "true"))
-    expect(search).to eq(default_config)
-    expect(other).to eq(default_config)
+    expect(stats).to eq(subject.default_config.merge(boolean: 'true'))
+    expect(search).to eq(subject.default_config)
+    expect(other).to eq(subject.default_config)
   end
 end

data/lib/flipper/test/shared_adapter_test.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Metrics/ModuleLength
 module Flipper
   module Test
     module SharedAdapterTests
@@ -9,24 +10,16 @@ module Flipper
         @boolean_gate = @feature.gate(:boolean)
         @group_gate = @feature.gate(:group)
         @actor_gate = @feature.gate(:actor)
-        @actors_gate =  @feature.gate(:percentage_of_actors)
-        @time_gate =  @feature.gate(:percentage_of_time)
-
-        @default_config = {
-          :boolean => nil,
-          :groups => Set.new,
-          :actors => Set.new,
-          :percentage_of_actors => nil,
-          :percentage_of_time => nil,
-        }
+        @actors_gate = @feature.gate(:percentage_of_actors)
+        @time_gate = @feature.gate(:percentage_of_time)
 
         Flipper.register(:admins) do |actor|
           actor.respond_to?(:admin?) && actor.admin?
         end
 
-        Flipper.register(:early_access) { |actor|
+        Flipper.register(:early_access) do |actor|
           actor.respond_to?(:early_access?) && actor.early_access?
-        }
+        end
       end
 
       def teardown
@@ -35,16 +28,16 @@ module Flipper
       end
 
       def test_has_name_that_is_a_symbol
-        refute_empty  @adapter.name
+        refute_empty @adapter.name
         assert_kind_of Symbol, @adapter.name
       end
 
       def test_has_included_the_flipper_adapter_module
-        assert_includes  @adapter.class.ancestors, Flipper::Adapter
+        assert_includes @adapter.class.ancestors, Flipper::Adapter
       end
 
       def test_returns_correct_default_values_for_gates_if_none_are_enabled
-        assert_equal @default_config, @adapter.get(@feature)
+        assert_equal @adapter.default_config, @adapter.get(@feature)
       end
 
       def test_can_enable_disable_and_get_value_for_boolean_gate
@@ -55,14 +48,14 @@ module Flipper
       end
 
       def test_fully_disables_all_enabled_things_when_boolean_gate_disabled
-        actor_22 = @actor_class.new('22')
+        actor22 = @actor_class.new('22')
         assert_equal true, @adapter.enable(@feature, @boolean_gate, @flipper.boolean)
         assert_equal true, @adapter.enable(@feature, @group_gate, @flipper.group(:admins))
-        assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor_22))
+        assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor22))
         assert_equal true, @adapter.enable(@feature, @actors_gate, @flipper.actors(25))
         assert_equal true, @adapter.enable(@feature, @time_gate, @flipper.time(45))
         assert_equal true, @adapter.disable(@feature, @boolean_gate, @flipper.boolean(false))
-        assert_equal @default_config, @adapter.get(@feature)
+        assert_equal @adapter.default_config, @adapter.get(@feature)
       end
 
       def test_can_enable_disable_get_value_for_group_gate
@@ -82,16 +75,16 @@ module Flipper
       end
 
       def test_can_enable_disable_and_get_value_for_an_actor_gate
-        actor_22 = @actor_class.new('22')
+        actor22 = @actor_class.new('22')
         actor_asdf = @actor_class.new('asdf')
 
-        assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor_22))
+        assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor22))
         assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor_asdf))
 
         result = @adapter.get(@feature)
         assert_equal Set['22', 'asdf'], result[:actors]
 
-        assert true, @adapter.disable(@feature, @actor_gate, @flipper.actor(actor_22))
+        assert true, @adapter.disable(@feature, @actor_gate, @flipper.actor(actor22))
         result = @adapter.get(@feature)
         assert_equal Set['asdf'], result[:actors]
 
@@ -159,7 +152,8 @@ module Flipper
       end
 
       def test_converts_the_actor_value_to_a_string
-        assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(@actor_class.new(22)))
+        assert_equal true,
+                     @adapter.enable(@feature, @actor_gate, @flipper.actor(@actor_class.new(22)))
         result = @adapter.get(@feature)
         assert_equal Set['22'], result[:actors]
       end
@@ -199,32 +193,32 @@ module Flipper
       end
 
       def test_clears_all_the_gate_values_for_the_feature_on_remove
-        actor_22 = @actor_class.new('22')
+        actor22 = @actor_class.new('22')
         assert_equal true, @adapter.enable(@feature, @boolean_gate, @flipper.boolean)
         assert_equal true, @adapter.enable(@feature, @group_gate, @flipper.group(:admins))
-        assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor_22))
+        assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor22))
         assert_equal true, @adapter.enable(@feature, @actors_gate, @flipper.actors(25))
         assert_equal true, @adapter.enable(@feature, @time_gate, @flipper.time(45))
 
         assert_equal true, @adapter.remove(@feature)
 
-        assert_equal @default_config, @adapter.get(@feature)
+        assert_equal @adapter.default_config, @adapter.get(@feature)
       end
 
       def test_can_clear_all_the_gate_values_for_a_feature
-        actor_22 = @actor_class.new('22')
+        actor22 = @actor_class.new('22')
         @adapter.add(@feature)
         assert_includes @adapter.features, @feature.key
 
         assert_equal true, @adapter.enable(@feature, @boolean_gate, @flipper.boolean)
         assert_equal true, @adapter.enable(@feature, @group_gate, @flipper.group(:admins))
-        assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor_22))
+        assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor22))
         assert_equal true, @adapter.enable(@feature, @actors_gate, @flipper.actors(25))
         assert_equal true, @adapter.enable(@feature, @time_gate, @flipper.time(45))
 
         assert_equal true, @adapter.clear(@feature)
         assert_includes @adapter.features, @feature.key
-        assert_equal @default_config, @adapter.get(@feature)
+        assert_equal @adapter.default_config, @adapter.get(@feature)
       end
 
       def test_does_not_complain_clearing_a_feature_that_does_not_exist_in_adapter
@@ -240,9 +234,9 @@ module Flipper
         assert_instance_of Hash, result
 
         stats, search, other = result.values
-        assert_equal @default_config.merge(boolean: "true"), stats
-        assert_equal @default_config, search
-        assert_equal @default_config, other
+        assert_equal @adapter.default_config.merge(boolean: 'true'), stats
+        assert_equal @adapter.default_config, search
+        assert_equal @adapter.default_config, other
       end
     end
   end