compony 0.2.1 → 0.2.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (85) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/Gemfile.lock +3 -3
  4. data/README.md +1397 -33
  5. data/Rakefile +6 -2
  6. data/TODO.md +1 -0
  7. data/VERSION +1 -0
  8. data/compony.gemspec +7 -7
  9. data/doc/ComponentGenerator.html +231 -0
  10. data/doc/Components.html +105 -0
  11. data/doc/ComponentsGenerator.html +203 -0
  12. data/doc/Compony/Component.html +2098 -0
  13. data/doc/Compony/ComponentMixins/Default/Labelling.html +406 -0
  14. data/doc/Compony/ComponentMixins/Default/Standalone/ResourcefulVerbDsl.html +539 -0
  15. data/doc/Compony/ComponentMixins/Default/Standalone/StandaloneDsl.html +588 -0
  16. data/doc/Compony/ComponentMixins/Default/Standalone/VerbDsl.html +577 -0
  17. data/doc/Compony/ComponentMixins/Default/Standalone.html +692 -0
  18. data/doc/Compony/ComponentMixins/Default.html +126 -0
  19. data/doc/Compony/ComponentMixins/Resourceful.html +1193 -0
  20. data/doc/Compony/ComponentMixins.html +126 -0
  21. data/doc/Compony/Components/Button.html +293 -0
  22. data/doc/Compony/Components/Destroy.html +384 -0
  23. data/doc/Compony/Components/Edit.html +462 -0
  24. data/doc/Compony/Components/Form.html +1112 -0
  25. data/doc/Compony/Components/New.html +462 -0
  26. data/doc/Compony/Components/WithForm.html +528 -0
  27. data/doc/Compony/Components.html +126 -0
  28. data/doc/Compony/ControllerMixin.html +136 -0
  29. data/doc/Compony/Engine.html +133 -0
  30. data/doc/Compony/MethodAccessibleHash.html +453 -0
  31. data/doc/Compony/ModelFields/Anchormodel.html +383 -0
  32. data/doc/Compony/ModelFields/Association.html +613 -0
  33. data/doc/Compony/ModelFields/Attachment.html +305 -0
  34. data/doc/Compony/ModelFields/Base.html +1066 -0
  35. data/doc/Compony/ModelFields/Boolean.html +232 -0
  36. data/doc/Compony/ModelFields/Color.html +299 -0
  37. data/doc/Compony/ModelFields/Currency.html +232 -0
  38. data/doc/Compony/ModelFields/Date.html +232 -0
  39. data/doc/Compony/ModelFields/Datetime.html +232 -0
  40. data/doc/Compony/ModelFields/Decimal.html +154 -0
  41. data/doc/Compony/ModelFields/Email.html +240 -0
  42. data/doc/Compony/ModelFields/Float.html +154 -0
  43. data/doc/Compony/ModelFields/Integer.html +154 -0
  44. data/doc/Compony/ModelFields/Percentage.html +232 -0
  45. data/doc/Compony/ModelFields/Phone.html +301 -0
  46. data/doc/Compony/ModelFields/RichText.html +232 -0
  47. data/doc/Compony/ModelFields/String.html +154 -0
  48. data/doc/Compony/ModelFields/Text.html +154 -0
  49. data/doc/Compony/ModelFields/Time.html +154 -0
  50. data/doc/Compony/ModelFields/Url.html +240 -0
  51. data/doc/Compony/ModelFields.html +126 -0
  52. data/doc/Compony/ModelMixin.html +524 -0
  53. data/doc/Compony/RequestContext.html +791 -0
  54. data/doc/Compony/Version.html +139 -0
  55. data/doc/Compony/ViewHelpers.html +443 -0
  56. data/doc/Compony.html +2156 -0
  57. data/doc/ComponyController.html +124 -0
  58. data/doc/_index.html +569 -0
  59. data/doc/class_list.html +51 -0
  60. data/doc/css/common.css +1 -0
  61. data/doc/css/full_list.css +58 -0
  62. data/doc/css/style.css +497 -0
  63. data/doc/file.README.html +1565 -0
  64. data/doc/file_list.html +56 -0
  65. data/doc/frames.html +17 -0
  66. data/doc/imgs/intro-example-destroy.png +0 -0
  67. data/doc/imgs/intro-example-edit.png +0 -0
  68. data/doc/imgs/intro-example-index.png +0 -0
  69. data/doc/imgs/intro-example-new.png +0 -0
  70. data/doc/imgs/intro-example-show.png +0 -0
  71. data/doc/index.html +1565 -0
  72. data/doc/js/app.js +314 -0
  73. data/doc/js/full_list.js +216 -0
  74. data/doc/js/jquery.js +4 -0
  75. data/doc/method_list.html +1435 -0
  76. data/doc/resourceful_lifecycle.png +0 -0
  77. data/doc/top-level-namespace.html +112 -0
  78. data/lib/compony/component.rb +2 -1
  79. data/lib/compony/component_mixins/default/standalone.rb +4 -0
  80. data/lib/compony/components/with_form.rb +1 -0
  81. data/lib/compony/model_fields/anchormodel.rb +0 -22
  82. data/lib/compony/model_mixin.rb +12 -2
  83. data/lib/compony/version.rb +1 -7
  84. data/logo.svg +133 -0
  85. metadata +82 -6
