Module: ActiveScaffold::Finder::ClassMethods

Defined in:
lib/active_scaffold/finder.rb

Defined Under Namespace

Modules: ActiveRecord, Mongoid

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(klass) ⇒ Object 



10
11
12
13
14
15
16
17
18
 
# File 'lib/active_scaffold/finder.rb', line 10

def self.extended(klass)
  return unless klass.active_scaffold_config

  if klass.active_scaffold_config.active_record?
    klass.extend ActiveRecord
  elsif klass.active_scaffold_config.mongoid?
    klass.extend Mongoid
  end
end

Instance Method Details

#alias_query_for_same_table_exists(query) ⇒ Object 



256
257
258
259
260
 
# File 'lib/active_scaffold/finder.rb', line 256

def alias_query_for_same_table_exists(query)
  query.instance_variable_set(:@table, query.table.dup)
  query.table.instance_variable_set(:@table_alias, "_#{query.table_name}_exists")
  query
end

#condition_for_column(column, value, text_search, session) ⇒ Object

Generates an SQL condition for the given ActiveScaffold column based on that column’s database type (or form_ui … for virtual columns?). TODO: this should reside on the column, not the controller



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
 
# File 'lib/active_scaffold/finder.rb', line 102

def condition_for_column(column, value, text_search, session)
  like_pattern = like_pattern(text_search)
  value = value.with_indifferent_access if value.is_a? Hash
  column_method = "condition_for_#{column.name}_column"
  if respond_to?(column_method)
    args = [column, value, like_pattern]
    args << session if method(column_method).arity == 4
    return send(:"condition_for_#{column.name}_column", *args)
  end
  return unless column.searchable? && value.present?

  search_ui = column.search_ui || column.column_type
  begin
    sql, *values =
      if search_ui && respond_to?(:"condition_for_#{search_ui}_type")
        send(:"condition_for_#{search_ui}_type", column, value, like_pattern)
      elsif column.search_sql.instance_of? Proc
        column.search_sql.call(value)
      else
        condition_for_search_ui(column, value, like_pattern, search_ui)
      end
    return nil unless sql
    return sql if sql.is_a? ::ActiveRecord::Relation

    where_values = []
    sql_conditions = []
    column.search_sql.each do |search_sql|
      if search_sql.is_a?(Hash)
        subquery_sql, *subquery_values = subquery_condition(column, sql, search_sql, values)
        sql_conditions << subquery_sql
        where_values.concat subquery_values
      else
        sql_conditions << (sql % {search_sql: search_sql})
        where_values.concat values
      end
    end
    [sql_conditions.join(' OR '), *where_values]
  rescue StandardError => e
    message = "on the ActiveScaffold column :#{column.name}, search_ui = #{search_ui} in #{name}"
    ActiveScaffold.log_exception(e, message)
    raise e.class, "#{e.message} -- #{message}", e.backtrace
  end
end

#condition_for_datetime(column, value, like_pattern = nil) ⇒ Object 



400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/active_scaffold/finder.rb', line 400

def condition_for_datetime(column, value, like_pattern = nil)
  operator = ActiveScaffold::Finder::NUMERIC_COMPARATORS.include?(value['opt']) && value['opt'] != 'BETWEEN' ? value['opt'] : nil
  from_value, to_value = datetime_from_to(column, value)

  if column.search_sql.is_a? Proc
    column.search_sql.call(from_value, to_value, operator)
  elsif ActiveScaffold::Finder::NULL_COMPARATORS.include?(value['opt'])
    condition_for_null_type(column, value['opt'], like_pattern)
  elsif operator.nil?
    ['%<search_sql>s BETWEEN ? AND ?', from_value, to_value] unless from_value.nil? || to_value.nil?
  else
    ["%<search_sql>s #{value['opt']} ?", from_value] unless from_value.nil?
  end
end

#condition_for_null_type(column, value, like_pattern = nil) ⇒ Object 



502
503
504
505
506
507
508
509
 
# File 'lib/active_scaffold/finder.rb', line 502

def condition_for_null_type(column, value, like_pattern = nil)
  case value.to_s
  when 'null'
    ['%<search_sql>s is null', []]
  when 'not_null'
    ['%<search_sql>s is not null', []]
  end
end

#condition_for_numeric(column, value) ⇒ Object 



193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/active_scaffold/finder.rb', line 193

