flipper 0.17.2 → 0.20.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74b7be3b37819e554e11bfc661794d50f90804ae5665bd7913c08239bb2d14aa
-  data.tar.gz: 1045e365f31c98ce51e441d0ea0aacac5eeb36e4a9158aa246bd9c3fa778ab81
+  metadata.gz: d324a4fa07054c9c189fba3f8baa100e4c4a70ae4618b251c84be77f56e27e54
+  data.tar.gz: 73a1ff5ddfdfbf04f43296fb0dfe67dd0cf2a3ab094d35909462dfa30fc9ba87
 SHA512:
-  metadata.gz: 78acbd2f020a59b1b4912cea78715195e6956918a3c4ad5158053a233709d98ee73f464b6f24bd081e25428ad04721538f8dde7ae4b76d994e421926bd9c11f9
-  data.tar.gz: d81461bbaacf4028e4f1eb5c9e7ce633d94176ba42c9a5da8504f3123b5caa8c5c73355a17fd5623b5b9c0d2c3c41ab76952e923183a7ae3fbe466a034472506
+  metadata.gz: 5ae1cde3eef862c76a40f6166deb59406a5f8a3560829220fd4291c614e4fd8eb91d300ad2eb218f81e433a447e90c6d88fea194ad05d9e27ea5a282bac51dfe
+  data.tar.gz: 33e3c151261a516fc9cf5b8415c57c472f5a5560d6670815f872b71cbf99293c79a1e7f1788e2db6a262f7c3b7e8ec2479717b59cdd6dba2cdc52945d9fc5c1b

data/Changelog.md

