flipper 0.26.0 → 1.3.6

data/lib/flipper/expressions/percentage.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Expressions
+    class Percentage
+      def self.call(value)
+        value.to_f.clamp(0, 100)
+      end
+    end
+  end
+end

data/lib/flipper/expressions/percentage_of_actors.rb

@@ -0,0 +1,12 @@
+module Flipper
+  module Expressions
+    class PercentageOfActors
+      SCALING_FACTOR = 1_000
+
+      def self.call(text, percentage, context: {})
+        prefix = context[:feature_name] || ""
+        Zlib.crc32("#{prefix}#{text}") % (100 * SCALING_FACTOR) < percentage * SCALING_FACTOR
+      end
+    end
+  end
+end

data/lib/flipper/expressions/property.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Expressions
+    class Property
+      def self.call(key, context:)
+        context.dig(:properties, key.to_s)
+      end
+    end
+  end
+end

data/lib/flipper/expressions/random.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Expressions
+    class Random
+      def self.call(max = 0)
+        rand max
+      end
+    end
+  end
+end

data/lib/flipper/expressions/string.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Expressions
+    class String
+      def self.call(value)
+        value.to_s
+      end
+    end
+  end
+end

data/lib/flipper/expressions/time.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Expressions
+    class Time
+      def self.call(value)
+        ::Time.parse(value)
+      end
+    end
+  end
+end

data/lib/flipper/feature.rb

@@ -96,18 +96,26 @@ module Flipper
       instrument(:clear) { adapter.clear(self) }
     end
 
-    # Public: Check if a feature is enabled for a thing.
+    # Public: Check if a feature is enabled for zero or more actors.
     #
     # Returns true if enabled, false if not.
-    def enabled?(thing = nil)
-      instrument(:enabled?) do |payload|
-        values = gate_values
-        thing = gate(:actor).wrap(thing) unless thing.nil?
-        payload[:thing] = thing
+    def enabled?(*actors)
+      actors = Array(actors).
+        # Avoids to_ary warning that happens when passing DelegateClass of an 
+        # ActiveRecord object and using flatten here. This is tested in 
+        # spec/flipper/model/active_record_spec.rb.
+        flat_map { |actor| actor.is_a?(Array) ? actor : [actor] }. 
+        # Allows null object pattern. See PR for more. https://github.com/flippercloud/flipper/pull/887
+        reject(&:nil?). 
+        map { |actor| Types::Actor.wrap(actor) }
+      actors = nil if actors.empty?
+
+      # thing is left for backwards compatibility
+      instrument(:enabled?, thing: actors&.first, actors: actors) do |payload|
         context = FeatureCheckContext.new(
           feature_name: @name,
-          values: values,
-          thing: thing
+          values: gate_values,
+          actors: actors
         )
 
         if open_gate = gates.detect { |gate| gate.open?(context) }
@@ -119,6 +127,28 @@ module Flipper
       end
     end
 
+    # Public: Enables an expression_to_add for a feature.
+    #
+    # expression - an Expression or Hash that can be converted to an expression.
+    #
+    # Returns result of enable.
+    def enable_expression(expression)
+      enable Expression.build(expression)
+    end
+
+    # Public: Add an expression for a feature.
+    #
+    # expression_to_add - an expression or Hash that can be converted to an expression.
+    #
+    # Returns result of enable.
+    def add_expression(expression_to_add)
+      if (current_expression = expression)
+        enable current_expression.add(expression_to_add)
+      else
+        enable expression_to_add
+      end
+    end
+
     # Public: Enables a feature for an actor.
     #
     # actor - a Flipper::Types::Actor instance or an object that responds
@@ -159,6 +189,27 @@ module Flipper
       enable Types::PercentageOfActors.wrap(percentage)
     end
 
+    # Public: Disables an expression for a feature.
+    #
+    # expression - an expression or Hash that can be converted to an expression.
+    #
+    # Returns result of disable.
+    def disable_expression
+      disable Flipper.all # just need an expression to clear
+    end
+
+    # Public: Remove an expression from a feature. Does nothing if no expression is
+    # currently enabled.
+    #
+    # expression - an Expression or Hash that can be converted to an expression.
+    #
+    # Returns result of enable or nil (if no expression enabled).
+    def remove_expression(expression_to_remove)
+      if (current_expression = expression)
+        enable current_expression.remove(expression_to_remove)
+      end
+    end
+
     # Public: Disables a feature for an actor.
     #
     # actor - a Flipper::Types::Actor instance or an object that responds
