compony 0.11.8 → 0.11.9

data/doc/Compony/Components/WithForm.html

@@ -130,7 +130,7 @@
 
   
     <h2>
-      Instance Method Summary
+      DSL
       <small><a href="#" class="summary_toggle">collapse</a></small>
     </h2>
 
@@ -139,7 +139,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#form_cancancan_action-instance_method" title="#form_cancancan_action (instance method)">#<strong>form_cancancan_action</strong>(new_form_cancancan_action = :missing)  &#x21d2; Object </a>
+      <a href="#form_cancancan_action-instance_method" title="#form_cancancan_action (instance method)">#<strong>form_cancancan_action</strong>(new_form_cancancan_action = :missing)  &#x21d2; Symbol<sup>?</sup> </a>
     
 
     
@@ -154,7 +154,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>DSL method Sets and gets the form’s cancancan action (for cancancan’s accessible_attributes).</p>
+<p>DSL method Sets and gets the form’s CanCanCan action, used for per-field <code>permitted_attributes</code>.</p>
 </div></span>
   
 </li>
@@ -163,7 +163,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#form_comp-instance_method" title="#form_comp (instance method)">#<strong>form_comp</strong>  &#x21d2; Object </a>
+      <a href="#form_comp_class-instance_method" title="#form_comp_class (instance method)">#<strong>form_comp_class</strong>(new_form_comp_class = nil)  &#x21d2; Class<sup>?</sup> </a>
     
 
     
@@ -178,7 +178,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns an instance of the form component responsible for rendering the form.</p>
+<p>DSL method Overrides the Form component class instantiated by <span class='object_link'><a href="#form_comp-instance_method" title="Compony::Components::WithForm#form_comp (method)">#form_comp</a></span> (defaults to the same-family <code>Form</code>).</p>
 </div></span>
   
 </li>
@@ -187,7 +187,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#form_comp_class-instance_method" title="#form_comp_class (instance method)">#<strong>form_comp_class</strong>(new_form_comp_class = nil)  &#x21d2; Object </a>
+      <a href="#submit_path-instance_method" title="#submit_path (instance method)">#<strong>submit_path</strong> {|controller| ... } &#x21d2; void </a>
     
 
     
@@ -202,7 +202,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>DSL method Overrides the form comp class that is instanciated to render the form.</p>
+<p>DSL method Overrides the submit path, which otherwise defaults to this component’s own path.</p>
 </div></span>
   
 </li>
@@ -211,15 +211,13 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>  &#x21d2; WithForm </a>
+      <a href="#submit_verb-instance_method" title="#submit_verb (instance method)">#<strong>submit_verb</strong>(new_submit_verb = nil)  &#x21d2; Symbol </a>
     
 
     
   </span>
   
   
-    <span class="note title constructor">constructor</span>
-  
   
   
   
@@ -228,16 +226,25 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>A new instance of WithForm.</p>
+<p>DSL method Sets or returns the HTTP verb the twinned form submits with (<code>:post</code> for New, <code>:patch</code> for Edit).</p>
 </div></span>
   
 </li>
 
       
+    </ul>
+  
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#submit_path-instance_method" title="#submit_path (instance method)">#<strong>submit_path</strong>(&amp;new_submit_path_block)  &#x21d2; Object </a>
+      <a href="#form_comp-instance_method" title="#form_comp (instance method)">#<strong>form_comp</strong>  &#x21d2; Object </a>
     
 
     
@@ -252,7 +259,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>DSL method Overrides the submit path which would otherwise default to this component This takes a block that will be called and given a controller.</p>
+<p>Returns an instance of the form component responsible for rendering the form.</p>
 </div></span>
   
 </li>
@@ -261,13 +268,15 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#submit_verb-instance_method" title="#submit_verb (instance method)">#<strong>submit_verb</strong>(new_submit_verb = nil)  &#x21d2; Object </a>
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>  &#x21d2; WithForm </a>
     
 
     
   </span>
   
   
