flipper 0.20.0 → 0.21.0.rc1

data/examples/percentage_of_time.rb

@@ -1,13 +1,10 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper'
 
-adapter = Flipper::Adapters::Memory.new
-flipper = Flipper.new(adapter)
-logging = flipper[:logging]
+logging = Flipper[:logging]
 
 perform_test = lambda do |number|
-  logging.enable flipper.time(number)
+  logging.enable_percentage_of_time number
 
   total = 100_000
   enabled = []

data/lib/flipper.rb

@@ -152,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'

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,58 +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
           clear(feature)
-          write key(feature, gate), thing.value.to_s
+          @source[feature.key][gate.key] = thing.value.to_s
         when :integer
-          write key(feature, gate), thing.value.to_s
+          @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
@@ -81,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
@@ -103,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/sync/interval_synchronizer.rb

@@ -19,7 +19,7 @@ module Flipper
         # Public: Initializes a new interval synchronizer.
         #
         # synchronizer - The Synchronizer to call when the interval has passed.
-        # interval - The Integer number of milliseconds between invocations of
+        # interval - The Integer number of seconds between invocations of
         #            the wrapped synchronizer.
         def initialize(synchronizer, interval: nil)
           @synchronizer = synchronizer

data/lib/flipper/configuration.rb

@@ -1,7 +1,7 @@
 module Flipper
   class Configuration
     def initialize
-      @default = -> { raise DefaultNotSet }
+      @default = -> { Flipper.new(Flipper::Adapters::Memory.new) }
     end
 
     # Controls the default instance for flipper. When used with a block it
@@ -9,15 +9,15 @@ module Flipper
     # without a block, it performs a block invocation and returns the result.
     #
     #   configuration = Flipper::Configuration.new
-    #   configuration.default # => raises DefaultNotSet error.
+    #   configuration.default # => Flipper::DSL instance using Memory adapter
     #
-    #   # sets the default block to generate a new instance using Memory adapter
+    #   # sets the default block to generate a new instance using ActiveRecord adapter
     #   configuration.default do
-    #     require "flipper/adapters/memory"
-    #     Flipper.new(Flipper::Adapters::Memory.new)
+    #     require "flipper-active_record"
+    #     Flipper.new(Flipper::Adapters::ActiveRecord.new)
     #   end
     #
-    #   configuration.default # => Flipper::DSL instance using Memory adapter
+    #   configuration.default # => Flipper::DSL instance using ActiveRecord adapter
     #
     # Returns result of default block invocation if called without block. If
     # called with block, assigns the default block.

data/lib/flipper/errors.rb

@@ -16,9 +16,8 @@ module Flipper
   # use it.
   class DefaultNotSet < Flipper::Error
     def initialize(message = nil)
-      default = "Default flipper instance not configured. See " \
-                "Flipper.configure for how to configure the default instance."
-      super(message || default)
+      warn "Flipper::DefaultNotSet is deprecated and will be removed in 1.0"
+      super
     end
   end
 

data/lib/flipper/identifier.rb

@@ -0,0 +1,17 @@
+module Flipper
+  # A default implementation of `#flipper_id` for actors.
+  #
+  #   class User < Struct.new(:id)
+  #     include Flipper::Identifier
+  #   end
+  #
+  #   user = User.new(99)
+  #   Flipper.enable :thing, user
+  #   Flipper.enabled? :thing, user #=> true
+  #
+  module Identifier
+    def flipper_id
+      "#{self.class.name};#{id}"
+    end
+  end
+end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.20.0'.freeze
+  VERSION = '0.21.0.rc1'.freeze
 end

data/spec/flipper/adapters/http_spec.rb

@@ -76,9 +76,9 @@ RSpec.describe Flipper::Adapters::Http do
         .to_return(status: 503, body: "", headers: {})
 
       adapter = described_class.new(url: 'http://app.com/flipper')
-      expect do
+      expect {
         adapter.get(flipper[:feature_panel])
-      end.to raise_error(Flipper::Adapters::Http::Error)
+      }.to raise_error(Flipper::Adapters::Http::Error)
     end
   end
 
@@ -88,9 +88,9 @@ RSpec.describe Flipper::Adapters::Http do
         .to_return(status: 503, body: "", headers: {})
 
       adapter = described_class.new(url: 'http://app.com/flipper')
-      expect do
+      expect {
         adapter.get_multi([flipper[:feature_panel]])
-      end.to raise_error(Flipper::Adapters::Http::Error)
+      }.to raise_error(Flipper::Adapters::Http::Error)
     end
   end
 
@@ -100,9 +100,9 @@ RSpec.describe Flipper::Adapters::Http do
         .to_return(status: 503, body: "", headers: {})
 
       adapter = described_class.new(url: 'http://app.com/flipper')
-      expect do
+      expect {
         adapter.get_all
-      end.to raise_error(Flipper::Adapters::Http::Error)
+      }.to raise_error(Flipper::Adapters::Http::Error)
     end
   end
 
@@ -112,9 +112,75 @@ RSpec.describe Flipper::Adapters::Http do
         .to_return(status: 503, body: "", headers: {})
 
       adapter = described_class.new(url: 'http://app.com/flipper')
-      expect do
+      expect {
         adapter.features
-      end.to raise_error(Flipper::Adapters::Http::Error)
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#add" do
+    it "raises error when not successful" do
+      stub_request(:post, /app.com/)
+        .to_return(status: 503, body: "{}", headers: {})
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      expect {
+        adapter.add(Flipper::Feature.new(:search, adapter))
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#remove" do
+    it "raises error when not successful" do
+      stub_request(:delete, /app.com/)
+        .to_return(status: 503, body: "{}", headers: {})
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      expect {
+        adapter.remove(Flipper::Feature.new(:search, adapter))
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#clear" do
+    it "raises error when not successful" do
+      stub_request(:delete, /app.com/)
+        .to_return(status: 503, body: "{}", headers: {})
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      expect {
+        adapter.clear(Flipper::Feature.new(:search, adapter))
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#enable" do
+    it "raises error when not successful" do
+      stub_request(:post, /app.com/)
+        .to_return(status: 503, body: "{}", headers: {})
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      feature = Flipper::Feature.new(:search, adapter)
+      gate = feature.gate(:boolean)
+      thing = gate.wrap(true)
+      expect {
+        adapter.enable(feature, gate, thing)
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#disable" do
+    it "raises error when not successful" do
+      stub_request(:delete, /app.com/)
+        .to_return(status: 503, body: "{}", headers: {})
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      feature = Flipper::Feature.new(:search, adapter)
+      gate = feature.gate(:boolean)
+      thing = gate.wrap(false)
+      expect {
+        adapter.disable(feature, gate, thing)
+      }.to raise_error(Flipper::Adapters::Http::Error)
     end
   end