compony 0.11.8 → 0.11.9

data/doc/Compony/Components/Destroy.html

@@ -136,7 +136,7 @@
 
   
     <h2>
-      Instance Method Summary
+      DSL
       <small><a href="#" class="summary_toggle">collapse</a></small>
     </h2>
 
@@ -145,7 +145,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#on_destroyed-instance_method" title="#on_destroyed (instance method)">#<strong>on_destroyed</strong>(&amp;block)  &#x21d2; Object </a>
+      <a href="#on_destroyed-instance_method" title="#on_destroyed (instance method)">#<strong>on_destroyed</strong> { ... } &#x21d2; void </a>
     
 
     
@@ -160,7 +160,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 destroy but before responding.</p>
 </div></span>
   
 </li>
@@ -169,7 +169,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#on_destroyed_redirect_path-instance_method" title="#on_destroyed_redirect_path (instance method)">#<strong>on_destroyed_redirect_path</strong>(&amp;block)  &#x21d2; Object </a>
+      <a href="#on_destroyed_redirect_path-instance_method" title="#on_destroyed_redirect_path (instance method)">#<strong>on_destroyed_redirect_path</strong> { ... } &#x21d2; void </a>
     
 
     
@@ -184,7 +184,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_destroyed_respond-instance_method" title="Compony::Components::Destroy#on_destroyed_respond (method)">#on_destroyed_respond</a></span> (keeping the default flash).</p>
 </div></span>
   
 </li>
@@ -193,7 +193,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#on_destroyed_respond-instance_method" title="#on_destroyed_respond (instance method)">#<strong>on_destroyed_respond</strong>(&amp;block)  &#x21d2; Object </a>
+      <a href="#on_destroyed_respond-instance_method" title="#on_destroyed_respond (instance method)">#<strong>on_destroyed_respond</strong> { ... } &#x21d2; void </a>
     
 
     
@@ -208,7 +208,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>DSL method.</p>
+<p>DSL method Overrides the response issued after a successful destroy.</p>
 </div></span>
   
 </li>
@@ -249,7 +249,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="on_destroyed-instance_method">
   
-    #<strong>on_destroyed</strong>(&amp;block)  &#x21d2; <tt>Object</tt> 
+    #<strong>on_destroyed</strong> { ... } &#x21d2; <tt>void</tt> 
   
 
   
@@ -257,14 +257,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 destroy but before responding. Suitable for post-destroy side effects (like an <code>after_destroy</code> that only fires when this component destroyed the record). Do not redirect or render here - use <span class='object_link'><a href="#on_destroyed_respond-instance_method" title="Compony::Components::Destroy#on_destroyed_respond (method)">#on_destroyed_respond</a></span> / <span class='object_link'><a href="#on_destroyed_redirect_path-instance_method" title="Compony::Components::Destroy#on_destroyed_redirect_path (method)">#on_destroyed_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 destroyed.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -272,12 +290,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/destroy.rb', line 83</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/destroy.rb', line 90</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_on_destroyed'>on_destroyed</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_destroyed_block</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
@@ -290,7 +308,7 @@
       <div class="method_details ">
   <h3 class="signature " id="on_destroyed_redirect_path-instance_method">
   
-    #<strong>on_destroyed_redirect_path</strong>(&amp;block)  &#x21d2; <tt>Object</tt> 
+    #<strong>on_destroyed_redirect_path</strong> { ... } &#x21d2; <tt>void</tt> 
   
 
   
@@ -298,14 +316,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_destroyed_respond-instance_method" title="Compony::Components::Destroy#on_destroyed_respond (method)">#on_destroyed_respond</a></span> (keeping the default flash). Defaults to the owner’s Show (if owned) 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>
@@ -313,12 +349,12 @@
       <pre class="lines">
 
 
-93
-94
-95</pre>
+111
+112
+113</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony/components/destroy.rb', line 93</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/destroy.rb', line 111</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_on_destroyed_redirect_path'>on_destroyed_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_destroyed_redirect_path_block</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
@@ -331,7 +367,7 @@
       <div class="method_details ">
   <h3 class="signature " id="on_destroyed_respond-instance_method">
   
-    #<strong>on_destroyed_respond</strong>(&amp;block)  &#x21d2; <tt>Object</tt> 
+    #<strong>on_destroyed_respond</strong> { ... } &#x21d2; <tt>void</tt> 
   
 
   
