demo_mode 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd264ed7e12434d94b75abcdf3738f2ae80832cbdcd429ef00999b27f9e114f
-  data.tar.gz: d41eda6c21582382f49235783c5d191aaed3f66d8c375c332e4d0b327f73b7b0
+  metadata.gz: 76f5606300169245566aec753daa16508d60cbaee8509a096234aa1a2ffd8cce
+  data.tar.gz: adffd7d7b4e688cf1c15ac1113d64f354a35dce5aa5754b694b7df3246636f32
 SHA512:
-  metadata.gz: a012ec618c62bae424ceae953bd777f95dc244948c0e867f9fc548569bb5709fccf62620386bcd6d53cc0a36c953512646ff6c6062869dd357d32fdeafad7b66
-  data.tar.gz: 0d9770f52fc391a60a248ffe2d1b644f1e95136b3b7307b2c8415e754ffdae6e718b1442e14590f80ec21468ab7c44ba687c7ce3e35d245aeb3e5e3ef788e155
+  metadata.gz: cc599fe84994691f54ecfe49af4e1b7f6e92561be78c26e0a8cf9e240ff1944e9d3c0a2825f75bd1a7b0e08ee5ac3cfac86009432c342354bfcf801b4dfa6272
+  data.tar.gz: b866a7902a4068fbc65400bda015908e8eae0a7c12141499cd24eedbbba8800b0de978da58c8f2fae0f1b9b6ba839dd28818d0e4f87291837e5584a317b8375a

data/README.md

