flipper 0.17.1 → 0.21.0

data/flipper.gemspec

@@ -25,13 +25,12 @@ Gem::Specification.new do |gem|
   gem.authors       = ['John Nunemaker']
   gem.email         = ['nunemaker@gmail.com']
   gem.summary       = 'Feature flipper for ANYTHING'
-  gem.description   = 'Feature flipper is the act of enabling/disabling features in your application, ideally without re-deploying or changing anything in your code base. Flipper makes this extremely easy to do with any backend you would like to use.' # rubocop:disable Metrics/LineLength
   gem.homepage      = 'https://github.com/jnunemaker/flipper'
   gem.license       = 'MIT'
 
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) } # rubocop:disable Metrics/LineLength
-  gem.files         = `git ls-files`.split("\n") - ignored_files + ['lib/flipper/version.rb'] # rubocop:disable Metrics/LineLength
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n") - ignored_test_files # rubocop:disable Metrics/LineLength
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n") - ignored_files + ['lib/flipper/version.rb']
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n") - ignored_test_files
   gem.name          = 'flipper'
   gem.require_paths = ['lib']
   gem.version       = Flipper::VERSION

data/lib/flipper.rb

@@ -1,7 +1,7 @@
 require "forwardable"
 
 module Flipper
-  extend self # rubocop:disable Style/ModuleFunction
+  extend self
   extend Forwardable
 
   # Private: The namespace for all instrumented events.
@@ -16,7 +16,7 @@ module Flipper
   # Public: Configure flipper.
   #
   #   Flipper.configure do |config|
-  #     config.default { ... }
+  #     config.adapter { ... }
   #   end
   #
   # Yields Flipper::Configuration instance.
@@ -65,7 +65,8 @@ module Flipper
                  :time, :percentage_of_time,
                  :features, :feature, :[], :preload, :preload_all,
                  :adapter, :add, :exist?, :remove, :import,
-                 :memoize=, :memoizing?
+                 :memoize=, :memoizing?,
+                 :sync, :sync_secret # For Flipper::Cloud. Will error for OSS Flipper.
 
   # Public: Use this to register a group by name.
   #
@@ -151,6 +152,7 @@ require 'flipper/feature'
 require 'flipper/gate'
 require 'flipper/instrumenters/memory'
 require 'flipper/instrumenters/noop'
+require 'flipper/identifier'
 require 'flipper/middleware/memoizer'
 require 'flipper/middleware/setup_env'
 require 'flipper/registry'
@@ -162,3 +164,5 @@ require 'flipper/types/percentage'
 require 'flipper/types/percentage_of_actors'
 require 'flipper/types/percentage_of_time'
 require 'flipper/typecast'
+
+require "flipper/railtie" if defined?(Rails::Railtie)

data/lib/flipper/adapters/dual_write.rb

@@ -0,0 +1,67 @@
+module Flipper
+  module Adapters
+    class DualWrite
+      include ::Flipper::Adapter
+
+      # Public: The name of the adapter.
+      attr_reader :name
+
+      # Public: Build a new sync instance.
+      #
+      # local - The local flipper adapter that should serve reads.
+      # 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
+
+      def features
+        @local.features
+      end
+
+      def get(feature)
+        @local.get(feature)
+      end
+
+      def get_multi(features)
+        @local.get_multi(features)
+      end
+
+      def get_all
+        @local.get_all
+      end
+
+      def add(feature)
+        result = @remote.add(feature)
+        @local.add(feature)
+        result
+      end
+
+      def remove(feature)
+        result = @remote.remove(feature)
+        @local.remove(feature)
+        result
+      end
+
+      def clear(feature)
+        result = @remote.clear(feature)
+        @local.clear(feature)
+        result
+      end
+
+      def enable(feature, gate, thing)
+        result = @remote.enable(feature, gate, thing)
+        @local.enable(feature, gate, thing)
+        result
+      end
+
+      def disable(feature, gate, thing)
+        result = @remote.disable(feature, gate, thing)
+        @local.disable(feature, gate, thing)
+        result
+      end
+    end
+  end
+end

data/lib/flipper/adapters/http.rb

@@ -35,12 +35,6 @@ module Flipper
         end
       end
 
-      def add(feature)
-        body = JSON.generate(name: feature.key)
-        response = @client.post('/features', body)
-        response.is_a?(Net::HTTPOK)
-      end
-
       def get_multi(features)
         csv_keys = features.map(&:key).join(',')
         response = @client.get("/features?keys=#{csv_keys}")
