flipper 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd726feaa644639324560bd944c759d63dcb4a49
-  data.tar.gz: c02113838e6c7cfaa712dbddda0d4fb8c26317af
+  metadata.gz: cc4f086ed26b95a195d65b0ef2162c09bf7d4878
+  data.tar.gz: 4360d2c7f218cc2790248497827ac55b866e617f
 SHA512:
-  metadata.gz: 3190149f9463a3938e5a8c773fc622356f6608bfd07c0c40ba5e8fc3ac3c4bafbb4e3351073d1346edd2171c90c47e360e1b2c9a6fa38b83150bd256ae6fdcce
-  data.tar.gz: d4bc9f0af41052af9a2bf62fee2839f67717da4065d810165014a6fc8247dcc016f9dc16d6d9f15ba9e8d94280ea7fe425e66d610a9342c1eb632e44469e76e8
+  metadata.gz: cafced6f460315fb925d0e8b849dd68bcc1c81bd719075378727095a2921ad80b4b3dce30ed616f5f9b13ac2f7a90e9521e27b01ea72957cc1a44176693caf77
+  data.tar.gz: 446d33765b51edda016f98ebf4fbf88cbd51ea5248b4e750fc8c26d72bcb24ac2d45b97929e206620b8ddbd47e46b2d57ec8b827a1554a801d4261aeadd8f98d

data/.codeclimate.yml

@@ -0,0 +1,2 @@
+exclude_patterns:
+  - "lib/flipper/ui/public"

data/.rubocop.yml

@@ -43,3 +43,6 @@ RSpec/InstanceVariable:
 
 Style/AccessorMethodName:
   Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false

data/Changelog.md

