demo_mode 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03b87ab2f9b6bcbf88c60b337d047317ed4c7f3021e11c7b54ed57fd4f457f8f
-  data.tar.gz: 6f7ec3791d4aa078dfe940d0ab213e5909f24d40ba22d4b72a25b8beb82e1af1
+  metadata.gz: 68c310d6d0797c6f17fb85f41ec11f72305619323bf7bf2174d6b6a44c2954f4
+  data.tar.gz: fd5fe9b737d929072e50576ffedfe93d5e516414adb384a4e6d2b4cdc856868a
 SHA512:
-  metadata.gz: 8a58563989f275a048d27f0d020b8bd8f3f43bed7e241a56305d8536baeffe7ab8fc3c9136d554e02f159c699368ef76eec8d124a8977ccc0ede6b5becffe82f
-  data.tar.gz: be67738d14ce5678b626a16c790b83d0f4532df61f01a1b848a055f26cee8d3e39b09067bbd4da1f3291def7508f57fa430a8220a4aa69b29dfa310aab99b8df
+  metadata.gz: a235b3dd997af98b44b1947fc3a8832f33793ef0600a027a935cf8cfc0d6c40f9232b2fe969dc146845e319ae9c150001d33308568e6876b9667a4968f8279d1
+  data.tar.gz: f848277ff5fa0a11e27e2c6f0d701069a17b818eceba5e0d86a7e9ce12c5592dfa0b7fe86da1248f07f07122824ccb84a2e3090cb6d0909fbb702f65824a0acf

data/Rakefile

@@ -8,6 +8,9 @@ end
 
 Bundler::GemHelper.install_tasks
 
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 
@@ -15,6 +18,9 @@ require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
+desc 'Create a persona'
+task create_user: 'app:persona:create'
+
 def default_task
   if ENV.fetch('APPRAISAL_INITIALIZED', nil) || ENV.fetch('CI', nil)
     %i(rubocop spec)

data/app/controllers/demo_mode/sessions_controller.rb

@@ -28,7 +28,7 @@ module DemoMode
       @session.save_and_generate_account_later!(**options_params.to_unsafe_h.deep_symbolize_keys)
       session[:demo_session] = { 'id' => @session.id, 'last_request_at' => Time.zone.now }
       respond_to do |f|
-        f.html { redirect_to @session }
+        f.html { redirect_to @session, status: :see_other }
         f.json { render_signinable_json }
       end
     end
@@ -50,11 +50,12 @@ 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,
         }

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,17 +4,26 @@ 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!
 
     delegate :begin_demo,
-             :custom_sign_in?,
-             :display_credentials?,
-             to: :persona,
-             allow_nil: true
+      :custom_sign_in?,
+      :display_credentials?,
+      to: :persona,
+      allow_nil: true
 
     def signinable_username
       signinable.public_send(DemoMode.signinable_username_method)
@@ -44,5 +53,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/app/views/layouts/demo_mode/application.html.erb

@@ -7,11 +7,15 @@
   <%= favicon_link_tag '/favicon.ico' %>
 
   <% DemoMode.stylesheets.each do |stylesheet| %>
-    <%= stylesheet_link_tag(stylesheet, media: 'all') %>
+    <% if stylesheet.respond_to?(:call) %>
+      <%= stylesheet_link_tag(instance_exec(&stylesheet), media: 'all') %>
+    <% else %>
+      <%= stylesheet_link_tag(stylesheet, media: 'all') %>
+    <% end %>
   <% end %>
 
-  <script src="/assets/demo_mode/vendor/typed-v2.1.0.js"></script>
-  <script src="/assets/demo_mode/demo_mode.js?v=<%= DemoMode::VERSION %>"></script>
+  <script src="/demo_mode/assets/vendor/typed-v2.1.0.js"></script>
+  <script src="/demo_mode/assets/demo_mode.js?v=<%= DemoMode::VERSION %>"></script>
   <%= csrf_meta_tags %>
   <meta name="viewport" content="width=device-width, initial-scale=1.0 maximum-scale=1.0, user-scalable=0">
 </head>

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/cli.rb

