flipper 1.0.0 → 1.1.0

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

@@ -120,6 +120,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 +182,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 +295,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 +306,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 +401,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

@@ -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/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/middleware/memoizer.rb

@@ -20,6 +20,14 @@ module Flipper
       #   # using with preload specific features
       #   use Flipper::Middleware::Memoizer, preload: [:stats, :search, :some_feature]
       #
+      #   # using with preload block that returns true/false
+      #   use Flipper::Middleware::Memoizer, preload: ->(request) { !request.path.start_with?('/assets') }
+      #
+      #   # using with preload block that returns specific features
+      #   use Flipper::Middleware::Memoizer, preload: ->(request) {
+      #     request.path.starts_with?('/admin') ? [:stats, :search] : false
+      #   }
+      #
       def initialize(app, opts = {})
         if opts.is_a?(Flipper::DSL) || opts.is_a?(Proc)
           raise 'Flipper::Middleware::Memoizer no longer initializes with a flipper instance or block. Read more at: https://git.io/vSo31.'
@@ -34,7 +42,7 @@ module Flipper
         request = Rack::Request.new(env)
 
         if memoize?(request)
-          memoized_call(env)
+          memoized_call(request)
         else
           @app.call(env)
         end
@@ -52,26 +60,34 @@ module Flipper
         end
       end
 
-      def memoized_call(env)
-        reset_on_body_close = false
-        flipper = env.fetch(@env_key) { Flipper }
+      def memoized_call(request)
+        flipper = request.env.fetch(@env_key) { Flipper }
 
         # Already memoizing. This instance does not need to do anything.
         if flipper.memoizing?
           warn "Flipper::Middleware::Memoizer appears to be running twice. Read how to resolve this at https://github.com/flippercloud/flipper/pull/523"
-          return @app.call(env)
+          return @app.call(request.env)
         end
 
-        flipper.memoize = true
+        begin
+          flipper.memoize = true
 
-        case @opts[:preload]
-        when true then flipper.preload_all
-        when Array then flipper.preload(@opts[:preload])
-        end
+          # Preloading is pointless without memoizing.
+          preload = if @opts[:preload].respond_to?(:call)
+            @opts[:preload].call(request)
+          else
+            @opts[:preload]
+          end
 
-        @app.call(env)
-      ensure
-        flipper.memoize = false if flipper
+          case preload
+          when true then flipper.preload_all
+          when Array then flipper.preload(preload)
+          end
+
+          @app.call(request.env)
+        ensure
+          flipper.memoize = false
+        end
       end
     end
   end

data/lib/flipper/poller.rb

@@ -17,7 +17,7 @@ module Flipper
     end
 
     def self.reset
-      instances.each {|_,poller| poller.stop }.clear
+      instances.each {|_, instance| instance.stop }.clear
     end
 
     def initialize(options = {})

data/lib/flipper/serializers/gzip.rb

@@ -0,0 +1,24 @@
+require "zlib"
+require "stringio"
+
+module Flipper
+  module Serializers
+    module Gzip
+      module_function
+
+      def serialize(source)
+        return if source.nil?
+        output = StringIO.new
+        gz = Zlib::GzipWriter.new(output)
+        gz.write(source)
+        gz.close
+        output.string
+      end
+
+      def deserialize(source)
+        return if source.nil?
+        Zlib::GzipReader.wrap(StringIO.new(source), &:read)
+      end
+    end
+  end
+end

data/lib/flipper/serializers/json.rb

@@ -0,0 +1,19 @@
+require "json"
+
+module Flipper
+  module Serializers
+    module Json
+      module_function
+
+      def serialize(source)
+        return if source.nil?
+        JSON.generate(source)
+      end
+
+      def deserialize(source)
+        return if source.nil?
+        JSON.parse(source)
+      end
+    end
+  end
+end

data/lib/flipper/spec/shared_adapter_specs.rb

@@ -4,11 +4,12 @@ RSpec.shared_examples_for 'a flipper adapter' do
   let(:flipper) { Flipper.new(subject) }
   let(:feature) { flipper[:stats] }
 
-  let(:boolean_gate) { feature.gate(:boolean) }
-  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(:boolean_gate)    { feature.gate(:boolean) }
+  let(:expression_gate) { feature.gate(:expression) }
+  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) }
 
   before do
     Flipper.register(:admins) do |actor|
@@ -66,10 +67,27 @@ RSpec.shared_examples_for 'a flipper adapter' do
     expect(subject.enable(feature, time_gate, Flipper::Types::PercentageOfTime.new(45))).to eq(true)
 
     expect(subject.disable(feature, boolean_gate, Flipper::Types::Boolean.new(false))).to eq(true)
-
     expect(subject.get(feature)).to eq(subject.default_config)
   end
 
+  it 'can enable, disable and get value for expression gate' do
+    basic_expression = Flipper.property(:plan).eq("basic")
+    age_expression = Flipper.property(:age).gte(21)
+    any_expression = Flipper.any(basic_expression, age_expression)
+
+    expect(subject.enable(feature, expression_gate, any_expression)).to eq(true)
+    result = subject.get(feature)
+    expect(result[:expression]).to eq(any_expression.value)
+
+    expect(subject.enable(feature, expression_gate, basic_expression)).to eq(true)
+    result = subject.get(feature)
+    expect(result[:expression]).to eq(basic_expression.value)
+
+    expect(subject.disable(feature, expression_gate, basic_expression)).to eq(true)
+    result = subject.get(feature)
+    expect(result[:expression]).to be(nil)
+  end
+
   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)
