Module: SearchesHelper

Included in:
ExportedCatalogItemPacket
Defined in:
app/helpers/searches_helper.rb

Overview

View helper: searches.

Instance Method Summary collapse

Instance Method Details

#adv_sortable(column, title = nil, _options = {}) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'app/helpers/searches_helper.rb', line 135

def adv_sortable(column, title = nil, _options = {})
  title ||= column.to_s.titleize
  title = title.html_safe
  direction = 'ASC'
  # Some of our columns are composite column constituded of other columns, we retrieve them to compare if we should highlight the table header
  composite_order_columns = @search.all_composite_columns[column.to_sym].try(:[], :select) || []
  # Is our table header column present in the current sort columns of the query or is it present and part of a composite set.
  if (sort_direction = @search.sort_columns_to_hash[column.to_sym] || @search.sort_columns_to_hash.keys.intersect?(composite_order_columns))
    index = @search.sort_columns_to_hash.keys.index(column.to_sym)
    title = (content_tag(:sup, " [#{index + 1}] ") + title) if index
    if %i[desc DESC].include?(sort_direction)
      title = fa_icon('chevron-down', text: title)
    else # :asc
      title = fa_icon('chevron-up', text: title)
      direction = 'DESC'
    end
    style = 'font-weight:bolder'
  end
  parameters = request.params.compact_blank
  parameters = parameters.symbolize_keys if parameters.present?
  parameters[:sort] = column
  parameters[:direction] = direction
  content_tag :th, link_to(title, parameters), style: style
end

#cross_reference_customer_search_collection ⇒ Object 



198
199
200
201
202
 
# File 'app/helpers/searches_helper.rb', line 198

def cross_reference_customer_search_collection
  CustomerSearch.where(employee_id: @context_user.id)
                .select('(select count(*) from search_results sr where sr.search_id = searches.id) as selected_results, searches.*')
                .where('(select count(*) from search_results sr where sr.search_id = searches.id) > 0').map { |s| ["#{s.effective_name} (#{s.selected_results} selected)", s.id] }
end

#current_user_recent_searches(user = current_user) ⇒ Object 



6
7
8
 
# File 'app/helpers/searches_helper.rb', line 6

def current_user_recent_searches(user = current_user)
  user.searches.where(persist: false).order(:updated_at).reverse_order.limit(15)
end

#field_wrap(form, name, display = nil) ⇒ Object 



160
161
162
163
164
165
166
167
 
# File 'app/helpers/searches_helper.rb', line 160

def field_wrap(form, name, display = nil)
  display ||= name.to_s.titleize

  content_tag :div, class: 'field' do
    form.label(name, "#{display}:") +
      yield
  end
end

#get_num_records(search_template, options) ⇒ Object 



37
38
39
40
41
42
43
44
45
 
# File 'app/helpers/searches_helper.rb', line 37

def get_num_records(search_template, options)
  case options[:aggregate_method]
  when :sum
    num_records = search_template.result_set.sum(options[:aggregate_column]) if options[:aggregate_column].present?
  when :count
    num_records = options[:num_records] || search_template.result_set_length
  end
  num_records
end

#hash_to_form_params(hash) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'app/helpers/searches_helper.rb', line 107

def hash_to_form_params(hash)
  cleaned_hash = hash.compact_blank
  pairs = cleaned_hash.to_query.split(Rack::Utils::DEFAULT_SEP)
  flattened_hash_params = {} # This allows duplicate keys which is what we want for array input tags
  flattened_hash_params.compare_by_identity
  pairs.map do |pair|
    key, value = pair.split('=', 2).map { |str| Rack::Utils.unescape(str) }
    next if value.blank?

    flattened_hash_params[key] = value
  end
  flattened_hash_params
end

#line_items_search_fields(f) ⇒ Object 



173
174
175
 
# File 'app/helpers/searches_helper.rb', line 173

def line_items_search_fields(f)
  render partial: '/searches/line_items_criteria', locals: { f: f }
end

#permitted_search_types ⇒ Object 



16
17
18
 
# File 'app/helpers/searches_helper.rb', line 16

def permitted_search_types
  Search.options.select { |so| can?(:read, so[1].constantize.new) }
end

#permitted_search_types_classes ⇒ Object 



20
21
22
 
# File 'app/helpers/searches_helper.rb', line 20

def permitted_search_types_classes
  Search.options_classes.select { |search_klass| can?(:read, search_klass.new) }
end

#query_template_link(search_klass, name_key = nil, options = {}) ⇒ Object 



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
 
# File 'app/helpers/searches_helper.rb', line 47

