flipper 0.21.0.rc1 → 0.22.1

data/lib/flipper/version.rb

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

data/lib/flipper.rb

@@ -16,7 +16,7 @@ module Flipper
   # Public: Configure flipper.
   #
   #   Flipper.configure do |config|
-  #     config.default { ... }
+  #     config.adapter { ... }
   #   end
   #
   # Yields Flipper::Configuration instance.
@@ -164,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/spec/flipper/configuration_spec.rb

@@ -2,10 +2,25 @@ require 'helper'
 require 'flipper/configuration'
 
 RSpec.describe Flipper::Configuration do
+  describe '#adapter' do
+    it 'returns instance using Memory adapter' do
+      expect(subject.adapter).to be_a(Flipper::Adapters::Memory)
+    end
+
+    it 'can be set' do
+      instance = Flipper::Adapters::Memory.new
+      expect(subject.adapter).not_to be(instance)
+      subject.adapter { instance }
+      expect(subject.adapter).to be(instance)
+      # All adapters are wrapped in Memoizable
+      expect(subject.default.adapter.adapter).to be(instance)
+    end
+  end
+
   describe '#default' do
     it 'returns instance using Memory adapter' do
       expect(subject.default).to be_a(Flipper::DSL)
-      # All adapter are wrapped in Memoizable
+      # All adapters are wrapped in Memoizable
       expect(subject.default.adapter.adapter).to be_a(Flipper::Adapters::Memory)
     end
 

data/spec/flipper/middleware/memoizer_spec.rb

@@ -15,10 +15,6 @@ RSpec.describe Flipper::Middleware::Memoizer do
   let(:flipper) { Flipper.new(adapter) }
   let(:env) { { 'flipper' => flipper } }
 
-  after do
-    flipper.memoize = nil
-  end
-
   it 'raises if initialized with app and flipper instance' do
     expect do
       described_class.new(app, flipper)
@@ -103,14 +99,14 @@ RSpec.describe Flipper::Middleware::Memoizer do
     end
   end
 
-  context 'with preload_all' do
+  context 'with preload: true' do
     let(:app) do
       # ensure scoped for builder block, annoying...
       instance = flipper
       middleware = described_class
 
       Rack::Builder.new do
-        use middleware, preload_all: true
+        use middleware, preload: true
 
         map '/' do
           run ->(_env) { [200, {}, []] }
@@ -139,7 +135,7 @@ RSpec.describe Flipper::Middleware::Memoizer do
         [200, {}, []]
       end
 
-      middleware = described_class.new(app, preload_all: true)
+      middleware = described_class.new(app, preload: true)
       middleware.call(env)
 
       expect(adapter.operations.size).to be(1)
@@ -156,7 +152,7 @@ RSpec.describe Flipper::Middleware::Memoizer do
         [200, {}, []]
       end
 
-      middleware = described_class.new(app, preload_all: true)
+      middleware = described_class.new(app, preload: true)
       middleware.call(env)
 
       expect(adapter.count(:get)).to be(1)
@@ -222,6 +218,44 @@ RSpec.describe Flipper::Middleware::Memoizer do
     end
   end
 
+  context 'with multiple instances' do
+    let(:app) do
+      # ensure scoped for builder block, annoying...
+      instance = flipper
+      middleware = described_class
+
+      Rack::Builder.new do
+        use middleware, preload: %i(stats)
+        # Second instance should be a noop
+        use middleware, preload: true
+
+        map '/' do
+          run ->(_env) { [200, {}, []] }
+        end
+
+        map '/fail' do
+          run ->(_env) { raise 'FAIL!' }
+        end
+      end.to_app
+    end
+
+    def get(uri, params = {}, env = {}, &block)
+      silence { super(uri, params, env, &block) }
+    end
+
+    include_examples 'flipper middleware'
+
+    it 'does not call preload in second instance' do
+      expect(flipper).not_to receive(:preload_all)
+
+      output = get '/', {}, 'flipper' => flipper
+
+      expect(output).to match(/Flipper::Middleware::Memoizer appears to be running twice/)
+      expect(adapter.count(:get_multi)).to be(1)
+      expect(adapter.last(:get_multi).args).to eq([[flipper[:stats]]])
+    end
+  end
+
   context 'when an app raises an exception' do
     it 'resets memoize' do
       begin
@@ -259,10 +293,9 @@ RSpec.describe Flipper::Middleware::Memoizer do
   context 'with Flipper setup in env' do
     it 'caches getting a feature for duration of request' do
       Flipper.configure do |config|
-        config.default do
+        config.adapter do
           memory = Flipper::Adapters::Memory.new
