kabk 0.2.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.
Potentially problematic release.
This version of kabk might be problematic. Click here for more details.
- checksums.yaml +7 -0
- data/CHANGELOG.md +27 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +108 -0
- data/Kabk_logo.svg +33 -0
- data/LICENSE +21 -0
- data/README.md +101 -0
- data/doc/Kabk/Adapters/Base.html +854 -0
- data/doc/Kabk/Adapters/SequelAdapter.html +948 -0
- data/doc/Kabk/Adapters.html +120 -0
- data/doc/Kabk/ApiError.html +511 -0
- data/doc/Kabk/Auth/JwtStrategy.html +551 -0
- data/doc/Kabk/Auth.html +118 -0
- data/doc/Kabk/Concurrency.html +297 -0
- data/doc/Kabk/ConcurrencyConflictError.html +225 -0
- data/doc/Kabk/Error.html +140 -0
- data/doc/Kabk/ExportHandler.html +381 -0
- data/doc/Kabk/Field.html +2160 -0
- data/doc/Kabk/ForbiddenError.html +225 -0
- data/doc/Kabk/InvalidFieldError.html +136 -0
- data/doc/Kabk/InvalidOldPasswordError.html +225 -0
- data/doc/Kabk/NotFoundError.html +225 -0
- data/doc/Kabk/QueryBuilder.html +551 -0
- data/doc/Kabk/Registry.html +608 -0
- data/doc/Kabk/RelationHydrator.html +480 -0
- data/doc/Kabk/Resource.html +1986 -0
- data/doc/Kabk/ResourceBuilder.html +1002 -0
- data/doc/Kabk/RestEngine.html +879 -0
- data/doc/Kabk/SchemaRenderer.html +318 -0
- data/doc/Kabk/UnauthorizedError.html +225 -0
- data/doc/Kabk/UploadHandler.html +308 -0
- data/doc/Kabk/ValidationError.html +225 -0
- data/doc/Kabk/Validator.html +380 -0
- data/doc/Kabk.html +330 -0
- data/doc/_index.html +376 -0
- data/doc/class_list.html +54 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +206 -0
- data/doc/css/style.css +1089 -0
- data/doc/file.README.html +149 -0
- data/doc/file_list.html +59 -0
- data/doc/frames.html +22 -0
- data/doc/index.html +149 -0
- data/doc/js/app.js +801 -0
- data/doc/js/full_list.js +334 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +910 -0
- data/doc/top-level-namespace.html +112 -0
- data/docs/API_REFERENCE.md +241 -0
- data/lib/kabk/adapters/base.rb +45 -0
- data/lib/kabk/adapters/sequel_adapter.rb +125 -0
- data/lib/kabk/concurrency.rb +30 -0
- data/lib/kabk/errors.rb +62 -0
- data/lib/kabk/export_handler.rb +43 -0
- data/lib/kabk/field.rb +97 -0
- data/lib/kabk/query_builder.rb +72 -0
- data/lib/kabk/registry.rb +41 -0
- data/lib/kabk/relation_hydrator.rb +107 -0
- data/lib/kabk/resource.rb +88 -0
- data/lib/kabk/resource_builder.rb +93 -0
- data/lib/kabk/rest_engine.rb +84 -0
- data/lib/kabk/schema_renderer.rb +69 -0
- data/lib/kabk/upload_handler.rb +24 -0
- data/lib/kabk/validator.rb +64 -0
- data/lib/kabk/version.rb +6 -0
- data/lib/kabk.rb +51 -0
- metadata +193 -0
|
@@ -0,0 +1,551 @@
|
|
|
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: Kabk::QueryBuilder
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.45
|
|
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 = "Kabk::QueryBuilder";
|
|
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 id="main_progress" aria-hidden="true"></div>
|
|
31
|
+
|
|
32
|
+
<div class="nav_wrap">
|
|
33
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
34
|
+
<div id="resizer"></div>
|
|
35
|
+
</div>
|
|
36
|
+
|
|
37
|
+
<div id="main" tabindex="-1">
|
|
38
|
+
<div id="header">
|
|
39
|
+
<div id="menu">
|
|
40
|
+
|
|
41
|
+
<a href="../_index.html">Index (Q)</a> »
|
|
42
|
+
<span class='title'><span class='object_link'><a href="../Kabk.html" title="Kabk (module)">Kabk</a></span></span>
|
|
43
|
+
»
|
|
44
|
+
<span class="title">QueryBuilder</span>
|
|
45
|
+
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
<div id="search">
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="class_list_link"
|
|
51
|
+
href="../class_list.html">
|
|
52
|
+
|
|
53
|
+
<svg width="24" height="24">
|
|
54
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
56
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
57
|
+
</svg>
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<div id="content"><h1>Class: Kabk::QueryBuilder
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</h1>
|
|
69
|
+
<div class="box_info">
|
|
70
|
+
|
|
71
|
+
<dl>
|
|
72
|
+
<dt>Inherits:</dt>
|
|
73
|
+
<dd>
|
|
74
|
+
<span class="inheritName">Object</span>
|
|
75
|
+
|
|
76
|
+
<ul class="fullTree">
|
|
77
|
+
<li>Object</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">Kabk::QueryBuilder</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/kabk/query_builder.rb
|
|
100
|
+
</dd>
|
|
101
|
+
</dl>
|
|
102
|
+
|
|
103
|
+
</div>
|
|
104
|
+
|
|
105
|
+
<h2>Overview</h2><div class="docstring">
|
|
106
|
+
<div class="discussion">
|
|
107
|
+
<p>Handles applying page, sort, search, and filters to a Sequel dataset</p>
|
|
108
|
+
|
|
109
|
+
</div>
|
|
110
|
+
</div>
|
|
111
|
+
<div class="tags">
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
</div>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<h2>
|
|
123
|
+
Class Method Summary
|
|
124
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
125
|
+
</h2>
|
|
126
|
+
|
|
127
|
+
<ul class="summary">
|
|
128
|
+
|
|
129
|
+
<li class="public ">
|
|
130
|
+
<span class="summary_signature">
|
|
131
|
+
|
|
132
|
+
<a href="#apply_filters-class_method" title="apply_filters (class method)">.<strong>apply_filters</strong>(dataset, _resource, filters) ⇒ Object </a>
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
</span>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
147
|
+
|
|
148
|
+
</li>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
<li class="public ">
|
|
152
|
+
<span class="summary_signature">
|
|
153
|
+
|
|
154
|
+
<a href="#apply_pagination-class_method" title="apply_pagination (class method)">.<strong>apply_pagination</strong>(dataset, resource, params) ⇒ Object </a>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
</span>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
169
|
+
|
|
170
|
+
</li>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<li class="public ">
|
|
174
|
+
<span class="summary_signature">
|
|
175
|
+
|
|
176
|
+
<a href="#apply_search-class_method" title="apply_search (class method)">.<strong>apply_search</strong>(dataset, resource, search_term) ⇒ Object </a>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</span>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
191
|
+
|
|
192
|
+
</li>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
<li class="public ">
|
|
196
|
+
<span class="summary_signature">
|
|
197
|
+
|
|
198
|
+
<a href="#apply_sort-class_method" title="apply_sort (class method)">.<strong>apply_sort</strong>(dataset, resource, sort_term) ⇒ Object </a>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
</span>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
213
|
+
|
|
214
|
+
</li>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
<li class="public ">
|
|
218
|
+
<span class="summary_signature">
|
|
219
|
+
|
|
220
|
+
<a href="#build-class_method" title="build (class method)">.<strong>build</strong>(resource, params) ⇒ Sequel::Dataset </a>
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
</span>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<span class="summary_desc"><div class='inline'><p>Paginated dataset.</p></div></span>
|
|
235
|
+
|
|
236
|
+
</li>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
</ul>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<div id="class_method_details" class="method_details_list">
|
|
246
|
+
<h2>Class Method Details</h2>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<div class="method_details first">
|
|
250
|
+
<h3 class="signature first" id="apply_filters-class_method">
|
|
251
|
+
|
|
252
|
+
.<strong>apply_filters</strong>(dataset, _resource, filters) ⇒ <tt>Object</tt>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
</h3><table class="source_code">
|
|
259
|
+
<tr>
|
|
260
|
+
<td>
|
|
261
|
+
<pre class="lines">
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
31
|
|
265
|
+
32
|
|
266
|
+
33
|
|
267
|
+
34
|
|
268
|
+
35
|
|
269
|
+
36
|
|
270
|
+
37
|
|
271
|
+
38
|
|
272
|
+
39
|
|
273
|
+
40
|
|
274
|
+
41
|
|
275
|
+
42
|
|
276
|
+
43
|
|
277
|
+
44</pre>
|
|
278
|
+
</td>
|
|
279
|
+
<td>
|
|
280
|
+
<pre class="code"><span class="info file"># File 'lib/kabk/query_builder.rb', line 31</span>
|
|
281
|
+
|
|
282
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_apply_filters'>apply_filters</span><span class='lparen'>(</span><span class='id identifier rubyid_dataset'>dataset</span><span class='comma'>,</span> <span class='id identifier rubyid__resource'>_resource</span><span class='comma'>,</span> <span class='id identifier rubyid_filters'>filters</span><span class='rparen'>)</span>
|
|
283
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_dataset'>dataset</span> <span class='kw'>unless</span> <span class='id identifier rubyid_filters'>filters</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
|
|
284
|
+
|
|
285
|
+
<span class='id identifier rubyid_filters'>filters</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_field'>field</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
|
|
286
|
+
<span class='comment'># Parse comma-separated values to support SQL IN clauses.
|
|
287
|
+
</span> <span class='id identifier rubyid_values'>values</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>,</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
288
|
+
<span class='id identifier rubyid_dataset'>dataset</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>></span> <span class='int'>1</span>
|
|
289
|
+
<span class='id identifier rubyid_dataset'>dataset</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='id identifier rubyid_field'>field</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='op'>=></span> <span class='id identifier rubyid_values'>values</span><span class='rparen'>)</span>
|
|
290
|
+
<span class='kw'>else</span>
|
|
291
|
+
<span class='id identifier rubyid_dataset'>dataset</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='id identifier rubyid_field'>field</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='op'>=></span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
292
|
+
<span class='kw'>end</span>
|
|
293
|
+
<span class='kw'>end</span>
|
|
294
|
+
<span class='id identifier rubyid_dataset'>dataset</span>
|
|
295
|
+
<span class='kw'>end</span></pre>
|
|
296
|
+
</td>
|
|
297
|
+
</tr>
|
|
298
|
+
</table>
|
|
299
|
+
</div>
|
|
300
|
+
|
|
301
|
+
<div class="method_details ">
|
|
302
|
+
<h3 class="signature " id="apply_pagination-class_method">
|
|
303
|
+
|
|
304
|
+
.<strong>apply_pagination</strong>(dataset, resource, params) ⇒ <tt>Object</tt>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</h3><table class="source_code">
|
|
311
|
+
<tr>
|
|
312
|
+
<td>
|
|
313
|
+
<pre class="lines">
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
60
|
|
317
|
+
61
|
|
318
|
+
62
|
|
319
|
+
63
|
|
320
|
+
64
|
|
321
|
+
65
|
|
322
|
+
66
|
|
323
|
+
67
|
|
324
|
+
68
|
|
325
|
+
69
|
|
326
|
+
70</pre>
|
|
327
|
+
</td>
|
|
328
|
+
<td>
|
|
329
|
+
<pre class="code"><span class="info file"># File 'lib/kabk/query_builder.rb', line 60</span>
|
|
330
|
+
|
|
331
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_apply_pagination'>apply_pagination</span><span class='lparen'>(</span><span class='id identifier rubyid_dataset'>dataset</span><span class='comma'>,</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
332
|
+
<span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>1</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
|
|
333
|
+
<span class='id identifier rubyid_per_page'>per_page</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>per_page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_per_page_default'>per_page_default</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
|
|
334
|
+
|
|
335
|
+
<span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='int'>1</span> <span class='kw'>if</span> <span class='id identifier rubyid_page'>page</span> <span class='op'><</span> <span class='int'>1</span>
|
|
336
|
+
<span class='id identifier rubyid_per_page'>per_page</span> <span class='op'>=</span> <span class='int'>15</span> <span class='kw'>if</span> <span class='id identifier rubyid_per_page'>per_page</span> <span class='op'><</span> <span class='int'>1</span>
|
|
337
|
+
|
|
338
|
+
<span class='comment'># Depends on Sequel's pagination extension (Sequel.extension :pagination).
|
|
339
|
+
</span> <span class='comment'># Returns a paginated Sequel::Dataset.
|
|
340
|
+
</span> <span class='id identifier rubyid_dataset'>dataset</span><span class='period'>.</span><span class='id identifier rubyid_extension'>extension</span><span class='lparen'>(</span><span class='symbol'>:pagination</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_paginate'>paginate</span><span class='lparen'>(</span><span class='id identifier rubyid_page'>page</span><span class='comma'>,</span> <span class='id identifier rubyid_per_page'>per_page</span><span class='rparen'>)</span>
|
|
341
|
+
<span class='kw'>end</span></pre>
|
|
342
|
+
</td>
|
|
343
|
+
</tr>
|
|
344
|
+
</table>
|
|
345
|
+
</div>
|
|
346
|
+
|
|
347
|
+
<div class="method_details ">
|
|
348
|
+
<h3 class="signature " id="apply_search-class_method">
|
|
349
|
+
|
|
350
|
+
.<strong>apply_search</strong>(dataset, resource, search_term) ⇒ <tt>Object</tt>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
</h3><table class="source_code">
|
|
357
|
+
<tr>
|
|
358
|
+
<td>
|
|
359
|
+
<pre class="lines">
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
19
|
|
363
|
+
20
|
|
364
|
+
21
|
|
365
|
+
22
|
|
366
|
+
23
|
|
367
|
+
24
|
|
368
|
+
25
|
|
369
|
+
26
|
|
370
|
+
27
|
|
371
|
+
28
|
|
372
|
+
29</pre>
|
|
373
|
+
</td>
|
|
374
|
+
<td>
|
|
375
|
+
<pre class="code"><span class="info file"># File 'lib/kabk/query_builder.rb', line 19</span>
|
|
376
|
+
|
|
377
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_apply_search'>apply_search</span><span class='lparen'>(</span><span class='id identifier rubyid_dataset'>dataset</span><span class='comma'>,</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_search_term'>search_term</span><span class='rparen'>)</span>
|
|
378
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_dataset'>dataset</span> <span class='kw'>if</span> <span class='id identifier rubyid_search_term'>search_term</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_search_term'>search_term</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
379
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_dataset'>dataset</span> <span class='kw'>if</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_searchable_fields'>searchable_fields</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_searchable_fields'>searchable_fields</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
380
|
+
|
|
381
|
+
<span class='comment'># Apply case-insensitive global search across all searchable fields.
|
|
382
|
+
</span> <span class='id identifier rubyid_search_conditions'>search_conditions</span> <span class='op'>=</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_searchable_fields'>searchable_fields</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_field'>field</span><span class='op'>|</span>
|
|
383
|
+
<span class='const'>Sequel</span><span class='period'>.</span><span class='id identifier rubyid_ilike'>ilike</span><span class='lparen'>(</span><span class='id identifier rubyid_field'>field</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_search_term'>search_term</span><span class='embexpr_end'>}</span><span class='tstring_content'>%</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
384
|
+
<span class='kw'>end</span>
|
|
385
|
+
|
|
386
|
+
<span class='id identifier rubyid_dataset'>dataset</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='const'>Sequel</span><span class='period'>.</span><span class='op'>|</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_search_conditions'>search_conditions</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
387
|
+
<span class='kw'>end</span></pre>
|
|
388
|
+
</td>
|
|
389
|
+
</tr>
|
|
390
|
+
</table>
|
|
391
|
+
</div>
|
|
392
|
+
|
|
393
|
+
<div class="method_details ">
|
|
394
|
+
<h3 class="signature " id="apply_sort-class_method">
|
|
395
|
+
|
|
396
|
+
.<strong>apply_sort</strong>(dataset, resource, sort_term) ⇒ <tt>Object</tt>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
</h3><table class="source_code">
|
|
403
|
+
<tr>
|
|
404
|
+
<td>
|
|
405
|
+
<pre class="lines">
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
46
|
|
409
|
+
47
|
|
410
|
+
48
|
|
411
|
+
49
|
|
412
|
+
50
|
|
413
|
+
51
|
|
414
|
+
52
|
|
415
|
+
53
|
|
416
|
+
54
|
|
417
|
+
55
|
|
418
|
+
56
|
|
419
|
+
57
|
|
420
|
+
58</pre>
|
|
421
|
+
</td>
|
|
422
|
+
<td>
|
|
423
|
+
<pre class="code"><span class="info file"># File 'lib/kabk/query_builder.rb', line 46</span>
|
|
424
|
+
|
|
425
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_apply_sort'>apply_sort</span><span class='lparen'>(</span><span class='id identifier rubyid_dataset'>dataset</span><span class='comma'>,</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_sort_term'>sort_term</span><span class='rparen'>)</span>
|
|
426
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_dataset'>dataset</span> <span class='kw'>if</span> <span class='id identifier rubyid_sort_term'>sort_term</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_sort_term'>sort_term</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
427
|
+
|
|
428
|
+
<span class='id identifier rubyid_is_desc'>is_desc</span> <span class='op'>=</span> <span class='id identifier rubyid_sort_term'>sort_term</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>-</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
429
|
+
<span class='id identifier rubyid_field_name'>field_name</span> <span class='op'>=</span> <span class='id identifier rubyid_is_desc'>is_desc</span> <span class='op'>?</span> <span class='id identifier rubyid_sort_term'>sort_term</span><span class='lbracket'>[</span><span class='int'>1</span><span class='op'>..</span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='id identifier rubyid_sort_term'>sort_term</span>
|
|
430
|
+
|
|
431
|
+
<span class='comment'># Ensure sorting is only applied to permitted fields.
|
|
432
|
+
</span> <span class='kw'>if</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_sortable_fields'>sortable_fields</span><span class='op'>&.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_field_name'>field_name</span><span class='rparen'>)</span>
|
|
433
|
+
<span class='id identifier rubyid_col'>col</span> <span class='op'>=</span> <span class='id identifier rubyid_field_name'>field_name</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
|
|
434
|
+
<span class='id identifier rubyid_dataset'>dataset</span> <span class='op'>=</span> <span class='id identifier rubyid_is_desc'>is_desc</span> <span class='op'>?</span> <span class='id identifier rubyid_dataset'>dataset</span><span class='period'>.</span><span class='id identifier rubyid_order'>order</span><span class='lparen'>(</span><span class='const'>Sequel</span><span class='period'>.</span><span class='id identifier rubyid_desc'>desc</span><span class='lparen'>(</span><span class='id identifier rubyid_col'>col</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_dataset'>dataset</span><span class='period'>.</span><span class='id identifier rubyid_order'>order</span><span class='lparen'>(</span><span class='const'>Sequel</span><span class='period'>.</span><span class='id identifier rubyid_asc'>asc</span><span class='lparen'>(</span><span class='id identifier rubyid_col'>col</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
435
|
+
<span class='kw'>end</span>
|
|
436
|
+
<span class='id identifier rubyid_dataset'>dataset</span>
|
|
437
|
+
<span class='kw'>end</span></pre>
|
|
438
|
+
</td>
|
|
439
|
+
</tr>
|
|
440
|
+
</table>
|
|
441
|
+
</div>
|
|
442
|
+
|
|
443
|
+
<div class="method_details ">
|
|
444
|
+
<h3 class="signature " id="build-class_method">
|
|
445
|
+
|
|
446
|
+
.<strong>build</strong>(resource, params) ⇒ <tt>Sequel::Dataset</tt>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
</h3><div class="docstring">
|
|
453
|
+
<div class="discussion">
|
|
454
|
+
<p>Returns Paginated dataset.</p>
|
|
455
|
+
|
|
456
|
+
</div>
|
|
457
|
+
</div>
|
|
458
|
+
<div class="tags">
|
|
459
|
+
<p class="tag_title">Parameters:</p>
|
|
460
|
+
<ul class="param">
|
|
461
|
+
|
|
462
|
+
<li>
|
|
463
|
+
|
|
464
|
+
<span class='name'>resource</span>
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
<span class='type'>(<tt><span class='object_link'><a href="Resource.html" title="Kabk::Resource (class)">Kabk::Resource</a></span></tt>)</span>
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
</li>
|
|
472
|
+
|
|
473
|
+
<li>
|
|
474
|
+
|
|
475
|
+
<span class='name'>params</span>
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
—
|
|
483
|
+
<div class='inline'><p>Request query parameters</p></div>
|
|
484
|
+
|
|
485
|
+
</li>
|
|
486
|
+
|
|
487
|
+
</ul>
|
|
488
|
+
|
|
489
|
+
<p class="tag_title">Returns:</p>
|
|
490
|
+
<ul class="return">
|
|
491
|
+
|
|
492
|
+
<li>
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
<span class='type'>(<tt>Sequel::Dataset</tt>)</span>
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
—
|
|
500
|
+
<div class='inline'><p>Paginated dataset</p></div>
|
|
501
|
+
|
|
502
|
+
</li>
|
|
503
|
+
|
|
504
|
+
</ul>
|
|
505
|
+
|
|
506
|
+
</div><table class="source_code">
|
|
507
|
+
<tr>
|
|
508
|
+
<td>
|
|
509
|
+
<pre class="lines">
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
9
|
|
513
|
+
10
|
|
514
|
+
11
|
|
515
|
+
12
|
|
516
|
+
13
|
|
517
|
+
14
|
|
518
|
+
15
|
|
519
|
+
16
|
|
520
|
+
17</pre>
|
|
521
|
+
</td>
|
|
522
|
+
<td>
|
|
523
|
+
<pre class="code"><span class="info file"># File 'lib/kabk/query_builder.rb', line 9</span>
|
|
524
|
+
|
|
525
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
526
|
+
<span class='id identifier rubyid_dataset'>dataset</span> <span class='op'>=</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_model_class'>model_class</span><span class='period'>.</span><span class='id identifier rubyid_dataset'>dataset</span>
|
|
527
|
+
|
|
528
|
+
<span class='id identifier rubyid_dataset'>dataset</span> <span class='op'>=</span> <span class='id identifier rubyid_apply_search'>apply_search</span><span class='lparen'>(</span><span class='id identifier rubyid_dataset'>dataset</span><span class='comma'>,</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>search</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
529
|
+
<span class='id identifier rubyid_dataset'>dataset</span> <span class='op'>=</span> <span class='id identifier rubyid_apply_filters'>apply_filters</span><span class='lparen'>(</span><span class='id identifier rubyid_dataset'>dataset</span><span class='comma'>,</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>filter</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
530
|
+
<span class='id identifier rubyid_dataset'>dataset</span> <span class='op'>=</span> <span class='id identifier rubyid_apply_sort'>apply_sort</span><span class='lparen'>(</span><span class='id identifier rubyid_dataset'>dataset</span><span class='comma'>,</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sort</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_default_sort'>default_sort</span><span class='rparen'>)</span>
|
|
531
|
+
|
|
532
|
+
<span class='id identifier rubyid_apply_pagination'>apply_pagination</span><span class='lparen'>(</span><span class='id identifier rubyid_dataset'>dataset</span><span class='comma'>,</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
533
|
+
<span class='kw'>end</span></pre>
|
|
534
|
+
</td>
|
|
535
|
+
</tr>
|
|
536
|
+
</table>
|
|
537
|
+
</div>
|
|
538
|
+
|
|
539
|
+
</div>
|
|
540
|
+
|
|
541
|
+
</div>
|
|
542
|
+
|
|
543
|
+
<div id="footer">
|
|
544
|
+
Generated on Tue Aug 11 21:17:07 2026 by
|
|
545
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
546
|
+
0.9.45 (ruby-4.0.6).
|
|
547
|
+
</div>
|
|
548
|
+
|
|
549
|
+
</div>
|
|
550
|
+
</body>
|
|
551
|
+
</html>
|