flipper-ui 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aee5a23a8c95d9e413f5e8ed6c4b6c6b1d38abc0
-  data.tar.gz: c5a37136c9775aa074bef533f6ebda3d8f1af81f
+  metadata.gz: 07623fc292dfbcf82da226e3e276dfd81ea3a88d
+  data.tar.gz: '08462fe8a654b112bb37e2a750690350ba809c7e'
 SHA512:
-  metadata.gz: bcf40fc34509dceced76f8753ea7a404d1ac0d98805044ee94a9518deff1701c7fb69c085a99f82e660224cd3e6dbf15c29050ab8294443d2fe80fb75678ce80
-  data.tar.gz: f1b1bffd6a61049e8d4e05c407868ef6d64113f59c38a70a089c5e72875dd4e3f33531e661b6a3cfbd8824d3a0f45f759d86537a2dcb6fe98db56c8e89fa307a
+  metadata.gz: 7c213e63ff643e4877f9a782722bdb7d69983273cbfd01ca5af0a494fff9875c6a93530e72e73a1d06bbc2c3170382171566f0e91d65d43c195f625d48121602
+  data.tar.gz: ac3bcc212f9299d3cbdbd58b09014eeda7f043d3fa9f1ad906d5b4d1b64dae6110a0072b25783858d26bc8b5cf34300e910a9ef0953494a6b2405ef40f28d43c

data/docs/ui/README.md

@@ -52,7 +52,7 @@ end
 
 #### Security
 
-You almost certainly want to limit access when using Flipper::UI in production. 
+You almost certainly want to limit access when using Flipper::UI in production.
 
 ##### Basic Authentication via Rack
 The `Flipper::UI.app` method yields a builder instance prior to any predefined middleware. You can insert the `Rack::Auth::Basic` middleware, that'll prompt for a username and password when visiting the defined (i.e., `/flipper`) route.
