livechat 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6007e2a9721aeb42f80cee9f9e5609adff1ae7edd787f9329efd74d1d92f94b5
-  data.tar.gz: 0d9769f92ead60fbb908447204bc7a9dabbf33f2ef8b1eb4b4f501e0df29e7b5
+  metadata.gz: fae79e3391f4f16e1823d4d9b8755061c5ae66a4651d36f19b47448cae320f25
+  data.tar.gz: a65a2fad39a547c6ce06c4b9d6d25cea355868ae848819f155e01038fe6d1ee4
 SHA512:
-  metadata.gz: ebfe7ab9b60281cb8199960e5cd3a60e5a9af4ee6b0222b8039e3e0103d25e69ea567548f3dcd9252cd881aec235bb4d0187a72f714f402cb84b972b441bd5c4
-  data.tar.gz: f1018b0d5775439bd90f87520a4a22ba44c1703e8b2a163940403f656ebcb793945e8a99a640267f31bf1215c517d4cf7925d7c6ed9be1a05ca8baa5ca8280c7
+  metadata.gz: 812f2d09748da467a8d79d1921520f03b643d3430d1e53b159e3d1801a5fb79e9e64310db905edb2332ce4f8a5b6dfbcdfdaf2a68bb0efc4d4c017df9337c35c
+  data.tar.gz: 0417f271610f0139a39e9b921d16a59c30b6bda3f226563dca618a3d6405b928675755c6a7ece46c677e3cab516dcbe20e8d1b3e3c394592fe901fe7c1cd717a

data/AGENTS.md

@@ -107,7 +107,7 @@ Leave it off unless the app already has Action Cable working. Polling is not a d
 ### Do not
 
 - **Do not copy the widget JavaScript into `app/javascript`, or add a `<script>` tag for it.** `livechat_tag` renders what is needed, and the engine serves the code with a content fingerprint. There is no build step and nothing for esbuild/importmap/Tailwind to know about.
-- **Do not build your own inbox.** Use the mounted one; `config.agent_layout = "admin/application"` renders it inside an existing admin shell.
+- **Do not rebuild the inbox, and do not edit views inside the gem.** To put it inside an admin you already have, set `config.base_controller_class = "Admin::BaseController"` — it inherits that controller's layout, helpers, authentication and request context. For the shell alone, `config.agent_layout = "admin/application"`. Both work with nothing else wired up: the inbox's own assets are declared by its views, not the layout.
 - **Do not add an Action Cable mount to "make chat realtime"** unless you also set `config.action_cable = true`. Polling is the default and is not broken.
 - **Do not set config outside the initializer.** `rate_limit` in particular is read when the controller class loads; assigning config per-request mutates it process-wide.
 - **Do not expose attachments by blob URL** — the engine's gated route exists so a leaked signed URL cannot hand over a customer's file.
@@ -119,6 +119,7 @@ Everything is optional; a fresh install works with zero config. Full list with c
 | Option | Default | Note |
 | --- | --- | --- |
 | `authorize_agent` | development only | **Who can read the inbox. Set before deploying.** |
+| `base_controller_class` | `ActionController::Base` | Controller the inbox inherits. Name your admin's and it adopts that layout, helpers, authentication and request context. Public endpoints never inherit it. |
 | `enabled` | everyone | Per-request gate for the widget and its endpoints |
 | `current_user` | `nil` | Receives the request; nil means guest-by-cookie |
 | `visitor_label`, `agent_label` | name/email/to_s | Receive the user |
@@ -143,6 +144,8 @@ Turbo Drive and strict nonce-based CSP work out of the box. 26 locales ship with
 
 | Symptom | Cause |
 | --- | --- |
+| `NameError` for one of your own helpers in the inbox | `isolate_namespace` scopes `helper` to the engine. Use `config.base_controller_class` so the inbox inherits your helpers, rather than `agent_layout` alone. |
+| `NotNullViolation` attaching a file on a uuid-keyed app | The tables were generated bigint. Set `primary_key_type` in `config.generators` before installing, or migrate them to uuid. |
 | `/livechat` returns 403 "Set Livechat.config.authorize_agent to grant access" | Exactly what it says: still at the development-only default |
 | No bubble on the page | `livechat_tag` missing from the rendered layout, `config.enabled` false, or `show_launcher = false` with no opener of your own |
 | No notification emails | `mailer_from` not set — `agent_emails` alone does nothing |
@@ -152,6 +155,10 @@ Turbo Drive and strict nonce-based CSP work out of the box. 26 locales ship with
 
 ---
 