@@ -207,7 +258,7 @@ module Flipper
 
       if values.boolean || values.percentage_of_time == 100
         :on
-      elsif non_boolean_gates.detect { |gate| gate.enabled?(values[gate.key]) }
+      elsif non_boolean_gates.detect { |gate| gate.enabled?(values.send(gate.key)) }
         :conditional
       else
         :off
@@ -232,7 +283,8 @@ module Flipper
 
     # Public: Returns the raw gate values stored by the adapter.
     def gate_values
-      GateValues.new(adapter.get(self))
+      adapter_values = adapter.get(self)
+      GateValues.new(adapter_values)
     end
 
     # Public: Get groups enabled for this feature.
@@ -250,6 +302,10 @@ module Flipper
       Flipper.groups - enabled_groups
     end
 
+    def expression
+      Flipper::Expression.build(expression_value) if expression_value
+    end
+
     # Public: Get the adapter value for the groups gate.
     #
     # Returns Set of String group names.
@@ -257,6 +313,13 @@ module Flipper
       gate_values.groups
     end
 
+    # Public: Get the adapter value for the expression gate.
+    #
+    # Returns expression.
+    def expression_value
+      gate_values.expression
+    end
+
     # Public: Get the adapter value for the actors gate.
     #
     # Returns Set of String flipper_id's.
@@ -290,7 +353,7 @@ module Flipper
     # Returns an Array of Flipper::Gate instances.
     def enabled_gates
       values = gate_values
-      gates.select { |gate| gate.enabled?(values[gate.key]) }
+      gates.select { |gate| gate.enabled?(values.send(gate.key)) }
     end
 
     # Public: Get the names of the enabled gates.
@@ -339,37 +402,42 @@ module Flipper
     #
     # Returns an array of gates
     def gates
-      @gates ||= [
-        Gates::Boolean.new,
-        Gates::Actor.new,
-        Gates::PercentageOfActors.new,
-        Gates::PercentageOfTime.new,
-        Gates::Group.new,
-      ]
+      @gates ||= gates_hash.values.freeze
+    end
+
+    def gates_hash
+      @gates_hash ||= {
+        boolean: Gates::Boolean.new,
+        expression: Gates::Expression.new,
+        actor: Gates::Actor.new,
+        percentage_of_actors: Gates::PercentageOfActors.new,
+        percentage_of_time: Gates::PercentageOfTime.new,
+        group: Gates::Group.new,
+      }.freeze
     end
 
     # Public: Find a gate by name.
     #
     # Returns a Flipper::Gate if found, nil if not.
     def gate(name)
-      gates.detect { |gate| gate.name == name.to_sym }
+      gates_hash[name.to_sym]
     end
 
-    # Public: Find the gate that protects a thing.
+    # Public: Find the gate that protects an actor.
     #
-    # thing - The object for which you would like to find a gate
+    # actor - The object for which you would like to find a gate
     #
     # Returns a Flipper::Gate.
-    # Raises Flipper::GateNotFound if no gate found for thing
-    def gate_for(thing)
-      gates.detect { |gate| gate.protects?(thing) } || raise(GateNotFound, thing)
+    # Raises Flipper::GateNotFound if no gate found for actor
+    def gate_for(actor)
+      gates.detect { |gate| gate.protects?(actor) } || raise(GateNotFound, actor)
     end
 
     private
 
     # Private: Instrument a feature operation.
-    def instrument(operation)
-      @instrumenter.instrument(InstrumentationName) do |payload|
+    def instrument(operation, initial_payload = {})
+      @instrumenter.instrument(InstrumentationName, initial_payload) do |payload|
         payload[:feature_name] = name
         payload[:operation] = operation
         payload[:result] = yield(payload) if block_given?

data/lib/flipper/feature_check_context.rb

@@ -7,13 +7,17 @@ module Flipper
     # gates for the feature.
     attr_reader :values
 
-    # Public: The thing we want to know if a feature is enabled for.
-    attr_reader :thing
+    # Public: The actors we want to know if a feature is enabled for.
+    attr_reader :actors
 
