flipper-ui 0.16.2 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 71eccacf760968860d08a08de30d86c435314c3a
-  data.tar.gz: 9e6a0d87e9158c108dbf7c80fbf663576899fcf3
+SHA256:
+  metadata.gz: 0bbc8229a6919e543d4f8ed77215b14d6e13cb68dfc24a0455a2aff99df88c50
+  data.tar.gz: 1e47a5645b80ca500a8ae212bce1bad4f2c34b7fc6a3473f59f937a5d1581b70
 SHA512:
-  metadata.gz: 5790f438fba84b3a34301fc004fab83f6609c249026438639395781b474848e2c57f38aa612a5864e6365b5e2e853b00a7c72c96c69e6b9074e37fd5e55da44b
-  data.tar.gz: ed1011c894f34b0ebd3ff87a06ed5687428c7ba8d76466d8e18a49ccfc595716eae65afdb6f2b54786ebde372f8ad367b6bea079773da00977d155d06d9b2d64
+  metadata.gz: 8d3aa432ff0629d2bff12fc556c18de7edac91dd3aab2c30e9057d974ddc76382972856930934075e144085dca9be736f69aed48d09c83f6d60a0a89dbed7538
+  data.tar.gz: 571dfd938b2742706f67f75117f76a4d6397cb1fddef2bef5334af2a92738c5e3391517abd1a73c239d60685f2026191328b9067c0f0317ba220e40880ecc53f

data/docs/ui/README.md

@@ -37,14 +37,15 @@ YourRailsApp::Application.routes.draw do
 end
 ```
 
-If you'd like to lazy load flipper, you can pass a block instead:
+If you'd like to lazy load flipper, you can instead pass a block to initialize it:
 
 ```ruby
 # config/routes.rb
 YourRailsApp::Application.routes.draw do
   flipper_block = lambda {
     # some flipper initialization here, for example:
-    # YourRailsApp.flipper
+    adapter = Flipper::Adapters::Memory.new
+    Flipper.new(adapter)
   }
   mount Flipper::UI.app(flipper_block) => '/flipper'
 end

data/flipper-ui.gemspec

@@ -10,12 +10,12 @@ Gem::Specification.new do |gem|
   gem.authors       = ['John Nunemaker']
   gem.email         = ['nunemaker@gmail.com']
   gem.summary       = 'UI for the Flipper gem'
-  gem.description   = 'Rack middleware that provides a fully featured web interface for the flipper gem.'
+  gem.description   = 'Rack middleware that provides a fully featured web interface for the flipper gem.' # rubocop:disable Metrics/LineLength
   gem.license       = 'MIT'
   gem.homepage      = 'https://github.com/jnunemaker/flipper'
 
-  gem.files         = `git ls-files`.split("\n").select(&flipper_ui_files) + ['lib/flipper/version.rb']
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_ui_files)
+  gem.files         = `git ls-files`.split("\n").select(&flipper_ui_files) + ['lib/flipper/version.rb'] # rubocop:disable Metrics/LineLength
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_ui_files) # rubocop:disable Metrics/LineLength
   gem.name          = 'flipper-ui'
   gem.require_paths = ['lib']
   gem.version       = Flipper::VERSION
@@ -24,5 +24,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'rack', '>= 1.4', '< 3'
   gem.add_dependency 'rack-protection', '>= 1.5.3', '< 2.1.0'
   gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
-  gem.add_dependency 'erubis', '~> 2.7.0'
+  gem.add_dependency 'erubi', '>= 1.0.0', '< 2.0.0'
 end

data/lib/flipper/ui.rb

@@ -41,15 +41,15 @@ module Flipper
 
     def self.app(flipper = nil, options = {})
       env_key = options.fetch(:env_key, 'flipper')
-      app = ->() { [200, { 'Content-Type' => 'text/html' }, ['']] }
+      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
-      builder.use Rack::Protection::AuthenticityToken
+      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 Middleware, env_key: env_key
+      builder.use Flipper::UI::Middleware, 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

@@ -1,6 +1,6 @@
 require 'forwardable'
 require 'flipper/ui/error'
-require 'flipper/ui/eruby'
+require 'erubi'
 require 'json'
 
 module Flipper
@@ -205,12 +205,8 @@ module Flipper
       # Private
       def view(name)
         path = views_path.join("#{name}.erb")
-
         raise "Template does not exist: #{path}" unless path.exist?
-
-        contents = path.read
-        compiled = Eruby.new(contents)
-        compiled.result proc {}.binding
+        eval(Erubi::Engine.new(path.read, escape: true).src) # rubocop:disable Security/Eval
       end
 
       # Internal: The path the app is mounted at.

