flipper 0.17.1 → 0.21.0

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/adapters/sync/synchronizer.rb

@@ -15,6 +15,7 @@ module Flipper
         #          adapter should be brought in line with.
         # options - The Hash of options.
         #           :instrumenter - The instrumenter used to instrument.
+        #           :raise - Should errors be raised (default: true).
         def initialize(local, remote, options = {})
           @local = local
           @remote = remote

data/lib/flipper/configuration.rb

@@ -1,7 +1,33 @@
 module Flipper
   class Configuration
-    def initialize
-      @default = -> { raise DefaultNotSet }
+    def initialize(options = {})
+      @default = -> { Flipper.new(adapter) }
+      @adapter = -> { Flipper::Adapters::Memory.new }
+    end
+
+    # The default adapter to use.
+    #
+    # Pass a block to assign the adapter, and invoke without a block to
+    # return the configured adapter instance.
+    #
+    #   Flipper.configure do |config|
+    #     config.adapter # => instance of default Memory adapter
+    #
+    #     # Configure it to use the ActiveRecord adapter
+    #     config.adapter do
+    #       require "flipper/adapters/active_record"
+    #       Flipper::Adapters::ActiveRecord.new
+    #     end
+    #
+    #     config.adapter # => instance of ActiveRecord adapter
+    #  end
+    #
+    def adapter(&block)
+      if block_given?
+        @adapter = block
+      else
+        @adapter.call
+      end
     end
 
     # Controls the default instance for flipper. When used with a block it
@@ -9,15 +35,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/adapters/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/dsl.rb

@@ -273,5 +273,13 @@ module Flipper
     def import(flipper)
       adapter.import(flipper.adapter)
     end
+
+    # Cloud DSL method that does nothing for open source version.
+    def sync
+    end
+
+    # Cloud DSL method that does nothing for open source version.
+    def sync_secret
+    end
   end
 end

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/feature.rb

@@ -5,7 +5,7 @@ require 'flipper/feature_check_context'
 require 'flipper/gate_values'
 
 module Flipper
-  class Feature # rubocop:disable Metrics/ClassLength
+  class Feature
     # Private: The name of feature instrumentation events.
     InstrumentationName = "feature_operation.#{InstrumentationNamespace}".freeze
 
@@ -205,7 +205,7 @@ module Flipper
       boolean = gate(:boolean)
       non_boolean_gates = gates - [boolean]
 
-      if values.boolean || values.percentage_of_actors == 100 || values.percentage_of_time == 100
+      if values.boolean || values.percentage_of_time == 100
         :on
       elsif non_boolean_gates.detect { |gate| gate.enabled?(values[gate.key]) }
         :conditional

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

@@ -8,8 +8,7 @@ module Flipper
       #
       # app - The app this middleware is included in.
       # opts - The Hash of options.
-      #        :preload_all - Boolean of whether or not to preload all features.
-      #        :preload - Array of Symbol feature names to preload.
+      #        :preload - Boolean to preload all features or Array of Symbol feature names to preload.
       #
       # Examples
       #
@@ -23,7 +22,12 @@ module Flipper
       #
       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.' # rubocop:disable LineLength
+          raise 'Flipper::Middleware::Memoizer no longer initializes with a flipper instance or block. Read more at: https://git.io/vSo31.'
+        end
+
+        if opts[:preload_all]
+          warn "Flipper::Middleware::Memoizer: `preload_all` is deprecated, use `preload: true`"
+          opts[:preload] = true
         end
 
         @app = app
@@ -34,39 +38,50 @@ module Flipper
       def call(env)
         request = Rack::Request.new(env)
 
-        if skip_memoize?(request)
-          @app.call(env)
-        else
+        if memoize?(request)
           memoized_call(env)
+        else
+          @app.call(env)
         end
       end
 
       private
 
-      def skip_memoize?(request)
-        @opts[:unless] && @opts[:unless].call(request)
+      def memoize?(request)
+        if @opts[:if]
+          @opts[:if].call(request)
+        elsif @opts[:unless]
+          !@opts[:unless].call(request)
+        else
+          true
+        end
       end
 
       def memoized_call(env)
         reset_on_body_close = false
         flipper = env.fetch(@env_key) { Flipper }
-        original = flipper.memoizing?
-        flipper.memoize = true
 
-        flipper.preload_all if @opts[:preload_all]
+        # 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/jnunemaker/flipper/pull/523"
+          return @app.call(env)
+        end
+
+        flipper.memoize = true
 