+## One family
+
+`testimonials`, `ideasbugs`, `product_tours`, `i18n_proofreading` are the sibling engines. Same install shape, same host hooks (`base_controller_class`, `agent_layout`), same scoped dashboard CSS, same `primary_key_type`-aware migrations — so what you learn here transfers.
+
 ## Working on the gem itself
 
 ```bash

data/README.md

@@ -326,6 +326,25 @@ bundle exec rubocop
   translation proofreading.
 - [SupeRails](https://superails.com) — Rails screencasts.
 
+## One family
+
+Five Rails engines built on the same backbone, so adopting a second one is
+mostly muscle memory:
+
+| Gem | What it does |
+| --- | --- |
+| [testimonials](https://github.com/yshmarov/testimonials) | Testimonials, reviews and NPS — text and video, collected in your own app |
+| [ideasbugs](https://github.com/yshmarov/ideasbugs) | In-app bug reports and feature requests, with a triage queue |
+| **livechat** *(this gem)* | Live chat between your visitors and your agents, self-hosted |
+| [product_tours](https://github.com/yshmarov/product_tours) | Product tours and video tutorials, shown in-app at the right moment |
+| [i18n_proofreading](https://github.com/yshmarov/i18n_proofreading) | In-context translation fixes suggested by your own users |
+
+They share the install shape (`generate <gem>:install`, mount, one initializer),
+the same host hooks (`base_controller_class` to inherit your admin's controller,
+`agent_layout` for just the shell), a dashboard stylesheet scoped so it
+cannot touch your own CSS, and migrations that follow your app's
+`primary_key_type`.
+
 ## License
 
 MIT.

data/lib/livechat/dashboard.css

@@ -52,24 +52,6 @@
   }
 }
 
-/* Page frame — the gem's own layout only. */
-.lvc-page { margin: 0; background: var(--lvc-bg); color: var(--lvc-text); font: 15px/1.5 system-ui, -apple-system, "Segoe UI", sans-serif; }
-/* Desktop inbox: a durable conversation list on the left and the active thread on the right, with each pane owning its own scroll. */
-.lvc-inbox, .lvc-inbox .container { height: 100vh; height: 100dvh; }
-.lvc-inbox { overflow: hidden; }
-.lvc-inbox .container { max-width: 1280px; display: flex; flex-direction: column; padding-bottom: 16px; }
-.lvc-inbox .container h1 { flex: 0 0 auto; margin-bottom: 14px; }
-/* Conversation page: fill the viewport and scroll the THREAD, not the page — so a reply never jumps the page, and the composer stays put. */
-.lvc-convo, .lvc-convo .container { height: 100vh; height: 100dvh; }
-.lvc-convo { overflow: hidden; }
-.lvc-convo .container { display: flex; flex-direction: column; padding-bottom: 16px; }
-.lvc-convo .breadcrumb, .lvc-convo .head-row, .lvc-convo .context-line,
-    .lvc-convo .flash { flex: 0 0 auto; }
-.lvc-convo .conversation-panel { flex: 1 1 auto; min-height: 0; display: flex; flex-direction: column; }
-.lvc-convo .card { flex: 1 1 auto; min-height: 0; display: flex; flex-direction: column; }
-.lvc-convo .thread { flex: 1 1 auto; min-height: 0; overflow-y: auto; }
-.lvc-convo .reply { flex: 0 0 auto; }
-
 /* Dashboard components — any layout. */
 .lvc-dashboard {
   /* A scoping device, not a layout one: without this the wrapper would
@@ -216,3 +198,22 @@
   & .empty-state p { margin: 0; }
   & .mobile-back { display: none; }
 }
+
+/* Page frame — the gem's own layout only. Last, so it wins the
+   specificity ties against the component layer above. */
+.lvc-page { margin: 0; background: var(--lvc-bg); color: var(--lvc-text); font: 15px/1.5 system-ui, -apple-system, "Segoe UI", sans-serif; }
+/* Desktop inbox: a durable conversation list on the left and the active thread on the right, with each pane owning its own scroll. */
+.lvc-inbox, .lvc-inbox .container { height: 100vh; height: 100dvh; }
+.lvc-inbox { overflow: hidden; }
+.lvc-inbox .container { max-width: 1280px; display: flex; flex-direction: column; padding-bottom: 16px; }
+.lvc-inbox .container h1 { flex: 0 0 auto; margin-bottom: 14px; }
+/* Conversation page: fill the viewport and scroll the THREAD, not the page — so a reply never jumps the page, and the composer stays put. */
+.lvc-convo, .lvc-convo .container { height: 100vh; height: 100dvh; }
+.lvc-convo { overflow: hidden; }
+.lvc-convo .container { display: flex; flex-direction: column; padding-bottom: 16px; }
+.lvc-convo .breadcrumb, .lvc-convo .head-row, .lvc-convo .context-line,
+    .lvc-convo .flash { flex: 0 0 auto; }
+.lvc-convo .conversation-panel { flex: 1 1 auto; min-height: 0; display: flex; flex-direction: column; }
+.lvc-convo .card { flex: 1 1 auto; min-height: 0; display: flex; flex-direction: column; }
+.lvc-convo .thread { flex: 1 1 auto; min-height: 0; overflow-y: auto; }
+.lvc-convo .reply { flex: 0 0 auto; }

data/lib/livechat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Livechat
-  VERSION = '0.8.1'
+  VERSION = '0.8.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: livechat
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Yaroslav Shmarov