flipper 0.10.2 → 0.11.0.beta1

data/lib/flipper/adapters/operation_logger.rb

@@ -19,7 +19,7 @@ module Flipper
         :get_multi,
         :enable,
         :disable,
-      ]
+      ].freeze
 
       # Internal: An array of the operations that have happened.
       attr_reader :operations

data/lib/flipper/adapters/pstore.rb

@@ -1,5 +1,5 @@
-require "pstore"
-require "set"
+require 'pstore'
+require 'set'
 
 module Flipper
   module Adapters
@@ -17,7 +17,7 @@ module Flipper
       attr_reader :path
 
       # Public
-      def initialize(path = "flipper.pstore")
+      def initialize(path = 'flipper.pstore')
         @path = path
         @store = ::PStore.new(path)
         @name = :pstore
@@ -55,14 +55,15 @@ module Flipper
         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
+          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

data/lib/flipper/adapters/read_only.rb

@@ -6,7 +6,7 @@ module Flipper
 
       class WriteAttempted < Error
         def initialize(message = nil)
-          super(message || "write attempted while in read only mode")
+          super(message || 'write attempted while in read only mode')
         end
       end
 
@@ -27,23 +27,23 @@ module Flipper
         @adapter.get(feature)
       end
 
-      def add(feature)
+      def add(_feature)
         raise WriteAttempted
       end
 
-      def remove(feature)
+      def remove(_feature)
         raise WriteAttempted
       end
 
-      def clear(feature)
+      def clear(_feature)
         raise WriteAttempted
       end
 
-      def enable(feature, gate, thing)
+      def enable(_feature, _gate, _thing)
         raise WriteAttempted
       end
 
-      def disable(feature, gate, thing)
+      def disable(_feature, _gate, _thing)
         raise WriteAttempted
       end
     end

data/lib/flipper/dsl.rb

@@ -158,9 +158,7 @@ module Flipper
         raise ArgumentError, "#{name} must be a String or Symbol"
       end
 
-      @memoized_features[name.to_sym] ||= Feature.new(name, @adapter, {
-        :instrumenter => instrumenter,
-      })
+      @memoized_features[name.to_sym] ||= Feature.new(name, @adapter, instrumenter: instrumenter)
     end
 
     # Public: Preload the features with the given names.

data/lib/flipper/feature.rb

@@ -41,7 +41,7 @@ module Flipper
     #
     # Returns the result of Adapter#enable.
     def enable(thing = true)
-      instrument(:enable) { |payload|
+      instrument(:enable) do |payload|
         adapter.add self
 
         gate = gate_for(thing)
@@ -50,14 +50,14 @@ module Flipper
         payload[:thing] = wrapped_thing
 
         adapter.enable self, gate, wrapped_thing
-      }
+      end
     end
 
     # Public: Disable this feature for something.
     #
     # Returns the result of Adapter#disable.
     def disable(thing = false)
-      instrument(:disable) { |payload|
+      instrument(:disable) do |payload|
         adapter.add self
 
         gate = gate_for(thing)
@@ -65,12 +65,8 @@ module Flipper
         payload[:gate_name] = gate.name
         payload[:thing] = wrapped_thing
 
-        if gate.is_a?(Gates::Boolean)
-          adapter.clear self
-        else
-          adapter.disable self, gate, wrapped_thing
-        end
-      }
+        adapter.disable self, gate, wrapped_thing
+      end
     end
 
     # Public: Removes this feature.
@@ -84,14 +80,14 @@ module Flipper
     #
     # Returns true if enabled, false if not.
     def enabled?(thing = nil)
-      instrument(:enabled?) { |payload|
+      instrument(:enabled?) do |payload|
         values = gate_values
         thing = gate(:actor).wrap(thing) unless thing.nil?
         payload[:thing] = thing
         context = FeatureCheckContext.new(
           feature_name: @name,
           values: values,
-          thing: thing,
+          thing: thing
         )
 
         if open_gate = gates.detect { |gate| gate.open?(context) }
@@ -100,7 +96,7 @@ module Flipper
         else
           false
         end
-      }
+      end
     end
 
     # Public: Enables a feature for an actor.
@@ -346,19 +342,18 @@ module Flipper
     # Returns a Flipper::Gate.
     # Raises Flipper::GateNotFound if no gate found for thing
     def gate_for(thing)
-      gates.detect { |gate| gate.protects?(thing) } ||
-        raise(GateNotFound.new(thing))
+      gates.detect { |gate| gate.protects?(thing) } || raise(GateNotFound, thing)
     end
 
     private
 
     # Private: Instrument a feature operation.
     def instrument(operation)
