compony 0.11.12 → 0.11.13

data/doc/file.README.html

@@ -60,7 +60,7 @@
       <div id="content"><div id='filecontents'>
 <p>&lt;img src=“logo.svg” height=250 alt=“Compony logo”/&gt;</p>
 
-<h1 id="label-Where+to+read+what">Where to read what</h1>
+<h1 id="where-to-read-what">Where to read what</h1>
 <ul><li>
 <p>Get to know what Compony is and which concepts it uses in the <a href="https://github.com/kalsan/compony">README on GitHub</a>.</p>
 </li><li>
@@ -69,7 +69,7 @@
 <p>There is also a <a href="https://www.rubydoc.info/github/kalsan/compony.git">RubyDoc page for Compony</a> available.</p>
 </li></ul>
 
-<h1 id="label-About+Compony">About Compony</h1>
+<h1 id="about-compony">About Compony</h1>
 
 <p>Compony is a Gem that allows you to write your Rails application in <strong>component-style</strong> fashion. It combines a controller action and route along with its view into a single Ruby class. Along with the DSL approach and a powerful model mixin, Compony <strong>makes your application’s code more semantic</strong>, allows writing <strong>much DRYer code</strong>, using inheritance even in views and <strong>much easier refactoring</strong> for your Rails applications, helping you to <strong>keep the code clean as the application evolves</strong>.</p>
 
@@ -95,15 +95,15 @@
 <p>Compony uses <a href="https://github.com/CanCanCommunity/cancancan">CanCanCan</a> for authorization but does not provide an authentication mechanism. You can easily build your own by creating login/logout components that manage cookies, and configure Compony to enforce authentication using the <code>Compony.authentication_before_action</code> setter. I have also successfully tested Compony to work with <a href="https://github.com/heartcombo/devise">Devise</a>.</p>
 </li></ul>
 
-<h2 id="label-State+of+the+project">State of the project</h2>
+<h2 id="state-of-the-project">State of the project</h2>
 
-<p>I am actively using this framework in various applications and both performance and reliability are good. However, the project is experimental and lacking peer reviews and especially automatic testing, such as unit and integration tests. Also, expect there to be (<a href="/CHANGELOG_md.html">documented</a>) breaking changes in the future, as the API will likely be further refined, resulting in renamings and deprecation of various methods.</p>
+<p>I am actively using this framework in various applications and both performance and reliability are good. However, the project is experimental and lacking peer reviews and especially extensive automatic testing, such as unit and integration tests. Also, expect there to be (<a href="/CHANGELOG_md.html">documented</a>) breaking changes in the future, as the API will likely be further refined, resulting in renamings and deprecation of various methods.</p>
 
-<h2 id="label-Other+projects+exploring+similar+concepts">Other projects exploring similar concepts</h2>
+<h2 id="other-projects-exploring-similar-concepts">Other projects exploring similar concepts</h2>
 
 <p>A project with a similar aim, but a different approach, is <a href="https://github.com/phlex-ruby/phlex">Phlex</a>.</p>
 
-<h1 id="label-Guide+-2F+Documentation">Guide / Documentation</h1>
+<h1 id="guide--documentation">Guide / Documentation</h1>
 
 <p>The following topics should help you get started. Please note that the links will not work in yard doc - read this on <a href="https://github.com/kalsan/compony">Compony’s GitHub repo</a>.</p>
 <ul><li>
@@ -181,18 +181,28 @@
 </li></ul>
 </li></ul>
 
-<h1 id="label-Contributing">Contributing</h1>
+<h1 id="contributing">Contributing</h1>
 
 <p>Compony is Free Software under the LGPLv3 and you are most welcome to contribute to it.</p>
 <ul><li>