@@ -1,3 +1,29 @@
+## 0.19.1
+
+### Additions/Changes
+
+* Bump rack-protection version to < 2.2 (https://github.com/jnunemaker/flipper/pull/487)
+* Add memoizer_options to Flipper::Api.app (https://github.com/jnunemaker/flipper/commit/174ad4bb94046a25c432d3c53fe1ff9f5a76d838)
+
+## 0.19.0
+
+### Additions/Changes
+
+* 100% of actors is now considered conditional. Feature#on?, Feature#conditional?, Feature#state would all be affected. See https://github.com/jnunemaker/flipper/issues/463 for more.
+* Several doc updates.
+
+## 0.18.0
+
+### Additions/Changes
+
+* Add support for feature descriptions to flipper-ui (https://github.com/jnunemaker/flipper/pull/461).
+* Remove rubocop (https://github.com/jnunemaker/flipper/pull/469).
+* flipper-ui redesign (https://github.com/jnunemaker/flipper/pull/470).
+* Removed support for ruby 2.4.
+* Added support for ruby 2.7.
+* Removed support for Rails 4.x.x.
+* Removed support for customizing actors, groups, % of actors and % of time text in flipper-ui in favor of automatic and more descriptive text.
+
 ## 0.17.2
 
 ### Additions/Changes
@@ -90,7 +116,7 @@
 
 ### Additions/Changes
 
-* Added rollout adapter documentation (https://github.com/jnunemaker/flipper/pull/328).  
+* Added rollout adapter documentation (https://github.com/jnunemaker/flipper/pull/328).
 
 ### Bug Fixes
 

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.2.5
+FROM ruby:2.5
 
 RUN apt-get update && apt-get install -y \
   # build-essential \

data/Gemfile

@@ -12,20 +12,16 @@ gem 'shotgun', '~> 0.9'
 gem 'statsd-ruby', '~> 1.2.1'
 gem 'rspec', '~> 3.0'
 gem 'rack-test', '~> 0.6.3'
-gem 'sqlite3', "~> #{ENV['SQLITE3_VERSION'] || '1.3.11'}"
+gem 'sqlite3', "~> #{ENV['SQLITE3_VERSION'] || '1.4.1'}"
 gem 'rails', "~> #{ENV['RAILS_VERSION'] || '6.0.0'}"
 gem 'minitest', '~> 5.8'
 gem 'minitest-documentation'
-gem 'rubocop'
-gem 'rubocop-rspec'
 gem 'webmock', '~> 3.0'
+gem 'climate_control'
 
 group(:guard) do
   gem 'guard', '~> 2.15'
-  gem 'guard-rubocop', '~> 1.3'
   gem 'guard-rspec', '~> 4.5'
   gem 'guard-bundler', '~> 2.2'
-  gem 'guard-coffeescript', '~> 2.0'
-  gem 'guard-sass', '~> 1.6'
   gem 'rb-fsevent', '~> 0.9'
 end

data/Rakefile

@@ -1,7 +1,6 @@
 #!/usr/bin/env rake
 $LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'rake/testtask'
-require 'rubocop/rake_task'
 require 'flipper/version'
 
 # gem install pkg/*.gem
@@ -50,6 +49,4 @@ Rake::TestTask.new(:test_rails) do |t|
   t.warning = false
 end
 
-RuboCop::RakeTask.new
-
-task default: [:spec, :test, :test_rails, :rubocop]
+task default: [:spec, :test, :test_rails]

data/docs/Adapters.md

@@ -4,7 +4,7 @@ I plan on supporting the adapters in the flipper repo. Other adapters are welcom
 
 ## Officially Supported
 
-* [ActiveRecord adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_record) - Rails 3, 4, and 5.
+* [ActiveRecord adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_record) - Rails 3, 4, 5, and 6.
 * [ActiveSupportCacheStore adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_support_cache_store) - ActiveSupport::Cache::Store
 * [Cassanity adapter](https://github.com/jnunemaker/flipper-cassanity)
 * [Http adapter](https://github.com/jnunemaker/flipper/blob/master/docs/http)

data/docs/DockerCompose.md

@@ -11,7 +11,6 @@ new contributor could start working on code with a minumum efforts.
 1. Install gems `docker-compose run --rm app bundle install`
 1. Run specs `docker-compose run --rm app bundle exec rspec`
 1. Run tests `docker-compose run --rm app bundle exec rake test`
-1. Clear and check files with Rubocop `docker-compose run --rm  app bundle exec rubocop -D`
 1. Optional: log in to container an using a `bash` shell for running specs
 ```sh
 docker-compose run --rm app bash

data/docs/Gates.md

@@ -96,7 +96,7 @@ flipper[:logging].enable percentage
 flipper[:logging].enabled? # this will return true 5% of the time.
 
 # you can also use shortcut methods
-flipper.enable_percentage_of_time :search, 5 # registers a feature called "enable_percentage_of_time" and enables it 5% of the time
+flipper.enable_percentage_of_time :search, 5 # registers a feature called "search" and enables it 5% of the time
 flipper.disable_percentage_of_time :search # sets to 0
 flipper[:search].enable_percentage_of_time 5
 flipper[:search].disable_percentage_of_time # sets to 0

data/examples/memoizing.rb

@@ -0,0 +1,39 @@
+require File.expand_path('../example_setup', __FILE__)
+
+require 'flipper'
+require 'flipper/adapters/operation_logger'
+require 'flipper/instrumentation/log_subscriber'
+
+Flipper.configure do |config|
+  config.default 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)
+  end
+end
+
+Flipper.enable(:foo)
+Flipper.enable(:bar)
+Flipper.disable(:baz)
+Flipper.disable(:wick)
+# reset the operation logging adapter to empty for clarity
+Flipper.adapter.reset
+
+# Turn on memoization (the memoizing middleware does this per request).
+Flipper.memoize = true
+
+# Preload all the features.
+Flipper.preload_all
+
+# Do as many feature checks as your heart desires.
+%w[foo bar baz wick].each do |name|
+  Flipper.enabled?(name)
+end
+
+# See that only one operation exists, a get_all (which is the preload_all).
+pp Flipper.adapter.operations
+# [#<Flipper::Adapters::OperationLogger::Operation:0x00007fdcfe1100e8
+#   @args=[],
+#   @type=:get_all>]

data/flipper.gemspec

@@ -25,7 +25,6 @@ Gem::Specification.new do |gem|
   gem.authors       = ['John Nunemaker']
   gem.email         = ['nunemaker@gmail.com']
   gem.summary       = 'Feature flipper for ANYTHING'
-  gem.description   = 'Feature flipper is the act of enabling/disabling features in your application, ideally without re-deploying or changing anything in your code base. Flipper makes this extremely easy to do with any backend you would like to use.' # rubocop:disable Layout/LineLength
   gem.homepage      = 'https://github.com/jnunemaker/flipper'
   gem.license       = 'MIT'
 

data/lib/flipper.rb

@@ -1,7 +1,7 @@
 require "forwardable"
 
 module Flipper
-  extend self # rubocop:disable Style/ModuleFunction
+  extend self
   extend Forwardable
 
   # Private: The namespace for all instrumented events.
@@ -65,7 +65,8 @@ module Flipper
                  :time, :percentage_of_time,
                  :features, :feature, :[], :preload, :preload_all,
                  :adapter, :add, :exist?, :remove, :import,
-                 :memoize=, :memoizing?
+                 :memoize=, :memoizing?,
+                 :sync, :sync_secret # For Flipper::Cloud. Will error for OSS Flipper.
 
   # Public: Use this to register a group by name.
   #

data/lib/flipper/adapters/dual_write.rb

@@ -0,0 +1,67 @@
+module Flipper
+  module Adapters
+    class DualWrite
+      include ::Flipper::Adapter
+
+      # Public: The name of the adapter.
+      attr_reader :name
+
+      # Public: Build a new sync instance.
+      #
+      # local - The local flipper adapter that should serve reads.
+      # remote - The remote flipper adapter that writes should go to first (in
+      #          addition to the local adapter).
+      def initialize(local, remote, options = {})
+        @name = :dual_write
+        @local = local
+        @remote = remote
+      end
+
+      def features
+        @local.features
+      end
+
+      def get(feature)
+        @local.get(feature)
+      end
+
+      def get_multi(features)
+        @local.get_multi(features)
+      end
+
+      def get_all
+        @local.get_all
+      end
+
+      def add(feature)
+        result = @remote.add(feature)
+        @local.add(feature)
+        result
+      end
+
+      def remove(feature)
+        result = @remote.remove(feature)
+        @local.remove(feature)
+        result
+      end
+
+      def clear(feature)
+        result = @remote.clear(feature)
+        @local.clear(feature)
+        result
+      end
+
+      def enable(feature, gate, thing)
+        result = @remote.enable(feature, gate, thing)
+        @local.enable(feature, gate, thing)
+        result
+      end
+
+      def disable(feature, gate, thing)
+        result = @remote.disable(feature, gate, thing)
+        @local.disable(feature, gate, thing)
+        result
+      end
+    end
+  end
+end

data/lib/flipper/adapters/operation_logger.rb

@@ -117,6 +117,11 @@ module Flipper
       def reset
         @operations.clear
       end
+
+      def inspect
+        inspect_id = ::Kernel::format "%x", (object_id * 2)
+        %(#<#{self.class}:0x#{inspect_id} @name=#{name.inspect}, @operations=#{@operations.inspect}, @adapter=#{@adapter.inspect}>)
+      end
     end
   end
 end

data/lib/flipper/adapters/sync.rb

@@ -17,7 +17,7 @@ module Flipper
       # Public: Build a new sync instance.
       #
       # local - The local flipper adapter that should serve reads.
-      # remote - The remote flipper adpater that should serve writes and update
+      # remote - The remote flipper adapter that should serve writes and update
       #          the local on an interval.
       # interval - The Float or Integer number of seconds between syncs from
       # remote to local. Default value is set in IntervalSynchronizer.
@@ -34,26 +34,26 @@ module Flipper
           synchronizer = Synchronizer.new(@local, @remote, sync_options)
           IntervalSynchronizer.new(synchronizer, interval: options[:interval])
         end
-        sync
+        synchronize
       end
 
       def features
-        sync
+        synchronize
         @local.features
       end
 
       def get(feature)
-        sync
+        synchronize
         @local.get(feature)
       end
 
       def get_multi(features)
-        sync
+        synchronize
         @local.get_multi(features)
       end
 
       def get_all
-        sync
+        synchronize
         @local.get_all
       end
 
@@ -89,7 +89,7 @@ module Flipper
 
       private
 
-      def sync
+      def synchronize
         @synchronizer.call
       end
     end

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

@@ -23,7 +23,7 @@ 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 Layout/LineLength
+          raise 'Flipper::Middleware::Memoizer no longer initializes with a flipper instance or block. Read more at: https://git.io/vSo31.'
         end
 
         @app = app

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/test/shared_adapter_test.rb

@@ -1,4 +1,3 @@
-# rubocop:disable Metrics/ModuleLength
 module Flipper
   module Test
     module SharedAdapterTests

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.17.2'.freeze
+  VERSION = '0.20.0.beta2'.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