-      @instrumenter.instrument(InstrumentationName) { |payload|
+      @instrumenter.instrument(InstrumentationName) do |payload|
         payload[:feature_name] = name
         payload[:operation] = operation
         payload[:result] = yield(payload) if block_given?
-      }
+      end
     end
   end
 end

data/lib/flipper/gate.rb

@@ -18,21 +18,21 @@ module Flipper
       raise 'Not implemented'
     end
 
-    def enabled?(value)
+    def enabled?(_value)
       raise 'Not implemented'
     end
 
     # Internal: Check if a gate is open for a thing. Implemented in subclass.
     #
     # Returns true if gate open for thing, false if not.
-    def open?(thing, value, options = {})
+    def open?(_thing, _value, _options = {})
       false
     end
 
     # Internal: Check if a gate is protects a thing. Implemented in subclass.
     #
     # Returns true if gate protects thing, false if not.
-    def protects?(thing)
+    def protects?(_thing)
       false
     end
 

data/lib/flipper/gate_values.rb

@@ -1,15 +1,15 @@
-require "set"
+require 'set'
 
 module Flipper
   class GateValues
     # Private: Array of instance variables that are readable through the []
     # instance method.
     LegitIvars = {
-      "boolean" => "@boolean",
-      "actors" => "@actors",
-      "groups" => "@groups",
-      "percentage_of_time" => "@percentage_of_time",
-      "percentage_of_actors" => "@percentage_of_actors",
+      'boolean' => '@boolean',
+      'actors' => '@actors',
+      'groups' => '@groups',
+      'percentage_of_time' => '@percentage_of_time',
+      'percentage_of_actors' => '@percentage_of_actors',
     }.freeze
 
     attr_reader :boolean

data/lib/flipper/gates/group.rb

@@ -27,14 +27,14 @@ module Flipper
         if context.thing.nil?
           false
         else
-          value.any? { |name|
+          value.any? do |name|
             begin
               group = Flipper.group(name)
               group.match?(context.thing, context)
             rescue GroupNotRegistered
               false
             end
-          }
+          end
         end
       end
 

data/lib/flipper/gates/percentage_of_actors.rb

@@ -29,8 +29,8 @@ module Flipper
 
         if Types::Actor.wrappable?(context.thing)
           actor = Types::Actor.wrap(context.thing)
-          key = "#{context.feature_name}#{actor.value}"
-          Zlib.crc32(key) % 100 < percentage
+          id = "#{context.feature_name}#{actor.value}"
+          Zlib.crc32(id) % 100 < percentage
         else
           false
         end

data/lib/flipper/instrumentation/log_subscriber.rb

@@ -25,9 +25,7 @@ module Flipper
         description = "Flipper feature(#{feature_name}) #{operation} #{result.inspect}"
         details = "thing=#{thing.inspect}"
 
-        unless gate_name.nil?
-          details += " gate_name=#{gate_name}"
-        end
+        details += " gate_name=#{gate_name}" unless gate_name.nil?
 
         name = '%s (%.1fms)' % [description, event.duration]
         debug "  #{color(name, CYAN, true)}  [ #{details} ]"
@@ -54,7 +52,7 @@ module Flipper
         operation = event.payload[:operation]
         result = event.payload[:result]
 
-        description = "Flipper "
+        description = 'Flipper '
         description << "feature(#{feature_name}) " unless feature_name.nil?
         description << "adapter(#{adapter_name}) "
         description << "#{operation} "

data/lib/flipper/instrumentation/metriks.rb

@@ -3,4 +3,4 @@ require 'active_support/notifications'
 require 'flipper/instrumentation/metriks_subscriber'
 
 ActiveSupport::Notifications.subscribe /\.flipper$/,
-  Flipper::Instrumentation::MetriksSubscriber
+                                       Flipper::Instrumentation::MetriksSubscriber

data/lib/flipper/instrumentation/statsd.rb

@@ -3,4 +3,4 @@ require 'active_support/notifications'
 require 'flipper/instrumentation/statsd_subscriber'
 
 ActiveSupport::Notifications.subscribe /\.flipper$/,
-  Flipper::Instrumentation::StatsdSubscriber
+                                       Flipper::Instrumentation::StatsdSubscriber

data/lib/flipper/instrumentation/statsd_subscriber.rb

@@ -18,9 +18,7 @@ module Flipper
       end
 
       def update_counter(metric)
-        if self.class.client
-          self.class.client.increment metric
-        end
+        self.class.client.increment metric if self.class.client
       end
     end
   end

data/lib/flipper/instrumentation/subscriber.rb

