compony 0.11.11 → 0.11.13

data/doc/file.patterns.html

@@ -60,13 +60,13 @@
       <div id="content"><div id='filecontents'>
 <p><a href="/README_md.html#guide--documentation">Back to the guide</a></p>
 
-<h1 id="label-Real-world+patterns">Real-world patterns</h1>
+<h1 id="real-world-patterns">Real-world patterns</h1>
 
 <p>Conventions distilled from a range of production Compony apps. These are <em>idioms</em>, not framework requirements — but they recur consistently and are worth adopting. Every example uses a neutral domain (<code>Account</code>, <code>Order</code>, <code>LineItem</code>, <code>Document</code>). Where a pattern relies on a companion gem (CanCanCan, ActiveType, simple_form, a date/select input) that is called out.</p>
 
 <p>For exact method signatures see <a href="/doc/guide/dsl_reference_md.html">dsl_reference.md</a>; for footguns see <a href="/doc/guide/gotchas_md.html">gotchas.md</a>.</p>
 
-<h2 id="label-1.+The+app+base-component+layer">1. The app base-component layer</h2>
+<h2 id="1-the-app-base-component-layer">1. The app base-component layer</h2>
 
 <p>Almost every non-trivial app inserts one abstract layer between Compony’s pre-built components and the concrete ones. Concrete components inherit from the app layer, never from Compony directly. This centralizes layout, button styling, and chrome so the whole app’s look changes in one place.</p>
 
@@ -91,11 +91,11 @@
 <span class='kw'>end</span>                                      <span class='comment'># fully functional, empty body
 </span></code></pre>
 
