Module: ActiveScaffold::Finder::ClassMethods

Defined in:
lib/active_scaffold/finder.rb

Instance Method Summary collapse

Instance Method Details

#condition_for_column(column, value, text_search = :full) ⇒ 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



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

def condition_for_column(column, value, text_search = :full)
  like_pattern = like_pattern(text_search)
  return unless column and column.search_sql and not value.blank?
  search_ui = column.search_ui || column.column.type
  begin
    if self.respond_to?("condition_for_#{column.name}_column")
      self.send("condition_for_#{column.name}_column", column, value, like_pattern)
    elsif self.respond_to?("condition_for_#{search_ui}_type")
      self.send("condition_for_#{search_ui}_type", column, value, like_pattern)
    else
      unless column.search_sql.instance_of? Proc
        case search_ui
          when :boolean, :checkbox
            ["#{column.search_sql} = ?", column.column.type_cast(value)]
          when :integer, :decimal, :float
            condition_for_numeric(column, value)
          when :string, :range
            condition_for_range(column, value, like_pattern)
          when :date, :time, :datetime, :timestamp
            condition_for_datetime(column, value)
          when :select, :multi_select, :country, :usa_state
          ["#{column.search_sql} in (?)", Array(value)]
          else
            if column.column.nil? || column.column.text?
              ["#{column.search_sql} #{ActiveScaffold::Finder.like_operator} ?", like_pattern.sub('?', value)]
            else
              ["#{column.search_sql} = ?", column.column.type_cast(value)]
            end
        end
      else
        column.search_sql.call(value)
      end
    end
  rescue Exception => e
    logger.error Time.now.to_s + "#{e.inspect} -- on the ActiveScaffold column :#{column.name}, search_ui = #{search_ui} in #{@controller.class}"
    raise e
  end
end

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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/active_scaffold/finder.rb', line 160

def condition_for_datetime(column, value, like_pattern = nil)
  conversion = datetime_conversion_for_condition(column)
  from_value = condition_value_for_datetime(value[:from], conversion)
  to_value = condition_value_for_datetime(value[:to], conversion)

  if from_value.nil? and to_value.nil?
    nil
  elsif !from_value
    ["#{column.search_sql} <= ?", to_value.to_s(:db)]
  elsif !to_value
    ["#{column.search_sql} >= ?", from_value.to_s(:db)]
  else
    ["#{column.search_sql} BETWEEN ? AND ?", from_value.to_s(:db), to_value.to_s(:db)]
  end
end

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



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/active_scaffold/finder.rb', line 184

def condition_for_null_type(column, value, like_pattern = nil)
  case value.to_sym
  when :null
    ["#{column.search_sql} is null"]
  when :not_null
    ["#{column.search_sql} is not null"]
  else
    nil
  end
end

#condition_for_numeric(column, value) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/active_scaffold/finder.rb', line 80

def condition_for_numeric(column, value)
  if !value.is_a?(Hash)
    ["#{column.search_sql} = ?", condition_value_for_numeric(column, value)]
  elsif value[:from].blank? or not ActiveScaffold::Finder::NumericComparators.include?(value[:opt])
    nil
  elsif value[:opt] == 'BETWEEN'
    ["#{column.search_sql} BETWEEN ? AND ?", condition_value_for_numeric(column, value[:from]), condition_value_for_numeric(column, value[:to])]
   else
    ["#{column.search_sql} #{value[:opt]} ?", condition_value_for_numeric(column, value[:from])]
  end
end

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



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