def query_template_link(search_klass, name_key = nil, options = {})
  options[:aggregate_method] ||= :count
  qt = search_klass.instantiate_query_template(name_key, options)
  link_names = []
  if qt.show_count? || options[:num_records].present?
    num_records = get_num_records qt, options
    if num_records.to_i.positive? || options[:show_zero]
      record_badge = number_to_currency(num_records, unit: options[:currency_symbol] || '$', precision: options.fetch(:precision, 2)) if options[:format] == :currency
      record_badge ||= num_records.to_i
      link_names << content_tag(:span, qt&.title&.html_safe) if qt.title.present?
      if options[:counter_class].present?
        counter_class = options[:counter_class]
      elsif link_names.present? # If we have one title entry, then we display badge style
        counter_class = 'ms-2 badge bg-primary'
      end
      if options[:zero_label] && num_records.to_f.zero?
        record_badge = options[:zero_label]
        counter_class = [counter_class, 'text-secondary'].compact.join(' ')
      elsif options[:mute_zero] && num_records.to_f.zero?
        counter_class = [counter_class, 'text-secondary'].compact.join(' ')
      end
      link_names << content_tag(:span, record_badge, class: counter_class) if record_badge.present?
    elsif qt.title
      link_names << content_tag(:span, qt.title)
    end
  elsif qt.title
    link_names << content_tag(:span, qt.title)
  end

  # Test if we are passing a class, then that overrides everything, we test for nil since a blank class
  # might mean we want no default behavior
  css_classes = []
  if options[:class].present?
    css_classes += options[:class].to_s.split
  elsif options[:in_menu].to_b # Apply in menu styling
    css_classes += %w[dropdown-item justify-content-between align-items-center d-flex]
  else
    css_classes = %w[btn btn-link p-0 m-0]
  end

  css_classes << 'btn' if css_classes.find { |cc| cc&.starts_with?('btn-') } && css_classes.exclude?('btn')

  if options[:link_only]
    link_element = link_to(num_records, execute_search_url(qt.to_params))
  else
    css_classes = css_classes.uniq.filter_map(&:presence)
    btn_options = {
      method: :post,
      class: css_classes.join(' '),
      style: options[:style],
      params: hash_to_form_params(qt.to_params)
}.compact
    link_element = button_to(searches_path, **btn_options) { link_names.compact.join.html_safe }
  end
  [
    link_element,
    num_records
  ]
end

#result_search_selector(r) ⇒ Object

Row selector checkbox on search result tables.

Class .search-result-row is the cascade-target hook for check-all
(header → rows). The change action then fires checkbox-persist#rowChange
which POSTs the diff to SearchesController#record. Both controllers
are stacked on the wrapping div in _search_results.html.erb.



127
128
129
130
131
132
133
 
# File 'app/helpers/searches_helper.rb', line 127

def result_search_selector(r)
  content_tag :td, check_box_tag(:resource_id,
                                 "#{r.class.main_resource_class}|#{r.id}",
                                 r.search_selected,
                                 class: 'search-result-row',
                                 data: { action: 'change->checkbox-persist#rowChange' })
end

#rma_items_search_fields(f) ⇒ Object 



177
178
179
 
# File 'app/helpers/searches_helper.rb', line 177

def rma_items_search_fields(f)
  render partial: '/searches/rma_items_criteria', locals: { f: f }
end

#sales_rep_fields(f, fields: nil) ⇒ Object 



169
170
171
 
# File 'app/helpers/searches_helper.rb', line 169

def sales_rep_fields(f, fields: nil)
  render partial: '/searches/sales_rep_fields', locals: { f: f, fields: fields }
end

#search_breadcrumb(search) ⇒ Object 



10
11
12
13
14
 
# File 'app/helpers/searches_helper.rb', line 10

def search_breadcrumb(search)
  content_tag(:li, link_to(search.type.to_s.titleize.pluralize,
                           employee_searches_path(@context_user, type: search.type.to_s))) +
    content_tag(:li, link_to("#{search.type.to_s.titleize} #{search.id}", search_path(search)))
end

#search_range_text_field(form, name, display = nil, options = {}) ⇒ Object 



208
209
210
 
# File 'app/helpers/searches_helper.rb', line 208

def search_range_text_field(form, name, display = nil, options = {})
  form.input name.to_sym, label: display || name, as: options[:class] == 'datepicker' ? :between_or_equal_date : :between_or_equal
end

#search_select_field(form, name, display = nil, list = [%w[Yes y], %w[No n]], options = {}) ⇒ Object 



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'app/helpers/searches_helper.rb', line 181

def search_select_field(form, name, display = nil, list = [%w[Yes y], %w[No n]], options = {})
  options[:multiple] = true if options[:multiple].nil?
  options[:include_blank] = true if options[:include_blank].nil?
  form.input name,
             label: display,
             as: :tom_select,
             collection: list,
             selected: @search.query_params[name],
             include_blank: options[:include_blank],
             input_html: {
               multiple: options[:multiple],
               style: options[:style]
             },
             required: false,
             hint: options[:hint]
end

#search_text_field(form, name, display = nil, options = {}) ⇒ Object 



204
205
206
 
# File 'app/helpers/searches_helper.rb', line 204

def search_text_field(form, name, display = nil, options = {})
  form.input name, label: display, input_html: { value: @search.query_params[name], class: options[:class], style: options[:style] }, required: false, hint: options[:hint]
end

#simple_search_link(search_klass, query_params: {}, selected_columns: nil, num_records: nil, format: nil, title: nil, link_class: nil, auto_count: false) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'app/helpers/searches_helper.rb', line 24

def simple_search_link(search_klass, query_params: {}, selected_columns: nil, num_records: nil, format: nil, title: nil, link_class: nil, auto_count: false)
  query_template_link(search_klass, nil,
                      {
                        query_params: query_params,
                        selected_columns: selected_columns,
                        num_records: num_records,
                        format: format,
                        title: title,
                        class: link_class,
                        auto_count: auto_count
                      }.compact)&.first
end

#yes_no_boolean_field(form, name, display) ⇒ Object 



212
213
214
215
216
217
218
219
220
221
 
# File 'app/helpers/searches_helper.rb', line 212

def yes_no_boolean_field(form, name, display)
  html_opts = { multiple: false, style: 'width:150px' }
  form.input name, label: display,
                   as: :select,
                   selected: @search.query_params[name],
                   include_blank: true,
                   collection: [%w[Yes true], %w[No false]],
                   input_html: html_opts,
                   required: false
end