Module: YummyGuide::Administrate::FilterControlsHelper

Defined in:
app/helpers/yummy_guide/administrate/filter_controls_helper.rb

Constant Summary collapse

FILTER_CONTROL_ICON_CLASS_MAP = 
{
  "fa-eraser" => :eraser,
  "fa-check-square" => :check_square
}.freeze

Instance Method Summary collapse

Instance Method Details

#admin_filter_body_modal_mount?(modal_mount) ⇒ Boolean

Returns:

  • (Boolean) 


173
174
175
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 173

def admin_filter_body_modal_mount?(modal_mount)
  modal_mount.to_s == "body"
end

#admin_filter_button_container(button_label:, form_markup: nil, modal_id: nil) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 152

def admin_filter_button_container(button_label:, form_markup: nil, modal_id: nil)
  data = { admin_filter_controls: true }
  data[:admin_filter_modal_id] = modal_id if modal_id

  content_tag(:div, id: "reserv-filter-options", data: data) do
    safe_join([
      link_to(button_label, "javascript:void(0)", class: "button"),
      form_markup
    ].compact)
  end
end

#admin_filter_controls(dashboard: nil, page: nil, path: nil, clear_path: nil, search_options: {}, form: :search_options, method: :get, hidden_fields: {}, root_hidden_fields: {}, filter_locals: {}, extra_actions: [], button_label: "Filter", title: "Filter Options", submit_label: "Filter", close_label: "Close", modal_mount: :inline, modal_content_for: :admin_filter_modals) ⇒ Object

Raises:

  • (ArgumentError) 


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
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
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 11

def admin_filter_controls(
  dashboard: nil,
  page: nil,
  path: nil,
  clear_path: nil,
  search_options: {},
  form: :search_options,
  method: :get,
  hidden_fields: {},
  root_hidden_fields: {},
  filter_locals: {},
  extra_actions: [],
  button_label: "Filter",
  title: "Filter Options",
  submit_label: "Filter",
  close_label: "Close",
  modal_mount: :inline,
  modal_content_for: :admin_filter_modals
)
  dashboard ||= admin_filter_dashboard_from_page(page)
  scope = form.to_s
  current_values = admin_filter_current_values(search_options)
  base_locals = filter_locals.merge(
    dashboard: dashboard,
    page: page,
    search_options: search_options,
    current_values: current_values,
    form_scope: scope
  )
  fields = admin_filter_visible_fields(dashboard, base_locals)
  return if fields.blank?

  path ||= admin_filter_dashboard_setting(dashboard, :filter_path, :FILTER_PATH, base_locals)
  raise ArgumentError, "admin_filter_controls requires path or dashboard FILTER_PATH" if path.blank?

  clear_path ||= admin_filter_dashboard_setting(dashboard, :filter_clear_path, :FILTER_CLEAR_PATH, base_locals) || path
  locals = filter_locals.merge(
    dashboard: dashboard,
    page: page,
    path: path,
    clear_path: clear_path,
    search_options: search_options,
    current_values: current_values,
    form_scope: scope
  )

  form_markup = admin_filter_form(
    fields: fields,
    scope: scope,
    path: path,
    clear_path: clear_path,
    method: method,
    current_values: current_values,
    hidden_fields: hidden_fields,
    root_hidden_fields: root_hidden_fields,
    locals: locals,
    extra_actions: extra_actions,
    title: title,
    submit_label: submit_label,
    close_label: close_label
  )

  if admin_filter_body_modal_mount?(modal_mount)
    modal_id = admin_filter_next_modal_id
    content_for(modal_content_for, admin_filter_modal_root(modal_id: modal_id, form_markup: form_markup))

    return admin_filter_button_container(button_label: button_label, modal_id: modal_id)
  end

  safe_join([
    content_tag(:div, "", class: "modal_overlay", data: { admin_filter_overlay: true }),
    admin_filter_button_container(button_label: button_label, form_markup: form_markup)
  ])
end

#admin_filter_current_values(raw_values) ⇒ Object 



229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 229

def admin_filter_current_values(raw_values)
  values =
    if raw_values.respond_to?(:to_unsafe_h)
      raw_values.to_unsafe_h
    elsif raw_values.respond_to?(:to_h)
      raw_values.to_h
    else
      raw_values || {}
    end

  values.deep_stringify_keys