-    def initialize(options = {})
-      @feature_name = options.fetch(:feature_name)
-      @values = options.fetch(:values)
-      @thing = options.fetch(:thing)
+    def initialize(feature_name:, values:, actors:)
+      @feature_name = feature_name
+      @values = values
+      @actors = actors
+    end
+
+    def actors?
+      !@actors.nil? && !@actors.empty?
     end
 
     # Public: Convenience method for groups value like Feature has.

data/lib/flipper/gate.rb

@@ -18,28 +18,29 @@ module Flipper
       raise 'Not implemented'
     end
 
-    def enabled?(_value)
+    def enabled?(value)
       raise 'Not implemented'
     end
 
-    # Internal: Check if a gate is open for a thing. Implemented in subclass.
+    # Internal: Check if a gate is open for one or more actors. Implemented
+    # in subclass.
     #
-    # Returns true if gate open for thing, false if not.
-    def open?(_thing, _value, _options = {})
+    # Returns true if gate open for any actor, false if not.
+    def open?(context)
       false
     end
 
-    # Internal: Check if a gate is protects a thing. Implemented in subclass.
+    # Internal: Check if a gate is protects an actor. Implemented in subclass.
     #
-    # Returns true if gate protects thing, false if not.
-    def protects?(_thing)
+    # Returns true if gate protects actor, false if not.
+    def protects?(actor)
       false
     end
 
-    # Internal: Allows gate to wrap thing using one of the supported flipper
-    # types so adapters always get something that responds to value.
-    def wrap(thing)
-      thing
+    # Internal: Allows gate to wrap actor using one of the supported flipper
+    # types so adapters always get someactor that responds to value.
+    def wrap(actor)
+      actor
     end
 
     # Public: Pretty string version for debugging.
@@ -59,3 +60,4 @@ require 'flipper/gates/boolean'
 require 'flipper/gates/group'
 require 'flipper/gates/percentage_of_actors'
 require 'flipper/gates/percentage_of_time'
+require 'flipper/gates/expression'

data/lib/flipper/gate_values.rb

@@ -3,19 +3,10 @@ require 'flipper/typecast'
 
 module Flipper
   class GateValues
-    # Private: Array of instance variables that are readable through the []
-    # instance method.
-    LegitIvars = {
-      'boolean' => '@boolean',
-      'actors' => '@actors',
-      'groups' => '@groups',
-      'percentage_of_time' => '@percentage_of_time',
-      'percentage_of_actors' => '@percentage_of_actors',
-    }.freeze
-
     attr_reader :boolean
     attr_reader :actors
     attr_reader :groups
+    attr_reader :expression
     attr_reader :percentage_of_actors
     attr_reader :percentage_of_time
 
@@ -23,14 +14,9 @@ module Flipper
       @boolean = Typecast.to_boolean(adapter_values[:boolean])
       @actors = Typecast.to_set(adapter_values[:actors])
       @groups = Typecast.to_set(adapter_values[:groups])
-      @percentage_of_actors = Typecast.to_percentage(adapter_values[:percentage_of_actors])
-      @percentage_of_time = Typecast.to_percentage(adapter_values[:percentage_of_time])
-    end
-
-    def [](key)
-      if ivar = LegitIvars[key.to_s]
-        instance_variable_get(ivar)
-      end
+      @expression = adapter_values[:expression]
+      @percentage_of_actors = Typecast.to_number(adapter_values[:percentage_of_actors])
+      @percentage_of_time = Typecast.to_number(adapter_values[:percentage_of_time])
     end
 
     def eql?(other)
@@ -38,6 +24,7 @@ module Flipper
         boolean == other.boolean &&
         actors == other.actors &&
         groups == other.groups &&
+        expression == other.expression &&
         percentage_of_actors == other.percentage_of_actors &&
         percentage_of_time == other.percentage_of_time
     end

data/lib/flipper/gates/actor.rb

@@ -19,30 +19,23 @@ module Flipper
         !value.empty?
       end
 
-      # Internal: Checks if the gate is open for a thing.
+      # Internal: Checks if the gate is open for an actor.
       #
-      # Returns true if gate open for thing, false if not.
+      # Returns true if gate open for actor, false if not.
       def open?(context)
