flipper-ui 0.16.2 → 0.20.0

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

@@ -1,43 +1,62 @@
 <% if @show_blank_slate %>
   <div class="jumbotron text-center">
-    <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>
+      <%- if Flipper::UI.configuration.feature_creation_enabled -%>
+        <p>
+          <a class="btn btn-primary btn-sm" href="<%= script_name %>/features/new">Add Feature</a>
+        </p>
+      <%- end -%>
+      <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>Getting Started</h4>
+      <p class="mb-1">You have not added any features to configure yet.</p>
+      <%- if Flipper::UI.configuration.feature_creation_enabled -%>
+        <p class="mt-2">
+          <a class="btn btn-primary btn-sm" href="<%= script_name %>/features/new">Add Feature</a>
+        </p>
+      <% else %>
+        <p>
+          Check the <a href="https://github.com/jnunemaker/flipper#examples">examples</a> to
+          learn how to add one.
+        </p>
+      <%- end -%>
+    <% end %>
   </div>
 <% else %>
   <div class="card">
-    <h4 class="card-header">Features</h4>
-    <table class="table">
-      <thead>
-        <tr class="d-flex">
-          <th class="col-1">
-            <span class="octicon octicon-squirrel"></span>
-          </th>
-          <th class="col">Feature</th>
-          <th class="col">Enabled Gates</th>
-        </tr>
-      </thead>
-      <tbody>
-        <% @features.each do |feature| %>
-          <tr class="d-flex">
-            <td class="col-1">
-              <span class="octicon octicon-squirrel <%= feature.color_class %>"></span>
-            </td>
-            <td class="col">
-              <a href="<%= "#{script_name}/features/#{feature.key}" %>">
-                <%= feature.key %></a>
-            </td>
-            <td class="col">
-              <%= feature.pretty_enabled_gate_names %>
-            </td>
-          </tr>
-        <% end %>
-      </tbody>
-    </table>
+    <div class="card-header">
+      <%- if Flipper::UI.configuration.feature_creation_enabled -%>
+        <div class="float-right">
+          <a class="btn btn-primary btn-sm" href="<%= script_name %>/features/new">Add Feature</a>
+        </div>
+      <%- end -%>
+      <h4 class="m-0">Features</h4>
+    </div>
+    <div class="card-body py-0">
+      <% @features.each do |feature| %>
+        <div class="feature row align-items-center mt-0 px-3 border-bottom">
+          <div class="col-1 col-md-auto">
+            <span class="octicon octicon-squirrel <%= feature.color_class %>" data-toggle="tooltip" title=<%= feature.state.to_s.capitalize %>></span>
+          </div>
+          <div class="col-10">
+            <a href="<%= "#{script_name}/features/#{feature.key}" %>" class="d-block px-0 py-3 btn text-left text-dark">
+              <div class="text-truncate" style="font-weight: 500"><%= feature.key %></div>
+              <% if Flipper::UI.configuration.show_feature_description_in_list? && Flipper::UI::Util.present?(feature.description) %>
+                <div class="text-muted font-weight-light" style="line-height: 1.4; white-space: initial; padding: 8px 0">
+                  <%= feature.description %>
+                </div>
+              <% end %>
+              <div class="text-muted text-truncate">
+                <%== feature.gates_in_words %>
+              </div>
+            </a>
+          </div>
+        </div>
+      <% end %>
+    </div>
   </div>
 <% end %>

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

@@ -6,17 +6,12 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">
     <link rel="stylesheet" href="<%= script_name %>/octicons/octicons.css">
     <link rel="stylesheet" href="<%= script_name %>/css/application.css">
-
-    <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
-    <!--[if lt IE 9]>
-      <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
-      <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
-    <![endif]-->
   </head>
-  <body>
-    <div class="container">
+  <body class="py-4">
+    <div class="container mw-600">
       <%- unless Flipper::UI.configuration.banner_text.nil? -%>
         <div class="alert alert-<%= Flipper::UI.configuration.banner_class %> text-center font-weight-bold">
           <%= Flipper::UI.configuration.banner_text %>