-<p>Recurring forms of this layer: <code>BaseComponents::{Index,Show,New,Edit,Destroy,List}</code>. The <code>content :main, hidden: true</code> + <code>content :wrapper</code> pair is the standard way to let children override the inner content while inheriting the outer chrome (see basic_componentbasic_component.md[/doc/guide/basic_component.md#nesting-content-blocks-calling-a-content-block-from-another]).</p>
+<p>Recurring forms of this layer: <code>BaseComponents::{Index,Show,New,Edit,Destroy,List}</code>. The <code>content :main, hidden: true</code> + <code>content :wrapper</code> pair is the standard way to let children override the inner content while inheriting the outer chrome (see <a href="/doc/guide/basic_component_md.html#nesting-content-blocks-calling-a-content-block-from-another">basic_component.md</a>).</p>
 
 <p>Teams sometimes add their own helper DSL on top of this layer (CSV/PDF helpers, archive toggles, etc.). Keep such helpers in the app base layer, not in concrete components.</p>
 
-<h2 id="label-2.+Thin+leaf+components">2. Thin leaf components</h2>
+<h2 id="2-thin-leaf-components">2. Thin leaf components</h2>
 
 <p>Concrete CRUD components are usually empty — all behavior is inherited. Add a <code>setup</code> block only to deviate.</p>
 
@@ -106,7 +106,7 @@
 
 <p>This is the single most common pattern. Prefer it over hand-written endpoints (<a href="/doc/guide/gotchas_md.html#15-hand-rolled-endpoint-where-a-pre-built-crud-component-exists">gotchas.md #15</a>).</p>
 
-<h2 id="label-3.+Index+-3D+load_data+scope+-2B+nested+-3Alist">3. Index = <code>load_data</code> scope + nested <code>:list</code></h2>
+<h2 id="3-index--loaddata-scope--nested-list">3. Index = <code>load_data</code> scope + nested <code>:list</code></h2>
 
 <p>Index components rarely render rows themselves; they load a scope and embed the family’s List via <code>render_sub_comp</code>.</p>
 
@@ -121,12 +121,12 @@
 <span class='kw'>end</span>
 </code></pre>
 <ul><li>
-<p><code>accessible_by(current_ability)</code> is the CanCanCan scoping idiom — pair it with the  <code>authorize</code> block so list and access rules agree.</p>
+<p><code>accessible_by(current_ability)</code> is the CanCanCan scoping idiom — pair it with the <code>authorize</code> block so list and access rules agree.</p>
 </li><li>
-<p><code>concat</code> is mandatory around <code>render_sub_comp</code>/<code>render_intent</code>  (<a href="/doc/guide/gotchas_md.html#2-render_intent--render_sub_comp-output-not-appearing">gotchas.md #2</a>).</p>
+<p><code>concat</code> is mandatory around <code>render_sub_comp</code>/<code>render_intent</code> (<a href="/doc/guide/gotchas_md.html#2-render_intent--render_sub_comp-output-not-appearing">gotchas.md #2</a>).</p>
 </li></ul>
 
-<h2 id="label-4.+List+customization">4. List customization</h2>
+<h2 id="4-list-customization">4. List customization</h2>
 
 <p>This pattern is typically combined with a customized <code>BaseComponents::List</code> that adds styling and features to the pre-built list component.</p>
 
@@ -152,7 +152,7 @@
 
 <p><code>skip_*</code> options (<code>skip_pagination:</code>, <code>skip_filtering:</code>, <code>skip_columns:</code>, …) are constructor kwargs passed through <code>render_sub_comp</code>, useful for read-only embeds.</p>
 
-<h2 id="label-5.+Custom+form+-2B+Schemacop-2C+kept+in+sync">5. Custom form + Schemacop, kept in sync</h2>
+<h2 id="5-custom-form--schemacop-kept-in-sync">5. Custom form + Schemacop, kept in sync</h2>
 
 <p><code>form_fields</code> (rendering) and <code>schema_*</code> (param whitelist) must mirror each other.</p>
 
@@ -176,13 +176,13 @@
 <span class='kw'>end</span>
 </code></pre>
 <ul><li>
-<p><code>as: :tom_select</code> / <code>as: :flatpickr_date(time)</code> are app-registered simple_form inputs  (TomSelect, Flatpickr) — a good choice for selects and date pickers.</p>
+<p><code>as: :tom_select</code> / <code>as: :flatpickr_date(time)</code> are app-registered simple_form inputs (TomSelect, Flatpickr) — a good choice for selects and date pickers.</p>
 </li><li>
-<p>Use the <strong>association name</strong> in <code>field</code>/<code>schema_field</code>; <code>_id</code> is added automatically  (<a href="/doc/guide/gotchas_md.html#4-schema_field-with-the-foreign-key-name">gotchas.md #4</a>).</p>
+<p>Use the <strong>association name</strong> in <code>field</code>/<code>schema_field</code>; <code>_id</code> is added automatically (<a href="/doc/guide/gotchas_md.html#4-schema_field-with-the-foreign-key-name">gotchas.md #4</a>).</p>
 </li><li>
-<p>Nested attributes: <code>f.simple_fields_for(:line_items)</code> in <code>form_fields</code> plus a raw  <code>schema_line { ary? :line_items_attributes do ... end }</code>.</p>
+<p>Nested attributes: <code>f.simple_fields_for(:line_items)</code> in <code>form_fields</code> plus a raw <code>schema_line { ary? :line_items_attributes do ... end }</code>.</p>
 </li><li>
-<p>Multilang fields: <code>field(:title, multilang: true).each { |i| concat i }</code> paired with  <code>schema_field :title, multilang: true</code>.</p>
+<p>Multilang fields: <code>field(:title, multilang: true).each { |i| concat i }</code> paired with <code>schema_field :title, multilang: true</code>.</p>
 </li></ul>
 
 <p>Wire a non-default form into New/Edit with <code>form_comp_class</code>:</p>
@@ -192,7 +192,7 @@
 <span class='kw'>end</span>
 </code></pre>
 
-<h2 id="label-6.+Autocomplete+form+-28app-level+subclass-29">6. Autocomplete form (app-level subclass)</h2>
+<h2 id="6-autocomplete-form-app-level-subclass">6. Autocomplete form (app-level subclass)</h2>
 
 <p>Compony does not ship autocomplete, but a very common app pattern is an <code>AutocompleteForm</code> base (subclass of <code>Compony::Components::Form</code>) exposing an extra <code>standalone</code> JSON endpoint for an ajax select. Shape:</p>
 
@@ -213,7 +213,7 @@
 
 <p>If you need autocomplete, build this base once and reuse it.</p>
 
-<h2 id="label-7.+Tabbed+Show+via+a+mixin">7. Tabbed Show via a mixin</h2>
+<h2 id="7-tabbed-show-via-a-mixin">7. Tabbed Show via a mixin</h2>
 
 <p>Detail pages are split into tabs with a small app mixin that adds a <code>tab</code> DSL and renders a tab bar into <code>:main</code>. Each tab body typically renders <code>content :data</code> or a nested list.</p>
 
@@ -230,20 +230,20 @@
 
 <p>The mixin keys the active tab off a prefixed param (<code>param_name(&#39;tab&#39;)</code>) so multiple tabbed components can coexist. Compony has no built-in tabs — copy the mixin per app.</p>
 
-<h2 id="label-8.+Lifecycle+hooks+for+derived+data">8. Lifecycle hooks for derived data</h2>
+<h2 id="8-lifecycle-hooks-for-derived-data">8. Lifecycle hooks for derived data</h2>
 <ul><li>
-<p><strong><code>after_assign_attributes</code></strong> — fill defaults / context after params are assigned,  before validation: <code>@data.account_id ||= current_user.account_id</code>.</p>
+<p><strong><code>after_assign_attributes</code></strong> — fill defaults / context after params are assigned, before validation: <code>@data.account_id ||= current_user.account_id</code>.</p>
 </li><li>
-<p><strong><code>before_render</code></strong> — verb-independent guards and precomputation. Redirect and the  content chain is skipped:  <code>ruby   before_render do redirect_to Compony.path(:show, @data) if @data.locked?   end </code></p>
+<p><strong><code>before_render</code></strong> — verb-independent guards and precomputation. Redirect and the content chain is skipped: <code>ruby  before_render do redirect_to Compony.path(:show, @data) if @data.locked?  end  </code></p>
 </li><li>
 <p><strong><code>load_data</code></strong> — narrow the scope (<code>accessible_by</code>, <code>includes</code>, ordering).</p>
 </li><li>
 <p><strong><code>store_data</code></strong> — override persistence (virtual models, file handling, bulk import).</p>
 </li><li>
-<p><strong><code>on_{created,updated,destroyed}_redirect_path</code></strong> — control where success lands, e.g.  <code>Compony.path(:show, @data.parent)</code> for owned records.</p>
+<p><strong><code>on_{created,updated,destroyed}_redirect_path</code></strong> — control where success lands, e.g. <code>Compony.path(:show, @data.parent)</code> for owned records.</p>
 </li></ul>
 
-<h2 id="label-9.+Exposed+intents+as+the+action+toolbar">9. Exposed intents as the action toolbar</h2>
+<h2 id="9-exposed-intents-as-the-action-toolbar">9. Exposed intents as the action toolbar</h2>
 
 <p>Concrete components tailor the header toolbar by <code>add</code>/<code>remove</code> on inherited intents.</p>
 
@@ -257,14 +257,14 @@
 <ul><li>
 <p><code>path: { format: :pdf }</code> points a button at a format endpoint (see pattern 10).</p>
 </li><li>
-<p><code>feasibility_action:</code> ties the button’s enabled state to a model <code>prevent</code>  (<a href="/doc/guide/feasibility_md.html">feasibility.md</a>).</p>
+<p><code>feasibility_action:</code> ties the button’s enabled state to a model <code>prevent</code> (<a href="/doc/guide/feasibility_md.html">feasibility.md</a>).</p>
 </li><li>
-<p>State-dependent toolbars (archived vs active) are done by branching inside the  <code>exposed_intents</code> block on <code>@data</code>.</p>
+<p>State-dependent toolbars (archived vs active) are done by branching inside the <code>exposed_intents</code> block on <code>@data</code>.</p>
 </li><li>
-<p>Generating one intent per enum value is common:  <code>Period.all.each { |p| add :new, :prices, name: :&quot;new_#{p.key}&quot;, path: { price: { period: p.key } } }</code>.</p>
+<p>Generating one intent per enum value is common: <code>Period.all.each { |p| add :new, :prices, name: :&quot;new_#{p.key}&quot;, path: { price: { period: p.key } } }</code>.</p>
 </li></ul>
 
-<h2 id="label-10.+CSV+-2F+PDF+via+respond+-3Aformat">10. CSV / PDF via <code>respond :format</code></h2>
+<h2 id="10-csv--pdf-via-respond-format">10. CSV / PDF via <code>respond :format</code></h2>
 
 <p>A format export is the same component with an extra <code>respond</code> branch and an exposed intent pointing at it. Because overriding <code>respond</code> skips the default <code>authorize</code>, re-check there (<a href="/doc/guide/gotchas_md.html#3-overriding-respond-skips-authorization">gotchas.md #3</a>).</p>
 
@@ -285,7 +285,7 @@
 <span class='comment'># exposed_intents { add :index, :orders, label: &#39;CSV&#39;, path: { format: :csv } }
 </span></code></pre>
 
-<h2 id="label-11.+Non-CRUD-3A+job+dispatch-2C+toggles-2C+clone">11. Non-CRUD: job dispatch, toggles, clone</h2>
+<h2 id="11-non-crud-job-dispatch-toggles-clone">11. Non-CRUD: job dispatch, toggles, clone</h2>
 
 <p><strong>Job dispatch</strong> — POST-only custom component, enqueue, flash, redirect:</p>
 
@@ -337,7 +337,7 @@
 <span class='kw'>end</span>
 </code></pre>
 
-<h2 id="label-12.+Virtual+model+for+non-persistent+-2F+upload+forms">12. Virtual model for non-persistent / upload forms</h2>
+<h2 id="12-virtual-model-for-non-persistent--upload-forms">12. Virtual model for non-persistent / upload forms</h2>
 
 <p>Inherit <code>New</code>, back it with a <code>Compony::VirtualModel</code>, take over the response. <code>@data.save</code> is a no-op so business logic goes in <code>on_created_respond</code> (or <code>store_data</code>).</p>
 
@@ -374,7 +374,7 @@
 
 <p>See <a href="/doc/guide/virtual_models_md.html">virtual_models.md</a> and <a href="/doc/guide/gotchas_md.html#12-activestorage-attachment-on-a-virtual-model">gotchas.md #12</a>.</p>
 
-<h2 id="label-13.+Public+endpoints+-26+webhooks">13. Public endpoints &amp; webhooks</h2>
+<h2 id="13-public-endpoints--webhooks">13. Public endpoints &amp; webhooks</h2>
 
 <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'><span class='object_link'><a href="Components.html" title="Components (module)">Components</a></span></span><span class='op'>::</span><span class='const'>Public</span><span class='op'>::</span><span class='const'>Webhook</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="Compony.html" title="Compony (module)">Compony</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Compony/Component.html" title="Compony::Component (class)">Component</a></span></span>
   <span class='id identifier rubyid_setup'>setup</span> <span class='kw'>do</span>
@@ -401,7 +401,7 @@
 
 <p>A login-aware redirect splitter is the same shape with <code>verb :get</code> + <code>before_render</code> choosing a <code>Compony.path</code> by <code>current_user</code>.</p>
 
-<h2 id="label-14.+Custom+button+style">14. Custom button style</h2>
+<h2 id="14-custom-button-style">14. Custom button style</h2>
 
 <p>Register one app button style and refer to it everywhere via <code>style:</code>.</p>
 
@@ -421,7 +421,7 @@
 
 <p>Make a separate style per visual kind (dropdown item, pill, compact) and select with <code>render_intent(:show, @data, style: :compact)</code>.</p>
 
-<h2 id="label-15.+Inline-edit+card+with+a+Turbo+Frame">15. Inline-edit card with a Turbo Frame</h2>
+<h2 id="15-inline-edit-card-with-a-turbo-frame">15. Inline-edit card with a Turbo Frame</h2>
 
 <p>A Show panel where the Edit form swaps in place (no full-page nav) and swaps back on save. Wrap both the Show content and the Edit form in a <strong>same-named</strong> <code>turbo_frame_tag</code>; Turbo Drive then scopes navigation to that frame. Distinct from the <code>render_sub_comp(:list, …, turbo_frame:)</code> use in <a href="/doc/guide/nesting_md.html">nesting.md</a> (there the frame isolates a nested list’s own search/filter params; here it is the inline-edit boundary for one record’s Show/Edit pair).</p>
 
@@ -451,12 +451,12 @@
 <span class='kw'>end</span>
 </code></pre>
 <ul><li>
-<p>Frame name must match exactly; deriving it from the record id keeps it unique when  several cards render on one page.</p>
+<p>Frame name must match exactly; deriving it from the record id keeps it unique when several cards render on one page.</p>
 </li><li>
-<p>A failed save re-renders Edit with HTTP 422 — keep the <code>turbo_frame_tag</code> wrapper in the  Edit content so errors render in-frame too.</p>
+<p>A failed save re-renders Edit with HTTP 422 — keep the <code>turbo_frame_tag</code> wrapper in the Edit content so errors render in-frame too.</p>
 </li></ul>
 
-<h2 id="label-16.+Multi-step+wizard+across+components">16. Multi-step wizard across components</h2>
+<h2 id="16-multi-step-wizard-across-components">16. Multi-step wizard across components</h2>
 
 <p>A create/edit flow split over several steps, each its own component, advancing on save. Chain steps with <code>on_updated_redirect_path</code> (or <code>on_created_redirect_path</code>) and render a step indicator via a shared mixin (same mechanism as the tabs mixin in §7).</p>
 
@@ -496,14 +496,14 @@
 <span class='comment'># …ConfirmEdit redirects to Show when done.
 </span></code></pre>
 <ul><li>
-<p>Each step is a normal resourceful component on the same model — partial validation per  step is just per-step <code>schema_field</code>s in each step’s Form.</p>
+<p>Each step is a normal resourceful component on the same model — partial validation per step is just per-step <code>schema_field</code>s in each step’s Form.</p>
 </li><li>
-<p>For a <em>non-persistent</em> wizard (nothing saved until the end), back the components with a  <a href="/doc/guide/virtual_models_md.html">VirtualModel</a> and carry state in its attributes (§12).</p>
+<p>For a <em>non-persistent</em> wizard (nothing saved until the end), back the components with a <a href="/doc/guide/virtual_models_md.html">VirtualModel</a> and carry state in its attributes (§12).</p>
 </li><li>
 <p><code>comp_name</code> drives the active-step highlight, so the mixin needs no per-step config.</p>
 </li></ul>
 
-<h2 id="label-17.+Inline+PATCH+without+a+form+-28reorder+-2F+quick+toggle-29">17. Inline PATCH without a form (reorder / quick toggle)</h2>
+<h2 id="17-inline-patch-without-a-form-reorder--quick-toggle">17. Inline PATCH without a form (reorder / quick toggle)</h2>
 
 <p>A JS front-end (drag-to-sort, an inline checkbox) issues a small PATCH that mutates state and returns no body. Add a <strong>named</strong> extra <code>standalone</code> with <code>verb :patch</code>, validate with Schemacop directly, and <code>head :ok</code>. No Form component involved.</p>
 
@@ -531,19 +531,19 @@
 
 <p>The route is <code>reorder_show_orders_comp</code> (see <a href="/doc/guide/standalone_md.html#naming-of-exposed-routes">standalone naming</a>); point your Stimulus controller’s PATCH at <code>Compony.path(:show, @data, standalone_name: :reorder)</code>.</p>
 <ul><li>
-<p>This is the <a href="/doc/guide/gotchas_md.html#3-overriding-respond-skips-authorization">gotchas.md #3</a>  case: the custom <code>respond</code> replaces the default that runs <code>authorize</code>, so authorize  again inside it.</p>
+<p>This is the <a href="/doc/guide/gotchas_md.html#3-overriding-respond-skips-authorization">gotchas.md #3</a> case: the custom <code>respond</code> replaces the default that runs <code>authorize</code>, so authorize again inside it.</p>
 </li><li>
-<p>Keep companion endpoints in the <em>same</em> component as the screen they serve — what extra  named <code>standalone</code>s are for  (<a href="/doc/guide/standalone_md.html#exposing-multiple-paths-in-the-same-component-calling-standalone-multiple-times">standalone.md</a>),  not a reason for a new component.</p>
+<p>Keep companion endpoints in the <em>same</em> component as the screen they serve — what extra named <code>standalone</code>s are for (<a href="/doc/guide/standalone_md.html#exposing-multiple-paths-in-the-same-component-calling-standalone-multiple-times">standalone.md</a>), not a reason for a new component.</p>
 </li><li>
 <p>Return <code>head :ok</code> (or small JSON) — no Compony content to render for an ajax-only verb.</p>
 </li></ul>
 
-<h2 id="label-18.+Signed-token+capability+links+-28auth-less+onboarding+-2F+magic+links-29">18. Signed-token capability links (auth-less onboarding / magic links)</h2>
+<h2 id="18-signed-token-capability-links-auth-less-onboarding--magic-links">18. Signed-token capability links (auth-less onboarding / magic links)</h2>
 
-<p>Goal: an emailed link that lets an unauthenticated visitor perform one bounded action — invite acceptance, magic login, password reset, email confirmation — without a session. The trick: override Compony’s <code>path do … end</code> to <strong>mint a signed JWT</strong> and carry it as a <code>token</code> query param, then gate a <code>skip_authentication!</code> standalone with <code>authorize { token_valid?(params) }</code>. A small mixin centralizes encode/decode.</p>
+<p>Goal: an emailed link that lets an unauthenticated visitor perform one bounded action —invite acceptance, magic login, password reset, email confirmation — without a session. The trick: override Compony’s <code>path do … end</code> to <strong>mint a signed JWT</strong> and carry it as a <code>token</code> query param, then gate a <code>skip_authentication!</code> standalone with <code>authorize { token_valid?(params) }</code>. A small mixin centralizes encode/decode.</p>
 
 <blockquote>
-<p><strong>Security — read before copying.</strong> Such a link <em>is</em> the capability; anyone holding the URL can perform the action. It is only safe if every one of these holds: - <strong>Expiry is mandatory.</strong> Put <code>exp</code> in the payload and verify it. A capability link  without a TTL is a permanent account-takeover primitive (it leaks via referrer  headers, proxy logs, mail forwarding, browser history). Pair short TTLs with a resend  flow. - <strong>Pin the algorithm and verify the signature</strong> — <code>JWT.decode(token, secret, true,   { algorithm: &#39;HS512&#39; })</code>. Never accept <code>alg: none</code>; never leave verification off. - <strong>Fail closed.</strong> Rescue <code>JWT::DecodeError</code> (its subclasses cover bad signature,  malformed token and expiry) and return <code>nil</code>/<code>false</code> so <code>authorize</code> denies with 403 —  not a 500. - <strong>Use a dedicated signing secret</strong>, not <code>secret_key_base</code>, so rotating it doesn’t also  invalidate every session (and vice-versa). - Still provide an <code>authorize</code> block: <code>skip_authentication!</code> removes <em>authentication</em>,  not authorization (#14[/doc/guide/gotchas.md#14-public-endpoint-still-401redirecting]).</p>
+<p><strong>Security — read before copying.</strong> Such a link <em>is</em> the capability; anyone holding the URL can perform the action. It is only safe if every one of these holds: - <strong>Expiry is mandatory.</strong> Put <code>exp</code> in the payload and verify it. A capability link without a TTL is a permanent account-takeover primitive (it leaks via referrer headers, proxy logs, mail forwarding, browser history). Pair short TTLs with a resend flow. - <strong>Pin the algorithm and verify the signature</strong> — <code>JWT.decode(token, secret, true,  { algorithm: &#39;HS512&#39; })</code>. Never accept <code>alg: none</code>; never leave verification off. - <strong>Fail closed.</strong> Rescue <code>JWT::DecodeError</code> (its subclasses cover bad signature, malformed token and expiry) and return <code>nil</code>/<code>false</code> so <code>authorize</code> denies with 403 — not a 500. - <strong>Use a dedicated signing secret</strong>, not <code>secret_key_base</code>, so rotating it doesn’t also invalidate every session (and vice-versa). - Still provide an <code>authorize</code> block: <code>skip_authentication!</code> removes <em>authentication</em>, not authorization (<a href="/doc/guide/gotchas_md.html#14-public-endpoint-still-401redirecting">gotchas.md #14</a>).</p>
 </blockquote>
 
 <pre class="code ruby"><code class="ruby"><span class='comment'># app/component_mixins/with_token.rb
@@ -633,24 +633,24 @@
 
 <p>Notes:</p>
 <ul><li>
-<p><code>Compony.path(:accept, :invites, account: some_account)</code> returns the full tokenized URL —  email that. The token, not a session, authorizes the request.</p>
+<p><code>Compony.path(:accept, :invites, account: some_account)</code> returns the full tokenized URL — email that. The token, not a session, authorizes the request.</p>
 </li><li>
-<p><code>path do</code> runs outside the request context; build URLs via  <code>Rails.application.routes.url_helpers</code>, not <code>controller</code>/<code>helpers</code> (see  <a href="/doc/guide/standalone_md.html#customizing-path-generation">standalone.md</a>).</p>
+<p><code>path do</code> runs outside the request context; build URLs via <code>Rails.application.routes.url_helpers</code>, not <code>controller</code>/<code>helpers</code> (see <a href="/doc/guide/standalone_md.html#customizing-path-generation">standalone.md</a>).</p>
 </li><li>
-<p>Reuse the mixin for every link flow (magic login, password reset, email confirm); encode  a flow discriminator or rely on the per-component payload shape-check to stop a token  minted for one flow being replayed against another.</p>
+<p>Reuse the mixin for every link flow (magic login, password reset, email confirm); encode a flow discriminator or rely on the per-component payload shape-check to stop a token minted for one flow being replayed against another.</p>
 </li><li>
-<p>One signed boolean in the payload (e.g. <code>confirmed: true</code>) is tamper-proof since the  client cannot re-sign — handy for multi-hop confirm flows.</p>
+<p>One signed boolean in the payload (e.g. <code>confirmed: true</code>) is tamper-proof since the client cannot re-sign — handy for multi-hop confirm flows.</p>
 </li></ul>
 
-<h2 id="label-Good+habits">Good habits</h2>
+<h2 id="good-habits">Good habits</h2>
 <ul><li>
-<p><strong>CanCanCan everywhere:</strong> <code>authorize { can?(...) }</code>, scope with  <code>Model.accessible_by(current_ability)</code>, bang form <code>authorize!(:read, record)</code> for  ad-hoc checks in <code>load_data</code>.</p>
+<p><strong>CanCanCan everywhere:</strong> <code>authorize { can?(...) }</code>, scope with <code>Model.accessible_by(current_ability)</code>, bang form <code>authorize!(:read, record)</code> for ad-hoc checks in <code>load_data</code>.</p>
 </li><li>
-<p><strong>Always <code>Compony.path</code> / <code>render_intent</code>,</strong> never hardcoded routes or <code>button_to</code>  (<a href="/doc/guide/gotchas_md.html#11-redirect_to-with-a-hardcoded-path">gotchas.md #11</a>, <a href="/doc/guide/gotchas_md.html#15-hand-rolled-endpoint-where-a-pre-built-crud-component-exists">#15</a>).</p>
+<p><strong>Always <code>Compony.path</code> / <code>render_intent</code>,</strong> never hardcoded routes or <code>button_to</code> (<a href="/doc/guide/gotchas_md.html#11-redirect_to-with-a-hardcoded-path">gotchas.md #11</a>, <a href="/doc/guide/gotchas_md.html#15-hand-rolled-endpoint-where-a-pre-built-crud-component-exists">#15</a>).</p>
 </li><li>
-<p><strong>Place a resourceful component in the family of the model it acts on,</strong> not the family  it is reached from; pass parent context via path params.</p>
+<p><strong>Place a resourceful component in the family of the model it acts on,</strong> not the family it is reached from; pass parent context via path params.</p>
 </li><li>
-<p><strong>Keep virtual/form-only fields off models</strong> — use ActiveType/VirtualModel  (<a href="/doc/guide/gotchas_md.html#16-attr_accessor-on-a-model-for-form-only-fields">gotchas.md #16</a>).</p>
+<p><strong>Keep virtual/form-only fields off models</strong> — use ActiveType/VirtualModel (<a href="/doc/guide/gotchas_md.html#16-attr_accessor-on-a-model-for-form-only-fields">gotchas.md #16</a>).</p>
 </li><li>
 <p><strong><code>concat</code></strong> around every <code>render_intent</code>/<code>render_sub_comp</code>/<code>field</code> in a block.</p>
 </li></ul>
@@ -659,7 +659,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sat Jun  6 09:14:48 2026 by
+  Generated on Tue Aug 18 14:36:35 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.4.9).
 </div>

data/doc/file.pre_built_components.html

@@ -60,7 +60,7 @@
       <div id="content"><div id='filecontents'>
 <p><a href="/README_md.html#guide--documentation">Back to the guide</a></p>
 
-<h1 id="label-Pre-built+components+shipped+with+Compony">Pre-built components shipped with Compony</h1>
+<h1 id="pre-built-components-shipped-with-compony">Pre-built components shipped with Compony</h1>
 
 <p>Compony comes with a few pre-built components that cover the most common cases that can be speed up development. They are meant to be inherited from and the easiest way to do this is by using the <a href="./generators_md.html">provided Rails generators</a> <code>rails g component ...</code>.</p>
 
@@ -89,7 +89,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sat Jun  6 09:14:47 2026 by
+  Generated on Tue Aug 18 14:36:34 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.4.9).
 </div>

data/doc/file.resourceful.html

@@ -60,7 +60,7 @@
       <div id="content"><div id='filecontents'>
 <p><a href="/README_md.html#guide--documentation">Back to the guide</a></p>
 
-<h1 id="label-Resourceful+components">Resourceful components</h1>
+<h1 id="resourceful-components">Resourceful components</h1>
 
 <p>So far, we have mainly seen how to present static content, without considering how loading and storing data is handled. Whenever a component is about data, be it a collection (e.g. index, list) or a single instance (e.g. new, show, edit, destroy, form), that component typically becomes resourceful. In order to implement a resourceful component, include the mixin <code>Compony::ComponentMixins::Resourceful</code>.</p>
 
@@ -142,7 +142,7 @@
 <span class='kw'>end</span>
 </code></pre>
 
-<h2 id="label-Complete+resourceful+lifecycle">Complete resourceful lifecycle</h2>
+<h2 id="complete-resourceful-lifecycle">Complete resourceful lifecycle</h2>
 
 <p>This graph documents a typical resourceful lifecycle according to which Compony’s <a href="./pre_built_components_md.html">pre-built components</a> are implemented.</p>
 <ul><li>
@@ -161,9 +161,9 @@
 <p><code>respond</code> typically shows a flash and redirects to another component.</p>
 </li></ul>
 
-<p><img src="/doc/resourceful_lifecycle.png"></p>
+<p><img src="/doc/resourceful_lifecycle.png" alt="Graph"> of the complete resourceful lifecycle</p>
 
-<h2 id="label-Nesting+resourceful+components">Nesting resourceful components</h2>
+<h2 id="nesting-resourceful-components">Nesting resourceful components</h2>
 
 <p>The <a href="/doc/guide/intents_md.html">Intent</a> API makes it very easy to pass a resource to nested components. For more details, refer to <a href="/doc/guide/nesting_md.html#rendering-list-as-sub-comp-in-show">this example</a>.</p>
 
@@ -171,7 +171,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sat Jun  6 09:14:46 2026 by
+  Generated on Tue Aug 18 14:36:33 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.4.9).
 </div>

data/doc/file.show.html

@@ -63,19 +63,19 @@
 <p><a href="/doc/guide/pre_built_components_md.html">List of pre-built components</a></p>
 </li></ul>
 
-<h1 id="label-Pre-built+components-3A+Show">Pre-built components: Show</h1>
+<h1 id="pre-built-components-show">Pre-built components: Show</h1>
 
 <p><code>Compony::Components::Show</code> is a resourceful standalone component corresponding to a Rails <code>show</code> action. It loads <code>@data</code> by <code>:id</code> and presents its fields.</p>
 
-<h2 id="label-What+it+does+by+default">What it does by default</h2>
+<h2 id="what-it-does-by-default">What it does by default</h2>
 
 <p>From <code>lib/compony/components/show.rb</code>:</p>
 <ul><li>
-<p><strong>Route:</strong> <code>standalone path: &quot;/#{family_name}/:id&quot;</code> with an <code>:id</code> constraint that accepts  integer <strong>or</strong> UUID ids, <code>verb :get</code> authorized by <code>can?(:show, @data)</code>.</p>
+<p><strong>Route:</strong> <code>standalone path: &quot;/#{family_name}/:id&quot;</code> with an <code>:id</code> constraint that accepts integer <strong>or</strong> UUID ids, <code>verb :get</code> authorized by <code>can?(:show, @data)</code>.</p>
 </li><li>
 <p><strong>Labels:</strong> long = <code>data.label</code>; short = a generic translated “Show”.</p>
 </li><li>
-<p><strong>Exposed intents:</strong> <code>:edit</code> and <code>:destroy</code> for <code>@data</code>, plus a <code>:back_to_owner</code> intent  if the model is <a href="/doc/guide/ownership_md.html">owned</a>.</p>
+<p><strong>Exposed intents:</strong> <code>:edit</code> and <code>:destroy</code> for <code>@data</code>, plus a <code>:back_to_owner</code> intent if the model is <a href="/doc/guide/ownership_md.html">owned</a>.</p>
 </li><li>
 <p><strong>Content blocks:</strong></p>
 </li><li>
@@ -89,9 +89,9 @@
 <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'><span class='object_link'><a href="Components.html" title="Components (module)">Components</a></span></span><span class='op'>::</span><span class='const'>Users</span><span class='op'>::</span><span class='const'>Show</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="Compony.html" title="Compony (module)">Compony</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Compony/Components.html" title="Compony::Components (module)">Components</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Compony/Components/Show.html" title="Compony::Components::Show (class)">Show</a></span></span><span class='semicolon'>;</span> <span class='kw'>end</span>   <span class='comment'># fully functional
 </span></code></pre>
 
-<h2 id="label-Column+DSL">Column DSL</h2>
+<h2 id="column-dsl">Column DSL</h2>
 
-<p><code>Show</code> shares a <code>column</code>/<code>columns</code> DSL with href="./list_md.html"></a> (here “column” means an attribute row, since Show renders one record).</p>
+<p><code>Show</code> shares a <code>column</code>/<code>columns</code> DSL with <a href="./list_md.html"><code>List</code></a> (here “column” means an attribute row, since Show renders one record).</p>
 
 <table role="table">
 <thead>
@@ -103,24 +103,24 @@
 </thead>
 <tbody>
 <tr>
-<td>‘column`</td>
-<td>‘column(:name, label: nil, class: nil, link_opts: {}, link_to_component: :show) { |record| … }`</td>
+<td><code>column</code></td>
+<td><code>column(:name, label: nil, class: nil, link_opts: {}, link_to_component: :show) { |record| ... }</code></td>
 <td>Add/define one attribute row. Without a block, treated as a model field; the block (instance-exec’d per record) supplies the value.</td>
 </tr>
 <tr>
-<td>‘columns`</td>
-<td>‘columns(:a, :b, **shared_kwargs)`</td>
-<td>Bulk ‘column`.</td>
+<td><code>columns</code></td>
+<td><code>columns(:a, :b, **shared_kwargs)</code></td>
+<td>Bulk <code>column</code>.</td>
 </tr>
 <tr>
-<td>‘all_field_columns`</td>
-<td>‘all_field_columns(@data)`</td>
+<td><code>all_field_columns</code></td>
+<td><code>all_field_columns(@data)</code></td>
 <td>Add a column for every model field (the default when none declared).</td>
 </tr>
 <tr>
-<td>‘skip_column`</td>
-<td>‘skip_column(:name)`</td>
-<td>Drop an inherited column. When nesting Show in a parent, prefer the constructor’s ‘skip_columns:` kwarg.</td>
+<td><code>skip_column</code></td>
+<td><code>skip_column(:name)</code></td>
+<td>Drop an inherited column. When nesting Show in a parent, prefer the constructor’s <code>skip_columns:</code> kwarg.</td>
 </tr>
 </tbody>
 </table>
@@ -148,7 +148,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sat Jun  6 09:14:47 2026 by
+  Generated on Tue Aug 18 14:36:34 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.4.9).
 </div>

data/doc/file.standalone.html

@@ -60,7 +60,7 @@
       <div id="content"><div id='filecontents'>
 <p><a href="/README_md.html#guide--documentation">Back to the guide</a></p>
 
-<h1 id="label-Standalone+-28routing+to+components-29">Standalone (routing to components)</h1>
+<h1 id="standalone-routing-to-components">Standalone (routing to components)</h1>
 
 <p>As stated earlier, Compony can generate routes to your components. This is achieved by using the standalone DSL inside the setup block. The first step is calling the method <code>standalone</code> with a path. Inside this block, you will then specify which HTTP verbs (e.g. GET, PATCH etc.) the component should listen to. As soon as both are specified, Compony will generate an appropriate route.</p>
 
@@ -106,7 +106,7 @@
 </li></ul>
 </li></ul>
 
-<h2 id="label-Exposing+multiple+paths+in+the+same+component+-28calling+standalone+multiple+times-29">Exposing multiple paths in the same component (calling standalone multiple times)</h2>
+<h2 id="exposing-multiple-paths-in-the-same-component-calling-standalone-multiple-times">Exposing multiple paths in the same component (calling standalone multiple times)</h2>
 
 <p>If your component loads data dynamically from a JavaScript front-end (e.g. implemented via Stimulus), you will find yourself in the situation where you need an extra route for a functionality that inherently belongs to the same component. Example use cases would be search fields that load data as the user types, maps that load tiles, dynamic photo galleries etc.</p>
 
@@ -135,16 +135,16 @@
 
 <p>Please note that the idea here is to package things that belong together, not to provide different kinds of content in a single component. For displaying different pages, use multiple components and have each expose a single route.</p>
 
-<h2 id="label-Naming+of+exposed+routes">Naming of exposed routes</h2>
+<h2 id="naming-of-exposed-routes">Naming of exposed routes</h2>
 
-<p>The routes to standalone components are named and you can point to them using Rails’ <code>..._path</code> and <code>..._url</code> helpers. The naming scheme is: <code>[standalone]<em>[component]</em>[family]_comp</code>. Examples:</p>
+<p>The routes to standalone components are named and you can point to them using Rails’ <code>..._path</code> and <code>..._url</code> helpers. The naming scheme is: <code>[standalone]_[component]_[family]_comp</code>. Examples:</p>
 <ul><li>
 <p>Default standalone: <code>Components::Users::Index</code> exports <code>index_users_comp</code> and thus <code>index_users_comp_path</code> can be used.</p>
 </li><li>
 <p>Named standalone: If <code>standalone :foo, path: ...</code> is used within <code>Components::Users::Index</code>, the exported name is <code>foo_index_users_comp</code>.</p>
 </li></ul>
 
-<h2 id="label-Handling+formats">Handling formats</h2>
+<h2 id="handling-formats">Handling formats</h2>
 
 <p>Compony is capable of responding to formats like Rails does. This is useful to deliver PDFs, CSV files etc. to a user from within Compony. This can be achieved by specifying the <code>respond</code> block:</p>
 
@@ -165,7 +165,7 @@
 <span class='kw'>end</span>
 </code></pre>
 
-<h2 id="label-Redirect+in+respond+or+in+before_render-3F">Redirect in <code>respond</code> or in <code>before_render</code>?</h2>
+<h2 id="redirect-in-respond-or-in-beforerender">Redirect in <code>respond</code> or in <code>before_render</code>?</h2>
 
 <p>Rails controller redirects can be issued both in a verb DSL’s <code>respond</code> block and in <code>before_render</code>. The rule of thumb that tells you which way to go is:</p>
 <ul><li>
@@ -174,7 +174,7 @@
 <p>If you want to redirect depending on params, state, time etc. <strong>independently of the HTTP verb</strong>, use <code>before_render</code>, as this is more convenient than writing a standalone -&gt; verb -&gt; respond tree.</p>
 </li></ul>
 
-<h2 id="label-Path+constraints">Path constraints</h2>
+<h2 id="path-constraints">Path constraints</h2>
 
 <p>When calling <code>standalone</code>, you may specify the keyword <code>constraints</code> that will be passed to the route. For example:</p>
 
@@ -185,7 +185,7 @@
 </span><span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>:lang</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>constraints:</span> <span class='lbrace'>{</span> <span class='label'>lang:</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>([a-z]{2})?</span><span class='regexp_end'>/i</span></span> <span class='rbrace'>}</span>
 </code></pre>
 
-<h2 id="label-Passing+scopes">Passing scopes</h2>
+<h2 id="passing-scopes">Passing scopes</h2>
 
 <p>When calling <code>standalone</code>, you may specify the keyword <code>scope</code> to wrap the component’s Rails route into a route scope. Additionally, you may specify a hash <code>scope_args</code>, which will be passed as keyword arguments to the <code>scope</code> call in the route:</p>
 
@@ -202,7 +202,7 @@
 <span class='kw'>end</span>
 </code></pre>
 
-<h2 id="label-Customizing+path+generation">Customizing path generation</h2>
+<h2 id="customizing-path-generation">Customizing path generation</h2>
 
 <p>By implementing <code>path do ... end</code> inside the <code>setup</code> method of a component, you can override the way paths to that component are generated. Customizing the path generation will affect all mentioned methods mentioned here involving paths, such as <code>Compony.path</code>, <code>render_intent</code> etc.</p>
 
@@ -212,9 +212,9 @@
 
 <p>Where overriding <code>path</code> is genuinely useful:</p>
 <ul><li>
-<p><strong>Inject a derived/looked-up param.</strong> Callers pass a high-level argument and the block  turns it into concrete path params.</p>
+<p><strong>Inject a derived/looked-up param.</strong> Callers pass a high-level argument and the block turns it into concrete path params.</p>
 </li><li>
-<p><strong>Mint a signed token into the URL</strong> so an unauthenticated link can authorize itself —  a full worked recipe is in  <a href="/doc/guide/patterns_md.html#18-signed-token-capability-links-auth-less-onboarding--magic-links">Real-world patterns §18 (signed-token capability links)</a>  (magic login, password reset, invite/confirm links).</p>
+<p><strong>Mint a signed token into the URL</strong> so an unauthenticated link can authorize itself — a full worked recipe is in <a href="/doc/guide/patterns_md.html#18-signed-token-capability-links-auth-less-onboarding--magic-links">Real-world patterns §18 (signed-token capability links)</a> (magic login, password reset, invite/confirm links).</p>
 </li><li>
 <p><strong>Custom slugs / vanity paths</strong> that differ from the Rails route helper’s default shape.</p>
 </li></ul>
@@ -223,7 +223,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sat Jun  6 09:14:46 2026 by
+  Generated on Tue Aug 18 14:36:33 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.4.9).
 </div>

data/doc/file.virtual_models.html

@@ -60,7 +60,7 @@
       <div id="content"><div id='filecontents'>
 <p><a href="/README_md.html#guide--documentation">Back to the guide</a></p>
 
-<h1 id="label-Unleashing+virtual+models+through+Compony-27s+ActiveType+integration">Unleashing virtual models through Compony’s <code>ActiveType</code> integration</h1>
+<h1 id="unleashing-virtual-models-through-componys-activetype-integration">Unleashing virtual models through Compony’s <code>ActiveType</code> integration</h1>
 
 <p>Compony explicitely supports using virtual models using the <code>active_type</code> gem for its resourceful components. However, when doing so, your model should inherit from <code>Compony::VirtualModel</code> rather than from <code>ActiveType::Object</code>.</p>
 
@@ -107,7 +107,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sat Jun  6 09:14:46 2026 by
+  Generated on Tue Aug 18 14:36:34 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.4.9).
 </div>