flipper 0.7.5 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a196a39494974789034ad6b513ee2f18573909fb
-  data.tar.gz: 04f3f2db1fa374a7f00220721e48f31f0362b535
+  metadata.gz: afbd6c749fed154fc4f131d9a100b6f475d5963c
+  data.tar.gz: 28a2fb5f3bf64365f003399cc6287e823da4ae23
 SHA512:
-  metadata.gz: fc05f220c23ce4bff918312d62652b6598fe2cab2f0280c300a6508828681dbe84190003cdaf9c2216daa093a4e28c8dd1a7366645a2d62dd6a7aa332751f01a
-  data.tar.gz: f0f2642874e663cc1b778ab90d1646f625f8e79cf5bfad016148114599b5f0d1befba6c92f72b0b59febe0d6321c5230a270e4f35b59f215d00ce100bafd4a2d
+  metadata.gz: 9edcf82bb9e5e600ff797c726aef6bb59c96f9ce86a5ccdc085048553c7d7112b45eb8cdf37782660f0b7d793a2f1abe4a2886d186aac06b721e80ef917bbc18
+  data.tar.gz: c0f9f0df3475ba5adee9467512fce9580d32b9398497389173cc9fb12ed5d853d9e26c6e8e4d1c98f8cfd5a4dcc3d61014bd5f366f4af0f2fd1466b432eb5852

data/Changelog.md