-        value = context.values[key]
-        if context.thing.nil?
-          false
-        else
-          if protects?(context.thing)
-            actor = wrap(context.thing)
-            enabled_actor_ids = value
-            enabled_actor_ids.include?(actor.value)
-          else
-            false
-          end
+        return false unless context.actors?
+
+        context.actors.any? do |actor|
+          context.values.actors.include?(actor.value)
         end
       end
 
-      def wrap(thing)
-        Types::Actor.wrap(thing)
+      def wrap(actor)
+        Types::Actor.wrap(actor)
       end
 
-      def protects?(thing)
-        Types::Actor.wrappable?(thing)
+      def protects?(actor)
+        Types::Actor.wrappable?(actor)
       end
     end
   end

data/lib/flipper/gates/boolean.rb

@@ -24,7 +24,7 @@ module Flipper
       # Returns true if explicitly set to true, false if explicitly set to false
       # or nil if not explicitly set.
       def open?(context)
-        context.values[key]
+        context.values.boolean
       end
 
       def wrap(thing)

data/lib/flipper/gates/expression.rb

@@ -0,0 +1,75 @@
+require "flipper/expression"
+
+module Flipper
+  module Gates
+    class Expression < Gate
+      # Internal: The name of the gate. Used for instrumentation, etc.
+      def name
+        :expression
+      end
+
+      # Internal: Name converted to value safe for adapter.
+      def key
+        :expression
+      end
+
+      def data_type
+        :json
+      end
+
+      def enabled?(value)
+        !value.nil? && !value.empty?
+      end
+
+      # Internal: Checks if the gate is open for a thing.
+      #
+      # Returns true if gate open for thing, false if not.
+      def open?(context)
+        data = context.values.expression
+        return false if data.nil? || data.empty?
+        expression = Flipper::Expression.build(data)
+
+        if context.actors.nil? || context.actors.empty?
+          !!expression.evaluate(feature_name: context.feature_name, properties: DEFAULT_PROPERTIES)
+        else
+          context.actors.any? do |actor|
+            !!expression.evaluate(feature_name: context.feature_name, properties: properties(actor))
+          end
+        end
+      end
+
+      def protects?(thing)
+        thing.is_a?(Flipper::Expression) || thing.is_a?(Hash)
+      end
+
+      def wrap(thing)
+        Flipper::Expression.build(thing)
+      end
+
+      private
+
+      # Internal
+      DEFAULT_PROPERTIES = {}.freeze
+
+      def properties(actor)
+        return DEFAULT_PROPERTIES if actor.nil?
+
+        properties = {}
+
+        if actor.respond_to?(:flipper_properties)
+          properties.update(actor.flipper_properties)
+        else
+          warn "#{actor.inspect} does not respond to `flipper_properties` but should."
+        end
+
+        properties.transform_keys!(&:to_s)
+
+        if actor.respond_to?(:flipper_id)
+          properties["flipper_id".freeze] = actor.flipper_id
+        end
+
+        properties
+      end
+    end
+  end
+end

data/lib/flipper/gates/group.rb

@@ -23,13 +23,11 @@ module Flipper
       #
       # Returns true if gate open for thing, false if not.
       def open?(context)
-        value = context.values[key]
-        if context.thing.nil?
-          false
-        else
-          value.any? do |name|
-            group = Flipper.group(name)
-            group.match?(context.thing, context)
+        return false unless context.actors?
+
+        context.values.groups.any? do |name|
+          context.actors.any? do |actor|
+            Flipper.group(name).match?(actor, context)
           end
         end
       end

data/lib/flipper/gates/percentage_of_actors.rb

@@ -21,21 +21,18 @@ module Flipper
         value > 0
       end
 
-      # Internal: Checks if the gate is open for a thing.
+      # Private: this constant is used to support up to 3 decimal places
+      # in percentages.
+      SCALING_FACTOR = 1_000
+      private_constant :SCALING_FACTOR
+
+      # Internal: Checks if the gate is open for one or more actors.
       #
-      # Returns true if gate open for thing, false if not.
+      # Returns true if gate open for any actors, false if not.
       def open?(context)
