compony 0.11.8 → 0.11.9

data/doc/Compony/Components/Index.html

@@ -162,7 +162,7 @@
 </div>
 
       <div id="footer">
-  Generated on Fri May 15 10:29:34 2026 by
+  Generated on Mon May 18 13:55:36 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.3.5).
 </div>

data/doc/Compony/Components/List.html

@@ -546,7 +546,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>DSL method If a block is given: Enters the DSL where row intents can be added or removed (use from Component#setup within the component).</p>
+<p>DSL method If a block is given: Enters the DSL where row intents can be added or removed (use from <span class='object_link'><a href="../Component.html#setup-class_method" title="Compony::Component.setup (method)">Compony::Component.setup</a></span> within the component).</p>
 </div></span>
   
 </li>
@@ -2116,7 +2116,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>DSL method If a block is given: Enters the DSL where row intents can be added or removed (use from Component#setup within the component). If no block is given: Builds the declared intents for the given record and returns them (use in <code>content</code> or <code>before_render</code>, pass kwarg <code>:data</code>).</p>
+<p>DSL method If a block is given: Enters the DSL where row intents can be added or removed (use from <span class='object_link'><a href="../Component.html#setup-class_method" title="Compony::Component.setup (method)">Compony::Component.setup</a></span> within the component). If no block is given: Builds the declared intents for the given record and returns them (use in <code>content</code> or <code>before_render</code>, pass kwarg <code>:data</code>).</p>
 
 
   </div>
@@ -2689,7 +2689,7 @@
 </div>
 
       <div id="footer">
-  Generated on Fri May 15 10:29:34 2026 by
+  Generated on Mon May 18 13:55:36 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.3.5).
 </div>

data/doc/Compony/Components/New.html

@@ -138,7 +138,7 @@
 
   
     <h2>
-      Instance Method Summary
+      DSL
       <small><a href="#" class="summary_toggle">collapse</a></small>
     </h2>
 
@@ -147,7 +147,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#on_create_failed_respond-instance_method" title="#on_create_failed_respond (instance method)">#<strong>on_create_failed_respond</strong>(&amp;block)  &#x21d2; Object </a>
+      <a href="#on_create_failed_respond-instance_method" title="#on_create_failed_respond (instance method)">#<strong>on_create_failed_respond</strong> { ... } &#x21d2; void </a>
     
 
     
@@ -162,7 +162,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>DSL method.</p>
+<p>DSL method Overrides the response issued when the create failed (<code>@create_succeeded</code> is not true).</p>
 </div></span>
   
 </li>
@@ -171,7 +171,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#on_created-instance_method" title="#on_created (instance method)">#<strong>on_created</strong>(&amp;block)  &#x21d2; Object </a>
+      <a href="#on_created-instance_method" title="#on_created (instance method)">#<strong>on_created</strong> { ... } &#x21d2; void </a>
     
 
     
@@ -186,7 +186,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>DSL method Sets a block that is evaluated with backfire in the successful case after storing, but before responding.</p>
+<p>DSL method Sets an optional hook evaluated (with backfire) after a successful create but before responding.</p>
 </div></span>
   
 </li>
@@ -195,7 +195,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#on_created_redirect_path-instance_method" title="#on_created_redirect_path (instance method)">#<strong>on_created_redirect_path</strong>(&amp;block)  &#x21d2; Object </a>
+      <a href="#on_created_redirect_path-instance_method" title="#on_created_redirect_path (instance method)">#<strong>on_created_redirect_path</strong> { ... } &#x21d2; void </a>
     
 
     
@@ -210,7 +210,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>DSL method.</p>
+<p>DSL method Overrides the redirect target used by the default <span class='object_link'><a href="#on_created_respond-instance_method" title="Compony::Components::New#on_created_respond (method)">#on_created_respond</a></span> (keeping the default flash).</p>
 </div></span>
   
 </li>
@@ -219,7 +219,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#on_created_respond-instance_method" title="#on_created_respond (instance method)">#<strong>on_created_respond</strong>(&amp;block)  &#x21d2; Object </a>
+      <a href="#on_created_respond-instance_method" title="#on_created_respond (instance method)">#<strong>on_created_respond</strong> { ... } &#x21d2; void </a>
     
 
     
@@ -234,7 +234,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>DSL method.</p>
+<p>DSL method Overrides the response issued after a successful create.</p>
 </div></span>
   
 </li>
@@ -286,7 +286,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="on_create_failed_respond-instance_method">
   
-    #<strong>on_create_failed_respond</strong>(&amp;block)  &#x21d2; <tt>Object</tt> 
+    #<strong>on_create_failed_respond</strong> { ... } &#x21d2; <tt>void</tt> 
   
 
   
@@ -294,14 +294,32 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>DSL method</p>
+    <p class="note returns_void">This method returns an undefined value.</p>
+<p>DSL method Overrides the response issued when the create failed (<code>@create_succeeded</code> is not true). The default logs the errors with level <code>warn</code> and re-renders the component with HTTP 422 so the form shows errors.</p>
 
 
   </div>
 </div>
 <div class="tags">
   
+<p class="tag_title">Yields:</p>
+<ul class="yield">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>Runs in the component’s request context; expected to render or redirect.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -309,12 +327,12 @@
       <pre class="lines">
 
 
-98
-99
-100</pre>
+120
+121
+122</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony/components/new.rb', line 98</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/new.rb', line 120</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_on_create_failed_respond'>on_create_failed_respond</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='ivar'>@on_create_failed_respond_block</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
@@ -327,7 +345,7 @@
       <div class="method_details ">
   <h3 class="signature " id="on_created-instance_method">
   
-    #<strong>on_created</strong>(&amp;block)  &#x21d2; <tt>Object</tt> 
+    #<strong>on_created</strong> { ... } &#x21d2; <tt>void</tt> 
   
 
   
@@ -335,14 +353,32 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>DSL method Sets a block that is evaluated with backfire in the successful case after storing, but before responding.</p>
+    <p class="note returns_void">This method returns an undefined value.</p>
+<p>DSL method Sets an optional hook evaluated (with backfire) after a successful create but before responding. Suitable for post-create side effects (like an <code>after_create</code> that only fires when this component created the record). Do not redirect or render here - use <span class='object_link'><a href="#on_created_respond-instance_method" title="Compony::Components::New#on_created_respond (method)">#on_created_respond</a></span> / <span class='object_link'><a href="#on_created_redirect_path-instance_method" title="Compony::Components::New#on_created_redirect_path (method)">#on_created_redirect_path</a></span> for that.</p>
 
 
   </div>
 </div>
 <div class="tags">
   
+<p class="tag_title">Yields:</p>
+<ul class="yield">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>Runs in the component’s request context after <code>@data</code> was saved successfully.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -350,12 +386,12 @@
       <pre class="lines">
 
 
-83
-84
-85</pre>
+90
+91
+92</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony/components/new.rb', line 83</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/new.rb', line 90</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_on_created'>on_created</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='ivar'>@on_created_block</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
@@ -368,7 +404,7 @@
       <div class="method_details ">
   <h3 class="signature " id="on_created_redirect_path-instance_method">
   
-    #<strong>on_created_redirect_path</strong>(&amp;block)  &#x21d2; <tt>Object</tt> 
+    #<strong>on_created_redirect_path</strong> { ... } &#x21d2; <tt>void</tt> 
   
 
   
@@ -376,14 +412,32 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>DSL method</p>
+    <p class="note returns_void">This method returns an undefined value.</p>
+<p>DSL method Overrides the redirect target used by the default <span class='object_link'><a href="#on_created_respond-instance_method" title="Compony::Components::New#on_created_respond (method)">#on_created_respond</a></span> (keeping the default flash). Defaults to the data’s Show, the owner’s Show, or the data’s Index.</p>
 
 
   </div>
 </div>
 <div class="tags">
   
+<p class="tag_title">Yields:</p>
+<ul class="yield">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>Runs in the component’s request context; expected to return a Rails path (e.g. via <code>Compony.path</code>).</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -391,12 +445,12 @@
       <pre class="lines">
 
 
-93
-94
-95</pre>
+110
+111
+112</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony/components/new.rb', line 93</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/new.rb', line 110</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_on_created_redirect_path'>on_created_redirect_path</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='ivar'>@on_created_redirect_path_block</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
@@ -409,7 +463,7 @@
       <div class="method_details ">
   <h3 class="signature " id="on_created_respond-instance_method">
   
-    #<strong>on_created_respond</strong>(&amp;block)  &#x21d2; <tt>Object</tt> 
+    #<strong>on_created_respond</strong> { ... } &#x21d2; <tt>void</tt> 
   
 
   
@@ -417,14 +471,32 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>DSL method</p>
+    <p class="note returns_void">This method returns an undefined value.</p>
+<p>DSL method Overrides the response issued after a successful create. The default shows a flash and redirects to <span class='object_link'><a href="#on_created_redirect_path-instance_method" title="Compony::Components::New#on_created_redirect_path (method)">#on_created_redirect_path</a></span>. If you override this, <span class='object_link'><a href="#on_created_redirect_path-instance_method" title="Compony::Components::New#on_created_redirect_path (method)">#on_created_redirect_path</a></span> is no longer called.</p>
 
 
   </div>
 </div>
 <div class="tags">
   
+<p class="tag_title">Yields:</p>
+<ul class="yield">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'>
+<p>Runs in the component’s request context; expected to render or redirect.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -432,12 +504,12 @@
       <pre class="lines">
 
 
-88
-89
-90</pre>
+100
+101
+102</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony/components/new.rb', line 88</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/new.rb', line 100</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_on_created_respond'>on_created_respond</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='ivar'>@on_created_respond_block</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
@@ -452,7 +524,7 @@
 </div>
 
       <div id="footer">
-  Generated on Fri May 15 10:29:33 2026 by
+  Generated on Mon May 18 13:55:35 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.3.5).
 </div>

data/doc/Compony/Components/Show.html

@@ -755,7 +755,7 @@
 </div>
 
       <div id="footer">
-  Generated on Fri May 15 10:29:34 2026 by
+  Generated on Mon May 18 13:55:36 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.3.5).
 </div>