Class: Ruact::Generators::ScaffoldGenerator::ScaffoldAttribute

Inherits:

Object

• Object
• Ruact::Generators::ScaffoldGenerator::ScaffoldAttribute

Defined in:

lib/generators/ruact/scaffold/scaffold_attribute.rb

Overview

A single scaffold attribute (name + AR type) with the view-model helpers the templates consume. references columns address <name>_id. Lives in its own file to keep Ruact::Generators::ScaffoldGenerator within its class-length budget; reopens the generator class so TYPE_MAP resolves by lexical scope.

Instance Attribute Summary

• #name ⇒ Object readonly

  Returns the value of attribute name.

• #type ⇒ Object readonly

  Returns the value of attribute type.

Instance Method Summary

• #boolean? ⇒ Boolean
• #column_kind ⇒ Object

  The DataTable cell renderer kind (Story 10.2 AC1): :badge → boolean → Badge "Yes"/"No" :numeric → integer/float/decimal/references → right-aligned numeric :date → date/datetime → locale-formatted :text → string/text → plain text.

• #column_name ⇒ Object

  The wire/DB column the controller params + serialized rows use.

• #control ⇒ Object
• #date? ⇒ Boolean

  date/datetime — the List sorts these columns by epoch time (Story 10.2b).

• #initialize(name, type) ⇒ ScaffoldAttribute constructor

  A new instance of ScaffoldAttribute.

• #js_setter ⇒ Object

  The React useState setter name (authorId → setAuthorId).

• #js_var ⇒ Object

  camelCase JS identifier for the column (author_id → authorId).

• #options_ivar ⇒ Object

  references only — the controller ivar / view local holding the capped parent options (author → author_options).

• #options_prop ⇒ Object

  references only — the camelCase prop the view passes and the Form reads (author → authorOptions, blog_post → blogPostOptions).

• #reference? ⇒ Boolean
• #reference_class_name ⇒ Object

  references only — the parent model constant (author → Author, blog_post → BlogPost), used by the controller's options loader.

