demo_mode 2.3.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd6c9ac4c3457ca727a5869cfb4ee13dd9d189a8cbb1bfee91bed6d71c5103b4
-  data.tar.gz: 6ccf2279207588ee5cd1efcca188766badb00ed85a2e15bae373f4fc2eb1796d
+  metadata.gz: 10de8b9508baa5777b2781794f82c8babd7f8c24bd70dcdfe3b8a7a875e583d8
+  data.tar.gz: 76b7e2216e689a68c81fed89e90b553642936a7eff850a0b65b0f75e9b809f1b
 SHA512:
-  metadata.gz: f5f8a1e8e0f04c228e748e1f149c8c4f4a6e9ace74c9a58e243c23e47b3ab2c74b37f172af9a69ca15e79e6b1f0be8048e81236bfdea120fd17a02a0db461aa2
-  data.tar.gz: 3bab26eddd3379a276c0df342c2b895168b570af6bca36f448fd85b007874692f87c91d4ce12c9910a3a414f86f40006da0f25a30735a802b28a7e8cacd5a26b
+  metadata.gz: '087250bc248228cd873012cf28653b98919864f46146ed278f0138a0e4000e75d5f151695e36735e795115cdcf2f042fff1dd1d3f14e4ae15bca37a318b05fee'
+  data.tar.gz: 9300fc6fa3fd1a2f84dc904ea8c7822e3b8b07e05d225ca403d423cbf9ae484b9250c5de2463dafe8a73453a0c3c25585aff35ca1a01884acb98568529672206

data/app/controllers/demo_mode/sessions_controller.rb

@@ -26,6 +26,7 @@ module DemoMode
     def create
       @session = Session.new(create_params)
       @session.save_and_generate_account_later!(**options_params.to_unsafe_h.deep_symbolize_keys)
+      @session.reload
       session[:demo_session] = { 'id' => @session.id, 'last_request_at' => Time.zone.now }
       respond_to do |f|
         f.html { redirect_to @session, status: :see_other }
@@ -50,13 +51,15 @@ module DemoMode
 
     def render_signinable_json
       if @session.signinable.blank?
-        render json: { id: @session.id, processing: true }
+        render json: { id: @session.id, processing: @session.processing?, status: @session.status }
       else
         render json: {
           id: @session.id,
-          processing: false,
+          processing: @session.processing?,
+          status: @session.status,
           username: @session.signinable_username,
           password: @session.signinable_password,
+          metadata: @session.signinable_metadata,
         }
       end
     end

data/app/jobs/demo_mode/account_generation_job.rb

@@ -8,9 +8,11 @@ module DemoMode
         raise "Unknown persona: #{session.persona_name}" if persona.blank?
 
         signinable = persona.generate!(variant: session.variant, password: session.signinable_password, options: options)
-        session.update!(signinable: signinable)
+        session.update!(signinable: signinable, status: 'successful')
       end
-      raise "Failed to create signinable persona!" if session.signinable.blank?
+    rescue StandardError => e
+      session.update!(status: 'failed')
+      raise e
     end
   end
 end

data/app/models/demo_mode/session.rb

@@ -4,8 +4,17 @@ module DemoMode
   class Session < ActiveRecord::Base
     attribute :variant, default: :default
 
+    if ActiveRecord.gem_version >= Gem::Version.new('7.2')
+      enum :status, { processing: 'processing', successful: 'successful', failed: 'failed' }, default: 'processing'
+    else
+      attribute :status, default: :processing
+      enum status: { processing: 'processing', successful: 'successful', failed: 'failed' }
+    end
+
     validates :persona_name, :variant, presence: true
     validates :persona, presence: { message: :required }, on: :create, if: :persona_name?
+    validate :successful_status_requires_signinable
+
     belongs_to :signinable, polymorphic: true, optional: true
 
     before_create :set_password!
@@ -13,6 +22,7 @@ module DemoMode
     delegate :begin_demo,
       :custom_sign_in?,
       :display_credentials?,
+      :metadata,
       to: :persona,
       allow_nil: true
 
@@ -20,6 +30,10 @@ module DemoMode
       signinable.public_send(DemoMode.signinable_username_method)
     end
 
