hyper-resource 1.0.0.lap79 → 1.0.0.lap80

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.
Files changed (58) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +3 -0
  3. data/.yardopts +1 -0
  4. data/API.md +62 -0
  5. data/Gemfile +2 -0
  6. data/JSON_format.md +62 -0
  7. data/PubSub.md +20 -0
  8. data/README.md +2 -0
  9. data/Security.md +0 -0
  10. data/docs/HyperRecord/ClassMethods.html +2969 -0
  11. data/docs/HyperRecord/ClientInstanceMethods.html +1833 -0
  12. data/docs/HyperRecord/Collection.html +564 -0
  13. data/docs/HyperRecord/DummyValue.html +384 -0
  14. data/docs/HyperRecord/PubSub/ClassMethods.html +2047 -0
  15. data/docs/HyperRecord/PubSub.html +1679 -0
  16. data/docs/HyperRecord/ServerClassMethods.html +697 -0
  17. data/docs/HyperRecord.html +119 -0
  18. data/docs/Hyperloop/Resource/ClientDrivers.html +352 -0
  19. data/docs/Hyperloop/Resource/HTTP.html +1795 -0
  20. data/docs/Hyperloop/Resource/MethodsController.html +479 -0
  21. data/docs/Hyperloop/Resource/PropertiesController.html +225 -0
  22. data/docs/Hyperloop/Resource/PubSub/ClassMethods.html +105 -0
  23. data/docs/Hyperloop/Resource/PubSub.html +1210 -0
  24. data/docs/Hyperloop/Resource/RelationsController.html +529 -0
  25. data/docs/Hyperloop/Resource/ScopesController.html +380 -0
  26. data/docs/Hyperloop/Resource/SecurityError.html +124 -0
  27. data/docs/Hyperloop/Resource/SecurityGuards/ClassMethods.html +226 -0
  28. data/docs/Hyperloop/Resource/SecurityGuards.html +299 -0
  29. data/docs/Hyperloop/Resource.html +135 -0
  30. data/docs/Hyperloop.html +186 -0
  31. data/docs/_index.html +302 -0
  32. data/docs/class_list.html +51 -0
  33. data/docs/css/common.css +1 -0
  34. data/docs/css/full_list.css +58 -0
  35. data/docs/css/style.css +496 -0
  36. data/docs/file.API.html +138 -0
  37. data/docs/file.JSON_format.html +134 -0
  38. data/docs/file.PubSub.html +86 -0
  39. data/docs/file.README.html +192 -0
  40. data/docs/file_list.html +71 -0
  41. data/docs/frames.html +17 -0
  42. data/docs/index.html +192 -0
  43. data/docs/js/app.js +292 -0
  44. data/docs/js/full_list.js +216 -0
  45. data/docs/js/jquery.js +4 -0
  46. data/docs/method_list.html +1115 -0
  47. data/docs/top-level-namespace.html +110 -0
  48. data/hyper-resource.gemspec +19 -18
  49. data/lib/hyper_record/class_methods.rb +186 -3
  50. data/lib/hyper_record/client_instance_methods.rb +68 -3
  51. data/lib/hyper_record/collection.rb +19 -4
  52. data/lib/hyper_record/pub_sub.rb +92 -12
  53. data/lib/hyper_record/server_class_methods.rb +15 -0
  54. data/lib/hyperloop/resource/client_drivers.rb +2 -0
  55. data/lib/hyperloop/resource/http.rb +33 -22
  56. data/lib/hyperloop/resource/pub_sub.rb +2 -0
  57. data/lib/hyperloop/resource/version.rb +1 -1
  58. metadata +61 -2
