Module: ActiveScaffold::Helpers::SearchColumnHelpers

Included in:
ViewHelpers
Defined in:
lib/active_scaffold/helpers/search_column_helpers.rb

Overview

Helpers that assist with the rendering of a Form Column

Instance Method Summary collapse

Instance Method Details

#active_scaffold_search_boolean(column, options) ⇒ Object Also known as: active_scaffold_search_checkbox

we can’t use active_scaffold_input_boolean because we need to have a nil value even when column can’t be null to decide whether search for this field or not



104
105
106
107
108
109
110
111
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 104

def active_scaffold_search_boolean(column, options)
  select_options = []
  select_options << [as_(:_select_), nil]
  select_options << [as_(:true), true]
  select_options << [as_(:false), false]

  select_tag(options[:name], options_for_select(select_options, column.active_record_class.db.send(:typecast_value_boolean, field_search_params[column.name])))
end

#active_scaffold_search_date(column, options) ⇒ Object 



206
207
208
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 206

def active_scaffold_search_date(column, options)
  active_scaffold_search_datetime(column, options.merge!(:discard_time => true))
end

#active_scaffold_search_datetime(column, options) ⇒ Object Also known as: active_scaffold_search_timestamp 



197
198
199
200
201
202
203
204
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 197

def active_scaffold_search_datetime(column, options)
  opt_value, from_value, to_value = field_search_params_range_values(column)
  options = column.options.merge(options)
  helper = "select_#{'date' unless options[:discard_date]}#{'time' unless options[:discard_time]}"
  
  send(helper, field_search_datetime_value(from_value), {:include_blank => true, :prefix => "#{options[:name]}[from]"}.merge(options)) << 
  ' - '.html_safe << send(helper, field_search_datetime_value(to_value), {:include_blank => true, :prefix => "#{options[:name]}[to]"}.merge(options))
end

#active_scaffold_search_for(column) ⇒ Object

This method decides which input to use for the given column. It does not do any rendering. It only decides which method is responsible for rendering.



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

def active_scaffold_search_for(column)
  options = active_scaffold_search_options(column)

  # first, check if the dev has created an override for this specific field for search
  if override_search_field?(column)
    send(override_search_field(column), @record, options)

  # second, check if the dev has specified a valid search_ui for this column, using specific ui for searches
  elsif column.search_ui and override_search?(column.search_ui)
    send(override_search(column.search_ui), column, options)

  # third, check if the dev has specified a valid search_ui for this column, using generic ui for forms
  elsif column.search_ui and override_input?(column.search_ui)
    send(override_input(column.search_ui), column, options)

  # fourth, check if the dev has created an override for this specific field
  elsif override_form_field?(column)
    send(override_form_field(column), @record, options)

  # fallback: we get to make the decision
  else
    if column.association or column.virtual?
      active_scaffold_search_text(column, options)

    else # regular model attribute column
      # if we (or someone else) have created a custom render option for the column type, use that
      if override_search?(column.column[:type])
        send(override_search(column.column[:type]), column, options)
      # if we (or someone else) have created a custom render option for the column type, use that
      elsif override_input?(column.column[:type])
        send(override_input(column.column[:type]), column, options)
      # final ultimate fallback: use rails' generic input method
      else
        # for textual fields we pass different options
        text_types = [:text, :string, :integer, :float, :decimal]
        options = active_scaffold_input_text_options(options) if text_types.include?(column.column[:type])
        text_field(:record, column.name, options.merge(column.options))
      end
    end
  end
end

#active_scaffold_search_multi_select(column, options) ⇒ Object

Search input methods



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 58

def active_scaffold_search_multi_select(column, options)
  associated = options.delete :value
  associated = [associated].compact unless associated.is_a? Array
  associated.collect!(&:to_i)
  
  if column.association
    select_options = options_for_association(column.association, false)
  else
    select_options = column.options[:options].collect do |text, value|
      active_scaffold_translated_option(column, text, value)
    end
  end
  return as_(:no_options) if select_options.empty?

  active_scaffold_checkbox_list(column, select_options, associated, options)
end

#active_scaffold_search_null(column, options) ⇒ Object 



115
116
117
118
119
120
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 115

def active_scaffold_search_null(column, options)
  select_options = []
  select_options << [as_(:_select_), nil]
  select_options.concat ActiveScaffold::Finder::NullComparators.collect {|comp| [as_(comp), comp]}
  select_tag(options[:name], options_for_select(select_options, field_search_params[column.name]))
end

#active_scaffold_search_options(column) ⇒ Object

the standard active scaffold options used for class, name and scope



50
51
52
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 50

def active_scaffold_search_options(column)
  { :name => "search[#{column.name}]", :class => "#{column.name}-input", :id => "search_#{column.name}", :value => field_search_params[column.name] }
end

#active_scaffold_search_range(column, options) ⇒ Object Also known as: active_scaffold_search_integer, active_scaffold_search_decimal, active_scaffold_search_float, active_scaffold_search_string 



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
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 162