@@ -39,6 +39,7 @@ To learn more about how we use `demo_mode` at **Betterment**, check out :sparkle
   - [Installation](#installation)
   - [App-Specific Setup](#app-specific-setup)
 - [Defining Personas](#defining-personas)
+  - [Grouping Personas](#grouping-personas)
 - [Customizing the Design](#customizing-the-design)
 - [Optional Features](#optional-features)
   - [The "Sign Up" Link](#the-sign-up-link)
@@ -273,6 +274,46 @@ end
 If defined, the non-variant `sign_in_as` will show up as "default" in the
 dropdown.
 
+### Grouping Personas
+
+When an app has many personas, the single table can become hard to scan. To
+improve the end-user experience, you can organize your persona files into subfolders
+(e.g. `config/personas/orders...`, `config/personas/advanced/...`) and then enable
+the following setting to collapse those personas into labeled groupings:
+
+```ruby
+DemoMode.configure do
+  group_by_folder true
+end
+```
+
+Alternatively, you can set a group name directly on any persona:
+
+```ruby
+DemoMode.add_persona do
+  group 'Playwright testing'
+  # ...
+end
+```
+
+To directly control page ordering, use the `groups` config:
+
+```ruby
+DemoMode.configure do
+  # Specify group order directly:
+  groups %w(transactions activity locked)
+
+  # ...or specify friendly labels along with the order:
+  groups(
+    'orders' => 'Orders',
+    'orders/checkout' => 'Checkout',
+  )
+
+  # If you prefer, move ungrouped personas to the bottom:
+  groups %w(inbound outbound), ungrouped_first: false
+end
+```
+
 ## Customizing the Design
 
 To supply your own branding, you can override the logo

data/app/views/demo_mode/sessions/_grouped_personas.html.erb

@@ -0,0 +1,8 @@
+<% named_groups.each do |name, personas| %>
+  <section>
+    <details class="persona-group">
+      <summary><%= name %> (<%= personas.count %>)</summary>
+      <%= render 'persona_table', personas: personas %>
+    </details>
+  </section>
+<% end %>

data/app/views/demo_mode/sessions/_persona_table.html.erb

@@ -0,0 +1,28 @@
+<table class="persona-table">
+  <thead>
+    <tr>
+      <th></th>
+      <th>Persona name</th>
+      <th>Variant</th>
+      <th>Features</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% personas.each do |persona| %>
+      <tr class="<%= persona.css_class %>">
+        <td>
+          <%= form_for @session, html: { id: persona.name.to_s.underscore } do |f| %>
+            <%= f.hidden_field :persona_name, value: persona.name %>
+            <%= f.submit 'Sign In', class: 'secondary small' %>
+            <% @f = f %>
+          <% end %>
+        </td>
+        <td><%= persona.name.to_s.titleize %></td>
+        <td>
+          <%= render 'variant_dropdown', f: @f, persona: persona %>
+        </td>
+        <td><%= persona.features.join(", ") %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/demo_mode/sessions/_ungrouped_personas.html.erb

@@ -0,0 +1,5 @@
+<% if personas.any? %>
+  <section>
+    <%= render 'persona_table', personas: personas %>
+  </section>
+<% end %>

data/app/views/demo_mode/sessions/new.html.erb

@@ -23,35 +23,12 @@
     <section>
       <input type="text" placeholder="Search..." data-table="persona-table" data-behavior="table-filter" />
     </section>
-    <section>
-      <table class="persona-table">
-        <thead>
-          <tr>
-            <th></th>
-            <th>Persona name</th>
-            <th>Variant</th>
-            <th>Features</th>
-          </tr>
-        </thead>
-        <tbody>
-          <% DemoMode.standard_personas.each do |persona| %>
-            <tr class="<%= persona.css_class %>">
-              <td>
-                <%= form_for @session, html: { id: persona.name.to_s.underscore } do |f| %>
-                  <%= f.hidden_field :persona_name, value: persona.name %>
-                  <%= f.submit 'Sign In', class: 'secondary small' %>
-                  <% @f = f %>
-                <% end %>
-              </td>
-              <td><%= persona.name.to_s.titleize %></td>
-              <td>
-                <%= render 'variant_dropdown', f: @f, persona: persona %>
-              </td>
-              <td><%= persona.features.join(", ") %></td>
-            </tr>
-          <% end %>
-        </tbody>
-      </table>
-    </section>
+    <% if DemoMode.ungrouped_first? %>
+      <%= render 'ungrouped_personas', personas: DemoMode.ungrouped_personas %>
+      <%= render 'grouped_personas', named_groups: DemoMode.personas_by_group %>
+    <% else %>
+      <%= render 'grouped_personas', named_groups: DemoMode.personas_by_group %>
+      <%= render 'ungrouped_personas', personas: DemoMode.ungrouped_personas %>
+    <% end %>
   </article>
 <% end %>

data/lib/demo_mode/config.rb

@@ -17,6 +17,9 @@ module DemoMode
     configurable_value(:log_level) { :debug }
     configurable_value(:minimum_pool_size) { 5 }
     configurable_boolean(:display_credentials)
+    configurable_boolean(:group_by_folder)
+    configurations << :groups
+    configurations << :ungrouped_first?
     configurations << :stylesheets
     configurations << :logo
     configurations << :loader
@@ -30,6 +33,15 @@ module DemoMode
       Rails.application.class.module_parent.name
     end
 
+    def groups(value = nil, **kwargs)
+      configure_groups(value, **kwargs) if value || kwargs.any?
+      @groups || []
+    end
+
+    def ungrouped_first?
+      @ungrouped_first.nil? ? true : @ungrouped_first
+    end
+
     def stylesheets
       @stylesheets ||= [
         "/demo_mode/assets/vendor/normalize-v8.0.1.css",
@@ -120,6 +132,11 @@ module DemoMode
 
     private
 
+    def configure_groups(value, **kwargs)
+      @ungrouped_first = kwargs.delete(:ungrouped_first)
+      @groups = kwargs.any? ? kwargs : value
+    end
+
     def auto_load_personas!
       Rails.root.glob("#{personas_path}/**/*.rb").sort.each do |persona_file|
         raise <<~ERROR if File.readlines(persona_file).grep(/DemoMode\.add_persona/).empty?
@@ -130,7 +147,10 @@ module DemoMode
         checksum = Digest::SHA256.hexdigest(File.read(persona_file))
         before_count = @personas.length
         load(persona_file)
-        @personas[before_count..].each { |p| p.file_checksum = checksum }
+        @personas[before_count..].each do |p|
+          p.file_checksum = checksum
+          p.file_path = persona_file.to_s
+        end
       end
     end
   end

data/lib/demo_mode/grouper.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module DemoMode
+  class Grouper
+    def initialize(personas, groups:)
+      @personas = personas
+      @groups = groups
+    end
+
+    def named
+      buckets.except(nil).sort_by { |group, _| sort_key(group) }
+    end
+
+    def named_groups
+      named.map { |group, personas| [name_for(group), personas] }
+    end
+
+    def ungrouped
+      buckets.fetch(nil, [])
+    end
+
+    def name_for(group)
+      return group unless groups.is_a?(Hash)
+
+      groups.stringify_keys[group.to_s] || group
+    end
+
+    private
+
+    attr_reader :personas, :groups
+
+    def buckets
+      personas.group_by(&:group)
+    end
+
+    def sort_key(group)
+      rank = group_keys.index(group.to_s)
+      [rank || Float::INFINITY, group.to_s]
+    end
+
+    def group_keys
+      (groups.is_a?(Hash) ? groups.keys : groups).map(&:to_s)
+    end
+  end
+end

data/lib/demo_mode/persona.rb

@@ -6,11 +6,19 @@ module DemoMode
   class Persona
     include ActiveModel::Model
 
-    attr_accessor :name, :file_checksum
+    attr_accessor :name, :file_checksum, :file_path
 
     validates :name, presence: true
     validate :persona_must_have_at_least_one_feature
 
+    def group(name = nil)
+      if name
+        @group = name
+      else
+        @group || folder_group
+      end
+    end
+
     def icon(name_or_path = nil, &block)
       if block
         @icon = block
@@ -141,6 +149,15 @@ module DemoMode
 
     private
 
+    def folder_group
+      return unless DemoMode.group_by_folder?
+      return unless file_path
+
+      relative = Pathname.new(file_path).relative_path_from(Rails.root.join(DemoMode.personas_path))
+      folder = relative.dirname.to_s
+      folder unless folder == '.'
+    end
+
     def persona_must_have_at_least_one_feature
       errors.add(:base, <<~ERR) unless features.count >= 1
         Persona must have at least one feature.

data/lib/demo_mode/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DemoMode
-  VERSION = '4.0.1'
+  VERSION = '4.1.0'
 end

data/lib/demo_mode.rb

@@ -6,6 +6,7 @@ require 'demo_mode/version'
 require 'demo_mode/clever_sequence'
 require 'demo_mode/config'
 require 'demo_mode/engine'
+require 'demo_mode/grouper'
 require 'demo_mode/persona'
 
 module DemoMode
@@ -48,6 +49,14 @@ module DemoMode
       personas - callout_personas
     end
 
+    def ungrouped_personas
+      grouper.ungrouped
+    end
+
+    def personas_by_group
+      grouper.named_groups
+    end
+
     def current_password
       Thread.current[:_demo_mode_password] ||= password.call
     end
@@ -70,6 +79,10 @@ module DemoMode
 
     private
 
+    def grouper
+      Grouper.new(standard_personas, groups: groups)
+    end
+
     def configuration
       @configuration ||= Config.new
     end

data/public/demo_mode/assets/demo_mode.css

@@ -319,3 +319,13 @@ td {
 .hidden {
     display: none;
 }
+
+.persona-group {
+    margin-top: 1rem;
+}
+
+.persona-group summary {
+    cursor: pointer;
+    font-weight: bold;
+    padding: 0.5rem 0;
+}

data/public/demo_mode/assets/demo_mode.js

@@ -55,14 +55,25 @@
     }
 
     function updateTable() {
-      var table = document.querySelector(`.${input.dataset.table}`);
-      if (table) {
+      var tables = document.querySelectorAll(`.${input.dataset.table}`);
+      if (tables.length === 0) {
+        alert("TableFilter cannot find its table");
+        return;
+      }
+      Array.prototype.forEach.call(tables, function (table) {
         Array.prototype.forEach.call(table.tBodies, function (tbody) {
           Array.prototype.forEach.call(tbody.rows, filter);
         });
-      } else {
-        alert("TableFilter cannot find its table");
-      }
+      });
+      revealGroupsWithMatches();
+    }
+
+    function revealGroupsWithMatches() {
+      var groups = document.querySelectorAll("details.persona-group");
+      Array.prototype.forEach.call(groups, function (group) {
+        var hasMatch = !!group.querySelector("tbody tr[data-matches]");
+        group.open = inputValue !== "" && hasMatch;
+      });
     }
 
     function updateHistory() {
@@ -75,8 +86,13 @@
 
     function filter(row) {
       var text = row.textContent.toLowerCase().replace(/[^0-9a-zA-Z ]/g, "");
-      row.style.display =
-        text.indexOf(inputValue) === -1 ? "none" : "table-row";
+      var matches = text.indexOf(inputValue) !== -1;
+      row.style.display = matches ? "table-row" : "none";
+      if (matches) {
+        row.setAttribute("data-matches", "");
+      } else {
+        row.removeAttribute("data-matches");
+      }
     }
 
     function debounce(func, threshold) {

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: demo_mode
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Nathan Griffith
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -343,6 +342,9 @@ files:
 - app/jobs/demo_mode/account_generation_job.rb
 - app/jobs/demo_mode/pool_hydration_job.rb
 - app/models/demo_mode/session.rb
+- app/views/demo_mode/sessions/_grouped_personas.html.erb
+- app/views/demo_mode/sessions/_persona_table.html.erb
+- app/views/demo_mode/sessions/_ungrouped_personas.html.erb
 - app/views/demo_mode/sessions/_variant_dropdown.html.erb
 - app/views/demo_mode/sessions/new.html.erb
 - app/views/demo_mode/sessions/show.html.erb
@@ -366,6 +368,7 @@ files:
 - lib/demo_mode/config.rb
 - lib/demo_mode/engine.rb
 - lib/demo_mode/factory_bot_ext.rb
+- lib/demo_mode/grouper.rb
 - lib/demo_mode/persona.rb
 - lib/demo_mode/tasks.rb
 - lib/demo_mode/version.rb
@@ -388,7 +391,6 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
   changelog_uri: https://github.com/Betterment/demo_mode/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -403,8 +405,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 4.0.21
 specification_version: 4
 summary: A configurable demo mode for your Rails app.
 test_files: []