inquery 0.0.1 → 0.1.0
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/.travis.yml +0 -2
- data/README.md +11 -2
- data/RUBY_VERSION +1 -1
- data/Rakefile +1 -1
- data/VERSION +1 -1
- data/doc/Inquery.html +38 -38
- data/doc/Inquery/Exceptions.html +38 -38
- data/doc/Inquery/Exceptions/Base.html +44 -43
- data/doc/Inquery/Exceptions/InvalidRelation.html +44 -43
- data/doc/Inquery/Exceptions/UnknownCallSignature.html +44 -43
- data/doc/Inquery/Mixins.html +38 -38
- data/doc/Inquery/Mixins/RelationValidation.html +70 -73
- data/doc/Inquery/Mixins/RelationValidation/ClassMethods.html +45 -47
- data/doc/Inquery/Mixins/SchemaValidation.html +47 -45
- data/doc/Inquery/Mixins/SchemaValidation/ClassMethods.html +41 -41
- data/doc/Inquery/Query.html +87 -105
- data/doc/Inquery/Query/Chainable.html +66 -73
- data/doc/_index.html +28 -31
- data/doc/class_list.html +24 -31
- data/doc/css/full_list.css +32 -31
- data/doc/css/style.css +244 -91
- data/doc/file.README.html +135 -143
- data/doc/file_list.html +26 -30
- data/doc/frames.html +7 -16
- data/doc/index.html +135 -143
- data/doc/js/app.js +106 -77
- data/doc/js/full_list.js +170 -135
- data/doc/method_list.html +98 -74
- data/doc/top-level-namespace.html +34 -36
- data/inquery.gemspec +44 -44
- metadata +7 -8
data/doc/Inquery/Query.html
CHANGED
@@ -1,12 +1,12 @@
|
|
1
|
-
<!DOCTYPE html
|
2
|
-
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
4
3
|
<head>
|
5
|
-
<meta
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
6
|
<title>
|
7
7
|
Class: Inquery::Query
|
8
8
|
|
9
|
-
— Documentation by YARD 0.
|
9
|
+
— Documentation by YARD 0.9.9
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -15,9 +15,8 @@
|
|
15
15
|
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
16
16
|
|
17
17
|
<script type="text/javascript" charset="utf-8">
|
18
|
-
|
18
|
+
pathId = "Inquery::Query";
|
19
19
|
relpath = '../';
|
20
|
-
framesUrl = "../frames.html#!Inquery/Query.html";
|
21
20
|
</script>
|
22
21
|
|
23
22
|
|
@@ -28,51 +27,48 @@
|
|
28
27
|
|
29
28
|
</head>
|
30
29
|
<body>
|
31
|
-
<div
|
32
|
-
<
|
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">
|
33
38
|
|
34
39
|
<a href="../_index.html">Index (Q)</a> »
|
35
40
|
<span class='title'><span class='object_link'><a href="../Inquery.html" title="Inquery (module)">Inquery</a></span></span>
|
36
41
|
»
|
37
42
|
<span class="title">Query</span>
|
38
43
|
|
39
|
-
|
40
|
-
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
41
44
|
</div>
|
42
45
|
|
43
|
-
|
46
|
+
<div id="search">
|
44
47
|
|
45
48
|
<a class="full_list_link" id="class_list_link"
|
46
49
|
href="../class_list.html">
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
</a>
|
54
|
-
|
55
|
-
<a class="full_list_link" id="file_list_link"
|
56
|
-
href="../file_list.html">
|
57
|
-
File List
|
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>
|
58
56
|
</a>
|
59
57
|
|
60
58
|
</div>
|
61
|
-
|
62
|
-
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
63
61
|
|
64
|
-
|
65
|
-
|
66
|
-
<div id="content"><h1>Class: Inquery::Query
|
62
|
+
<div id="content"><h1>Class: Inquery::Query
|
67
63
|
|
68
64
|
|
69
65
|
|
70
66
|
</h1>
|
71
|
-
|
72
|
-
<dl class="box">
|
67
|
+
<div class="box_info">
|
73
68
|
|
74
|
-
|
75
|
-
<
|
69
|
+
<dl>
|
70
|
+
<dt>Inherits:</dt>
|
71
|
+
<dd>
|
76
72
|
<span class="inheritName">Object</span>
|
77
73
|
|
78
74
|
<ul class="fullTree">
|
@@ -83,25 +79,30 @@
|
|
83
79
|
</ul>
|
84
80
|
<a href="#" class="inheritanceTree">show all</a>
|
85
81
|
|
86
|
-
|
87
|
-
|
82
|
+
</dd>
|
83
|
+
</dl>
|
88
84
|
|
85
|
+
|
89
86
|
|
90
|
-
|
91
87
|
|
92
|
-
|
93
|
-
<dt class="r2">Includes:</dt>
|
94
|
-
<dd class="r2"><span class='object_link'><a href="Mixins/SchemaValidation.html" title="Inquery::Mixins::SchemaValidation (module)">Mixins::SchemaValidation</a></span></dd>
|
95
|
-
|
96
|
-
|
97
88
|
|
98
89
|
|
90
|
+
<dl>
|
91
|
+
<dt>Includes:</dt>
|
92
|
+
<dd><span class='object_link'><a href="Mixins/SchemaValidation.html" title="Inquery::Mixins::SchemaValidation (module)">Mixins::SchemaValidation</a></span></dd>
|
93
|
+
</dl>
|
99
94
|
|
100
|
-
<dt class="r1 last">Defined in:</dt>
|
101
|
-
<dd class="r1 last">lib/inquery/query.rb</dd>
|
102
95
|
|
103
|
-
|
104
|
-
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
|
100
|
+
<dl>
|
101
|
+
<dt>Defined in:</dt>
|
102
|
+
<dd>lib/inquery/query.rb</dd>
|
103
|
+
</dl>
|
104
|
+
|
105
|
+
</div>
|
105
106
|
|
106
107
|
<div id="subclasses">
|
107
108
|
<h2>Direct Known Subclasses</h2>
|
@@ -121,13 +122,13 @@
|
|
121
122
|
|
122
123
|
|
123
124
|
|
124
|
-
<h2>Instance Attribute Summary <small
|
125
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
125
126
|
<ul class="summary">
|
126
127
|
|
127
128
|
<li class="public ">
|
128
129
|
<span class="summary_signature">
|
129
130
|
|
130
|
-
<a href="#params-instance_method" title="#params (instance method)"
|
131
|
+
<a href="#params-instance_method" title="#params (instance method)">#<strong>params</strong> ⇒ Object </a>
|
131
132
|
|
132
133
|
|
133
134
|
|
@@ -146,8 +147,7 @@
|
|
146
147
|
|
147
148
|
|
148
149
|
|
149
|
-
<span class="summary_desc"><div class='inline'>
|
150
|
-
<p>Returns the value of attribute params.</p>
|
150
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute params.</p>
|
151
151
|
</div></span>
|
152
152
|
|
153
153
|
</li>
|
@@ -161,7 +161,7 @@
|
|
161
161
|
|
162
162
|
<h2>
|
163
163
|
Class Method Summary
|
164
|
-
<small
|
164
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
165
165
|
</h2>
|
166
166
|
|
167
167
|
<ul class="summary">
|
@@ -169,7 +169,7 @@
|
|
169
169
|
<li class="public ">
|
170
170
|
<span class="summary_signature">
|
171
171
|
|
172
|
-
<a href="#call-class_method" title="call (class method)"
|
172
|
+
<a href="#call-class_method" title="call (class method)">.<strong>call</strong>(*args) ⇒ Object </a>
|
173
173
|
|
174
174
|
|
175
175
|
|
@@ -183,9 +183,7 @@
|
|
183
183
|
|
184
184
|
|
185
185
|
|
186
|
-
<span class="summary_desc"><div class='inline'>
|
187
|
-
<p>Instantiates the query class using the given arguments and runs
|
188
|
-
<code>call</code> on it.</p>
|
186
|
+
<span class="summary_desc"><div class='inline'><p>Instantiates the query class using the given arguments and runs <code>call</code> on it.</p>
|
189
187
|
</div></span>
|
190
188
|
|
191
189
|
</li>
|
@@ -194,7 +192,7 @@
|
|
194
192
|
<li class="public ">
|
195
193
|
<span class="summary_signature">
|
196
194
|
|
197
|
-
<a href="#run-class_method" title="run (class method)"
|
195
|
+
<a href="#run-class_method" title="run (class method)">.<strong>run</strong>(*args) ⇒ Object </a>
|
198
196
|
|
199
197
|
|
200
198
|
|
@@ -208,9 +206,7 @@
|
|
208
206
|
|
209
207
|
|
210
208
|
|
211
|
-
<span class="summary_desc"><div class='inline'>
|
212
|
-
<p>Instantiates the query class using the given arguments and runs
|
213
|
-
<code>call</code> and <code>process</code> on it.</p>
|
209
|
+
<span class="summary_desc"><div class='inline'><p>Instantiates the query class using the given arguments and runs <code>call</code> and <code>process</code> on it.</p>
|
214
210
|
</div></span>
|
215
211
|
|
216
212
|
</li>
|
@@ -220,7 +216,7 @@
|
|
220
216
|
|
221
217
|
<h2>
|
222
218
|
Instance Method Summary
|
223
|
-
<small
|
219
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
224
220
|
</h2>
|
225
221
|
|
226
222
|
<ul class="summary">
|
@@ -228,7 +224,7 @@
|
|
228
224
|
<li class="public ">
|
229
225
|
<span class="summary_signature">
|
230
226
|
|
231
|
-
<a href="#call-instance_method" title="#call (instance method)"
|
227
|
+
<a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong> ⇒ Object </a>
|
232
228
|
|
233
229
|
|
234
230
|
|
@@ -242,8 +238,7 @@
|
|
242
238
|
|
243
239
|
|
244
240
|
|
245
|
-
<span class="summary_desc"><div class='inline'>
|
246
|
-
<p>Override this method to perform the actual query.</p>
|
241
|
+
<span class="summary_desc"><div class='inline'><p>Override this method to perform the actual query.</p>
|
247
242
|
</div></span>
|
248
243
|
|
249
244
|
</li>
|
@@ -252,7 +247,7 @@
|
|
252
247
|
<li class="public ">
|
253
248
|
<span class="summary_signature">
|
254
249
|
|
255
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)"
|
250
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(params = {}) ⇒ Query </a>
|
256
251
|
|
257
252
|
|
258
253
|
|
@@ -268,9 +263,7 @@
|
|
268
263
|
|
269
264
|
|
270
265
|
|
271
|
-
<span class="summary_desc"><div class='inline'>
|
272
|
-
<p>Instantiates the query class and validates the given params hash (if there
|
273
|
-
was a validation schema specified).</p>
|
266
|
+
<span class="summary_desc"><div class='inline'><p>Instantiates the query class and validates the given params hash (if there was a validation schema specified).</p>
|
274
267
|
</div></span>
|
275
268
|
|
276
269
|
</li>
|
@@ -279,7 +272,7 @@ was a validation schema specified).</p>
|
|
279
272
|
<li class="public ">
|
280
273
|
<span class="summary_signature">
|
281
274
|
|
282
|
-
<a href="#osparams-instance_method" title="#osparams (instance method)"
|
275
|
+
<a href="#osparams-instance_method" title="#osparams (instance method)">#<strong>osparams</strong> ⇒ Object </a>
|
283
276
|
|
284
277
|
|
285
278
|
|
@@ -293,9 +286,7 @@ was a validation schema specified).</p>
|
|
293
286
|
|
294
287
|
|
295
288
|
|
296
|
-
<span class="summary_desc"><div class='inline'>
|
297
|
-
<p>Returns a copy of the query's params, wrapped in an OpenStruct object
|
298
|
-
for easyer access.</p>
|
289
|
+
<span class="summary_desc"><div class='inline'><p>Returns a copy of the query's params, wrapped in an OpenStruct object for easyer access.</p>
|
299
290
|
</div></span>
|
300
291
|
|
301
292
|
</li>
|
@@ -304,7 +295,7 @@ for easyer access.</p>
|
|
304
295
|
<li class="public ">
|
305
296
|
<span class="summary_signature">
|
306
297
|
|
307
|
-
<a href="#process-instance_method" title="#process (instance method)"
|
298
|
+
<a href="#process-instance_method" title="#process (instance method)">#<strong>process</strong>(results) ⇒ Object </a>
|
308
299
|
|
309
300
|
|
310
301
|
|
@@ -318,8 +309,7 @@ for easyer access.</p>
|
|
318
309
|
|
319
310
|
|
320
311
|
|
321
|
-
<span class="summary_desc"><div class='inline'>
|
322
|
-
<p>Override this method to perform an optional result postprocessing.</p>
|
312
|
+
<span class="summary_desc"><div class='inline'><p>Override this method to perform an optional result postprocessing.</p>
|
323
313
|
</div></span>
|
324
314
|
|
325
315
|
</li>
|
@@ -328,7 +318,7 @@ for easyer access.</p>
|
|
328
318
|
<li class="public ">
|
329
319
|
<span class="summary_signature">
|
330
320
|
|
331
|
-
<a href="#run-instance_method" title="#run (instance method)"
|
321
|
+
<a href="#run-instance_method" title="#run (instance method)">#<strong>run</strong> ⇒ Object </a>
|
332
322
|
|
333
323
|
|
334
324
|
|
@@ -342,8 +332,7 @@ for easyer access.</p>
|
|
342
332
|
|
343
333
|
|
344
334
|
|
345
|
-
<span class="summary_desc"><div class='inline'>
|
346
|
-
<p>Runs both <code>call</code> and <code>process</code>.</p>
|
335
|
+
<span class="summary_desc"><div class='inline'><p>Runs both <code>call</code> and <code>process</code>.</p>
|
347
336
|
</div></span>
|
348
337
|
|
349
338
|
</li>
|
@@ -365,7 +354,7 @@ for easyer access.</p>
|
|
365
354
|
<div class="method_details first">
|
366
355
|
<h3 class="signature first" id="initialize-instance_method">
|
367
356
|
|
368
|
-
|
357
|
+
#<strong>initialize</strong>(params = {}) ⇒ <tt><span class='object_link'><a href="" title="Inquery::Query (class)">Query</a></span></tt>
|
369
358
|
|
370
359
|
|
371
360
|
|
@@ -373,8 +362,7 @@ for easyer access.</p>
|
|
373
362
|
|
374
363
|
</h3><div class="docstring">
|
375
364
|
<div class="discussion">
|
376
|
-
|
377
|
-
<p>Instantiates the query class and validates the given params hash (if there
|
365
|
+
<p>Instantiates the query class and validates the given params hash (if there
|
378
366
|
was a validation schema specified).</p>
|
379
367
|
|
380
368
|
|
@@ -422,7 +410,7 @@ was a validation schema specified).</p>
|
|
422
410
|
<div class="method_details first">
|
423
411
|
<h3 class="signature first" id="params-instance_method">
|
424
412
|
|
425
|
-
|
413
|
+
#<strong>params</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
426
414
|
|
427
415
|
|
428
416
|
|
@@ -430,8 +418,7 @@ was a validation schema specified).</p>
|
|
430
418
|
|
431
419
|
</h3><div class="docstring">
|
432
420
|
<div class="discussion">
|
433
|
-
|
434
|
-
<p>Returns the value of attribute params</p>
|
421
|
+
<p>Returns the value of attribute params</p>
|
435
422
|
|
436
423
|
|
437
424
|
</div>
|
@@ -470,7 +457,7 @@ was a validation schema specified).</p>
|
|
470
457
|
<div class="method_details first">
|
471
458
|
<h3 class="signature first" id="call-class_method">
|
472
459
|
|
473
|
-
|
460
|
+
.<strong>call</strong>(*args) ⇒ <tt>Object</tt>
|
474
461
|
|
475
462
|
|
476
463
|
|
@@ -478,9 +465,8 @@ was a validation schema specified).</p>
|
|
478
465
|
|
479
466
|
</h3><div class="docstring">
|
480
467
|
<div class="discussion">
|
481
|
-
|
482
|
-
<
|
483
|
-
<code>call</code> on it.</p>
|
468
|
+
<p>Instantiates the query class using the given arguments
|
469
|
+
and runs <code>call</code> on it.</p>
|
484
470
|
|
485
471
|
|
486
472
|
</div>
|
@@ -512,7 +498,7 @@ was a validation schema specified).</p>
|
|
512
498
|
<div class="method_details ">
|
513
499
|
<h3 class="signature " id="run-class_method">
|
514
500
|
|
515
|
-
|
501
|
+
.<strong>run</strong>(*args) ⇒ <tt>Object</tt>
|
516
502
|
|
517
503
|
|
518
504
|
|
@@ -520,9 +506,8 @@ was a validation schema specified).</p>
|
|
520
506
|
|
521
507
|
</h3><div class="docstring">
|
522
508
|
<div class="discussion">
|
523
|
-
|
524
|
-
<
|
525
|
-
<code>call</code> and <code>process</code> on it.</p>
|
509
|
+
<p>Instantiates the query class using the given arguments
|
510
|
+
and runs <code>call</code> and <code>process</code> on it.</p>
|
526
511
|
|
527
512
|
|
528
513
|
</div>
|
@@ -560,7 +545,7 @@ was a validation schema specified).</p>
|
|
560
545
|
<div class="method_details first">
|
561
546
|
<h3 class="signature first" id="call-instance_method">
|
562
547
|
|
563
|
-
|
548
|
+
#<strong>call</strong> ⇒ <tt>Object</tt>
|
564
549
|
|
565
550
|
|
566
551
|
|
@@ -568,8 +553,7 @@ was a validation schema specified).</p>
|
|
568
553
|
|
569
554
|
</h3><div class="docstring">
|
570
555
|
<div class="discussion">
|
571
|
-
|
572
|
-
<p>Override this method to perform the actual query.</p>
|
556
|
+
<p>Override this method to perform the actual query.</p>
|
573
557
|
|
574
558
|
|
575
559
|
</div>
|
@@ -601,7 +585,7 @@ was a validation schema specified).</p>
|
|
601
585
|
<div class="method_details ">
|
602
586
|
<h3 class="signature " id="osparams-instance_method">
|
603
587
|
|
604
|
-
|
588
|
+
#<strong>osparams</strong> ⇒ <tt>Object</tt>
|
605
589
|
|
606
590
|
|
607
591
|
|
@@ -609,9 +593,8 @@ was a validation schema specified).</p>
|
|
609
593
|
|
610
594
|
</h3><div class="docstring">
|
611
595
|
<div class="discussion">
|
612
|
-
|
613
|
-
|
614
|
-
for easyer access.</p>
|
596
|
+
<p>Returns a copy of the query's params, wrapped in an OpenStruct object for
|
597
|
+
easyer access.</p>
|
615
598
|
|
616
599
|
|
617
600
|
</div>
|
@@ -643,7 +626,7 @@ for easyer access.</p>
|
|
643
626
|
<div class="method_details ">
|
644
627
|
<h3 class="signature " id="process-instance_method">
|
645
628
|
|
646
|
-
|
629
|
+
#<strong>process</strong>(results) ⇒ <tt>Object</tt>
|
647
630
|
|
648
631
|
|
649
632
|
|
@@ -651,8 +634,7 @@ for easyer access.</p>
|
|
651
634
|
|
652
635
|
</h3><div class="docstring">
|
653
636
|
<div class="discussion">
|
654
|
-
|
655
|
-
<p>Override this method to perform an optional result postprocessing.</p>
|
637
|
+
<p>Override this method to perform an optional result postprocessing.</p>
|
656
638
|
|
657
639
|
|
658
640
|
</div>
|
@@ -684,7 +666,7 @@ for easyer access.</p>
|
|
684
666
|
<div class="method_details ">
|
685
667
|
<h3 class="signature " id="run-instance_method">
|
686
668
|
|
687
|
-
|
669
|
+
#<strong>run</strong> ⇒ <tt>Object</tt>
|
688
670
|
|
689
671
|
|
690
672
|
|
@@ -692,8 +674,7 @@ for easyer access.</p>
|
|
692
674
|
|
693
675
|
</h3><div class="docstring">
|
694
676
|
<div class="discussion">
|
695
|
-
|
696
|
-
<p>Runs both <code>call</code> and <code>process</code>.</p>
|
677
|
+
<p>Runs both <code>call</code> and <code>process</code>.</p>
|
697
678
|
|
698
679
|
|
699
680
|
</div>
|
@@ -726,11 +707,12 @@ for easyer access.</p>
|
|
726
707
|
|
727
708
|
</div>
|
728
709
|
|
729
|
-
|
730
|
-
Generated on
|
710
|
+
<div id="footer">
|
711
|
+
Generated on Tue May 16 10:49:05 2017 by
|
731
712
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
732
|
-
0.
|
713
|
+
0.9.9 (ruby-2.3.1).
|
733
714
|
</div>
|
734
715
|
|
716
|
+
</div>
|
735
717
|
</body>
|
736
718
|
</html>
|