compony 0.11.12 → 0.11.14

data/doc/Compony.html

@@ -345,6 +345,54 @@
 <p>Getter for content_before_root_comp_block.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#content_locales-class_method" title="content_locales (class method)">.<strong>content_locales</strong>  &#x21d2; Array&lt;Symbol&gt; </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Getter for the content locales, defaults to <code>I18n.available_locales</code>.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#content_locales=-class_method" title="content_locales= (class method)">.<strong>content_locales=</strong>(content_locales)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Setter for the content locales, i.e.</p>
+</div></span>
+  
 </li>
 
       
@@ -630,12 +678,12 @@
       <pre class="lines">
 
 
-104
-105
-106</pre>
+123
+124
+125</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 104</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 123</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_authentication_before_action'>authentication_before_action</span>
   <span class='ivar'>@authentication_before_action</span>
@@ -691,12 +739,12 @@
       <pre class="lines">
 
 
-47
-48
-49</pre>
+58
+59
+60</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 47</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 58</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_authentication_before_action='>authentication_before_action=</span><span class='lparen'>(</span><span class='id identifier rubyid_authentication_before_action'>authentication_before_action</span><span class='rparen'>)</span>
   <span class='ivar'>@authentication_before_action</span> <span class='op'>=</span> <span class='id identifier rubyid_authentication_before_action'>authentication_before_action</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
@@ -763,25 +811,25 @@
       <pre class="lines">
 
 
-73
-74
-75
-76
-77
-78
-79
-80
-81
-82
-83
 84
 85
 86
 87
-88</pre>
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+99</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 73</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 84</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_button_component_class'>button_component_class</span><span class='lparen'>(</span><span class='id identifier rubyid_style'>style</span> <span class='op'>=</span> <span class='id identifier rubyid_default_button_style'>default_button_style</span><span class='rparen'>)</span>
   <span class='comment'># Lazy initialize
@@ -837,14 +885,14 @@
       <pre class="lines">
 
 
