flipper 0.7.5 → 0.8.0

data/lib/flipper/dsl.rb

@@ -145,6 +145,15 @@ module Flipper
       feature(name).disable_percentage_of_actors
     end
 
+    # Public: Remove a feature.
+    #
+    # name - The String or Symbol name of the feature.
+    #
+    # Returns result of remove.
+    def remove(name)
+      feature(name).remove
+    end
+
     # Public: Access a feature instance by name.
     #
     # name - The String or Symbol name of the feature.

data/lib/flipper/feature.rb

@@ -9,9 +9,6 @@ module Flipper
     # Private: The name of feature instrumentation events.
     InstrumentationName = "feature_operation.#{InstrumentationNamespace}"
 
-    # Private: The name of gate instrumentation events.
-    GateInstrumentationName = "gate_operation.#{InstrumentationNamespace}"
-
     # Public: The name of the feature.
     attr_reader :name
 
@@ -75,6 +72,13 @@ module Flipper
       }
     end
 
+    # Public: Removes this feature.
+    #
+    # Returns the result of Adapter#remove.
+    def remove
+      instrument(:remove) { adapter.remove(self) }
+    end
+
     # Public: Check if a feature is enabled for a thing.
     #
     # Returns true if enabled, false if not.
@@ -85,9 +89,7 @@ module Flipper
         payload[:thing] = gate(:actor).wrap(thing) unless thing.nil?
 
         open_gate = gates.detect { |gate|
-          instrument_gate(gate, :open?, thing) { |gate_payload|
-            gate.open?(thing, values[gate.key], feature_name: @name)
-          }
+          gate.open?(thing, values[gate.key], feature_name: @name)
         }
 
         if open_gate.nil?
@@ -356,19 +358,5 @@ module Flipper
         payload[:result] = yield(payload) if block_given?
       }
     end
-
-    # Private: Intrument a gate operation.
-    def instrument_gate(gate, operation, thing)
-      payload = {
-        :feature_name => @name,
-        :gate_name => gate.name,
-        :operation => operation,
-        :thing => thing,
-      }
-
-      @instrumenter.instrument(GateInstrumentationName, payload) { |payload|
-        payload[:result] = yield(payload) if block_given?
-      }
-    end
   end
 end

data/lib/flipper/gate.rb

@@ -1,9 +1,5 @@
-require 'forwardable'
-
 module Flipper
   class Gate
-    extend Forwardable
-
     # Public
     def initialize(options = {})
     end

data/lib/flipper/gate_values.rb

@@ -1,14 +1,16 @@
+require "set"
+
 module Flipper
   class GateValues
     # Private: Array of instance variables that are readable through the []
     # instance method.
-    LegitIvars = [
+    LegitIvars = Set.new([
       "boolean",
       "actors",
       "groups",
       "percentage_of_time",
       "percentage_of_actors",
-    ]
+    ]).freeze
 
     attr_reader :boolean
     attr_reader :actors

data/lib/flipper/gates/actor.rb

@@ -16,7 +16,7 @@ module Flipper
       end
 
       def enabled?(value)
-        !Typecast.to_set(value).empty?
+        !value.empty?
       end
 
       # Internal: Checks if the gate is open for a thing.

data/lib/flipper/gates/boolean.rb

@@ -16,7 +16,7 @@ module Flipper
       end
 
       def enabled?(value)
-        Typecast.to_boolean(value)
+        !!value
       end
 
       # Internal: Checks if the gate is open for a thing.

data/lib/flipper/gates/group.rb

@@ -16,7 +16,7 @@ module Flipper
       end
 
       def enabled?(value)
-        !Typecast.to_set(value).empty?
+        !value.empty?
       end
 
       # Internal: Checks if the gate is open for a thing.

data/lib/flipper/gates/percentage_of_actors.rb

@@ -18,20 +18,18 @@ module Flipper
       end
 
       def enabled?(value)
-        Typecast.to_integer(value) > 0
+        value > 0
       end
 
       # Internal: Checks if the gate is open for a thing.
       #
       # Returns true if gate open for thing, false if not.
       def open?(thing, value, options = {})
-        feature_name = options.fetch(:feature_name)
-        percentage = Typecast.to_integer(value)
-
         if Types::Actor.wrappable?(thing)
           actor = Types::Actor.wrap(thing)
+          feature_name = options.fetch(:feature_name)
           key = "#{feature_name}#{actor.value}"
-          Zlib.crc32(key) % 100 < percentage
+          Zlib.crc32(key) % 100 < value
         else
           false
         end

