Module: BlacklightRangeLimit::ViewHelperOverride

Defined in:
lib/blacklight_range_limit/view_helper_override.rb

Overview

Meant to be applied on top of Blacklight helpers, to over-ride Will add rendering of limit itself in sidebar, and of constraings display.

Instance Method Summary collapse

Instance Method Details

#facet_partial_name(display_facet) ⇒ Object 



23
24
25
26
 
# File 'lib/blacklight_range_limit/view_helper_override.rb', line 23

def facet_partial_name(display_facet)
  return "blacklight_range_limit/range_limit_panel" if range_config(display_facet.name) and should_show_limit(display_facet.name)
  super
end

#has_range_limit_parameters?(params = params) ⇒ Boolean

Returns:

  • (Boolean) 


6
7
8
9
10
11
12
 
# File 'lib/blacklight_range_limit/view_helper_override.rb', line 6

def has_range_limit_parameters?(params = params)
  params[:range] && 
    params[:range].any? do |key, v| 
      v.present? && v.respond_to?(:'[]') && 
      (v["begin"].present? || v["end"].present? || v["missing"].present?)
    end
end

#has_search_parameters? ⇒ Boolean

over-ride, call super, but make sure our range limits count too

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/blacklight_range_limit/view_helper_override.rb', line 15

def has_search_parameters?
  super || has_range_limit_parameters?
end

#query_has_constraints?(params = params) ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/blacklight_range_limit/view_helper_override.rb', line 19

def query_has_constraints?(params = params)         
  super || has_range_limit_parameters?(params)
end

#remove_range_param(solr_field, my_params = params) ⇒ Object 



63
64
65
66
67
68
69
70
 
# File 'lib/blacklight_range_limit/view_helper_override.rb', line 63

def remove_range_param(solr_field, my_params = params)
  if ( my_params["range"] )
    my_params = my_params.dup
    my_params["range"] = my_params["range"].dup
    my_params["range"].delete(solr_field)
  end
  return my_params
end

#render_constraints_filters(my_params = params) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/blacklight_range_limit/view_helper_override.rb', line 28

def render_constraints_filters(my_params = params)
  content = super(my_params)
  # add a constraint for ranges?
  unless my_params[:range].blank?
    my_params[:range].each_pair do |solr_field, hash|
      next unless hash["missing"] || (!hash["begin"].blank?) || (!hash["end"].blank?)
      content << render_constraint_element(
        facet_field_labels[solr_field],
        range_display(solr_field, my_params),
        :escape_value => false,
        :remove => remove_range_param(solr_field, my_params)
      )                      
    end
  end
  return content
end

#render_search_to_s_filters(my_params) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/blacklight_range_limit/view_helper_override.rb', line 45

def render_search_to_s_filters(my_params)
  content = super(my_params)
  # add a constraint for ranges?
  unless my_params[:range].blank?
    my_params[:range].each_pair do |solr_field, hash|
      next unless hash["missing"] || (!hash["begin"].blank?) || (! hash["end"].blank?)        
      
      content << render_search_to_s_element(
        facet_field_labels[solr_field],
        range_display(solr_field, my_params),
        :escape_value => false
      )          
    
    end
  end
  return content
end

#solr_range_queries_to_a(solr_field) ⇒ Object

Looks in the solr @response for [“facet_counts“][solr_field], for elements expressed as ”solr_field:[X to Y]“, turns them into a list of hashes with [:from, :to, :count], sorted by :from. Assumes integers for sorting purposes.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/blacklight_range_limit/view_helper_override.rb', line 76

def solr_range_queries_to_a(solr_field)
  return [] unless @response["facet_counts"] && @response["facet_counts"]["facet_queries"]

  array = []

  @response["facet_counts"]["facet_queries"].each_pair do |query, count|
    if query =~ /#{solr_field}: *\[ *(\d+) *TO *(\d+) *\]/
      array << {:from => $1, :to => $2, :count => count}
    end
  end
  array = array.sort_by {|hash| hash[:from].to_i }

  return array
end