def condition_for_range(column, value, like_pattern = nil)
  if !value.is_a?(Hash)
    if column.column.nil? || column.column.text?
      ["#{column.search_sql} #{ActiveScaffold::Finder.like_operator} ?", like_pattern.sub('?', column.stripped_value(value))]
    else
      ["#{column.search_sql} = ?", column.column.type_cast(value)]
    end
  elsif value[:from].blank?
    nil
  elsif ActiveScaffold::Finder::StringComparators.values.include?(value[:opt])
    if(active_scaffold_config.field_search.or_columns.include? column.name)
      search_values = column.stripped_value(value[:from]).split(active_scaffold_config.field_search.or_delimiter).compact
      sql_prepared_statement = search_values.collect {|search_value| "#{column.search_sql} #{ActiveScaffold::Finder.like_operator} ?"}.join(' OR ')
      [sql_prepared_statement] + search_values.collect{|search_value| value[:opt].sub('?', column.stripped_value(search_value))}
    else
      ["#{column.search_sql} #{ActiveScaffold::Finder.like_operator} ?", value[:opt].sub('?', column.stripped_value(value[:from]))]
    end
  elsif value[:opt] == 'BETWEEN'
    ["#{column.search_sql} BETWEEN ? AND ?", column.stripped_value(value[:from]), column.stripped_value(value[:to])]
  elsif ActiveScaffold::Finder::NumericComparators.include?(value[:opt])
    ["#{column.search_sql} #{value[:opt]} ?", column.stripped_value(value[:from])]
  else
    nil
  end
end

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



176
177
178
179
180
181
182
 
# File 'lib/active_scaffold/finder.rb', line 176

def condition_for_record_select_type(column, value, like_pattern = nil)
  if value.is_a?(Array)
    ["#{column.search_sql} IN (?)", value]
  else
    ["#{column.search_sql} = ?", value]
  end
end

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



118
119
120
121
122
123
124
125
126
 
# File 'lib/active_scaffold/finder.rb', line 118

def condition_value_for_datetime(value, conversion = :to_time)
  if value.is_a? Hash
    Time.zone.local(*[:year, :month, :day, :hour, :minute, :second].collect {|part| value[field][part].to_i}) rescue nil
  elsif value.respond_to?(:strftime)
    value.send(conversion)
  else
    Time.zone.parse(value).in_time_zone.send(conversion) rescue nil
  end unless value.nil? || value.blank?
end

#condition_value_for_numeric(column, value) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/active_scaffold/finder.rb', line 128

def condition_value_for_numeric(column, value)
  return value if value.nil?
  value = i18n_number_to_native_format(value) if [:i18n_number, :currency].include?(column.options[:format])
  case (column.search_ui || column.column.type)
  when :integer   then value.to_i rescue value ? 1 : 0
  when :float     then value.to_f
  when :decimal   then ActiveRecord::ConnectionAdapters::Column.value_to_decimal(value)
  else
    value
  end
end

#create_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.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/active_scaffold/finder.rb', line 17

def create_conditions_for_columns(tokens, columns, text_search = :full)
  # if there aren't any columns, then just return a nil condition
  return unless columns.length > 0
  like_pattern = like_pattern(text_search)

  tokens = [tokens] if tokens.is_a? String

  where_clauses = []
  columns.each do |column|
    where_clauses << ((column.column.nil? || column.column.text?) ? "#{column.search_sql} #{ActiveScaffold::Finder.like_operator} ?" : "#{column.search_sql} = ?")
  end
  phrase = "(#{where_clauses.join(' OR ')})"

  sql = ([phrase] * tokens.length).join(' AND ')
  tokens = tokens.collect do |value|
    columns.collect {|column| (column.column.nil? || column.column.text?) ? like_pattern.sub('?', value) : column.column.type_cast(value)}
  end.flatten

  [sql, *tokens]
end

#datetime_conversion_for_condition(column) ⇒ Object 



152
153
154
155
156
157
158
 
# File 'lib/active_scaffold/finder.rb', line 152

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

#i18n_number_to_native_format(value) ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/active_scaffold/finder.rb', line 140

def i18n_number_to_native_format(value)
  native = '.'
  delimiter = I18n.t('number.format.delimiter')
  separator = I18n.t('number.format.separator')
  return value if value.blank? || !value.is_a?(String)
  unless delimiter == native && !value.include?(separator) && value !~ /\.\d{3}$/
    value.gsub(/[^0-9\-#{I18n.t('number.format.separator')}]/, '').gsub(I18n.t('number.format.separator'), native)
  else
    value
  end
end

#like_pattern(text_search) ⇒ Object 



195
196
197
198
199
200
201
202
 
# File 'lib/active_scaffold/finder.rb', line 195

def like_pattern(text_search)
  case text_search
    when :full then '%?%'
    when :start then '?%'
    when :end then '%?'
    else '?'
  end
end