@@ -0,0 +1,564 @@
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: HyperRecord::Collection
8
+
9
+ &mdash; Documentation by YARD 0.9.13
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "HyperRecord::Collection";
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 (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../HyperRecord.html" title="HyperRecord (module)">HyperRecord</a></span></span>
41
+ &raquo;
42
+ <span class="title">Collection</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: HyperRecord::Collection
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Array</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Array</li>
78
+
79
+ <li class="next">HyperRecord::Collection</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/hyper_record/collection.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+ <h2>
113
+ Instance Method Summary
114
+ <small><a href="#" class="summary_toggle">collapse</a></small>
115
+ </h2>
116
+
117
+ <ul class="summary">
118
+
119
+ <li class="public ">
120
+ <span class="summary_signature">
121
+
122
+ <a href="#<<-instance_method" title="#&lt;&lt; (instance method)">#<strong>&lt;&lt;</strong>(other_record) &#x21d2; Object </a>
123
+
124
+
125
+
126
+ </span>
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ <span class="summary_desc"><div class='inline'>
137
+ <p>add record to collection, record is saved to db, success assumed.</p>
138
+ </div></span>
139
+
140
+ </li>
141
+
142
+
143
+ <li class="public ">
144
+ <span class="summary_signature">
145
+
146
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(other_record) &#x21d2; Object </a>
147
+
148
+
149
+
150
+ </span>
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+ <span class="summary_desc"><div class='inline'>
161
+ <p>delete record from collection, saved to db, success assumed.</p>
162
+ </div></span>
163
+
164
+ </li>
165
+
166
+
167
+ <li class="public ">
168
+ <span class="summary_signature">
169
+
170
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(collection = [], record = nil, relation_name = nil) &#x21d2; Collection </a>
171
+
172
+
173
+
174
+ </span>
175
+
176
+
177
+ <span class="note title constructor">constructor</span>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+ <span class="summary_desc"><div class='inline'>
187
+ <p>initialize new HyperRecord::Collection, used internally.</p>
188
+ </div></span>
189
+
190
+ </li>
191
+
192
+
193
+ <li class="public ">
194
+ <span class="summary_signature">
195
+
196
+ <a href="#push-instance_method" title="#push (instance method)">#<strong>push</strong>(other_record) &#x21d2; Object </a>
197
+
198
+
199
+
200
+ </span>
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+ <span class="summary_desc"><div class='inline'>
211
+ <p>add record to collection, not saved to db.</p>
212
+ </div></span>
213
+
214
+ </li>
215
+
216
+
217
+ </ul>
218
+
219
+
220
+
221
+ <div id="constructor_details" class="method_details_list">
222
+ <h2>Constructor Details</h2>
223
+
224
+ <div class="method_details first">
225
+ <h3 class="signature first" id="initialize-instance_method">
226
+
227
+ #<strong>initialize</strong>(collection = [], record = nil, relation_name = nil) &#x21d2; <tt><span class='object_link'><a href="" title="HyperRecord::Collection (class)">Collection</a></span></tt>
228
+
229
+
230
+
231
+
232
+
233
+ </h3><div class="docstring">
234
+ <div class="discussion">
235
+
236
+ <p>initialize new HyperRecord::Collection, used internally</p>
237
+
238
+
239
+ </div>
240
+ </div>
241
+ <div class="tags">
242
+ <p class="tag_title">Parameters:</p>
243
+ <ul class="param">
244
+
245
+ <li>
246
+
247
+ <span class='name'>collection</span>
248
+
249
+
250
+ <span class='type'>(<tt><span class='object_link'><a href="" title="HyperRecord::Collection (class)">HyperRecord::Collection</a></span></tt>)</span>
251
+
252
+
253
+ <em class="default">(defaults to: <tt>[]</tt>)</em>
254
+
255
+
256
+ &mdash;
257
+ <div class='inline'>
258
+ <p>or [Array] of records or empty [Array]</p>
259
+ </div>
260
+
261
+ </li>
262
+
263
+ <li>
264
+
265
+ <span class='name'>record</span>
266
+
267
+
268
+ <span class='type'>(<tt><span class='object_link'><a href="../HyperRecord.html" title="HyperRecord (module)">HyperRecord</a></span></tt>)</span>
269
+
270
+
271
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
272
+
273
+
274
+ &mdash;
275
+ <div class='inline'>
276
+ <p>optional base record this collection belongs to</p>
277
+ </div>
278
+
279
+ </li>
280
+
281
+ <li>
282
+
283
+ <span class='name'>relation_name</span>
284
+
285
+
286
+ <span class='type'>(<tt>String</tt>)</span>
287
+
288
+
289
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
290
+
291
+
292
+ &mdash;
293
+ <div class='inline'>
294
+ <p>optional base record relation name this collection represents</p>
295
+ </div>
296
+
297
+ </li>
298
+
299
+ </ul>
300
+
301
+
302
+ </div><table class="source_code">
303
+ <tr>
304
+ <td>
305
+ <pre class="lines">
306
+
307
+
308
+ 9
309
+ 10
310
+ 11
311
+ 12
312
+ 13
313
+ 14
314
+ 15
315
+ 16
316
+ 17
317
+ 18
318
+ 19</pre>
319
+ </td>
320
+ <td>
321
+ <pre class="code"><span class="info file"># File 'lib/hyper_record/collection.rb', line 9</span>
322
+
323
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_collection'>collection</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_record'>record</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_relation_name'>relation_name</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
324
+ <span class='ivar'>@record</span> <span class='op'>=</span> <span class='id identifier rubyid_record'>record</span>
325
+ <span class='ivar'>@relation_name</span> <span class='op'>=</span> <span class='id identifier rubyid_relation_name'>relation_name</span>
326
+ <span class='kw'>if</span> <span class='id identifier rubyid_collection'>collection</span>
327
+ <span class='id identifier rubyid_collection'>collection</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_record'>record</span><span class='op'>|</span>
328
+ <span class='id identifier rubyid_record'>record</span><span class='period'>.</span><span class='id identifier rubyid__register_collection'>_register_collection</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
329
+ <span class='kw'>end</span>
330
+ <span class='kw'>end</span>
331
+ <span class='ivar'>@record</span><span class='period'>.</span><span class='id identifier rubyid__notify_observers'>_notify_observers</span> <span class='kw'>if</span> <span class='ivar'>@record</span>
332
+ <span class='id identifier rubyid_collection'>collection</span> <span class='op'>?</span> <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_collection'>collection</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='kw'>super</span>
333
+ <span class='kw'>end</span></pre>
334
+ </td>
335
+ </tr>
336
+ </table>
337
+ </div>
338
+
339
+ </div>
340
+
341
+
342
+ <div id="instance_method_details" class="method_details_list">
343
+ <h2>Instance Method Details</h2>
344
+
345
+
346
+ <div class="method_details first">
347
+ <h3 class="signature first" id="<<-instance_method">
348
+
349
+ #<strong>&lt;&lt;</strong>(other_record) &#x21d2; <tt>Object</tt>
350
+
351
+
352
+
353
+
354
+
355
+ </h3><div class="docstring">
356
+ <div class="discussion">
357
+
358
+ <p>add record to collection, record is saved to db, success assumed</p>
359
+
360
+
361
+ </div>
362
+ </div>
363
+ <div class="tags">
364
+ <p class="tag_title">Parameters:</p>
365
+ <ul class="param">
366
+
367
+ <li>
368
+
369
+ <span class='name'>other_record</span>
370
+
371
+
372
+ <span class='type'>(<tt><span class='object_link'><a href="../HyperRecord.html" title="HyperRecord (module)">HyperRecord</a></span></tt>)</span>
373
+
374
+
375
+
376
+ &mdash;
377
+ <div class='inline'>
378
+ <p>record to add</p>
379
+ </div>
380
+
381
+ </li>
382
+
383
+ </ul>
384
+
385
+
386
+ </div><table class="source_code">
387
+ <tr>
388
+ <td>
389
+ <pre class="lines">
390
+
391
+
392
+ 24
393
+ 25
394
+ 26
395
+ 27
396
+ 28
397
+ 29
398
+ 30
399
+ 31</pre>
400
+ </td>
401
+ <td>
402
+ <pre class="code"><span class="info file"># File 'lib/hyper_record/collection.rb', line 24</span>
403
+
404
+ <span class='kw'>def</span> <span class='op'>&lt;&lt;</span><span class='lparen'>(</span><span class='id identifier rubyid_other_record'>other_record</span><span class='rparen'>)</span>
405
+ <span class='kw'>if</span> <span class='ivar'>@record</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@relation_name</span>
406
+ <span class='ivar'>@record</span><span class='period'>.</span><span class='id identifier rubyid_promise_link'>promise_link</span><span class='lparen'>(</span><span class='id identifier rubyid_other_record'>other_record</span><span class='comma'>,</span> <span class='ivar'>@relation_name</span><span class='rparen'>)</span>
407
+ <span class='kw'>end</span>
408
+ <span class='id identifier rubyid_other_record'>other_record</span><span class='period'>.</span><span class='id identifier rubyid__register_collection'>_register_collection</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
409
+ <span class='ivar'>@record</span><span class='period'>.</span><span class='id identifier rubyid__notify_observers'>_notify_observers</span> <span class='kw'>if</span> <span class='ivar'>@record</span>
410
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_other_record'>other_record</span><span class='rparen'>)</span>
411
+ <span class='kw'>end</span></pre>
412
+ </td>
413
+ </tr>
414
+ </table>
415
+ </div>
416
+
417
+ <div class="method_details ">
418
+ <h3 class="signature " id="delete-instance_method">
419
+
420
+ #<strong>delete</strong>(other_record) &#x21d2; <tt>Object</tt>
421
+
422
+
423
+
424
+
425
+
426
+ </h3><div class="docstring">
427
+ <div class="discussion">
428
+
429
+ <p>delete record from collection, saved to db, success assumed</p>
430
+
431
+
432
+ </div>
433
+ </div>
434
+ <div class="tags">
435
+ <p class="tag_title">Parameters:</p>
436
+ <ul class="param">
437
+
438
+ <li>
439
+
440
+ <span class='name'>other_record</span>
441
+
442
+
443
+ <span class='type'>(<tt><span class='object_link'><a href="../HyperRecord.html" title="HyperRecord (module)">HyperRecord</a></span></tt>)</span>
444
+
445
+
446
+
447
+ &mdash;
448
+ <div class='inline'>
449
+ <p>record to delete from collection</p>
450
+ </div>
451
+
452
+ </li>
453
+
454
+ </ul>
455
+
456
+
457
+ </div><table class="source_code">
458
+ <tr>
459
+ <td>
460
+ <pre class="lines">
461
+
462
+
463
+ 36
464
+ 37
465
+ 38
466
+ 39
467
+ 40
468
+ 41
469
+ 42
470
+ 43</pre>
471
+ </td>
472
+ <td>
473
+ <pre class="code"><span class="info file"># File 'lib/hyper_record/collection.rb', line 36</span>
474
+
475
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_other_record'>other_record</span><span class='rparen'>)</span>
476
+ <span class='kw'>if</span> <span class='ivar'>@record</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@relation_name</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_other_record'>other_record</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='symbol'>:promise_unlink</span><span class='lparen'>(</span><span class='id identifier rubyid_other_record'>other_record</span><span class='comma'>,</span> <span class='ivar'>@relation_name</span><span class='rparen'>)</span>
477
+ <span class='kw'>end</span>
478
+ <span class='id identifier rubyid_other_record'>other_record</span><span class='period'>.</span><span class='id identifier rubyid__unregister_collection'>_unregister_collection</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
479
+ <span class='ivar'>@record</span><span class='period'>.</span><span class='id identifier rubyid__notify_observers'>_notify_observers</span> <span class='kw'>if</span> <span class='ivar'>@record</span>
480
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_other_record'>other_record</span><span class='rparen'>)</span>
481
+ <span class='kw'>end</span></pre>
482
+ </td>
483
+ </tr>
484
+ </table>
485
+ </div>
486
+
487
+ <div class="method_details ">
488
+ <h3 class="signature " id="push-instance_method">
489
+
490
+ #<strong>push</strong>(other_record) &#x21d2; <tt>Object</tt>
491
+
492
+
493
+
494
+
495
+
496
+ </h3><div class="docstring">
497
+ <div class="discussion">
498
+
499
+ <p>add record to collection, not saved to db</p>
500
+
501
+
502
+ </div>
503
+ </div>
504
+ <div class="tags">
505
+ <p class="tag_title">Parameters:</p>
506
+ <ul class="param">
507
+
508
+ <li>
509
+
510
+ <span class='name'>other_record</span>
511
+
512
+
513
+ <span class='type'>(<tt><span class='object_link'><a href="../HyperRecord.html" title="HyperRecord (module)">HyperRecord</a></span></tt>)</span>
514
+
515
+
516
+
517
+ &mdash;
518
+ <div class='inline'>
519
+ <p>record to add</p>
520
+ </div>
521
+
522
+ </li>
523
+
524
+ </ul>
525
+
526
+
527
+ </div><table class="source_code">
528
+ <tr>
529
+ <td>
530
+ <pre class="lines">
531
+
532
+
533
+ 48
534
+ 49
535
+ 50
536
+ 51
537
+ 52</pre>
538
+ </td>
539
+ <td>
540
+ <pre class="code"><span class="info file"># File 'lib/hyper_record/collection.rb', line 48</span>
541
+
542
+ <span class='kw'>def</span> <span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_other_record'>other_record</span><span class='rparen'>)</span>
543
+ <span class='id identifier rubyid_other_record'>other_record</span><span class='period'>.</span><span class='id identifier rubyid__register_collection'>_register_collection</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
544
+ <span class='ivar'>@record</span><span class='period'>.</span><span class='id identifier rubyid__notify_observers'>_notify_observers</span> <span class='kw'>if</span> <span class='ivar'>@record</span>
545
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_other_record'>other_record</span><span class='rparen'>)</span>
546
+ <span class='kw'>end</span></pre>
547
+ </td>
548
+ </tr>
549
+ </table>
550
+ </div>
551
+
552
+ </div>
553
+
554
+ </div>
555
+
556
+ <div id="footer">
557
+ Generated on Tue Jun 5 23:13:52 2018 by
558
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
559
+ 0.9.13 (ruby-2.5.1).
560
+ </div>
561
+
562
+ </div>
563
+ </body>
564
+ </html>