@@ -0,0 +1,305 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Compony::ModelFields::Attachment
8
+
9
+ &mdash; Documentation by YARD 0.9.34
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Compony::ModelFields::Attachment";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (A)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../Compony.html" title="Compony (module)">Compony</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../ModelFields.html" title="Compony::ModelFields (module)">ModelFields</a></span></span>
41
+ &raquo;
42
+ <span class="title">Attachment</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Compony::ModelFields::Attachment
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="Base.html" title="Compony::ModelFields::Base (class)">Base</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="Base.html" title="Compony::ModelFields::Base (class)">Base</a></span></li>
78
+
79
+ <li class="next">Compony::ModelFields::Attachment</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/compony/model_fields/attachment.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>Model field type representing an ActiveStorage attachment.</p>
108
+
109
+
110
+ </div>
111
+ </div>
112
+ <div class="tags">
113
+
114
+
115
+ </div>
116
+
117
+
118
+
119
+
120
+
121
+ <h2>Instance Attribute Summary</h2>
122
+
123
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Base.html" title="Compony::ModelFields::Base (class)">Base</a></span></h3>
124
+ <p class="inherited"><span class='object_link'><a href="Base.html#extra_attrs-instance_method" title="Compony::ModelFields::Base#extra_attrs (method)">#extra_attrs</a></span>, <span class='object_link'><a href="Base.html#model_class-instance_method" title="Compony::ModelFields::Base#model_class (method)">#model_class</a></span>, <span class='object_link'><a href="Base.html#name-instance_method" title="Compony::ModelFields::Base#name (method)">#name</a></span>, <span class='object_link'><a href="Base.html#schema_key-instance_method" title="Compony::ModelFields::Base#schema_key (method)">#schema_key</a></span></p>
125
+
126
+
127
+
128
+ <h2>
129
+ Instance Method Summary
130
+ <small><a href="#" class="summary_toggle">collapse</a></small>
131
+ </h2>
132
+
133
+ <ul class="summary">
134
+
135
+ <li class="public ">
136
+ <span class="summary_signature">
137
+
138
+ <a href="#simpleform_input-instance_method" title="#simpleform_input (instance method)">#<strong>simpleform_input</strong>(form, _component, name: nil, accept: nil, **input_opts) &#x21d2; Object </a>
139
+
140
+
141
+
142
+ </span>
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+ <span class="summary_desc"><div class='inline'></div></span>
153
+
154
+ </li>
155
+
156
+
157
+ <li class="public ">
158
+ <span class="summary_signature">
159
+
160
+ <a href="#value_for-instance_method" title="#value_for (instance method)">#<strong>value_for</strong>(data, controller: nil, **_) &#x21d2; Object </a>
161
+
162
+
163
+
164
+ </span>
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+ <span class="summary_desc"><div class='inline'></div></span>
175
+
176
+ </li>
177
+
178
+
179
+ </ul>
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="Compony::ModelFields::Base (class)">Base</a></span></h3>
192
+ <p class="inherited"><span class='object_link'><a href="Base.html#association%3F-instance_method" title="Compony::ModelFields::Base#association? (method)">#association?</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="Compony::ModelFields::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#label-instance_method" title="Compony::ModelFields::Base#label (method)">#label</a></span>, <span class='object_link'><a href="Base.html#multi%3F-instance_method" title="Compony::ModelFields::Base#multi? (method)">#multi?</a></span>, <span class='object_link'><a href="Base.html#schema_line-instance_method" title="Compony::ModelFields::Base#schema_line (method)">#schema_line</a></span>, <span class='object_link'><a href="Base.html#simpleform_input_hidden-instance_method" title="Compony::ModelFields::Base#simpleform_input_hidden (method)">#simpleform_input_hidden</a></span>, <span class='object_link'><a href="Base.html#transform_and_join-instance_method" title="Compony::ModelFields::Base#transform_and_join (method)">#transform_and_join</a></span></p>
193
+ <div id="constructor_details" class="method_details_list">
194
+ <h2>Constructor Details</h2>
195
+
196
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="Compony::ModelFields::Base#initialize (method)">Compony::ModelFields::Base</a></span></p>
197
+
198
+ </div>
199
+
200
+
201
+ <div id="instance_method_details" class="method_details_list">
202
+ <h2>Instance Method Details</h2>
203
+
204
+
205
+ <div class="method_details first">
206
+ <h3 class="signature first" id="simpleform_input-instance_method">
207
+
208
+ #<strong>simpleform_input</strong>(form, _component, name: nil, accept: nil, **input_opts) &#x21d2; <tt>Object</tt>
209
+
210
+
211
+
212
+
213
+
214
+ </h3><div class="docstring">
215
+ <div class="discussion">
216
+
217
+
218
+ </div>
219
+ </div>
220
+ <div class="tags">
221
+
222
+
223
+ </div><table class="source_code">
224
+ <tr>
225
+ <td>
226
+ <pre class="lines">
227
+
228
+
229
+ 14
230
+ 15
231
+ 16
232
+ 17</pre>
233
+ </td>
234
+ <td>
235
+ <pre class="code"><span class="info file"># File 'lib/compony/model_fields/attachment.rb', line 14</span>
236
+
237
+ <span class='kw'>def</span> <span class='id identifier rubyid_simpleform_input'>simpleform_input</span><span class='lparen'>(</span><span class='id identifier rubyid_form'>form</span><span class='comma'>,</span> <span class='id identifier rubyid__component'>_component</span><span class='comma'>,</span> <span class='label'>name:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>accept:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_input_opts'>input_opts</span><span class='rparen'>)</span>
238
+ <span class='id identifier rubyid_input_opts'>input_opts</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='label'>input_html:</span> <span class='lbrace'>{</span> <span class='label'>accept:</span> <span class='rbrace'>}</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_accept'>accept</span>
239
+ <span class='kw'>return</span> <span class='id identifier rubyid_form'>form</span><span class='period'>.</span><span class='id identifier rubyid_input'>input</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span> <span class='op'>||</span> <span class='ivar'>@name</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_input_opts'>input_opts</span><span class='rparen'>)</span>
240
+ <span class='kw'>end</span></pre>
241
+ </td>
242
+ </tr>
243
+ </table>
244
+ </div>
245
+
246
+ <div class="method_details ">
247
+ <h3 class="signature " id="value_for-instance_method">
248
+
249
+ #<strong>value_for</strong>(data, controller: nil, **_) &#x21d2; <tt>Object</tt>
250
+
251
+
252
+
253
+
254
+
255
+ </h3><div class="docstring">
256
+ <div class="discussion">
257
+
258
+
259
+ </div>
260
+ </div>
261
+ <div class="tags">
262
+
263
+
264
+ </div><table class="source_code">
265
+ <tr>
266
+ <td>
267
+ <pre class="lines">
268
+
269
+
270
+ 6
271
+ 7
272
+ 8
273
+ 9
274
+ 10
275
+ 11
276
+ 12</pre>
277
+ </td>
278
+ <td>
279
+ <pre class="code"><span class="info file"># File 'lib/compony/model_fields/attachment.rb', line 6</span>
280
+
281
+ <span class='kw'>def</span> <span class='id identifier rubyid_value_for'>value_for</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>controller:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid__'>_</span><span class='rparen'>)</span>
282
+ <span class='kw'>return</span> <span class='id identifier rubyid_transform_and_join'>transform_and_join</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='ivar'>@name</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>controller:</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_el'>el</span><span class='op'>|</span>
283
+ <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'>Must pass controller to generate the link to the attachment.</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_controller'>controller</span>
284
+ <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>unless</span> <span class='id identifier rubyid_el'>el</span><span class='period'>.</span><span class='id identifier rubyid_attached?'>attached?</span>
285
+ <span class='kw'>return</span> <span class='id identifier rubyid_controller'>controller</span><span class='period'>.</span><span class='id identifier rubyid_helpers'>helpers</span><span class='period'>.</span><span class='id identifier rubyid_link_to'>link_to</span><span class='lparen'>(</span><span class='const'>I18n</span><span class='period'>.</span><span class='id identifier rubyid_t'>t</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>compony.model_fields.attachment.download</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_controller'>controller</span><span class='period'>.</span><span class='id identifier rubyid_helpers'>helpers</span><span class='period'>.</span><span class='id identifier rubyid_rails_blob_path'>rails_blob_path</span><span class='lparen'>(</span><span class='id identifier rubyid_el'>el</span><span class='rparen'>)</span><span class='rparen'>)</span>
286
+ <span class='kw'>end</span>
287
+ <span class='kw'>end</span></pre>
288
+ </td>
289
+ </tr>
290
+ </table>
291
+ </div>
292
+
293
+ </div>
294
+
295
+ </div>
296
+
297
+ <div id="footer">
298
+ Generated on Wed Apr 24 17:14:06 2024 by
299
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
300
+ 0.9.34 (ruby-3.2.2).
301
+ </div>
302
+
303
+ </div>
304
+ </body>
305
+ </html>