relation.rb
9.51 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
module Searchkick
class Relation
extend Forwardable
attr_reader :klass, :term, :options
def_delegators :execute, :map, :each, :any?, :empty?, :size, :length, :slice, :[], :to_ary,
:records, :results, :suggestions, :each_with_hit, :with_details, :aggregations,
:took, :error, :model_name, :entry_name, :total_count, :total_entries,
:current_page, :per_page, :limit_value, :total_pages, :num_pages,
:offset_value, :previous_page, :prev_page, :next_page, :first_page?, :last_page?,
:out_of_range?, :hits, :response, :to_a, :first, :highlights, :group_by, :misspellings?, :with_highlights
def_delegators :query, :body, :params
def initialize(klass, term = "*", **options)
unknown_keywords = options.keys - [:aggs, :block, :body, :body_options, :boost,
:boost_by, :boost_by_distance, :boost_by_recency, :boost_where, :conversions, :conversions_term, :debug, :emoji, :exclude, :execute, :explain,
:fields, :highlight, :includes, :index_name, :indices_boost, :limit, :load,
:match, :misspellings, :models, :model_includes, :offset, :operator, :order, :padding, :page, :per_page, :profile,
:request_params, :routing, :scope_results, :scroll, :select, :similar, :smart_aggs, :suggest, :total_entries, :track, :type, :where]
raise ArgumentError, "unknown keywords: #{unknown_keywords.join(", ")}" if unknown_keywords.any?
if options[:execute] == false
Searchkick.warn("The execute option is deprecated")
options.delete(:execute)
end
@klass = klass
@term = term
@options = options
end
def where(opts)
spawn.where!(opts)
end
def where!(opts)
opts = sanitize_opts(opts)
if options[:where]
options[:where] = {_and: [options[:where], opts]}
else
options[:where] = opts
end
self
end
def limit(value)
spawn.limit!(value)
end
def limit!(value)
options[:limit] = value
self
end
def offset(*args)
if args.empty?
execute.offset
else
spawn.offset!(*args)
end
end
def offset!(value)
options[:offset] = value
self
end
def order(*args)
spawn.order!(*args)
end
def order!(*args)
options[:order] = Array(options[:order]) + args
self
end
def select(*fields, &block)
if block_given?
# TODO better error message
raise ArgumentError, "too many arguments" if fields.any?
records.select(&block)
else
spawn.select!(*fields)
end
end
# TODO decide how to handle block form
# TODO see how Active Record merges multiple calls
def select!(*fields)
options[:select] = fields.size == 1 ? fields.first : fields
self
end
def page(value)
spawn.page!(value)
end
def page!(value)
options[:page] = value
self
end
def per_page(*args)
if args.empty?
execute.per_page
else
spawn.per_page!(*args)
end
end
alias_method :per, :per_page
def per_page!(value)
options[:per_page] = value
self
end
def padding(*args)
if args.empty?
execute.padding
else
spawn.padding!(*args)
end
end
def padding!(value)
options[:padding] = value
self
end
def fields(*fields)
spawn.fields!(*fields)
end
def fields!(*fields)
options[:fields] = Array(options[:fields]) + fields
self
end
def load(value)
spawn.load!(value)
end
def load!(value)
if value.respond_to?(:call)
options[:load] = true
options[:scope_results] = value
else
options[:load] = value
end
self
end
def includes(*args)
spawn.includes!(*args)
end
def includes!(*args)
options[:includes] = Array(options[:includes]) + args
self
end
def models(*args)
spawn.models!(*args)
end
def models!(*args)
options[:models] = Array(options[:models]) + args
self
end
def model_includes(value)
spawn.model_includes!(value)
end
def model_includes!(value)
options[:model_includes] ||= {}
value.each do |k, v|
options[:model_includes][k] = Array(options[:model_includes][k]) + v
end
self
end
def operator(value)
spawn.operator!(value)
end
def operator!(value)
options[:operator] = value
self
end
# TODO support boost_by(:order, :other)
def boost_by(value)
spawn.boost_by!(value)
end
def boost_by!(value)
options[:boost_by] = value
self
end
def boost_where(value)
spawn.boost_where!(value)
end
# TODO merge options
def boost_where!(value)
options[:boost_where] = value
self
end
def boost_by_recency(value)
spawn.boost_by_recency!(value)
end
# TODO merge options
def boost_by_recency!(value)
options[:boost_by_recency] = value
self
end
def boost_by_distance(value)
spawn.boost_by_distance!(value)
end
# TODO merge options
def boost_by_distance!(value)
options[:boost_by_distance] = value
self
end
def indices_boost(value)
spawn.indices_boost!(value)
end
# TODO merge options
def indices_boost!(value)
options[:indices_boost] = value
self
end
def aggs(*args)
if args.empty?
execute.aggs
else
aggs!(*args)
end
end
# TODO merge options
def aggs!(*args)
options[:aggs] = hash_args(options[:aggs], args)
self
end
def match(value)
spawn.match!(value)
end
def match!(value)
options[:match] = value
self
end
def highlight(value = true)
spawn.highlight!(value)
end
def highlight!(value = true)
options[:highlight] = value
self
end
def scroll(value = nil, &block)
spawn.scroll!(value, &block)
end
def scroll!(value = nil, &block)
options[:scroll] = value if value
if !value && !block
execute.scroll
elsif block
execute.scroll(&block)
else
self
end
end
def routing(value)
spawn.routing!(value)
end
def routing!(value)
options[:routing] = value
self
end
def body_options(value)
spawn.body_options!(value)
end
def body_options!(value)
options[:body_options] = value
self
end
def request_params(value)
spawn.request_params!(value)
end
def request_params!(value)
options[:request_params] = value
self
end
def debug(value = true)
spawn.debug!(value)
end
def debug!(value = true)
options[:debug] = value
self
end
def explain(value = true)
spawn.explain!(value)
end
def explain!(value = true)
options[:explain] = value
self
end
def exclude(*args)
spawn.exclude!(*args)
end
def exclude!(*args)
options[:exclude] = Array(options[:exclude]) + args.flatten
self
end
def misspellings(value)
spawn.misspellings!(value)
end
def misspellings!(value)
options[:misspellings] = value
self
end
def suggest(value = true)
spawn.suggest!(value)
end
def suggest!(value = true)
options[:suggest] = value
self
end
def emoji(value = true)
spawn.emoji!(value)
end
def emoji!(value = true)
options[:emoji] = value
self
end
def smart_aggs(value)
spawn.smart_aggs!(value)
end
def smart_aggs!(value)
options[:smart_aggs] = value
self
end
def type(*args)
spawn.type!(*args)
end
def type!(*args)
options[:type] = Array(options[:type]) + args.flatten
self
end
def conversions(value)
spawn.conversions!(value)
end
def conversions!(value)
options[:conversions] = value
self
end
def conversions_term(value)
spawn.conversions_term!(value)
end
def conversions_term!(value)
options[:conversions_term] = value
self
end
# TODO decide if makes sense to keep
def find_in_batches(batch_size: 1000)
page = 1 # see if page set?
loop do
result = page(page).per(batch_size).execute
yield result.results
page = result.next_page
break if result.last_page?
end
end
# TODO decide if makes sense to keep
def find_each
find_in_batches do |batch|
batch.each do |record|
yield record
end
end
end
# same as Active Record
def inspect
entries = results.first(11).map!(&:inspect)
entries[10] = "..." if entries.size == 11
"#<#{self.class.name} [#{entries.join(', ')}]>"
end
# private
def query
@query ||= Query.new(klass, term, options)
end
# private
# TODO reset when ! methods called
def execute
@execute ||= query.execute
end
private
def hash_args(old, new)
old ||= {}
new.each do |v|
if v.is_a?(Hash)
old.merge!(v)
else
old[v] = {}
end
end
old
end
def sanitize_opts(attributes)
if attributes.respond_to?(:permitted?)
raise ActiveModel::ForbiddenAttributesError if !attributes.permitted?
attributes.to_h
else
attributes
end
end
def spawn
# cannot deep dup due to model classes
Relation.new(klass, term, options.dup)
end
end
end