flipper 1.0.0 → 1.1.0

data/lib/flipper/adapter_builder.rb

@@ -0,0 +1,44 @@
+module Flipper
+  # Builds an adapter from a stack of adapters.
+  #
+  #   adapter = Flipper::AdapterBuilder.new do
+  #     use Flipper::Adapters::Strict
+  #     use Flipper::Adapters::Memoizer
+  #     store Flipper::Adapters::Memory
+  #   end.to_adapter
+  #
+  class AdapterBuilder
+    def initialize(&block)
+      @stack = []
+
+      # Default to memory adapter
+      store Flipper::Adapters::Memory
+
+      block.arity == 0 ? instance_eval(&block) : block.call(self) if block
+    end
+
+    if RUBY_VERSION >= '3.0'
+      def use(klass, *args, **kwargs, &block)
+        @stack.push ->(adapter) { klass.new(adapter, *args, **kwargs, &block) }
+      end
+    else
+      def use(klass, *args, &block)
+        @stack.push ->(adapter) { klass.new(adapter, *args, &block) }
+      end
+    end
+
+    if RUBY_VERSION >= '3.0'
+      def store(adapter, *args, **kwargs, &block)
+        @store = adapter.respond_to?(:call) ? adapter : -> { adapter.new(*args, **kwargs, &block) }
+      end
+    else
+      def store(adapter, *args, &block)
+        @store = adapter.respond_to?(:call) ? adapter : -> { adapter.new(*args, &block) }
+      end
+    end
+
+    def to_adapter
+      @stack.reverse.inject(@store.call) { |adapter, wrapper| wrapper.call(adapter) }
+    end
+  end
+end

data/lib/flipper/adapters/dual_write.rb

@@ -3,8 +3,7 @@ module Flipper
     class DualWrite
       include ::Flipper::Adapter
 
-      # Public: The name of the adapter.
-      attr_reader :name, :local, :remote
+      attr_reader :local, :remote
 
       # Public: Build a new sync instance.
       #
@@ -12,7 +11,6 @@ module Flipper
       # remote - The remote flipper adapter that writes should go to first (in
       #          addition to the local adapter).
       def initialize(local, remote, options = {})
-        @name = :dual_write
         @local = local
         @remote = remote
       end

data/lib/flipper/adapters/failover.rb

@@ -3,9 +3,6 @@ module Flipper
     class Failover
       include ::Flipper::Adapter
 
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Public: Build a new failover instance.
       #
       # primary   - The primary flipper adapter.
@@ -17,7 +14,6 @@ module Flipper
       #             :errors - Array of exception types for which to failover
 
       def initialize(primary, secondary, options = {})
-        @name = :failover
         @primary = primary
         @secondary = secondary
 

data/lib/flipper/adapters/failsafe.rb

@@ -3,9 +3,6 @@ module Flipper
     class Failsafe
       include ::Flipper::Adapter
 
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Public: Build a new Failsafe instance.
       #
       # adapter   - Flipper adapter to guard.
@@ -15,7 +12,6 @@ module Flipper
       def initialize(adapter, options = {})
         @adapter = adapter
         @errors = options.fetch(:errors, [StandardError])
-        @name = :failsafe
       end
 
       def features

data/lib/flipper/adapters/http/client.rb

@@ -14,6 +14,12 @@ module Flipper
 
         HTTPS_SCHEME = "https".freeze
 
+        CLIENT_FRAMEWORKS = {
+          rails: -> { Rails.version if defined?(Rails) },
+          sinatra: -> { Sinatra::VERSION if defined?(Sinatra) },
+          hanami: -> { Hanami::VERSION if defined?(Hanami) },
+        }
+
         attr_reader :uri, :headers
         attr_reader :basic_auth_username, :basic_auth_password
         attr_reader :read_timeout, :open_timeout, :write_timeout, :max_retries, :debug_output
@@ -30,6 +36,10 @@ module Flipper
           @debug_output = options[:debug_output]
         end
 
+        def add_header(key, value)
+          @headers[key] = value
+        end
+
         def get(path)
           perform Net::HTTP::Get, path, @headers
         end