def condition_for_numeric(column, value)
  if !value.is_a?(Hash)
    ['%<search_sql>s = ?', condition_value_for_numeric(column, value)]
  elsif ActiveScaffold::Finder::NULL_COMPARATORS.include?(value[:opt])
    condition_for_null_type(column, value[:opt])
  elsif value[:from].blank? || ActiveScaffold::Finder::NUMERIC_COMPARATORS.exclude?(value[:opt])
    nil
  elsif value[:opt] == 'BETWEEN'
    ['(%<search_sql>s BETWEEN ? AND ?)', condition_value_for_numeric(column, value[:from]), condition_value_for_numeric(column, value[:to])]
  else
    ["%<search_sql>s #{value[:opt]} ?", condition_value_for_numeric(column, value[:from])]
  end
end

#condition_for_range(column, value, like_pattern = nil) ⇒ Object 



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
 
# File 'lib/active_scaffold/finder.rb', line 216

def condition_for_range(column, value, like_pattern = nil)
  if ActiveScaffold::Finder::NULL_COMPARATORS.include?(value[:opt])
    condition_for_null_type(column, value[:opt], like_pattern)
  elsif value[:from].is_a?(Array) # opt can be only =
    from = Array(value[:from]).compact_blank
    ['%<search_sql>s in (?)', from] if from.present?
  elsif value[:from].blank?
    nil
  elsif ActiveScaffold::Finder::STRING_COMPARATORS.value?(value[:opt])
    text = column.active_record? ? column.active_record_class.sanitize_sql_like(value[:from]) : value[:from]
    [
      "%<search_sql>s #{'NOT ' if value[:opt].start_with?('not_')}#{ActiveScaffold::Finder.like_operator} ?",
      value[:opt].sub('not_', '').sub('?', text)
    ]
  elsif value[:opt] == 'BETWEEN'
    ['(%<search_sql>s BETWEEN ? AND ?)', value[:from], value[:to]]
  elsif ActiveScaffold::Finder::NUMERIC_COMPARATORS.include?(value[:opt])
    ["%<search_sql>s #{value[:opt]} ?", value[:from]]
  elsif ActiveScaffold::Finder::LOGICAL_COMPARATORS.include?(value[:opt])
    operator =
      case value[:opt]
      when 'all_tokens' then 'AND'
      when 'any_token'  then 'OR'
      end
    parser = ActiveScaffold::Bridges::LogicalQueryParser::TokensGrammar::Parser.new(operator) if operator
    [logical_search_condition(column, value[:from], parser)]
  end
end

#condition_for_record_select_type(column, value, like_pattern = nil) ⇒ Object 



493
494
495
496
497
498
499
500
 
# File 'lib/active_scaffold/finder.rb', line 493

def condition_for_record_select_type(column, value, like_pattern = nil)
  if value.is_a?(Array)
    value = value.compact_blank
    ['%<search_sql>s IN (?)', value] if value.present?
  else
    ['%<search_sql>s = ?', value]
  end
end

#condition_for_search_ui(column, value, like_pattern, search_ui) ⇒ Object 



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
 
# File 'lib/active_scaffold/finder.rb', line 163

def condition_for_search_ui(column, value, like_pattern, search_ui)
  case search_ui
  when :boolean, :checkbox
    if value == 'null'
      condition_for_null_type(column, value)
    else
      ['%<search_sql>s = ?', column.column ? ActiveScaffold::Core.column_type_cast(value, column.column) : value]
    end
  when :integer, :decimal, :float
    condition_for_numeric(column, value)
  when :string, :range
    if value.is_a?(Hash)
      condition_for_range(column, value, like_pattern)
    else
      condition_for_single_value(column, value, like_pattern)
    end
  when :date, :time, :datetime, :timestamp
    condition_for_datetime(column, value)
  when :select, :select_multiple, :draggable, :multi_select, :country, :usa_state, :chosen, :multi_chosen
    if value.is_a?(Hash)
      condition_for_range(column, value, like_pattern)
    else
      values = Array(value).compact_blank
      ['%<search_sql>s in (?)', values] if values.present?
    end
  else
    condition_for_single_value(column, value, like_pattern)
  end
end

#condition_for_single_value(column, value, like_pattern = nil) ⇒ Object 



207
208
209
210
211
212
213
214
 
# File 'lib/active_scaffold/finder.rb', line 207