-        percentage = context.values[key]
-
-        if Types::Actor.wrappable?(context.thing)
-          actor = Types::Actor.wrap(context.thing)
-          id = "#{context.feature_name}#{actor.value}"
-          # this is to support up to 3 decimal places in percentages
-          scaling_factor = 1_000
-          Zlib.crc32(id) % (100 * scaling_factor) < percentage * scaling_factor
-        else
-          false
-        end
+        return false unless context.actors?
+        id = "#{context.feature_name}#{context.actors.map(&:value).sort.join}"
+        Zlib.crc32(id) % (100 * SCALING_FACTOR) < context.values.percentage_of_actors * SCALING_FACTOR
       end
 
       def protects?(thing)

data/lib/flipper/gates/percentage_of_time.rb

@@ -23,8 +23,7 @@ module Flipper
       #
       # Returns true if gate open for thing, false if not.
       def open?(context)
-        value = context.values[key]
-        rand < (value / 100.0)
+        rand < (context.values.percentage_of_time / 100.0)
       end
 
       def protects?(thing)

data/lib/flipper/identifier.rb

@@ -6,8 +6,8 @@ module Flipper
   #   end
   #
   #   user = User.new(99)
-  #   Flipper.enable :thing, user
-  #   Flipper.enabled? :thing, user #=> true
+  #   Flipper.enable :some_feature, user
+  #   Flipper.enabled? :some_feature, user #=> true
   #
   module Identifier
     def flipper_id

data/lib/flipper/instrumentation/log_subscriber.rb

@@ -1,4 +1,5 @@
 require 'securerandom'
+require 'active_support/gem_version'
 require 'active_support/notifications'
 require 'active_support/log_subscriber'
 
@@ -10,7 +11,7 @@ module Flipper
       # Example Output
       #
       #   flipper[:search].enabled?(user)
-      #   # Flipper feature(search) enabled? false (1.2ms)  [ thing=... ]
+      #   # Flipper feature(search) enabled? false (1.2ms)  [ actors=... ]
       #
       # Returns nothing.
       def feature_operation(event)
@@ -20,15 +21,19 @@ module Flipper
         gate_name = event.payload[:gate_name]
         operation = event.payload[:operation]
         result = event.payload[:result]
-        thing = event.payload[:thing]
 
         description = "Flipper feature(#{feature_name}) #{operation} #{result.inspect}"
-        details = "thing=#{thing.inspect}"
+
+        details = if event.payload.key?(:actors)
+          "actors=#{event.payload[:actors].inspect}"
+        else
+          "thing=#{event.payload[:thing].inspect}"
+        end
 
         details += " gate_name=#{gate_name}" unless gate_name.nil?
 
         name = '%s (%.1fms)' % [description, event.duration]
-        debug "  #{color(name, CYAN, true)}  [ #{details} ]"
+        debug "  #{color_name(name)}  [ #{details} ]"
       end
 
       # Logs an adapter operation. If operation is for a feature, then that
@@ -48,11 +53,10 @@ module Flipper
 
         feature_name = event.payload[:feature_name]
         adapter_name = event.payload[:adapter_name]
-        gate_name = event.payload[:gate_name]
         operation = event.payload[:operation]
         result = event.payload[:result]
 
-        description = 'Flipper '
+        description = String.new('Flipper ')
         description << "feature(#{feature_name}) " unless feature_name.nil?
         description << "adapter(#{adapter_name}) "
         description << "#{operation} "
@@ -60,14 +64,37 @@ module Flipper
         details = "result=#{result.inspect}"
 
         name = '%s (%.1fms)' % [description, event.duration]
-        debug "  #{color(name, CYAN, true)}  [ #{details} ]"
+        debug "  #{color_name(name)}  [ #{details} ]"
       end
 
       def logger
         self.class.logger
       end
+
+      def self.attach
+        attach_to InstrumentationNamespace
+      end
+
+      def self.detach
+        # Rails 5.2 doesn't support this, that's fine
+        detach_from InstrumentationNamespace if respond_to?(:detach_from)
+      end
+
+      private
+
+      # Rails 7.1 changed the signature of this function.
+      COLOR_OPTIONS = if Gem::Requirement.new(">=7.1").satisfied_by?(ActiveSupport.gem_version)
+        { bold: true }.freeze
+      else
+        true
+      end
+      private_constant :COLOR_OPTIONS
+
+      def color_name(name)
+        color(name, CYAN, COLOR_OPTIONS)
+      end
     end
   end
 
-  Instrumentation::LogSubscriber.attach_to InstrumentationNamespace
+  Instrumentation::LogSubscriber.attach
 end