-          logged_adapter = Flipper::Adapters::OperationLogger.new(memory)
-          Flipper.new(logged_adapter)
+          Flipper::Adapters::OperationLogger.new(memory)
         end
       end
       Flipper.enable(:stats)
@@ -308,14 +341,16 @@ RSpec.describe Flipper::Middleware::Memoizer do
     end
   end
 
-  context 'with preload_all and unless option' do
+  context 'with preload:true' do
+    let(:options) { {preload: true} }
+
     let(:app) do
       # ensure scoped for builder block, annoying...
       middleware = described_class
+      opts = options
 
       Rack::Builder.new do
-        use middleware, preload_all: true,
-                        unless: ->(request) { request.path.start_with?("/assets") }
+        use middleware, opts
 
         map '/' do
           run ->(_env) { [200, {}, []] }
@@ -327,18 +362,53 @@ RSpec.describe Flipper::Middleware::Memoizer do
       end.to_app
     end
 
-    it 'does NOT preload_all if request matches unless block' do
-      expect(flipper).to receive(:preload_all).never
-      get '/assets/foo.png', {}, 'flipper' => flipper
+
+    context 'and unless option' do
+      before do
+        options[:unless] = ->(request) { request.path.start_with?("/assets") }
+      end
+
+      it 'does NOT preload if request matches unless block' do
+        expect(flipper).to receive(:preload_all).never
+        get '/assets/foo.png', {}, 'flipper' => flipper
+      end
+
+      it 'does preload if request does NOT match unless block' do
+        expect(flipper).to receive(:preload_all).once
+        get '/some/other/path', {}, 'flipper' => flipper
+      end
     end
 
-    it 'does preload_all if request does NOT match unless block' do
-      expect(flipper).to receive(:preload_all).once
-      get '/some/other/path', {}, 'flipper' => flipper
+    context 'and if option' do
+      before do
+        options[:if] = ->(request) { !request.path.start_with?("/assets") }
+      end
+
+      it 'does NOT preload if request does not match if block' do
+        expect(flipper).to receive(:preload_all).never
+        get '/assets/foo.png', {}, 'flipper' => flipper
+      end
+
+      it 'does preload if request matches if block' do
+        expect(flipper).to receive(:preload_all).once
+        get '/some/other/path', {}, 'flipper' => flipper
+      end
     end
   end
 
-  context 'with preload_all and caching adapter' do
+  context 'with preload:true and caching adapter' do
+    let(:app) do
+      app = lambda do |_env|
+        flipper[:stats].enabled?
+        flipper[:stats].enabled?
+        flipper[:shiny].enabled?
+        flipper[:shiny].enabled?
+        [200, {}, []]
+      end
+
+      described_class.new(app, preload: true)
+    end
+
     it 'eagerly caches known features for duration of request' do
       memory = Flipper::Adapters::Memory.new
       logged_memory = Flipper::Adapters::OperationLogger.new(memory)
@@ -355,25 +425,15 @@ RSpec.describe Flipper::Middleware::Memoizer do
       logged_memory.reset
       logged_cached.reset
 
-      app = lambda do |_env|
-        flipper[:stats].enabled?
-        flipper[:stats].enabled?
-        flipper[:shiny].enabled?
-        flipper[:shiny].enabled?
-        [200, {}, []]
-      end
-
-      middleware = described_class.new(app, preload_all: true)
-
-      middleware.call('flipper' => flipper)
+      get '/', {}, 'flipper' => flipper
       expect(logged_cached.count(:get_all)).to be(1)
       expect(logged_memory.count(:get_all)).to be(1)
 
-      middleware.call('flipper' => flipper)
+      get '/', {}, 'flipper' => flipper
       expect(logged_cached.count(:get_all)).to be(2)
       expect(logged_memory.count(:get_all)).to be(1)
 
-      middleware.call('flipper' => flipper)
+      get '/', {}, 'flipper' => flipper
       expect(logged_cached.count(:get_all)).to be(3)
       expect(logged_memory.count(:get_all)).to be(1)
     end

data/spec/flipper/railtie_spec.rb