-<p>If you spotted a security vulnerability, <strong>do not open an issue</strong> but instead use the contact form at <a href="https://kalsan.ch/#contact">kalsan.ch/#contact</a> instead (English is just fine, even if the website is in German).</p>
+<p>If you spotted a security vulnerability, <strong>do not open an issue</strong> but instead use the contact form at <a href="https://kalsan.ch/#contact">https://kalsan.ch/#contact</a> instead (English is just fine, even if the website is in German).</p>
 </li><li>
 <p>If you’d like to contribute feedback or discuss something, please open an issue.</p>
 </li><li>
 <p>If you have an idea that is worth implementing, please fork the repo, implement your changes in your own fork, and open a pull request.</p>
 </li></ul>
 
-<h1 id="label-Caveats">Caveats</h1>
+<h2 id="running-the-tests">Running the tests</h2>
+
+<p>The gem ships an RSpec suite backed by a minimal dummy Rails app (in-memory SQLite, no setup needed):</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_install'>install</span>
+<span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rspec'>rspec</span>   <span class='comment'># or: bundle exec rake spec (also the default rake task)
+</span></code></pre>
+
+<p>See <a href="./spec/README_md.html">spec/README.md</a> for the suite’s layout and the reasons behind the Gemfile’s <code>rails</code> and <code>rack</code> version pins.</p>
+
+<h1 id="caveats">Caveats</h1>
 <ul><li>
 <p>The API is not yet as consistent as I’d like it. Examples:</p>
 </li><li>
@@ -212,7 +222,7 @@
 <p>Compony is not compatible with <code>tailwindcss-rails</code>. This is likely due to Tailwind automatically removing any CSS that is not used by the application and the usage detection not picking up Compony components, as their content is not provided in views.</p>
 </li></ul>
 
-<h1 id="label-Acknowledgements">Acknowledgements</h1>
+<h1 id="acknowledgements">Acknowledgements</h1>
 
 <p>A big thank you to Alex and Koni who have patiently listened to my weird ideas and helped me developing them further, resulting in a few of the key concepts of Compony, such as <code>param_name</code>, or the way forms are structured.</p>
 
@@ -220,7 +230,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Tue Jun 30 22:41:17 2026 by
+  Generated on Tue Aug 18 14:36:32 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.basic_component.html

@@ -60,15 +60,15 @@
       <div id="content"><div id='filecontents'>
 <p><a href="/README_md.html#guide--documentation">Back to the guide</a></p>
 
-<h1 id="label-What+is+a+component-3F">What is a component?</h1>
+<h1 id="what-is-a-component">What is a component?</h1>
 
 <p>Compony components are nestable elements that are capable of replacing Rails’ routes, views and controllers. They structure code for data manipulation, authentication and rendering into a single class that can easily be subclassed. This is achieved with Compony’s DSL that provides a readable and overridable way to store your logic.</p>
 
 <p>Just like Rails, Compony is opinionated and you are advised to structure your code according to the examples and explanations. This makes it easier for others to dive into existing code.</p>
 
-<h1 id="label-A+basic+-28bare-29+component">A basic (bare) component</h1>
+<h1 id="a-basic-bare-component">A basic (bare) component</h1>
 
-<h2 id="label-Naming">Naming</h2>
+<h2 id="naming">Naming</h2>
 
 <p>Compony components must be named according to the pattern <code>Components::FamilyName::ComponentName</code>.</p>
 <ul><li>
@@ -81,7 +81,7 @@
 
 <p>If you have abstract components (i.e. components that your app never uses directly, but which you inherit from), you may name and place them arbitrarily.</p>
 
-<h2 id="label-Initialization-2C+manual+instantiation+and+rendering">Initialization, manual instantiation and rendering</h2>
+<h2 id="initialization-manual-instantiation-and-rendering">Initialization, manual instantiation and rendering</h2>
 
 <p>You will rarely have to override <code>def initialize</code> of a component, as most of your code will go into the component’s <code>setup</code> block as explained below. However, when you do, make sure to forward all default arguments to the parent class, as they are essential to the component’s function:</p>
 