+    <span class="note title constructor">constructor</span>
+  
   
   
   
@@ -276,7 +285,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>DSL method Sets or returns the previously set submit verb.</p>
+<p>A new instance of WithForm.</p>
 </div></span>
   
 </li>
@@ -354,7 +363,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="form_cancancan_action-instance_method">
   
-    #<strong>form_cancancan_action</strong>(new_form_cancancan_action = :missing)  &#x21d2; <tt>Object</tt> 
+    #<strong>form_cancancan_action</strong>(new_form_cancancan_action = :missing)  &#x21d2; <tt>Symbol</tt><sup>?</sup> 
   
 
   
@@ -363,13 +372,53 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>DSL method Sets and gets the form’s cancancan action (for cancancan’s accessible_attributes)</p>
+<p>DSL method Sets and gets the form’s CanCanCan action, used for per-field <code>permitted_attributes</code>. Pass <code>nil</code> to disable per-field auth.</p>
 
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>new_form_cancancan_action</span>
+      
+      
+        <span class='type'>(<tt>Symbol</tt>, <tt>nil</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>:missing</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The CanCanCan action (e.g. <code>:edit</code>); omit to read the current value.</p>
+</div>
+      
+    </li>
   
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Symbol</tt>, <tt>nil</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The configured CanCanCan action.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -377,15 +426,15 @@
       <pre class="lines">
 
 
-45
-46
-47
-48
-49
-50</pre>
+56
+57
+58
+59
+60
+61</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony/components/with_form.rb', line 45</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/with_form.rb', line 56</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_form_cancancan_action'>form_cancancan_action</span><span class='lparen'>(</span><span class='id identifier rubyid_new_form_cancancan_action'>new_form_cancancan_action</span> <span class='op'>=</span> <span class='symbol'>:missing</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='id identifier rubyid_new_form_cancancan_action'>new_form_cancancan_action</span> <span class='op'>!=</span> <span class='symbol'>:missing</span>
@@ -454,7 +503,7 @@
       <div class="method_details ">
   <h3 class="signature " id="form_comp_class-instance_method">
   
-    #<strong>form_comp_class</strong>(new_form_comp_class = nil)  &#x21d2; <tt>Object</tt> 
+    #<strong>form_comp_class</strong>(new_form_comp_class = nil)  &#x21d2; <tt>Class</tt><sup>?</sup> 
   
 
   
@@ -463,13 +512,53 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>DSL method Overrides the form comp class that is instanciated to render the form</p>
+<p>DSL method Overrides the Form component class instantiated by <span class='object_link'><a href="#form_comp-instance_method" title="Compony::Components::WithForm#form_comp (method)">#form_comp</a></span> (defaults to the same-family <code>Form</code>).</p>
 
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>new_form_comp_class</span>
+      
+      
+        <span class='type'>(<tt>Class</tt>, <tt>nil</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The Form component class to use.</p>
+</div>
+      
+    </li>
   
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Class</tt>, <tt>nil</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The configured form component class.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -477,12 +566,12 @@
       <pre class="lines">
 
 
-39
-40
-41</pre>
+47
+48
+49</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony/components/with_form.rb', line 39</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/with_form.rb', line 47</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_form_comp_class'>form_comp_class</span><span class='lparen'>(</span><span class='id identifier rubyid_new_form_comp_class'>new_form_comp_class</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='ivar'>@form_comp_class</span> <span class='op'>||=</span> <span class='id identifier rubyid_new_form_comp_class'>new_form_comp_class</span>
@@ -495,7 +584,7 @@
       <div class="method_details ">
   <h3 class="signature " id="submit_path-instance_method">
   
-    #<strong>submit_path</strong>(&amp;new_submit_path_block)  &#x21d2; <tt>Object</tt> 
+    #<strong>submit_path</strong> {|controller| ... } &#x21d2; <tt>void</tt> 
   
 
   
@@ -503,14 +592,32 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    
-<p>DSL method Overrides the submit path which would otherwise default to this component This takes a block that will be called and given a controller</p>
+    <p class="note returns_void">This method returns an undefined value.</p>
+<p>DSL method Overrides the submit path, which otherwise defaults to this component’s own path.</p>
 
 
   </div>
 </div>
 <div class="tags">
   
+<p class="tag_title">Yields:</p>
+<ul class="yield">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>controller</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Called with the controller; expected to return the Rails path the form submits to.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -518,12 +625,12 @@
       <pre class="lines">
 
 
-55
-56
-57</pre>
+68
+69
+70</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony/components/with_form.rb', line 55</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/with_form.rb', line 68</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_submit_path'>submit_path</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_new_submit_path_block'>new_submit_path_block</span><span class='rparen'>)</span>
   <span class='ivar'>@submit_path_block</span> <span class='op'>=</span> <span class='id identifier rubyid_new_submit_path_block'>new_submit_path_block</span>
@@ -536,7 +643,7 @@
       <div class="method_details ">
   <h3 class="signature " id="submit_verb-instance_method">
   
-    #<strong>submit_verb</strong>(new_submit_verb = nil)  &#x21d2; <tt>Object</tt> 
+    #<strong>submit_verb</strong>(new_submit_verb = nil)  &#x21d2; <tt>Symbol</tt> 
   
 
   
@@ -545,13 +652,53 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>DSL method Sets or returns the previously set submit verb</p>
+<p>DSL method Sets or returns the HTTP verb the twinned form submits with (<code>:post</code> for New, <code>:patch</code> for Edit).</p>
 
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
   
+    <li>
+      
+        <span class='name'>new_submit_verb</span>
+      
+      
+        <span class='type'>(<tt>Symbol</tt>, <tt>nil</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>If given, sets the submit verb; must be a known HTTP verb.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Symbol</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The (possibly just set) submit verb.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -559,18 +706,18 @@
       <pre class="lines">
 
 
-27
-28
-29
-30
-31
 32
 33
 34
-35</pre>
+35
+36
+37
+38
+39
+40</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony/components/with_form.rb', line 27</span>
+      <pre class="code"><span class="info file"># File 'lib/compony/components/with_form.rb', line 32</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_submit_verb'>submit_verb</span><span class='lparen'>(</span><span class='id identifier rubyid_new_submit_verb'>new_submit_verb</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='id identifier rubyid_new_submit_verb'>new_submit_verb</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
@@ -591,7 +738,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.html

@@ -118,7 +118,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/ControllerMixin.html

@@ -126,7 +126,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/Engine.html

@@ -123,7 +123,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/Intent.html

@@ -1491,7 +1491,7 @@
       
         —
         <div class='inline'>
-<p>If present, overrides the class of the generated button component, defaults to Compony#default_button_style.</p>
+<p>If present, overrides the class of the generated button component, defaults to <span class='object_link'><a href="../Compony.html#default_button_style-class_method" title="Compony.default_button_style (method)">Compony.default_button_style</a></span>.</p>
 </div>
       
     </li>
@@ -1561,7 +1561,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/ManageIntentsDsl.html

@@ -403,7 +403,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/MethodAccessibleHash.html

@@ -443,7 +443,7 @@ instance_of_a_hash.roo --> nil
 </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/ModelFields/Anchormodel.html

@@ -509,7 +509,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/ModelFields/Association.html

@@ -603,7 +603,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/ModelFields/Attachment.html

@@ -495,7 +495,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/ModelFields/Base.html

@@ -1186,7 +1186,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/ModelFields/Boolean.html

@@ -354,7 +354,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/ModelFields/Color.html

@@ -289,7 +289,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/ModelFields/Currency.html

@@ -222,7 +222,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/ModelFields/Date.html

@@ -222,7 +222,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/ModelFields/Datetime.html

@@ -222,7 +222,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/ModelFields/Decimal.html

@@ -144,7 +144,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/ModelFields/Email.html

@@ -230,7 +230,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/ModelFields/Float.html

@@ -144,7 +144,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>