def condition_for_single_value(column, value, like_pattern = nil)
  if column.text?
    value = column.active_record_class.sanitize_sql_like(value) if column.active_record?
    ["%<search_sql>s #{ActiveScaffold::Finder.like_operator} ?", like_pattern.sub('?', value)]
  else
    ['%<search_sql>s = ?', ActiveScaffold::Core.column_type_cast(value, column.column)]
  end
end

#condition_value_for_datetime(column, value, conversion = :to_time, ui_method: :search_ui, ui_options: nil) ⇒ Object 



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/active_scaffold/finder.rb', line 350

def condition_value_for_datetime(column, value, conversion = :to_time, ui_method: :search_ui, ui_options: nil)
  return if value.nil? || value.blank?

  ui_options ||= column.send(:"#{ui_method}_options") || column.options
  if value.is_a? Hash
    local_time_from_hash(value, conversion)
  elsif value.respond_to?(:strftime)
    if conversion == :to_time
      # Explicitly get the current zone, because TimeWithZone#to_time in rails 3.2.3 returns UTC.
      # https://github.com/rails/rails/pull/2453
      value.to_time.in_time_zone
    else
      value.send(conversion)
    end
  elsif conversion == :to_date
    parse_date_with_format(*format_for_date(column, value, column.send(ui_method), ui_options))
  elsif value.include?('T')
    Time.zone.parse(value)
  else # datetime
    time = parse_time_with_format(value, *format_for_datetime(column, value, column.send(ui_method), ui_options))
    conversion == :to_time ? time : time.send(conversion)
  end
end

#condition_value_for_numeric(column, value) ⇒ Object 



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/active_scaffold/finder.rb', line 374

def condition_value_for_numeric(column, value)
  return value if value.nil?

  value = column.number_to_native(value) if column.options[:format] && column.search_ui != :number
  case column.search_ui || column.column_type
  when :integer
    if value.is_a?(TrueClass) || value.is_a?(FalseClass)
      value ? 1 : 0
    else
      value.to_i
    end
  when :float     then value.to_f
  when :decimal   then ::ActiveRecord::Type::Decimal.new.cast(value)
  else
    value
  end
end

#conditions_for_columns(tokens, columns, text_search = :full) ⇒ Object

Takes a collection of search terms (the tokens) and creates SQL that searches all specified ActiveScaffold columns. A row will match if each token is found in at least one of the columns.



23
24
25
26
27
28
29
30
 
# File 'lib/active_scaffold/finder.rb', line 23

def conditions_for_columns(tokens, columns, text_search = :full)
  # if there aren't any columns, then just return a nil condition
  return unless columns.any?

  tokens = [tokens] if tokens.is_a? String
  tokens = type_casted_tokens(tokens, columns, like_pattern(text_search))
  create_conditions_for_columns(tokens, columns)
end

#datetime_column_date?(column) ⇒ Boolean

Returns:

  • (Boolean) 


489
490
491
 
# File 'lib/active_scaffold/finder.rb', line 489

def datetime_column_date?(column)
  column.column&.type == :date
end

#datetime_conversion_for_condition(column) ⇒ Object 



392
393
394
395
396
397
398
 
# File 'lib/active_scaffold/finder.rb', line 392

def datetime_conversion_for_condition(column)
  if column.column
    column.column_type == :date ? :to_date : :to_time
  else
    :to_time
  end
end

#datetime_from_to(column, value) ⇒ Object 



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/active_scaffold/finder.rb', line 415

def datetime_from_to(column, value)
  conversion = datetime_conversion_for_condition(column)
  case value['opt']
  when 'RANGE'
    values = datetime_from_to_for_range(column, value)
    # Avoid calling to_time, not needed and broken on rails >= 4, because return local time instead of UTC
    values.collect!(&conversion) if conversion != :to_time
    values
  when 'PAST', 'FUTURE'
    values = datetime_from_to_for_trend(column, value)
    # Avoid calling to_time, not needed and broken on rails >= 4, because return local time instead of UTC
    values.collect!(&conversion) if conversion != :to_time
    values
  else
    %w[from to].collect { |field| condition_value_for_datetime(column, value[field], conversion) }
  end
end

#datetime_from_to_for_range(column, value) ⇒ Object 



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/active_scaffold/finder.rb', line 464

