flipper 0.21.0.rc1 → 0.22.1

data/docs/api/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 ```ruby
 # config/routes.rb
 YourRailsApp::Application.routes.draw do
-  mount Flipper::Api.app(flipper) => '/flipper/api'
+  mount Flipper::Api.app(Flipper) => '/flipper/api'
 end
 ```
 
@@ -34,8 +34,8 @@ There can be more than one router in your application. Make sure if you choose a
 *bad:*
 ```ruby
 YourRailsApp::Application.routes.draw do
-  mount Flipper::UI.app(flipper) => '/flipper'
-  mount Flipper::Api.app(flipper) => '/flipper/api'
+  mount Flipper::UI.app(Flipper) => '/flipper'
+  mount Flipper::Api.app(Flipper) => '/flipper/api'
 end
 ```
 
@@ -44,8 +44,8 @@ In this case any requests to /flipper\* will be routed to Flipper::UI - includin
 *good:*
 ```ruby
 YourRailsApp::Application.routes.draw do
-  mount Flipper::Api.app(flipper) => '/flipper/api'
-  mount Flipper::UI.app(flipper) => '/flipper'
+  mount Flipper::Api.app(Flipper) => '/flipper/api'
+  mount Flipper::UI.app(Flipper) => '/flipper'
 end
 ````
 For more advanced mounting techniques and for suggestions on how to mount in a non-Rails application, it is recommend that you review the [`Flipper::UI` usage documentation](https://github.com/jnunemaker/flipper/blob/master/docs/ui/README.md#usage) as the same approaches apply to `Flipper::Api`.

data/docs/http/README.md

@@ -8,17 +8,18 @@ Initialize the HTTP adapter with a configuration Hash.
 ```ruby
 require 'flipper/adapters/http'
 
-configuration = {
-  url: 'http://app.com/mount-point', # required
-  headers: { 'X-Custom-Header' => 'foo' },
-  basic_auth_username: 'user123',
-  basic_auth_password: 'password123'
-  read_timeout: 5,
-  open_timeout: 2,
-}
-
-adapter = Flipper::Adapters::Http.new(configuration)
-flipper = Flipper.new(adapter)
+Flipper.configure do |config|
+  config.adapter do
+    Flipper::Adapters::Http.new({
+      url: 'http://app.com/mount-point', # required
+      headers: { 'X-Custom-Header' => 'foo' },
+      basic_auth_username: 'user123',
+      basic_auth_password: 'password123'
+      read_timeout: 5,
+      open_timeout: 2,
+    })
+  end
+end
 ```
 
 **Required keys**:

data/docs/read-only/README.md

@@ -5,17 +5,20 @@ A [read-only](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adap
 Use this adapter to wrap another adapter and raise an exception for any writes.
 
 Any attempted write raises `Flipper::Adapters::ReadOnly::WriteAttempted`  with message  `'write attempted while in read only mode'`
+
 ## Usage
+
 ```ruby
 # example wrapping memory adapter
 require 'flipper/adapters/read_only'
 
-memory_adapter = Flipper::Adapters::Memory.new
-read_only_adapter = Flipper::Adapters::ReadOnly.new(memory_adapter)
-
-flipper = Flipper.new(read_only_adapter)
+Flipper.configure do |config|
+  config.adapter do
+    Flipper::Adapters::ReadOnly.new(Flipper::Adapters::Memory.new)
+  end
+end
 
 # Enabling a feature