def active_scaffold_search_range(column, options)
  opt_value, from_value, to_value = field_search_params_range_values(column)

  select_options = active_scaffold_search_range_comparator_options(column)
  if active_scaffold_search_range_string?(column)
    text_field_size = 15
    opt_value ||= '%?%'
  else
    text_field_size = 10
    opt_value ||= '='
  end
  
  from_value = controller.class.condition_value_for_numeric(column, from_value)
  to_value = controller.class.condition_value_for_numeric(column, to_value)
  from_value = format_number_value(from_value, column.options) if from_value.is_a?(Numeric)
  to_value = format_number_value(to_value, column.options) if to_value.is_a?(Numeric)
  html = select_tag("#{options[:name]}[opt]",
        options_for_select(select_options, opt_value),
        :id => "#{options[:id]}_opt",
        :class => "as_search_range_option")
  html << ' ' << text_field_tag("#{options[:name]}[from]", from_value, active_scaffold_input_text_options(:id => options[:id], :size => text_field_size))
  html << ' ' << content_tag(:span, (' - ' + text_field_tag("#{options[:name]}[to]", to_value,
        active_scaffold_input_text_options(:id => "#{options[:id]}_to", :size => text_field_size))).html_safe,
        :id => "#{options[:id]}_between", :class => "as_search_range_between", :style => "display:#{(opt_value == 'BETWEEN') ? '' : 'none'}")
  content_tag :span, html, :class => 'search_range'
end

#active_scaffold_search_range_comparator_options(column) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 142

def active_scaffold_search_range_comparator_options(column)
  select_options = ActiveScaffold::Finder::NumericComparators.collect {|comp| [as_(comp.downcase.to_sym), comp]}
  if active_scaffold_search_range_string?(column)
    select_options.unshift *ActiveScaffold::Finder::StringComparators.collect {|title, comp| [as_(title), comp]}
  end
  if include_null_comparators? column
    select_options += ActiveScaffold::Finder::NullComparators.collect {|comp| [as_(comp), comp]}
  end
  select_options
end

#active_scaffold_search_range_string?(column) ⇒ Boolean

Returns:

  • (Boolean) 


129
130
131
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 129

def active_scaffold_search_range_string?(column)
  (column.column && column.column.text?) || column.search_ui == :string
end

#active_scaffold_search_select(column, html_options) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 75

def active_scaffold_search_select(column, html_options)
  associated = html_options.delete :value
  if column.association
    associated = associated.is_a?(Array) ? associated.map(&:to_i) : associated.to_i unless associated.nil?
    method = column.association.macro == :belongs_to ? column.association.foreign_key : column.name
    select_options = options_for_association(column.association, true)
  else
    method = column.name
    select_options = column.options[:options].collect do |text, value|
      active_scaffold_translated_option(column, text, value)
    end
  end

  options = { :selected => associated }.merge! column.options
  html_options.merge! column.options[:html_options] || {}
  if html_options[:multiple]
    html_options[:name] += '[]'
  else
    options[:include_blank] ||= as_(:_select_) 
  end
  select(:record, method, select_options, options, html_options)
end

#active_scaffold_search_text(column, options) ⇒ Object 



98
99
100
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 98

def active_scaffold_search_text(column, options)
  text_field :record, column.name, active_scaffold_input_text_options(options)
end

#active_scaffold_search_time(column, options) ⇒ Object 



209
210
211
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 209

def active_scaffold_search_time(column, options)
  active_scaffold_search_datetime(column, options.merge!(:discard_date => true))
end

#field_search_datetime_value(value) ⇒ Object 



193
194
195
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 193

def field_search_datetime_value(value)
  DateTime.new(value[:year].to_i, value[:month].to_i, value[:day].to_i, value[:hour].to_i, value[:minute].to_i, value[:second].to_i) unless value.nil? || value[:year].blank?
end

#field_search_params_range_values(column) ⇒ Object 



122
123
124
125
126
127
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 122

def field_search_params_range_values(column)
  values = field_search_params[column.name]
  return nil if values.nil?
  return values[:opt], (values[:from].blank? ? nil : values[:from]), (values[:to].blank? ? nil : values[:to])
  
end

#include_null_comparators?(column) ⇒ Boolean

Returns:

  • (Boolean) 


133
134
135
136
137
138
139
140
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 133

def include_null_comparators?(column)
  return column.options[:null_comparators] if column.options.has_key? :null_comparators
  if column.association
    column.association.macro != :belongs_to || active_scaffold_config.columns[column.association[:key] || column.association[:left_key]].column.try(:null)
  else
    column.column.try(:null)
  end
end

#override_search(form_ui) ⇒ Object

the naming convention for overriding search input types with helpers



236
237
238
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 236

def override_search(form_ui)
  "active_scaffold_search_#{form_ui}"
end

#override_search?(search_ui) ⇒ Boolean

Returns:

  • (Boolean) 


231
232
233
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 231

def override_search?(search_ui)
  respond_to?(override_search(search_ui))
end

#override_search_field(column) ⇒ Object Also known as: override_search_field?

Search column override signatures



218
219
220
221
222
223
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 218

def override_search_field(column)
  method_with_class = override_search_field_name(column, true)
  return method_with_class if respond_to?(method_with_class)
  method = override_search_field_name(column)
  method if respond_to?(method)
end

#override_search_field_name(column, class_prefix = false) ⇒ Object

the naming convention for overriding form fields with helpers



227
228
229
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 227

def override_search_field_name(column, class_prefix = false)
  "#{clean_class_name(column.active_record_class.name) + '_' if class_prefix}#{clean_column_name(column.name)}_search_column"
end

#searched_by?(column) ⇒ Boolean

Returns:

  • (Boolean) 


254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 254

def searched_by?(column)
  value = field_search_params[column.name]
  case value
  when Hash
    !value['from'].blank?
  when String
    !value.blank?
  else
    false
  end
end

#visibles_and_hiddens(search_config) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/active_scaffold/helpers/search_column_helpers.rb', line 240

def visibles_and_hiddens(search_config)
  visibles = [] 
  hiddens = []
  search_config.columns.each do |column|
    next unless column.search_sql
    if search_config.optional_columns.include?(column.name) && !searched_by?(column)
      hiddens << column
    else
      visibles << column
    end
  end
  return visibles, hiddens
end