@@ -106,7 +106,7 @@
 &lt;%= index_users_comp.render(controller, locals: { weather: :sunny }) %&gt;
 </code></pre>
 
-<h2 id="label-Setup">Setup</h2>
+<h2 id="setup">Setup</h2>
 
 <p>Every component must call the static method <code>setup</code> which will contain most of the code of your components. This can be achieved either by a call directly from your class, or by <a href="/doc/guide/inheritance_md.html">inheriting</a> from a component that calls <code>setup</code>. If both classes call the method, the inherited class’ <code>setup</code> is run first and the inheriting’s second, thus, the child class can override setup properties of the parent class.</p>
 
@@ -121,7 +121,7 @@
 
 <p>The code in setup is run at the end the component’s initialization. In this block, you will call a number of methods that define the component’s behavior and which we will explain now.</p>
 
-<h3 id="label-Labelling">Labelling</h3>
+<h3 id="labelling">Labelling</h3>
 
 <p>This defines a component’s label, both as seen from within the component and from the outside, e.g. from an <a href="/doc/guide/intents_md.html">intent</a>. You can query the label in order to display it as a title in your component. Links and buttons to components will also display the same label, allowing you to easily rename a component, including any parts of your UI that point to it.</p>
 
@@ -174,11 +174,11 @@
 </span><span class='id identifier rubyid_my_component'>my_component</span><span class='period'>.</span><span class='id identifier rubyid_icon'>icon</span> <span class='comment'># [:&#39;fa-solid&#39;, :circle]
 </span></code></pre>
 
-<h3 id="label-Providing+content">Providing content</h3>
+<h3 id="providing-content">Providing content</h3>
 
 <p>Basic components do not come with default content. Instead, you must call the method <code>content</code> inside the setup block and provide a block containing your view. It will be evaluated inside a <a href="/doc/guide/internal_datastructures_md.html#requestcontext">request context</a>.</p>
 
-<p>In this block, provide the HTML to be generated using Dyny: <a href="https://github.com/kalsan/dyny">github.com/kalsan/dyny</a></p>
+<p>In this block, provide the HTML to be generated using Dyny: <a href="https://github.com/kalsan/dyny">https://github.com/kalsan/dyny</a></p>
 
 <p>Here is an example of a component that renders a title along with a paragraph:</p>
 
@@ -191,7 +191,7 @@
 <span class='kw'>end</span>
 </code></pre>
 
-<h4 id="label-Naming+content+blocks-2C+ordering+and+overriding+them+in+subclasses">Naming content blocks, ordering and overriding them in subclasses</h4>
+<h4 id="naming-content-blocks-ordering-and-overriding-them-in-subclasses">Naming content blocks, ordering and overriding them in subclasses</h4>
 
 <p>Content blocks are actually named. The <code>content</code> call adds or replaces a previously defined content block, e.g. in an earlier call to <code>setup</code> in a component’s superclass. When calling <code>content</code> without a name, it defaults to <code>main</code> and will overwrite any previous <code>main</code> content. However, you can provide your own name and refer to other names by using the <code>before:</code> keyword.</p>
 
@@ -214,13 +214,13 @@
 <span class='kw'>end</span>
 </code></pre>
 
-<p>This results in:  - This appears first.  - Welcome to my basic component.  - This paragraph is inserted between the others.  - Thank you and see you tonight.</p>
+<p>This results in: - This appears first. - Welcome to my basic component. - This paragraph is inserted between the others. - Thank you and see you tonight.</p>
 
 <p>As you see, overusing this feature can lead to messy code as it becomes unclear what happens in what order. For this reason, this feature should only be used to decouple the content of your abstract components for allowing surgical overrides in <a href="/doc/guide/inheritance_md.html">subclasses</a>.</p>
 
 <p>It is a good convention to always have one content block named <code>:main</code>, as you might want to refer to it in subclasses.</p>
 