@@ -339,14 +375,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 destroy. The default shows a flash and redirects to <span class='object_link'><a href="#on_destroyed_redirect_path-instance_method" title="Compony::Components::Destroy#on_destroyed_redirect_path (method)">#on_destroyed_redirect_path</a></span> with HTTP 303 (forces a GET, required for Turbo). If you override this, <span class='object_link'><a href="#on_destroyed_redirect_path-instance_method" title="Compony::Components::Destroy#on_destroyed_redirect_path (method)">#on_destroyed_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>
@@ -354,12 +408,12 @@
       <pre class="lines">
 
 
-88
-89
-90</pre>
+101
+102
+103</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony/components/destroy.rb', line 88</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/destroy.rb', line 101</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_on_destroyed_respond'>on_destroyed_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_destroyed_respond_block</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
@@ -374,7 +428,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/Edit.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_update_failed-instance_method" title="#on_update_failed (instance method)">#<strong>on_update_failed</strong>(&amp;block)  &#x21d2; Object </a>
+      <a href="#on_update_failed-instance_method" title="#on_update_failed (instance method)">#<strong>on_update_failed</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 update failed (<code>@update_succeeded</code> is not true).</p>
 </div></span>
   
 </li>
@@ -171,7 +171,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#on_updated-instance_method" title="#on_updated (instance method)">#<strong>on_updated</strong>(&amp;block)  &#x21d2; Object </a>
+      <a href="#on_updated-instance_method" title="#on_updated (instance method)">#<strong>on_updated</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 update but before responding.</p>
 </div></span>
   
 </li>
@@ -195,7 +195,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#on_updated_redirect_path-instance_method" title="#on_updated_redirect_path (instance method)">#<strong>on_updated_redirect_path</strong>(&amp;block)  &#x21d2; Object </a>
+      <a href="#on_updated_redirect_path-instance_method" title="#on_updated_redirect_path (instance method)">#<strong>on_updated_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_updated_respond-instance_method" title="Compony::Components::Edit#on_updated_respond (method)">#on_updated_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_updated_respond-instance_method" title="#on_updated_respond (instance method)">#<strong>on_updated_respond</strong>(&amp;block)  &#x21d2; Object </a>
+      <a href="#on_updated_respond-instance_method" title="#on_updated_respond (instance method)">#<strong>on_updated_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 update.</p>
 </div></span>
   
 </li>
@@ -286,7 +286,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="on_update_failed-instance_method">
   
-    #<strong>on_update_failed</strong>(&amp;block)  &#x21d2; <tt>Object</tt> 
+    #<strong>on_update_failed</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 update failed (<code>@update_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">
 
 
-110
-111
-112</pre>
+132
+133
+134</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony/components/edit.rb', line 110</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/edit.rb', line 132</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_on_update_failed'>on_update_failed</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_update_failed_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_updated-instance_method">
   
-    #<strong>on_updated</strong>(&amp;block)  &#x21d2; <tt>Object</tt> 
+    #<strong>on_updated</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 update but before responding. Suitable for post-update side effects (like an <code>after_update</code> that only fires when this component updated the record). Do not redirect or render here - use <span class='object_link'><a href="#on_updated_respond-instance_method" title="Compony::Components::Edit#on_updated_respond (method)">#on_updated_respond</a></span> / <span class='object_link'><a href="#on_updated_redirect_path-instance_method" title="Compony::Components::Edit#on_updated_redirect_path (method)">#on_updated_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">
 
 
-95
-96
-97</pre>
+102
+103
+104</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony/components/edit.rb', line 95</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/edit.rb', line 102</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_on_updated'>on_updated</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_updated_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_updated_redirect_path-instance_method">
   
-    #<strong>on_updated_redirect_path</strong>(&amp;block)  &#x21d2; <tt>Object</tt> 
+    #<strong>on_updated_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_updated_respond-instance_method" title="Compony::Components::Edit#on_updated_respond (method)">#on_updated_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">
 
 
-105
-106
-107</pre>
+122
+123
+124</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony/components/edit.rb', line 105</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/edit.rb', line 122</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_on_updated_redirect_path'>on_updated_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_updated_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_updated_respond-instance_method">
   
-    #<strong>on_updated_respond</strong>(&amp;block)  &#x21d2; <tt>Object</tt> 
+    #<strong>on_updated_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 update. The default shows a flash and redirects to <span class='object_link'><a href="#on_updated_redirect_path-instance_method" title="Compony::Components::Edit#on_updated_redirect_path (method)">#on_updated_redirect_path</a></span>. If you override this, <span class='object_link'><a href="#on_updated_redirect_path-instance_method" title="Compony::Components::Edit#on_updated_redirect_path (method)">#on_updated_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">
 
 
-100
-101
-102</pre>
+112
+113
+114</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony/components/edit.rb', line 100</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/edit.rb', line 112</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_on_updated_respond'>on_updated_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_updated_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>