@@ -0,0 +1,69 @@
+require 'helper'
+require 'rails'
+require 'flipper/railtie'
+
+RSpec.describe Flipper::Railtie do
+  let(:application) do
+    app = Class.new(Rails::Application).new(
+      railties: [Flipper::Railtie],
+      ordered_railties: [Flipper::Railtie]
+    )
+    app.config.eager_load = false
+    app.config.logger = ActiveSupport::Logger.new($stdout)
+    app.run_load_hooks!
+  end
+
+  before do
+    Rails.application = nil
+  end
+
+  subject do
+    application.initialize!
+    application
+  end
+
+  describe 'initializers' do
+    it 'sets defaults' do
+      expect(application.config.flipper.env_key).to eq("flipper")
+      expect(application.config.flipper.memoize).to be(true)
+      expect(application.config.flipper.preload).to be(true)
+    end
+
+    it "configures instrumentor on default instance" do
+      subject
+
+      expect(Flipper.instance.instrumenter).to eq(ActiveSupport::Notifications)
+    end
+
+    it 'uses Memoizer middleware if config.memoize = true' do
+      expect(subject.middleware.last).to eq(Flipper::Middleware::Memoizer)
+    end
+
+    it 'does not use Memoizer middleware if config.memoize = false' do
+      # load but don't initialize
+      application.config.flipper.memoize = false
+
+      expect(subject.middleware.last).not_to eq(Flipper::Middleware::Memoizer)
+    end
+
+    it 'passes config to memoizer' do
+      # load but don't initialize
+      application.config.flipper.update(
+        env_key: 'my_flipper',
+        preload: [:stats, :search]
+      )
+
+      expect(Flipper::Middleware::Memoizer).to receive(:new).with(application.routes,
+        env_key: 'my_flipper', preload: [:stats, :search], if: nil
+      )
+
+      subject # initialize
+    end
+
+    it "defines #flipper_id on AR::Base" do
+      subject
+      require 'active_record'
+      expect(ActiveRecord::Base.ancestors).to include(Flipper::Identifier)
+    end
+  end
+end

data/spec/helper.rb

@@ -14,8 +14,8 @@ require 'webmock/rspec'
 WebMock.disable_net_connect!(allow_localhost: true)
 
 require 'flipper'
-require 'flipper-ui'
-require 'flipper-api'
+require 'flipper/ui'
+require 'flipper/api'
 
 Dir[FlipperRoot.join('spec/support/**/*.rb')].sort.each { |f| require f }
 

data/spec/support/spec_helpers.rb

@@ -61,6 +61,23 @@ module SpecHelpers
   def with_modified_env(options, &block)
     ClimateControl.modify(options, &block)
   end
+
+  def silence
+    # Store the original stderr and stdout in order to restore them later
+    original_stderr = $stderr
+    original_stdout = $stdout
+
+    # Redirect stderr and stdout
+    output = $stderr = $stdout = StringIO.new
+
+    yield
+
+    $stderr = original_stderr
+    $stdout = original_stdout
+
+    # Return output
+    output.string
+  end
 end
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.21.0.rc1
+  version: 0.22.1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-01 00:00:00.000000000 Z
+date: 2021-08-23 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".github/workflows/ci.yml"
+- ".github/workflows/examples.yml"
 - CODE_OF_CONDUCT.md
 - Changelog.md
 - Dockerfile
@@ -37,6 +38,9 @@ files:
 - docs/http/README.md
 - docs/images/banner.jpg
 - docs/read-only/README.md
+- examples/api/basic.ru
+- examples/api/custom_memoized.ru
+- examples/api/memoized.ru
 - examples/basic.rb
 - examples/configuring_default.rb
 - examples/dsl.rb
@@ -47,6 +51,7 @@ files:
 - examples/importing.rb
 - examples/individual_actor.rb
 - examples/instrumentation.rb
+- examples/instrumentation_last_accessed_at.rb
 - examples/memoizing.rb
 - examples/percentage_of_actors.rb
 - examples/percentage_of_actors_enabled_check.rb
@@ -92,6 +97,7 @@ files:
 - lib/flipper/metadata.rb
 - lib/flipper/middleware/memoizer.rb
 - lib/flipper/middleware/setup_env.rb
+- lib/flipper/railtie.rb
 - lib/flipper/registry.rb
 - lib/flipper/spec/shared_adapter_specs.rb
 - lib/flipper/test/shared_adapter_test.rb
@@ -137,6 +143,7 @@ files:
 - spec/flipper/instrumenters/noop_spec.rb
 - spec/flipper/middleware/memoizer_spec.rb
 - spec/flipper/middleware/setup_env_spec.rb
+- spec/flipper/railtie_spec.rb
 - spec/flipper/registry_spec.rb
 - spec/flipper/typecast_spec.rb
 - spec/flipper/types/actor_spec.rb
@@ -171,9 +178,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 
@@ -213,6 +220,7 @@ test_files:
 - spec/flipper/instrumenters/noop_spec.rb
 - spec/flipper/middleware/memoizer_spec.rb
 - spec/flipper/middleware/setup_env_spec.rb
+- spec/flipper/railtie_spec.rb
 - spec/flipper/registry_spec.rb
 - spec/flipper/typecast_spec.rb
 - spec/flipper/types/actor_spec.rb