flipper-ui 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd4963986e65fb20081d23374099f2a054df7e78a81e2571ad3640831b7d0d81
-  data.tar.gz: b94fc64dcf6752a2951c8c03bd6161c46e4850f206ebb049f4aa8b0a5b20e881
+  metadata.gz: 3be7bbda3ec1a09b1cc1c421766ea520a9a933eeb1628ea27281c35a174725a2
+  data.tar.gz: ca0375faf5a0cfd4f2b6c04435c803e9414c2e41337918ad9f8bb9f95f579e46
 SHA512:
-  metadata.gz: c46dbab449279c506b9d5ce1d2869392b8e4f0f6b8dab59b527b64a2acf25504cb5fb3e8af2e2601176f0f7c026afdf547196d197d4d0cfad0031e8a26f270bc
-  data.tar.gz: 95ed1aefbe02cdac6f8e938107a00a41e2e8754fa20351fa35948942557746d863d542c52b3993846828ce327b52aa4c151e1422997baea0e8099ff4c3580988
+  metadata.gz: effdbdd4ab7c0646dcd1a50ebd0d96fd78dc2dabb2a87ae1e524a2a4b32ce43c1b01e6e96046d1e9bc4fe298a805a2c31c713b83ad1dbfb26c31dfb70f714e90
+  data.tar.gz: 8d1f5b3f946a0b5d9bb42db7a497484c490cc2a2e9f15562e046ddeb41be0dba1cdda19ef1016bb5f7966ab35c600b8b57418533797b3000cec927671079ff1a

data/examples/ui/authorization.ru

@@ -5,50 +5,13 @@
 #   http://localhost:9999/
 #
 require 'bundler/setup'
-require "logger"
-
 require "flipper/ui"
 require "flipper/adapters/pstore"
-require "active_support/notifications"
 
 Flipper.register(:admins) { |actor|
   actor.respond_to?(:admin?) && actor.admin?
 }
 
-Flipper.register(:early_access) { |actor|
-  actor.respond_to?(:early?) && actor.early?
-}
-
-# Setup logging of flipper calls.
-if ENV["LOG"] == "1"
-  $logger = Logger.new(STDOUT)
-  require "flipper/instrumentation/log_subscriber"
-  Flipper::Instrumentation::LogSubscriber.logger = $logger
-end
-
-adapter = Flipper::Adapters::PStore.new
-flipper = Flipper.new(adapter, instrumenter: ActiveSupport::Notifications)
-
-Flipper::UI.configure do |config|
-  # config.banner_text = 'Production Environment'
-  # config.banner_class = 'danger'
-  config.feature_creation_enabled = true
-  config.feature_removal_enabled = true
-  # config.show_feature_description_in_list = true
-  config.descriptions_source = lambda do |_keys|
-    {
-      "search_performance_another_long_thing" => "Just to test feature name length.",
-      "gauges_tracking" => "Should we track page views with gaug.es.",
-      "unused" => "Not used.",
-      "suits" => "Are suits necessary in business?",
-      "secrets" => "Secrets are lies.",
-      "logging" => "Log all the things.",
-      "new_cache" => "Like the old cache but newer.",
-      "a/b" => "Why would someone use a slash? I don't know but someone did. Let's make this really long so they regret using slashes. Please don't use slashes.",
-    }
-  end
-end
-
 # Example middleware to allow reading the Flipper UI but nothing else.
 class FlipperReadOnlyMiddleware
   def initialize(app)
@@ -67,18 +30,17 @@ class FlipperReadOnlyMiddleware
 end
 
 # You can uncomment these to get some default data:
