testimonials 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca7fa3a534c13036edc28e6206c06b5e4ef82949cafaeee614a2d196509c2176
-  data.tar.gz: 140a7b0783d3284076def56a598a0c70bb72f1208b2a6158b62c09d634eeaeb2
+  metadata.gz: f22788e95288902bcd21a32e81a39841fcc71fb844b10c96ae768726e51026a1
+  data.tar.gz: 3cd300be21ce03785c3f10ac081299278ceeb434bdcd250496a80a67115f2e63
 SHA512:
-  metadata.gz: 6eebe2d3c06afff74b999f4a8a29120a97d3a2e78eeb0ff1429df26bf14a9303c66861665489fdb10104c9f7557bca3ad140f466ddb4a4b2a2116d465c3bc302
-  data.tar.gz: 343195af39cd476f4a74728ab5e11997efa834806c7213aa3ab3b61bba933a6f2d89ccb6d255a9463b9089f9a4ebba5af078ff968db4b2adfff1fe1c6ad97cb3
+  metadata.gz: 1fc585035952eedaac590b367271939f8c825ba44a8bc010f6e45223372c68aaab3ea773dc0f320420fc8b0cda3ccfa26ba7fc70a8800a6a03567eb77e9b8acd
+  data.tar.gz: 650ea64d54721adbe117e821e1f1873fbc84bc5d2320c1486c4cce866a788c12d05c19509d72c6bb390ea9bf5bff944a7f0b9354681d26e3914c295eef5f2653

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.1.5
+
+- Docs: show how to wire `current_user` with Rails 8's built-in authentication
+  (`bin/rails generate authentication`), alongside the existing Devise/Warden
+  example — in the README and the generated initializer.
+
+## 0.1.4
+
+- Validation and submit errors are announced to screen readers: every
+  `.tml-error` container is a `role="alert"` region from creation, and text
+  is inserted only after the region is exposed.
+- Page scroll is locked behind the open widget dialog and restored on close;
+  a Turbo body swap that removes the overlay releases the lock too. The
+  inline collection-page form is unaffected.
+
 ## 0.1.3
 
 - Video playback no longer pauses itself moments after play in Firefox: the

data/README.md

@@ -115,6 +115,20 @@ Testimonials.configure do |config|
 end
 ```
 
+`current_user` (and any admin gate) receives the raw request, so it works
+with whatever auth you have:
+
+```ruby
+# Devise / Warden:
+config.current_user = ->(request) { request.env["warden"]&.user }
+
+# Rails 8 built-in auth (bin/rails generate authentication):
+config.current_user = lambda do |request|
+  token = request.cookies["session_token"]
+  Session.find_signed(token)&.user if token
+end
+```
+
 ### Guiding questions, localized
 
 The questions shown above the form ("How has %{app} helped you?") fight

data/lib/generators/testimonials/install/templates/initializer.rb

@@ -15,7 +15,14 @@ Testimonials.configure do |config|
 
   # Attribute submissions to a user (optional). Return an object responding
   # to #id, or nil. Receives the request.
+  # Devise / Warden:
   # config.current_user = ->(request) { request.env["warden"]&.user }
+  #
+  # Rails 8 built-in auth (bin/rails generate authentication):
+  # config.current_user = lambda do |request|
+  #   token = request.cookies["session_token"]
+  #   Session.find_signed(token)&.user if token
+  # end
 
   # Attribution stored with a signed-in user's submission.
   # config.user_display = ->(user) { { name: user.name, email: user.email } }

data/lib/testimonials/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Testimonials
-  VERSION = '0.1.3'
+  VERSION = '0.1.5'
 end

data/lib/testimonials/widget.js

@@ -29,6 +29,7 @@
   var Z = 2147482000;
   var overlay = null;
   var lastFocused = null;
+  var savedOverflow = null; // documentElement overflow to restore when the modal closes
   var state = null; // one open session: { kind, auto, stage, rating, videoBlob, ... }
   var media = { stream: null, recorder: null, chunks: [], timer: null };
 
@@ -67,6 +68,10 @@
     config = readConfig() || config;
     injectStyles();
 
+    // A Turbo body swap can remove the overlay without close() running; the
+    // lock lives on documentElement, which survives the swap, so release it.
+    if (!document.getElementById("tml-overlay")) unlockScroll();
+
     if (config.mode === "page") {
       renderInline();
       return;
@@ -147,6 +152,7 @@
 
     overlay.appendChild(dialog);
     document.body.appendChild(overlay);
+    lockScroll();
     overlay.addEventListener("keydown", trapFocus);
 
     if (auto) postEvent(kind, "shown");
@@ -161,9 +167,21 @@
     overlay.remove();
     overlay = null;
     state = null;
+    unlockScroll();
     if (lastFocused && lastFocused.focus) lastFocused.focus();
   }
 
+  function lockScroll() {
+    if (savedOverflow === null) savedOverflow = document.documentElement.style.overflow;
+    document.documentElement.style.overflow = "hidden";
+  }
+
+  function unlockScroll() {
+    if (savedOverflow === null) return;
+    document.documentElement.style.overflow = savedOverflow;
+    savedOverflow = null;
+  }
+
   function dialogEl() {
     return overlay ? overlay.querySelector("#tml-dialog") : document.querySelector("[data-testimonials-inline] .tml-inline");
   }
@@ -301,6 +319,7 @@
     form.appendChild(consentField());
 
     var error = el("p", "tml-error");
+    error.setAttribute("role", "alert");
     error.hidden = true;
     form.appendChild(error);
 
@@ -470,6 +489,7 @@
     stage.appendChild(hint);
 
     var error = el("p", "tml-error");
+    error.setAttribute("role", "alert");
     error.hidden = true;
     stage.appendChild(error);
 
@@ -640,6 +660,7 @@
     stage.appendChild(playback);
 
     var error = el("p", "tml-error");
+    error.setAttribute("role", "alert");
     error.hidden = true;
     stage.appendChild(error);
 
@@ -747,6 +768,7 @@
     }
 
     var error = el("p", "tml-error");
+    error.setAttribute("role", "alert");
     error.hidden = true;
     form.appendChild(error);
 
@@ -952,8 +974,10 @@
   function showError(form, text) {
     var error = form.querySelector(".tml-error");
     if (!error) return;
-    error.textContent = text;
+    // Unhide first: text landing in an already-exposed alert region is
+    // reliably announced; revealing role+text together sometimes isn't.
     error.hidden = false;
+    error.textContent = text;
   }
 
   // --- styles -------------------------------------------------------------------

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testimonials
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Yaroslav Shmarov