Module: BlacklightRangeLimit::RangeLimitBuilder

Extended by:
ActiveSupport::Concern
Includes:
SegmentCalculation
Defined in:
lib/blacklight_range_limit/range_limit_builder.rb

Instance Method Summary collapse

Instance Method Details

#_bl_range_limit_app_params ⇒ Object 



82
83
84
 
# File 'lib/blacklight_range_limit/range_limit_builder.rb', line 82

def _bl_range_limit_app_params
  blacklight_params
end

#add_range_limit_params(solr_params) ⇒ Object

Method added to to fetch proper things for date ranges.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/blacklight_range_limit/range_limit_builder.rb', line 14

def add_range_limit_params(solr_params)
  ranged_facet_configs = blacklight_config.facet_fields.select { |_key, config| config.range }
  return solr_params unless ranged_facet_configs.any?

  solr_params["stats"] = "true"
  solr_params["stats.field"] ||= []

  ranged_facet_configs.each do |field_key, config|
    solr_params["stats.field"] << config.field

    range_config = config.range_config
    next unless range_config[:chart_js] || range_config[:textual_facets]

    selected_value = search_state.filter(config.key).values.first

    range = bl_create_selected_range_value(selected_value, config)

    # If we have both ends of a range
    add_range_segments_to_solr!(solr_params, field_key, range.begin, range.end) if range && range.count != Float::INFINITY
  end

  solr_params
end

#bl_create_selected_range_value(selected_value, field_config) ⇒ Object

Range created from a range value or from assumed boundaries if present, and clamped between min and max



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/blacklight_range_limit/range_limit_builder.rb', line 122

def bl_create_selected_range_value(selected_value, field_config)
  range_config = field_config.range_config

  range = if selected_value.is_a? Range
    selected_value
  elsif range_config[:assumed_boundaries].is_a?(Range)
    range_config[:assumed_boundaries]
  elsif range_config[:assumed_boundaries] # Array of two things please
    Range.new(*range_config[:assumed_boundaries])
  else
    nil
  end

  # clamp between config'd min and max
  min = range_config[:min_value]
  max = range_config[:max_value]

  range = Range.new(
    (range.begin.clamp(min, max) if range.begin),
    (range.end.clamp(min, max) if range.end),
  ) if range

  range
end

#facet_value_to_fq_string(facet_field, value, use_local_params: true) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/blacklight_range_limit/range_limit_builder.rb', line 96

def facet_value_to_fq_string(facet_field, value, use_local_params: true)
  facet_config = blacklight_config.facet_fields[facet_field]

  # if it's an one-end range, and condition from original that would use query instead isn't met
  if value.is_a?(Range) && (value.count == Float::INFINITY) && !facet_config&.query
    # Adapted from
    # https://github.com/projectblacklight/blacklight/blob/1494bd0884efe7a48623e9b37abe558fa6348e2a/lib/blacklight/solr/search_builder_behavior.rb#L362-L366

    solr_field = facet_config.field if facet_config && !facet_config.query
    solr_field ||= facet_field

    local_params = []
    local_params << "tag=#{facet_config.tag}" if use_local_params && facet_config && facet_config.tag

    prefix = "{!#{local_params.join(' ')}}" unless local_params.empty?

    "#{prefix}#{solr_field}:[#{value.begin || "*"} TO #{value.end || "*"}]"
  else
    super
  end
end

#fetch_specific_range_limit(solr_params) ⇒ Object

Another processing method, this one is NOT included in default processing chain, it is specifically swapped in instead of add_range_limit_params for certain ajax requests that only want to fetch range limit segments for ONE field.

It turns off facetting and sets rows to 0 as well, only results for single specified field are needed.

Specified field and parameters are specified in incoming parameters range_field, range_start, range_end



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
 
# File 'lib/blacklight_range_limit/range_limit_builder.rb', line 49

def fetch_specific_range_limit(solr_params)
  field_key = _bl_range_limit_app_params[:range_field] # what field to fetch for

  unless  _bl_range_limit_app_params[:range_start].present? && _bl_range_limit_app_params[:range_start].kind_of?(String) &&
          _bl_range_limit_app_params[:range_end].present? && _bl_range_limit_app_params[:range_end].kind_of?(String)
    raise BlacklightRangeLimit::InvalidRange
  end

  start = _bl_range_limit_app_params[:range_start].to_i
  finish = _bl_range_limit_app_params[:range_end].to_i

  add_range_segments_to_solr!(solr_params, field_key, start, finish )

  # Remove all field faceting for efficiency, we won't be using it.
  solr_params.delete("facet.field")
  solr_params.delete("facet.field".to_sym)

  # We don't need any actual rows either
  solr_params[:rows] = 0

  return solr_params
rescue BlacklightRangeLimit::InvalidRange
  # This will make Rails return a 400
  raise ActionController::BadRequest, "invalid range_start (#{_bl_range_limit_app_params[:range_start]}) or range_end (#{_bl_range_limit_app_params[:range_end]})"
end