data/lib/flipper/gates/percentage_of_time.rb

@@ -16,15 +16,14 @@ module Flipper
       end
 
       def enabled?(value)
-        Typecast.to_integer(value) > 0
+        value > 0
       end
 
       # Internal: Checks if the gate is open for a thing.
       #
       # Returns true if gate open for thing, false if not.
       def open?(thing, value, options = {})
-        percentage = Typecast.to_integer(value)
-        rand < (percentage / 100.0)
+        rand < (value / 100.0)
       end
 
       def protects?(thing)

data/lib/flipper/instrumentation/log_subscriber.rb

@@ -65,34 +65,6 @@ module Flipper
         debug "  #{color(name, CYAN, true)}  [ #{details} ]"
       end
 
-      # Logs a gate operation.
-      #
-      # Example Output
-      #
-      #   flipper[:search].enabled?(user)
-      #   # Flipper feature(search) gate(boolean) open false (0.1ms)  [ thing=... ]
-      #   # Flipper feature(search) gate(group) open false (0.1ms)  [ thing=... ]
-      #   # Flipper feature(search) gate(actor) open false (0.1ms)  [ thing=... ]
-      #   # Flipper feature(search) gate(percentage_of_actors) open false (0.1ms)  [ thing=... ]
-      #   # Flipper feature(search) gate(percentage_of_time) open false (0.1ms)  [ thing=... ]
-      #
-      # Returns nothing.
-      def gate_operation(event)
-        return unless logger.debug?
-
-        feature_name = event.payload[:feature_name]
-        gate_name = event.payload[:gate_name]
-        operation = event.payload[:operation]
-        result = event.payload[:result]
-        thing = event.payload[:thing]
-
-        description = "Flipper feature(#{feature_name}) gate(#{gate_name}) #{operation} #{result.inspect}"
-        details = "thing=#{thing.inspect}"
-
-        name = '%s (%.1fms)' % [description, event.duration]
-        debug "  #{color(name, CYAN, true)}  [ #{details} ]"
-      end
-
       def logger
         self.class.logger
       end

data/lib/flipper/instrumentation/subscriber.rb

@@ -71,28 +71,6 @@ module Flipper
         update_timer "flipper.adapter.#{adapter_name}.#{operation}"
       end
 
-      # Private
-      def update_gate_operation_metrics
-        feature_name = @payload[:feature_name]
-        gate_name = @payload[:gate_name]
-        operation = strip_trailing_question_mark(@payload[:operation])
-        result = @payload[:result]
-        thing = @payload[:thing]
-
-        update_timer "flipper.gate_operation.#{gate_name}.#{operation}"
-        update_timer "flipper.feature.#{feature_name}.gate_operation.#{gate_name}.#{operation}"
-
-        if @payload[:operation] == :open?
-          metric_name = if result
-            "flipper.feature.#{feature_name}.gate.#{gate_name}.open"
-          else
-            "flipper.feature.#{feature_name}.gate.#{gate_name}.closed"
-          end
-
-          update_counter metric_name
-        end
-      end
-
       # Private
       def strip_trailing_question_mark(operation)
         operation.to_s.chomp('?')

data/lib/flipper/middleware/memoizer.rb

@@ -3,7 +3,7 @@ require 'rack/body_proxy'
 module Flipper
   module Middleware
     class Memoizer
-      # Public: Initializes an instance of the UI middleware.
+      # Public: Initializes an instance of the Memoizer middleware.
       #
       # app - The app this middleware is included in.
       # flipper_or_block - The Flipper::DSL instance or a block that yields a
@@ -11,9 +11,8 @@ module Flipper
       #
       # Examples
       #
-      #   flipper = Flipper.new(...)
-      #
       #   # using with a normal flipper instance
+      #   flipper = Flipper.new(...)
       #   use Flipper::Middleware::Memoizer, flipper
       #
       #   # using with a block that yields a flipper instance

data/lib/flipper/spec/shared_adapter_specs.rb

@@ -121,6 +121,22 @@ 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
+    (1..100).each do |percentage|
+      expect(subject.enable(feature, actors_gate, flipper.actors(percentage))).to eq(true)
+      result = subject.get(feature)
+      expect(result[:percentage_of_actors]).to eq(percentage.to_s)
+    end
+  end
+
+  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)
+      expect(result[:percentage_of_actors]).to eq(percentage.to_s)
+    end
+  end
+
   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)
