jsonapi_compliable 0.6.4 → 0.6.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +1 -1
- data/.travis.yml +11 -3
- data/.yardopts +1 -0
- data/README.md +10 -1
- data/Rakefile +1 -0
- data/docs/JsonapiCompliable.html +202 -0
- data/docs/JsonapiCompliable/Adapters.html +119 -0
- data/docs/JsonapiCompliable/Adapters/Abstract.html +2285 -0
- data/docs/JsonapiCompliable/Adapters/ActiveRecord.html +2151 -0
- data/docs/JsonapiCompliable/Adapters/ActiveRecordSideloading.html +582 -0
- data/docs/JsonapiCompliable/Adapters/Null.html +1682 -0
- data/docs/JsonapiCompliable/Base.html +1395 -0
- data/docs/JsonapiCompliable/Deserializer.html +835 -0
- data/docs/JsonapiCompliable/Errors.html +115 -0
- data/docs/JsonapiCompliable/Errors/BadFilter.html +124 -0
- data/docs/JsonapiCompliable/Errors/StatNotFound.html +266 -0
- data/docs/JsonapiCompliable/Errors/UnsupportedPageSize.html +264 -0
- data/docs/JsonapiCompliable/Errors/ValidationError.html +124 -0
- data/docs/JsonapiCompliable/Extensions.html +117 -0
- data/docs/JsonapiCompliable/Extensions/BooleanAttribute.html +212 -0
- data/docs/JsonapiCompliable/Extensions/BooleanAttribute/ClassMethods.html +229 -0
- data/docs/JsonapiCompliable/Extensions/ExtraAttribute.html +242 -0
- data/docs/JsonapiCompliable/Extensions/ExtraAttribute/ClassMethods.html +237 -0
- data/docs/JsonapiCompliable/Query.html +1099 -0
- data/docs/JsonapiCompliable/Rails.html +211 -0
- data/docs/JsonapiCompliable/Resource.html +5241 -0
- data/docs/JsonapiCompliable/Scope.html +703 -0
- data/docs/JsonapiCompliable/Scoping.html +117 -0
- data/docs/JsonapiCompliable/Scoping/Base.html +843 -0
- data/docs/JsonapiCompliable/Scoping/DefaultFilter.html +318 -0
- data/docs/JsonapiCompliable/Scoping/ExtraFields.html +301 -0
- data/docs/JsonapiCompliable/Scoping/Filter.html +313 -0
- data/docs/JsonapiCompliable/Scoping/Filterable.html +364 -0
- data/docs/JsonapiCompliable/Scoping/Paginate.html +613 -0
- data/docs/JsonapiCompliable/Scoping/Sort.html +454 -0
- data/docs/JsonapiCompliable/SerializableTempId.html +216 -0
- data/docs/JsonapiCompliable/Sideload.html +2484 -0
- data/docs/JsonapiCompliable/Stats.html +117 -0
- data/docs/JsonapiCompliable/Stats/DSL.html +999 -0
- data/docs/JsonapiCompliable/Stats/Payload.html +391 -0
- data/docs/JsonapiCompliable/Util.html +117 -0
- data/docs/JsonapiCompliable/Util/FieldParams.html +228 -0
- data/docs/JsonapiCompliable/Util/Hash.html +471 -0
- data/docs/JsonapiCompliable/Util/IncludeParams.html +299 -0
- data/docs/JsonapiCompliable/Util/Persistence.html +435 -0
- data/docs/JsonapiCompliable/Util/RelationshipPayload.html +563 -0
- data/docs/JsonapiCompliable/Util/RenderOptions.html +250 -0
- data/docs/JsonapiCompliable/Util/ValidationResponse.html +532 -0
- data/docs/_index.html +527 -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 +492 -0
- data/docs/file.README.html +99 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +99 -0
- data/docs/js/app.js +248 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +1731 -0
- data/docs/top-level-namespace.html +110 -0
- data/gemfiles/rails_5.gemfile +1 -1
- data/lib/jsonapi_compliable/adapters/abstract.rb +267 -4
- data/lib/jsonapi_compliable/adapters/active_record.rb +23 -1
- data/lib/jsonapi_compliable/adapters/null.rb +43 -3
- data/lib/jsonapi_compliable/base.rb +182 -33
- data/lib/jsonapi_compliable/deserializer.rb +90 -21
- data/lib/jsonapi_compliable/extensions/boolean_attribute.rb +12 -0
- data/lib/jsonapi_compliable/extensions/extra_attribute.rb +32 -0
- data/lib/jsonapi_compliable/extensions/temp_id.rb +11 -0
- data/lib/jsonapi_compliable/query.rb +94 -2
- data/lib/jsonapi_compliable/rails.rb +8 -0
- data/lib/jsonapi_compliable/resource.rb +548 -11
- data/lib/jsonapi_compliable/scope.rb +43 -1
- data/lib/jsonapi_compliable/scoping/base.rb +59 -8
- data/lib/jsonapi_compliable/scoping/default_filter.rb +33 -0
- data/lib/jsonapi_compliable/scoping/extra_fields.rb +33 -0
- data/lib/jsonapi_compliable/scoping/filter.rb +29 -2
- data/lib/jsonapi_compliable/scoping/filterable.rb +4 -0
- data/lib/jsonapi_compliable/scoping/paginate.rb +33 -0
- data/lib/jsonapi_compliable/scoping/sort.rb +18 -0
- data/lib/jsonapi_compliable/sideload.rb +229 -1
- data/lib/jsonapi_compliable/stats/dsl.rb +44 -0
- data/lib/jsonapi_compliable/stats/payload.rb +20 -0
- data/lib/jsonapi_compliable/util/field_params.rb +1 -0
- data/lib/jsonapi_compliable/util/hash.rb +18 -0
- data/lib/jsonapi_compliable/util/include_params.rb +22 -0
- data/lib/jsonapi_compliable/util/persistence.rb +13 -3
- data/lib/jsonapi_compliable/util/relationship_payload.rb +2 -0
- data/lib/jsonapi_compliable/util/render_options.rb +2 -0
- data/lib/jsonapi_compliable/util/validation_response.rb +16 -0
- data/lib/jsonapi_compliable/version.rb +1 -1
- metadata +60 -5
- data/gemfiles/rails_4.gemfile.lock +0 -208
- data/gemfiles/rails_5.gemfile.lock +0 -212
- data/lib/jsonapi_compliable/write.rb +0 -93
|
@@ -0,0 +1,391 @@
|
|
|
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: JsonapiCompliable::Stats::Payload
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.9
|
|
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 = "JsonapiCompliable::Stats::Payload";
|
|
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 (P)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span> » <span class='title'><span class='object_link'><a href="../Stats.html" title="JsonapiCompliable::Stats (module)">Stats</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Payload</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: JsonapiCompliable::Stats::Payload
|
|
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">JsonapiCompliable::Stats::Payload</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/jsonapi_compliable/stats/payload.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Generate the stats payload so we can return it in the response.</p>
|
|
106
|
+
|
|
107
|
+
<pre class="code ruby"><code class="ruby">{
|
|
108
|
+
data: [...],
|
|
109
|
+
meta: { stats: the_generated_payload }
|
|
110
|
+
}</code></pre>
|
|
111
|
+
|
|
112
|
+
<p>For example:</p>
|
|
113
|
+
|
|
114
|
+
<pre class="code ruby"><code class="ruby">{
|
|
115
|
+
data: [...],
|
|
116
|
+
meta: { stats: { total: { count: 100 } } }
|
|
117
|
+
}</code></pre>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
</div>
|
|
121
|
+
</div>
|
|
122
|
+
<div class="tags">
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
</div>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
<h2>
|
|
134
|
+
Instance Method Summary
|
|
135
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
136
|
+
</h2>
|
|
137
|
+
|
|
138
|
+
<ul class="summary">
|
|
139
|
+
|
|
140
|
+
<li class="public ">
|
|
141
|
+
<span class="summary_signature">
|
|
142
|
+
|
|
143
|
+
<a href="#generate-instance_method" title="#generate (instance method)">#<strong>generate</strong> ⇒ Hash </a>
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
</span>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<span class="summary_desc"><div class='inline'>
|
|
158
|
+
<p>Generate the payload for <tt>{ meta: { stats: { … } } }</tt> Loops over all
|
|
159
|
+
calculations, computes then, and gives back a hash of stats and their
|
|
160
|
+
results.</p>
|
|
161
|
+
</div></span>
|
|
162
|
+
|
|
163
|
+
</li>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
<li class="public ">
|
|
167
|
+
<span class="summary_signature">
|
|
168
|
+
|
|
169
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(resource, query_hash, scope) ⇒ Payload </a>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
</span>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<span class="note title constructor">constructor</span>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
<span class="summary_desc"><div class='inline'>
|
|
186
|
+
<p>A new instance of Payload.</p>
|
|
187
|
+
</div></span>
|
|
188
|
+
|
|
189
|
+
</li>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
</ul>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
<div id="constructor_details" class="method_details_list">
|
|
196
|
+
<h2>Constructor Details</h2>
|
|
197
|
+
|
|
198
|
+
<div class="method_details first">
|
|
199
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
200
|
+
|
|
201
|
+
#<strong>initialize</strong>(resource, query_hash, scope) ⇒ <tt><span class='object_link'><a href="" title="JsonapiCompliable::Stats::Payload (class)">Payload</a></span></tt>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
</h3><div class="docstring">
|
|
208
|
+
<div class="discussion">
|
|
209
|
+
|
|
210
|
+
<p>Returns a new instance of Payload</p>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
</div>
|
|
214
|
+
</div>
|
|
215
|
+
<div class="tags">
|
|
216
|
+
<p class="tag_title">Parameters:</p>
|
|
217
|
+
<ul class="param">
|
|
218
|
+
|
|
219
|
+
<li>
|
|
220
|
+
|
|
221
|
+
<span class='name'>resource</span>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Resource.html" title="JsonapiCompliable::Resource (class)">Resource</a></span></tt>)</span>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
—
|
|
229
|
+
<div class='inline'>
|
|
230
|
+
<p>the resource instance</p>
|
|
231
|
+
</div>
|
|
232
|
+
|
|
233
|
+
</li>
|
|
234
|
+
|
|
235
|
+
<li>
|
|
236
|
+
|
|
237
|
+
<span class='name'>query_hash</span>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
—
|
|
245
|
+
<div class='inline'>
|
|
246
|
+
<p>the Query#to_hash for the current resource</p>
|
|
247
|
+
</div>
|
|
248
|
+
|
|
249
|
+
</li>
|
|
250
|
+
|
|
251
|
+
<li>
|
|
252
|
+
|
|
253
|
+
<span class='name'>scope</span>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
<span class='type'></span>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
—
|
|
261
|
+
<div class='inline'>
|
|
262
|
+
<p>the scope we are chaining/modifying</p>
|
|
263
|
+
</div>
|
|
264
|
+
|
|
265
|
+
</li>
|
|
266
|
+
|
|
267
|
+
</ul>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
</div><table class="source_code">
|
|
271
|
+
<tr>
|
|
272
|
+
<td>
|
|
273
|
+
<pre class="lines">
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
20
|
|
277
|
+
21
|
|
278
|
+
22
|
|
279
|
+
23
|
|
280
|
+
24</pre>
|
|
281
|
+
</td>
|
|
282
|
+
<td>
|
|
283
|
+
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/stats/payload.rb', line 20</span>
|
|
284
|
+
|
|
285
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_query_hash'>query_hash</span><span class='comma'>,</span> <span class='id identifier rubyid_scope'>scope</span><span class='rparen'>)</span>
|
|
286
|
+
<span class='ivar'>@resource</span> <span class='op'>=</span> <span class='id identifier rubyid_resource'>resource</span>
|
|
287
|
+
<span class='ivar'>@query_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_query_hash'>query_hash</span><span class='lbracket'>[</span><span class='symbol'>:stats</span><span class='rbracket'>]</span>
|
|
288
|
+
<span class='ivar'>@scope</span> <span class='op'>=</span> <span class='id identifier rubyid_scope'>scope</span>
|
|
289
|
+
<span class='kw'>end</span></pre>
|
|
290
|
+
</td>
|
|
291
|
+
</tr>
|
|
292
|
+
</table>
|
|
293
|
+
</div>
|
|
294
|
+
|
|
295
|
+
</div>
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
<div id="instance_method_details" class="method_details_list">
|
|
299
|
+
<h2>Instance Method Details</h2>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
<div class="method_details first">
|
|
303
|
+
<h3 class="signature first" id="generate-instance_method">
|
|
304
|
+
|
|
305
|
+
#<strong>generate</strong> ⇒ <tt>Hash</tt>
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
</h3><div class="docstring">
|
|
312
|
+
<div class="discussion">
|
|
313
|
+
|
|
314
|
+
<p>Generate the payload for <tt>{ meta: { stats: { … } } }</tt> Loops over all
|
|
315
|
+
calculations, computes then, and gives back a hash of stats and their
|
|
316
|
+
results.</p>
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
</div>
|
|
320
|
+
</div>
|
|
321
|
+
<div class="tags">
|
|
322
|
+
|
|
323
|
+
<p class="tag_title">Returns:</p>
|
|
324
|
+
<ul class="return">
|
|
325
|
+
|
|
326
|
+
<li>
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
—
|
|
334
|
+
<div class='inline'>
|
|
335
|
+
<p>the generated payload</p>
|
|
336
|
+
</div>
|
|
337
|
+
|
|
338
|
+
</li>
|
|
339
|
+
|
|
340
|
+
</ul>
|
|
341
|
+
|
|
342
|
+
</div><table class="source_code">
|
|
343
|
+
<tr>
|
|
344
|
+
<td>
|
|
345
|
+
<pre class="lines">
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
30
|
|
349
|
+
31
|
|
350
|
+
32
|
|
351
|
+
33
|
|
352
|
+
34
|
|
353
|
+
35
|
|
354
|
+
36
|
|
355
|
+
37
|
|
356
|
+
38
|
|
357
|
+
39
|
|
358
|
+
40</pre>
|
|
359
|
+
</td>
|
|
360
|
+
<td>
|
|
361
|
+
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/stats/payload.rb', line 30</span>
|
|
362
|
+
|
|
363
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_generate'>generate</span>
|
|
364
|
+
<span class='lbrace'>{</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_stats'>stats</span><span class='op'>|</span>
|
|
365
|
+
<span class='ivar'>@query_hash</span><span class='period'>.</span><span class='id identifier rubyid_each_pair'>each_pair</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_calculation'>calculation</span><span class='op'>|</span>
|
|
366
|
+
<span class='id identifier rubyid_stats'>stats</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
367
|
+
|
|
368
|
+
<span class='id identifier rubyid_each_calculation'>each_calculation</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_calculation'>calculation</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_calc'>calc</span><span class='comma'>,</span> <span class='id identifier rubyid_function'>function</span><span class='op'>|</span>
|
|
369
|
+
<span class='id identifier rubyid_stats'>stats</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_calc'>calc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_function'>function</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='ivar'>@scope</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
|
370
|
+
<span class='kw'>end</span>
|
|
371
|
+
<span class='kw'>end</span>
|
|
372
|
+
<span class='kw'>end</span>
|
|
373
|
+
<span class='kw'>end</span></pre>
|
|
374
|
+
</td>
|
|
375
|
+
</tr>
|
|
376
|
+
</table>
|
|
377
|
+
</div>
|
|
378
|
+
|
|
379
|
+
</div>
|
|
380
|
+
|
|
381
|
+
</div>
|
|
382
|
+
|
|
383
|
+
<div id="footer">
|
|
384
|
+
Generated on Fri May 5 15:53:23 2017 by
|
|
385
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
386
|
+
0.9.9 (ruby-2.3.0).
|
|
387
|
+
</div>
|
|
388
|
+
|
|
389
|
+
</div>
|
|
390
|
+
</body>
|
|
391
|
+
</html>
|
|
@@ -0,0 +1,117 @@
|
|
|
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: JsonapiCompliable::Util
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.9
|
|
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 = "JsonapiCompliable::Util";
|
|
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 (U)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Util</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: JsonapiCompliable::Util
|
|
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/jsonapi_compliable/util/hash.rb<span class="defines">,<br />
|
|
82
|
+
lib/jsonapi_compliable/util/field_params.rb,<br /> lib/jsonapi_compliable/util/include_params.rb,<br /> lib/jsonapi_compliable/util/render_options.rb,<br /> lib/jsonapi_compliable/util/relationship_payload.rb</span>
|
|
83
|
+
</dd>
|
|
84
|
+
</dl>
|
|
85
|
+
|
|
86
|
+
</div>
|
|
87
|
+
|
|
88
|
+
<h2>Defined Under Namespace</h2>
|
|
89
|
+
<p class="children">
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Util/FieldParams.html" title="JsonapiCompliable::Util::FieldParams (class)">FieldParams</a></span>, <span class='object_link'><a href="Util/Hash.html" title="JsonapiCompliable::Util::Hash (class)">Hash</a></span>, <span class='object_link'><a href="Util/IncludeParams.html" title="JsonapiCompliable::Util::IncludeParams (class)">IncludeParams</a></span>, <span class='object_link'><a href="Util/Persistence.html" title="JsonapiCompliable::Util::Persistence (class)">Persistence</a></span>, <span class='object_link'><a href="Util/RelationshipPayload.html" title="JsonapiCompliable::Util::RelationshipPayload (class)">RelationshipPayload</a></span>, <span class='object_link'><a href="Util/RenderOptions.html" title="JsonapiCompliable::Util::RenderOptions (class)">RenderOptions</a></span>, <span class='object_link'><a href="Util/ValidationResponse.html" title="JsonapiCompliable::Util::ValidationResponse (class)">ValidationResponse</a></span>
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
</p>
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
|
|
109
|
+
<div id="footer">
|
|
110
|
+
Generated on Fri May 5 15:53:21 2017 by
|
|
111
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
112
|
+
0.9.9 (ruby-2.3.0).
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
</body>
|
|
117
|
+
</html>
|