-# flipper[:search_performance_another_long_thing].enable
-# flipper[:gauges_tracking].enable
-# flipper[:unused].disable
-# flipper[:suits].enable_actor Flipper::Actor.new('1')
-# flipper[:suits].enable_actor Flipper::Actor.new('6')
-# flipper[:secrets].enable_group :admins
-# flipper[:secrets].enable_group :early_access
-# flipper[:logging].enable_percentage_of_time 5
-# flipper[:new_cache].enable_percentage_of_actors 15
-# flipper["something/slashed"].add
-
-run Flipper::UI.app(flipper) { |builder|
+# Flipper.enable(:search_performance_another_long_thing)
+# Flipper.disable(:gauges_tracking)
+# Flipper.disable(:unused)
+# Flipper.enable_actor(:suits, Flipper::Actor.new('1'))
+# Flipper.enable_actor(:suits, Flipper::Actor.new('6'))
+# Flipper.enable_group(:secrets, :admins)
+# Flipper.enable_percentage_of_time(:logging, 5)
+# Flipper.enable_percentage_of_actors(:new_cache, 15)
+# Flipper.add("a/b")
+
+run Flipper::UI.app { |builder|
   builder.use Rack::Session::Cookie, secret: "_super_secret"
   builder.use FlipperReadOnlyMiddleware
 }

data/examples/ui/basic.ru

@@ -42,16 +42,16 @@ Flipper::UI.configure do |config|
 end
 
 # You can uncomment these to get some default data:
-# flipper[:search_performance_another_long_thing].enable
-# flipper[:gauges_tracking].enable
-# flipper[:unused].disable
-# flipper[:suits].enable_actor Flipper::Actor.new('1')
-# flipper[:suits].enable_actor Flipper::Actor.new('6')
-# flipper[:secrets].enable_group :admins
-# flipper[:secrets].enable_group :early_access
-# flipper[:logging].enable_percentage_of_time 5
-# flipper[:new_cache].enable_percentage_of_actors 15
-# flipper["a/b"].add
+# Flipper.enable(:search_performance_another_long_thing)
+# Flipper.disable(:gauges_tracking)
+# Flipper.disable(:unused)
+# Flipper.enable_actor(:suits, Flipper::Actor.new('1'))
+# Flipper.enable_actor(:suits, Flipper::Actor.new('6'))
+# Flipper.enable_group(:secrets, :admins)
+# Flipper.enable_group(:secrets, :early_access)
+# Flipper.enable_percentage_of_time(:logging, 5)
+# Flipper.enable_percentage_of_actors(:new_cache, 15)
+# Flipper.add("a/b")
 
 run Flipper::UI.app { |builder|
   builder.use Rack::Session::Cookie, secret: "_super_secret"

data/lib/flipper/ui.rb

@@ -39,14 +39,14 @@ module Flipper
     def self.app(flipper = nil, options = {})
       env_key = options.fetch(:env_key, 'flipper')
       rack_protection_options = options.fetch(:rack_protection, use: :authenticity_token)
+
       app = ->(_) { [200, { 'Content-Type' => 'text/html' }, ['']] }
       builder = Rack::Builder.new
       yield builder if block_given?
       builder.use Rack::Protection, rack_protection_options
       builder.use Rack::MethodOverride
       builder.use Flipper::Middleware::SetupEnv, flipper, env_key: env_key
-      builder.use Flipper::Middleware::Memoizer, env_key: env_key
-      builder.use Flipper::UI::Middleware, env_key: env_key
+      builder.use Flipper::UI::Middleware, flipper: flipper, env_key: env_key
       builder.run app
       klass = self
       builder.define_singleton_method(:inspect) { klass.inspect } # pretty rake routes output

data/lib/flipper/ui/action.rb

@@ -151,7 +151,7 @@ module Flipper
       # location - The String location to set the Location header to.
       def redirect_to(location)
         status 302
-        header 'Location', "#{script_name}#{location}"
+        header 'Location', "#{script_name}#{Rack::Utils.escape_path(location)}"
         halt [@code, @headers, ['']]
       end
 

data/lib/flipper/ui/actions/actors_gate.rb

@@ -27,7 +27,7 @@ module Flipper
           value = params['value'].to_s.strip
 
           if Util.blank?(value)
-            error = Rack::Utils.escape("#{value.inspect} is not a valid actor value.")
+            error = "#{value.inspect} is not a valid actor value."
             redirect_to("/features/#{feature.key}/actors?error=#{error}")
           end
 

data/lib/flipper/ui/actions/features.rb

@@ -49,14 +49,14 @@ module Flipper
           value = params['value'].to_s.strip
 
           if Util.blank?(value)
-            error = Rack::Utils.escape("#{value.inspect} is not a valid feature name.")
+            error = "#{value.inspect} is not a valid feature name."
             redirect_to("/features/new?error=#{error}")
           end
 
           feature = flipper[value]
           feature.add
 
-          redirect_to "/features/#{Rack::Utils.escape_path(value)}"
+          redirect_to "/features/#{value}"
         end
       end
     end

data/lib/flipper/ui/actions/groups_gate.rb

@@ -35,7 +35,7 @@ module Flipper
 
             redirect_to("/features/#{feature.key}")
           else
-            error = Rack::Utils.escape("The group named #{value.inspect} has not been registered.")
+            error = "The group named #{value.inspect} has not been registered."
             redirect_to("/features/#{feature.key}/groups?error=#{error}")
           end
         end

data/lib/flipper/ui/actions/percentage_of_actors_gate.rb

@@ -16,7 +16,7 @@ module Flipper
           begin
             feature.enable_percentage_of_actors params['value']
           rescue ArgumentError => exception
-            error = Rack::Utils.escape("Invalid percentage of actors value: #{exception.message}")
+            error = "Invalid percentage of actors value: #{exception.message}"
             redirect_to("/features/#{@feature.key}?error=#{error}")
           end
 

data/lib/flipper/ui/actions/percentage_of_time_gate.rb

@@ -16,7 +16,7 @@ module Flipper
           begin
             feature.enable_percentage_of_time params['value']
           rescue ArgumentError => exception
-            error = Rack::Utils.escape("Invalid percentage of time value: #{exception.message}")
+            error = "Invalid percentage of time value: #{exception.message}"
             redirect_to("/features/#{@feature.key}?error=#{error}")
           end
 

data/lib/flipper/ui/middleware.rb

@@ -12,6 +12,7 @@ module Flipper
       def initialize(app, options = {})
         @app = app
         @env_key = options.fetch(:env_key, 'flipper')
+        @flipper = options.fetch(:flipper) { Flipper }
 
         @action_collection = ActionCollection.new
 
@@ -43,7 +44,7 @@ module Flipper
         if action_class.nil?
           @app.call(env)
         else
-          flipper = env.fetch(@env_key)
+          flipper = env.fetch(@env_key) { Flipper }
           action_class.run(flipper, request)
         end
       end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.21.0'.freeze
+  VERSION = '0.22.0'.freeze
 end

data/spec/flipper/ui/actions/actors_gate_spec.rb

@@ -61,6 +61,23 @@ RSpec.describe Flipper::UI::Actions::ActorsGate do
         expect(last_response.headers['Location']).to eq('/features/search')
       end
 
+      context "when feature name contains space" do
+        before do
+          post 'features/sp%20ace/actors',
+               { 'value' => value, 'operation' => 'enable', 'authenticity_token' => token },
+               'rack.session' => session
+        end
+
+        it 'adds item to members' do
+          expect(flipper["sp ace"].actors_value).to include('User;6')
+        end
+
+        it "redirects back to feature" do
+          expect(last_response.status).to be(302)
+          expect(last_response.headers['Location']).to eq('/features/sp%20ace')
+        end
+      end
+
       context 'value contains whitespace' do
         let(:value) { '  User;6  ' }
 
@@ -75,7 +92,7 @@ RSpec.describe Flipper::UI::Actions::ActorsGate do
 
           it 'redirects back to feature' do
             expect(last_response.status).to be(302)
-            expect(last_response.headers['Location']).to eq('/features/search/actors?error=%22%22+is+not+a+valid+actor+value.')
+            expect(last_response.headers['Location']).to eq('/features/search/actors?error=%22%22%20is%20not%20a%20valid%20actor%20value.')
           end
         end
 
@@ -84,7 +101,7 @@ RSpec.describe Flipper::UI::Actions::ActorsGate do
 
           it 'redirects back to feature' do
             expect(last_response.status).to be(302)
-            expect(last_response.headers['Location']).to eq('/features/search/actors?error=%22%22+is+not+a+valid+actor+value.')
+            expect(last_response.headers['Location']).to eq('/features/search/actors?error=%22%22%20is%20not%20a%20valid%20actor%20value.')
           end
         end
       end

data/spec/flipper/ui/actions/boolean_gate_spec.rb

@@ -31,6 +31,24 @@ RSpec.describe Flipper::UI::Actions::BooleanGate do
       end
     end
 
+    context "with space in feature name" do
+      before do
+        flipper.disable :search
+        post 'features/sp%20ace/boolean',
+             { 'action' => 'Enable', 'authenticity_token' => token },
+             'rack.session' => session
+      end
+
+      it 'updates feature' do
+        expect(flipper.enabled?("sp ace")).to be(true)
+      end
+
+      it 'redirects back to feature' do
+        expect(last_response.status).to be(302)
+        expect(last_response.headers['Location']).to eq('/features/sp%20ace')
+      end
+    end
+
     context 'with disable' do
       before do
         flipper.enable :search

data/spec/flipper/ui/actions/feature_spec.rb

@@ -29,6 +29,24 @@ RSpec.describe Flipper::UI::Actions::Feature do
       expect(last_response.headers['Location']).to eq('/features')
     end
 
+    context "with space in feature name" do
+      before do
+        flipper.enable "sp ace"
+        delete '/features/sp%20ace',
+               { 'authenticity_token' => token },
+               'rack.session' => session
+      end
+
+      it 'removes feature' do
+        expect(flipper.features.map(&:key)).not_to include('sp ace')
+      end
+
+      it 'redirects to features' do
+        expect(last_response.status).to be(302)
+        expect(last_response.headers['Location']).to eq('/features')
+      end
+    end
+
     context 'when feature_removal_enabled is set to false' do
       around do |example|
         begin

data/spec/flipper/ui/actions/features_spec.rb

@@ -95,7 +95,7 @@ RSpec.describe Flipper::UI::Actions::Features do
         expect(last_response.headers['Location']).to eq('/features/notifications_next')
       end
 
-      context 'feature name contains whitespace' do
+      context 'feature name has whitespace at beginning and end' do
         let(:feature_name) { '  notifications_next   ' }
 
         it 'adds feature without whitespace' do
@@ -103,6 +103,19 @@ RSpec.describe Flipper::UI::Actions::Features do
         end
       end
 
+      context 'feature name contains space' do
+        let(:feature_name) { 'notifications next' }
+
+        it 'adds feature with space' do
+          expect(flipper.features.map(&:key)).to include('notifications next')
+        end
+
+        it 'redirects to feature' do
+          expect(last_response.status).to be(302)
+          expect(last_response.headers['Location']).to eq('/features/notifications%20next')
+        end
+      end
+
       context 'for an invalid feature name' do
         context 'empty feature name' do
           let(:feature_name) { '' }
@@ -113,7 +126,7 @@ RSpec.describe Flipper::UI::Actions::Features do
 
           it 'redirects back to feature' do
             expect(last_response.status).to be(302)
-            expect(last_response.headers['Location']).to eq('/features/new?error=%22%22+is+not+a+valid+feature+name.')
+            expect(last_response.headers['Location']).to eq('/features/new?error=%22%22%20is%20not%20a%20valid%20feature%20name.')
           end
         end
 
@@ -126,7 +139,7 @@ RSpec.describe Flipper::UI::Actions::Features do
 
           it 'redirects back to feature' do
             expect(last_response.status).to be(302)
-            expect(last_response.headers['Location']).to eq('/features/new?error=%22%22+is+not+a+valid+feature+name.')
+            expect(last_response.headers['Location']).to eq('/features/new?error=%22%22%20is%20not%20a%20valid%20feature%20name.')
           end
         end
       end

data/spec/flipper/ui/actions/groups_gate_spec.rb

@@ -60,6 +60,23 @@ RSpec.describe Flipper::UI::Actions::GroupsGate do
         expect(last_response.headers['Location']).to eq('/features/search')
       end
 
+      context 'feature name contains space' do
+        before do
+          post 'features/sp%20ace/groups',
+               { 'value' => group_name, 'operation' => 'enable', 'authenticity_token' => token },
+               'rack.session' => session
+        end
+
+        it 'adds item to members' do
+          expect(flipper["sp ace"].groups_value).to include('admins')
+        end
+
+        it 'redirects back to feature' do
+          expect(last_response.status).to be(302)
+          expect(last_response.headers['Location']).to eq('/features/sp%20ace')
+        end
+      end
+
       context 'group name contains whitespace' do
         let(:group_name) { '  admins  ' }
 
@@ -74,7 +91,7 @@ RSpec.describe Flipper::UI::Actions::GroupsGate do
 
           it 'redirects back to feature' do
             expect(last_response.status).to be(302)
-            expect(last_response.headers['Location']).to eq('/features/search/groups?error=The+group+named+%22not_here%22+has+not+been+registered.')
+            expect(last_response.headers['Location']).to eq('/features/search/groups?error=The%20group%20named%20%22not_here%22%20has%20not%20been%20registered.')
           end
         end
 
@@ -83,7 +100,7 @@ RSpec.describe Flipper::UI::Actions::GroupsGate do
 
           it 'redirects back to feature' do
             expect(last_response.status).to be(302)
-            expect(last_response.headers['Location']).to eq('/features/search/groups?error=The+group+named+%22%22+has+not+been+registered.')
+            expect(last_response.headers['Location']).to eq('/features/search/groups?error=The%20group%20named%20%22%22%20has%20not%20been%20registered.')
           end
         end
 
@@ -92,7 +109,7 @@ RSpec.describe Flipper::UI::Actions::GroupsGate do
 
           it 'redirects back to feature' do
             expect(last_response.status).to be(302)
-            expect(last_response.headers['Location']).to eq('/features/search/groups?error=The+group+named+%22%22+has+not+been+registered.')
+            expect(last_response.headers['Location']).to eq('/features/search/groups?error=The%20group%20named%20%22%22%20has%20not%20been%20registered.')
           end
         end
       end

data/spec/flipper/ui/actions/percentage_of_actors_gate_spec.rb

@@ -30,6 +30,23 @@ RSpec.describe Flipper::UI::Actions::PercentageOfActorsGate do
       end
     end
 
+    context 'with space in feature name' do
+      before do
+        post 'features/sp%20ace/percentage_of_actors',
+             { 'value' => '24', 'authenticity_token' => token },
+             'rack.session' => session
+      end
+
+      it 'enables the feature' do
+        expect(flipper["sp ace"].percentage_of_actors_value).to be(24)
+      end
+
+      it 'redirects back to feature' do
+        expect(last_response.status).to be(302)
+        expect(last_response.headers['Location']).to eq('/features/sp%20ace')
+      end
+    end
+
     context 'with invalid value' do
       before do
         post 'features/search/percentage_of_actors',
@@ -43,7 +60,7 @@ RSpec.describe Flipper::UI::Actions::PercentageOfActorsGate do
 
       it 'redirects back to feature' do
         expect(last_response.status).to be(302)
-        expect(last_response.headers['Location']).to eq('/features/search?error=Invalid+percentage+of+actors+value%3A+value+must+be+a+positive+number+less+than+or+equal+to+100%2C+but+was+555')
+        expect(last_response.headers['Location']).to eq('/features/search?error=Invalid%20percentage%20of%20actors%20value:%20value%20must%20be%20a%20positive%20number%20less%20than%20or%20equal%20to%20100,%20but%20was%20555')
       end
     end
   end

data/spec/flipper/ui/actions/percentage_of_time_gate_spec.rb

@@ -30,6 +30,23 @@ RSpec.describe Flipper::UI::Actions::PercentageOfTimeGate do
       end
     end
 
+    context 'with space in feature name' do
+      before do
+        post 'features/sp%20ace/percentage_of_time',
+             { 'value' => '24', 'authenticity_token' => token },
+             'rack.session' => session
+      end
+
+      it 'enables the feature' do
+        expect(flipper["sp ace"].percentage_of_time_value).to be(24)
+      end
+
+      it 'redirects back to feature' do
+        expect(last_response.status).to be(302)
+        expect(last_response.headers['Location']).to eq('/features/sp%20ace')
+      end
+    end
+
     context 'with invalid value' do
       before do
         post 'features/search/percentage_of_time',
@@ -43,7 +60,7 @@ RSpec.describe Flipper::UI::Actions::PercentageOfTimeGate do
 
       it 'redirects back to feature' do
         expect(last_response.status).to be(302)
-        expect(last_response.headers['Location']).to eq('/features/search?error=Invalid+percentage+of+time+value%3A+value+must+be+a+positive+number+less+than+or+equal+to+100%2C+but+was+555')
+        expect(last_response.headers['Location']).to eq('/features/search?error=Invalid%20percentage%20of%20time%20value:%20value%20must%20be%20a%20positive%20number%20less%20than%20or%20equal%20to%20100,%20but%20was%20555')
       end
     end
   end

data/spec/flipper/ui_spec.rb

@@ -24,19 +24,6 @@ RSpec.describe Flipper::UI do
     end
   end
 
-  describe 'Initializing middleware lazily with a block' do
-    let(:app) do
-      build_app(-> { flipper })
-    end
-
-    it 'works' do
-      flipper.enable :some_great_feature
-      get '/features'
-      expect(last_response.status).to be(200)
-      expect(last_response.body).to include('some_great_feature')
-    end
-  end
-
   describe 'Request method unsupported by action' do
     it 'raises error' do
       expect do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-ui
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-09 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -56,14 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: erubi
   requirement: !ruby/object:Gem::Requirement