@@ -77,18 +87,23 @@ module Flipper
 
         def build_request(http_method, uri, headers, options)
           request_headers = {
-            "Client-Language" => "ruby",
-            "Client-Language-Version" => "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
-            "Client-Platform" => RUBY_PLATFORM,
-            "Client-Engine" => defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
-            "Client-Pid" => Process.pid.to_s,
-            "Client-Thread" => Thread.current.object_id.to_s,
-            "Client-Hostname" => Socket.gethostname,
+            client_language: "ruby",
+            client_language_version: "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
+            client_platform: RUBY_PLATFORM,
+            client_engine: defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
+            client_pid: Process.pid.to_s,
+            client_thread: Thread.current.object_id.to_s,
+            client_hostname: Socket.gethostname,
           }.merge(headers)
 
           body = options[:body]
           request = http_method.new(uri.request_uri)
           request.initialize_http_header(request_headers)
+
+          client_frameworks.each do |framework, version|
+            request.add_field("Client-Framework", [framework, version].join("="))
+          end
+
           request.body = body if body
 
           if @basic_auth_username && @basic_auth_password
@@ -97,6 +112,10 @@ module Flipper
 
           request
         end
+
+        def client_frameworks
+          CLIENT_FRAMEWORKS.transform_values { |detect| detect.call rescue nil }.compact
+        end
       end
     end
   end

data/lib/flipper/adapters/http/error.rb

@@ -11,7 +11,7 @@ module Flipper
           message = "Failed with status: #{response.code}"
 
           begin
-            data = JSON.parse(response.body)
+            data = Typecast.from_json(response.body)
 
             if error_message = data["message"]
               message << "\n\n#{data["message"]}"

data/lib/flipper/adapters/http.rb

@@ -10,7 +10,7 @@ module Flipper
     class Http
       include Flipper::Adapter
 
-      attr_reader :name, :client
+      attr_reader :client
 
       def initialize(options = {})
         @client = Client.new(url: options.fetch(:url),
@@ -22,13 +22,12 @@ module Flipper
                              write_timeout: options[:write_timeout],
                              max_retries: options[:max_retries],
                              debug_output: options[:debug_output])
-        @name = :http
       end
 
       def get(feature)
         response = @client.get("/features/#{feature.key}")
         if response.is_a?(Net::HTTPOK)
-          parsed_response = JSON.parse(response.body)
+          parsed_response = Typecast.from_json(response.body)
           result_for_feature(feature, parsed_response.fetch('gates'))
         elsif response.is_a?(Net::HTTPNotFound)
           default_config
@@ -42,7 +41,7 @@ module Flipper
         response = @client.get("/features?keys=#{csv_keys}&exclude_gate_names=true")
         raise Error, response unless response.is_a?(Net::HTTPOK)
 
-        parsed_response = JSON.parse(response.body)
+        parsed_response = Typecast.from_json(response.body)
         parsed_features = parsed_response.fetch('features')
         gates_by_key = parsed_features.each_with_object({}) do |parsed_feature, hash|
           hash[parsed_feature['key']] = parsed_feature['gates']
@@ -60,7 +59,7 @@ module Flipper
         response = @client.get("/features?exclude_gate_names=true")
         raise Error, response unless response.is_a?(Net::HTTPOK)
 
-        parsed_response = JSON.parse(response.body)
+        parsed_response = Typecast.from_json(response.body)
         parsed_features = parsed_response.fetch('features')
         gates_by_key = parsed_features.each_with_object({}) do |parsed_feature, hash|
           hash[parsed_feature['key']] = parsed_feature['gates']
@@ -68,7 +67,7 @@ module Flipper
         end
 
         result = {}
-        gates_by_key.keys.each do |key|
+        gates_by_key.each_key do |key|
           feature = Feature.new(key, self)
           result[feature.key] = result_for_feature(feature, gates_by_key[feature.key])
         end
@@ -79,7 +78,7 @@ module Flipper
         response = @client.get('/features?exclude_gate_names=true')
         raise Error, response unless response.is_a?(Net::HTTPOK)
 
-        parsed_response = JSON.parse(response.body)
+        parsed_response = Typecast.from_json(response.body)
         parsed_response['features'].map { |feature| feature['key'] }.to_set
       end
 
@@ -97,7 +96,7 @@ module Flipper
       end
 
       def enable(feature, gate, thing)