-<h4 id="label-Nesting+content+blocks-2C+calling+a+content+block+from+another">Nesting content blocks, calling a content block from another</h4>
+<h4 id="nesting-content-blocks-calling-a-content-block-from-another">Nesting content blocks, calling a content block from another</h4>
 
 <p>In some situations, such as in forms, it can be useful to nest content blocks. This will also allow subclasses to override a wrapper while keeping the content, and vice versa. To make this possible, you can also use the <code>content</code> keyword inside a content block. Note that unlike the call in <code>setup</code>, this call will render a content block instead of defining it. This happens inside the request context and the content block must be defined inside the current component.</p>
 
@@ -263,7 +263,7 @@
 <pre class="code ruby"><code class="ruby">&lt;div class=&quot;card card-body&quot;&gt;&lt;h1&gt;Hello&lt;/h1&gt;&lt;p&gt;Welcome to my site.&lt;/p&gt;&lt;/div&gt;
 </code></pre>
 
-<h4 id="label-Removing+content+blocks">Removing content blocks</h4>
+<h4 id="removing-content-blocks">Removing content blocks</h4>
 
 <p>If a component’s parent class defines a content block that is undesired in a subclass component, the content block can be removed as follows:</p>
 
@@ -272,7 +272,7 @@
 </span><span class='kw'>end</span>
 </code></pre>
 
-<h3 id="label-Redirecting+away+-2F+Intercepting+rendering">Redirecting away / Intercepting rendering</h3>
+<h3 id="redirecting-away--intercepting-rendering">Redirecting away / Intercepting rendering</h3>
 
 <p>Immediately before the <code>content</code> block(s) are evaluated, another chain of blocks is evaluated if present: <code>before_render</code>. If on of these blocks creates a reponse body in the Rails controller, the subsequent <code>before_render</code> blocks and all <code>content</code> blocks are skipped.</p>
 
@@ -304,7 +304,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Tue Jun 30 22:41:18 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.cookbook.html

@@ -60,11 +60,11 @@
       <div id="content"><div id='filecontents'>
 <p><a href="/README_md.html#guide--documentation">Back to the guide</a></p>
 
-<h1 id="label-Cookbook">Cookbook</h1>
+<h1 id="cookbook">Cookbook</h1>
 
 <p>Task-oriented entry point: “I want to do X — where is it?”. Every recipe lives in <a href="./patterns_md.html">Real-world patterns</a> or the guide; this page is a pure index by goal so you don’t need to know a pattern’s name. Nothing is duplicated here — only links.</p>
 
-<h2 id="label-Recipes+by+task">Recipes by task</h2>
+<h2 id="recipes-by-task">Recipes by task</h2>
 
 <table role="table">
 <thead>
@@ -76,99 +76,99 @@
 <tbody>
 <tr>
 <td>Share layout/chrome across all components</td>