@@ -17,12 +17,12 @@ module Flipper
       end
 
       # Internal: Override in subclass.
-      def update_timer(metric)
+      def update_timer(_metric)
         raise 'not implemented'
       end
 
       # Internal: Override in subclass.
-      def update_counter(metric)
+      def update_counter(_metric)
         raise 'not implemented'
       end
 
@@ -34,7 +34,8 @@ module Flipper
         if respond_to?(method_name)
           send(method_name)
         else
-          puts "Could not update #{operation_type} metrics as #{self.class} did not respond to `#{method_name}`"
+          puts "Could not update #{operation_type} metrics as #{self.class} " \
+               "did not respond to `#{method_name}`"
         end
       end
 
@@ -49,11 +50,12 @@ module Flipper
         update_timer "flipper.feature_operation.#{operation}"
 
         if @payload[:operation] == :enabled?
-          metric_name = if result
-            "flipper.feature.#{feature_name}.enabled"
-          else
-            "flipper.feature.#{feature_name}.disabled"
-          end
+          metric_name =
+            if result
+              "flipper.feature.#{feature_name}.enabled"
+            else
+              "flipper.feature.#{feature_name}.disabled"
+            end
 
           update_counter metric_name
         end
@@ -67,11 +69,10 @@ module Flipper
         value = @payload[:value]
         key = @payload[:key]
 
-
         update_timer "flipper.adapter.#{adapter_name}.#{operation}"
       end
 
-      QUESTION_MARK = "?".freeze
+      QUESTION_MARK = '?'.freeze
 
       # Private
       def strip_trailing_question_mark(operation)

data/lib/flipper/instrumenters/memory.rb

@@ -17,11 +17,7 @@ module Flipper
         # block rather than the one passed to #instrument.
         payload = payload.dup
 
-        result = if block_given?
-          yield payload
-        else
-          nil
-        end
+        result = (yield payload if block_given?)
         @events << Event.new(name, payload, result)
         result
       end

data/lib/flipper/instrumenters/noop.rb

@@ -1,7 +1,7 @@
 module Flipper
   module Instrumenters
     class Noop
-      def self.instrument(name, payload = {})
+      def self.instrument(_name, payload = {})
         yield payload if block_given?
       end
     end

data/lib/flipper/middleware/memoizer.rb

@@ -3,43 +3,29 @@ require 'rack/body_proxy'
 module Flipper
   module Middleware
     class Memoizer
-      # Public: Initializes an instance of the Memoizer middleware.
+      # Public: Initializes an instance of the Memoizer middleware. The flipper
+      # instance must be setup in the env of the request. You can do this by
+      # using the Flipper::Middleware::SetupEnv middleware.
       #
       # 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.
       #
       # Examples
       #
-      #   # using with a normal flipper instance
-      #   flipper = Flipper.new(...)
-      #   use Flipper::Middleware::Memoizer, flipper
-      #
-      #   # using with a block that yields a flipper instance
-      #   use Flipper::Middleware::Memoizer, lambda { Flipper.new(...) }
+      #   use Flipper::Middleware::Memoizer
       #
       #   # using with preload_all features
-      #   use Flipper::Middleware::Memoizer, flipper, preload_all: true
+      #   use Flipper::Middleware::Memoizer, preload_all: true
       #
       #   # using with preload specific features
-      #   use Flipper::Middleware::Memoizer, flipper, preload: [:stats, :search, :some_feature]
+      #   use Flipper::Middleware::Memoizer, preload: [:stats, :search, :some_feature]
       #
-      def initialize(app, flipper_or_block, opts = {})
+      def initialize(app, opts = {})
         @app = app
         @opts = opts
-
-        if flipper_or_block.respond_to?(:call)
-          @flipper_block = flipper_or_block
-        else
-          @flipper = flipper_or_block
-        end
-      end
-
-      def flipper
-        @flipper ||= @flipper_block.call
       end
 
       def call(env)
+        flipper = env.fetch('flipper')
         original = flipper.adapter.memoizing?
         flipper.adapter.memoize = true
 
@@ -48,14 +34,12 @@ module Flipper
           flipper.preload(names)
         end
 
-        if @opts[:preload]
-          flipper.preload(@opts[:preload])
-        end
+        flipper.preload(@opts[:preload]) if @opts[:preload]
 
         response = @app.call(env)
-        response[2] = Rack::BodyProxy.new(response[2]) {
+        response[2] = Rack::BodyProxy.new(response[2]) do
           flipper.adapter.memoize = original
-        }
+        end
         response
       rescue
         flipper.adapter.memoize = original