@@ -27,58 +27,65 @@ class DemoMode::Cli
     private
 
     def ask_next_step
-      CLI::UI::Prompt.ask('What next?') do |handler|
-        handler.option("I'm done") do
-          puts "good bye"
-        end
-        handler.option('Keep going') do
-          prompt_persona
-        end
+      case CLI::UI::Prompt.ask("What next?", options: ["I'm done", "Keep going"])
+      in "I'm done"
+        puts "good bye"
+      in "Keep going"
+        prompt_persona
       end
     end
 
-    def prompt_persona # rubocop:disable Metrics/AbcSize
+    def prompt_persona
       CLI::UI::Frame.open("{{*}} Generate an Account! {{*}}") do
-        CLI::UI::Prompt.ask('Which persona should we use?') do |handler|
-          DemoMode.personas.sort_by { |p| p.name.to_s }.each do |persona|
-            persona_label = persona.name.to_s.titleize
-
-            handler.option(persona_label) do
-              persona.features.each do |feature|
-                puts "👉 #{feature}"
-              end
-
-              named_tags = SemanticLogger.named_tags if defined?(SemanticLogger)
-
-              variant = variant_for(persona, persona_label)
+        personas = DemoMode.personas.sort_by { |p| p.name.to_s }
 
-              CLI::UI::Spinner.spin("generating account...") do |spinner|
-                SemanticLogger.push_named_tags(named_tags) if defined?(SemanticLogger)
-
-                session = DemoMode::Session.new(persona_name: persona.name, variant: variant)
-                session.save_and_generate_account!
-                spinner.update_title('done!')
-                created_sessions << session
-              end
-            end
+        persona_id = CLI::UI::Prompt.ask('Which persona should we use?') do |handler|
+          personas.each.with_index do |persona, i|
+            handler.option(persona_label(persona)) { i.to_s }
           end
         end
+
+        execute_persona(personas[persona_id.to_i])
       end
+
       display_personas
       ask_next_step
     end
 
-    def variant_for(persona, persona_label)
+    def execute_persona(persona)
+      persona.features.each do |feature|
+        puts "👉 #{feature}"
+      end
+
+      named_tags = SemanticLogger.named_tags if defined?(SemanticLogger)
+
+      variant = variant_for(persona)
+
+      CLI::UI::Spinner.spin("generating account...") do |spinner|
+        SemanticLogger.push_named_tags(named_tags) if defined?(SemanticLogger)
+
+        session = DemoMode::Session.new(persona_name: persona.name, variant: variant)
+        session.save_and_generate_account!
+        spinner.update_title('done!')
+        created_sessions << session
+      end
+    end
+
+    def variant_for(persona)
       if persona.variants.keys == ['default']
         :default
       else
         CLI::UI::Prompt.ask(
-          "Which variant should we use for #{persona_label}?",
-          options: persona.variants.keys,
-        )
+          "Which variant should we use for #{persona_label(persona)}?",
+          options: persona.variants.keys.map(&:to_s),
+        ).to_sym
       end
     end
 
+    def persona_label(persona)
+      persona.name.to_s.titleize
+    end
+
     def display_personas
       created_sessions.each do |session|
         CLI::UI::Frame.open("{{*}} #{session.persona_name} {{*}}") do

data/lib/demo_mode/clis/multi_word_search_patch.rb

@@ -19,7 +19,7 @@ module DemoMode::Clis
       CLI::UI::Prompt.const_get(:InteractiveOptions)
     end
 
-    def presented_options(recalculate: false) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
+    def presented_options(recalculate: false) # rubocop:disable Metrics/PerceivedComplexity
       return @presented_options unless recalculate
 
       @presented_options = @options.zip(1..Float::INFINITY)

data/lib/demo_mode/config.rb