data/lib/flipper/ui/configuration.rb

@@ -26,6 +26,15 @@ module Flipper
       # set to false, users won't be able to delete features from the UI.
       attr_accessor :feature_removal_enabled
 
+      # Public: Are you feeling lucky? Defaults to true. If set to false, users
+      # won't see a videoclip of Taylor Swift when there aren't any features
+      attr_accessor :fun
+
+      # Public: What should show up in the form to add actors. This can be
+      # different per application since flipper_id's can be whatever an
+      # application needs. Defaults to "a flipper id".
+      attr_accessor :add_actor_placeholder
+
       VALID_BANNER_CLASS_VALUES = %w(
         danger
         dark
@@ -47,6 +56,8 @@ module Flipper
         @banner_class = 'danger'
         @feature_creation_enabled = true
         @feature_removal_enabled = true
+        @fun = true
+        @add_actor_placeholder = "a flipper id"
       end
 
       def banner_class=(value)

data/lib/flipper/ui/views/add_actor.erb

@@ -13,7 +13,7 @@
     <form action="<%= script_name %>/features/<%= @feature.key %>/actors" method="post" class="form-inline">
       <%== csrf_input_tag %>
       <input type="hidden" name="operation" value="enable">
-      <input type="text" name="value" placeholder="ie: User:6" class="form-control mr-2">
+      <input type="text" name="value" placeholder="<%= Flipper::UI.configuration.add_actor_placeholder %>" class="form-control mr-2">
       <input type="submit" value="Add Actor" class="btn btn-light">
     </form>
   </div>

data/lib/flipper/ui/views/add_feature.erb

@@ -9,7 +9,7 @@
   <div class="card-body">
     <form action="<%= script_name %>/features" method="post" class="form-inline mb-2">
       <%== csrf_input_tag %>
-      <input type="text" name="value" size="30" placeholder="ie: search, new_pricing, etc." autofocus class="form-control mr-2 mb-2 mb-md-0">
+      <input type="text" name="value" size="30" placeholder="search, new_pricing, etc." autofocus class="form-control mr-2 mb-2 mb-md-0">
       <input type="submit" value="Add Feature" class="btn btn-light">
     </form>
     <p class="text-muted">

data/lib/flipper/ui/views/feature.erb

@@ -60,7 +60,7 @@
             <div class="col">
               <form action="<%= script_name %>/features/<%= @feature.key %>/percentage_of_actors" method="post" class="form-inline">
                 <%== csrf_input_tag %>
-                <input type="text" name="value" <% if @feature.percentage_of_actors_value > 0 %>value="<%= @feature.percentage_of_actors_value %>"<% end %> placeholder="custom (ie: 26, 32, etc.)" class="form-control form-control-sm mr-sm-2 mb-2 mb-md-0">
+                <input type="text" name="value" <% if @feature.percentage_of_actors_value > 0 %>value="<%= @feature.percentage_of_actors_value %>"<% end %> placeholder="custom (26, 32, etc.)" class="form-control form-control-sm mr-sm-2 mb-2 mb-md-0">
                 <input type="submit" name="action" value="Enable" class="btn btn-light btn-sm">
               </form>
             </div>
@@ -98,7 +98,7 @@
             <div class="col">
               <form action="<%= script_name %>/features/<%= @feature.key %>/percentage_of_time" method="post" class="form-inline">
                 <%== csrf_input_tag %>
-                <input type="text" name="value" <% if @feature.percentage_of_time_value > 0 %>value="<%= @feature.percentage_of_time_value %>"<% end %> placeholder="custom (ie: 26, 32, etc.)" class="form-control form-control-sm mr-sm-2 mb-2 mb-md-0">
+                <input type="text" name="value" <% if @feature.percentage_of_time_value > 0 %>value="<%= @feature.percentage_of_time_value %>"<% end %> placeholder="custom (26, 32, etc.)" class="form-control form-control-sm mr-sm-2 mb-2 mb-md-0">
                 <input type="submit" name="action" value="Enable" class="btn btn-light btn-sm">
               </form>
             </div>
@@ -186,7 +186,7 @@
               <form action="<%= script_name %>/features/<%= @feature.key %>/actors" method="post" class="form-inline">
                 <%== csrf_input_tag %>
                 <input type="hidden" name="operation" value="enable">
-                <input type="text" name="value" placeholder="ie: User:6" class="form-control form-control-sm mr-sm-2 mb-2 mb-sm-0">
+                <input type="text" name="value" placeholder="<%= Flipper::UI.configuration.add_actor_placeholder %>" class="form-control form-control-sm mr-sm-2 mb-2 mb-sm-0">
                 <input type="submit" value="Add Actor" class="btn btn-light btn-sm">
               </form>
             </div>
@@ -239,7 +239,7 @@
             <%= Flipper::UI.configuration.delete.description %>
           </p>
 
-          <form action="<%= script_name %>/features/<%= @feature.key %>" method="post" onsubmit="return confirm('Are you sure you want to remove <%= @feature.key %> from the list of features and disable it for everyone?')">
+          <form action="<%= script_name %>/features/<%= @feature.key %>" method="post" onsubmit="return confirm('Are you sure you want to remove this feature from the list of features and disable it for everyone?')">
             <%== csrf_input_tag %>
             <input type="hidden" name="_method" value="DELETE">
             <button type="submit" name="action" value="Delete" class="btn btn-danger" data-toggle="tooltip" title="Remove feature from list of features and disable it." data-placement="right">Delete</button>

data/lib/flipper/ui/views/features.erb

@@ -3,11 +3,19 @@
     <span class="mega-octicon octicon-plus"></span>
     <span class="mega-octicon octicon-list-unordered"></span>
     <span class="mega-octicon octicon-zap"></span>
-    <h4>But I've got a blank space baby...</h4>
-    <p>And I'll flip your features.</p>
-    <div class="embed-responsive embed-responsive-16by9">
-      <iframe class="embed-responsive-item" width="560" height="315" src="https://www.youtube.com/embed/e-ORhEE9VVg" frameborder="0" allowfullscreen></iframe>
-    </div>
+    <% if Flipper::UI.configuration.fun %>
+      <h4>But I've got a blank space baby...</h4>
+      <p>And I'll flip your features.</p>
+      <div class="embed-responsive embed-responsive-16by9">
+        <iframe class="embed-responsive-item" width="560" height="315" src="https://www.youtube.com/embed/e-ORhEE9VVg" frameborder="0" allowfullscreen></iframe>
+      </div>
+    <% else %>
+      <h4>There aren't any features to configure.</h4>
+      <p>
+        Check the <a href="https://github.com/jnunemaker/flipper#examples">examples</a> to
+        learn how to add one.
+      </p>
+    <% end %>
   </div>
 <% else %>
   <div class="card">

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.16.2'.freeze
+  VERSION = '0.17.1'.freeze
 end

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

@@ -44,7 +44,7 @@ RSpec.describe Flipper::UI::Actions::ActorsGate do
 
   describe 'POST /features/:feature/actors' do
     context 'enabling an actor' do
-      let(:value) { 'User:6' }
+      let(:value) { 'User;6' }
 
       before do
         post 'features/search/actors',
@@ -53,7 +53,7 @@ RSpec.describe Flipper::UI::Actions::ActorsGate do
       end
 
       it 'adds item to members' do
-        expect(flipper[:search].actors_value).to include('User:6')
+        expect(flipper[:search].actors_value).to include('User;6')
       end
 
       it 'redirects back to feature' do
@@ -62,10 +62,10 @@ RSpec.describe Flipper::UI::Actions::ActorsGate do
       end
 
       context 'value contains whitespace' do
-        let(:value) { '  User:6  ' }
+        let(:value) { '  User;6  ' }
 
         it 'adds item without whitespace' do
-          expect(flipper[:search].actors_value).to include('User:6')
+          expect(flipper[:search].actors_value).to include('User;6')
         end
       end
 
@@ -95,17 +95,17 @@ RSpec.describe Flipper::UI::Actions::ActorsGate do
     end
 
     context 'disabling an actor' do
-      let(:value) { 'User:6' }
+      let(:value) { 'User;6' }
 
       before do
-        flipper[:search].enable_actor Flipper::Actor.new('User:6')
+        flipper[:search].enable_actor Flipper::Actor.new('User;6')
         post 'features/search/actors',
              { 'value' => value, 'operation' => 'disable', 'authenticity_token' => token },
              'rack.session' => session
       end
 
       it 'removes item from members' do
-        expect(flipper[:search].actors_value).not_to include('User:6')
+        expect(flipper[:search].actors_value).not_to include('User;6')
       end
 
       it 'redirects back to feature' do
@@ -114,10 +114,10 @@ RSpec.describe Flipper::UI::Actions::ActorsGate do
       end
 
       context 'value contains whitespace' do
-        let(:value) { '  User:6  ' }
+        let(:value) { '  User;6  ' }
 
         it 'removes item without whitespace' do
-          expect(flipper[:search].actors_value).not_to include('User:6')
+          expect(flipper[:search].actors_value).not_to include('User;6')
         end
       end
     end

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

@@ -13,19 +13,58 @@ RSpec.describe Flipper::UI::Actions::Features do
   end
 
   describe 'GET /features' do
-    before do
-      flipper[:stats].enable
-      flipper[:search].enable
-      get '/features'
-    end
+    context "when there are some features" do
+      before do
+        flipper[:stats].enable
+        flipper[:search].enable
+        get '/features'
+      end
 
-    it 'responds with success' do
-      expect(last_response.status).to be(200)
+      it 'responds with success' do
+        expect(last_response.status).to be(200)
+      end
+
+      it 'renders template' do
+        expect(last_response.body).to include('stats')
+        expect(last_response.body).to include('search')
+      end
     end
 
-    it 'renders template' do
-      expect(last_response.body).to include('stats')
-      expect(last_response.body).to include('search')
+    context "when there are no features to list" do
+      before do
+        @original_fun_enabled = Flipper::UI.configuration.fun
+        Flipper::UI.configuration.fun = fun_mode
+      end
+
+      after do
+        Flipper::UI.configuration.fun = @original_fun_enabled
+      end
+
+      context "when fun mode is enabled" do
+        let(:fun_mode) { true }
+        before { get '/features' }
+
+        it 'responds with success' do
+          expect(last_response.status).to be(200)
+        end
+
+        it 'renders template' do
+          expect(last_response.body).to include('And I\'ll flip your features.')
+        end
+      end
+
+      context "when fun mode is disabled" do
+        let(:fun_mode) { false }
+        before { get '/features' }
+
+        it 'responds with success' do
+          expect(last_response.status).to be(200)
+        end
+
+        it 'renders template' do
+          expect(last_response.body).to include('There aren\'t any features to configure.')
+        end
+      end
     end
   end
 

data/spec/flipper/ui/configuration_spec.rb

@@ -102,4 +102,15 @@ RSpec.describe Flipper::UI::Configuration do
       expect(configuration.feature_removal_enabled).to eq(false)
     end
   end
+
+  describe "#fun" do
+    it "has default value" do
+      expect(configuration.fun).to eq(true)
+    end
+
+    it "can be updated" do
+      configuration.fun = false
+      expect(configuration.fun).to eq(false)
+    end
+  end
 end

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

@@ -77,11 +77,11 @@ RSpec.describe Flipper::UI::Decorators::Feature do
     end
 
     it 'sorts :on before :off' do
-      expect((on <=> conditional)).to be(-1)
+      expect((on <=> off)).to be(-1)
     end
 
     it 'sorts :conditional before :off' do
-      expect((on <=> conditional)).to be(-1)
+      expect((conditional <=> off)).to be(-1)
     end
 
     it 'sorts on key for identical states' do

data/spec/flipper/ui_spec.rb

@@ -54,7 +54,7 @@ RSpec.describe Flipper::UI do
   # See https://github.com/jnunemaker/flipper/issues/80
   it 'can route features with names that match static directories' do
     post 'features/refactor-images/actors',
-         { 'value' => 'User:6', 'operation' => 'enable', 'authenticity_token' => token },
+         { 'value' => 'User;6', 'operation' => 'enable', 'authenticity_token' => token },
          'rack.session' => session
     expect(last_response.status).to be(302)
     expect(last_response.headers['Location']).to eq('/features/refactor-images')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-ui
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.17.1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-20 00:00:00.000000000 Z
+date: 2019-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -56,28 +56,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: 0.17.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
-  name: erubis
+  name: erubi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.0.0
 description: Rack middleware that provides a fully featured web interface for the
   flipper gem.
 email:
@@ -220,7 +226,6 @@ files:
 - lib/flipper/ui/decorators/feature.rb
 - lib/flipper/ui/decorators/gate.rb
 - lib/flipper/ui/error.rb
-- lib/flipper/ui/eruby.rb
 - lib/flipper/ui/middleware.rb
 - lib/flipper/ui/public/css/application.css
 - lib/flipper/ui/public/fonts/bootstrap/glyphicons-halflings-regular.eot
@@ -287,8 +292,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: UI for the Flipper gem

data/lib/flipper/ui/eruby.rb

@@ -1,11 +0,0 @@
-require 'erubis'
-
-module Flipper
-  module UI
-    # Version of erubis just for flipper.
-    class Eruby < ::Erubis::Eruby
-      # switches '<%= ... %>' to escaped and '<%== ... %>' to unescaped.
-      include ::Erubis::EscapeEnhancer
-    end
-  end
-end