end

#admin_filter_dashboard_constant(dashboard, constant_name) ⇒ Object 



106
107
108
109
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 106

def admin_filter_dashboard_constant(dashboard, constant_name)
  target = dashboard.is_a?(Class) ? dashboard : dashboard.class
  target.const_get(constant_name, false) if target.const_defined?(constant_name, false)
end

#admin_filter_dashboard_from_page(page) ⇒ Object 



86
87
88
89
90
91
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 86

def admin_filter_dashboard_from_page(page)
  return page.dashboard if page.respond_to?(:dashboard)
  return unless page.respond_to?(:instance_variable_defined?) && page.instance_variable_defined?(:@dashboard)

  page.instance_variable_get(:@dashboard)
end

#admin_filter_dashboard_setting(dashboard, method_name, constant_name, locals) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 93

def admin_filter_dashboard_setting(dashboard, method_name, constant_name, locals)
  return if dashboard.blank?

  value =
    if dashboard.respond_to?(method_name)
      dashboard.public_send(method_name)
    else
      admin_filter_dashboard_constant(dashboard, constant_name)
    end

  admin_filter_evaluate_value(value, locals)
end

#admin_filter_evaluate_value(value, locals) ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 216

def admin_filter_evaluate_value(value, locals)
  return value unless value.respond_to?(:call)

  case value.arity
  when 0
    value.call
  when 1
    value.call(self)
  else
    value.call(self, locals)
  end
end

#admin_filter_evaluated_hash(values) ⇒ Object 



211
212
213
214
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 211

def admin_filter_evaluated_hash(values)
  values = admin_filter_evaluate_value(values, {})
  (values || {}).to_h
end

#admin_filter_form(fields:, scope:, path:, clear_path:, method:, current_values:, hidden_fields:, root_hidden_fields:, locals:, extra_actions:, title:, submit_label:, close_label:) ⇒ Object 



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
145
146
147
148
149
150
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 120

def admin_filter_form(fields:, scope:, path:, clear_path:, method:, current_values:, hidden_fields:, root_hidden_fields:, locals:, extra_actions:, title:, submit_label:, close_label:)
  form_with(
    url: path,
    scope: scope,
    method: method,
    html: {
      class: "filter-form",
      data: {
        yummy_guide_administrate_filter_form: true,
        admin_filter_form: true
      }
    }
  ) do |f|
    safe_join([
      admin_filter_hidden_fields(scope, hidden_fields, root_hidden_fields),
      admin_filter_form_header(title: title, close_label: close_label),
      content_tag(:div, class: "filter-form__body") do
        content_tag(:table, class: "filter_table") do
          safe_join(fields.map { |field| field.row(self, f, scope, current_values, locals) })
        end
      end,
      content_tag(:div, class: "filter-form__actions") do
        safe_join([
          link_to("Clear", clear_path, class: "button button--outline-primary", data: { behavior: "filter-form-clear-link" }),
          Array(extra_actions),
          f.submit(submit_label, class: "submit_filter")
        ].flatten)
      end
    ])
  end
end

#admin_filter_form_header(title:, close_label:) ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 183

def admin_filter_form_header(title:, close_label:)
  content_tag(:div, class: "filter-form__header") do
    safe_join([
      content_tag(:h2, title, class: "filter-form__title"),
      button_tag(
        "x",
        type: "button",
        class: "filter-form__close",
        data: { behavior: "filter-form-close" },
        aria: { label: close_label },
        title: close_label
      )
    ])
  end
end

#admin_filter_hidden_fields(scope, hidden_fields, root_hidden_fields) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 199

def admin_filter_hidden_fields(scope, hidden_fields, root_hidden_fields)
  root_tags = admin_filter_evaluated_hash(root_hidden_fields).map do |key, value|
    hidden_field_tag(key, value)
  end

  scoped_tags = admin_filter_evaluated_hash(hidden_fields).map do |key, value|
    hidden_field_tag("#{scope}[#{key}]", value)
  end

  safe_join(root_tags + scoped_tags)
end

#admin_filter_modal_root(modal_id:, form_markup:) ⇒ Object 



164
165
166
167
168
169
170
171
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 164