@@ -1,10 +1,24 @@
+## 0.12
+
+### Additions/Changes
+
+* Added Flipper.instance= writer method for explicitly setting the default instance (https://github.com/jnunemaker/flipper/pull/309).
+* Added Flipper::UI configuration instance for changing text and things (https://github.com/jnunemaker/flipper/pull/306).
+* Delegate memoize= and memoizing? for Flipper and Flipper::DSL (https://github.com/jnunemaker/flipper/pull/310).
+* Fixed error when enabling the same group or actor more than once (https://github.com/jnunemaker/flipper/pull/313).
+* Fixed redis cache adapter key (and thus cache misses) (https://github.com/jnunemaker/flipper/pull/325).
+* Added Rollout adapter to make it easy to import rollout data into Flipper (https://github.com/jnunemaker/flipper/pull/319).
+* Relaxed redis gem dependency constraint to allow redis-rb 4 (https://github.com/jnunemaker/flipper/pull/317).
+* Added configuration option for Flipper::UI to disable feature removal (https://github.com/jnunemaker/flipper/pull/322).
+
 ## 0.11
 
 ### Backwards Compatibility Breaks
 
-* Set flipper from env for API and UI (https://github.com/jnunemaker/flipper/pull/223 and https://github.com/jnunemaker/flipper/pull/229). It is documented, but now the memoizing middleware requires that the SetupEnv middleware is used first.
+* Set flipper from env for API and UI (https://github.com/jnunemaker/flipper/pull/223 and https://github.com/jnunemaker/flipper/pull/229). It is documented, but now the memoizing middleware requires that the SetupEnv middleware is used first, unless you are configuring a Flipper default instance.
 * Drop support for Ruby 2.0 as it is end of lined (https://github.com/jnunemaker/flipper/commit/c2c81ed89938155ce91acb5173ac38580f630e3d).
 * Allow unregistered groups (https://github.com/jnunemaker/flipper/pull/244). Only break in compatibility is that previously unregistered groups could not be enabled and now they can be.
+* Removed support for metriks (https://github.com/jnunemaker/flipper/pull/291).
 
 ### Additions/Changes
 
@@ -22,9 +36,12 @@
 * Add DSL#preload_all and Adapter#get_all to allow for making even more efficient loading of features (https://github.com/jnunemaker/flipper/pull/255).
 * Allow setting debug output of http adapter (https://github.com/jnunemaker/flipper/pull/256 and https://github.com/jnunemaker/flipper/pull/258).
 * Allow setting env key for middleware (https://github.com/jnunemaker/flipper/pull/259).
-* Added ActiveSupport cache store adapter for use with Rails.cache (https://github.com/jnunemaker/flipper/pull/265).
+* Added ActiveSupport cache store adapter for use with Rails.cache (https://github.com/jnunemaker/flipper/pull/265 and https://github.com/jnunemaker/flipper/pull/297).
 * Added support for up to 3 decimal places in percentage based rollouts (https://github.com/jnunemaker/flipper/pull/274).
 * Removed Flipper::GroupNotRegistered error as it is now unused (https://github.com/jnunemaker/flipper/pull/270).
+* Added get_all to all adapters (https://github.com/jnunemaker/flipper/pull/298).
+* Added support for Rails 5.1 (https://github.com/jnunemaker/flipper/pull/299).
+* Added Flipper default instance generation (https://github.com/jnunemaker/flipper/pull/279).
 
 ## 0.10.2
 

data/Rakefile

@@ -41,9 +41,4 @@ Rake::TestTask.new do |t|
   t.pattern = 'test/**/*_test.rb'
 end
 
-Rake::TestTask.new(:shared_test) do |t|
-  t.libs = %w(lib test)
-  t.pattern = 'lib/flipper/shared/test/**_test.rb'
-end
-
-task default: [:spec, :test, :shared_test]
+task default: [:spec, :test]

data/docs/Gates.md

@@ -15,7 +15,7 @@ flipper[:stats].enabled? # check
 
 ## 2. Group
 
-Turn on feature based on the return value of block. Super flexible way to turn on a feature for multiple things (users, people, accounts, etc.) as long as the thing returns true when passed to the block. 
+Turn on feature based on the return value of block. Super flexible way to turn on a feature for multiple things (users, people, accounts, etc.) as long as the thing returns true when passed to the block.
 
 ```ruby
 # this registers a group
@@ -71,8 +71,8 @@ In your application code, you can do something like this now:
 if flipper[:stats].enabled?(some_admin)
   # do thing...
 else
-  raise "Your are not authorized to view this page"
-end 
+  # do not do thing
+end
 ```
 
 ## 3. Individual Actor

data/lib/flipper.rb

@@ -32,7 +32,7 @@ module Flipper
   # Public: Sets Flipper::Configuration instance.
   def configuration=(configuration)
     # need to reset flipper instance if configuration changes
-    Thread.current[:flipper_instance] = nil
+    self.instance = nil
     @configuration = configuration
   end
 
@@ -46,6 +46,13 @@ module Flipper
     Thread.current[:flipper_instance] ||= configuration.default
   end
 
+  # Public: Set the flipper instance. It is most common to use the
+  # Configuration#default to set this instance, but for things like the test
+  # environment, this writer is actually useful.
+  def instance=(flipper)
+    Thread.current[:flipper_instance] = flipper
+  end
+
   # Public: All the methods delegated to instance. These should match the
   # interface of Flipper::DSL.
   def_delegators :instance,
@@ -57,7 +64,8 @@ module Flipper
                  :enable_percentage_of_time, :disable_percentage_of_time,
                  :time, :percentage_of_time,
                  :features, :feature, :[], :preload, :preload_all,
-                 :adapter, :add, :remove, :import
+                 :adapter, :add, :remove, :import,
+                 :memoize=, :memoizing?
 
   # Public: Use this to register a group by name.
   #

data/lib/flipper/dsl.rb

@@ -1,14 +1,19 @@
+require 'forwardable'
 require 'flipper/adapters/memoizable'
 require 'flipper/instrumenters/noop'
 
 module Flipper
   class DSL
+    extend Forwardable
+
     # Private
     attr_reader :adapter
 
     # Private: What is being used to instrument all the things.
     attr_reader :instrumenter
 
+    def_delegators :@adapter, :memoize=, :memoizing?
+
     # Public: Returns a new instance of the DSL.
     #
     # adapter - The adapter that this DSL instance should use.

data/lib/flipper/feature.rb

@@ -6,6 +6,7 @@ require 'flipper/gate_values'
 require 'flipper/instrumenters/noop'
 
 module Flipper
+  # rubocop:disable Metrics/ClassLength
   class Feature
     # Private: The name of feature instrumentation events.
     InstrumentationName = "feature_operation.#{InstrumentationNamespace}".freeze
@@ -83,6 +84,13 @@ module Flipper
       instrument(:remove) { adapter.remove(self) }
     end
 
+    # Public: Clears all gate values for this feature.
+    #
+    # Returns the result of Adapter#clear.
+    def clear
+      instrument(:clear) { adapter.clear(self) }
+    end
+
     # Public: Check if a feature is enabled for a thing.
     #
     # Returns true if enabled, false if not.

data/lib/flipper/middleware/memoizer.rb

@@ -52,8 +52,8 @@ module Flipper
       def memoized_call(env)
         reset_on_body_close = false
         flipper = env.fetch(@env_key) { Flipper }
-        original = flipper.adapter.memoizing?
-        flipper.adapter.memoize = true
+        original = flipper.memoizing?
+        flipper.memoize = true
 
         flipper.preload_all if @opts[:preload_all]
 
@@ -63,12 +63,12 @@ module Flipper
 
         response = @app.call(env)
         response[2] = Rack::BodyProxy.new(response[2]) do
-          flipper.adapter.memoize = original
+          flipper.memoize = original
         end
         reset_on_body_close = true
         response
       ensure
-        flipper.adapter.memoize = original if flipper && !reset_on_body_close
+        flipper.memoize = original if flipper && !reset_on_body_close
       end
     end
   end

data/lib/flipper/spec/shared_adapter_specs.rb

@@ -258,4 +258,15 @@ RSpec.shared_examples_for 'a flipper adapter' do
     expect(stats).to eq(subject.default_config.merge(boolean: 'true'))
     expect(search).to eq(subject.default_config)
   end
+
+  it 'can double enable an actor without error' do
+    actor = Flipper::Actor.new('Flipper::Actor;22')
+    expect(subject.enable(feature, actor_gate, flipper.actor(actor))).to eq(true)
+    expect(subject.enable(feature, actor_gate, flipper.actor(actor))).to eq(true)
+  end
+
+  it 'can double enable a group without error' do
+    expect(subject.enable(feature, group_gate, flipper.group(:admins))).to eq(true)
+    expect(subject.enable(feature, group_gate, flipper.group(:admins))).to eq(true)
+  end
 end

data/lib/flipper/test/shared_adapter_test.rb

@@ -253,6 +253,17 @@ module Flipper
         assert_equal @adapter.default_config.merge(boolean: 'true'), stats
         assert_equal @adapter.default_config, search
       end
+
+      def test_can_double_enable_an_actor_without_error
+        actor = Flipper::Actor.new('Flipper::Actor;22')
+        assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor))
+        assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor))
+      end
+
+      def test_can_double_enable_a_group_without_error
+        assert_equal true, @adapter.enable(@feature, @group_gate, @flipper.group(:admins))
+        assert_equal true, @adapter.enable(@feature, @group_gate, @flipper.group(:admins))
+      end
     end
   end
 end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.11.0'.freeze
+  VERSION = '0.12.0'.freeze
 end

data/spec/flipper/adapter_spec.rb

@@ -65,6 +65,13 @@ RSpec.describe Flipper::Adapter do
 
       destination_flipper.import(source_flipper)
 
+      feature = destination_flipper[:yep]
+      expect(feature.boolean_value).to be(true)
+      expect(feature.groups_value).to eq(Set[])
+      expect(feature.actors_value).to eq(Set[])
+      expect(feature.percentage_of_actors_value).to be(0)
+      expect(feature.percentage_of_time_value).to be(0)
+
       feature = destination_flipper[:preview_features]
       expect(feature.boolean_value).to be(false)
       expect(feature.actors_value).to eq(Set['1', '2', '3'])

data/spec/flipper/dsl_spec.rb

@@ -329,4 +329,21 @@ RSpec.describe Flipper::DSL do
       subject.import(destination_flipper)
     end
   end
+
+  describe '#memoize=' do
+    it 'delegates to adapter' do
+      expect(subject.adapter).not_to be_memoizing
+      subject.memoize = true
+      expect(subject.adapter).to be_memoizing
+    end
+  end
+
+  describe '#memoizing?' do
+    it 'delegates to adapter' do
+      subject.memoize = false
+      expect(subject.adapter.memoizing?).to eq(subject.memoizing?)
+      subject.memoize = true
+      expect(subject.adapter.memoizing?).to eq(subject.memoizing?)
+    end
+  end
 end

data/spec/flipper/feature_spec.rb

@@ -106,6 +106,15 @@ RSpec.describe Flipper::Feature do
     end
   end
 
+  describe '#clear' do
+    it 'clears feature using adapter' do
+      subject.enable
+      expect(subject).to be_enabled
+      subject.clear
+      expect(subject).not_to be_enabled
+    end
+  end
+
   describe '#inspect' do
     it 'returns easy to read string representation' do
       string = subject.inspect
@@ -234,6 +243,17 @@ RSpec.describe Flipper::Feature do
       expect(event.payload[:result]).not_to be_nil
     end
 
+    it 'is recorded for clear' do
+      subject.clear
+
+      event = instrumenter.events.last
+      expect(event).not_to be_nil
+      expect(event.name).to eq('feature_operation.flipper')
+      expect(event.payload[:feature_name]).to eq(:search)
+      expect(event.payload[:operation]).to eq(:clear)
+      expect(event.payload[:result]).not_to be_nil
+    end
+
     it 'is recorded for enabled?' do
       thing = Flipper::Types::Actor.new(Flipper::Actor.new('1'))
       gate = subject.gate_for(thing)

data/spec/flipper/middleware/memoizer_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe Flipper::Middleware::Memoizer do
   let(:env) { { 'flipper' => flipper } }
 
   after do
-    flipper.adapter.memoize = nil
+    flipper.memoize = nil
   end
 
   it 'raises if initialized with app and flipper instance' do
@@ -51,9 +51,9 @@ RSpec.describe Flipper::Middleware::Memoizer do
       middleware = described_class.new(app)
       body = middleware.call(env).last
 
-      expect(flipper.adapter.memoizing?).to eq(true)
+      expect(flipper.memoizing?).to eq(true)
       body.close
-      expect(flipper.adapter.memoizing?).to eq(false)
+      expect(flipper.memoizing?).to eq(false)
     end
 
     it 'clears local cache after body close' do
@@ -231,7 +231,7 @@ RSpec.describe Flipper::Middleware::Memoizer do
         middleware = described_class.new(app)
         middleware.call(env)
       rescue RuntimeError
-        expect(flipper.adapter.memoizing?).to be(false)
+        expect(flipper.memoizing?).to be(false)
       end
     end
   end

data/spec/flipper_spec.rb

@@ -54,6 +54,14 @@ RSpec.describe Flipper do
     end
   end
 
+  describe '.instance=' do
+    it 'updates Flipper.instance' do
+      instance = described_class.new(Flipper::Adapters::Memory.new)
+      described_class.instance = instance
+      expect(described_class.instance).to be(instance)
+    end
+  end
+
   describe "delegation to instance" do
     let(:group) { Flipper::Types::Group.new(:admins) }
     let(:actor) { Flipper::Actor.new("1") }
@@ -193,6 +201,16 @@ RSpec.describe Flipper do
     it 'delegates adapter to instance' do
       expect(described_class.adapter).to eq(described_class.instance.adapter)
     end
+
+    it 'delegates memoize= to instance' do
+      expect(described_class.adapter.memoizing?).to be(false)
+      described_class.memoize = true
+      expect(described_class.adapter.memoizing?).to be(true)
+    end
+
+    it 'delegates memoizing? to instance' do
+      expect(described_class.memoizing?).to eq(described_class.adapter.memoizing?)
+    end
   end
 
   describe '.register' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2018-01-06 00:00:00.000000000 Z
 dependencies: []
 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
@@ -19,6 +19,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - Changelog.md