-<td>[patterns §1 base layer](./patterns.md#1-the-app-base-component-layer)</td>
+<td><a href="./patterns_md.html#1-the-app-base-component-layer">patterns §1 base layer</a></td>
 </tr>
 <tr>
 <td>Add a CRUD screen with almost no code</td>
-<td>[patterns §2 thin leaves](./patterns.md#2-thin-leaf-components), [example.md](./example.md)</td>
+<td><a href="./patterns_md.html#2-thin-leaf-components">patterns §2 thin leaves</a>, <a href="./example_md.html">example.md</a></td>
 </tr>
 <tr>
 <td>List records with columns/filters/sorts</td>
-<td>[List](./pre_built_components/list.md), [patterns §3–4](./patterns.md#3-index–load_data-scope–nested-list)</td>
+<td><a href="./pre_built_components/list_md.html">List</a>, <a href="./patterns_md.html#3-index--load_data-scope--nested-list">patterns §3–4</a></td>
 </tr>
 <tr>
 <td>Scope/order what an Index shows</td>
-<td>[patterns §3](./patterns.md#3-index–load_data-scope–nested-list) (‘load_data`)</td>
+<td><a href="./patterns_md.html#3-index--load_data-scope--nested-list">patterns §3</a> (<code>load_data</code>)</td>
 </tr>
 <tr>
 <td>Embed a child list inside a Show</td>
-<td>[patterns §4](./patterns.md#4-list-customization), [nesting.md](./nesting.md)</td>
+<td><a href="./patterns_md.html#4-list-customization">patterns §4</a>, <a href="./nesting_md.html">nesting.md</a></td>
 </tr>
 <tr>
 <td>Build a custom form + strong params</td>
-<td>[patterns §5](./patterns.md#5-custom-form–schemacop-kept-in-sync), [Form](./pre_built_components/form.md)</td>
+<td><a href="./patterns_md.html#5-custom-form--schemacop-kept-in-sync">patterns §5</a>, <a href="./pre_built_components/form_md.html">Form</a></td>
 </tr>
 <tr>
 <td>Nested attributes in a form</td>
-<td>[patterns §5](./patterns.md#5-custom-form–schemacop-kept-in-sync), [example_advanced.md](./example_advanced.md)</td>
+<td><a href="./patterns_md.html#5-custom-form--schemacop-kept-in-sync">patterns §5</a>, <a href="./example_advanced_md.html">example_advanced.md</a></td>
 </tr>
 <tr>
 <td>Autocomplete / ajax select field</td>
-<td>[patterns §6](./patterns.md#6-autocomplete-form-app-level-subclass)</td>
+<td><a href="./patterns_md.html#6-autocomplete-form-app-level-subclass">patterns §6</a></td>
 </tr>
 <tr>
 <td>Split a detail page into tabs</td>
-<td>[patterns §7](./patterns.md#7-tabbed-show-via-a-mixin)</td>
+<td><a href="./patterns_md.html#7-tabbed-show-via-a-mixin">patterns §7</a></td>
 </tr>
 <tr>
 <td>Prefill/derive fields before save</td>
-<td>[patterns §8](./patterns.md#8-lifecycle-hooks-for-derived-data) (‘after_assign_attributes`)</td>
+<td><a href="./patterns_md.html#8-lifecycle-hooks-for-derived-data">patterns §8</a> (<code>after_assign_attributes</code>)</td>
 </tr>
 <tr>
 <td>Guard/redirect before rendering</td>
-<td>[patterns §8](./patterns.md#8-lifecycle-hooks-for-derived-data), [basic_component.md](./basic_component.md#redirecting-away–intercepting-rendering)</td>
+<td><a href="./patterns_md.html#8-lifecycle-hooks-for-derived-data">patterns §8</a>, <a href="./basic_component_md.html#redirecting-away--intercepting-rendering">basic_component.md</a></td>
 </tr>
 <tr>
 <td>Customize the action toolbar</td>
-<td>[patterns §9](./patterns.md#9-exposed-intents-as-the-action-toolbar), [intents.md](./intents.md#exposed-intents)</td>
+<td><a href="./patterns_md.html#9-exposed-intents-as-the-action-toolbar">patterns §9</a>, <a href="./intents_md.html#exposed-intents">intents.md</a></td>
 </tr>
 <tr>
 <td>Disable a button with a reason</td>
-<td>[feasibility.md](./feasibility.md), [patterns §9](./patterns.md#9-exposed-intents-as-the-action-toolbar)</td>
+<td><a href="./feasibility_md.html">feasibility.md</a>, <a href="./patterns_md.html#9-exposed-intents-as-the-action-toolbar">patterns §9</a></td>
 </tr>
 <tr>
 <td>Export CSV / PDF</td>
-<td>[patterns §10](./patterns.md#10-csv–pdf-via-respond-format)</td>
+<td><a href="./patterns_md.html#10-csv--pdf-via-respond-format">patterns §10</a></td>
 </tr>
 <tr>
 <td>Launch a background job from a button</td>
-<td>[patterns §11](./patterns.md#11-non-crud-job-dispatch-toggles-clone)</td>
+<td><a href="./patterns_md.html#11-non-crud-job-dispatch-toggles-clone">patterns §11</a></td>
 </tr>
 <tr>
 <td>Toggle a boolean (activate/lock/…)</td>
-<td>[patterns §11](./patterns.md#11-non-crud-job-dispatch-toggles-clone)</td>
+<td><a href="./patterns_md.html#11-non-crud-job-dispatch-toggles-clone">patterns §11</a></td>
 </tr>
 <tr>
 <td>Clone/duplicate a record</td>
-<td>[patterns §11](./patterns.md#11-non-crud-job-dispatch-toggles-clone)</td>
+<td><a href="./patterns_md.html#11-non-crud-job-dispatch-toggles-clone">patterns §11</a></td>
 </tr>
 <tr>
 <td>Non-persistent / upload-only form</td>
-<td>[patterns §12](./patterns.md#12-virtual-model-for-non-persistent–upload-forms), [virtual_models.md](./virtual_models.md)</td>
+<td><a href="./patterns_md.html#12-virtual-model-for-non-persistent--upload-forms">patterns §12</a>, <a href="./virtual_models_md.html">virtual_models.md</a></td>
 </tr>
 <tr>
 <td>Public page / inbound webhook</td>
-<td>[patterns §13](./patterns.md#13-public-endpoints–webhooks), [gotchas §14](./gotchas.md#14-public-endpoint-still-401redirecting)</td>
+<td><a href="./patterns_md.html#13-public-endpoints--webhooks">patterns §13</a>, <a href="./gotchas_md.html#14-public-endpoint-still-401redirecting">gotchas §14</a></td>
 </tr>
 <tr>
 <td>Custom button look</td>
-<td>[patterns §14](./patterns.md#14-custom-button-style), [intents.md](./intents.md#adding-your-own-styles)</td>
+<td><a href="./patterns_md.html#14-custom-button-style">patterns §14</a>, <a href="./intents_md.html#adding-your-own-styles">intents.md</a></td>
 </tr>
 <tr>
 <td>Inline-edit a card without a full page</td>
-<td>[patterns §15 turbo-frame inline edit](./patterns.md#15-inline-edit-card-with-a-turbo-frame)</td>
+<td><a href="./patterns_md.html#15-inline-edit-card-with-a-turbo-frame">patterns §15 turbo-frame inline edit</a></td>
 </tr>
 <tr>
 <td>Multi-step wizard across components</td>
-<td>[patterns §16 multi-step wizard](./patterns.md#16-multi-step-wizard-across-components)</td>
+<td><a href="./patterns_md.html#16-multi-step-wizard-across-components">patterns §16 multi-step wizard</a></td>
 </tr>
 <tr>
 <td>Reorder/inline-patch without a form</td>
-<td>[patterns §17 inline PATCH](./patterns.md#17-inline-patch-without-a-form-reorder–quick-toggle)</td>
+<td><a href="./patterns_md.html#17-inline-patch-without-a-form-reorder--quick-toggle">patterns §17 inline PATCH</a></td>
 </tr>
 <tr>
 <td>Magic-login / invite / reset / confirm link (no session)</td>
-<td>[patterns §18 signed-token capability links](./patterns.md#18-signed-token-capability-links-auth-less-onboarding–magic-links)</td>
+<td><a href="./patterns_md.html#18-signed-token-capability-links-auth-less-onboarding--magic-links">patterns §18 signed-token capability links</a></td>
 </tr>
 </tbody>
 </table>
@@ -179,7 +179,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Tue Jun 30 22:41:20 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.destroy.html

@@ -63,7 +63,7 @@
 <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+Destroy">Pre-built components: Destroy</h1>
+<h1 id="pre-built-components-destroy">Pre-built components: Destroy</h1>
 
 <p>This component is the Compony equivalent to a typical Rails controller’s <code>destroy</code> action.</p>
 
@@ -95,7 +95,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Tue Jun 30 22:41:19 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>