-        body = request_body_for_gate(gate, thing.value.to_s)
+        body = request_body_for_gate(gate, thing.value)
         query_string = gate.key == :groups ? "?allow_unregistered_groups=true" : ""
         response = @client.post("/features/#{feature.key}/#{gate.key}#{query_string}", body)
         raise Error, response unless response.is_a?(Net::HTTPOK)
@@ -105,7 +104,7 @@ module Flipper
       end
 
       def disable(feature, gate, thing)
-        body = request_body_for_gate(gate, thing.value.to_s)
+        body = request_body_for_gate(gate, thing.value)
         query_string = gate.key == :groups ? "?allow_unregistered_groups=true" : ""
         response = case gate.key
         when :percentage_of_actors, :percentage_of_time
@@ -138,11 +137,13 @@ module Flipper
         when :boolean
           {}
         when :groups
-          { name: value }
+          { name: value.to_s }
         when :actors
-          { flipper_id: value }
+          { flipper_id: value.to_s }
         when :percentage_of_actors, :percentage_of_time
-          { percentage: value }
+          { percentage: value.to_s }
+        when :expression
+          value
         else
           raise "#{gate.key} is not a valid flipper gate key"
         end
@@ -166,13 +167,17 @@ module Flipper
         case gate.data_type
         when :boolean, :integer
           value ? value.to_s : value
+        when :json
+          value
         when :set
           value ? value.to_set : Set.new
         else
-          unsupported_data_type(gate.data_type)
+          unsupported_data_type gate.data_type
         end
       end
 
+      private
+
       def unsupported_data_type(data_type)
         raise "#{data_type} is not supported by this adapter"
       end

data/lib/flipper/adapters/instrumented.rb

@@ -13,9 +13,6 @@ module Flipper
       # Private: What is used to instrument all the things.
       attr_reader :instrumenter
 
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Internal: Initializes a new adapter instance.
       #
       # adapter - Vanilla adapter instance to wrap.
@@ -25,7 +22,6 @@ module Flipper
       #
       def initialize(adapter, options = {})
         @adapter = adapter
-        @name = :instrumented
         @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
       end
 

data/lib/flipper/adapters/memoizable.rb

@@ -8,35 +8,25 @@ module Flipper
     class Memoizable
       include ::Flipper::Adapter
 
-      FeaturesKey = :flipper_features
-      GetAllKey = :all_memoized
-
       # Internal
       attr_reader :cache
 
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Internal: The adapter this adapter is wrapping.
       attr_reader :adapter
 
-      # Private
-      def self.key_for(key)
-        "feature/#{key}"
-      end
-
       # Public
       def initialize(adapter, cache = nil)
         @adapter = adapter
-        @name = :memoizable
         @cache = cache || {}
         @memoize = false
+        @features_key = :flipper_features
+        @get_all_key = :all_memoized
       end
 
       # Public
       def features
         if memoizing?
-          cache.fetch(FeaturesKey) { cache[FeaturesKey] = @adapter.features }
+          cache.fetch(@features_key) { cache[@features_key] = @adapter.features }
         else
           @adapter.features
         end
@@ -94,9 +84,9 @@ module Flipper
       def get_all
         if memoizing?
           response = nil
-          if cache[GetAllKey]
+          if cache[@get_all_key]
             response = {}
-            cache[FeaturesKey].each do |key|
+            cache[@features_key].each do |key|
               response[key] = cache[key_for(key)]
             end
           else
@@ -104,8 +94,8 @@ module Flipper
             response.each do |key, value|
               cache[key_for(key)] = value
             end
-            cache[FeaturesKey] = response.keys.to_set
-            cache[GetAllKey] = true
+            cache[@features_key] = response.keys.to_set
+            cache[@get_all_key] = true
           end
 
           # Ensures that looking up other features that do not exist doesn't
@@ -127,6 +117,11 @@ module Flipper
         @adapter.disable(feature, gate, thing).tap { expire_feature(feature) }
       end
 
+      # Public
+      def read_only?
+        @adapter.read_only?
+      end
+
       def import(source)
         @adapter.import(source).tap { cache.clear if memoizing? }
       end
@@ -161,7 +156,7 @@ module Flipper
       private
 
       def key_for(key)
-        self.class.key_for(key)
+        "feature/#{key}"
       end
 
       def expire_feature(feature)