@@ -256,14 +274,14 @@ RSpec.shared_examples_for 'a flipper adapter' do
     expect(subject.add(flipper[:stats])).to eq(true)
     expect(subject.enable(flipper[:stats], boolean_gate, Flipper::Types::Boolean.new)).to eq(true)
     expect(subject.add(flipper[:search])).to eq(true)
+    flipper.enable :analytics, Flipper.property(:plan).eq("pro")
 
     result = subject.get_all
-    expect(result).to be_instance_of(Hash)
 
-    stats = result["stats"]
-    search = result["search"]
-    expect(stats).to eq(subject.default_config.merge(boolean: 'true'))
-    expect(search).to eq(subject.default_config)
+    expect(result).to be_instance_of(Hash)
+    expect(result["stats"]).to eq(subject.default_config.merge(boolean: 'true'))
+    expect(result["search"]).to eq(subject.default_config)
+    expect(result["analytics"]).to eq(subject.default_config.merge(expression: {"Equal"=>[{"Property"=>["plan"]}, "pro"]}))
   end
 
   it 'includes explicitly disabled features when getting all features' do

data/lib/flipper/test/shared_adapter_test.rb

@@ -7,6 +7,7 @@ module Flipper
         @feature = @flipper[:stats]
         @boolean_gate = @feature.gate(:boolean)
         @group_gate = @feature.gate(:group)
+        @expression_gate = @feature.gate(:expression)
         @actor_gate = @feature.gate(:actor)
         @actors_gate = @feature.gate(:percentage_of_actors)
         @time_gate = @feature.gate(:percentage_of_time)
@@ -65,6 +66,24 @@ module Flipper
         assert_equal @adapter.default_config, @adapter.get(@feature)
       end
 
+      def test_can_enable_disable_and_get_value_for_expression_gate
+        basic_expression = Flipper.property(:plan).eq("basic")
+        age_expression = Flipper.property(:age).gte(21)
+        any_expression = Flipper.any(basic_expression, age_expression)
+
+        assert_equal true, @adapter.enable(@feature, @expression_gate, any_expression)
+        result = @adapter.get(@feature)
+        assert_equal any_expression.value, result[:expression]
+
+        assert_equal true, @adapter.enable(@feature, @expression_gate, basic_expression)
+        result = @adapter.get(@feature)
+        assert_equal basic_expression.value, result[:expression]
+
+        assert_equal true, @adapter.disable(@feature, @expression_gate, basic_expression)
+        result = @adapter.get(@feature)
+        assert_nil result[:expression]
+      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))
@@ -252,14 +271,14 @@ module Flipper
         assert @adapter.add(@flipper[:stats])
         assert @adapter.enable(@flipper[:stats], @boolean_gate, Flipper::Types::Boolean.new)
         assert @adapter.add(@flipper[:search])
+        @flipper.enable :analytics, Flipper.property(:plan).eq("pro")
 
         result = @adapter.get_all
-        assert_instance_of Hash, result
 
-        stats = result["stats"]
-        search = result["search"]
-        assert_equal @adapter.default_config.merge(boolean: 'true'), stats
-        assert_equal @adapter.default_config, search
+        assert_instance_of Hash, result
+        assert_equal @adapter.default_config.merge(boolean: 'true'), result["stats"]
+        assert_equal @adapter.default_config, result["search"]
+        assert_equal @adapter.default_config.merge(expression: {"Equal"=>[{"Property"=>["plan"]}, "pro"]}), result["analytics"]
       end
 
       def test_includes_explicitly_disabled_features_when_getting_all_features

data/lib/flipper/typecast.rb

@@ -1,4 +1,6 @@
 require 'set'
+require "flipper/serializers/json"
+require "flipper/serializers/gzip"
 
 module Flipper
   module Typecast
@@ -36,17 +38,25 @@ module Flipper
       raise ArgumentError, "#{value.inspect} cannot be converted to a float"
     end
 
-    # Internal: Convert value to a percentage.
+    # Internal: Convert value to a number.
     #
     # Returns a Integer or Float representation of the value.
     # Raises ArgumentError if conversion is not possible.
-    def self.to_percentage(value)
-      result_to_f = value.to_f
-      result_to_i = result_to_f.to_i
-      result_to_f == result_to_i ? result_to_i : result_to_f
+    def self.to_number(value)
+      case value
+      when Numeric
+        value
+      when String
+        value.include?('.') ? to_float(value) : to_integer(value)
+      when NilClass
+        0
+      else
+        value.to_f
+      end
     rescue NoMethodError
-      raise ArgumentError, "#{value.inspect} cannot be converted to a percentage"
+      raise ArgumentError, "#{value.inspect} cannot be converted to a number"
     end
+    singleton_class.send(:alias_method, :to_percentage, :to_number)
 
     # Internal: Convert value to a set.
     #
@@ -71,6 +81,8 @@ module Flipper
           normalized_value = case value
           when Array, Set
             value.to_set
+          when Hash
+            value
           else
             value ? value.to_s : value
           end
@@ -79,5 +91,21 @@ module Flipper
       end
       normalized_source
     end
+
+    def self.to_json(source)
+      Serializers::Json.serialize(source)
+    end
+
+    def self.from_json(source)
+      Serializers::Json.deserialize(source)
+    end
+
+    def self.to_gzip(source)
+      Serializers::Gzip.serialize(source)
+    end
+
+    def self.from_gzip(source)
+      Serializers::Gzip.deserialize(source)
+    end
   end
 end

data/lib/flipper/types/percentage.rb

@@ -4,7 +4,7 @@ module Flipper
   module Types
     class Percentage < Type
       def initialize(value)
-        value = Typecast.to_percentage(value)
+        value = Typecast.to_number(value)
 
         if value < 0 || value > 100
           raise ArgumentError,

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end