• #shadcn_control ⇒ Object

  The shadcn Form control this attribute renders as (Story 10.3 AC1): :input → string → :textarea → text → :switch → boolean → <Switch> :number → integer/float/decimal → <Input type="number"> :date → date → <Input type="date"> :datetime → datetime → <Input type="datetime-local"> :select → references → <Select> of parent options The :input/:number/:date/:datetime kinds all render an <Input>; the concrete <code>type=</code> attribute comes from <code>html_input_type</code> (FormHelpers).</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#ts_type-instance_method" title="#ts_type (instance method)">#<strong>ts_type</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> </ul> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> #<strong>initialize</strong>(name, type) ⇒ <tt><span class='object_link'><a href="" title="Ruact::Generators::ScaffoldGenerator::ScaffoldAttribute (class)">ScaffoldAttribute</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of ScaffoldAttribute.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 15 16 17 18</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 15</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span> <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='ivar'>@type</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id=""></span> <div class="method_details first"> <h3 class="signature first" id="name-instance_method"> #<strong>name</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute name.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 13 14 15</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 13</span> <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span> <span class='ivar'>@name</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="type-instance_method"> #<strong>type</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute type.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 13 14 15</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 13</span> <span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span> <span class='ivar'>@type</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="boolean?-instance_method"> #<strong>boolean?</strong> ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 33 34 35</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 33</span> <span class='kw'>def</span> <span class='id identifier rubyid_boolean?'>boolean?</span> <span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>boolean</span><span class='tstring_end'>"</span></span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="column_kind-instance_method"> #<strong>column_kind</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>The DataTable cell renderer kind (Story 10.2 AC1):</p> <pre class="code ruby"><code class="ruby">:badge → boolean → Badge "Yes"/"No" :numeric → integer/float/decimal/references → right-aligned numeric :date → date/datetime → locale-formatted :text → string/text → plain text</code></pre> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 47 48 49 50 51 52 53 54</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 47</span> <span class='kw'>def</span> <span class='id identifier rubyid_column_kind'>column_kind</span> <span class='kw'>case</span> <span class='id identifier rubyid_type'>type</span> <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>boolean</span><span class='tstring_end'>"</span></span> <span class='kw'>then</span> <span class='symbol'>:badge</span> <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>integer</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>float</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>decimal</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>references</span><span class='tstring_end'>"</span></span> <span class='kw'>then</span> <span class='symbol'>:numeric</span> <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>date</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>datetime</span><span class='tstring_end'>"</span></span> <span class='kw'>then</span> <span class='symbol'>:date</span> <span class='kw'>else</span> <span class='symbol'>:text</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="column_name-instance_method"> #<strong>column_name</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>The wire/DB column the controller params + serialized rows use.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 21 22 23</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 21</span> <span class='kw'>def</span> <span class='id identifier rubyid_column_name'>column_name</span> <span class='id identifier rubyid_reference?'>reference?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>_id</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="control-instance_method"> #<strong>control</strong> ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 29 30 31</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 29</span> <span class='kw'>def</span> <span class='id identifier rubyid_control'>control</span> <span class='const'><span class='object_link'><a href="../ScaffoldGenerator.html#TYPE_MAP-constant" title="Ruact::Generators::ScaffoldGenerator::TYPE_MAP (constant)">TYPE_MAP</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='symbol'>:control</span><span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="date?-instance_method"> #<strong>date?</strong> ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> <p>date/datetime — the List sorts these columns by epoch time (Story 10.2b).</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 38 39 40</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 38</span> <span class='kw'>def</span> <span class='id identifier rubyid_date?'>date?</span> <span class='id identifier rubyid_column_kind'>column_kind</span> <span class='op'>==</span> <span class='symbol'>:date</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="js_setter-instance_method"> #<strong>js_setter</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>The React <code>useState</code> setter name (<code>authorId</code> → <code>setAuthorId</code>).</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 108 109 110</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 108</span> <span class='kw'>def</span> <span class='id identifier rubyid_js_setter'>js_setter</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>set</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_js_var'>js_var</span><span class='period'>.</span><span class='id identifier rubyid_sub'>sub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\A.</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='op'>&</span><span class='symbol'>:upcase</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="js_var-instance_method"> #<strong>js_var</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>camelCase JS identifier for the column (<code>author_id</code> → <code>authorId</code>).</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 102 103 104 105</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 102</span> <span class='kw'>def</span> <span class='id identifier rubyid_js_var'>js_var</span> <span class='id identifier rubyid_parts'>parts</span> <span class='op'>=</span> <span class='id identifier rubyid_column_name'>column_name</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>_</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='lparen'>(</span><span class='id identifier rubyid_parts'>parts</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='id identifier rubyid_parts'>parts</span><span class='period'>.</span><span class='id identifier rubyid_drop'>drop</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:capitalize</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="options_ivar-instance_method"> #<strong>options_ivar</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>references only — the controller ivar / view local holding the capped parent options (<code>author</code> → <code>author_options</code>).</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 86 87 88</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 86</span> <span class='kw'>def</span> <span class='id identifier rubyid_options_ivar'>options_ivar</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>_options</span><span class='tstring_end'>"</span></span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="options_prop-instance_method"> #<strong>options_prop</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>references only — the camelCase prop the view passes and the Form reads (<code>author</code> → <code>authorOptions</code>, <code>blog_post</code> → <code>blogPostOptions</code>).</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 92 93 94 95</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 92</span> <span class='kw'>def</span> <span class='id identifier rubyid_options_prop'>options_prop</span> <span class='id identifier rubyid_parts'>parts</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>_</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='lparen'>(</span><span class='id identifier rubyid_parts'>parts</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='id identifier rubyid_parts'>parts</span><span class='period'>.</span><span class='id identifier rubyid_drop'>drop</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:capitalize</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='embexpr_end'>}</span><span class='tstring_content'>Options</span><span class='tstring_end'>"</span></span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="reference?-instance_method"> #<strong>reference?</strong> ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 97 98 99</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 97</span> <span class='kw'>def</span> <span class='id identifier rubyid_reference?'>reference?</span> <span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>references</span><span class='tstring_end'>"</span></span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="reference_class_name-instance_method"> #<strong>reference_class_name</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>references only — the parent model constant (<code>author</code> → <code>Author</code>, <code>blog_post</code> → <code>BlogPost</code>), used by the controller's options loader.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 80 81 82</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 80</span> <span class='kw'>def</span> <span class='id identifier rubyid_reference_class_name'>reference_class_name</span> <span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_camelize'>camelize</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="shadcn_control-instance_method"> #<strong>shadcn_control</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>The shadcn Form control this attribute renders as (Story 10.3 AC1):</p> <pre class="code ruby"><code class="ruby">:input → string → <Input type="text"> :textarea → text → <Textarea> :switch → boolean → <Switch> :number → integer/float/decimal → <Input type="number"> :date → date → <Input type="date"> :datetime → datetime → <Input type="datetime-local"> :select → references → <Select> of parent options </code></pre> <p>The :input/:number/:date/:datetime kinds all render an <Input>; the concrete <code>type=</code> attribute comes from <code>html_input_type</code> (FormHelpers).</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 66 67 68 69 70 71 72 73 74 75 76</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 66</span> <span class='kw'>def</span> <span class='id identifier rubyid_shadcn_control'>shadcn_control</span> <span class='kw'>case</span> <span class='id identifier rubyid_type'>type</span> <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>text</span><span class='tstring_end'>"</span></span> <span class='kw'>then</span> <span class='symbol'>:textarea</span> <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>boolean</span><span class='tstring_end'>"</span></span> <span class='kw'>then</span> <span class='symbol'>:switch</span> <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>integer</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>float</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>decimal</span><span class='tstring_end'>"</span></span> <span class='kw'>then</span> <span class='symbol'>:number</span> <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>date</span><span class='tstring_end'>"</span></span> <span class='kw'>then</span> <span class='symbol'>:date</span> <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>datetime</span><span class='tstring_end'>"</span></span> <span class='kw'>then</span> <span class='symbol'>:datetime</span> <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>references</span><span class='tstring_end'>"</span></span> <span class='kw'>then</span> <span class='symbol'>:select</span> <span class='kw'>else</span> <span class='symbol'>:input</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="ts_type-instance_method"> #<strong>ts_type</strong> ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 25 26 27</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/generators/ruact/scaffold/scaffold_attribute.rb', line 25</span> <span class='kw'>def</span> <span class='id identifier rubyid_ts_type'>ts_type</span> <span class='const'><span class='object_link'><a href="../ScaffoldGenerator.html#TYPE_MAP-constant" title="Ruact::Generators::ScaffoldGenerator::TYPE_MAP (constant)">TYPE_MAP</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='symbol'>:ts</span><span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Tue Jun 30 22:40:30 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.44 (ruby-4.0.2). </div> </div> </body> </html>