-        if (preload = @opts[:preload])
-          flipper.preload(preload)
+        case @opts[:preload]
+        when true then flipper.preload_all
+        when Array then flipper.preload(@opts[:preload])
         end
 
         response = @app.call(env)
         response[2] = Rack::BodyProxy.new(response[2]) do
-          flipper.memoize = original
+          flipper.memoize = false
         end
         reset_on_body_close = true
         response
       ensure
-        flipper.memoize = original if flipper && !reset_on_body_close
+        flipper.memoize = false if flipper && !reset_on_body_close
       end
     end
   end

data/lib/flipper/middleware/setup_env.rb

@@ -7,7 +7,8 @@ module Flipper
       #
       # app - The app this middleware is included in.
       # flipper_or_block - The Flipper::DSL instance or a block that yields a
-      #                    Flipper::DSL instance to use for all operations.
+      #                    Flipper::DSL instance to use for all operations
+      #                    (optional, default: Flipper).
       #
       # Examples
       #
@@ -19,18 +20,27 @@ module Flipper
       #   # using with a block that yields a flipper instance
       #   use Flipper::Middleware::SetupEnv, lambda { Flipper.new(...) }
       #
-      def initialize(app, flipper_or_block, options = {})
+      #   # using default configured Flipper instance
+      #   Flipper.configure do |config|
+      #     config.default { Flipper.new(...) }
+      #   end
+      #   use Flipper::Middleware::SetupEnv
+      def initialize(app, flipper_or_block = nil, options = {})
         @app = app
         @env_key = options.fetch(:env_key, 'flipper')
 
         if flipper_or_block.respond_to?(:call)
           @flipper_block = flipper_or_block
         else
-          @flipper = flipper_or_block
+          @flipper = flipper_or_block || Flipper
         end
       end
 
       def call(env)
+        dup.call!(env)
+      end
+
+      def call!(env)
         env[@env_key] ||= flipper
         @app.call(env)
       end

data/lib/flipper/railtie.rb

@@ -0,0 +1,38 @@
+module Flipper
+  class Railtie < Rails::Railtie
+    config.before_configuration do
+      config.flipper = ActiveSupport::OrderedOptions.new.update(
+        env_key: "flipper",
+        memoize: true,
+        preload: true,
+        instrumenter: ActiveSupport::Notifications
+      )
+    end
+
+    initializer "flipper.default", before: :load_config_initializers do |app|
+      Flipper.configure do |config|
+        config.default do
+          Flipper.new(config.adapter, instrumenter: app.config.flipper.instrumenter)
+        end
+      end
+    end
+
+    initializer "flipper.memoizer", after: :load_config_initializers do |app|
+      config = app.config.flipper
+
+      if config.memoize
+        app.middleware.use Flipper::Middleware::Memoizer, {
+          env_key: config.env_key,
+          preload: config.preload,
+          if: config.memoize.respond_to?(:call) ? config.memoize : nil
+        }
+      end
+    end
+
+    initializer "flipper.identifier" do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.include Flipper::Identifier
+      end
+    end
+  end
+end

data/lib/flipper/spec/shared_adapter_specs.rb

@@ -289,4 +289,19 @@ RSpec.shared_examples_for 'a flipper adapter' do
     expect(subject.enable(feature, boolean_gate, flipper.boolean)).to eq(true)
     expect(subject.enable(feature, boolean_gate, flipper.boolean)).to eq(true)
   end
+
+  it 'can get_all features when there are none' do
+    expect(subject.features).to eq(Set.new)
+    expect(subject.get_all).to eq({})
+  end
+
+  it 'clears other gate values on enable' do
+    actor = Flipper::Actor.new('Flipper::Actor;22')
+    subject.enable(feature, actors_gate, flipper.actors(25))
+    subject.enable(feature, time_gate, flipper.time(25))
+    subject.enable(feature, group_gate, flipper.group(:admins))
+    subject.enable(feature, actor_gate, flipper.actor(actor))
+    subject.enable(feature, boolean_gate, flipper.boolean(true))
+    expect(subject.get(feature)).to eq(subject.default_config.merge(boolean: "true"))
+  end
 end

data/lib/flipper/test/shared_adapter_test.rb

@@ -1,4 +1,3 @@
-# rubocop:disable Metrics/ModuleLength
 module Flipper
   module Test
     module SharedAdapterTests
