Class: TrkDatatables::ActiveRecord

Inherits:
Base
  • Object
show all
Defined in:
lib/trk_datatables/active_record.rb

Constant Summary collapse

MAX_NUMBER_OF_STRINGS =

there is a stack level too deep exception for more than 190 strings

190

Instance Attribute Summary

Attributes inherited from Base

#column_key_options

Instance Method Summary collapse

Methods inherited from Base

#additional_data_for_json, #all_items, #all_items_count, #as_json, #columns, #default_order, #default_page_length, #dt_orders_or_default_index_and_direction, #dt_per_page_or_default, #filtered_items, #filtered_items_count, #global_search_columns, #index_by_column_key, #initialize, #link_to_rdoc, #ordered_paginated_filtered_items, #param_get, #predefined_date_ranges, #predefined_datetime_ranges, #predefined_ranges, #preferences_field, #preferences_holder, #render_html, #rows

Methods included from BaseHelpers

#form_field_name, #order_set, #param_set, #range_string

Constructor Details

This class inherits a constructor from TrkDatatables::Base

Instance Method Details

#_arel_column(column_key_option) ⇒ Object 



132
133
134
135
136
137
138
 
# File 'lib/trk_datatables/active_record.rb', line 132

def _arel_column(column_key_option)
  if column_key_option[:table_class] < TrkDatatables::CalculatedInDb
    Arel.sql send(column_key_option[:column_key])
  else
    column_key_option[:table_class].arel_table[column_key_option[:column_name]]
  end
end

#_filter_column_as_string(column_key_option, search_value) ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'lib/trk_datatables/active_record.rb', line 50

def _filter_column_as_string(column_key_option, search_value)
  search_value.split(" ").first(MAX_NUMBER_OF_STRINGS).map do |search_string|
    casted_column = ::Arel::Nodes::NamedFunction.new(
      "CAST",
      [_arel_column(column_key_option).as(@column_key_options.string_cast)]
    )
    casted_column.matches("%#{search_string}%")
  end.reduce(:and)
end

#_parse_from_to(from, to, column_key_option) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/trk_datatables/active_record.rb', line 84

def _parse_from_to(from, to, column_key_option)
  case column_key_option[:column_type_in_db]
  when :integer, :float
    # we do not need to cast from string since range will do automatically
    parsed_from = from
    parsed_to = to
  when :date
    parsed_from = _parse_in_zone(from)&.to_date
    parsed_to = _parse_in_zone(to)&.to_date&.end_of_day
  when :datetime
    parsed_from = _parse_in_zone(from)
    parsed_to = _parse_in_zone(to)
    if parsed_to.present? && !to.match(/:/)
      # Use end of a day if time is not defined, for example 2020-02-02
      parsed_to = parsed_to.at_end_of_day
    end
  end
  [parsed_from, parsed_to]
end

#_parse_in_zone(time) ⇒ Object 



104
105
106
107
108
109
110
111
 
# File 'lib/trk_datatables/active_record.rb', line 104

def _parse_in_zone(time)
  return nil if time.blank?

  # without zone we will parse without zone so make sure params are correct
  Time.zone ? Time.zone.parse(time) : Time.parse(time)
rescue ArgumentError
  nil
end

#build_condition_for_column(column_key_option, search_value) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/trk_datatables/active_record.rb', line 32

def build_condition_for_column(column_key_option, search_value)
  # nil is when we use action columns, usually not column searchable
  return nil if column_key_option[:column_type_in_db].nil?

  select_options = column_key_option[:column_options][ColumnKeyOptions::SELECT_OPTIONS]
  if select_options.present?
    filter_column_as_in(column_key_option, search_value)
  elsif %i[boolean].include?(column_key_option[:column_type_in_db])
    filter_column_as_boolean(column_key_option, search_value)
  elsif %i[date datetime integer float].include?(column_key_option[:column_type_in_db]) &&
      search_value.include?(BETWEEN_SEPARATOR)
    from, to = search_value.split BETWEEN_SEPARATOR
    filter_column_as_between(column_key_option, from, to)
  else
    _filter_column_as_string(column_key_option, search_value)
  end
end

#filter_by_columns(filtered) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/trk_datatables/active_record.rb', line 18

def filter_by_columns(filtered)
  conditions = @dt_params.dt_columns.each_with_object([]) do |dt_column, cond|
    next unless dt_column[:searchable] && dt_column[:search_value].present?

    # check both params and configuration
    column_key_option = @column_key_options[dt_column[:index]]
    next if column_key_option[:column_options][ColumnKeyOptions::SEARCH_OPTION] == false

    cond << build_condition_for_column(column_key_option, dt_column[:search_value])
  end.reduce(:and) # 'and' for each searchable column

  filtered.where conditions
end

#filter_by_search_all(filtered) ⇒ Object

Global search. All columns are typecasted to string. Search string is splited by space and “and”-ed.



8
9
10
11
12
13
14
15
16
 
# File 'lib/trk_datatables/active_record.rb', line 8

def filter_by_search_all(filtered)
  conditions = @dt_params.search_all.split(" ").first(MAX_NUMBER_OF_STRINGS).map do |search_string|
    @column_key_options.searchable_and_global_search.map do |column_key_option|
      _filter_column_as_string column_key_option, search_string
    end.reduce(:or) # any searchable column is 'or'-ed
  end.reduce(:and) # 'and' for each search_string

  filtered.where conditions
end

#filter_column_as_between(column_key_option, from, to) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/trk_datatables/active_record.rb', line 67

def filter_column_as_between(column_key_option, from, to)
  from, to = _parse_from_to(from, to, column_key_option)
  if from.present? && to.present?
    _arel_column(column_key_option).between(from..to)
  elsif from.present?
    _arel_column(column_key_option).gteq(from)
  elsif to.present?
    _arel_column(column_key_option).lteq(to)
    # else
    # nil will result in true relation
  end
end

#filter_column_as_boolean(column_key_option, search_value) ⇒ Object 



60
61
62
63
64
65
 
# File 'lib/trk_datatables/active_record.rb', line 60

def filter_column_as_boolean(column_key_option, search_value)
  # return true relation in case we ignore
  return Arel::Nodes::SqlLiteral.new("1").eq(1) if search_value == "any"

  _arel_column(column_key_option).eq(search_value == "true")
end

#filter_column_as_in(column_key_option, search_value) ⇒ Object 



80
81
82
 
# File 'lib/trk_datatables/active_record.rb', line 80

def filter_column_as_in(column_key_option, search_value)
  _arel_column(column_key_option).in search_value.split(MULTIPLE_OPTION_SEPARATOR)
end

#order_and_paginate_items(filtered) ⇒ Object 



113
114
115
116
 
# File 'lib/trk_datatables/active_record.rb', line 113

def order_and_paginate_items(filtered)
  filtered = order_items filtered
  filtered.offset(@dt_params.dt_offset).limit(dt_per_page_or_default)
end

#order_items(filtered) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/trk_datatables/active_record.rb', line 118

def order_items(filtered)
  order_by = dt_orders_or_default_index_and_direction.each_with_object([]) do |(index, direction), queries|
    column_key_option = @column_key_options[index]
    next if column_key_option[:column_options][ColumnKeyOptions::ORDER_OPTION] == false

    queries << if column_key_option[:table_class] < TrkDatatables::CalculatedInDb
      "#{send(column_key_option[:column_key])} #{direction}"
    else
      "#{column_key_option[:column_key]} #{direction}"
    end
  end
  filtered.order(Arel.sql(order_by.join(", ")))
end