def datetime_from_to_for_range(column, value)
  case value['range']
  when 'TODAY'
    [datetime_now.beginning_of_day, datetime_now.end_of_day]
  when 'YESTERDAY'
    [datetime_now.ago(1.day).beginning_of_day, datetime_now.ago(1.day).end_of_day]
  when 'TOMORROW'
    [datetime_now.in(1.day).beginning_of_day, datetime_now.in(1.day).end_of_day]
  else
    range_type, range = value['range'].downcase.split('_')
    raise ArgumentError unless %w[week month year].include?(range)

    case range_type
    when 'this'
      [datetime_now.send(:"beginning_of_#{range}"), datetime_now.send(:"end_of_#{range}")]
    when 'prev'
      [datetime_now.ago(1.send(range.to_sym)).send(:"beginning_of_#{range}"), datetime_now.ago(1.send(range.to_sym)).send(:"end_of_#{range}")]
    when 'next'
      [datetime_now.in(1.send(range.to_sym)).send(:"beginning_of_#{range}"), datetime_now.in(1.send(range.to_sym)).send(:"end_of_#{range}")]
    else
      [nil, nil]
    end
  end
end

#datetime_from_to_for_trend(column, value) ⇒ Object 



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
 
# File 'lib/active_scaffold/finder.rb', line 437

def datetime_from_to_for_trend(column, value)
  case value['opt']
  when 'PAST'
    trend_number = [value['number'].to_i, 1].max
    now = datetime_now
    if datetime_column_date?(column)
      from = now.beginning_of_day.ago(trend_number.send(value['unit'].downcase.singularize.to_sym))
      to = now.end_of_day
    else
      from = now.ago(trend_number.send(value['unit'].downcase.singularize.to_sym))
      to = now
    end
    [from, to]
  when 'FUTURE'
    trend_number = [value['number'].to_i, 1].max
    now = datetime_now
    if datetime_column_date?(column)
      from = now.beginning_of_day
      to = now.end_of_day.in(trend_number.send(value['unit'].downcase.singularize.to_sym))
    else
      from = now
      to = now.in(trend_number.send(value['unit'].downcase.singularize.to_sym))
    end
    [from, to]
  end
end

#datetime_now ⇒ Object 



433
434
435
 
# File 'lib/active_scaffold/finder.rb', line 433

def datetime_now
  Time.zone.now
end

#format_for_date(column, value, ui_name, ui_options) ⇒ Object 



319
320
321
322
323
324
325
326
 
# File 'lib/active_scaffold/finder.rb', line 319

def format_for_date(column, value, ui_name, ui_options)
  if ui_options[:format]
    format = I18n.t("date.formats.#{ui_options[:format]}")
    format.gsub!(/%-d|%-m|%_m/) { |s| s.gsub(/[-_]/, '') } # strptime fails with %-d, %-m, %_m
    en_value = I18n.locale == :en ? value : translate_days_and_months(value, format)
  end
  [en_value || value, format]
end

#format_for_datetime(column, value, ui_name, ui_options) ⇒ Object 



299
300
301
302
303
304
305
306
307
308
 
# File 'lib/active_scaffold/finder.rb', line 299

def format_for_datetime(column, value, ui_name, ui_options)
  parts = Date._parse(value)
  time_parts = [[:hour, '%H'], [:min, '%M'], [:sec, '%S']].filter_map do |part, format_part|
    format_part if parts[part].present?
  end
  format = "%Y-%m-%d #{time_parts.join(':')} #{'%z' if parts[:offset].present?}"

  format.gsub!(/.*(?=%H)/, '') if !parts[:year] && !parts[:month] && !parts[:mday]
  [format, parts[:offset]]
end

#local_time_from_hash(value, conversion = :to_time) ⇒ Object 



310
311
312
313
314
315
316
317
 
# File 'lib/active_scaffold/finder.rb', line 310

def local_time_from_hash(value, conversion = :to_time)
  time = Time.zone.local(*i[year month day hour minute second].collect { |part| value[part].to_i })
  time.send(conversion)
rescue StandardError => e
  message = "Error creating time from #{value.inspect}:"
  Rails.logger.warn "#{message}\n#{e.message}\n#{e.backtrace.join("\n")}"
  nil
end

#logical_search_condition(column, search, parser = nil) ⇒ Object 



245
246
247
248
249
250
251
252
253
254
 
# File 'lib/active_scaffold/finder.rb', line 245