@@ -1,3 +1,15 @@
+## 0.8
+
+* removed Flipper::Decorator and Flipper::Adapters::Decorator in favor of just calling methods on wrapped adapter
+* fix bug where certain versions of AR left off quotes for key column which caused issues with MySQL https://github.com/jnunemaker/flipper/issues/120
+* fix bug where AR would store multiple gate values for percentage gates for each enable/disable and then nondeterministically pick one on read (https://github.com/jnunemaker/flipper/pull/122 and https://github.com/jnunemaker/flipper/pull/124)
+* added readonly adapter (https://github.com/jnunemaker/flipper/pull/111)
+* flipper groups now match for truthy values rather than explicitly only true (https://github.com/jnunemaker/flipper/issues/110)
+* removed gate operation instrumentation (https://github.com/jnunemaker/flipper/commit/32f14ed1fb25c64961b23c6be3dc6773143a06c8); I don't think it was useful and never found myself instrumenting it in reality
+* initial implementation of flipper api - very limited functionality right now (get/delete feature, boolean gate for feature) but more is on the way
+* made it easy to remove a feature (https://github.com/jnunemaker/flipper/pull/126)
+* add minitest shared tests for adapters that work the same as the shared specs for rspec (https://github.com/jnunemaker/flipper/pull/127)
+
 ## 0.7.5
 
 * support for rails 5 beta/ rack 2 alpha

data/Gemfile

@@ -14,6 +14,7 @@ gem 'rspec', '~> 3.0'
 gem 'rack-test', '~> 0.6.3'
 gem 'sqlite3', '~> 1.3.11'
 gem 'rails', "~> #{ENV["RAILS_VERSION"] || '4.2.5'}"
+gem 'minitest', '~> 5.8.0'
 
 # for active support tests in test/ and only needed for ruby 2.2.x
 gem 'test-unit', '~> 3.0'

data/Rakefile

@@ -1,5 +1,6 @@
 #!/usr/bin/env rake
 $LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require 'rake/testtask'
 require "flipper/version"
 
 # gem install pkg/*.gem
@@ -35,10 +36,14 @@ namespace :spec do
   end
 end
 
-task :default => :spec
+Rake::TestTask.new do |t|
+  t.libs = ['lib', 'test']
+  t.pattern = "test/**/*_test.rb"
+end
 
-task :test do
-  sh "bundle exec ruby -Itest test/generators/flipper/active_record_generator_test.rb"
+Rake::TestTask.new(:shared_test) do |t|
+  t.libs = ['lib', 'test']
+  t.pattern = "lib/flipper/shared/test/**_test.rb"
 end
 
-task :default => :test
+task :default => [:spec, :test, :shared_test]

data/docs/Optimization.md

@@ -18,10 +18,16 @@ If you set your flipper instance up in an initializer, you can pass a block to t
 
 ```ruby
 # config/initializers/flipper.rb
-$flipper = Flipper.new(...)
+module MyRailsApp
+  def self.flipper
+    @flipper ||= Flipper.new(...)
+  end
+end
 
 # config/application.rb
-config.middleware.use Flipper::Middleware::Memoizer, lambda { $flipper }
+config.middleware.use Flipper::Middleware::Memoizer, lambda {
+  MyRailsApp.flipper
+}
 ```
 
 **Note**: Be sure that the middleware is high enough up in your stack that all feature checks are wrapped.

data/lib/flipper/adapters/instrumented.rb

@@ -1,17 +1,21 @@
-require 'flipper/adapters/decorator'
 require 'flipper/instrumenters/noop'
 
 module Flipper
   module Adapters
     # Internal: Adapter that wraps another adapter and instruments all adapter
     # operations. Used by flipper dsl to provide instrumentatin for flipper.
-    class Instrumented < Decorator
+    class Instrumented
+      include ::Flipper::Adapter
+
       # Private: The name of instrumentation events.
       InstrumentationName = "adapter_operation.#{InstrumentationNamespace}"
 
       # Private: What is used to instrument all the things.
       attr_reader :instrumenter
 
+      # Public: The name of the adapter.
+      attr_reader :name
+
       # Internal: Initializes a new adapter instance.
       #
       # adapter - Vanilla adapter instance to wrap.
@@ -20,7 +24,7 @@ module Flipper
       #           :instrumenter - What to use to instrument all the things.
       #
       def initialize(adapter, options = {})
-        super(adapter)
+        @adapter = adapter
         @name = :instrumented
         @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
       end
@@ -29,11 +33,11 @@ module Flipper
       def features
         payload = {
           :operation => :features,
-          :adapter_name => name,
+          :adapter_name => @adapter.name,
         }
 
         @instrumenter.instrument(InstrumentationName, payload) { |payload|
-          payload[:result] = super
+          payload[:result] = @adapter.features
         }
       end
 
@@ -41,12 +45,12 @@ module Flipper
       def add(feature)
         payload = {
           :operation => :add,
-          :adapter_name => name,
+          :adapter_name => @adapter.name,
           :feature_name => feature.name,
         }
 
         @instrumenter.instrument(InstrumentationName, payload) { |payload|
-          payload[:result] = super
+          payload[:result] = @adapter.add(feature)
         }
       end
 
@@ -54,12 +58,12 @@ module Flipper
       def remove(feature)
         payload = {
           :operation => :remove,
-          :adapter_name => name,
+          :adapter_name => @adapter.name,
           :feature_name => feature.name,
         }
 
         @instrumenter.instrument(InstrumentationName, payload) { |payload|
-          payload[:result] = super
+          payload[:result] = @adapter.remove(feature)
         }
       end
 
@@ -67,12 +71,12 @@ module Flipper
       def clear(feature)
         payload = {
           :operation => :clear,
-          :adapter_name => name,
+          :adapter_name => @adapter.name,
           :feature_name => feature.name,
         }
 
         @instrumenter.instrument(InstrumentationName, payload) { |payload|
-          payload[:result] = super
+          payload[:result] = @adapter.clear(feature)
         }
       end
 
@@ -80,12 +84,12 @@ module Flipper
       def get(feature)
         payload = {
           :operation => :get,
-          :adapter_name => name,
+          :adapter_name => @adapter.name,
           :feature_name => feature.name,
         }
 
         @instrumenter.instrument(InstrumentationName, payload) { |payload|
-          payload[:result] = super
+          payload[:result] = @adapter.get(feature)
         }
       end
 
@@ -93,13 +97,13 @@ module Flipper
       def enable(feature, gate, thing)
         payload = {
           :operation => :enable,
-          :adapter_name => name,
+          :adapter_name => @adapter.name,
           :feature_name => feature.name,
           :gate_name => gate.name,
         }
 
         @instrumenter.instrument(InstrumentationName, payload) { |payload|
-          payload[:result] = super
+          payload[:result] = @adapter.enable(feature, gate, thing)
         }
       end
 
@@ -107,13 +111,13 @@ module Flipper
       def disable(feature, gate, thing)
         payload = {
           :operation => :disable,
-          :adapter_name => name,
+          :adapter_name => @adapter.name,
           :feature_name => feature.name,
           :gate_name => gate.name,
         }
 
         @instrumenter.instrument(InstrumentationName, payload) { |payload|
-          payload[:result] = super
+          payload[:result] = @adapter.disable(feature, gate, thing)
         }
       end
     end

data/lib/flipper/adapters/memoizable.rb

@@ -1,19 +1,26 @@
-require 'flipper/adapters/decorator'
-
 module Flipper
   module Adapters
     # Internal: Adapter that wraps another adapter with the ability to memoize
     # adapter calls in memory. Used by flipper dsl and the memoizer middleware
     # to make it possible to memoize adapter calls for the duration of a request.
-    class Memoizable < Decorator
+    class Memoizable
+      include ::Flipper::Adapter
+
       FeaturesKey = :flipper_features
 
       # Internal
       attr_reader :cache
 
+      # Public: The name of the adapter.
+      attr_reader :name
+
+      # Internal: The adapter this adapter is wrapping.
+      attr_reader :adapter
+
       # Public
       def initialize(adapter, cache = nil)
-        super(adapter)
+        @adapter = adapter
+        @name = :memoizable
         @cache = cache || {}
         @memoize = false
       end
@@ -22,23 +29,23 @@ module Flipper
       def features
         if memoizing?
           cache.fetch(FeaturesKey) {
-            cache[FeaturesKey] = super
+            cache[FeaturesKey] = @adapter.features
           }
         else
-          super
+          @adapter.features
         end
       end
 
       # Public
       def add(feature)
-        result = super
+        result = @adapter.add(feature)
         cache.delete(FeaturesKey) if memoizing?
         result
       end
 
       # Public
       def remove(feature)
-        result = super
+        result = @adapter.remove(feature)
         if memoizing?
           cache.delete(FeaturesKey)
           cache.delete(feature)
@@ -48,7 +55,7 @@ module Flipper
 
       # Public
       def clear(feature)
-        result = super
+        result = @adapter.clear(feature)
         cache.delete(feature) if memoizing?
         result
       end
@@ -56,22 +63,22 @@ module Flipper
       # Public
       def get(feature)
         if memoizing?
-          cache.fetch(feature) { cache[feature] = super }
+          cache.fetch(feature) { cache[feature] = @adapter.get(feature) }
         else
-          super
+          @adapter.get(feature)
         end
       end
 
       # Public
       def enable(feature, gate, thing)
-        result = super
+        result = @adapter.enable(feature, gate, thing)
         cache.delete(feature) if memoizing?
         result
       end
 
       # Public
       def disable(feature, gate, thing)
-        result = super
+        result = @adapter.disable(feature, gate, thing)
         cache.delete(feature) if memoizing?
         result
       end

data/lib/flipper/adapters/memory.rb

@@ -5,7 +5,7 @@ module Flipper
     # Public: Adapter for storing everything in memory (ie: Hash).
     # Useful for tests/specs.
     class Memory
-      include Adapter
+      include ::Flipper::Adapter
 
       FeaturesKey = :flipper_features
 

data/lib/flipper/adapters/operation_logger.rb

@@ -1,11 +1,11 @@
-require 'flipper/adapters/decorator'
-
 module Flipper
   module Adapters
     # Public: Adapter that wraps another adapter and stores the operations.
     #
     # Useful in tests to verify calls and such. Never use outside of testing.
-    class OperationLogger < Decorator
+    class OperationLogger
+      include ::Flipper::Adapter
+
       Operation = Struct.new(:type, :args)
 
       OperationTypes = [
@@ -21,20 +21,57 @@ module Flipper
       # Internal: An array of the operations that have happened.
       attr_reader :operations
 
+      # Internal: The name of the adapter.
+      attr_reader :name
+
       # Public
       def initialize(adapter, operations = nil)
-        super(adapter)
+        @adapter = adapter
+        @name = :operation_logger
         @operations = operations || []
       end
 
-      # Wraps original method with in memory log of operations performed.
-      OperationTypes.each do |type|
-        class_eval <<-EOE
-          def #{type}(*args)
-            @operations << Operation.new(:#{type}, args)
-            super
-          end
-        EOE
+      # Public: The set of known features.
+      def features
+        @operations << Operation.new(:features, [])
+        @adapter.features
+      end
+
+      # Public: Adds a feature to the set of known features.
+      def add(feature)
+        @operations << Operation.new(:add, [feature])
+        @adapter.add(feature)
+      end
+
+      # Public: Removes a feature from the set of known features and clears
+      # all the values for the feature.
+      def remove(feature)
+        @operations << Operation.new(:remove, [feature])
+        @adapter.remove(feature)
+      end
+
+      # Public: Clears all the gate values for a feature.
+      def clear(feature)
+        @operations << Operation.new(:clear, [feature])
+        @adapter.clear(feature)
+      end
+
+      # Public
+      def get(feature)
+        @operations << Operation.new(:get, [feature])
+        @adapter.get(feature)
+      end
+
+      # Public
+      def enable(feature, gate, thing)
+        @operations << Operation.new(:enable, [feature, gate, thing])
+        @adapter.enable(feature, gate, thing)
+      end
+
+      # Public
+      def disable(feature, gate, thing)
+        @operations << Operation.new(:disable, [feature, gate, thing])
+        @adapter.disable(feature, gate, thing)
       end
 
       # Public: Count the number of times a certain operation happened.

data/lib/flipper/adapters/pstore.rb

@@ -6,7 +6,7 @@ module Flipper
     # Public: Adapter based on Ruby's pstore database. Perfect for when a local
     # file is good enough for storing features.
     class PStore
-      include Adapter
+      include ::Flipper::Adapter
 
       FeaturesKey = :flipper_features
 

data/lib/flipper/adapters/read_only.rb

@@ -0,0 +1,51 @@
+module Flipper
+  module Adapters
+    # Public: Adapter that wraps another adapter and raises for any writes.
+    class ReadOnly
+      include ::Flipper::Adapter
+
+      class WriteAttempted < Error
+        def initialize(message = nil)
+          super(message || "write attempted while in read only mode")
+        end
+      end
+
+      # Internal: The name of the adapter.
+      attr_reader :name
+
+      # Public
+      def initialize(adapter)
+        @adapter = adapter
+        @name = :read_only
+      end
+
+      def features
+        @adapter.features
+      end
+
+      def get(feature)
+        @adapter.get(feature)
+      end
+
+      def add(feature)
+        raise WriteAttempted
+      end
+
+      def remove(feature)
+        raise WriteAttempted
+      end
+
+      def clear(feature)
+        raise WriteAttempted
+      end
+
+      def enable(feature, gate, thing)
+        raise WriteAttempted
+      end
+
+      def disable(feature, gate, thing)
+        raise WriteAttempted
+      end
+    end
+  end
+end