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.
- checksums.yaml +4 -4
- data/.gitignore +3 -0
- data/.yardopts +1 -0
- data/API.md +62 -0
- data/Gemfile +2 -0
- data/JSON_format.md +62 -0
- data/PubSub.md +20 -0
- data/README.md +2 -0
- data/Security.md +0 -0
- data/docs/HyperRecord/ClassMethods.html +2969 -0
- data/docs/HyperRecord/ClientInstanceMethods.html +1833 -0
- data/docs/HyperRecord/Collection.html +564 -0
- data/docs/HyperRecord/DummyValue.html +384 -0
- data/docs/HyperRecord/PubSub/ClassMethods.html +2047 -0
- data/docs/HyperRecord/PubSub.html +1679 -0
- data/docs/HyperRecord/ServerClassMethods.html +697 -0
- data/docs/HyperRecord.html +119 -0
- data/docs/Hyperloop/Resource/ClientDrivers.html +352 -0
- data/docs/Hyperloop/Resource/HTTP.html +1795 -0
- data/docs/Hyperloop/Resource/MethodsController.html +479 -0
- data/docs/Hyperloop/Resource/PropertiesController.html +225 -0
- data/docs/Hyperloop/Resource/PubSub/ClassMethods.html +105 -0
- data/docs/Hyperloop/Resource/PubSub.html +1210 -0
- data/docs/Hyperloop/Resource/RelationsController.html +529 -0
- data/docs/Hyperloop/Resource/ScopesController.html +380 -0
- data/docs/Hyperloop/Resource/SecurityError.html +124 -0
- data/docs/Hyperloop/Resource/SecurityGuards/ClassMethods.html +226 -0
- data/docs/Hyperloop/Resource/SecurityGuards.html +299 -0
- data/docs/Hyperloop/Resource.html +135 -0
- data/docs/Hyperloop.html +186 -0
- data/docs/_index.html +302 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +496 -0
- data/docs/file.API.html +138 -0
- data/docs/file.JSON_format.html +134 -0
- data/docs/file.PubSub.html +86 -0
- data/docs/file.README.html +192 -0
- data/docs/file_list.html +71 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +192 -0
- data/docs/js/app.js +292 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +1115 -0
- data/docs/top-level-namespace.html +110 -0
- data/hyper-resource.gemspec +19 -18
- data/lib/hyper_record/class_methods.rb +186 -3
- data/lib/hyper_record/client_instance_methods.rb +68 -3
- data/lib/hyper_record/collection.rb +19 -4
- data/lib/hyper_record/pub_sub.rb +92 -12
- data/lib/hyper_record/server_class_methods.rb +15 -0
- data/lib/hyperloop/resource/client_drivers.rb +2 -0
- data/lib/hyperloop/resource/http.rb +33 -22
- data/lib/hyperloop/resource/pub_sub.rb +2 -0
- data/lib/hyperloop/resource/version.rb +1 -1
- metadata +61 -2
|
@@ -0,0 +1,697 @@
|
|
|
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
|
+
Module: HyperRecord::ServerClassMethods
|
|
8
|
+
|
|
9
|
+
— 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::ServerClassMethods";
|
|
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 (S)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../HyperRecord.html" title="HyperRecord (module)">HyperRecord</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">ServerClassMethods</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>Module: HyperRecord::ServerClassMethods
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<dl>
|
|
80
|
+
<dt>Defined in:</dt>
|
|
81
|
+
<dd>lib/hyper_record/server_class_methods.rb</dd>
|
|
82
|
+
</dl>
|
|
83
|
+
|
|
84
|
+
</div>
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
<h2>
|
|
95
|
+
Instance Method Summary
|
|
96
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
97
|
+
</h2>
|
|
98
|
+
|
|
99
|
+
<ul class="summary">
|
|
100
|
+
|
|
101
|
+
<li class="public ">
|
|
102
|
+
<span class="summary_signature">
|
|
103
|
+
|
|
104
|
+
<a href="#resource_scopes-instance_method" title="#resource_scopes (instance method)">#<strong>resource_scopes</strong> ⇒ Hash </a>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</span>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
<span class="summary_desc"><div class='inline'>
|
|
119
|
+
<p>introspect defined scopes.</p>
|
|
120
|
+
</div></span>
|
|
121
|
+
|
|
122
|
+
</li>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
<li class="public ">
|
|
126
|
+
<span class="summary_signature">
|
|
127
|
+
|
|
128
|
+
<a href="#rest_class_method-instance_method" title="#rest_class_method (instance method)">#<strong>rest_class_method</strong>(name, options = { default_result: '...' }, &block) ⇒ Object </a>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
</span>
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
<span class="summary_desc"><div class='inline'>
|
|
143
|
+
<p>DSL for defining rest_class_methods.</p>
|
|
144
|
+
</div></span>
|
|
145
|
+
|
|
146
|
+
</li>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<li class="public ">
|
|
150
|
+
<span class="summary_signature">
|
|
151
|
+
|
|
152
|
+
<a href="#rest_class_methods-instance_method" title="#rest_class_methods (instance method)">#<strong>rest_class_methods</strong> ⇒ Hash </a>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
</span>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
<span class="summary_desc"><div class='inline'>
|
|
167
|
+
<p>introspect defined rest_class_methods.</p>
|
|
168
|
+
</div></span>
|
|
169
|
+
|
|
170
|
+
</li>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<li class="public ">
|
|
174
|
+
<span class="summary_signature">
|
|
175
|
+
|
|
176
|
+
<a href="#rest_method-instance_method" title="#rest_method (instance method)">#<strong>rest_method</strong>(name, options = { default_result: '...' }, &block) ⇒ Object </a>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</span>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<span class="summary_desc"><div class='inline'>
|
|
191
|
+
<p>DSL for defining rest_methods.</p>
|
|
192
|
+
</div></span>
|
|
193
|
+
|
|
194
|
+
</li>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
<li class="public ">
|
|
198
|
+
<span class="summary_signature">
|
|
199
|
+
|
|
200
|
+
<a href="#rest_methods-instance_method" title="#rest_methods (instance method)">#<strong>rest_methods</strong> ⇒ Hash </a>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
</span>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
<span class="summary_desc"><div class='inline'>
|
|
215
|
+
<p>introspect defined rest_methods.</p>
|
|
216
|
+
</div></span>
|
|
217
|
+
|
|
218
|
+
</li>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
<li class="public ">
|
|
222
|
+
<span class="summary_signature">
|
|
223
|
+
|
|
224
|
+
<a href="#scope-instance_method" title="#scope (instance method)">#<strong>scope</strong>(name, *args) ⇒ Object </a>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
</span>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<span class="summary_desc"><div class='inline'>
|
|
239
|
+
<p>defines a scope, wrapper around ORM method.</p>
|
|
240
|
+
</div></span>
|
|
241
|
+
|
|
242
|
+
</li>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
</ul>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
<div id="instance_method_details" class="method_details_list">
|
|
251
|
+
<h2>Instance Method Details</h2>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
<div class="method_details first">
|
|
255
|
+
<h3 class="signature first" id="resource_scopes-instance_method">
|
|
256
|
+
|
|
257
|
+
#<strong>resource_scopes</strong> ⇒ <tt>Hash</tt>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
</h3><div class="docstring">
|
|
264
|
+
<div class="discussion">
|
|
265
|
+
|
|
266
|
+
<p>introspect defined scopes</p>
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
</div>
|
|
270
|
+
</div>
|
|
271
|
+
<div class="tags">
|
|
272
|
+
|
|
273
|
+
<p class="tag_title">Returns:</p>
|
|
274
|
+
<ul class="return">
|
|
275
|
+
|
|
276
|
+
<li>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
</li>
|
|
284
|
+
|
|
285
|
+
</ul>
|
|
286
|
+
|
|
287
|
+
</div><table class="source_code">
|
|
288
|
+
<tr>
|
|
289
|
+
<td>
|
|
290
|
+
<pre class="lines">
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
47
|
|
294
|
+
48
|
|
295
|
+
49</pre>
|
|
296
|
+
</td>
|
|
297
|
+
<td>
|
|
298
|
+
<pre class="code"><span class="info file"># File 'lib/hyper_record/server_class_methods.rb', line 47</span>
|
|
299
|
+
|
|
300
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_resource_scopes'>resource_scopes</span>
|
|
301
|
+
<span class='ivar'>@resource_scopes</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
302
|
+
<span class='kw'>end</span></pre>
|
|
303
|
+
</td>
|
|
304
|
+
</tr>
|
|
305
|
+
</table>
|
|
306
|
+
</div>
|
|
307
|
+
|
|
308
|
+
<div class="method_details ">
|
|
309
|
+
<h3 class="signature " id="rest_class_method-instance_method">
|
|
310
|
+
|
|
311
|
+
#<strong>rest_class_method</strong>(name, options = { default_result: '...' }, &block) ⇒ <tt>Object</tt>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
</h3><div class="docstring">
|
|
318
|
+
<div class="discussion">
|
|
319
|
+
|
|
320
|
+
<p>DSL for defining rest_class_methods</p>
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
</div>
|
|
324
|
+
</div>
|
|
325
|
+
<div class="tags">
|
|
326
|
+
<p class="tag_title">Parameters:</p>
|
|
327
|
+
<ul class="param">
|
|
328
|
+
|
|
329
|
+
<li>
|
|
330
|
+
|
|
331
|
+
<span class='name'>name</span>
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
—
|
|
339
|
+
<div class='inline'>
|
|
340
|
+
<p>name of the method</p>
|
|
341
|
+
</div>
|
|
342
|
+
|
|
343
|
+
</li>
|
|
344
|
+
|
|
345
|
+
<li>
|
|
346
|
+
|
|
347
|
+
<span class='name'>options</span>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
<em class="default">(defaults to: <tt>{ default_result: '...' }</tt>)</em>
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
—
|
|
357
|
+
<div class='inline'>
|
|
358
|
+
<p>known key: default_result, used client side</p>
|
|
359
|
+
</div>
|
|
360
|
+
|
|
361
|
+
</li>
|
|
362
|
+
|
|
363
|
+
</ul>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
</div><table class="source_code">
|
|
367
|
+
<tr>
|
|
368
|
+
<td>
|
|
369
|
+
<pre class="lines">
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
6
|
|
373
|
+
7
|
|
374
|
+
8
|
|
375
|
+
9
|
|
376
|
+
10
|
|
377
|
+
11
|
|
378
|
+
12
|
|
379
|
+
13
|
|
380
|
+
14
|
|
381
|
+
15
|
|
382
|
+
16</pre>
|
|
383
|
+
</td>
|
|
384
|
+
<td>
|
|
385
|
+
<pre class="code"><span class="info file"># File 'lib/hyper_record/server_class_methods.rb', line 6</span>
|
|
386
|
+
|
|
387
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_rest_class_method'>rest_class_method</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>default_result:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>...</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
388
|
+
<span class='id identifier rubyid_rest_class_methods'>rest_class_methods</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span>
|
|
389
|
+
<span class='id identifier rubyid_rest_class_methods'>rest_class_methods</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:params</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_arity'>arity</span>
|
|
390
|
+
<span class='id identifier rubyid_singleton_class'>singleton_class</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='symbol'>:define_method</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='op'>|</span>
|
|
391
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>></span> <span class='int'>0</span>
|
|
392
|
+
<span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
|
|
393
|
+
<span class='kw'>else</span>
|
|
394
|
+
<span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span>
|
|
395
|
+
<span class='kw'>end</span>
|
|
396
|
+
<span class='kw'>end</span>
|
|
397
|
+
<span class='kw'>end</span></pre>
|
|
398
|
+
</td>
|
|
399
|
+
</tr>
|
|
400
|
+
</table>
|
|
401
|
+
</div>
|
|
402
|
+
|
|
403
|
+
<div class="method_details ">
|
|
404
|
+
<h3 class="signature " id="rest_class_methods-instance_method">
|
|
405
|
+
|
|
406
|
+
#<strong>rest_class_methods</strong> ⇒ <tt>Hash</tt>
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
</h3><div class="docstring">
|
|
413
|
+
<div class="discussion">
|
|
414
|
+
|
|
415
|
+
<p>introspect defined rest_class_methods</p>
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
</div>
|
|
419
|
+
</div>
|
|
420
|
+
<div class="tags">
|
|
421
|
+
|
|
422
|
+
<p class="tag_title">Returns:</p>
|
|
423
|
+
<ul class="return">
|
|
424
|
+
|
|
425
|
+
<li>
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
</li>
|
|
433
|
+
|
|
434
|
+
</ul>
|
|
435
|
+
|
|
436
|
+
</div><table class="source_code">
|
|
437
|
+
<tr>
|
|
438
|
+
<td>
|
|
439
|
+
<pre class="lines">
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
35
|
|
443
|
+
36
|
|
444
|
+
37</pre>
|
|
445
|
+
</td>
|
|
446
|
+
<td>
|
|
447
|
+
<pre class="code"><span class="info file"># File 'lib/hyper_record/server_class_methods.rb', line 35</span>
|
|
448
|
+
|
|
449
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_rest_class_methods'>rest_class_methods</span>
|
|
450
|
+
<span class='ivar'>@rest_class_methods</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
451
|
+
<span class='kw'>end</span></pre>
|
|
452
|
+
</td>
|
|
453
|
+
</tr>
|
|
454
|
+
</table>
|
|
455
|
+
</div>
|
|
456
|
+
|
|
457
|
+
<div class="method_details ">
|
|
458
|
+
<h3 class="signature " id="rest_method-instance_method">
|
|
459
|
+
|
|
460
|
+
#<strong>rest_method</strong>(name, options = { default_result: '...' }, &block) ⇒ <tt>Object</tt>
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
</h3><div class="docstring">
|
|
467
|
+
<div class="discussion">
|
|
468
|
+
|
|
469
|
+
<p>DSL for defining rest_methods</p>
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
</div>
|
|
473
|
+
</div>
|
|
474
|
+
<div class="tags">
|
|
475
|
+
<p class="tag_title">Parameters:</p>
|
|
476
|
+
<ul class="param">
|
|
477
|
+
|
|
478
|
+
<li>
|
|
479
|
+
|
|
480
|
+
<span class='name'>name</span>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
—
|
|
488
|
+
<div class='inline'>
|
|
489
|
+
<p>name of the method</p>
|
|
490
|
+
</div>
|
|
491
|
+
|
|
492
|
+
</li>
|
|
493
|
+
|
|
494
|
+
<li>
|
|
495
|
+
|
|
496
|
+
<span class='name'>options</span>
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
<em class="default">(defaults to: <tt>{ default_result: '...' }</tt>)</em>
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
—
|
|
506
|
+
<div class='inline'>
|
|
507
|
+
<p>known key: default_result, used client side</p>
|
|
508
|
+
</div>
|
|
509
|
+
|
|
510
|
+
</li>
|
|
511
|
+
|
|
512
|
+
</ul>
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
</div><table class="source_code">
|
|
516
|
+
<tr>
|
|
517
|
+
<td>
|
|
518
|
+
<pre class="lines">
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
21
|
|
522
|
+
22
|
|
523
|
+
23
|
|
524
|
+
24
|
|
525
|
+
25
|
|
526
|
+
26
|
|
527
|
+
27
|
|
528
|
+
28
|
|
529
|
+
29
|
|
530
|
+
30
|
|
531
|
+
31</pre>
|
|
532
|
+
</td>
|
|
533
|
+
<td>
|
|
534
|
+
<pre class="code"><span class="info file"># File 'lib/hyper_record/server_class_methods.rb', line 21</span>
|
|
535
|
+
|
|
536
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_rest_method'>rest_method</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>default_result:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>...</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
537
|
+
<span class='id identifier rubyid_rest_methods'>rest_methods</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span>
|
|
538
|
+
<span class='id identifier rubyid_rest_methods'>rest_methods</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:params</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_arity'>arity</span>
|
|
539
|
+
<span class='id identifier rubyid_define_method'>define_method</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='op'>|</span>
|
|
540
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>></span> <span class='int'>0</span>
|
|
541
|
+
<span class='id identifier rubyid_instance_exec'>instance_exec</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_block'>block</span><span class='rparen'>)</span>
|
|
542
|
+
<span class='kw'>else</span>
|
|
543
|
+
<span class='id identifier rubyid_instance_exec'>instance_exec</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
544
|
+
<span class='kw'>end</span>
|
|
545
|
+
<span class='kw'>end</span>
|
|
546
|
+
<span class='kw'>end</span></pre>
|
|
547
|
+
</td>
|
|
548
|
+
</tr>
|
|
549
|
+
</table>
|
|
550
|
+
</div>
|
|
551
|
+
|
|
552
|
+
<div class="method_details ">
|
|
553
|
+
<h3 class="signature " id="rest_methods-instance_method">
|
|
554
|
+
|
|
555
|
+
#<strong>rest_methods</strong> ⇒ <tt>Hash</tt>
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
</h3><div class="docstring">
|
|
562
|
+
<div class="discussion">
|
|
563
|
+
|
|
564
|
+
<p>introspect defined rest_methods</p>
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
</div>
|
|
568
|
+
</div>
|
|
569
|
+
<div class="tags">
|
|
570
|
+
|
|
571
|
+
<p class="tag_title">Returns:</p>
|
|
572
|
+
<ul class="return">
|
|
573
|
+
|
|
574
|
+
<li>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
</li>
|
|
582
|
+
|
|
583
|
+
</ul>
|
|
584
|
+
|
|
585
|
+
</div><table class="source_code">
|
|
586
|
+
<tr>
|
|
587
|
+
<td>
|
|
588
|
+
<pre class="lines">
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
41
|
|
592
|
+
42
|
|
593
|
+
43</pre>
|
|
594
|
+
</td>
|
|
595
|
+
<td>
|
|
596
|
+
<pre class="code"><span class="info file"># File 'lib/hyper_record/server_class_methods.rb', line 41</span>
|
|
597
|
+
|
|
598
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_rest_methods'>rest_methods</span>
|
|
599
|
+
<span class='ivar'>@rest_methods</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
600
|
+
<span class='kw'>end</span></pre>
|
|
601
|
+
</td>
|
|
602
|
+
</tr>
|
|
603
|
+
</table>
|
|
604
|
+
</div>
|
|
605
|
+
|
|
606
|
+
<div class="method_details ">
|
|
607
|
+
<h3 class="signature " id="scope-instance_method">
|
|
608
|
+
|
|
609
|
+
#<strong>scope</strong>(name, *args) ⇒ <tt>Object</tt>
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
</h3><div class="docstring">
|
|
616
|
+
<div class="discussion">
|
|
617
|
+
|
|
618
|
+
<p>defines a scope, wrapper around ORM method</p>
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
</div>
|
|
622
|
+
</div>
|
|
623
|
+
<div class="tags">
|
|
624
|
+
<p class="tag_title">Parameters:</p>
|
|
625
|
+
<ul class="param">
|
|
626
|
+
|
|
627
|
+
<li>
|
|
628
|
+
|
|
629
|
+
<span class='name'>name</span>
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
—
|
|
637
|
+
<div class='inline'>
|
|
638
|
+
<p>name of the args</p>
|
|
639
|
+
</div>
|
|
640
|
+
|
|
641
|
+
</li>
|
|
642
|
+
|
|
643
|
+
<li>
|
|
644
|
+
|
|
645
|
+
<span class='name'>*args</span>
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
<span class='type'></span>
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
—
|
|
653
|
+
<div class='inline'>
|
|
654
|
+
<p>additional args, passed to ORMs scope DSL</p>
|
|
655
|
+
</div>
|
|
656
|
+
|
|
657
|
+
</li>
|
|
658
|
+
|
|
659
|
+
</ul>
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
</div><table class="source_code">
|
|
663
|
+
<tr>
|
|
664
|
+
<td>
|
|
665
|
+
<pre class="lines">
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
54
|
|
669
|
+
55
|
|
670
|
+
56
|
|
671
|
+
57</pre>
|
|
672
|
+
</td>
|
|
673
|
+
<td>
|
|
674
|
+
<pre class="code"><span class="info file"># File 'lib/hyper_record/server_class_methods.rb', line 54</span>
|
|
675
|
+
|
|
676
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_scope'>scope</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
|
|
677
|
+
<span class='id identifier rubyid_resource_scopes'>resource_scopes</span> <span class='op'><<</span> <span class='id identifier rubyid_name'>name</span>
|
|
678
|
+
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
|
|
679
|
+
<span class='kw'>end</span></pre>
|
|
680
|
+
</td>
|
|
681
|
+
</tr>
|
|
682
|
+
</table>
|
|
683
|
+
</div>
|
|
684
|
+
|
|
685
|
+
</div>
|
|
686
|
+
|
|
687
|
+
</div>
|
|
688
|
+
|
|
689
|
+
<div id="footer">
|
|
690
|
+
Generated on Tue Jun 5 23:13:52 2018 by
|
|
691
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
692
|
+
0.9.13 (ruby-2.5.1).
|
|
693
|
+
</div>
|
|
694
|
+
|
|
695
|
+
</div>
|
|
696
|
+
</body>
|
|
697
|
+
</html>
|