@@ -285,6 +284,22 @@ module Flipper
         assert_equal true, @adapter.enable(@feature, @boolean_gate, @flipper.boolean)
         assert_equal true, @adapter.enable(@feature, @boolean_gate, @flipper.boolean)
       end
+
+      def test_can_get_all_features_when_there_are_none
+        expected = {}
+        assert_equal Set.new, @adapter.features
+        assert_equal expected, @adapter.get_all
+      end
+
+      def test_clears_other_gate_values_on_enable
+        actor = Flipper::Actor.new('Flipper::Actor;22')
+        assert_equal true, @adapter.enable(@feature, @actors_gate, @flipper.actors(25))
+        assert_equal true, @adapter.enable(@feature, @time_gate, @flipper.time(25))
+        assert_equal true, @adapter.enable(@feature, @group_gate, @flipper.group(:admins))
+        assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor))
+        assert_equal true, @adapter.enable(@feature, @boolean_gate, @flipper.boolean(true))
+        assert_equal @adapter.default_config.merge(boolean: "true"), @adapter.get(@feature)
+      end
     end
   end
 end

data/lib/flipper/version.rb

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

data/spec/flipper/adapter_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe Flipper::Adapter do
   describe '.default_config' do
     it 'returns default config' do
       adapter_class = Class.new do
-        include Flipper::Adapter # rubocop:disable RSpec/DescribedClass
+        include Flipper::Adapter
       end
       expect(adapter_class.default_config).to eq(default_config)
     end
@@ -25,7 +25,7 @@ RSpec.describe Flipper::Adapter do
   describe '#default_config' do
     it 'returns default config' do
       adapter_class = Class.new do
-        include Flipper::Adapter # rubocop:disable RSpec/DescribedClass
+        include Flipper::Adapter
       end
       expect(adapter_class.new.default_config).to eq(default_config)
     end

data/spec/flipper/adapters/dual_write_spec.rb

@@ -0,0 +1,71 @@
+require 'helper'
+require 'flipper/adapters/dual_write'
+require 'flipper/adapters/operation_logger'
+require 'flipper/spec/shared_adapter_specs'
+require 'active_support/notifications'
+
+RSpec.describe Flipper::Adapters::DualWrite do
+  let(:local_adapter) do
+    Flipper::Adapters::OperationLogger.new Flipper::Adapters::Memory.new
+  end
+  let(:remote_adapter) do
+    Flipper::Adapters::OperationLogger.new Flipper::Adapters::Memory.new
+  end
+  let(:local) { Flipper.new(local_adapter) }
+  let(:remote) { Flipper.new(remote_adapter) }
+  let(:sync) { Flipper.new(subject) }
+
+  subject do
+    described_class.new(local_adapter, remote_adapter)
+  end
+
+  it_should_behave_like 'a flipper adapter'
+
+  it 'only uses local for #features' do
+    subject.features
+  end
+
+  it 'only uses local for #get' do
+    subject.get sync[:search]
+  end
+
+  it 'only uses local for #get_multi' do
+    subject.get_multi [sync[:search]]
+  end
+
+  it 'only uses local for #get_all' do
+    subject.get_all
+  end
+
+  it 'updates remote and local for #add' do
+    subject.add sync[:search]
+    expect(remote_adapter.count(:add)).to be(1)
+    expect(local_adapter.count(:add)).to be(1)
+  end
+
+  it 'updates remote and local for #remove' do
+    subject.remove sync[:search]
+    expect(remote_adapter.count(:remove)).to be(1)
+    expect(local_adapter.count(:remove)).to be(1)
+  end
+
+  it 'updates remote and local for #clear' do
+    subject.clear sync[:search]
+    expect(remote_adapter.count(:clear)).to be(1)
+    expect(local_adapter.count(:clear)).to be(1)
+  end
+
+  it 'updates remote and local for #enable' do
+    feature = sync[:search]
+    subject.enable feature, feature.gate(:boolean), local.boolean
+    expect(remote_adapter.count(:enable)).to be(1)
+    expect(local_adapter.count(:enable)).to be(1)
+  end
+
+  it 'updates remote and local for #disable' do
+    feature = sync[:search]
+    subject.disable feature, feature.gate(:boolean), local.boolean(false)
+    expect(remote_adapter.count(:disable)).to be(1)
+    expect(local_adapter.count(:disable)).to be(1)
+  end
+end