flipper 1.0.0 → 1.3.6

data/lib/flipper/expression.rb

@@ -0,0 +1,71 @@
+require "flipper/expression/builder"
+require "flipper/expression/constant"
+
+module Flipper
+  class Expression
+    include Builder
+
+    def self.build(object)
+      return object if object.is_a?(self) || object.is_a?(Constant)
+
+      case object
+      when Hash
+        name = object.keys.first
+        args = object.values.first
+        unless name
+          raise ArgumentError, "#{object.inspect} cannot be converted into an expression"
+        end
+
+        new(name, Array(args).map { |o| build(o) })
+      when String, Numeric, FalseClass, TrueClass
+        Expression::Constant.new(object)
+      when Symbol
+        Expression::Constant.new(object.to_s)
+      else
+        raise ArgumentError, "#{object.inspect} cannot be converted into an expression"
+      end
+    end
+
+    # Use #build
+    private_class_method :new
+
+    attr_reader :name, :function, :args
+
+    def initialize(name, args = [])
+      @name = name.to_s
+      @function = Expressions.const_get(name)
+      @args = args
+    end
+
+    def evaluate(context = {})
+      if call_with_context?
+        function.call(*args.map {|arg| arg.evaluate(context) }, context: context)
+      else
+        function.call(*args.map {|arg| arg.evaluate(context) })
+      end
+    end
+
+    def eql?(other)
+      other.is_a?(self.class) && @function == other.function && @args == other.args
+    end
+    alias_method :==, :eql?
+
+    def value
+      {
+        name => args.map(&:value)
+      }
+    end
+
+    private
+
+    def call_with_context?
+      function.method(:call).parameters.any? do |type, name|
+        name == :context && [:key, :keyreq].include?(type)
+      end
+    end
+  end
+end
+
+Dir[File.join(File.dirname(__FILE__), 'expressions', '*.rb')].sort.each do |file|
+  require "flipper/expressions/#{File.basename(file, '.rb')}"
+end

data/lib/flipper/expressions/all.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Expressions
+    class All
+      def self.call(*args)
+        args.all?
+      end
+    end
+  end
+end

data/lib/flipper/expressions/any.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Expressions
+    class Any
+      def self.call(*args)
+        args.any?
+      end
+    end
+  end
+end

data/lib/flipper/expressions/boolean.rb

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

data/lib/flipper/expressions/comparable.rb

@@ -0,0 +1,13 @@
+module Flipper
+  module Expressions
+    class Comparable
+      def self.operator
+        raise NotImplementedError
+      end
+
+      def self.call(left, right)
+        left.respond_to?(operator) && right.respond_to?(operator) && left.public_send(operator, right)
+      end
+    end
+  end
+end

data/lib/flipper/expressions/duration.rb

@@ -0,0 +1,28 @@
+module Flipper
+  module Expressions
+    class Duration
+      SECONDS_PER = {
+        "second" => 1,
+        "minute" => 60,
+        "hour" => 3600,
+        "day" => 86400,
+        "week" => 604_800,
+        "month" => 2_629_746,  # 1/12 of a gregorian year
+        "year" => 31_556_952 # length of a gregorian year (365.2425 days)
+      }.freeze
+
+      def self.call(scalar, unit = 'second')
+        unit = unit.to_s.downcase.chomp("s")
+
+        unless scalar.is_a?(Numeric)
+          raise ArgumentError.new("Duration value must be a number but was #{scalar.inspect}")
+        end
+        unless SECONDS_PER[unit]
+          raise ArgumentError.new("Duration unit #{unit.inspect} must be one of: #{SECONDS_PER.keys.join(', ')}")
+        end
+
+        scalar * SECONDS_PER[unit]
+      end
+    end
+  end
+end

data/lib/flipper/expressions/equal.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Expressions
+    class Equal < Comparable
+      def self.operator
+        :==
+      end
+    end
+  end
+end

data/lib/flipper/expressions/greater_than.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Expressions
+    class GreaterThan < Comparable
+      def self.operator
+        :>
+      end
+    end
+  end
+end

data/lib/flipper/expressions/greater_than_or_equal_to.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Expressions
+    class GreaterThanOrEqualTo < Comparable
+      def self.operator
+        :>=
+      end
+    end
+  end
+end

data/lib/flipper/expressions/less_than.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Expressions
+    class LessThan < Comparable
+      def self.operator
+        :<
+      end
+    end
+  end
+end

