Module: Worthwhile::RenderConstraintsHelper

Included in:
MainAppHelpers
Defined in:
app/helpers/worthwhile/render_constraints_helper.rb

Instance Method Summary collapse

Instance Method Details

#constraint_query_label(localized_params = params) ⇒ String

We can remove this method once we use Blacklight > 5.4.0

Return a label for the currently selected search field. If no “search_field” or the default (e.g. “all_fields”) is selected, then return nil Otherwise grab the label of the selected search field.

Parameters:

  • query (Hash) —

    parameters

Returns:

  • (String) 


28
29
30
 
# File 'app/helpers/worthwhile/render_constraints_helper.rb', line 28

def constraint_query_label(localized_params = params)
  label_for_search_field(localized_params[:search_field]) unless default_search_field?(localized_params[:search_field])
end

#default_search_field?(selected_search_field) ⇒ Boolean

We can remove this method once we use Blacklight > 5.4.0

Is the search form using the default search field (“all_fields” by default)?

Parameters:

  • the (String) —

    currently selected search_field

Returns:

  • (Boolean) 


38
39
40
 
# File 'app/helpers/worthwhile/render_constraints_helper.rb', line 38

def default_search_field?(selected_search_field)
  selected_search_field.blank? || (default_search_field && selected_search_field == default_search_field[:key])
end

#render_constraints_query(localized_params = params) ⇒ String

Overridden to remove the ‘search_field’ tag from the localized params when the query is cleared. This is because unlike Blacklight, there is no way to change the search_field in the worthwhile UI

Render the query constraints

Parameters:

  • query (Hash) —

    parameters

Returns:

  • (String) 


10
11
12
13
14
15
16
17
18
 
# File 'app/helpers/worthwhile/render_constraints_helper.rb', line 10

def render_constraints_query(localized_params = params)
  # So simple don't need a view template, we can just do it here.
  return "".html_safe if localized_params[:q].blank?

  render_constraint_element(constraint_query_label(localized_params),
        localized_params[:q],
        classes: ["query"],
        remove: url_for(localized_params.except(:search_field).merge(q: nil, action: 'index')))
end