def admin_filter_modal_root(modal_id:, form_markup:)
  content_tag(:div, id: modal_id, class: "admin-filter-modal-root", data: { admin_filter_modal_root: true }) do
    safe_join([
      content_tag(:div, "", class: "modal_overlay", data: { admin_filter_overlay: true }),
      form_markup
    ])
  end
end

#admin_filter_next_modal_id ⇒ Object 



177
178
179
180
181
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 177

def admin_filter_next_modal_id
  @admin_filter_controls_modal_index ||= 0
  @admin_filter_controls_modal_index += 1
  "admin-filter-modal-#{@admin_filter_controls_modal_index}"
end

#admin_filter_visible_fields(dashboard, locals) ⇒ Object 



111
112
113
114
115
116
117
118
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 111

def admin_filter_visible_fields(dashboard, locals)
  return [] if dashboard.blank?

  YummyGuide::Administrate::Filters::Resolver
    .attributes_for(dashboard)
    .values
    .select { |field| field.visible?(self, locals) }
end

#checkbox_group_action_button(label:, behavior:, target:, icon: nil, icon_class: nil, title: nil) ⇒ Object 



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 301

def checkbox_group_action_button(label:, behavior:, target:, icon: nil, icon_class: nil, title: nil)
  accessible_label = title || label
  icon ||= filter_control_icon_name_from_class(icon_class)

  button_tag(
    type: "button",
    class: "filter-icon-button",
    data: { behavior: behavior, target: target },
    aria: { label: accessible_label },
    title: accessible_label
  ) do
    if icon.present?
      filter_control_icon(icon)
    else
      label
    end
  end
end

#checkbox_group_action_cell(target:) ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 276

def checkbox_group_action_cell(target:)
  content_tag(:td, class: "filter-table__clear filter-table__checkbox-actions") do
    content_tag(
      :div,
      safe_join([
        checkbox_group_select_all_button(target: target),
        checkbox_group_clear_all_button(target: target)
      ]),
      class: "filter-checkbox-group__actions filter-checkbox-group__actions--clear-cell"
    )
  end
end

#checkbox_group_clear_all_button(target:) ⇒ Object 



267
268
269
270
271
272
273
274
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 267

def checkbox_group_clear_all_button(target:)
  checkbox_group_action_button(
    icon: :eraser,
    label: "Clear all",
    behavior: "checkbox-group-clear-all",
    target: target
  )
end

#checkbox_group_select_all_button(target:) ⇒ Object 



258
259
260
261
262
263
264
265
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 258

def checkbox_group_select_all_button(target:)
  checkbox_group_action_button(
    icon: :check_square,
    label: "Select all",
    behavior: "checkbox-group-select-all",
    target: target
  )
end

#filter_control_icon(icon) ⇒ Object 



289
290
291
292
293
294
295
296
297
298
299
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 289

def filter_control_icon(icon)
  icon_name = icon.to_s.tr("_", "-")

  content_tag(
    :span,
    "",
    class: "filter-control-icon filter-control-icon--#{icon_name}",
    data: { filter_icon: icon_name },
    aria: { hidden: true }
  )
end

#filter_control_icon_name_from_class(icon_class) ⇒ Object 



320
321
322
323
324
325
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 320

def filter_control_icon_name_from_class(icon_class)
  classes = icon_class.to_s.split
  icon_class_name = FILTER_CONTROL_ICON_CLASS_MAP.keys.find { |class_name| classes.include?(class_name) }

  FILTER_CONTROL_ICON_CLASS_MAP[icon_class_name]
end

#filter_field_clear_button ⇒ Object 



242
243
244
245
246
247
248
249
250
251
252
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 242

def filter_field_clear_button
  button_tag(
    type: "button",
    class: "filter-field-clear-button",
    data: { behavior: "filter-field-clear" },
    aria: { label: "Clear this filter" },
    title: "Clear this filter"
  ) do
    filter_control_icon(:eraser)
  end
end

#filter_field_clear_cell ⇒ Object 



254
255
256
 
# File 'app/helpers/yummy_guide/administrate/filter_controls_helper.rb', line 254

def filter_field_clear_cell
  content_tag(:td, filter_field_clear_button, class: "filter-table__clear")
end