def logical_search_condition(column, search, parser = nil)
  model = column.active_record_class
  subquery = alias_query_for_same_table_exists(model.all) if column.logical_search.any?(Hash)
  query = ::LogicalQueryParser.search(search, subquery || model, columns: column.logical_search, parser: parser)
  if subquery
    model.where(same_table_exists_subquery(query))
  else
    query
  end
end

#parse_date_with_format(value, format) ⇒ Object 



328
329
330
331
332
333
334
335
 
# File 'lib/active_scaffold/finder.rb', line 328

def parse_date_with_format(value, format)
  Date.strptime(value, *format)
rescue StandardError => e
  message = "Error parsing date from #{value}"
  message << ", with format #{format}" if format
  Rails.logger.warn "#{message}:\n#{e.message}\n#{e.backtrace.join("\n")}"
  nil
end

#parse_time_with_format(value, format, offset) ⇒ Object 



337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/active_scaffold/finder.rb', line 337

def parse_time_with_format(value, format, offset)
  format.gsub!(/%-d|%-m|%_m/) { |s| s.gsub(/[-_]/, '') } # strptime fails with %-d, %-m, %_m
  en_value = I18n.locale == :en ? value : translate_days_and_months(value, format)
  time = Time.strptime(en_value, format)
  offset ? time : Time.zone.local_to_utc(time).in_time_zone
rescue StandardError => e
  message = "Error parsing time from #{en_value}"
  message << " (#{value})" if en_value != value
  message << ", with format #{format}" if format
  Rails.logger.warn "#{message}:\n#{e.message}\n#{e.backtrace.join("\n")}"
  nil
end

#same_table_exists_subquery(query) ⇒ Object 



262
263
264
265
266
 
# File 'lib/active_scaffold/finder.rb', line 262

def same_table_exists_subquery(query)
  alias_query_for_same_table_exists(query) unless query.table.table_alias
  subquery = query.where(query.arel_table[query.primary_key].eq(query.table[query.primary_key]))
  subquery.select(1).arel.exists
end

#subquery_condition(column, sql, options, values) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/active_scaffold/finder.rb', line 146

def subquery_condition(column, sql, options, values)
  relation, *columns = options[:subquery]
  conditions = [columns.map { |search_sql| sql % {search_sql: search_sql} }.join(' OR ')]
  conditions += values * columns.size if values.present?
  subquery = relation.where(conditions)
  subquery = subquery.select(relation.primary_key) if subquery.select_values.blank?

  conditions = [["#{options[:field] || column.field} IN (?)", options[:conditions]&.first].compact.join(' AND ')]
  conditions << subquery
  conditions.concat options[:conditions][1..] if options[:conditions]
  if column.association&.polymorphic?
    conditions[0] << " AND #{column.quoted_foreign_type} = ?"
    conditions << relation.base_class.sti_name
  end
  conditions
end

#tables_for_translating_days_and_months(format) ⇒ Object 



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/active_scaffold/finder.rb', line 268

def tables_for_translating_days_and_months(format)
  keys = {
    '%A' => 'date.day_names',
    '%a' => 'date.abbr_day_names',
    '%B' => 'date.month_names',
    '%b' => 'date.abbr_month_names'
  }
  key_index = keys.keys.index_with { |key| format.index(key) }
  keys.select! { |k, _| key_index[k] }
  keys.sort_by { |k, _| key_index[k] }.map do |_, k|
    I18n.t(k).compact.zip(I18n.t(k, locale: :en).compact).to_h
  end
end

#translate_days_and_months(value, format) ⇒ Object 



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/active_scaffold/finder.rb', line 282

def translate_days_and_months(value, format)
  translated = +''
  value = value.dup # ensure the string can be changed
  tables_for_translating_days_and_months(format).each do |table|
    regexp = Regexp.union(table.keys)
    index = value.index(regexp)
    next unless index

    translated << value.slice!(0...index)
    value.sub!(regexp) do |str|
      translated << table[str]
      ''
    end
  end
  translated << value
end

#type_casted_tokens(tokens, columns, like_pattern) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/active_scaffold/finder.rb', line 32

def type_casted_tokens(tokens, columns, like_pattern)
  tokens.map do |value|
    columns.each_with_object({}) do |column, column_tokens|
      column_tokens[column.name] =
        if column.text?
          like_pattern.sub('?', column.active_record? ? column.active_record_class.sanitize_sql_like(value) : value)
        else
          ActiveScaffold::Core.column_type_cast(value, column.column)
        end
    end
  end
end