anchormodel 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +2 -0
- data/.ruby-version +1 -0
- data/.yardopts +1 -0
- data/LICENSE +165 -0
- data/README.md +96 -0
- data/Rakefile +27 -0
- data/anchormodel.gemspec +33 -0
- data/doc/Anchormodel/ActiveModelTypeValue.html +513 -0
- data/doc/Anchormodel/Attribute.html +502 -0
- data/doc/Anchormodel/ModelMixin.html +307 -0
- data/doc/Anchormodel/Version.html +195 -0
- data/doc/Anchormodel.html +846 -0
- data/doc/_index.html +151 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +497 -0
- data/doc/file.README.html +167 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +167 -0
- data/doc/js/app.js +314 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +203 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/anchormodel/active_model_type_value.rb +37 -0
- data/lib/anchormodel/attribute.rb +24 -0
- data/lib/anchormodel/model_mixin.rb +46 -0
- data/lib/anchormodel/version.rb +11 -0
- data/lib/anchormodel.rb +65 -0
- metadata +114 -0
|
@@ -0,0 +1,846 @@
|
|
|
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: Anchormodel
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.28
|
|
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 = "Anchormodel";
|
|
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> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">Anchormodel</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: Anchormodel
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">Anchormodel</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/anchormodel.rb<span class="defines">,<br />
|
|
98
|
+
lib/anchormodel/version.rb</span>
|
|
99
|
+
</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
<p>Inherit from this class and place your Anchormodel under <code>app/anchormodels/your_anchor_model.rb</code>. Use it like <code>Anchormodels::YourAnchorModel</code>.
|
|
107
|
+
Refer to the README for usage.</p>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
</div>
|
|
112
|
+
<div class="tags">
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div><h2>Defined Under Namespace</h2>
|
|
116
|
+
<p class="children">
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Anchormodel/ModelMixin.html" title="Anchormodel::ModelMixin (module)">ModelMixin</a></span>, <span class='object_link'><a href="Anchormodel/Version.html" title="Anchormodel::Version (module)">Version</a></span>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Anchormodel/ActiveModelTypeValue.html" title="Anchormodel::ActiveModelTypeValue (class)">ActiveModelTypeValue</a></span>, <span class='object_link'><a href="Anchormodel/Attribute.html" title="Anchormodel::Attribute (class)">Attribute</a></span>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
</p>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
132
|
+
<ul class="summary">
|
|
133
|
+
|
|
134
|
+
<li class="public ">
|
|
135
|
+
<span class="summary_signature">
|
|
136
|
+
|
|
137
|
+
<a href="#index-instance_method" title="#index (instance method)">#<strong>index</strong> ⇒ Object </a>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
</span>
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<span class="note title readonly">readonly</span>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
157
|
+
|
|
158
|
+
</li>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<li class="public ">
|
|
162
|
+
<span class="summary_signature">
|
|
163
|
+
|
|
164
|
+
<a href="#key-instance_method" title="#key (instance method)">#<strong>key</strong> ⇒ Object </a>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
</span>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<span class="note title readonly">readonly</span>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
184
|
+
|
|
185
|
+
</li>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
</ul>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<h2>
|
|
195
|
+
Class Method Summary
|
|
196
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
197
|
+
</h2>
|
|
198
|
+
|
|
199
|
+
<ul class="summary">
|
|
200
|
+
|
|
201
|
+
<li class="public ">
|
|
202
|
+
<span class="summary_signature">
|
|
203
|
+
|
|
204
|
+
<a href="#all-class_method" title="all (class method)">.<strong>all</strong> ⇒ Object </a>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
</span>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
<span class="summary_desc"><div class='inline'><p>Returns all possible values this Anchormodel can take.</p>
|
|
219
|
+
</div></span>
|
|
220
|
+
|
|
221
|
+
</li>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<li class="public ">
|
|
225
|
+
<span class="summary_signature">
|
|
226
|
+
|
|
227
|
+
<a href="#find-class_method" title="find (class method)">.<strong>find</strong>(key) ⇒ Object </a>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
</span>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
<span class="summary_desc"><div class='inline'><p>Retrieves a particular value given the key.</p>
|
|
242
|
+
</div></span>
|
|
243
|
+
|
|
244
|
+
</li>
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
</ul>
|
|
248
|
+
|
|
249
|
+
<h2>
|
|
250
|
+
Instance Method Summary
|
|
251
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
252
|
+
</h2>
|
|
253
|
+
|
|
254
|
+
<ul class="summary">
|
|
255
|
+
|
|
256
|
+
<li class="public ">
|
|
257
|
+
<span class="summary_signature">
|
|
258
|
+
|
|
259
|
+
<a href="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(other) ⇒ Object </a>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
</span>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
274
|
+
|
|
275
|
+
</li>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
<li class="public ">
|
|
279
|
+
<span class="summary_signature">
|
|
280
|
+
|
|
281
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(key, **attributes) ⇒ Anchormodel </a>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
</span>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
<span class="note title constructor">constructor</span>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
<span class="summary_desc"><div class='inline'><p>Call this initializer directly in your Anchormodel class.</p>
|
|
298
|
+
</div></span>
|
|
299
|
+
|
|
300
|
+
</li>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<li class="public ">
|
|
304
|
+
<span class="summary_signature">
|
|
305
|
+
|
|
306
|
+
<a href="#inspect-instance_method" title="#inspect (instance method)">#<strong>inspect</strong> ⇒ Object </a>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</span>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
321
|
+
|
|
322
|
+
</li>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
<li class="public ">
|
|
326
|
+
<span class="summary_signature">
|
|
327
|
+
|
|
328
|
+
<a href="#label-instance_method" title="#label (instance method)">#<strong>label</strong> ⇒ Object </a>
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
</span>
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<span class="summary_desc"><div class='inline'><p>Returns a Rails label that is compatible with the <a href="https://github.com/grosser/gettext_i18n_rails/">Rails FastGettext</a> gem.</p>
|
|
343
|
+
</div></span>
|
|
344
|
+
|
|
345
|
+
</li>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
<li class="public ">
|
|
349
|
+
<span class="summary_signature">
|
|
350
|
+
|
|
351
|
+
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> ⇒ Object </a>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
</span>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
366
|
+
|
|
367
|
+
</li>
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
</ul>
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
<div id="constructor_details" class="method_details_list">
|
|
374
|
+
<h2>Constructor Details</h2>
|
|
375
|
+
|
|
376
|
+
<div class="method_details first">
|
|
377
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
378
|
+
|
|
379
|
+
#<strong>initialize</strong>(key, **attributes) ⇒ <tt><span class='object_link'><a href="" title="Anchormodel (class)">Anchormodel</a></span></tt>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
</h3><div class="docstring">
|
|
386
|
+
<div class="discussion">
|
|
387
|
+
<p>Call this initializer directly in your Anchormodel class. To set <code>@foo=:bar</code> for anchor <code>:ter</code>, use <code>new(:ter, foo: :bar)</code></p>
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
</div>
|
|
391
|
+
</div>
|
|
392
|
+
<div class="tags">
|
|
393
|
+
<p class="tag_title">Parameters:</p>
|
|
394
|
+
<ul class="param">
|
|
395
|
+
|
|
396
|
+
<li>
|
|
397
|
+
|
|
398
|
+
<span class='name'>key</span>
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
—
|
|
406
|
+
<div class='inline'><p>The key under which the entry should be stored.</p>
|
|
407
|
+
</div>
|
|
408
|
+
|
|
409
|
+
</li>
|
|
410
|
+
|
|
411
|
+
<li>
|
|
412
|
+
|
|
413
|
+
<span class='name'>attributes</span>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
<span class='type'></span>
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
—
|
|
421
|
+
<div class='inline'><p>All named arguments to Anchormodel are made available as instance attributes.</p>
|
|
422
|
+
</div>
|
|
423
|
+
|
|
424
|
+
</li>
|
|
425
|
+
|
|
426
|
+
</ul>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
</div><table class="source_code">
|
|
430
|
+
<tr>
|
|
431
|
+
<td>
|
|
432
|
+
<pre class="lines">
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
27
|
|
436
|
+
28
|
|
437
|
+
29
|
|
438
|
+
30
|
|
439
|
+
31
|
|
440
|
+
32
|
|
441
|
+
33
|
|
442
|
+
34
|
|
443
|
+
35
|
|
444
|
+
36
|
|
445
|
+
37
|
|
446
|
+
38
|
|
447
|
+
39
|
|
448
|
+
40
|
|
449
|
+
41
|
|
450
|
+
42</pre>
|
|
451
|
+
</td>
|
|
452
|
+
<td>
|
|
453
|
+
<pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 27</span>
|
|
454
|
+
|
|
455
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
|
|
456
|
+
<span class='ivar'>@key</span> <span class='op'>=</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
|
|
457
|
+
<span class='ivar'>@index</span> <span class='op'>=</span> <span class='id identifier rubyid_entries_list'>entries_list</span><span class='period'>.</span><span class='id identifier rubyid_count'>count</span>
|
|
458
|
+
|
|
459
|
+
<span class='comment'># Save attributes as instance variables
|
|
460
|
+
</span> <span class='id identifier rubyid_attributes'>attributes</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_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span>
|
|
461
|
+
<span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='symbol'>:"@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_k'>k</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='rparen'>)</span>
|
|
462
|
+
<span class='kw'>end</span>
|
|
463
|
+
|
|
464
|
+
<span class='comment'># Register self
|
|
465
|
+
</span> <span class='id identifier rubyid_entries_list'>entries_list</span> <span class='op'><<</span> <span class='kw'>self</span>
|
|
466
|
+
<span class='id identifier rubyid_entries_hash'>entries_hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>self</span>
|
|
467
|
+
|
|
468
|
+
<span class='comment'># Register valid keys
|
|
469
|
+
</span> <span class='id identifier rubyid_valid_keys'>valid_keys</span> <span class='op'><<</span> <span class='id identifier rubyid_key'>key</span>
|
|
470
|
+
<span class='kw'>end</span></pre>
|
|
471
|
+
</td>
|
|
472
|
+
</tr>
|
|
473
|
+
</table>
|
|
474
|
+
</div>
|
|
475
|
+
|
|
476
|
+
</div>
|
|
477
|
+
|
|
478
|
+
<div id="instance_attr_details" class="attr_details">
|
|
479
|
+
<h2>Instance Attribute Details</h2>
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
<span id=""></span>
|
|
483
|
+
<div class="method_details first">
|
|
484
|
+
<h3 class="signature first" id="index-instance_method">
|
|
485
|
+
|
|
486
|
+
#<strong>index</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
</h3><div class="docstring">
|
|
493
|
+
<div class="discussion">
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
</div>
|
|
497
|
+
</div>
|
|
498
|
+
<div class="tags">
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
</div><table class="source_code">
|
|
502
|
+
<tr>
|
|
503
|
+
<td>
|
|
504
|
+
<pre class="lines">
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
6
|
|
508
|
+
7
|
|
509
|
+
8</pre>
|
|
510
|
+
</td>
|
|
511
|
+
<td>
|
|
512
|
+
<pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 6</span>
|
|
513
|
+
|
|
514
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span>
|
|
515
|
+
<span class='ivar'>@index</span>
|
|
516
|
+
<span class='kw'>end</span></pre>
|
|
517
|
+
</td>
|
|
518
|
+
</tr>
|
|
519
|
+
</table>
|
|
520
|
+
</div>
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
<span id=""></span>
|
|
524
|
+
<div class="method_details ">
|
|
525
|
+
<h3 class="signature " id="key-instance_method">
|
|
526
|
+
|
|
527
|
+
#<strong>key</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
</h3><div class="docstring">
|
|
534
|
+
<div class="discussion">
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
</div>
|
|
538
|
+
</div>
|
|
539
|
+
<div class="tags">
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
</div><table class="source_code">
|
|
543
|
+
<tr>
|
|
544
|
+
<td>
|
|
545
|
+
<pre class="lines">
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
5
|
|
549
|
+
6
|
|
550
|
+
7</pre>
|
|
551
|
+
</td>
|
|
552
|
+
<td>
|
|
553
|
+
<pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 5</span>
|
|
554
|
+
|
|
555
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_key'>key</span>
|
|
556
|
+
<span class='ivar'>@key</span>
|
|
557
|
+
<span class='kw'>end</span></pre>
|
|
558
|
+
</td>
|
|
559
|
+
</tr>
|
|
560
|
+
</table>
|
|
561
|
+
</div>
|
|
562
|
+
|
|
563
|
+
</div>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
<div id="class_method_details" class="method_details_list">
|
|
567
|
+
<h2>Class Method Details</h2>
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
<div class="method_details first">
|
|
571
|
+
<h3 class="signature first" id="all-class_method">
|
|
572
|
+
|
|
573
|
+
.<strong>all</strong> ⇒ <tt>Object</tt>
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
</h3><div class="docstring">
|
|
580
|
+
<div class="discussion">
|
|
581
|
+
<p>Returns all possible values this Anchormodel can take.</p>
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
</div>
|
|
585
|
+
</div>
|
|
586
|
+
<div class="tags">
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
</div><table class="source_code">
|
|
590
|
+
<tr>
|
|
591
|
+
<td>
|
|
592
|
+
<pre class="lines">
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
13
|
|
596
|
+
14
|
|
597
|
+
15</pre>
|
|
598
|
+
</td>
|
|
599
|
+
<td>
|
|
600
|
+
<pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 13</span>
|
|
601
|
+
|
|
602
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
|
|
603
|
+
<span class='id identifier rubyid_entries_list'>entries_list</span>
|
|
604
|
+
<span class='kw'>end</span></pre>
|
|
605
|
+
</td>
|
|
606
|
+
</tr>
|
|
607
|
+
</table>
|
|
608
|
+
</div>
|
|
609
|
+
|
|
610
|
+
<div class="method_details ">
|
|
611
|
+
<h3 class="signature " id="find-class_method">
|
|
612
|
+
|
|
613
|
+
.<strong>find</strong>(key) ⇒ <tt>Object</tt>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
</h3><div class="docstring">
|
|
620
|
+
<div class="discussion">
|
|
621
|
+
<p>Retrieves a particular value given the key. Fails if not found.</p>
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
</div>
|
|
625
|
+
</div>
|
|
626
|
+
<div class="tags">
|
|
627
|
+
<p class="tag_title">Parameters:</p>
|
|
628
|
+
<ul class="param">
|
|
629
|
+
|
|
630
|
+
<li>
|
|
631
|
+
|
|
632
|
+
<span class='name'>key</span>
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
—
|
|
640
|
+
<div class='inline'><p>The key of the value that should be retrieved.</p>
|
|
641
|
+
</div>
|
|
642
|
+
|
|
643
|
+
</li>
|
|
644
|
+
|
|
645
|
+
</ul>
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
</div><table class="source_code">
|
|
649
|
+
<tr>
|
|
650
|
+
<td>
|
|
651
|
+
<pre class="lines">
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
19
|
|
655
|
+
20
|
|
656
|
+
21
|
|
657
|
+
22</pre>
|
|
658
|
+
</td>
|
|
659
|
+
<td>
|
|
660
|
+
<pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 19</span>
|
|
661
|
+
|
|
662
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
|
663
|
+
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
664
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_entries_hash'>entries_hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_fail'>fail</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Retreived undefined anchor model key </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'> for </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
665
|
+
<span class='kw'>end</span></pre>
|
|
666
|
+
</td>
|
|
667
|
+
</tr>
|
|
668
|
+
</table>
|
|
669
|
+
</div>
|
|
670
|
+
|
|
671
|
+
</div>
|
|
672
|
+
|
|
673
|
+
<div id="instance_method_details" class="method_details_list">
|
|
674
|
+
<h2>Instance Method Details</h2>
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
<div class="method_details first">
|
|
678
|
+
<h3 class="signature first" id="==-instance_method">
|
|
679
|
+
|
|
680
|
+
#<strong>==</strong>(other) ⇒ <tt>Object</tt>
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
</h3><div class="docstring">
|
|
687
|
+
<div class="discussion">
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
</div>
|
|
691
|
+
</div>
|
|
692
|
+
<div class="tags">
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
</div><table class="source_code">
|
|
696
|
+
<tr>
|
|
697
|
+
<td>
|
|
698
|
+
<pre class="lines">
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
44
|
|
702
|
+
45
|
|
703
|
+
46</pre>
|
|
704
|
+
</td>
|
|
705
|
+
<td>
|
|
706
|
+
<pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 44</span>
|
|
707
|
+
|
|
708
|
+
<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
|
|
709
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>&&</span> <span class='id identifier rubyid_key'>key</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_key'>key</span>
|
|
710
|
+
<span class='kw'>end</span></pre>
|
|
711
|
+
</td>
|
|
712
|
+
</tr>
|
|
713
|
+
</table>
|
|
714
|
+
</div>
|
|
715
|
+
|
|
716
|
+
<div class="method_details ">
|
|
717
|
+
<h3 class="signature " id="inspect-instance_method">
|
|
718
|
+
|
|
719
|
+
#<strong>inspect</strong> ⇒ <tt>Object</tt>
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
</h3><div class="docstring">
|
|
726
|
+
<div class="discussion">
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
</div>
|
|
730
|
+
</div>
|
|
731
|
+
<div class="tags">
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
</div><table class="source_code">
|
|
735
|
+
<tr>
|
|
736
|
+
<td>
|
|
737
|
+
<pre class="lines">
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
53
|
|
741
|
+
54
|
|
742
|
+
55</pre>
|
|
743
|
+
</td>
|
|
744
|
+
<td>
|
|
745
|
+
<pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 53</span>
|
|
746
|
+
|
|
747
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span>
|
|
748
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#<</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'><</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_hash'>hash</span><span class='embexpr_end'>}</span><span class='tstring_content'>></span><span class='tstring_end'>"</span></span>
|
|
749
|
+
<span class='kw'>end</span></pre>
|
|
750
|
+
</td>
|
|
751
|
+
</tr>
|
|
752
|
+
</table>
|
|
753
|
+
</div>
|
|
754
|
+
|
|
755
|
+
<div class="method_details ">
|
|
756
|
+
<h3 class="signature " id="label-instance_method">
|
|
757
|
+
|
|
758
|
+
#<strong>label</strong> ⇒ <tt>Object</tt>
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
</h3><div class="docstring">
|
|
765
|
+
<div class="discussion">
|
|
766
|
+
<p>Returns a Rails label that is compatible with the <a href="https://github.com/grosser/gettext_i18n_rails/">Rails FastGettext</a> gem.</p>
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
</div>
|
|
770
|
+
</div>
|
|
771
|
+
<div class="tags">
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
</div><table class="source_code">
|
|
775
|
+
<tr>
|
|
776
|
+
<td>
|
|
777
|
+
<pre class="lines">
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
49
|
|
781
|
+
50
|
|
782
|
+
51</pre>
|
|
783
|
+
</td>
|
|
784
|
+
<td>
|
|
785
|
+
<pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 49</span>
|
|
786
|
+
|
|
787
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_label'>label</span>
|
|
788
|
+
<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'>"</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_demodulize'>demodulize</span><span class='embexpr_end'>}</span><span class='tstring_content'>|</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_humanize'>humanize</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
789
|
+
<span class='kw'>end</span></pre>
|
|
790
|
+
</td>
|
|
791
|
+
</tr>
|
|
792
|
+
</table>
|
|
793
|
+
</div>
|
|
794
|
+
|
|
795
|
+
<div class="method_details ">
|
|
796
|
+
<h3 class="signature " id="to_s-instance_method">
|
|
797
|
+
|
|
798
|
+
#<strong>to_s</strong> ⇒ <tt>Object</tt>
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
</h3><div class="docstring">
|
|
805
|
+
<div class="discussion">
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
</div>
|
|
809
|
+
</div>
|
|
810
|
+
<div class="tags">
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
</div><table class="source_code">
|
|
814
|
+
<tr>
|
|
815
|
+
<td>
|
|
816
|
+
<pre class="lines">
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
57
|
|
820
|
+
58
|
|
821
|
+
59</pre>
|
|
822
|
+
</td>
|
|
823
|
+
<td>
|
|
824
|
+
<pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 57</span>
|
|
825
|
+
|
|
826
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
|
|
827
|
+
<span class='id identifier rubyid_inspect'>inspect</span>
|
|
828
|
+
<span class='kw'>end</span></pre>
|
|
829
|
+
</td>
|
|
830
|
+
</tr>
|
|
831
|
+
</table>
|
|
832
|
+
</div>
|
|
833
|
+
|
|
834
|
+
</div>
|
|
835
|
+
|
|
836
|
+
</div>
|
|
837
|
+
|
|
838
|
+
<div id="footer">
|
|
839
|
+
Generated on Sat Dec 17 12:56:00 2022 by
|
|
840
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
841
|
+
0.9.28 (ruby-3.0.4).
|
|
842
|
+
</div>
|
|
843
|
+
|
|
844
|
+
</div>
|
|
845
|
+
</body>
|
|
846
|
+
</html>
|