Class: Blacklight::SearchBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/blacklight/search_builder.rb

Overview

Blacklight's SearchBuilder converts blacklight request parameters into query parameters appropriate for search index. It does so by evaluating a chain of processing methods to populate a result hash (see #to_hash).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope) ⇒ SearchBuilder #initialize(processor_chain, scope) ⇒ SearchBuilder

Returns a new instance of SearchBuilder.

Overloads:

  • #initialize(scope) ⇒ SearchBuilder

    Parameters:

    • scope (Object) —

      scope the scope where the filter methods reside in.

  • #initialize(processor_chain, scope) ⇒ SearchBuilder

    Parameters:

    • processor_chain (List<Symbol>, TrueClass) —

      options a list of filter methods to run or true, to use the default methods

    • scope (Object) —

      the scope where the filter methods reside in.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/blacklight/search_builder.rb', line 18

def initialize(*options)
  case options.size
  when 1
    @processor_chain = default_processor_chain.dup
    @scope = options.first
  when 2
    @processor_chain, @scope = options
  else
    raise ArgumentError, "wrong number of arguments. (#{options.size} for 1..2)"
  end

  @blacklight_params = {}
  search_state_class = @scope&.search_state_class || Blacklight::SearchState
  @search_state = search_state_class.new(@blacklight_params, @scope&.blacklight_config, @scope)
  @additional_filters = {}
  @merged_params = {}
  @reverse_merged_params = {}
end

Instance Attribute Details

#blacklight_params ⇒ Object (readonly)

Returns the value of attribute blacklight_params.



11
12
13
 
# File 'lib/blacklight/search_builder.rb', line 11

def blacklight_params
  @blacklight_params
end

#processor_chain ⇒ Object (readonly)

Returns the value of attribute processor_chain.



11
12
13
 
# File 'lib/blacklight/search_builder.rb', line 11

def processor_chain
  @processor_chain
end

#search_state ⇒ Object (readonly)

Returns the value of attribute search_state.



11
12
13
 
# File 'lib/blacklight/search_builder.rb', line 11

def search_state
  @search_state
end

Instance Method Details

#append(*addl_processor_chain) ⇒ Object

Append additional processor chain directives



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/blacklight/search_builder.rb', line 59

def append(*addl_processor_chain)
  params_will_change!
  builder = self.class.new(processor_chain + addl_processor_chain, scope)
      .with(search_state)
      .merge(@merged_params)
      .reverse_merge(@reverse_merged_params)

  builder.start = @start if @start
  builder.rows  = @rows if @rows
  builder.page  = @page if @page
  builder.facet = @facet if @facet
  builder
end

#except(*except_processor_chain) ⇒ Object

Converse to append, remove processor chain directives, returning a new builder that's a copy of receiver with specified change.

Methods in argument that aren't currently in processor chain are ignored as no-ops, rather than raising.



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/blacklight/search_builder.rb', line 80

def except(*except_processor_chain)
  builder = self.class.new(processor_chain - except_processor_chain, scope)
      .with(search_state)
      .merge(@merged_params)
      .reverse_merge(@reverse_merged_params)

  builder.start = @start if @start
  builder.rows  = @rows if @rows
  builder.page  = @page if @page
  builder.facet = @facet if @facet
  builder
end

#facet(value = nil) ⇒ Object

Parameters:

  • value (Object) (defaults to: nil) 


216
217
218
219
220
221
222
 
# File 'lib/blacklight/search_builder.rb', line 216

def facet(value = nil)
  if value
    self.facet = value
    return self
  end
  @facet
end

#facet=(value) ⇒ Object

sets the facet that this query pertains to, for the purpose of facet pagination



210
211
212
213
 
# File 'lib/blacklight/search_builder.rb', line 210

def facet=(value)
  params_will_change!
  @facet = value
end

#merge(extra_params, &block) ⇒ Object

Merge additional, repository-specific parameters



95
96
97
98
99
100
101
 
# File 'lib/blacklight/search_builder.rb', line 95

def merge(extra_params, &block)
  if extra_params
    params_will_change!
    @merged_params.merge!(extra_params.to_hash, &block)
  end
  self
end

#page(value = nil) ⇒ Object

