Rename config option

display_descriptions_on_features_page felt too verbose. It is hard to make it short though.

Author: jnunemaker

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.",

lib/flipper/ui/actions/features.rb

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

lib/flipper/ui/configuration.rb

@@ -36,8 +36,8 @@ class Configuration
       # page, and optionally the `features` pages. Defaults to empty block.
       attr_accessor :descriptions_source
 
-      # Public: when using descriptions, show them on the `features` page. Default false. 
-      attr_accessor :display_descriptions_on_features_page
+      # Public: when using descriptions, show them on the `features` page. Default false.
+      attr_accessor :show_feature_description_in_list
 
       VALID_BANNER_CLASS_VALUES = %w(
         danger
@@ -61,15 +61,15 @@ def initialize
         @fun = true
         @add_actor_placeholder = "a flipper id"
         @descriptions_source = DEFAULT_DESCRIPTIONS_SOURCE
-        @display_descriptions_on_features_page = false
+        @show_feature_description_in_list = false
       end
 
       def using_descriptions?
         @descriptions_source != DEFAULT_DESCRIPTIONS_SOURCE
       end
 
-      def display_descriptions_on_features_page?
-        using_descriptions? && @display_descriptions_on_features_page
+      def show_feature_description_in_list?
+        using_descriptions? && @show_feature_description_in_list
       end
 
       def banner_class=(value)

lib/flipper/ui/views/features.erb

@@ -45,7 +45,7 @@
           <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.display_descriptions_on_features_page? && Flipper::UI::Util.present?(feature.description) %>
+              <% 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>

spec/flipper/ui/configuration_spec.rb

@@ -101,38 +101,38 @@
     end
   end
 
-  describe "#display_descriptions_on_features_page" do
+  describe "#show_feature_description_in_list" do
     it "has default value" do
-      expect(configuration.display_descriptions_on_features_page).to eq(false)
+      expect(configuration.show_feature_description_in_list).to eq(false)
     end
 
     it "can be updated" do
-      configuration.display_descriptions_on_features_page = true
-      expect(configuration.display_descriptions_on_features_page).to eq(true)
+      configuration.show_feature_description_in_list = true
+      expect(configuration.show_feature_description_in_list).to eq(true)
     end
   end
 
-  describe "#display_descriptions_on_features_page?" do
-    subject { configuration.display_descriptions_on_features_page? }
+  describe "#show_feature_description_in_list?" do
+    subject { configuration.show_feature_description_in_list? }
 
-    context 'when using_descriptions? is false and display_descriptions_on_features_page is false' do
+    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 display_descriptions_on_features_page is true' do
-      before { configuration.display_descriptions_on_features_page = true }
+    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 display_descriptions_on_features_page is false' do
+    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 display_descriptions_on_features_page is true' do
+    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.display_descriptions_on_features_page = true
+        configuration.show_feature_description_in_list = true
       end
       it { is_expected.to eq(true) }
     end