@@ -30,8 +30,8 @@ module DemoMode
 
     def stylesheets
       @stylesheets ||= [
-        "/assets/demo_mode/vendor/normalize-v8.0.1.css",
-        "/assets/demo_mode/demo_mode.css?v=#{VERSION}",
+        "/demo_mode/assets/vendor/normalize-v8.0.1.css",
+        "/demo_mode/assets/demo_mode.css?v=#{VERSION}",
       ]
     end
 
@@ -47,7 +47,7 @@ module DemoMode
       if block
         @loader = block
       else
-        @loader ||= ->(_) { image_tag("/assets/demo_mode/loader.png?v=#{VERSION}") }
+        @loader ||= ->(_) { image_tag("/demo_mode/assets/loader.png?v=#{VERSION}") }
       end
     end
 
@@ -64,8 +64,8 @@ module DemoMode
     end
 
     WORDS = %w(area book business case child company country day eye fact family government group home job life lot money month night number
-               office people phone place point problem program question right room school state story student study system thing time water
-               way week word work world year).freeze
+      office people phone place point problem program question right room school state story student study system thing time water
+      way week word work world year).freeze
 
     def password(&block)
       if block

data/lib/demo_mode/version.rb

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

data/lib/demo_mode.rb

@@ -9,16 +9,16 @@ require 'demo_mode/persona'
 
 module DemoMode
   ICONS = {
-    tophat: "/assets/demo_mode/icon--tophat.png?v=#{VERSION}",
-    user: "/assets/demo_mode/icon--user.png?v=#{VERSION}",
-    users: "/assets/demo_mode/icon--users.png?v=#{VERSION}",
+    tophat: "/demo_mode/assets/icon--tophat.png?v=#{VERSION}",
+    user: "/demo_mode/assets/icon--user.png?v=#{VERSION}",
+    users: "/demo_mode/assets/icon--users.png?v=#{VERSION}",
   }.freeze
 
   class << self
     delegate(*Config.configurations, to: :configuration)
 
     def enabled?
-      ActiveModel::Type::Boolean::FALSE_VALUES.exclude?(ENV.fetch('DEMO_MODE', false)).tap do |enabled|
+      ActiveModel::Type::Boolean::FALSE_VALUES.exclude?(ENV.fetch('DEMO_MODE', 'false')).tap do |enabled|
         webvalve_check! if enabled && defined?(WebValve)
       end
     end

data/public/{assets/demo_mode → demo_mode/assets}/demo_mode.css

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

data/public/{assets/demo_mode → 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,14 @@
 --- !ruby/object:Gem::Specification
 name: demo_mode
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Nathan Griffith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2025-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -94,16 +94,16 @@ dependencies:
   name: cli-ui
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -186,20 +186,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: combustion
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: cuprite
   requirement: !ruby/object:Gem::Requirement
@@ -257,7 +243,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sprockets-rails
+  name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -271,7 +257,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: sprockets-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -285,7 +271,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: uncruft
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -336,6 +322,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,14 +337,14 @@ files:
 - lib/generators/demo_mode/install_generator.rb
 - lib/generators/templates/initializer.rb
 - lib/generators/templates/sample_persona.rb
-- public/assets/demo_mode/demo_mode.css
-- public/assets/demo_mode/demo_mode.js
-- public/assets/demo_mode/icon--tophat.png
-- public/assets/demo_mode/icon--user.png
-- public/assets/demo_mode/icon--users.png
-- public/assets/demo_mode/loader.png
-- public/assets/demo_mode/vendor/normalize-v8.0.1.css
-- public/assets/demo_mode/vendor/typed-v2.1.0.js
+- public/demo_mode/assets/demo_mode.css
+- public/demo_mode/assets/demo_mode.js
+- public/demo_mode/assets/icon--tophat.png
+- public/demo_mode/assets/icon--user.png
+- public/demo_mode/assets/icon--users.png
+- public/demo_mode/assets/loader.png
+- public/demo_mode/assets/vendor/normalize-v8.0.1.css
+- public/demo_mode/assets/vendor/typed-v2.1.0.js
 homepage: http://github.com/betterment/demo_mode
 licenses:
 - MIT