@@ -24,7 +19,7 @@
       <%- end -%>
 
       <nav aria-label="breadcrumb">
-        <ol class="breadcrumb bg-white border border-light align-items-center">
+        <ol class="breadcrumb bg-white border align-items-center mb-4">
           <% @breadcrumbs.each do |breadcrumb| %>
             <li class="breadcrumb-item <% if breadcrumb.active? %>active<% end %>">
               <% if breadcrumb.active? %>
@@ -34,11 +29,6 @@
               <% end %>
             </li>
           <% end %>
-          <li class="ml-auto">
-            <%- if Flipper::UI.configuration.feature_creation_enabled -%>
-              <a class="btn btn-sm btn-light" href="<%= script_name %>/features/new">Add Feature</a>
-            <%- end -%>
-          </li>
         </ol>
       </nav>
 

data/lib/flipper/ui.rb

@@ -30,9 +30,6 @@ module Flipper
             "deprecated. This configuration option has moved to Flipper::UI::Configuration"
         end
       end
-
-      # Public: Set attributes on this instance to customize UI text
-      attr_reader :configuration
     end
 
     def self.root
@@ -41,15 +38,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/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.16.2'.freeze
+  VERSION = '0.20.0'.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
 
@@ -73,39 +73,35 @@ RSpec.describe Flipper::UI::Actions::ActorsGate do
         context 'empty value' do
           let(:value) { '' }
 
-          # rubocop:disable Metrics/LineLength
           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.')
           end
-          # rubocop:enable Metrics/LineLength
         end
 
         context 'nil value' do
           let(:value) { nil }
 
-          # rubocop:disable Metrics/LineLength
           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.')
           end
-          # rubocop:enable Metrics/LineLength
         end
       end
     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 +110,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/feature_spec.rb

@@ -70,6 +70,15 @@ RSpec.describe Flipper::UI::Actions::Feature do
 
   describe 'GET /features/:feature' do
     before do
+      Flipper::UI.configure do |config|
+        config.descriptions_source = lambda { |_keys|
+          {
+            "stats" => "Most awesome stats",
+            "search" => "Most in-depth search",
+          }
+        }
+      end
+
       get '/features/search'
     end
 
@@ -81,10 +90,11 @@ RSpec.describe Flipper::UI::Actions::Feature do
       expect(last_response.body).to include('search')
       expect(last_response.body).to include('Enable')
       expect(last_response.body).to include('Disable')
-      expect(last_response.body).to include('Actors')
-      expect(last_response.body).to include('Groups')
-      expect(last_response.body).to include('Percentage of Time')
-      expect(last_response.body).to include('Percentage of Actors')
+      expect(last_response.body).to include('No actors enabled')
+      expect(last_response.body).to include('No groups enabled')
+      expect(last_response.body).to include('Enabled for 0% of time')
+      expect(last_response.body).to include('Enabled for 0% of actors')
+      expect(last_response.body).to include('Most in-depth search')
     end
   end
 
@@ -99,12 +109,6 @@ RSpec.describe Flipper::UI::Actions::Feature do
 
     it 'renders template' do
       expect(last_response.body).to include('search_features')
-      expect(last_response.body).to include('Enable')
-      expect(last_response.body).to include('Disable')
-      expect(last_response.body).to include('Actors')
-      expect(last_response.body).to include('Groups')
-      expect(last_response.body).to include('Percentage of Time')
-      expect(last_response.body).to include('Percentage of Actors')
     end
   end
 
@@ -119,12 +123,6 @@ RSpec.describe Flipper::UI::Actions::Feature do
 
     it 'renders template' do
       expect(last_response.body).to include('a/b')
-      expect(last_response.body).to include('Enable')
-      expect(last_response.body).to include('Disable')
-      expect(last_response.body).to include('Actors')
-      expect(last_response.body).to include('Groups')
-      expect(last_response.body).to include('Percentage of Time')
-      expect(last_response.body).to include('Percentage of Actors')
     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('You have not added any features to configure yet.')