-139
-140
-141
-142
-143</pre>
+158
+159
+160
+161
+162</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 139</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 158</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_comp_class_for'>comp_class_for</span><span class='lparen'>(</span><span class='op'>...</span><span class='rparen'>)</span>
   <span class='kw'>return</span> <span class='id identifier rubyid_intent'>intent</span><span class='lparen'>(</span><span class='op'>...</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_comp_class'>comp_class</span>
@@ -891,14 +939,14 @@
       <pre class="lines">
 
 
-148
-149
-150
-151
-152</pre>
+167
+168
+169
+170
+171</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 148</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 167</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_comp_class_for!'>comp_class_for!</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_comp_class_for'>comp_class_for</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_fail'>fail</span><span class='lparen'>(</span>
@@ -936,13 +984,13 @@
       <pre class="lines">
 
 
-60
-61
-62
-63</pre>
+71
+72
+73
+74</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 60</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 71</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_content_after_root_comp'>content_after_root_comp</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_fail'>fail</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>`Compony.content_after` requires a block.</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
@@ -986,12 +1034,12 @@
       <pre class="lines">
 
 
-116
-117
-118</pre>
+135
+136
+137</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 116</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 135</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_content_after_root_comp_block'>content_after_root_comp_block</span>
   <span class='ivar'>@content_after_root_comp_block</span>
@@ -1027,13 +1075,13 @@
       <pre class="lines">
 
 
-53
-54
-55
-56</pre>
+64
+65
+66
+67</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 53</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 64</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_content_before_root_comp'>content_before_root_comp</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_fail'>fail</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>`Compony.content_before` requires a block.</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
@@ -1077,12 +1125,12 @@
       <pre class="lines">
 
 
-110
-111
-112</pre>
+129
+130
+131</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 110</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 129</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_content_before_root_comp_block'>content_before_root_comp_block</span>
   <span class='ivar'>@content_before_root_comp_block</span>
@@ -1090,6 +1138,142 @@
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="content_locales-class_method">
+  
+    .<strong>content_locales</strong>  &#x21d2; <tt>Array&lt;Symbol&gt;</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Getter for the content locales, defaults to <code>I18n.available_locales</code>.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array&lt;Symbol&gt;</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The locales for which <code>multilang: true</code> fields generate a suffixed field.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="#content_locales=-class_method" title="Compony.content_locales= (method)">Explanation of content_locales (documented in the corresponding setter)</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+116
+117
+118
+119</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 116</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_content_locales'>content_locales</span>
+  <span class='id identifier rubyid_content_locales'>content_locales</span> <span class='op'>=</span> <span class='ivar'>@content_locales</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:call</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='ivar'>@content_locales</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span> <span class='op'>:</span> <span class='ivar'>@content_locales</span>
+  <span class='kw'>return</span> <span class='lparen'>(</span><span class='id identifier rubyid_content_locales'>content_locales</span> <span class='op'>||</span> <span class='const'>I18n</span><span class='period'>.</span><span class='id identifier rubyid_available_locales'>available_locales</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:to_sym</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="content_locales=-class_method">
+  
+    .<strong>content_locales=</strong>(content_locales)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Setter for the content locales, i.e. the languages in which <code>multilang: true</code> fields exist (useful with gem “mobility”). Set this when your app’s <code>I18n.available_locales</code> differ from the languages your content is stored in, e.g. when using regional locales such as <code>:&quot;de-CH&quot;</code> while content is stored per language (<code>label_de</code>, <code>label_en</code>, …). Model fields are generated when the model class loads, so set this in an initializer, before any model is loaded. Alternatively, pass a callable, which is evaluated every time the content locales are needed.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>content_locales</span>
+      
+      
+        <span class='type'>(<tt>Array&lt;Symbol,String&gt;</tt>, <tt>#call</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The content locales, or a callable returning them. Defaults to <code>I18n.available_locales</code>.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li>{Compony{Compony#content_locales}</li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+45
+46
+47</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 45</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_content_locales='>content_locales=</span><span class='lparen'>(</span><span class='id identifier rubyid_content_locales'>content_locales</span><span class='rparen'>)</span>
+  <span class='ivar'>@content_locales</span> <span class='op'>=</span> <span class='id identifier rubyid_content_locales'>content_locales</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -1125,12 +1309,12 @@
       <pre class="lines">
 
 
-92
-93
-94</pre>
+103
+104
+105</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 92</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 103</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default_button_style'>default_button_style</span>
   <span class='kw'>return</span> <span class='ivar'>@default_button_style</span> <span class='op'>||</span> <span class='symbol'>:css_button</span>
@@ -1254,16 +1438,16 @@
       <pre class="lines">
 
 
-163
-164
-165
-166
-167
-168
-169</pre>
+182
+183
+184
+185
+186
+187
+188</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 163</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 182</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_family_name_for'>family_name_for</span><span class='lparen'>(</span><span class='id identifier rubyid_model_or_family_name_or_cst'>model_or_family_name_or_cst</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='id identifier rubyid_model_or_family_name_or_cst'>model_or_family_name_or_cst</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:model_name</span><span class='rparen'>)</span>
@@ -1303,14 +1487,14 @@
       <pre class="lines">
 
 
-125
-126
-127
-128
-129</pre>
+144
+145
+146
+147
+148</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 125</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 144</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_intent'>intent</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>**</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_first'>first</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
@@ -1368,18 +1552,18 @@
       <pre class="lines">
 
 
-173
-174
-175
-176
-177
-178
-179
-180
-181</pre>
+192
+193
+194
+195
+196
+197
+198
+199
+200</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 173</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 192</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_model_field_class_for'>model_field_class_for</span><span class='lparen'>(</span><span class='id identifier rubyid_constant'>constant</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_model_field_namespaces'>model_field_namespaces</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_model_field_namespace'>model_field_namespace</span><span class='op'>|</span>
@@ -1428,12 +1612,12 @@
       <pre class="lines">
 
 
-98
-99
-100</pre>
+109
+110
+111</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 98</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 109</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_model_field_namespaces'>model_field_namespaces</span>
   <span class='kw'>return</span> <span class='ivar'>@model_field_namespaces</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Compony::ModelFields</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
@@ -1530,12 +1714,12 @@
       <pre class="lines">
 
 
-133
-134
-135</pre>
+152
+153
+154</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 133</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 152</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span><span class='lparen'>(</span><span class='id identifier rubyid_comp_name_or_cst_or_class'>comp_name_or_cst_or_class</span><span class='comma'>,</span> <span class='id identifier rubyid_model_or_family_name_or_cst'>model_or_family_name_or_cst</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>*</span><span class='comma'>,</span> <span class='op'>**</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_intent'>intent</span><span class='lparen'>(</span><span class='id identifier rubyid_comp_name_or_cst_or_class'>comp_name_or_cst_or_class</span><span class='comma'>,</span> <span class='id identifier rubyid_model_or_family_name_or_cst'>model_or_family_name_or_cst</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span><span class='lparen'>(</span><span class='op'>*</span><span class='comma'>,</span> <span class='op'>**</span><span class='rparen'>)</span>
@@ -1650,12 +1834,12 @@
       <pre class="lines">
 
 
-155
-156
-157</pre>
+174
+175
+176</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 155</span>
+      <pre class="code"><span class="info file"># File 'lib/compony.rb', line 174</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_root_comp'>root_comp</span>
   <span class='const'>RequestStore</span><span class='period'>.</span><span class='id identifier rubyid_store'>store</span><span class='lbracket'>[</span><span class='symbol'>:compony_root_comp</span><span class='rbracket'>]</span>
@@ -1670,7 +1854,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jun 30 22:41:20 2026 by
+  Generated on Wed Oct  7 10:48:20 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/ComponyController.html

@@ -114,7 +114,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jun 30 22:41:21 2026 by
+  Generated on Wed Oct  7 10:48:21 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/_index.html

@@ -718,7 +718,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jun 30 22:41:17 2026 by
+  Generated on Wed Oct  7 10:48:16 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>