rollout-ui 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fe93ad84dab349410b8d45fd548837b3c7057db163916ae51af5415f0b6a9bd
-  data.tar.gz: 6b451b50cc1e907a63e94976c103800f26fa6366705ed34e4a31d2faad585507
+  metadata.gz: 30014dd8f03ca67cb9bd7152adb431746e9d1ec399201e2a51abb4f3dedab1a4
+  data.tar.gz: bfa5ade0416b04978bc47f461513dcb857e88a2aa8838a140564a12fe9101a8f
 SHA512:
-  metadata.gz: '09ad9b11897744854625b4654e7d2a5c543492ac945ad6b91e5359b1c6aad0bab6ba0927781588f4c8b3c16e221597f625cf9acc4ca1e6c208c260d20a6e6ee8'
-  data.tar.gz: 837fa191cde919c0a88f881cc31fe300311026acf7559410f3f23bdc9ffd27c5d6f9644955337d64019c96e2642343837569d8da31648706bdf7a80d411b9bbb
+  metadata.gz: bf00bea7e987f4569fff37e268e48dccaf5b30c9cf62e545d8276ab66f426da578fc454e5ab1fd2b1db065a58284400ea72e4a0b8cd3eac088715c0f4d50a041
+  data.tar.gz: cea39dbe21f1a32be247c019e0fe7ca3073344ab918c4deb9ca7fedc80230b852b0d4e5ac745e1b4b776d41d5352030f25f41c98e70fd7a07479de4d034d67ca

data/.github/workflows/release.yml

@@ -7,8 +7,7 @@ on:
 
 jobs:
   release:
-    # setup-ruby has no build of the .ruby-version Ruby (3.4.7) for ubuntu-26.04.
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-26.04
     permissions:
       contents: write
       id-token: write

data/.github/workflows/test.yml

@@ -8,8 +8,7 @@ on:
 
 jobs:
   test:
-    # setup-ruby has no build of the .ruby-version Ruby (3.4.7) for ubuntu-26.04.
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-26.04
     services:
       redis:
         image: redis:7-alpine

data/.mise.toml

@@ -1,2 +1,2 @@
 [tools]
-ruby = "3.4.7"
+ruby = "3.4.11"

data/.ruby-version

@@ -1 +1 @@
-3.4.7
+3.4.11

data/README.md

@@ -139,6 +139,31 @@ and check Remove for visible rows. **Update before following page links** to
 avoid discarding unsaved form changes. Enrollment pagination remains available
 when nickname lookup fails; unknown IDs are never silently dropped.
 
+## Missing definitions
+
+The overview and feature page mark stored features that have no definition in
+the current application as **Missing definition**. This is informational: it
+does not change targeting, editing, or deletion, and a missing definition is not
+proof that a feature is unused.
+
+With Rollout's `definitions` API, the UI checks `Rollout.definitions` when the
+definitions directory exists. Older Rollout versions, a missing directory, or
+`Rollout.definitions_path = nil` leave checking disabled.
+
+Applications that also register features in Ruby can supply their complete list
+of defined names instead:
+
+```ruby
+Rollout::UI.configure do
+  defined_features { MyApplication.defined_feature_names }
+end
+```
+
+The callback returns string or symbol names. Returning `nil` disables checking;
+an empty list marks every stored feature as missing. Definitions are read once
+per HTML request, so changes appear on the next request. Loading errors are not
+treated as missing definitions. JSON responses are unchanged.
+
 ## Concurrent edits
 
 Feature forms include a `feature_version` fingerprint of the editable state:

data/lib/rollout/ui/config.rb