@@ -87,51 +81,61 @@ module Flipper
         parsed_response['features'].map { |feature| feature['key'] }.to_set
       end
 
+      def add(feature)
+        body = JSON.generate(name: feature.key)
+        response = @client.post('/features', body)
+        raise Error, response unless response.is_a?(Net::HTTPOK)
+        true
+      end
+
       def remove(feature)
         response = @client.delete("/features/#{feature.key}")
-        response.is_a?(Net::HTTPNoContent)
+        raise Error, response unless response.is_a?(Net::HTTPNoContent)
+        true
       end
 
       def enable(feature, gate, thing)
         body = request_body_for_gate(gate, thing.value.to_s)
         query_string = gate.key == :groups ? "?allow_unregistered_groups=true" : ""
         response = @client.post("/features/#{feature.key}/#{gate.key}#{query_string}", body)
-        response.is_a?(Net::HTTPOK)
+        raise Error, response unless response.is_a?(Net::HTTPOK)
+        true
       end
 
       def disable(feature, gate, thing)
         body = request_body_for_gate(gate, thing.value.to_s)
         query_string = gate.key == :groups ? "?allow_unregistered_groups=true" : ""
-        response =
-          case gate.key
-          when :percentage_of_actors, :percentage_of_time
-            @client.post("/features/#{feature.key}/#{gate.key}#{query_string}", body)
-          else
-            @client.delete("/features/#{feature.key}/#{gate.key}#{query_string}", body)
-          end
-        response.is_a?(Net::HTTPOK)
+        response = case gate.key
+        when :percentage_of_actors, :percentage_of_time
+          @client.post("/features/#{feature.key}/#{gate.key}#{query_string}", body)
+        else
+          @client.delete("/features/#{feature.key}/#{gate.key}#{query_string}", body)
+        end
+        raise Error, response unless response.is_a?(Net::HTTPOK)
+        true
       end
 
       def clear(feature)
         response = @client.delete("/features/#{feature.key}/clear")
-        response.is_a?(Net::HTTPNoContent)
+        raise Error, response unless response.is_a?(Net::HTTPNoContent)
+        true
       end
 
       private
 
       def request_body_for_gate(gate, value)
         data = case gate.key
-               when :boolean
-                 {}
-               when :groups
-                 { name: value }
-               when :actors
-                 { flipper_id: value }
-               when :percentage_of_actors, :percentage_of_time
-                 { percentage: value }
-               else
-                 raise "#{gate.key} is not a valid flipper gate key"
-               end
+        when :boolean
+          {}
+        when :groups
+          { name: value }
+        when :actors
+          { flipper_id: value }
+        when :percentage_of_actors, :percentage_of_time
+          { percentage: value }
+        else
+          raise "#{gate.key} is not a valid flipper gate key"
+        end
         JSON.generate(data)
       end
 

data/lib/flipper/adapters/memory.rb

@@ -20,55 +20,57 @@ module Flipper
 
       # Public: The set of known features.
       def features
-        read_feature_keys
+        @source.keys.to_set
       end
 
       # Public: Adds a feature to the set of known features.
       def add(feature)
-        features.add(feature.key)
+        @source[feature.key] ||= default_config
         true
       end
 
       # Public: Removes a feature from the set of known features and clears
       # all the values for the feature.
       def remove(feature)
-        features.delete(feature.name.to_s)
-        clear(feature)
+        @source.delete(feature.key)
         true
       end
 
       # Public: Clears all the gate values for a feature.
       def clear(feature)
-        feature.gates.each do |gate|
-          delete key(feature, gate)
-        end
+        @source[feature.key] = default_config
         true
       end
 
       # Public
       def get(feature)
-        read_feature(feature)
+        @source[feature.key] || default_config
       end
 
       def get_multi(features)
-        read_many_features(features)
+        result = {}
+        features.each do |feature|
+          result[feature.key] = @source[feature.key] || default_config
+        end
+        result
       end
 
       def get_all
-        features = read_feature_keys.map do |key|
-          Flipper::Feature.new(key, self)
-        end
-
-        read_many_features(features)
+        @source
       end
 
       # Public
       def enable(feature, gate, thing)
+        @source[feature.key] ||= default_config
+
         case gate.data_type
-        when :boolean, :integer
-          write key(feature, gate), thing.value.to_s
+        when :boolean
+          clear(feature)
+          @source[feature.key][gate.key] = thing.value.to_s
+        when :integer
+          @source[feature.key][gate.key] = thing.value.to_s
         when :set
-          set_add key(feature, gate), thing.value.to_s
+          @source[feature.key][gate.key] << thing.value.to_s
         else
           raise "#{gate} is not supported by this adapter yet"
         end