@@ -131,6 +147,22 @@ 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
+    (1..100).each do |percentage|
+      expect(subject.enable(feature, time_gate, flipper.time(percentage))).to eq(true)
+      result = subject.get(feature)
+      expect(result[:percentage_of_time]).to eq(percentage.to_s)
+    end
+  end
+
+  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)
+      expect(result[:percentage_of_time]).to eq(percentage.to_s)
+    end
+  end
+
   it "converts boolean value to a string" do
     expect(subject.enable(feature, boolean_gate, flipper.boolean)).to eq(true)
     result = subject.get(feature)

data/lib/flipper/test/shared_adapter_test.rb

@@ -0,0 +1,249 @@
+module SharedAdapterTests
+  def setup
+    super
+    @flipper = Flipper.new(@adapter)
+    @actor_class = Struct.new(:flipper_id)
+    @feature = @flipper[:stats]
+    @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)
+
+    Flipper.register(:admins) do |actor|
+      actor.respond_to?(:admin?) && actor.admin?
+    end
+
+    Flipper.register(:early_access) { |actor|
+      actor.respond_to?(:early_access?) && actor.early_access?
+    }
+  end
+
+  def teardown
+    super
+    Flipper.unregister_groups
+  end
+
+  def test_has_name_that_is_a_symbol
+    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
+  end
+
+  def test_returns_correct_default_values_for_gates_if_none_are_enabled
+    expected = {
+      :boolean => nil,
+      :groups => Set.new,
+      :actors => Set.new,
+      :percentage_of_actors => nil,
+      :percentage_of_time => nil,
+    }
+    assert_equal expected, @adapter.get(@feature)
+  end
+
+  def test_can_enable_disable_and_get_value_for_boolean_gate
+    assert_equal true, @adapter.enable(@feature, @boolean_gate, @flipper.boolean)
+    assert_equal 'true', @adapter.get(@feature)[:boolean]
+    assert_equal true, @adapter.disable(@feature, @boolean_gate, @flipper.boolean(false))
+    assert_equal nil, @adapter.get(@feature)[:boolean]
+  end
+
+  def test_fully_disables_all_enabled_things_when_boolean_gate_disabled
+    actor_22 = @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, @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))
+    expected = {
+      :boolean => nil,
+      :groups => Set.new,
+      :actors => Set.new,
+      :percentage_of_actors => nil,
+      :percentage_of_time => nil,
+    }
+    assert_equal expected, @adapter.get(@feature)
+  end
+
+  def test_can_enable_disable_get_value_for_group_gate
+    assert_equal true, @adapter.enable(@feature, @group_gate, @flipper.group(:admins))
+    assert_equal true, @adapter.enable(@feature, @group_gate, @flipper.group(:early_access))
+
+    result = @adapter.get(@feature)
+    assert_equal Set['admins', 'early_access'], result[:groups]
+
+    assert_equal true, @adapter.disable(@feature, @group_gate, @flipper.group(:early_access))
+    result = @adapter.get(@feature)
+    assert_equal Set['admins'], result[:groups]
+
+    assert_equal true, @adapter.disable(@feature, @group_gate, @flipper.group(:admins))
+    result = @adapter.get(@feature)
+    assert_equal Set.new, result[:groups]
+  end
+
+  def test_can_enable_disable_and_get_value_for_an_actor_gate
+    actor_22 = @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(actor_asdf))
+
+    result = @adapter.get(@feature)
+    assert_equal Set['22', 'asdf'], result[:actors]
+
+    assert true, @adapter.disable(@feature, @actor_gate, @flipper.actor(actor_22))
+    result = @adapter.get(@feature)
+    assert_equal Set['asdf'], result[:actors]
+
+    assert_equal true, @adapter.disable(@feature, @actor_gate, @flipper.actor(actor_asdf))
+    result = @adapter.get(@feature)
+    assert_equal Set.new, result[:actors]
+  end
+
+  def test_can_enable_disable_get_value_for_percentage_of_actors_gate
+    assert_equal true, @adapter.enable(@feature, @actors_gate, @flipper.actors(15))
+    result = @adapter.get(@feature)
+    assert_equal '15', result[:percentage_of_actors]
+
+    assert_equal true, @adapter.disable(@feature, @actors_gate, @flipper.actors(0))
+    result = @adapter.get(@feature)
+    assert_equal '0', result[:percentage_of_actors]
+  end
+
+  def test_can_enable_percentage_of_actors_gate_many_times_and_consistently_return_values
+    (1..100).each do |percentage|
+      assert_equal true, @adapter.enable(@feature, @actors_gate, @flipper.actors(percentage))
+      result = @adapter.get(@feature)
+      assert_equal percentage.to_s, result[:percentage_of_actors]
+    end
+  end
+
+  def test_can_disable_percentage_of_actors_gate_many_times_and_consistently_return_values
+    (1..100).each do |percentage|
+      assert_equal true, @adapter.disable(@feature, @actors_gate, @flipper.actors(percentage))
+      result = @adapter.get(@feature)
+      assert_equal percentage.to_s, result[:percentage_of_actors]
+    end
+  end
+
+  def test_can_enable_disable_and_get_value_for_percentage_of_time_gate
+    assert_equal true, @adapter.enable(@feature, @time_gate, @flipper.time(10))
+    result = @adapter.get(@feature)
+    assert_equal '10', result[:percentage_of_time]
+
+    assert_equal true, @adapter.disable(@feature, @time_gate, @flipper.time(0))
+    result = @adapter.get(@feature)
+    assert_equal '0', result[:percentage_of_time]
+  end
+
+  def test_can_enable_percentage_of_time_gate_many_times_and_consistently_return_values
+    (1..100).each do |percentage|
+      assert_equal true, @adapter.enable(@feature, @time_gate, @flipper.time(percentage))
+      result = @adapter.get(@feature)
+      assert_equal percentage.to_s, result[:percentage_of_time]
+    end
+  end
+
+  def test_can_disable_percentage_of_time_gate_many_times_and_consistently_return_values
+    (1..100).each do |percentage|
+      assert_equal true, @adapter.disable(@feature, @time_gate, @flipper.time(percentage))
+      result = @adapter.get(@feature)
+      assert_equal percentage.to_s, result[:percentage_of_time]
+    end
+  end
+
+  def test_converts_boolean_value_to_a_string
+    assert_equal true, @adapter.enable(@feature, @boolean_gate, @flipper.boolean)
+    result = @adapter.get(@feature)
+    assert_equal 'true', result[:boolean]
+  end
+
+  def test_converts_the_actor_value_to_a_string
+    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
+
+  def test_converts_group_value_to_a_string
+    assert_equal  true, @adapter.enable(@feature, @group_gate, @flipper.group(:admins))
+    result = @adapter.get(@feature)
+    assert_equal Set['admins'], result[:groups]
+  end
+
+  def test_converts_percentage_of_time_integer_value_to_a_string
+    assert_equal true, @adapter.enable(@feature, @time_gate, @flipper.time(10))
+    result = @adapter.get(@feature)
+    assert_equal '10', result[:percentage_of_time]
+  end
+
+  def test_converts_percentage_of_actors_integer_value_to_a_string
+    assert_equal true, @adapter.enable(@feature, @actors_gate, @flipper.actors(10))
+    result = @adapter.get(@feature)
+    assert_equal '10', result[:percentage_of_actors]
+  end
+
+  def test_can_add_remove_and_list_known_features
+    assert_equal Set.new, @adapter.features
+
+    assert_equal true, @adapter.add(@flipper[:stats])
+    assert_equal Set['stats'], @adapter.features
+
+    assert_equal true, @adapter.add(@flipper[:search])
+    assert_equal Set['stats', 'search'], @adapter.features
+
+    assert_equal true, @adapter.remove(@flipper[:stats])
+    assert_equal Set['search'], @adapter.features
+
+    assert_equal true, @adapter.remove(@flipper[:search])
+    assert_equal Set.new, @adapter.features
+  end
+
+  def test_clears_all_the_gate_values_for_the_feature_on_remove
+    actor_22 = @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, @actors_gate, @flipper.actors(25))
+    assert_equal true, @adapter.enable(@feature, @time_gate, @flipper.time(45))
+
+    assert_equal true, @adapter.remove(@feature)
+
+    assert_equal @adapter.get(@feature), {
+      :boolean => nil,
+      :groups => Set.new,
+      :actors => Set.new,
+      :percentage_of_actors => nil,
+      :percentage_of_time => nil,
+    }
+  end
+
+  def test_can_clear_all_the_gate_values_for_a_feature
+    actor_22 = @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, @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 @adapter.get(@feature), {
+      :boolean => nil,
+      :groups => Set.new,
+      :actors => Set.new,
+      :percentage_of_actors => nil,
+      :percentage_of_time => nil,
+    }
+  end
+
+  def test_does_not_complain_clearing_a_feature_that_does_not_exist_in_adapter
+    assert_equal true, @adapter.clear(@flipper[:stats])
+  end
+end