-> flipper[:dashboard_panel].enable
+> Flipper[:dashboard_panel].enable
 => Flipper::Adapters::ReadOnly::WriteAttempted: write attempted while in read only mode
 ```

data/examples/api/basic.ru

@@ -0,0 +1,19 @@
+#
+# Usage:
+#   # if you want it to not reload and be really fast
+#   bin/rackup examples/api/basic.ru -p 9999
+#
+#   # if you want reloading
+#   bin/shotgun examples/api/basic.ru -p 9999
+#
+#   http://localhost:9999/
+#
+
+require 'bundler/setup'
+require "flipper/api"
+require "flipper/adapters/pstore"
+
+# You can uncomment this to get some default data:
+# Flipper.enable :logging
+
+run Flipper::Api.app

data/examples/api/custom_memoized.ru

@@ -0,0 +1,37 @@
+#
+# Usage:
+#   # if you want it to not reload and be really fast
+#   bin/rackup examples/api/custom_memoized.ru -p 9999
+#
+#   # if you want reloading
+#   bin/shotgun examples/api/custom_memoized.ru -p 9999
+#
+#   http://localhost:9999/
+#
+
+require 'bundler/setup'
+require "active_support/notifications"
+require "flipper/api"
+require "flipper/adapters/pstore"
+
+adapter = Flipper::Adapters::Instrumented.new(
+  Flipper::Adapters::PStore.new,
+  instrumenter: ActiveSupport::Notifications,
+)
+flipper = Flipper.new(adapter)
+
+ActiveSupport::Notifications.subscribe(/.*/, ->(*args) {
+  name, start, finish, id, data = args
+  case name
+  when "adapter_operation.flipper"
+    p data[:adapter_name] => data[:operation]
+  end
+})
+
+# You can uncomment this to get some default data:
+# flipper[:logging].enable_percentage_of_time 5
+
+run Flipper::Api.app(flipper) { |builder|
+  builder.use Flipper::Middleware::SetupEnv, flipper
+  builder.use Flipper::Middleware::Memoizer, preload: true
+}

data/examples/api/memoized.ru

@@ -0,0 +1,43 @@
+#
+# Usage:
+#   # if you want it to not reload and be really fast
+#   bin/rackup examples/api/memoized.ru -p 9999
+#
+#   # if you want reloading
+#   bin/shotgun examples/api/memoized.ru -p 9999
+#
+#   http://localhost:9999/
+#
+
+require 'bundler/setup'
+require "active_support/notifications"
+require "flipper/api"
+require "flipper/adapters/pstore"
+
+Flipper.configure do |config|
+  config.adapter {
+    Flipper::Adapters::Instrumented.new(
+      Flipper::Adapters::PStore.new,
+      instrumenter: ActiveSupport::Notifications,
+    )
+  }
+end
+
+ActiveSupport::Notifications.subscribe(/.*/, ->(*args) {
+  name, start, finish, id, data = args
+  case name
+  when "adapter_operation.flipper"
+    p data[:adapter_name] => data[:operation]
+  end
+})
+
+Flipper.register(:admins) { |actor|
+  actor.respond_to?(:admin?) && actor.admin?
+}
+
+# You can uncomment this to get some default data:
+# Flipper.enable :logging
+
+run Flipper::Api.app { |builder|
+  builder.use Flipper::Middleware::Memoizer, preload: true
+}

data/examples/configuring_default.rb

@@ -3,9 +3,7 @@ require 'flipper'
 
 # sets up default adapter so Flipper works like Flipper::DSL
 Flipper.configure do |config|
-  config.default do
-    Flipper.new Flipper::Adapters::Memory.new
-  end
+  config.adapter { Flipper::Adapters::Memory.new }
 end
 
 puts Flipper.enabled?(:search) # => false

data/examples/instrumentation_last_accessed_at.rb

@@ -0,0 +1,37 @@
+# Quick example of how to keep track of when a feature was last checked.
+require 'bundler/setup'
+require 'securerandom'
+require 'active_support/notifications'
+require 'flipper'
+
+class FlipperSubscriber
+  def self.stats
+    @stats ||= {}
+  end
+
+  def call(name, start, finish, id, payload)
+    if payload[:operation] == :enabled?
+      feature_name = payload.fetch(:feature_name)
+      self.class.stats[feature_name] = Time.now
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe(/feature_operation.flipper/, new)
+end
+
+Flipper.configure do |config|
+  config.default {
+    Flipper.new(config.adapter, instrumenter: ActiveSupport::Notifications)
+  }
+end
+
+Flipper.enabled?(:search)
+Flipper.enabled?(:booyeah)
+Flipper.enabled?(:hooray)
+sleep 1
+Flipper.enabled?(:booyeah)
+Flipper.enabled?(:hooray)
+sleep 1
+Flipper.enabled?(:hooray)
+
+pp FlipperSubscriber.stats

data/examples/memoizing.rb

@@ -4,12 +4,9 @@ require 'flipper/adapters/operation_logger'
 require 'flipper/instrumentation/log_subscriber'
 
 Flipper.configure do |config|
-  config.default do
+  config.adapter do
     # pick an adapter, this uses memory, any will do
-    adapter = Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
-
-    # pass adapter to handy DSL instance
-    Flipper.new(adapter)
+    Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
   end
 end
 

data/lib/flipper/adapters/pstore.rb

@@ -216,3 +216,7 @@ module Flipper
     end
   end
 end
+
+Flipper.configure do |config|
+  config.adapter { Flipper::Adapters::PStore.new }
+end

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

@@ -37,7 +37,8 @@ module Flipper
           # Sync all the gate values.
           remote_get_all.each do |feature_key, remote_gates_hash|
             feature = Feature.new(feature_key, @local)
-            local_gates_hash = local_get_all[feature_key] || @local.default_config
+            # Check if feature_key is in hash before accessing to prevent unintended hash modification
+            local_gates_hash = local_get_all.key?(feature_key) ? local_get_all[feature_key] : @local.default_config
             local_gate_values = GateValues.new(local_gates_hash)
             remote_gate_values = GateValues.new(remote_gates_hash)
             FeatureSynchronizer.new(feature, local_gate_values, remote_gate_values).call

data/lib/flipper/configuration.rb

@@ -1,7 +1,33 @@
 module Flipper
   class Configuration
-    def initialize
-      @default = -> { Flipper.new(Flipper::Adapters::Memory.new) }
+    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
@@ -13,7 +39,7 @@ module Flipper
     #
     #   # sets the default block to generate a new instance using ActiveRecord adapter
     #   configuration.default do
-    #     require "flipper-active_record"
+    #     require "flipper/adapters/active_record"
     #     Flipper.new(Flipper::Adapters::ActiveRecord.new)
     #   end
     #

data/lib/flipper/middleware/memoizer.rb

@@ -8,15 +8,14 @@ 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
       #
       #   use Flipper::Middleware::Memoizer
       #
       #   # using with preload_all features
-      #   use Flipper::Middleware::Memoizer, preload_all: true
+      #   use Flipper::Middleware::Memoizer, preload: true
       #
       #   # using with preload specific features
       #   use Flipper::Middleware::Memoizer, preload: [:stats, :search, :some_feature]
@@ -26,6 +25,11 @@ module Flipper
           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
         @opts = opts
         @env_key = opts.fetch(:env_key, 'flipper')
@@ -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/railtie.rb

@@ -0,0 +1,46 @@
+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,
+        log: true
+      )
+    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.log", after: :load_config_initializers do |app|
+      config = app.config.flipper
+      if config.log && config.instrumenter == ActiveSupport::Notifications
+        require "flipper/instrumentation/log_subscriber"
+      end
+    end
+
+    initializer "flipper.identifier" do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.include Flipper::Identifier
+      end
+    end
+  end
+end