@@ -169,7 +164,7 @@ module Flipper
       end
 
       def expire_features_set
-        cache.delete(FeaturesKey) if memoizing?
+        cache.delete(@features_key) if memoizing?
       end
     end
   end

data/lib/flipper/adapters/memory.rb

@@ -8,15 +8,9 @@ module Flipper
     class Memory
       include ::Flipper::Adapter
 
-      FeaturesKey = :features
-
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Public
       def initialize(source = nil, threadsafe: true)
         @source = Typecast.features_hash(source)
-        @name = :memory
         @lock = Mutex.new if threadsafe
         reset
       end
@@ -77,6 +71,8 @@ module Flipper
             @source[feature.key][gate.key] = thing.value.to_s
           when :set
             @source[feature.key][gate.key] << thing.value.to_s
+          when :json
+            @source[feature.key][gate.key] = thing.value
           else
             raise "#{gate} is not supported by this adapter yet"
           end
@@ -97,6 +93,8 @@ module Flipper
             @source[feature.key][gate.key] = thing.value.to_s
           when :set
             @source[feature.key][gate.key].delete thing.value.to_s
+          when :json
+            @source[feature.key].delete(gate.key)
           else
             raise "#{gate} is not supported by this adapter yet"
           end

data/lib/flipper/adapters/operation_logger.rb

@@ -34,13 +34,9 @@ module Flipper
       # Internal: An array of the operations that have happened.
       attr_reader :operations
 
-      # Internal: The name of the adapter.
-      attr_reader :name
-
       # Public
       def initialize(adapter, operations = nil)
         @adapter = adapter
-        @name = :operation_logger
         @operations = operations || []
       end
 

data/lib/flipper/adapters/poll.rb

@@ -10,13 +10,11 @@ module Flipper
       # Deprecated
       Poller = ::Flipper::Poller
 
-      # Public: The name of the adapter.
-      attr_reader :name, :adapter, :poller
+      attr_reader :adapter, :poller
 
       def_delegators :synced_adapter, :features, :get, :get_multi, :get_all, :add, :remove, :clear, :enable, :disable
 
       def initialize(poller, adapter)
-        @name = :poll
         @adapter = adapter
         @poller = poller
         @last_synced_at = 0

data/lib/flipper/adapters/pstore.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'pstore'
 require 'set'
 require 'flipper'
@@ -9,19 +10,14 @@ module Flipper
     class PStore
       include ::Flipper::Adapter
 
-      FeaturesKey = :flipper_features
-
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Public: The path to where the file is stored.
       attr_reader :path
 
       # Public
       def initialize(path = 'flipper.pstore', thread_safe = true)
-        @name = :pstore
         @path = path
         @store = ::PStore.new(path, thread_safe)
+        @features_key = :flipper_features
       end
 
       # Public: The set of known features.
@@ -34,7 +30,7 @@ module Flipper
       # Public: Adds a feature to the set of known features.
       def add(feature)
         @store.transaction do
-          set_add FeaturesKey, feature.key
+          set_add @features_key, feature.key
         end
         true
       end
@@ -43,7 +39,7 @@ module Flipper
       # all the values for the feature.
       def remove(feature)
         @store.transaction do
-          set_delete FeaturesKey, feature.key
+          set_delete @features_key, feature.key
           clear_gates(feature)
         end
         true
@@ -88,6 +84,8 @@ module Flipper
             write key(feature, gate), thing.value.to_s
           when :set
             set_add key(feature, gate), thing.value.to_s
+          when :json
+            write key(feature, gate), Typecast.to_json(thing.value)
           else
             raise "#{gate} is not supported by this adapter yet"
           end
@@ -109,6 +107,10 @@ module Flipper
           @store.transaction do
             set_delete key(feature, gate), thing.value.to_s
           end
+        when :json
+          @store.transaction do
+            delete key(feature, gate)
+          end
         else
           raise "#{gate} is not supported by this adapter yet"
         end
@@ -135,7 +137,7 @@ module Flipper
       end
 
       def read_feature_keys
-        set_members FeaturesKey
+        set_members @features_key
       end
 
       def read_many_features(features)
@@ -150,12 +152,16 @@ module Flipper
         result = {}
 
         feature.gates.each do |gate|