+    def signinable_metadata
+      successful? ? metadata.call(self) : {}
+    end
+
     # Heads up: finding a persona is not guaranteed (e.g. past sessions)
     def persona
       DemoMode.personas.find { |p| p.name.to_s == persona_name.to_s }
@@ -44,5 +58,11 @@ module DemoMode
     def set_password!
       self.signinable_password ||= DemoMode.current_password
     end
+
+    def successful_status_requires_signinable
+      if status == 'successful' && signinable.blank?
+        errors.add(:status, 'cannot be successful if signinable is not present')
+      end
+    end
   end
 end

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

@@ -17,10 +17,14 @@
   </article>
 <% else %>
   <article class="middle center" data-polling-refresh-url='<%= session_path(@session, format: :json) %>'>
-    <figure>
+    <figure id="LoadingMessage" class="<%= 'hidden' if @session.failed? %>">
       <%= instance_eval(&DemoMode.loader) %>
       <h4><span id="DemoTypedText"></span></h4>
     </figure>
+    <div id="ErrorMessage" class="<%= 'hidden' unless @session.failed? %>">
+      <div>Unable to generate persona.</div>
+      <%= link_to "Go back to persona selection", new_session_path, aria: { label: 'Homepage' } %>
+    </div>
 
     <script type="text/javascript">
       new Typed('#DemoTypedText', {

data/db/migrate/20250210222933_add_demo_mode_sessions_status.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class AddDemoModeSessionsStatus < ActiveRecord::Migration[5.1]
+  def change
+    add_column :demo_mode_sessions, :status, :string, null: false, default: 'processing'
+
+    reversible do |dir|
+      dir.up do
+        execute "UPDATE demo_mode_sessions SET status = 'successful'"
+      end
+    end
+  end
+end

data/lib/demo_mode/persona.rb

@@ -38,6 +38,14 @@ module DemoMode
       end
     end
 
+    def metadata(&block)
+      if block
+        @metadata = block
+      else
+        @metadata ||= ->(_) { {} }
+      end
+    end
+
     def sign_in_as(&signinable_generator)
       variant(:default) do
         sign_in_as(&signinable_generator)

data/lib/demo_mode/version.rb

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

data/public/demo_mode/assets/demo_mode.css

@@ -316,3 +316,7 @@ td {
 .center {
     text-align: center;
 }
+
+.hidden {
+    display: none;
+}

data/public/demo_mode/assets/demo_mode.js

@@ -1,15 +1,24 @@
-(function(document, performance, location) {
+(function (document, performance, location) {
   function* getJSON(url) {
-    while(true) { yield fetch(url).then(resp => resp.json()); }
+    while (true) {
+      yield fetch(url).then((resp) => resp.json());
+    }
   }
 
   function pollURL(url, minInterval, success, func) {
     const then = performance.now();
-    if(!minInterval) { minInterval = 1000 }
-    if(!func) { func = getJSON(url) }
+    if (!minInterval) {
+      minInterval = 1000;
+    }
+    if (!func) {
+      func = getJSON(url);
+    }
 
     func.next().value.then((resp) => {
-      if(resp.processing) {
+      if (resp.status === 'failed') {
+        document.querySelector("#LoadingMessage").classList.add("hidden");
+        document.querySelector("#ErrorMessage").classList.remove("hidden");
+      } else if (resp.status === 'processing') {
         setTimeout(
           () => pollURL(url, minInterval, success, func),
           Math.max(0, minInterval - (performance.now() - then))
@@ -20,50 +29,54 @@
     });
   }
 
-  document.addEventListener('DOMContentLoaded', (event) => {
-    [...document.querySelectorAll('[data-polling-refresh-url]')].forEach((elem) => {
-      pollURL(
-        elem.getAttribute('data-polling-refresh-url'),
-        elem.getAttribute('data-polling-refresh-interval') * 1000,
-        () => location.reload()
-      );
-    });
+  document.addEventListener("DOMContentLoaded", (event) => {
+    [...document.querySelectorAll("[data-polling-refresh-url]")].forEach(
+      (elem) => {
+        pollURL(
+          elem.getAttribute("data-polling-refresh-url"),
+          elem.getAttribute("data-polling-refresh-interval") * 1000,
+          () => location.reload()
+        );
+      }
+    );
   });
-}(document, performance, location));
+})(document, performance, location);
 
-(function() {
-  var TableFilter = (function() {
+(function () {
+  var TableFilter = (function () {
     var input;
     var inputValue;
 
     function onInputEvent(e) {
       input = e.target;
-      inputValue = input.value.toLowerCase().replace(/[^0-9a-zA-Z ]/g, '');
-      updateTable()
-      updateHistory()
+      inputValue = input.value.toLowerCase().replace(/[^0-9a-zA-Z ]/g, "");
+      updateTable();
+      updateHistory();
     }
 
     function updateTable() {
       var table = document.querySelector(`.${input.dataset.table}`);
       if (table) {
-        Array.prototype.forEach.call(table.tBodies, function(tbody) {
+        Array.prototype.forEach.call(table.tBodies, function (tbody) {
           Array.prototype.forEach.call(tbody.rows, filter);
         });
       } else {
-        alert('TableFilter cannot find its table')
+        alert("TableFilter cannot find its table");
       }
     }
 
     function updateHistory() {
-      var searchParams = new URLSearchParams(window.location.search)
+      var searchParams = new URLSearchParams(window.location.search);
       searchParams.set("search", inputValue);
-      var newRelativePathQuery = window.location.pathname + '?' + searchParams.toString();
-      history.pushState(null, '', newRelativePathQuery);
+      var newRelativePathQuery =
+        window.location.pathname + "?" + searchParams.toString();
+      history.pushState(null, "", newRelativePathQuery);
     }
 
     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 text = row.textContent.toLowerCase().replace(/[^0-9a-zA-Z ]/g, "");
+      row.style.display =
+        text.indexOf(inputValue) === -1 ? "none" : "table-row";
     }
 
     function debounce(func, threshold) {
@@ -76,7 +89,7 @@
         function delayed() {
           func.apply(obj, args);
           timeout = null;
-        };
+        }
 
         if (timeout) {
           clearTimeout(timeout);
@@ -86,32 +99,32 @@
     }
 
     return {
-      init: function() {
-        var input = document.querySelector('input[data-behavior=table-filter]');
+      init: function () {
+        var input = document.querySelector("input[data-behavior=table-filter]");
         if (!input) return;
 
         input.oninput = debounce(onInputEvent, 250);
         var urlParams = new URLSearchParams(window.location.search);
-        var search = urlParams.get('search');
+        var search = urlParams.get("search");
         if (search) {
-          input.value = search
-          input.dispatchEvent(new InputEvent('input', { data: search }));
+          input.value = search;
+          input.dispatchEvent(new InputEvent("input", { data: search }));
         }
 
-        window.addEventListener('popstate', (event) => {
+        window.addEventListener("popstate", (event) => {
           var urlParams = new URLSearchParams(window.location.search);
-          var search = urlParams.get('search');
+          var search = urlParams.get("search");
           if (search) {
             input.value = search;
             inputValue = search;
-            updateTable()
+            updateTable();
           }
         });
-      }
+      },
     };
   })();
 
-  document.addEventListener('DOMContentLoaded', (event) => {
+  document.addEventListener("DOMContentLoaded", (event) => {
     TableFilter.init();
   });
 })();

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: demo_mode
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Nathan Griffith
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-12 00:00:00.000000000 Z
+date: 2025-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -322,6 +321,7 @@ files:
 - db/migrate/20190503143021_add_demo_mode_sessions.rb
 - db/migrate/20201111000000_add_demo_mode_sessions_variant.rb
 - db/migrate/20210505000000_add_demo_mode_sessions_password.rb
+- db/migrate/20250210222933_add_demo_mode_sessions_status.rb
 - lib/demo_mode.rb
 - lib/demo_mode/clever_sequence.rb
 - lib/demo_mode/cli.rb
@@ -350,7 +350,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
@@ -365,8 +364,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: A configurable demo mode for your Rails app.
 test_files: []