@@ -6,6 +6,7 @@ module Rollout::UI
   class Config
     KEYS = %i[
       instance
+      defined_features
       actor
       actor_url
       timestamp_format

data/lib/rollout/ui/helpers.rb

@@ -34,6 +34,10 @@ module Rollout::UI
       config.defined?(:user_search) && config.defined?(:user_lookup)
     end
 
+    def missing_definition?(feature_name)
+      @defined_features && !@defined_features.include?(feature_name.to_s)
+    end
+
     def user_search_min_length
       config.get(:user_search_min_length).to_i.clamp(1, USER_SEARCH_MAX_LENGTH)
     end

data/lib/rollout/ui/version.rb

@@ -1,5 +1,5 @@
 class Rollout
   module UI
-    VERSION = "0.10.1"
+    VERSION = "0.11.0"
   end
 end

data/lib/rollout/ui/views/features/index.erb

@@ -11,6 +11,9 @@
   <table class="text-sm w-100 text-left w-full">
     <thead class="font-semibold text-gray-500 border-b border-gray-200">
       <th class="pb-2 pr-3">Name</th>
+      <% if @defined_features %>
+        <th class="w-10 px-3" aria-label="Definition"></th>
+      <% end %>
       <th class="pb-2 pr-3">Percentage</th>
       <th class="pb-2 pr-3">Groups</th>
       <th class="pb-2 pr-3">Users</th>
@@ -25,9 +28,21 @@
         <% feature = @rollout.get(feature_name) %>
         <tr class="border-b border-gray-200">
           <td class="py-2">
-            <a class="text-blue-600 hover:text-blue-700 hover:underline" href="<%= h(feature_path(feature.name)) %>"><%= h(feature_name) %></a>
+            <a class="text-blue-600 hover:text-blue-700 hover:underline whitespace-no-wrap" href="<%= h(feature_path(feature.name)) %>"><%= h(feature_name) %></a>
             <div class="text-gray-500 text-xs"><%= h(feature.data['description']) %></div>
           </td>
+          <% if @defined_features %>
+            <td class="py-2 px-3">
+              <% if missing_definition?(feature_name) %>
+                <div class="flex justify-center">
+                  <span class="definition-warning relative inline-flex text-yellow-800" tabindex="0" role="img" aria-label="Missing definition">
+                    <%= erb :"features/partials/warning_icon", layout: false %>
+                    <span class="definition-tooltip hidden absolute right-0 px-3 border border-yellow-700 bg-yellow-100 text-xs text-center leading-normal whitespace-no-wrap rounded-sm" aria-hidden="true">Missing definition</span>
+                  </span>
+                </div>
+              <% end %>
+            </td>
+          <% end %>
           <td class="py-2 whitespace-no-wrap">
             <% if feature.percentage == 0 %>
               <span class="text-gray-400"><%= h(feature.percentage) %>%</span>

data/lib/rollout/ui/views/features/partials/warning_icon.erb

@@ -0,0 +1,3 @@
+<svg class="w-4 h-4 fill-current" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" aria-hidden="true" focusable="false">
+  <path d="M1.267 15H14.74c.942 0 1.548-.962 1.122-1.773L9.126 1.674c-.465-.899-1.794-.899-2.258 0L.132 13.227C-.281 14.038.325 15 1.267 15m7.794-2.685c0 .6-.451 1.061-1.097 1.061s-1.096-.462-1.096-1.061v-.025c0-.6.451-1.062 1.096-1.062.646 0 1.097.462 1.097 1.062zm-1.69-7.806h1.264c.349 0 .555.288.517.65l-.555 4.696c-.04.337-.271.55-.594.55s-.555-.213-.594-.55l-.555-4.696c-.038-.362.169-.65.517-.65"/>
+</svg>

data/lib/rollout/ui/views/features/show.erb

@@ -4,6 +4,15 @@
   <pre class="text-red-500"><%= h(params[:error]) %></pre>
 <% end %>
 <h2 class="font-semibold text-xl text-gray-500 pt-12"><%= h(@feature.name) %></h2>
+<% if missing_definition?(@feature.name) %>
+  <section class="mt-4 p-4 max-w-3xl flex items-center border border-yellow-700 bg-yellow-100 text-yellow-800 text-sm rounded-sm" aria-labelledby="missing-definition-heading">
+    <div class="mr-4 flex-shrink-0"><%= erb :"features/partials/warning_icon", layout: false %></div>
+    <div>
+      <h3 id="missing-definition-heading" class="font-semibold">Missing definition</h3>
+      <p class="mt-1 leading-relaxed">This feature has no definition in the current application.</p>
+    </div>
+  </section>
+<% end %>
 
 <div class="w-8 h-1 bg-gray-300 my-10"></div>
 <main class="p-6 bg-gray-100 max-w-3xl w-full text-sm rounded-sm">

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

@@ -25,6 +25,13 @@
       .dark .bg-white { background-color: #333333; }
       .dark .border-gray-300 { border-color: #555555; }
       .dark .hover\:bg-gray-800:hover { background-color: #4a4a4a; }
+      .dark .bg-yellow-100 { background-color: #352b16; }
+      .dark .border-yellow-700 { border-color: #975a16; }
+      .dark .text-yellow-800 { color: #fbd38d; }
+      .definition-tooltip { bottom: 100%; z-index: 1; padding-top: 10px; padding-bottom: 6px; }
+      .definition-warning:hover .definition-tooltip,
+      .definition-warning:focus .definition-tooltip { display: block; }
+      .definition-warning:focus { outline: 2px solid currentColor; outline-offset: 2px; }
     </style>
   </head>
   <body>

data/lib/rollout/ui/web.rb

@@ -2,6 +2,7 @@ require "erb"
 require "json"
 require "rack"
 require "rollout"
+require "set"
 
 require "rollout/ui/version"
 require "rollout/ui/config"
@@ -98,6 +99,7 @@ module Rollout::UI
             end
           )
         else
+          load_defined_features
           @history_events = @rollout.respond_to?(:logging) ? @rollout.logging.global_events.reverse : []
           load_history_user_nicknames(@history_events)
           render_view(:'features/index')
@@ -120,6 +122,7 @@ module Rollout::UI
         if json_request?
           json(feature_to_hash(@feature))
         else
+          load_defined_features
           load_selected_users
           @history_events = @rollout.respond_to?(:logging) ? @rollout.logging.events(@feature.name).reverse : []
           load_history_user_nicknames(@history_events)
@@ -127,6 +130,17 @@ module Rollout::UI
         end
       end
 
+      def load_defined_features
+        names = if config.defined?(:defined_features)
+          config.get(:defined_features)
+        elsif Rollout.respond_to?(:definitions)
+          path = Rollout.definitions_path
+          Rollout.definitions.keys if path && File.directory?(path)
+        end
+
+        @defined_features = names.map(&:to_s).to_set unless names.nil?
+      end
+
       def search_users
         return not_found unless user_selector_enabled?
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rollout-ui
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - FetLife
@@ -238,6 +238,7 @@ files:
 - lib/rollout/ui/views/features/partials/event_log.erb
 - lib/rollout/ui/views/features/partials/user_pagination.erb
 - lib/rollout/ui/views/features/partials/user_selector.erb
+- lib/rollout/ui/views/features/partials/warning_icon.erb
 - lib/rollout/ui/views/features/show.erb
 - lib/rollout/ui/views/layout.erb
 - lib/rollout/ui/web.rb