+          key = key(feature, gate)
           result[gate.key] =
             case gate.data_type
             when :boolean, :integer
-              read key(feature, gate)
+              read key
             when :set
-              set_members key(feature, gate)
+              set_members key
+            when :json
+              value = read(key)
+              Typecast.from_json(value)
             else
               raise "#{gate} is not supported by this adapter yet"
             end

data/lib/flipper/adapters/read_only.rb

@@ -12,19 +12,19 @@ module Flipper
         end
       end
 
-      # Internal: The name of the adapter.
-      attr_reader :name
-
       # Public
       def initialize(adapter)
         @adapter = adapter
-        @name = :read_only
       end
 
       def features
         @adapter.features
       end
 
+      def read_only?
+        true
+      end
+
       def get(feature)
         @adapter.get(feature)
       end

data/lib/flipper/adapters/strict.rb

@@ -0,0 +1,47 @@
+module Flipper
+  module Adapters
+    # An adapter that ensures a feature exists before checking it.
+    class Strict
+      extend Forwardable
+      include ::Flipper::Adapter
+      attr_reader :name, :adapter, :handler
+
+      class NotFound < ::Flipper::Error
+        def initialize(name)
+          super "Could not find feature #{name.inspect}. Call `Flipper.add(#{name.inspect})` to create it."
+        end
+      end
+
+      HANDLERS = {
+        raise: ->(feature) { raise NotFound.new(feature.key) },
+        warn: ->(feature) { warn NotFound.new(feature.key).message },
+        noop: ->(_) { },
+      }
+
+      def_delegators :@adapter, :features, :get_all, :add, :remove, :clear, :enable, :disable
+
+      def initialize(adapter, handler = nil, &block)
+        @name = :strict
+        @adapter = adapter
+        @handler = block || HANDLERS.fetch(handler)
+      end
+
+      def get(feature)
+        assert_feature_exists(feature)
+        @adapter.get(feature)
+      end
+
+      def get_multi(features)
+        features.each { |feature| assert_feature_exists(feature) }
+        @adapter.get_multi(features)
+      end
+
+      private
+
+      def assert_feature_exists(feature)
+        @handler.call(feature) unless @adapter.features.include?(feature.key)
+      end
+
+    end
+  end
+end

data/lib/flipper/adapters/sync/feature_synchronizer.rb

@@ -9,6 +9,7 @@ module Flipper
       class FeatureSynchronizer
         extend Forwardable
 
+        def_delegator :@local_gate_values, :expression, :local_expression
         def_delegator :@local_gate_values, :boolean, :local_boolean
         def_delegator :@local_gate_values, :actors, :local_actors
         def_delegator :@local_gate_values, :groups, :local_groups
@@ -17,6 +18,7 @@ module Flipper
         def_delegator :@local_gate_values, :percentage_of_time,
                       :local_percentage_of_time
 
+        def_delegator :@remote_gate_values, :expression, :remote_expression
         def_delegator :@remote_gate_values, :boolean, :remote_boolean
         def_delegator :@remote_gate_values, :actors, :remote_actors
         def_delegator :@remote_gate_values, :groups, :remote_groups
@@ -40,8 +42,9 @@ module Flipper
             @feature.enable
           else
             @feature.disable if local_boolean_enabled?
-            sync_actors
             sync_groups
+            sync_actors
+            sync_expression
             sync_percentage_of_actors
             sync_percentage_of_time
           end
@@ -49,6 +52,12 @@ module Flipper
 
         private
 
+        def sync_expression
+          return if local_expression == remote_expression
+
+          @feature.enable_expression remote_expression
+        end
+
         def sync_actors
           remote_actors_added = remote_actors - local_actors
           remote_actors_added.each do |flipper_id|

data/lib/flipper/adapters/sync.rb

@@ -8,9 +8,6 @@ module Flipper
     class Sync
       include ::Flipper::Adapter
 
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Public: The synchronizer that will keep the local and remote in sync.
       attr_reader :synchronizer
 
@@ -22,7 +19,6 @@ module Flipper
       # interval - The Float or Integer number of seconds between syncs from
       # remote to local. Default value is set in IntervalSynchronizer.
       def initialize(local, remote, options = {})
-        @name = :sync
         @local = local
         @remote = remote
         @synchronizer = options.fetch(:synchronizer) do