Parameters:

  • value (#to_i) (defaults to: nil) 


180
181
182
183
184
185
186
 
# File 'lib/blacklight/search_builder.rb', line 180

def page(value = nil)
  if value
    self.page = value
    return self
  end
  @page ||= search_state.page
end

#page=(value) ⇒ Object 



173
174
175
176
177
 
# File 'lib/blacklight/search_builder.rb', line 173

def page=(value)
  params_will_change!
  @page = value.to_i
  @page = 1 if @page < 1
end

#processed_parameters ⇒ Object

The CatalogController #index action uses this. Solr parameters can come from a number of places. From lowest precedence to highest:

1. General defaults in blacklight config (are trumped by)
2. defaults for the particular search field identified by  params[:search_field] (are trumped by)
3. certain parameters directly on input HTTP query params
   * not just any parameter is grabbed willy nilly, only certain ones are allowed by HTTP input)
   * for legacy reasons, qt in http query does not over-ride qt in search field definition default.
4.  extra parameters passed in as argument.

spellcheck.q will be supplied with the [:q] value unless specifically specified otherwise.

Incoming parameter :f is mapped to :fq solr parameter.

Returns:

  • a params hash for searching solr.



145
146
147
148
149
150
151
 
# File 'lib/blacklight/search_builder.rb', line 145

def processed_parameters
  request.tap do |request_parameters|
    processor_chain.each do |method_name|
      send(method_name, request_parameters)
    end
  end
end

#reverse_merge(extra_params, &block) ⇒ Object

“Reverse merge” additional, repository-specific parameters



105
106
107
108
109
110
111
 
# File 'lib/blacklight/search_builder.rb', line 105

def reverse_merge(extra_params, &block)
  if extra_params
    params_will_change!
    @reverse_merged_params.reverse_merge!(extra_params.to_hash, &block)
  end
  self
end

#rows(value = nil) ⇒ Object Also known as: per

Parameters:

  • value (#to_i) (defaults to: nil) 


194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/blacklight/search_builder.rb', line 194

def rows(value = nil)
  if value
    self.rows = value
    return self
  end
  @rows ||= begin
    # user-provided parameters should override any default row
    r = search_state.per_page
    # ensure we don't excede the max page size
    r.nil? ? nil : [r, blacklight_config.max_per_page].map(&:to_i).min
  end
end

#rows=(value) ⇒ Object 



188
189
190
191
 
# File 'lib/blacklight/search_builder.rb', line 188

def rows=(value)
  params_will_change!
  @rows = [value, blacklight_config.max_per_page].map(&:to_i).min
end

#sort ⇒ String

Decode the user provided 'sort' parameter into a sort string that can be passed to the search. This sanitizes the input by ensuring only configured search values are passed through to the search.

Returns:

  • (String) —

    the field/fields to sort by



228
229
230
 
# File 'lib/blacklight/search_builder.rb', line 228

def sort
  search_state.sort_field&.sort
end

#start(value = nil) ⇒ Object Also known as: padding

Parameters:

  • value (#to_i) (defaults to: nil) 


161
162
163
164
165
166
167
168
169
170
 
# File 'lib/blacklight/search_builder.rb', line 161

def start(value = nil)
  if value
    self.start = value
    return self
  end
  @start ||= (page - 1) * (rows || 10)
  val = @start || 0
  val = 0 if @start < 0
  val
end

#start=(value) ⇒ Object 



155
156
157
158
 
# File 'lib/blacklight/search_builder.rb', line 155

def start=(value)
  params_will_change!
  @start = value.to_i
end

#to_hash ⇒ Blacklight::Solr::Response Also known as: query, to_h

a solr query method

Returns:



117
118
119
120
121
122
123
124
 
# File 'lib/blacklight/search_builder.rb', line 117

def to_hash
  return @params unless params_need_update?

  @params = processed_parameters
              .reverse_merge(@reverse_merged_params)
              .merge(@merged_params)
              .tap { clear_changes }
end

#where(conditions) ⇒ Object

Update the :q (query) parameter



48
49
50
51
52
53
54
55
 
# File 'lib/blacklight/search_builder.rb', line 48

def where(conditions)
  Deprecation.warn(Blacklight::SearchBuilder, "SearchBuilder#where must be called with a hash, received #{conditions.inspect}.") unless conditions.is_a? Hash
  params_will_change!
  @search_state = @search_state.reset(@search_state.params.merge(q: conditions))
  @blacklight_params = @search_state.params
  @additional_filters = conditions
  self
end

#with(blacklight_params_or_search_state = {}) ⇒ Object

Set the parameters to pass through the processor chain



39
40
41
42
43
44
 
# File 'lib/blacklight/search_builder.rb', line 39

def with(blacklight_params_or_search_state = {})
  params_will_change!
  @search_state = blacklight_params_or_search_state.is_a?(Blacklight::SearchState) ? blacklight_params_or_search_state : @search_state.reset(blacklight_params_or_search_state)
  @blacklight_params = @search_state.params.dup
  self
end