@@ -78,13 +80,15 @@ module Flipper
 
       # Public
       def disable(feature, gate, thing)
+        @source[feature.key] ||= default_config
+
         case gate.data_type
         when :boolean
           clear(feature)
         when :integer
-          write key(feature, gate), thing.value.to_s
+          @source[feature.key][gate.key] = thing.value.to_s
         when :set
-          set_delete key(feature, gate), thing.value.to_s
+          @source[feature.key][gate.key].delete thing.value.to_s
         else
           raise "#{gate} is not supported by this adapter yet"
         end
@@ -100,81 +104,6 @@ module Flipper
         ]
         "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
       end
-
-      private
-
-      def read_feature_keys
-        set_members(FeaturesKey)
-      end
-
-      # Private
-      def key(feature, gate)
-        "feature/#{feature.key}/#{gate.key}"
-      end
-
-      def read_many_features(features)
-        result = {}
-        features.each do |feature|
-          result[feature.key] = read_feature(feature)
-        end
-        result
-      end
-
-      def read_feature(feature)
-        result = {}
-
-        feature.gates.each do |gate|
-          result[gate.key] =
-            case gate.data_type
-            when :boolean, :integer
-              read key(feature, gate)
-            when :set
-              set_members key(feature, gate)
-            else
-              raise "#{gate} is not supported by this adapter yet"
-            end
-        end
-
-        result
-      end
-
-      # Private
-      def read(key)
-        @source[key.to_s]
-      end
-
-      # Private
-      def write(key, value)
-        @source[key.to_s] = value.to_s
-      end
-
-      # Private
-      def delete(key)
-        @source.delete(key.to_s)
-      end
-
-      # Private
-      def set_add(key, value)
-        ensure_set_initialized(key)
-        @source[key.to_s].add(value.to_s)
-      end
-
-      # Private
-      def set_delete(key, value)
-        ensure_set_initialized(key)
-        @source[key.to_s].delete(value.to_s)
-      end
-
-      # Private
-      def set_members(key)
-        ensure_set_initialized(key)
-        @source[key.to_s]
-      end
-
-      # Private
-      def ensure_set_initialized(key)
-        @source[key.to_s] ||= Set.new
-      end
     end
   end
 end

data/lib/flipper/adapters/operation_logger.rb

@@ -117,6 +117,11 @@ module Flipper
       def reset
         @operations.clear
       end
+
+      def inspect
+        inspect_id = ::Kernel::format "%x", (object_id * 2)
+        %(#<#{self.class}:0x#{inspect_id} @name=#{name.inspect}, @operations=#{@operations.inspect}, @adapter=#{@adapter.inspect}>)
+      end
     end
   end
 end

data/lib/flipper/adapters/pstore.rb

@@ -84,7 +84,10 @@ module Flipper
       def enable(feature, gate, thing)
         @store.transaction do
           case gate.data_type
-          when :boolean, :integer
+          when :boolean
+            clear_gates(feature)
+            write key(feature, gate), thing.value.to_s
+          when :integer
             write key(feature, gate), thing.value.to_s
           when :set
             set_add key(feature, gate), thing.value.to_s
@@ -213,3 +216,7 @@ module Flipper
     end
   end
 end
+
+Flipper.configure do |config|
+  config.adapter { Flipper::Adapters::PStore.new }
+end

data/lib/flipper/adapters/sync.rb

@@ -17,7 +17,7 @@ module Flipper
       # Public: Build a new sync instance.
       #
       # local - The local flipper adapter that should serve reads.
-      # remote - The remote flipper adpater that should serve writes and update
+      # remote - The remote flipper adapter that should serve writes and update
       #          the local on an interval.
       # interval - The Float or Integer number of seconds between syncs from
       # remote to local. Default value is set in IntervalSynchronizer.
@@ -34,26 +34,26 @@ module Flipper
           synchronizer = Synchronizer.new(@local, @remote, sync_options)
           IntervalSynchronizer.new(synchronizer, interval: options[:interval])
         end
-        sync
+        synchronize
       end
 
       def features
-        sync
+        synchronize
         @local.features
       end
 
       def get(feature)
-        sync
+        synchronize
         @local.get(feature)
       end
 
       def get_multi(features)
-        sync
+        synchronize
         @local.get_multi(features)
       end
 
       def get_all
-        sync
+        synchronize
         @local.get_all
       end
 
@@ -89,7 +89,7 @@ module Flipper
 
       private
 
-      def sync
+      def synchronize
         @synchronizer.call
       end
     end