+        end
+      end
     end
   end
 
@@ -72,12 +111,10 @@ RSpec.describe Flipper::UI::Actions::Features do
             expect(flipper.features.map(&:key)).to eq([])
           end
 
-          # rubocop:disable Metrics/LineLength
           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.')
           end
-          # rubocop:enable Metrics/LineLength
         end
 
         context 'nil feature name' do
@@ -87,12 +124,10 @@ RSpec.describe Flipper::UI::Actions::Features do
             expect(flipper.features.map(&:key)).to eq([])
           end
 
-          # rubocop:disable Metrics/LineLength
           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.')
           end
-          # rubocop:enable Metrics/LineLength
         end
       end
     end

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

@@ -21,16 +21,6 @@ RSpec.describe Flipper::UI::Actions::File do
     end
   end
 
-  describe 'GET /fonts/bootstrap/glyphicons-halflings-regular.eot' do
-    before do
-      get '/fonts/bootstrap/glyphicons-halflings-regular.eot'
-    end
-
-    it 'responds with 200' do
-      expect(last_response.status).to be(200)
-    end
-  end
-
   describe 'GET /octicons/octicons.eot' do
     before do
       get '/octicons/octicons.eot'

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

@@ -72,34 +72,28 @@ RSpec.describe Flipper::UI::Actions::GroupsGate do
         context 'unknown group name' do
           let(:group_name) { 'not_here' }
 
-          # rubocop:disable Metrics/LineLength
           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.')
           end
-          # rubocop:enable Metrics/LineLength
         end
 
         context 'empty group name' do
           let(:group_name) { '' }
 
-          # rubocop:disable Metrics/LineLength
           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.')
           end
-          # rubocop:enable Metrics/LineLength
         end
 
         context 'nil group name' do
           let(:group_name) { nil }
 
-          # rubocop:disable Metrics/LineLength
           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.')
           end
-          # rubocop:enable Metrics/LineLength
         end
       end
     end

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

@@ -41,12 +41,10 @@ RSpec.describe Flipper::UI::Actions::PercentageOfActorsGate do
         expect(flipper[:search].percentage_of_actors_value).to be(0)
       end
 
-      # rubocop:disable Metrics/LineLength
       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')
       end
-      # rubocop:enable Metrics/LineLength
     end
   end
 end

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

@@ -41,12 +41,10 @@ RSpec.describe Flipper::UI::Actions::PercentageOfTimeGate do
         expect(flipper[:search].percentage_of_time_value).to be(0)
       end
 
-      # rubocop:disable Metrics/LineLength
       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')
       end
-      # rubocop:enable Metrics/LineLength
     end
   end
 end

data/spec/flipper/ui/configuration_spec.rb

@@ -3,43 +3,10 @@ require 'helper'
 RSpec.describe Flipper::UI::Configuration do
   let(:configuration) { described_class.new }
 
-  describe "#actors" do
-    it "has default text" do
-      expect(configuration.actors.title).to eq("Actors")
-      expect(configuration.actors.description).to eq("Enable actors using the form above.")
-    end
-
-    it "can be updated" do
-      configuration.actors.title = "Actors Section"
-      expect(configuration.actors.title).to eq("Actors Section")
-    end
-  end
-
-  describe "#groups" do
-    it "has default text" do
-      expect(configuration.groups.title).to eq("Groups")
-      expect(configuration.groups.description).to eq("Enable groups using the form above.")
-    end
-  end
-
-  describe "#percentage_of_actors" do
-    it "has default text" do
-      expect(configuration.percentage_of_actors.title).to eq("Percentage of Actors")
-      expect(configuration.percentage_of_actors.description).to eq("Percentage of actors functions independently of percentage of time. If you enable 50% of Actors and 25% of Time then the feature will always be enabled for 50% of users and occasionally enabled 25% of the time for everyone.") # rubocop:disable Metrics/LineLength
-    end
-  end
-
-  describe "#percentage_of_time" do
-    it "has default text" do
-      expect(configuration.percentage_of_time.title).to eq("Percentage of Time")
-      expect(configuration.percentage_of_time.description).to eq("Percentage of actors functions independently of percentage of time. If you enable 50% of Actors and 25% of Time then the feature will always be enabled for 50% of users and occasionally enabled 25% of the time for everyone.") # rubocop:disable Metrics/LineLength
-    end
-  end
-
   describe "#delete" do
     it "has default text" do
       expect(configuration.delete.title).to eq("Danger Zone")
