flipper-ui 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c1e364e1af2059e2eeb915be4ccacbc2a441429789bdd6a3241de011c5df2c5
-  data.tar.gz: 21fbdf1b0e4276203ed05e63b938db518f5e04f925940ae9188ffa24986a4f40
+  metadata.gz: 61f65bfa737d7cd159165e492c573629403da4f9d55fdeed90c1381900af75c8
+  data.tar.gz: e5804ef90798f479fa03577a76c3c48f8321c90f16f7b8fbaec12e57ce9d6da3
 SHA512:
-  metadata.gz: d958959d8acb5dd90bd73df0338676c89fa403fdbc71402307c91fdb3d33396bbbc3db158fb6cf0bdb6ed7054410f0f364e9df8a76720acd18092f7fe88c94ef
-  data.tar.gz: 1401fabdbf9c9e4a1c5f1600955d55ae3bc7cecfdfbc95ed901b1d137b1715b12d43830d40f3ef3350a9066f2755454cfa71f9be9260c536518f49a1ed67d626
+  metadata.gz: 6651d1dc8eb1f9920ad5eb9c519be5356344e4876c1c746eb92c6a3ef14c7add2cb2f9f8d60a15d2285a205e48b3ac3a0be8780a62576298be803c2ec63e1567
+  data.tar.gz: 23ee8e91d63cadb72fccd89c9a4effd5cf9186f4be58d051938a29f69a9b9ad32e04cf7bc35fa26662344d557a4ba6f4d5f75cfb970bac549f8825015e3dbba5

data/docs/ui/README.md

@@ -5,9 +5,11 @@ UI for the [Flipper](https://github.com/jnunemaker/flipper) gem.
 ## Screenshots
 
 Viewing list of features:
+
 ![features](images/features.png)
 
 Viewing an individual feature:
+
 ![feature](images/feature.png)
 
 ## Installation
@@ -127,28 +129,11 @@ See [examples/ui/basic.ru](https://github.com/jnunemaker/flipper/blob/master/exa
 
 ### 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"
+Flipper UI can be customized via `configure`, which yields a configuration instance.
 
-  config.delete.title = "BE VERY CAREFUL!"
-  config.delete.description = "YOU'VE BEEN WARNED!"
-end
-```
+#### Description
 
-We can also associate a `description` for each `feature` by providing a descriptions source:
+We can associate a `description` for each `feature` by providing a descriptions source:
 
 ```ruby
 Flipper::UI.configure do |config|
@@ -156,14 +141,18 @@ Flipper::UI.configure do |config|
     # descriptions loaded from YAML file or database (postgres, mysql, etc)
     # return has to be hash of {String key => String description}
   end
+
+  # Defaults to false. Set to true to show feature descriptions on the list
+  # page as well as the view page.
+  # config.show_feature_description_in_list = true
 end
 ```
 
-results in:
+Descriptions show up in the UI like so:
 
-![configure](images/configured-ui.png)
+![description](images/description.png)
 
-### Banner
+#### Banner
 
 Flipper UI can display a banner across the top of the page. The `banner_text` and `banner_class` can be configured by using the `Flipper::UI.configure` block as seen below.
 
@@ -178,9 +167,9 @@ By default the `environment` is set to an empty string so no banner will show. I
 
 The above configuration results in:
 
-![configure](images/environment-banner.png)
+![banner](images/banner.png)
 
-### Fun mode
+#### Fun mode
 
 By default, Flipper UI displays a videoclip when there are no flags. The `fun` mode can be configured by using the `Flipper::UI.configure` block as seen below.
 

data/examples/ui/basic.ru

@@ -39,6 +39,7 @@ Flipper::UI.configure do |config|
   # 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.",

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

@@ -11,8 +11,20 @@ module Flipper
         def get
           @page_title = 'Features'
           keys = flipper.features.map(&:key)
+          descriptions = if Flipper::UI.configuration.show_feature_description_in_list?
+            Flipper::UI.configuration.descriptions_source.call(keys)
+          else
+            {}
+          end
+
           @features = flipper.features.map do |feature|
-            Decorators::Feature.new(feature)
+            decorated_feature = Decorators::Feature.new(feature)
+
+            if Flipper::UI.configuration.show_feature_description_in_list?
+              decorated_feature.description = descriptions[feature.key]
+            end
+
+            decorated_feature
           end.sort
 
           @show_blank_slate = @features.empty?

data/lib/flipper/ui/configuration.rb

@@ -33,9 +33,13 @@ module Flipper
 
       # Public: If you set this, Flipper::UI will fetch descriptions
       # from your external source. Descriptions for `features` will be shown on `feature`
-      # and `features` pages. Defaults to empty block.
+      # page, and optionally the `features` pages. Defaults to empty block.
       attr_accessor :descriptions_source
 
+      # Public: Should feature descriptions be show on the `features` list page.
+      # Default false. Only works when using descriptions.
+      attr_accessor :show_feature_description_in_list
+
       VALID_BANNER_CLASS_VALUES = %w(
         danger
         dark
@@ -58,12 +62,17 @@ module Flipper
         @fun = true
         @add_actor_placeholder = "a flipper id"
         @descriptions_source = DEFAULT_DESCRIPTIONS_SOURCE
+        @show_feature_description_in_list = false
       end
 
       def using_descriptions?
         @descriptions_source != DEFAULT_DESCRIPTIONS_SOURCE
       end
 
+      def show_feature_description_in_list?
+        using_descriptions? && @show_feature_description_in_list
+      end
+
       def banner_class=(value)
         unless VALID_BANNER_CLASS_VALUES.include?(value)
           raise InvalidConfigurationValue, "The banner_class provided '#{value}' is " \

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

@@ -44,7 +44,12 @@
           </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"><%= feature.key %></div>
+              <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>

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.18.0'.freeze
+  VERSION = '0.19.0'.freeze
 end

data/spec/flipper/ui/configuration_spec.rb

@@ -100,4 +100,41 @@ RSpec.describe Flipper::UI::Configuration do
       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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-ui
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -56,14 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: erubi
   requirement: !ruby/object:Gem::Requirement
@@ -92,8 +92,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - docs/ui/README.md
-- docs/ui/images/configured-ui.png
-- docs/ui/images/environment-banner.png
+- docs/ui/images/banner.png
+- docs/ui/images/description.png
 - docs/ui/images/feature.png
 - docs/ui/images/features.png
 - examples/ui/basic.ru