-
Notifications
You must be signed in to change notification settings - Fork 30
/
tanker.rb
474 lines (394 loc) · 13.6 KB
/
tanker.rb
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
begin
require "rubygems"
require "bundler"
Bundler.setup :default
rescue => e
puts "Tanker: #{e.message}"
end
require 'indextank_client'
require 'tanker/configuration'
require 'tanker/utilities'
if defined? Rails
begin
require 'tanker/railtie'
rescue LoadError
end
end
module Tanker
class NotConfigured < StandardError; end
class BadConfiguration < StandardError; end
class NoBlockGiven < StandardError; end
class NoIndexName < StandardError; end
autoload :Configuration, 'tanker/configuration'
extend Configuration
autoload :Pagination, 'tanker/pagination'
class << self
attr_reader :included_in
def api
@api ||= IndexTank::ApiClient.new(Tanker.configuration[:url])
end
def included(klass)
configuration # raises error if not defined
@included_in ||= []
@included_in << klass
@included_in.uniq!
klass.send :include, InstanceMethods
klass.extend ClassMethods
class << klass
define_method(:per_page) { 10 } unless respond_to?(:per_page)
end
end
def batch_update(records)
return false if records.empty?
data = records.map do |record|
options = record.tanker_index_options
if record.tanker_indexable?
options.merge!( :docid => record.it_doc_id, :fields => record.tanker_index_data )
options
else
nil
end
end.compact
records.first.class.tanker_index.add_documents(data) unless data.empty?
end
def search_results(models, query, options = {})
ids = []
models = [models].flatten.uniq
index = models.first.tanker_index
query = query.join(' ') if Array === query
snippets = options.delete(:snippets)
fetch = options.delete(:fetch)
paginate = extract_setup_paginate_options(options, :page => 1, :per_page => models.first.per_page)
if (index_names = models.map(&:tanker_config).map(&:index_name).uniq).size > 1
raise "You can't search across multiple indexes in one call (#{index_names.inspect})"
end
# move conditions into the query body
if conditions = options.delete(:conditions)
conditions.each do |field, value|
value = [value].flatten.compact
value.each do |item|
query += " #{field}:(#{item})"
end
end
end
# rephrase filter_functions
if filter_functions = options.delete(:filter_functions)
filter_functions.each do |function_number, ranges|
options[:"filter_function#{function_number}"] = ranges.map{|r|r.join(':')}.join(',')
end
end
# rephrase filter_docvars
if filter_docvars = options.delete(:filter_docvars)
filter_docvars.each do |var_number, ranges|
options[:"filter_docvar#{var_number}"] = ranges.map{|r|r.join(':')}.join(',')
end
end
# fetch values from index tank or just the type and id to instace results localy
options[:fetch] = "__type,__id"
options[:fetch] += ",#{fetch.join(',')}" if fetch
options[:snippet] = snippets.join(',') if snippets
# convert category_filters to a json string
options[:category_filters] = options[:category_filters].to_json if options[:category_filters]
search_on_fields = models.map{|model| model.tanker_config.indexes.map{|arr| arr[0]}.uniq}.flatten.uniq.join(":(#{query.to_s}) OR ")
query = "(#{search_on_fields}:(#{query.to_s}) OR __any:(#{query.to_s})) __type:(#{models.map(&:name).map {|name| "\"#{name.split('::').join(' ')}\"" }.join(' OR ')})"
options = { :start => paginate[:per_page] * (paginate[:page] - 1), :len => paginate[:per_page] }.merge(options) if paginate
results = index.search(query, options)
SearchState.new(results, fetch, snippets, paginate)
end
class SearchState
def initialize(results, fetch, snippets, paginate)
@results = results
@fetch = fetch
@snippets = snippets
@paginate = paginate
end
def results
@results
end
def fetch
@fetch
end
def snippets
@snippets
end
def paginate
@paginate
end
end
def search(models, query, options = {})
search_state = search_results(models, query, options)
instantiate(search_state)
end
def instantiate(search_state)
results = search_state.results
fetch = search_state.fetch
snippets = search_state.snippets
paginate = search_state.paginate
categories = results['facets'] if results.has_key?('facets')
instantiated_results = if (fetch || snippets)
instantiate_results_from_results(results, fetch, snippets)
else
instantiate_results_from_db(results)
end
paginate === false ? instantiated_results : Pagination.create(instantiated_results, results['matches'], paginate, categories)
end
protected
def instantiate_results_from_db(index_result)
results = index_result['results']
return [] if results.empty?
id_map = results.inject({}) do |acc, result|
model = result["__type"]
id = constantize(model).tanker_parse_doc_id(result)
acc[model] ||= []
acc[model] << id
acc
end
id_map.each do |klass, ids|
# replace the id list with an eager-loaded list of records for this model
klass_const = constantize(klass)
if klass_const.respond_to?('find_all_by_id')
id_map[klass] = klass_const.find_all_by_id(ids)
else
id_map[klass] = klass_const.find(ids)
end
end
# return them in order
results = results.map do |result|
model, id = result["__type"], result["__id"]
id_map[model].detect {|record| id == record.id.to_s }
end
results.compact
end
def instantiate_results_from_results(index_result, fetch = false, snippets = false)
results = index_result['results']
return [] if results.empty?
instances = []
id_map = results.inject({}) do |acc, result|
model = result["__type"]
instance = constantize(model).new()
result.each do |key, value|
case key
when /snippet/
# create snippet reader attribute (method)
instance.create_snippet_attribute(key, value)
when '__id'
# assign id attribute to the model
instance.id = value
when '__type', 'docid'
# do nothing
else
#assign attributes that are fetched if they match attributes in the model
if instance.respond_to?("#{key}=".to_sym)
instance.send("#{key}=", value)
end
end
end
instances << instance
end
instances
end
# borrowed from Rails' ActiveSupport::Inflector
def constantize(camel_cased_word)
names = camel_cased_word.split('::')
names.shift if names.empty? || names.first.empty?
constant = Object
names.each do |name|
constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
end
constant
end
def extract_setup_paginate_options(options, defaults)
# extract
paginate_options = if options[:paginate]
options.delete(:paginate)
else
{ :page => options.delete(:page), :per_page => options.delete(:per_page) }
end
# setup defaults and ensure we got integer values
unless paginate_options === false
paginate_options[:page] = defaults[:page] unless paginate_options[:page]
paginate_options[:per_page] = defaults[:per_page] unless paginate_options[:per_page]
paginate_options.each { |key, value| paginate_options[key] = value.to_i }
end
paginate_options
end
end
# these are the class methods added when Tanker is included
# They're kept to a minimum to prevent namespace pollution
module ClassMethods
attr_accessor :tanker_config
def tankit(name = nil, options = {}, &block)
if block_given?
raise(NoIndexName, 'Please provide an index name') if name.nil? && self.tanker_config.nil?
self.tanker_config ||= ModelConfig.new(name, options, Proc.new)
name ||= self.tanker_config.index_name
self.tanker_config.index_name = name
config = ModelConfig.new(name, {}, block)
config.indexes.each do |key, value|
self.tanker_config.indexes << [key, value]
end
unless config.variables.empty?
self.tanker_config.variables do
instance_exec &config.variables.first
end
end
else
raise(NoBlockGiven, 'Please provide a block')
end
end
def search_tank(query, options = {})
Tanker.search([self], query, options)
end
def tanker_index
tanker_config.index
end
def tanker_reindex(options = {})
puts "Indexing #{self} model"
batches = []
options[:batch_size] ||= 200
records = options[:scope] ? send(options[:scope]).all : all
record_size = 0
records.each_with_index do |model_instance, idx|
batch_num = idx / options[:batch_size]
(batches[batch_num] ||= []) << model_instance
record_size += 1
end
timer = Time.now
batches.each_with_index do |batch, idx|
Tanker.batch_update(batch)
puts "Indexed #{batch.size} records #{(idx * options[:batch_size]) + batch.size}/#{record_size}"
end
puts "Indexed #{record_size} #{self} records in #{Time.now - timer} seconds"
end
def tanker_parse_doc_id(result)
result['docid'].split(' ').last
end
end
class ModelConfig
attr_accessor :index_name
attr_accessor :options
def initialize(index_name, options, block)
@index_name = index_name
@options = options
@indexes = []
@categories = []
@variables = []
@conditions = []
@functions = {}
instance_exec &block
end
def indexes(field = nil, options = {}, &block)
if field
@indexes << [field, block]
@categories << [field, block] if options[:category]
end
@indexes
end
def conditions(&block)
@conditions << block
end
def category(field = nil, options = {}, &block)
categories field, options, &block
end
def categories(field = nil, options = {}, &block)
if field
@categories << [field, block]
end
@categories
end
def variables(&block)
@variables << block if block
@variables
end
def functions(&block)
@functions = block.call if block
@functions
end
def index
@index ||= Tanker.api.get_index(index_name)
end
end
# these are the instance methods included
module InstanceMethods
def tanker_config
self.class.tanker_config || raise(NotConfigured, "Please configure Tanker for #{self.class.inspect} with the 'tankit' block")
end
def tanker_indexes
tanker_config.indexes
end
def tanker_categories
tanker_config.categories
end
def tanker_variables
tanker_config.variables
end
def tanker_conditions
tanker_config.conditions
end
# update a create instance from index tank
# or remove it if not indexable anymore
def update_tank_indexes
if tanker_indexable?
tanker_config.index.add_document(
it_doc_id, tanker_index_data, tanker_index_options
)
else
delete_tank_indexes
end
end
# delete instance from index tank
def delete_tank_indexes
tanker_config.index.delete_document(it_doc_id)
end
def tanker_indexable?
return true if tanker_conditions.empty? || tanker_conditions.first.nil?
instance_exec(&tanker_conditions.first)
end
def tanker_index_data
data = {}
# attempt to autodetect timestamp
if respond_to?(:created_at)
data[:timestamp] = created_at.to_i
end
tanker_indexes.each do |field, block|
val = block ? instance_exec(&block) : send(field)
val = val.join(' ') if Array === val
data[field.to_sym] = val.to_s unless val.nil?
end
data[:__any] = data.values.sort_by{|v| v.to_s}.join " . "
data[:__type] = type_name
data[:__id] = self.id.is_a?(Fixnum) ? self.id : self.id.to_s
data
end
#dynamically create a snippet read attribute (method)
def create_snippet_attribute(key, value)
# method name should something_snippet not snippet_something as the api returns it
method_name = "#{key.match(/snippet_(\w+)/)[1]}_snippet"
(class << self; self end).send(:define_method, method_name) { value }
end
def tanker_index_options
options = {}
unless tanker_variables.empty?
options[:variables] = tanker_variables.inject({}) do |hash, variables|
hash.merge(instance_exec(&variables))
end
end
unless tanker_categories.empty?
options[:categories] = {}
tanker_categories.each do |field, block|
val = block ? instance_exec(&block) : send(field)
val = val.join(' ') if Array === val
options[:categories][field] = val.to_s unless val.nil?
end
end
options
end
# create a unique index based on the model name and unique id
def it_doc_id
type_name + ' ' + self.id.to_s
end
def type_name
tanker_config.options[:as] || self.class.name
end
end
end