@@ -125,6 +125,33 @@ RuntimeError: you need to set up a session middleware *before* Rack::Protection:
 
 See [examples/ui/basic.ru](https://github.com/jnunemaker/flipper/blob/master/examples/ui/basic.ru) for a more full example
 
+### Configuration
+
+Flipper UI can be customized via `configure`, which yields a configuration instance for setting the text on the five main sections of the UI feature view.
+
+* `config.actors`
+* `config.groups`
+* `config.percentage_of_actors`
+* `config.percentage_of_time`
+* `config.delete`
+
+Each of these methods returns a [Flipper::UI::Option](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/ui/configuration/option.rb) that responds to `title=`, `description=` as seen below.
+
+*e.g. customzing the percentage_of_actors and delete sections' titles and descriptions*
+```ruby
+Flipper::UI.configure do |config|
+  config.percentage_of_actors.title = "My Custom Title"
+  config.percentage_of_actors.description = "My custom description"
+
+  config.delete.title = "BE VERY CAREFUL!"
+  config.delete.description = "YOU'VE BEEN WARNED!"
+end
+```
+
+results in:
+
+![configure](images/configured-ui.png)
+
 ## Contributing
 
 1. Fork it

data/lib/flipper/ui.rb

@@ -12,6 +12,7 @@ require 'flipper'
 require 'flipper/middleware/setup_env'
 require 'flipper/middleware/memoizer'
 require 'flipper/ui/middleware'
+require 'flipper/ui/configuration'
 
 module Flipper
   module UI
@@ -23,11 +24,19 @@ module Flipper
 
       # Public: Is feature creation allowed from the UI? Defaults to true. If
       # set to false, users of the UI cannot create features. All feature
-      # creation will need to be done through the conigured flipper instance.
+      # creation will need to be done through the configured flipper instance.
       attr_accessor :feature_creation_enabled
+
+      # Public: Is feature deletion allowed from the UI? Defaults to true. If
+      # set to false, users won't be able to delete features from the UI.
+      attr_accessor :feature_removal_enabled
+
+      # Public: Set attributes on this instance to customize UI text
+      attr_reader :configuration
     end
 
     self.feature_creation_enabled = true
+    self.feature_removal_enabled = true
 
     def self.root
       @root ||= Pathname(__FILE__).dirname.expand_path.join('ui')
@@ -49,5 +58,14 @@ module Flipper
       builder.define_singleton_method(:inspect) { klass.inspect } # pretty rake routes output
       builder
     end
+
+    # Public: yields configuration instance for customizing UI text
+    def self.configure
+      yield(configuration)
+    end
+
+    def self.configuration
+      @configuration ||= ::Flipper::UI::Configuration.new
+    end
   end
 end

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

@@ -21,9 +21,18 @@ module Flipper
         end
 
         def delete
+          unless Flipper::UI.feature_removal_enabled
+            status 403
+
+            breadcrumb 'Home', '/'
+            breadcrumb 'Features', '/features'
+
+            halt view_response(:feature_removal_disabled)
+          end
+
           feature_name = Rack::Utils.unescape(request.path.split('/').last)
           feature = flipper[feature_name]
-          flipper.adapter.remove(feature)
+          feature.remove
           redirect_to '/features'
         end
       end

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

@@ -40,7 +40,8 @@ module Flipper
             redirect_to("/features/new?error=#{error}")
           end
 
-          flipper.adapter.add(flipper[value])
+          feature = flipper[value]
+          feature.add
 
           redirect_to "/features/#{Rack::Utils.escape_path(value)}"
         end

data/lib/flipper/ui/configuration.rb

@@ -0,0 +1,21 @@
+require 'flipper/ui/configuration/option'
+
+module Flipper
+  module UI
+    class Configuration
+      attr_reader :actors,
+                  :delete,
+                  :groups,
+                  :percentage_of_actors,
+                  :percentage_of_time
+
+      def initialize
+        @actors = Option.new("Actors", "Enable actors using the form above.")
+        @groups = Option.new("Groups", "Enable groups using the form above.")
+        @percentage_of_actors = Option.new("Percentage of Actors", "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
+        @percentage_of_time = Option.new("Percentage of Time", "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
+        @delete = Option.new("Danger Zone", "Deleting a feature removes it from the list of features and disables it for everyone.") # rubocop:disable Metrics/LineLength
+      end
+    end
+  end
+end

data/lib/flipper/ui/configuration/option.rb

@@ -0,0 +1,12 @@
+module Flipper
+  module UI
+    class Option
+      attr_accessor :title, :description
+
+      def initialize(title, description)
+        @title = title
+        @description = description
+      end
+    end
+  end
+end

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

@@ -11,7 +11,7 @@
   <div class="panel-body">
     <form action="<%= script_name %>/features" method="post">
       <%== csrf_input_tag %>
-      <input type="text" name="value" size="30" placeholder="ie: search, new_pricing, etc.">
+      <input type="text" name="value" size="30" placeholder="ie: search, new_pricing, etc." autofocus>
       <input type="submit" value="Add Feature" class="btn">
     </form>
     <p class="help">

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

@@ -37,7 +37,7 @@
     <div class="column one-half">
       <div class="panel panel-default">
         <div class="panel-heading">
-          <h3 class="panel-title">Percentage of Actors</h3>
+          <h3 class="panel-title"><%= Flipper::UI.configuration.percentage_of_actors.title %></h3>
         </div>
         <div class="panel-body">
           <form action="<%= script_name %>/features/<%= @feature.key %>/percentage_of_actors" method="post">
@@ -56,14 +56,14 @@
             <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="input-mini">
             <input type="submit" name="action" value="Enable" class="btn btn-sm">
           </form>
-          <p class="help"><small>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.</small></p>
+          <p class="help"><small><%= Flipper::UI.configuration.percentage_of_actors.description %></small></p>
         </div>
       </div>
     </div>
     <div class="column one-half">
       <div class="panel panel-default">
         <div class="panel-heading">
-          <h3 class="panel-title">Percentage of Time</h3>
+          <h3 class="panel-title"><%= Flipper::UI.configuration.percentage_of_time.title %></h3>
         </div>
         <div class="panel-body">
           <form action="<%= script_name %>/features/<%= @feature.key %>/percentage_of_time" method="post">
@@ -83,7 +83,7 @@
             <input type="submit" name="action" value="Enable" class="btn btn-sm">
           </form>
 
-          <p class="help"><small>Percentage of time functions independently of percentage of actors. 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.</small></p>
+          <p class="help"><small><%= Flipper::UI.configuration.actors.description %></small></p>
         </div>
       </div>
     </div>
@@ -110,7 +110,7 @@
               <input type="submit" value="Add Group" class="btn btn-sm">
             </form>
           <% end %>
-          <h3 class="panel-title">Groups</h3>
+          <h3 class="panel-title"><%= Flipper::UI.configuration.groups.title %></h3>
         </div>
         <% if @feature.groups_value.empty? %>
           <div class="blankslate">
@@ -118,7 +118,7 @@
             <span class="mega-octicon octicon-squirrel"></span>
             <span class="mega-octicon octicon-zap"></span>
             <h3>No Enabled Groups</h3>
-            <p>Enable groups using the form above.</p>
+            <p><%= Flipper::UI.configuration.groups.description %></p>
           </div>
         <% else %>
           <ul class="list-group">
@@ -154,7 +154,7 @@
             <input type="text" name="value" placeholder="ie: User:6" class="input-mini">
             <input type="submit" value="Add Actor" class="btn btn-sm">
           </form>
-          <h3 class="panel-title">Actors</h3>
+          <h3 class="panel-title"><%= Flipper::UI.configuration.actors.title %></h3>
         </div>
         <% if @feature.actors_value.empty? %>
           <div class="blankslate">
@@ -162,7 +162,7 @@
             <span class="mega-octicon octicon-squirrel"></span>
             <span class="mega-octicon octicon-zap"></span>
             <h3>No Enabled Actors</h3>
-            <p>Enable actors using the form above.</p>
+            <p><%= Flipper::UI.configuration.actors.description %></p>
           </div>
         <% else %>
           <ul class="list-group">
@@ -192,19 +192,21 @@
   </div>
 </div>
 
-<div class="panel panel-danger">
-  <div class="panel-heading">
-    <h3 class="panel-title">Danger Zone</h3>
-  </div>
-  <div class="panel-body">
-    <p>
-      Deleting a feature removes it from the list of features and disables it for everyone.
-    </p>
+<% if Flipper::UI.feature_removal_enabled %>
+  <div class="panel panel-danger">
+    <div class="panel-heading">
+      <h3 class="panel-title"><%= Flipper::UI.configuration.delete.title %></h3>
+    </div>
+    <div class="panel-body">
+      <p>
+        <%= 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?')">
-      <%== csrf_input_tag %>
-      <input type="hidden" name="_method" value="DELETE">
-      <button type="submit" name="action" value="Delete" class="btn btn-danger tooltipped tooltipped-ne" aria-label="Remove feature from list of features and disable it.">Delete</button>
-    </form>
+      <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?')">
+        <%== csrf_input_tag %>
+        <input type="hidden" name="_method" value="DELETE">
+        <button type="submit" name="action" value="Delete" class="btn btn-danger tooltipped tooltipped-ne" aria-label="Remove feature from list of features and disable it.">Delete</button>
+      </form>
+    </div>
   </div>
-</div>
+<% end %>

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

@@ -0,0 +1,3 @@
+<div class="flash flash-error">
+  Feature removal from the UI is disabled. To enable, you'll need to set <code>Flipper::UI.feature_removal_enabled = true</code> wherever flipper is running from.
+</div>

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/ui/actions/feature_spec.rb

@@ -28,6 +28,26 @@ RSpec.describe Flipper::UI::Actions::Feature do
       expect(last_response.status).to be(302)
       expect(last_response.headers['Location']).to eq('/features')
     end
+
+    context 'when feature_removal_enabled is set to false' do
+      around do |example|
+        begin
+          @original_feature_removal_enabled = Flipper::UI.feature_removal_enabled
+          Flipper::UI.feature_removal_enabled = false
+          example.run
+        ensure
+          Flipper::UI.feature_removal_enabled = @original_feature_removal_enabled
+        end
+      end
+
+      it 'returns with 403 status' do
+        expect(last_response.status).to be(403)
+      end
+
+      it 'renders feature removal disabled template' do
+        expect(last_response.body).to include('Feature removal from the UI is disabled')
+      end
+    end
   end
 
   describe 'POST /features/:feature with _method=DELETE' do

data/spec/flipper/ui/configuration_spec.rb

@@ -0,0 +1,45 @@
+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
+    end
+  end
+end

data/spec/flipper/ui_spec.rb

@@ -146,4 +146,12 @@ RSpec.describe Flipper::UI do
       described_class.feature_creation_enabled = @original_feature_creation_enabled
     end
   end
+
+  describe 'configure' do
+    it 'yields configuration instance' do
+      described_class.configure do |config|
+        expect(config).to be_instance_of(Flipper::UI::Configuration)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-ui
 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-16 00:00:00.000000000 Z
+date: 2018-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -56,14 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +87,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - docs/ui/README.md
+- docs/ui/images/configured-ui.png
 - docs/ui/images/feature.png
 - docs/ui/images/features.png
 - examples/ui/basic.ru
@@ -203,6 +204,8 @@ files:
 - lib/flipper/ui/assets/stylesheets/primer/_utility.scss
 - lib/flipper/ui/assets/stylesheets/primer/_variables.scss
 - lib/flipper/ui/assets/stylesheets/primer/primer.scss
+- lib/flipper/ui/configuration.rb
+- lib/flipper/ui/configuration/option.rb
 - lib/flipper/ui/decorators/feature.rb
 - lib/flipper/ui/decorators/gate.rb
 - lib/flipper/ui/error.rb
@@ -251,6 +254,7 @@ files:
 - lib/flipper/ui/views/add_group.erb
 - lib/flipper/ui/views/feature.erb
 - lib/flipper/ui/views/feature_creation_disabled.erb
+- lib/flipper/ui/views/feature_removal_disabled.erb
 - lib/flipper/ui/views/features.erb
 - lib/flipper/ui/views/layout.erb
 - lib/flipper/version.rb
@@ -266,6 +270,7 @@ files:
 - spec/flipper/ui/actions/home_spec.rb
 - spec/flipper/ui/actions/percentage_of_actors_gate_spec.rb
 - spec/flipper/ui/actions/percentage_of_time_gate_spec.rb
+- spec/flipper/ui/configuration_spec.rb
 - spec/flipper/ui/decorators/feature_spec.rb
 - spec/flipper/ui/decorators/gate_spec.rb
 - spec/flipper/ui/util_spec.rb
@@ -307,6 +312,7 @@ test_files:
 - spec/flipper/ui/actions/home_spec.rb
 - spec/flipper/ui/actions/percentage_of_actors_gate_spec.rb
 - spec/flipper/ui/actions/percentage_of_time_gate_spec.rb
+- spec/flipper/ui/configuration_spec.rb
 - spec/flipper/ui/decorators/feature_spec.rb
 - spec/flipper/ui/decorators/gate_spec.rb
 - spec/flipper/ui/util_spec.rb