-      expect(configuration.delete.description).to eq("Deleting a feature removes it from the list of features and disables it for everyone.") # rubocop:disable Metrics/LineLength
+      expect(configuration.delete.description).to eq("Deleting a feature removes it from the list of features and disables it for everyone.")
     end
   end
 
@@ -102,4 +69,72 @@ 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
+
+  describe "#descriptions_source" do
+    it "has default value" do
+      expect(configuration.descriptions_source.call(%w[foo bar])).to eq({})
+    end
+
+    context "descriptions source is provided" do
+      it "can be updated" do
+        configuration.descriptions_source = lambda do |_keys|
+          YAML.load_file(FlipperRoot.join('spec/support/descriptions.yml'))
+        end
+        keys = %w[some_awesome_feature foo]
+        result = configuration.descriptions_source.call(keys)
+        expected = {
+          "some_awesome_feature" => "Awesome feature description",
+        }
+        expect(result).to eq(expected)
+      end
+    end
+  end
+
+  describe "#show_feature_description_in_list" do
+    it "has default value" do
+      expect(configuration.show_feature_description_in_list).to eq(false)
+    end
+
+    it "can be updated" do
+      configuration.show_feature_description_in_list = true
+      expect(configuration.show_feature_description_in_list).to eq(true)
+    end
+  end
+
+  describe "#show_feature_description_in_list?" do
+    subject { configuration.show_feature_description_in_list? }
+
+    context 'when using_descriptions? is false and show_feature_description_in_list is false' do
+      it { is_expected.to eq(false) }
+    end
+
+    context 'when using_descriptions? is false and show_feature_description_in_list is true' do
+      before { configuration.show_feature_description_in_list = true }
+      it { is_expected.to eq(false) }
+    end
+
+    context 'when using_descriptions? is true and show_feature_description_in_list is false' do
+      before { allow(configuration).to receive(:using_descriptions?).and_return(true) }
+      it { is_expected.to eq(false) }
+    end
+
+    context 'when using_descriptions? is true and show_feature_description_in_list is true' do
+      before do
+        allow(configuration).to receive(:using_descriptions?).and_return(true)
+        configuration.show_feature_description_in_list = true
+      end
+      it { is_expected.to eq(true) }
+    end
+  end
 end

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

@@ -22,36 +22,6 @@ RSpec.describe Flipper::UI::Decorators::Feature do
     end
   end
 
-  describe '#as_json' do
-    before do
-      @result = subject.as_json
-    end
-
-    it 'returns Hash' do
-      expect(@result).to be_instance_of(Hash)
-    end
-
-    it 'includes id' do
-      expect(@result['id']).to eq('some_awesome_feature')
-    end
-
-    it 'includes pretty name' do
-      expect(@result['name']).to eq('Some Awesome Feature')
-    end
-
-    it 'includes state' do
-      expect(@result['state']).to eq('off')
-    end
-
-    it 'includes gates' do
-      gates = subject.gates.map do |gate|
-        value = subject.gate_values[gate.key]
-        Flipper::UI::Decorators::Gate.new(gate, value).as_json
-      end
-      expect(@result['gates']).to eq(gates)
-    end
-  end
-
   describe '#<=>' do
     let(:on) do
       flipper.enable(:on_a)
@@ -77,11 +47,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