data/lib/flipper/expressions/less_than_or_equal_to.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Expressions
+    class LessThanOrEqualTo < Comparable
+      def self.operator
+        :<=
+      end
+    end
+  end
+end

data/lib/flipper/expressions/not_equal.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Expressions
+    class NotEqual < Comparable
+      def self.operator
+        :!=
+      end
+    end
+  end
+end

data/lib/flipper/expressions/now.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Expressions
+    class Now
+      def self.call
+        ::Time.now.utc
+      end
+    end
+  end
+end

data/lib/flipper/expressions/number.rb

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

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

@@ -100,7 +100,14 @@ module Flipper
     #
     # Returns true if enabled, false if not.
     def enabled?(*actors)
-      actors = actors.flatten.compact.map { |actor| Types::Actor.wrap(actor) }
+      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
@@ -120,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
@@ -160,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
@@ -252,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.
@@ -259,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.
@@ -347,6 +408,7 @@ module Flipper
     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,

data/lib/flipper/gate.rb

@@ -26,7 +26,7 @@ module Flipper
     # in subclass.
     #
     # Returns true if gate open for any actor, false if not.
-    def open?(actors, value, options = {})
+    def open?(context)
       false
     end
 
@@ -60,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

@@ -6,6 +6,7 @@ module Flipper
     attr_reader :boolean
     attr_reader :actors
     attr_reader :groups
+    attr_reader :expression
     attr_reader :percentage_of_actors
     attr_reader :percentage_of_time
 
@@ -13,8 +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])
+      @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)
@@ -22,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/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/instrumentation/log_subscriber.rb

@@ -1,4 +1,5 @@
 require 'securerandom'
+require 'active_support/gem_version'
 require 'active_support/notifications'
 require 'active_support/log_subscriber'
 
@@ -52,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} "
@@ -71,11 +71,19 @@ module Flipper
         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.
-      # Checking if > 7.0.99 rather than >= 7.1 so that 7.1 pre-release versions are included.
-      COLOR_OPTIONS = if Rails.gem_version > Gem::Version.new('7.0.99')
+      COLOR_OPTIONS = if Gem::Requirement.new(">=7.1").satisfied_by?(ActiveSupport.gem_version)
         { bold: true }.freeze
       else
         true
@@ -88,5 +96,5 @@ module Flipper
     end
   end
 
-  Instrumentation::LogSubscriber.attach_to InstrumentationNamespace
+  Instrumentation::LogSubscriber.attach
 end

data/lib/flipper/instrumentation/statsd.rb

@@ -2,5 +2,7 @@ require 'securerandom'
 require 'active_support/notifications'
 require 'flipper/instrumentation/statsd_subscriber'
 
-ActiveSupport::Notifications.subscribe /\.flipper$/,
-                                       Flipper::Instrumentation::StatsdSubscriber
+ActiveSupport::Notifications.subscribe(
+  /\.flipper$/,
+  Flipper::Instrumentation::StatsdSubscriber
+)

data/lib/flipper/instrumentation/statsd_subscriber.rb

@@ -12,13 +12,11 @@ module Flipper
       end
 
       def update_timer(metric)
-        if self.class.client
-          self.class.client.timing metric, (@duration * 1_000).round
-        end
+        self.class.client&.timing metric, (@duration * 1_000).round
       end
 
       def update_counter(metric)
-        self.class.client.increment metric if self.class.client
+        self.class.client&.increment metric
       end
     end
   end

data/lib/flipper/instrumentation/subscriber.rb

@@ -42,7 +42,6 @@ module Flipper
       # Private
       def update_feature_operation_metrics
         feature_name = @payload[:feature_name]
-        gate_name = @payload[:gate_name]
         operation = strip_trailing_question_mark(@payload[:operation])
         result = @payload[:result]
 
@@ -64,9 +63,6 @@ module Flipper
       def update_adapter_operation_metrics
         adapter_name = @payload[:adapter_name]
         operation = @payload[:operation]
-        result = @payload[:result]
-        value = @payload[:value]
-        key = @payload[:key]
 
         update_timer "flipper.adapter.#{adapter_name}.#{operation}"
       end

data/lib/flipper/metadata.rb

@@ -1,9 +1,12 @@
+require_relative './version'
+
 module Flipper
   METADATA = {
     "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/blob/main/Changelog.md",
+    "changelog_uri"     => "https://github.com/flippercloud/flipper/releases/tag/v#{Flipper::VERSION}",
+    "funding_uri"       => "https://github.com/sponsors/flippercloud",
   }.freeze
 end