• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

pulibrary / orangelight / 4c391e0e-519a-40cb-8ad3-354445f4ce03

12 Aug 2025 08:47PM UTC coverage: 85.348% (-10.0%) from 95.335%
4c391e0e-519a-40cb-8ad3-354445f4ce03

push

circleci

web-flow
[#5143] Use access restriction note as Aeon ItemInfo1 if available (#5173)

With this commit, if a user visits a record with an access
restrictions note and presses the Reading Room Request
button, they will get to an Aeon form with the 'Restrictions'
field pre-filled with the restriction note.

If the record does not have an access restrictions note,
the field will be pre-filled with 'Reading Room Access Only',
as it has been previously.

Closes #5143

5493 of 6436 relevant lines covered (85.35%)

251.82 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.03
/app/controllers/catalog_controller.rb
1
# frozen_string_literal: false
2

3
class CatalogController < ApplicationController
1✔
4
  include Blacklight::Catalog
1✔
5

6
  include Blacklight::Marc::Catalog
1✔
7
  include BlacklightRangeLimit::ControllerOverride
1✔
8
  include Orangelight::Catalog
1✔
9
  include Orangelight::ExcessivePaging
1✔
10
  include BlacklightHelper
1✔
11

12
  before_action :redirect_browse
1✔
13
  before_action :deny_excessive_paging
1✔
14

15
  rescue_from Blacklight::Exceptions::RecordNotFound do
1✔
16
    alma_id = "99#{params[:id]}3506421"
×
17
    search_service.fetch(alma_id)
×
18
    redirect_to solr_document_path(id: alma_id)
×
19
  rescue Blacklight::Exceptions::RecordNotFound
20
    redirect_to '/404'
×
21
  end
22

23
  rescue_from ActionController::InvalidAuthenticityToken do
1✔
24
    redirect_to solr_document_path(params[:id])
×
25
  end
26

27
  rescue_from BlacklightRangeLimit::InvalidRange do
1✔
28
    redirect_to '/', flash: { error: 'The start year must be before the end year.' }
×
29
  end
30

31
  configure_blacklight do |config|
1✔
32
    # config.add_field_configuration_to_solr_request!
33
    config.raw_endpoint.enabled = true
1✔
34

35
    config.json_solr_path = 'advanced'
1✔
36

37
    # default advanced config values
38
    config.advanced_search ||= Blacklight::OpenStructWithHashAccess.new
1✔
39
    config.advanced_search[:url_key] ||= 'advanced'
1✔
40
    config.advanced_search[:query_parser] ||= 'edismax'
1✔
41
    config.advanced_search[:form_solr_parameters] ||= {}
1✔
42
    config.advanced_search[:form_solr_parameters]['facet.field'] ||= %w[access_facet format publication_place_hierarchical_facet language_facet original_language_of_translation_facet advanced_location_s]
1✔
43
    config.advanced_search[:form_solr_parameters]['facet.query'] ||= ''
1✔
44
    config.advanced_search[:form_solr_parameters]['facet.limit'] ||= -1
1✔
45
    config.advanced_search[:form_solr_parameters]['facet.pivot'] ||= ''
1✔
46
    config.advanced_search[:form_solr_parameters]['f.language_facet.facet.sort'] ||= 'index'
1✔
47
    # TODO: Remove non-pipe options after re-index with pipe delimiter
48
    config.advanced_search[:form_solr_parameters]['f.publication_place_hierarchical_facet.facet.sort'] ||= 'index'
1✔
49
    config.advanced_search[:form_solr_parameters]['f.publication_place_hierarchical_pipe_facet.facet.sort'] ||= 'index'
1✔
50

51
    config.numismatics_search ||= Blacklight::OpenStructWithHashAccess.new
1✔
52
    config.numismatics_search[:facet_fields] ||= %w[issue_metal_s issue_city_s issue_state_s issue_region_s issue_denomination_s
1✔
53
                                                    issue_ruler_s issue_artists_s find_place_s donor_s issue_object_type_s]
54

55
    ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
56

57
    # solr path which will be added to solr base url before the other solr params.
58
    # config.solr_path = 'select'
59

60
    # items to show per page, each number in the array represent another option to choose from.
61
    # config.per_page = [10,20,50,100]
62
    config.default_per_page = 20
1✔
63

64
    ## Default parameters to send on single-document requests to Solr. These settings are the Blackligt defaults (see SolrHelper#solr_doc_params) or
65
    ## parameters included in the Blacklight-jetty document requestHandler.
66
    #
67

68
    # config.default_document_solr_params = {
69
    #  :qt => 'document',
70
    #  ## These are hard-coded in the blacklight 'document' requestHandler
71
    #  # :fl => '*',
72
    #  # :rows => 1
73
    #   :q => query
74
    # }
75

76
    config.add_show_tools_partial(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
1✔
77
    config.add_show_tools_partial(:email, callback: :email_action, validator: :validate_email_params)
1✔
78
    config.add_show_tools_partial(:sms, if: :render_sms_action?, callback: :sms_action, validator: :validate_sms_params)
1✔
79
    config.add_show_tools_partial(:citation)
1✔
80

81
    config.navbar.partials.delete(:search_history)
1✔
82
    config.add_nav_action(:bookmark, partial: 'blacklight/nav/bookmark')
1✔
83

84
    # solr field configuration for search results/index views
85
    config.index.title_field = 'title_display'
1✔
86
    config.index.title_component = IndexTitleComponent
1✔
87
    config.index.document_component = IndexDocumentComponent
1✔
88
    config.index.display_type_field = 'format'
1✔
89

90
    # solr field configuration for document/show views
91
    config.show.partials = %i[show_identifiers show]
1✔
92
    # config.show.title_field = 'title_display'
93
    # config.show.display_type_field = 'format'
94

95
    # solr fields that will be treated as facets by the blacklight application
96
    #   The ordering of the field names is the order of the display
97
    #
98
    # Setting a limit will trigger Blacklight's 'more' facet values link.
99
    # * If left unset, then all facet values returned by solr will be displayed.
100
    # * If set to an integer, then "f.somefield.facet.limit" will be added to
101
    # solr request, with actual solr request being +1 your configured limit --
102
    # you configure the number of items you actually want _displayed_ in a page.
103
    # * If set to 'true', then no additional parameters will be sent to solr,
104
    # but any 'sniffed' request limit parameters will be used for paging, with
105
    # paging at requested limit -1. Can sniff from facet.limit or
106
    # f.specific_field.facet.limit solr request params. This 'true' config
107
    # can be used if you set limits in :default_solr_params, or as defaults
108
    # on the solr side in the request handler itself. Request handler defaults
109
    # sniffing requires solr requests to be made with "echoParams=all", for
110
    # app code to actually have it echo'd back to see it.
111
    #
112
    # :show may be set to false if you don't want the facet to be drawn in the
113
    # facet bar
114
    # The following fields are hidden from the facet bar and advanced search. They are used as a keyword search.
115
    config.add_facet_field 'lc_subject_facet', label: 'LC Subjects', limit: true, include_in_advanced_search: false, show: false
1✔
116
    config.add_facet_field 'lcgft_genre_facet', label: 'LC Genres', limit: true, include_in_advanced_search: false, show: false
1✔
117
    config.add_facet_field 'aat_genre_facet', label: 'Genres: Art and Architecture Thesaurus', limit: true, include_in_advanced_search: false, show: false
1✔
118
    config.add_facet_field 'homoit_genre_facet', label: 'Genres: Homosaurus', limit: true, include_in_advanced_search: false, show: false
1✔
119
    config.add_facet_field 'homoit_subject_facet', label: 'Subjects: Homosaurus', limit: true, include_in_advanced_search: false, show: false
1✔
120
    config.add_facet_field 'local_subject_facet', label: 'Subjects: Local', limit: true, include_in_advanced_search: false, show: false
1✔
121
    config.add_facet_field 'rbgenr_genre_facet', label: 'Genres: Rare Books', limit: true, include_in_advanced_search: false, show: false
1✔
122
    config.add_facet_field 'siku_subject_facet', label: 'Subjects: Siku', limit: true, include_in_advanced_search: false, show: false
1✔
123

124
    config.add_facet_field 'access_facet', label: 'Access', sort: 'index', collapse: false, home: true, include_in_advanced_search: true
1✔
125
    config.add_facet_field 'location', label: 'Library', limit: 20, sort: 'index',
1✔
126
                                       home: true, solr_params: { 'facet.mincount' => Blacklight.blacklight_yml['mincount'] || 1 }, include_in_advanced_search: false
127
    config.add_facet_field 'format', label: 'Format', item_component: FormatFacetItemComponent, sort: 'index', limit: 15,
1✔
128
                                     collapse: false, home: true, solr_params: { 'facet.mincount' => Blacklight.blacklight_yml['mincount'] || 1 }, include_in_advanced_search: true
129

130
    # num_segments and segments set to defaults here, included to show customizable features
131
    config.add_facet_field 'pub_date_start_sort', label: 'Publication year', single: true, range: true, range_config: {
1✔
132
      num_segments: 10,
133
      assumed_boundaries: [1100, Time.now.year + 1],
134
      segments: true,
135
      chart_segment_border_color: 'rgb(255, 217, 96)',
136
      chart_segment_bg_color: 'rgba(255, 217, 96, 0.5)',
137
      show_missing_link: false
138
    }
139
    config.add_facet_field 'language_facet', label: 'Language', limit: true, include_in_advanced_search: true, suggest: true
1✔
140
    config.add_facet_field 'original_language_of_translation_facet', label: 'Source language of translation', show: false, include_in_advanced_search_if: -> { Flipflop.source_language_of_translation? }
35✔
141
    config.add_facet_field 'subject_topic_facet', label: 'Subject: Topic', limit: true, include_in_advanced_search: false, suggest: true
1✔
142
    config.add_facet_field 'genre_facet', label: 'Subject: Genre', limit: true, include_in_advanced_search: false
1✔
143
    config.add_facet_field 'subject_era_facet', label: 'Subject: Era', limit: true, include_in_advanced_search: false
1✔
144
    config.add_facet_field 'geographic_facet', label: 'Subject: Geographic', limit: true, include_in_advanced_search: false
1✔
145
    config.add_facet_field 'recently_added_facet', label: 'Recently added', home: true, query: {
1✔
146
      weeks_1: { label: 'Within 1 week', fq: 'cataloged_tdt:[NOW/DAY-7DAYS TO NOW/DAY+1DAY]' },
147
      weeks_2: { label: 'Within 2 weeks', fq: 'cataloged_tdt:[NOW/DAY-14DAYS TO NOW/DAY+1DAY]' },
148
      weeks_3: { label: 'Within 3 weeks', fq: 'cataloged_tdt:[NOW/DAY-21DAYS TO NOW/DAY+1DAY]' },
149
      months_1: { label: 'Within 1 month', fq: 'cataloged_tdt:[NOW/DAY-1MONTH TO NOW/DAY+1DAY]' },
150
      months_2: { label: 'Within 2 months', fq: 'cataloged_tdt:[NOW/DAY-2MONTHS TO NOW/DAY+1DAY]' },
151
      months_3: { label: 'Within 3 months', fq: 'cataloged_tdt:[NOW/DAY-3MONTHS TO NOW/DAY+1DAY]' },
152
      months_6: { label: 'Within 6 months', fq: 'cataloged_tdt:[NOW/DAY-6MONTHS TO NOW/DAY+1DAY]' }
153
    }, include_in_advanced_search: false
154

155
    config.add_facet_field 'instrumentation_facet', label: 'Instrumentation', limit: true, include_in_advanced_search: false
1✔
156
    config.add_facet_field 'publication_place_hierarchical_pipe_facet', label: 'Place of publication', component: Blacklight::Hierarchy::FacetFieldListComponent, sort: 'index', limit: 1000, include_in_advanced_search: true, unless: ->(_controller, _config, _field) { Flipflop.blacklight_hierarchy_publication_facet? }
40✔
157
    # TODO: Remove non-pipe options after re-index with pipe delimiter
158
    config.add_facet_field 'publication_place_hierarchical_facet', label: 'Place of publication', component: Blacklight::Hierarchy::FacetFieldListComponent, sort: 'index', limit: 1000, include_in_advanced_search: true, if: ->(_controller, _config, _field) { Flipflop.blacklight_hierarchy_publication_facet? }
40✔
159
    config.add_facet_field 'lc_pipe_facet', label: 'Classification', component: Blacklight::Hierarchy::FacetFieldListComponent, sort: 'index', limit: 1000, include_in_advanced_search: false, unless: ->(_controller, _config, _field) { Flipflop.blacklight_hierarchy_facet? }
40✔
160
    # TODO: Remove non-pipe options after re-index with pipe delimiter
161
    config.add_facet_field 'lc_facet', label: 'Classification', component: Blacklight::Hierarchy::FacetFieldListComponent, sort: 'index', limit: 1000, include_in_advanced_search: false, if: ->(_controller, _config, _field) { Flipflop.blacklight_hierarchy_facet? }
40✔
162

163
    config.add_facet_field 'lc_1letter_facet', label: 'Classification', limit: 25, include_in_request: false, sort: 'index'
1✔
164
    config.add_facet_field 'lc_rest_facet', label: 'Full call number code', limit: 25, include_in_request: false, sort: 'index'
1✔
165
    config.add_facet_field 'sudoc_facet', label: 'SuDocs', limit: true, sort: 'index', include_in_advanced_search: false
1✔
166

167
    # The following facet configurations are purely for display purposes. They
168
    # will not show up in the facet bar, but without them the labels and other
169
    # configuration which show up when a user clicks that field in the show page
170
    # will be wrong.
171
    config.add_facet_field 'author_s', label: 'Author', limit: true, include_in_request: false
1✔
172
    config.add_facet_field 'class_year_s', label: 'PU class year', limit: true, include_in_request: false
1✔
173
    config.add_facet_field 'call_number_browse_s', label: 'Call number', include_in_request: false
1✔
174

175
    config.add_facet_field 'call_number_scheme_facet', label: 'Call number scheme', limit: 25, include_in_request: false, sort: 'index'
1✔
176
    config.add_facet_field 'call_number_group_facet', label: 'Call number group', limit: 25, include_in_request: false, sort: 'index'
1✔
177
    config.add_facet_field 'call_number_full_facet', label: 'Full call number', limit: 25, include_in_request: false, sort: 'index'
1✔
178
    config.add_facet_field 'advanced_location_s', label: 'Holding location', include_in_request: true, show: false,
1✔
179
                                                  helper_method: :render_location_code, include_in_advanced_search: true, sort: 'alpha'
180
    config.add_facet_field 'name_title_browse_s', label: 'Author-title heading', include_in_request: false
1✔
181
    config.add_facet_field 'subject_facet', show: false, include_in_advanced_search: false
1✔
182

183
    # Numismatics facets
184
    config.add_facet_field 'numismatic_collection_s', label: 'Numismatic Collection', include_in_request: false
1✔
185
    config.add_facet_field 'issue_date_s', label: 'Date', include_in_request: false
1✔
186
    config.add_facet_field 'issue_artists_s', label: 'Artist', include_in_request: false
1✔
187
    config.add_facet_field 'issue_subject_s', label: 'Subject', include_in_request: false
1✔
188
    config.add_facet_field 'numismatic_accession_s', label: 'Accession', include_in_request: false
1✔
189
    config.add_facet_field 'numismatic_provenance_s', label: 'Provenance', include_in_request: false
1✔
190
    config.add_facet_field 'issue_number_s', label: 'Issue', include_in_request: false
1✔
191
    config.add_facet_field 'issue_monogram_title_s', label: 'Monogram', include_in_request: false
1✔
192
    config.add_facet_field 'issue_citations_s', label: 'Citations', include_in_request: false
1✔
193
    config.add_facet_field 'issue_references_s', label: 'References', include_in_request: false
1✔
194
    config.add_facet_field 'donor_s', label: 'Donor', include_in_request: false
1✔
195
    config.add_facet_field 'analysis_s', label: 'Analysis', include_in_request: false
1✔
196
    config.add_facet_field 'counter_stamp_s', label: 'Counter Stamp', include_in_request: false
1✔
197
    config.add_facet_field 'die_axis_s', label: 'Die Axis', include_in_request: false
1✔
198
    config.add_facet_field 'find_date_s', label: 'Find Date', include_in_request: false
1✔
199
    config.add_facet_field 'find_description_s', label: 'Find Description', include_in_request: false
1✔
200
    config.add_facet_field 'find_feature_s', label: 'Find Feature', include_in_request: false
1✔
201
    config.add_facet_field 'find_locus_s', label: 'Find Locus', include_in_request: false
1✔
202
    config.add_facet_field 'find_number_s', label: 'Find Number', include_in_request: false
1✔
203
    config.add_facet_field 'find_place_s', label: 'Find Place', include_in_request: false
1✔
204
    config.add_facet_field 'issue_color_s', label: 'Color', include_in_request: false
1✔
205
    config.add_facet_field 'issue_denomination_s', label: 'Denomination', include_in_request: false
1✔
206
    config.add_facet_field 'issue_edge_s', label: 'Edge', include_in_request: false
1✔
207
    config.add_facet_field 'issue_era_s', label: 'Era', include_in_request: false
1✔
208
    config.add_facet_field 'issue_master_s', label: 'Master', include_in_request: false
1✔
209
    config.add_facet_field 'issue_metal_s', label: 'Metal', include_in_request: false
1✔
210
    config.add_facet_field 'issue_city_s', label: 'City', include_in_request: false
1✔
211
    config.add_facet_field 'issue_state_s', label: 'State', include_in_request: false
1✔
212
    config.add_facet_field 'issue_region_s', label: 'Region', include_in_request: false
1✔
213
    config.add_facet_field 'issue_object_type_s', label: 'Object Type', include_in_request: false
1✔
214
    config.add_facet_field 'issue_obverse_attributes_s', label: 'Obverse Attributes', include_in_request: false
1✔
215
    config.add_facet_field 'issue_obverse_figure_description_s', label: 'Obverse Figure Description', include_in_request: false
1✔
216
    config.add_facet_field 'issue_obverse_figure_relationship_s', label: 'Obverse Figure Relationship', include_in_request: false
1✔
217
    config.add_facet_field 'issue_obverse_figure_s', label: 'Obverse Figure', include_in_request: false
1✔
218
    config.add_facet_field 'issue_obverse_legend_s', label: 'Obverse Legend', include_in_request: false
1✔
219
    config.add_facet_field 'issue_obverse_orientation_s', label: 'Obverse Orientation', include_in_request: false
1✔
220
    config.add_facet_field 'issue_obverse_part_s', label: 'Obverse Part', include_in_request: false
1✔
221
    config.add_facet_field 'issue_obverse_symbol_s', label: 'Obverse Symbol', include_in_request: false
1✔
222
    config.add_facet_field 'issue_reverse_attributes_s', label: 'Reverse Attributes', include_in_request: false
1✔
223
    config.add_facet_field 'issue_reverse_figure_description_s', label: 'Reverse Figure Description', include_in_request: false
1✔
224
    config.add_facet_field 'issue_reverse_figure_relationship_s', label: 'Reverse Figure Relationship', include_in_request: false
1✔
225
    config.add_facet_field 'issue_reverse_figure_s', label: 'Reverse Figure', include_in_request: false
1✔
226
    config.add_facet_field 'issue_reverse_legend_s', label: 'Reverse Legend', include_in_request: false
1✔
227
    config.add_facet_field 'issue_reverse_orientation_s', label: 'Reverse Orientation', include_in_request: false
1✔
228
    config.add_facet_field 'issue_reverse_part_s', label: 'Reverse Part', include_in_request: false
1✔
229
    config.add_facet_field 'issue_reverse_symbol_s', label: 'Reverse Symbol', include_in_request: false
1✔
230
    config.add_facet_field 'issue_ruler_s', label: 'Ruler', include_in_request: false
1✔
231
    config.add_facet_field 'issue_series_s', label: 'Series', include_in_request: false
1✔
232
    config.add_facet_field 'issue_shape_s', label: 'Shape', include_in_request: false
1✔
233
    config.add_facet_field 'issue_workshop_s', label: 'Workshop', include_in_request: false
1✔
234
    config.add_facet_field 'size_s', label: 'Size', include_in_request: false
1✔
235
    config.add_facet_field 'technique_s', label: 'Technique', include_in_request: false
1✔
236
    config.add_facet_field 'weight_s', label: 'Weight', include_in_request: false
1✔
237
    config.add_facet_field 'coin_citations_s', label: 'Citations', include_in_request: false
1✔
238
    config.add_facet_field 'coin_references_s', label: 'References', include_in_request: false
1✔
239

240
    # Have BL send all facet field names to Solr, which has been the default
241
    # previously. Simply remove these lines if you'd rather use Solr request
242
    # handler defaults, or have no facets.
243
    config.add_facet_fields_to_solr_request!
1✔
244

245
    # Config for hierarchy options
246
    # TODO: Remove non-pipe options after re-index with pipe delimiter
247
    config.facet_display = {
1✔
248
      hierarchy: {
249
        'lc' => [['facet'], ':'],
250
        'lc_pipe' => [['facet'], '|||'],
251
        'publication_place_hierarchical' => [['facet'], ':'],
252
        'publication_place_hierarchical_pipe' => [['facet'], '|||']
253
      }
254
    }
255

256
    # solr fields to be displayed in the index (search results) view
257
    #   The ordering of the field names is the order of the display
258
    # NOTE: Most of these are added with show: false so they show up in the JSON
259
    #   output for bento search. If you need to add a field to JSON display
260
    #   (catalog.json), add it here!
261
    config.add_index_field 'series_display', label: 'Series', helper_method: :series_results
1✔
262
    config.add_index_field 'author_display', label: 'Author/Artist', browse_link: :name, presenter: Orangelight::HighlightPresenter
1✔
263
    config.add_index_field 'pub_created_display', label: 'Published/Created'
1✔
264
    config.add_index_field 'format', label: 'Format', component: FormatBadgeFieldComponent
1✔
265
    config.add_index_field 'holdings_1display', if: :json_request?
1✔
266
    config.add_index_field 'contained_in_s', if: :json_request?
1✔
267
    config.add_index_field 'isbn_t', if: :json_request?
1✔
268
    config.add_index_field 'score', if: :json_request?
1✔
269
    config.add_index_field 'marc_relator_display', if: :json_request?
1✔
270
    config.add_index_field 'title_display', if: :json_request?, presenter: Orangelight::HighlightPresenter
1✔
271
    config.add_index_field 'title_vern_display', if: :json_request?, presenter: Orangelight::HighlightPresenter
1✔
272
    config.add_index_field 'isbn_s', if: :json_request?
1✔
273
    config.add_index_field 'oclc_s', if: :json_request?
1✔
274
    config.add_index_field 'lccn_s', if: :json_request?
1✔
275
    config.add_index_field 'electronic_access_1display', if: :json_request?
1✔
276
    config.add_index_field 'cataloged_tdt', if: :json_request?
1✔
277
    config.add_index_field 'electronic_portfolio_s', if: :json_request?
1✔
278
    config.add_index_field 'lc_subject_display', label: 'Subjects', browse_link: :name, presenter: Orangelight::HighlightPresenter
1✔
279
    config.add_index_field 'siku_subject_display', if: false, presenter: Orangelight::HighlightPresenter
1✔
280
    config.add_index_field 'homoit_subject_display', if: false, presenter: Orangelight::HighlightPresenter
1✔
281
    config.add_index_field 'lcgft_s', if: false, presenter: Orangelight::HighlightPresenter
1✔
282
    config.add_index_field 'homoit_genre_s', if: false, presenter: Orangelight::HighlightPresenter
1✔
283
    config.add_index_field 'rbgenr_s', if: false, presenter: Orangelight::HighlightPresenter
1✔
284
    config.add_index_field 'aat_s', if: false, presenter: Orangelight::HighlightPresenter
1✔
285
    config.add_index_field 'notes_display', label: 'Notes', presenter: Orangelight::HighlightPresenter
1✔
286

287
    # solr fields to be displayed in the show (single result) view
288
    #   The ordering of the field names is the order of the display
289
    # config.add_show_field 'title_display', :label => 'Title'
290
    # config.add_show_field 'title_vern_display', :label => 'Title'
291
    # config.add_show_field 'subtitle_display', :label => 'Subtitle'
292
    # config.add_show_field 'subtitle_vern_display', :label => 'Subtitle'
293

294
    # Top fields in show page / prioritized information
295
    # Top fields must include `if: false`, or they will be duplicated in the Details section
296
    # They should be designated with either `default_top_field: true`, `coin_top_field: true` or both
297
    config.add_show_field 'author_display', label: "Author/\u200BArtist", browse_link: :name, if: false, default_top_field: true
1✔
298
    # For uniform titles from 240 field - when there is both an author and uniform title
299
    config.add_show_field 'name_uniform_title_1display', label: 'Uniform title', helper_method: :name_title_hierarchy, if: false, default_top_field: true
1✔
300
    # For uniform titles from 130 field - when there is only a uniform title, and no author
301
    config.add_show_field 'uniform_title_1display', label: 'Uniform title', helper_method: :title_hierarchy, if: false, default_top_field: true
1✔
302
    config.add_show_field 'format', label: 'Format', helper_method: :format_render, if: false, coin_top_field: true, default_top_field: true
1✔
303
    config.add_show_field 'language_name_display', label: 'Language', if: false, default_top_field: true
1✔
304
    config.add_show_field 'original_language_of_translation_facet', label: 'Translated from', if: false, default_top_field: true
1✔
305
    config.add_show_field 'edition_display', label: 'Εdition', if: false, default_top_field: true
1✔
306
    config.add_show_field 'pub_created_display', label: "Published/\u200BCreated", if: false, default_top_field: true
1✔
307
    config.add_show_field 'description_display', label: 'Description', if: false, default_top_field: true
1✔
308

309
    # Senior Thesis linked fields
310
    config.add_show_field 'advisor_display', label: 'Advisor(s)', browse_link: :name
1✔
311
    config.add_show_field 'contributor_display', label: 'Contributor(s)', browse_link: :name
1✔
312
    config.add_show_field 'department_display', label: 'Department', browse_link: :name
1✔
313
    config.add_show_field 'certificate_display', label: 'Certificate', browse_link: :name
1✔
314

315
    config.add_show_field 'class_year_s', label: 'Class year', link_to_search_value: true
1✔
316
    # Linked fields pushed to top of supplemental info
317
    config.add_show_field 'lc_subject_display', label: 'Subject(s)', component: Orangelight::ProcessVocabularyComponent
1✔
318
    config.add_show_field 'siku_subject_display', label: 'Chinese traditional subject(s)', component: Orangelight::ProcessVocabularyComponent
1✔
319
    config.add_show_field 'homoit_subject_display', label: 'Homosaurus term(s)', component: Orangelight::ProcessVocabularyComponent
1✔
320
    config.add_show_field 'homoit_genre_s', label: 'Homosaurus genre(s)', component: Orangelight::ProcessVocabularyComponent
1✔
321
    config.add_show_field 'related_name_json_1display', hash: true
1✔
322
    config.add_show_field 'lcgft_s', label: 'Library of Congress genre(s)', component: Orangelight::ProcessVocabularyComponent
1✔
323
    config.add_show_field 'rbgenr_s', label: 'Rare books genre', component: Orangelight::ProcessVocabularyComponent
1✔
324
    config.add_show_field 'aat_s', label: 'Getty AAT genre', component: Orangelight::ProcessVocabularyComponent
1✔
325
    config.add_show_field 'local_subject_display', label: 'Local Subjects', component: Orangelight::ProcessVocabularyComponent
1✔
326
    config.add_show_field 'fast_subject_display', label: 'FaST Subject(s)', component: Orangelight::ProcessVocabularyComponent
1✔
327
    config.add_show_field 'related_works_1display', label: 'Related work(s)', helper_method: :name_title_hierarchy
1✔
328
    config.add_show_field 'series_display', label: 'Series', series_link: true
1✔
329
    config.add_show_field 'contains_1display', label: 'Contains', helper_method: :name_title_hierarchy
1✔
330
    config.add_show_field 'data_source_display', label: 'Data source', browse_link: :name_title
1✔
331
    config.add_show_field 'contained_in_s', label: 'Contained in', link_field: 'id'
1✔
332
    config.add_show_field 'related_record_s', label: 'Related record(s)', link_field: 'id'
1✔
333
    config.add_show_field 'other_editions_s', label: 'Other available editions', link_field: 'id'
1✔
334
    config.add_show_field 'translation_of_display', label: 'Translation of', browse_link: :name_title
1✔
335
    config.add_show_field 'translated_as_display', label: 'Translated as', browse_link: :name_title
1✔
336
    config.add_show_field 'issued_with_display', label: 'Issued with', browse_link: :name_title
1✔
337
    config.add_show_field 'continues_display', label: 'Continues', browse_link: :name_title
1✔
338
    config.add_show_field 'continues_in_part_display', label: 'Continues in part', browse_link: :name_title
1✔
339
    config.add_show_field 'formed_from_display', label: 'Formed from', browse_link: :name_title
1✔
340
    config.add_show_field 'absorbed_display', label: 'Absorbed', browse_link: :name_title
1✔
341
    config.add_show_field 'absorbed_in_part_display', label: 'Absorbed in part', browse_link: :name_title
1✔
342
    config.add_show_field 'separated_from_display', label: 'Separated from', browse_link: :name_title
1✔
343
    config.add_show_field 'continued_by_display', label: 'Continued by', browse_link: :name_title
1✔
344
    config.add_show_field 'continued_in_part_by_display', label: 'Continued in part by', browse_link: :name_title
1✔
345
    config.add_show_field 'absorbed_by_display', label: 'Absorbed by', browse_link: :name_title
1✔
346
    config.add_show_field 'absorbed_in_part_by_display', label: 'Absorbed in part by', browse_link: :name_title
1✔
347
    config.add_show_field 'split_into_display', label: 'Split into', browse_link: :name_title
1✔
348
    config.add_show_field 'merged_to_form_display', label: 'Merged to form', browse_link: :name_title
1✔
349
    config.add_show_field 'changed_back_to_display', label: 'Changed back to', browse_link: :name_title
1✔
350
    config.add_show_field 'subseries_of_display', label: 'Subseries of', browse_link: :name_title
1✔
351
    config.add_show_field 'has_subseries_display', label: 'Has subseries', browse_link: :name_title
1✔
352
    config.add_show_field 'has_supplement_display', label: 'Has supplement', browse_link: :name_title
1✔
353
    config.add_show_field 'supplement_to_display', label: 'Supplement to', browse_link: :name_title
1✔
354

355
    # Fields that are not links
356
    config.add_show_field 'url_fulltext_display', label: 'URL'
1✔
357
    config.add_show_field 'url_suppl_display', label: 'More information'
1✔
358
    config.add_show_field 'compiled_created_display', label: "Compiled/\u200BCreated"
1✔
359
    config.add_show_field 'medium_support_display', label: "Medium/\u200BSupport"
1✔
360
    config.add_show_field 'numbering_pec_notes_display', label: 'Numbering peculiarities'
1✔
361
    config.add_show_field 'arrangement_display', label: 'Arrangement'
1✔
362
    config.add_show_field 'frequency_display', label: 'Frequency'
1✔
363
    config.add_show_field 'former_frequency_display', label: 'Former frequency'
1✔
364
    config.add_show_field 'linking_notes_display', label: 'Linking notes'
1✔
365
    config.add_show_field 'restrictions_note_display', label: 'Restrictions note', mark_as_safe: true
1✔
366
    config.add_show_field 'biographical_historical_note_display', label: "Biographical/\u200BHistorical note"
1✔
367
    config.add_show_field 'summary_note_display', label: 'Summary note'
1✔
368
    config.add_show_field 'content_advice_display', label: 'Content advice'
1✔
369
    config.add_show_field 'notes_display', label: 'Notes'
1✔
370
    config.add_show_field 'holdings_1display', label: 'Location has', if: :online_holding_note?, helper_method: :location_has
1✔
371
    config.add_show_field 'with_notes_display', label: 'With'
1✔
372
    config.add_show_field 'bibliographic_notes_display', label: 'Bibliographic history'
1✔
373
    config.add_show_field 'dissertation_notes_display', label: 'Dissertation note'
1✔
374
    config.add_show_field 'bib_ref_notes_display', label: 'Bibliographic references'
1✔
375
    config.add_show_field 'scale_notes_display', label: 'Scale'
1✔
376
    config.add_show_field 'credits_notes_display', label: "Creation/\u200BProduction credits"
1✔
377
    config.add_show_field 'type_period_notes_display', label: 'Type of report and period covered'
1✔
378
    config.add_show_field 'data_quality_notes_display', label: 'Data quality'
1✔
379
    config.add_show_field 'type_comp_data_notes_display', label: 'Type of data'
1✔
380
    config.add_show_field 'date_place_event_notes_display', label: 'Time and place of event'
1✔
381
    config.add_show_field 'target_aud_notes_display', label: 'Target audience'
1✔
382
    config.add_show_field 'geo_cov_notes_display', label: 'Geographic coverage'
1✔
383
    config.add_show_field 'time_period_notes_display', label: 'Time period of content'
1✔
384
    config.add_show_field 'supplement_notes_display', label: 'Supplement note'
1✔
385
    config.add_show_field 'study_prog_notes_display', label: 'Study program information'
1✔
386
    config.add_show_field 'censorship_notes_display', label: 'Censorship note'
1✔
387
    config.add_show_field 'reproduction_notes_display', label: 'Reproduction note'
1✔
388
    config.add_show_field 'original_version_notes_display', label: 'Original version'
1✔
389
    config.add_show_field 'location_originals_notes_display', label: 'Location of originals'
1✔
390
    config.add_show_field 'funding_info_notes_display', label: 'Funding information'
1✔
391
    config.add_show_field 'source_data_notes_display', label: 'Source of data'
1✔
392
    config.add_show_field 'system_details_notes_display', label: 'System details'
1✔
393
    config.add_show_field 'related_copyright_notes_display', label: 'Copyright note'
1✔
394
    config.add_show_field 'location_other_arch_notes_display', label: 'Location of other archival materials'
1✔
395
    config.add_show_field 'former_title_complex_notes_display', label: 'Former title complexity'
1✔
396
    config.add_show_field 'issuing_body_notes_display', label: 'Issuing body'
1✔
397
    config.add_show_field 'info_document_notes_display', label: 'Information about documentation'
1✔
398
    config.add_show_field 'copy_version_notes_display', label: 'Copy and version identification'
1✔
399
    config.add_show_field 'case_file_notes_display', label: 'Case file characteristics'
1✔
400
    config.add_show_field 'methodology_notes_display', label: 'Methodology note'
1✔
401
    config.add_show_field 'editor_notes_display', label: 'Editor note'
1✔
402
    config.add_show_field 'action_notes_1display', label: 'Action note', helper_method: :action_notes_display
1✔
403
    config.add_show_field 'accumulation_notes_display', label: 'Accumulation and frequency of use'
1✔
404
    config.add_show_field 'awards_notes_display', label: 'Awards'
1✔
405
    config.add_show_field 'source_desc_notes_display', label: 'Source of description'
1✔
406
    config.add_show_field 'binding_note_display', label: 'Binding note'
1✔
407
    config.add_show_field 'local_notes_display', label: 'Local notes'
1✔
408
    config.add_show_field 'rights_reproductions_note_display', label: 'Rights and reproductions note', mark_as_safe: true
1✔
409
    config.add_show_field 'exhibitions_note_display', label: 'Exhibitions note'
1✔
410
    config.add_show_field 'participant_performer_display', label: "Participant(s)/\u200BPerformer(s)"
1✔
411
    config.add_show_field 'language_display', label: 'Language note'
1✔
412
    config.add_show_field 'script_display', label: 'Script'
1✔
413
    config.add_show_field 'contents_display', label: 'Contents', component: DisplayMoreFieldComponent, maxInitialDisplay: 3
1✔
414
    config.add_show_field 'incomplete_contents_display', label: 'Incomplete contents'
1✔
415
    config.add_show_field 'partial_contents_display', label: 'Partial contents'
1✔
416
    config.add_show_field 'provenance_display', label: 'Provenance'
1✔
417
    config.add_show_field 'source_acquisition_display', label: 'Source acquisition'
1✔
418
    config.add_show_field 'publications_about_display', label: 'Publications about'
1✔
419
    config.add_show_field 'indexed_in_display', label: 'Indexed in'
1✔
420
    config.add_show_field 'references_url_display', label: 'References', references_url: true
1✔
421
    config.add_show_field 'cite_as_display', label: 'Cite as'
1✔
422
    config.add_show_field 'other_format_display', label: 'Other format(s)'
1✔
423
    config.add_show_field 'indexes_display', label: 'Indexes'
1✔
424
    config.add_show_field 'finding_aid_display', label: 'Finding aid'
1✔
425
    config.add_show_field 'cumulative_index_finding_aid_display', label: "Cumulative index/\u200BFinding aid"
1✔
426

427
    config.add_show_field 'place_name_display', label: 'Place name(s)'
1✔
428
    config.add_show_field 'other_title_display', label: 'Other title(s)'
1✔
429
    config.add_show_field 'other_title_1display', hash: true
1✔
430
    config.add_show_field 'in_display', label: 'In'
1✔
431
    config.add_show_field 'other_editions_display', label: 'Other editions'
1✔
432
    config.add_show_field 'isbn_display', label: 'ISBN'
1✔
433
    config.add_show_field 'issn_display', label: 'ISSN'
1✔
434
    config.add_show_field 'sudoc_no_display', label: 'SuDoc no.'
1✔
435
    config.add_show_field 'tech_report_no_display', label: 'Tech. report no.'
1✔
436
    config.add_show_field 'publisher_no_display', label: 'Publisher no.'
1✔
437
    config.add_show_field 'lccn_display', label: 'LCCN'
1✔
438
    config.add_show_field 'oclc_s', label: 'OCLC'
1✔
439
    config.add_show_field 'coden_display', label: 'Coden designation'
1✔
440
    config.add_show_field 'standard_no_1display', hash: true
1✔
441
    config.add_show_field 'original_language_display', label: 'Original language'
1✔
442
    config.add_show_field 'recap_notes_display', label: 'RCP'
1✔
443

444
    # Numismatics fields
445
    ## Issue Description
446
    config.add_show_field 'numismatic_collection_s', label: 'Numismatic Collection', link_to_search_value: true, if: false, coin_top_field: true
1✔
447
    config.add_show_field 'issue_number_s', label: 'Issue', link_to_search_value: true, if: false, coin_top_field: true
1✔
448
    config.add_show_field 'issue_object_type_s', label: 'Object Type', link_to_search_value: true
1✔
449
    config.add_show_field 'issue_denomination_s', label: 'Denomination', link_to_search_value: true
1✔
450
    config.add_show_field 'issue_metal_s', label: 'Metal', link_to_search_value: true
1✔
451
    config.add_show_field 'issue_region_s', label: 'Region', link_to_search_value: true
1✔
452
    config.add_show_field 'issue_state_s', label: 'State', link_to_search_value: true
1✔
453
    config.add_show_field 'issue_city_s', label: 'City', link_to_search_value: true
1✔
454
    config.add_show_field 'issue_ruler_s', label: 'Ruler', link_to_search_value: true
1✔
455
    config.add_show_field 'issue_date_s', label: 'Date', link_to_search_value: true
1✔
456
    config.add_show_field 'issue_obverse_description_s', label: 'Obverse Figure Description', link_to_search_value: true
1✔
457
    config.add_show_field 'issue_obverse_legend_s', label: 'Obverse Legend', link_to_search_value: true
1✔
458
    config.add_show_field 'issue_obverse_attributes_s', label: 'Obverse Attributes', link_to_search_value: true
1✔
459
    config.add_show_field 'issue_obverse_figure_relationship_s', label: 'Obverse Figure Relationship', link_to_search_value: true
1✔
460
    config.add_show_field 'issue_obverse_symbol_s', label: 'Obverse Symbol', link_to_search_value: true
1✔
461
    config.add_show_field 'issue_reverse_description_s', label: 'Reverse Figure Description', link_to_search_value: true
1✔
462
    config.add_show_field 'issue_reverse_legend_s', label: 'Reverse Legend', link_to_search_value: true
1✔
463
    config.add_show_field 'issue_reverse_attributes_s', label: 'Reverse Attributes', link_to_search_value: true
1✔
464
    config.add_show_field 'issue_reverse_figure_relationship_s', label: 'Reverse Figure Relationship', link_to_search_value: true
1✔
465
    config.add_show_field 'issue_reverse_symbol_s', label: 'Reverse Symbol', link_to_search_value: true
1✔
466
    config.add_show_field 'issue_era_s', label: 'Era', link_to_search_value: true
1✔
467
    config.add_show_field 'issue_master_s', label: 'Master', link_to_search_value: true
1✔
468
    config.add_show_field 'issue_workshop_s', label: 'Workshop', link_to_search_value: true
1✔
469
    config.add_show_field 'issue_series_s', label: 'Series', link_to_search_value: true
1✔
470
    config.add_show_field 'issue_artists_s', label: 'Artist', link_to_search_value: true
1✔
471
    config.add_show_field 'issue_subject_s', label: 'Subject', link_to_search_value: true
1✔
472
    config.add_show_field 'issue_citations_s', label: 'Citations', link_to_search_value: true
1✔
473
    config.add_show_field 'issue_references_s', label: 'References', link_to_search_value: true
1✔
474

475
    ## Coin Description
476
    config.add_show_field 'size_s', label: 'Size', link_to_facet: true, coin_description: true
1✔
477
    config.add_show_field 'die_axis_s', label: 'Die Axis', link_to_facet: true, coin_description: true
1✔
478
    config.add_show_field 'weight_s', label: 'Weight', link_to_facet: true, coin_description: true
1✔
479
    config.add_show_field 'numismatic_accession_s', label: 'Accession', link_to_facet: true, coin_description: true
1✔
480
    config.add_show_field 'find_place_s', label: 'Find Place', link_to_facet: true, coin_description: true
1✔
481
    config.add_show_field 'find_number_s', label: 'Find Number', link_to_facet: true, coin_description: true
1✔
482
    config.add_show_field 'find_date_s', label: 'Find Date', link_to_facet: true, coin_description: true
1✔
483
    config.add_show_field 'find_locus_s', label: 'Find Locus', link_to_facet: true, coin_description: true
1✔
484
    config.add_show_field 'find_feature_s', label: 'Find Feature', link_to_facet: true, coin_description: true
1✔
485
    config.add_show_field 'find_description_s', label: 'Find Description', link_to_facet: true, coin_description: true
1✔
486
    config.add_show_field 'technique_s', label: 'Technique', link_to_facet: true, coin_description: true
1✔
487
    config.add_show_field 'issue_shape_s', label: 'Shape', link_to_facet: true, coin_description: true
1✔
488
    config.add_show_field 'issue_edge_s', label: 'Edge', link_to_facet: true, coin_description: true
1✔
489
    config.add_show_field 'issue_color_s', label: 'Color', link_to_facet: true, coin_description: true
1✔
490
    config.add_show_field 'counter_stamp_s', label: 'Counter Stamp', link_to_facet: true, coin_description: true
1✔
491
    config.add_show_field 'analysis_s', label: 'Analysis', link_to_facet: true, coin_description: true
1✔
492
    config.add_show_field 'coin_citations_s', label: 'Citations', link_to_facet: true, coin_description: true
1✔
493
    config.add_show_field 'coin_references_s', label: 'References', link_to_facet: true, coin_description: true
1✔
494

495
    ## Provenance
496
    config.add_show_field 'numismatic_provenance_s', label: 'Provenance'
1✔
497

498
    #     Search fields will inherit the :qt solr request handler from
499
    #     config[:default_solr_parameters], OR can specify a different one
500
    #     with a :qt key/value. Below examples inherit, except for subject
501
    #     that specifies the same :qt as default for our own internal
502
    #     testing purposes.
503
    #
504
    # The :key is what will be used to identify this BL search field internally,
505
    # as well as in URLs -- so changing it after deployment may break bookmarked
506
    # urls.  A display label will be automatically calculated from the :key,
507
    # or can be specified manually to be different.
508

509
    # This one uses all the defaults set by the solr request handler. Which
510
    # solr request handler? The one set in config[:default_solr_parameters][:qt],
511
    # since we aren't specifying it otherwise.
512

513
    # To add an advanced option only search field:
514
    #   config.add_search_field("advanced_field") do |field|
515
    #   field.include_in_simple_select = false
516
    #   field.solr_parameters = { :qf => "advanced_field_solrname" }
517
    # end
518
    # if the request handler ends up being different for advanced fields, they must be
519
    # specifically included, while at the same time be removed from simple search:
520
    #   :include_in_advanced_search => true
521
    #   field.include_in_simple_select = false
522

523
    config.add_search_field 'all_fields', label: 'Keyword', placeholder_text: I18n.t('blacklight.search.form.search.placeholder')
1✔
524

525
    # Now we see how to over-ride Solr request handler defaults, in this
526
    # case for a BL "search field", which is really a dismax aggregate
527
    # of Solr search fields.
528

529
    config.add_search_field('title') do |field|
1✔
530
      # solr_parameters hash are sent to Solr as ordinary url query params.
531
      field.solr_parameters = {
1✔
532
        'spellcheck.dictionary': 'title',
533
        qf: '${title_qf}',
534
        pf: '${title_pf}'
535
      }
536
      field.dropdown_label = 'Title (keyword)'
1✔
537
      field.solr_adv_parameters = {
1✔
538
        qf: '$title_qf',
539
        pf: '$title_pf'
540
      }
541
      field.placeholder_text = I18n.t('blacklight.search.form.search.placeholder')
1✔
542
    end
543

544
    config.add_search_field('author') do |field|
1✔
545
      field.solr_parameters = {
1✔
546
        'spellcheck.dictionary' => 'author',
547
        qf: '${author_qf}',
548
        pf: '${author_pf}'
549
      }
550
      field.dropdown_label = 'Author (keyword)'
1✔
551
      field.label = 'Author/Creator'
1✔
552
      field.solr_adv_parameters = {
1✔
553
        qf: '$author_qf',
554
        pf: '$author_pf'
555
      }
556
      field.placeholder_text = I18n.t('blacklight.search.form.search.placeholder')
1✔
557
    end
558

559
    # Specifying a :qt only to show it's possible, and so our internal automated
560
    # tests can test it. In this case it's the same as
561
    # config[:default_solr_parameters][:qt], so isn't actually neccesary.
562
    config.add_search_field('subject') do |field|
1✔
563
      field.solr_parameters = {
1✔
564
        'spellcheck.dictionary': 'subject',
565
        qf: '${subject_qf}',
566
        pf: '${subject_pf}'
567
      }
568
      field.dropdown_label = 'Subject (keyword)'
1✔
569
      field.qt = 'search'
1✔
570
      field.solr_adv_parameters = {
1✔
571
        qf: '$subject_qf',
572
        pf: '$subject_pf'
573
      }
574
      field.placeholder_text = I18n.t('blacklight.search.form.search.placeholder')
1✔
575
    end
576

577
    config.add_search_field('left_anchor') do |field|
1✔
578
      field.label = 'Title starts with'
1✔
579
      field.solr_parameters = {
1✔
580
        qf: '${left_anchor_qf}',
581
        pf: '${left_anchor_pf}'
582
      }
583
      field.solr_adv_parameters = {
1✔
584
        qf: '$left_anchor_qf',
585
        pf: '$left_anchor_pf'
586
      }
587
      field.advanced_parse = false
1✔
588
      field.placeholder_text = I18n.t('blacklight.search.form.search.placeholder')
1✔
589
    end
590

591
    config.add_search_field('publisher') do |field|
1✔
592
      field.include_in_simple_select = false
1✔
593
      field.label = 'Publisher'
1✔
594
      field.solr_parameters = {
1✔
595
        qf: '${publisher_qf}',
596
        pf: '${publisher_pf}'
597
      }
598
      field.placeholder_text = I18n.t('blacklight.search.form.search.placeholder')
1✔
599
    end
600

601
    config.add_search_field('in_series') do |field|
1✔
602
      field.include_in_advanced_search = false
1✔
603
      field.include_in_simple_select = false
1✔
604
      field.label = 'Series starts with'
1✔
605
      field.solr_parameters = {
1✔
606
        qf: '${in_series_qf}',
607
        pf: '${in_series_qf}'
608
      }
609
      field.solr_adv_parameters = {
1✔
610
        qf: '$in_series_qf',
611
        pf: '$in_series_pf'
612
      }
613
      field.placeholder_text = I18n.t('blacklight.search.form.search.placeholder')
1✔
614
    end
615

616
    config.add_search_field('notes') do |field|
1✔
617
      field.include_in_simple_select = false
1✔
618
      field.label = 'Notes'
1✔
619
      field.solr_parameters = {
1✔
620
        qf: '${notes_qf}',
621
        pf: '${notes_pf}'
622
      }
623
      field.placeholder_text = I18n.t('blacklight.search.form.search.placeholder')
1✔
624
    end
625

626
    config.add_search_field('series_title') do |field|
1✔
627
      field.include_in_simple_select = false
1✔
628
      field.label = 'Series title'
1✔
629
      field.solr_parameters = {
1✔
630
        qf: '${series_title_qf}',
631
        pf: '${series_title_pf}'
632
      }
633
      field.placeholder_text = I18n.t('blacklight.search.form.search.placeholder')
1✔
634
    end
635

636
    config.add_search_field('isbn') do |field|
1✔
637
      field.include_in_simple_select = false
1✔
638
      field.label = 'ISBN'
1✔
639
      field.solr_adv_parameters = {
1✔
640
        qf: 'isbn_t'
641
      }
642
      field.solr_parameters = {
1✔
643
        qf: 'isbn_t'
644
      }
645
      field.placeholder_text = I18n.t('blacklight.search.form.search.placeholder')
1✔
646
    end
647

648
    config.add_search_field('issn') do |field|
1✔
649
      field.include_in_simple_select = false
1✔
650
      field.label = 'ISSN'
1✔
651
      field.solr_adv_parameters = {
1✔
652
        qf: 'issn_s'
653
      }
654
      field.solr_parameters = {
1✔
655
        qf: 'issn_s'
656
      }
657
      field.placeholder_text = I18n.t('blacklight.search.form.search.placeholder')
1✔
658
    end
659

660
    config.add_search_field('lccn') do |field|
1✔
661
      field.include_in_simple_select = false
1✔
662
      field.include_in_advanced_search = false
1✔
663
      field.label = 'LCCN'
1✔
664
      field.solr_adv_parameters = {
1✔
665
        qf: 'lccn_s'
666
      }
667
      field.solr_parameters = {
1✔
668
        qf: 'lccn_s'
669
      }
670
      field.placeholder_text = I18n.t('blacklight.search.form.search.placeholder')
1✔
671
    end
672

673
    config.add_search_field('oclc') do |field|
1✔
674
      field.include_in_simple_select = false
1✔
675
      field.include_in_advanced_search = false
1✔
676
      field.label = 'OCLC'
1✔
677
      field.solr_adv_parameters = {
1✔
678
        qf: 'oclc_s'
679
      }
680
      field.solr_adv_parameters = {
1✔
681
        qf: 'oclc_s'
682
      }
683
      field.placeholder_text = I18n.t('blacklight.search.form.search.placeholder')
1✔
684
    end
685

686
    config.add_search_field('browse_subject') do |field|
1✔
687
      field.include_in_advanced_search = false
1✔
688
      field.label = 'Subject (browse)'
1✔
689
      field.placeholder_text = I18n.t('blacklight.search.form.search.placeholder')
1✔
690
    end
691
    config.add_search_field('browse_name') do |field|
1✔
692
      field.include_in_advanced_search = false
1✔
693
      field.label = 'Author (browse)'
1✔
694
      field.placeholder_text = 'Last name, first name'
1✔
695
      field.placeholder_text = I18n.t('blacklight.search.form.search.placeholder')
1✔
696
    end
697
    config.add_search_field('name_title') do |field|
1✔
698
      field.include_in_advanced_search = false
1✔
699
      field.label = 'Author (sorted by title)'
1✔
700
      field.placeholder_text = 'Last name, first name. Title'
1✔
701
    end
702
    config.add_search_field('browse_cn') do |field|
1✔
703
      field.include_in_advanced_search = false
1✔
704
      field.label = 'Call number (browse)'
1✔
705
      field.placeholder_text = 'e.g. P19.737.3'
1✔
706
    end
707

708
    # "sort results by" select (pulldown)
709
    # label in pulldown is followed by the name of the SOLR field to sort by and
710
    # whether the sort is ascending or descending (it must be asc or desc
711
    # except in the relevancy case).
712
    config.add_sort_field 'score desc, pub_date_start_sort desc, title_sort asc', label: 'relevance'
1✔
713
    config.add_sort_field 'location asc, advanced_location_s asc, call_number_browse_s asc', label: 'library',
1✔
714
                                                                                             if: lambda { |controller, _config|
715
                                                                                               controller.controller_path == 'bookmarks'
86✔
716
                                                                                             }
717
    config.add_sort_field 'pub_date_start_sort desc, title_sort asc, score desc', label: 'year (newest first)'
1✔
718
    config.add_sort_field 'pub_date_start_sort asc, title_sort asc, score desc', label: 'year (oldest first)'
1✔
719
    config.add_sort_field 'author_sort asc, title_sort asc, score desc', label: 'author'
1✔
720
    config.add_sort_field 'title_sort asc, pub_date_start_sort desc, score desc', label: 'title'
1✔
721
    config.add_sort_field 'cataloged_tdt desc, title_sort asc, score desc', label: 'date cataloged'
1✔
722

723
    config.add_email_field 'title_display', label: 'Title'
1✔
724
    config.add_email_field 'title_vern_display', label: 'Title'
1✔
725
    config.add_email_field 'author_display', label: 'Author'
1✔
726
    config.add_email_field 'pub_created_display', label: 'Published/Created'
1✔
727
    config.add_email_field 'format', label: 'Format'
1✔
728
    config.add_email_field 'electronic_access_1display', label: 'Online access', presenter: Orangelight::ElectronicAccessPlainTextPresenter
1✔
729
    config.add_email_field 'electronic_portfolio_s', label: 'Online access', presenter: Orangelight::ElectronicPortfolioPlainTextPresenter
1✔
730

731
    # If there are more than this many search results, no spelling ("did you
732
    # mean") suggestion is offered.
733
    config.spell_max = 0
1✔
734

735
    config.add_results_document_tool(:bookmark, partial: 'bookmark_control')
1✔
736

737
    config.filter_search_state_fields = true
1✔
738
    config.search_state_fields = config.search_state_fields + [
1✔
739
      :advanced_type, :clause, :boolean_operator1, :boolean_operator2
740
    ]
741

742
    config.index.constraints_component = Orangelight::ConstraintsComponent
1✔
743

744
    config.crawler_detector = lambda { |request|
1✔
745
      return true if request.env['HTTP_USER_AGENT'].blank?
241✔
746
      request.bot?
35✔
747
    }
748
  end
749

750
  def sms_mappings
1✔
751
    # remove AT&T from Send me a Text option
752
    super.except('AT&T')
×
753
  end
754

755
  def render_search_results_as_json
1✔
756
    { response: { docs: @document_list, facets: search_facets_as_json, pages: pagination_info(@response) } }
×
757
  end
758

759
  def index
1✔
760
    solrize_boolean_params
57✔
761
    if no_search_yet?
57✔
762
      render_empty_search
3✔
763
    elsif bot_is_attempting_expensive_search?
54✔
764
      head :uri_too_long
×
765
    else
766
      super
54✔
767
    end
768
  rescue ActionController::BadRequest
769
    render file: Rails.public_path.join('x400.html'), layout: true, status: :bad_request
×
770
  end
771

772
  def numismatics
1✔
773
    @response = search_service.search_results
9✔
774
    respond_to do |format|
9✔
775
      format.html { render "advanced/numismatics" }
18✔
776
      format.json { render plain: "Format not supported", status: :bad_request }
9✔
777
    end
778
  end
779

780
  def librarian_view
1✔
781
    if agent_is_crawler?
×
782
      basic_response
×
783
    else
784
      # rubocop:disable Lint/SuppressedException
785
      # This exception is handled in the view layer
786
      begin
787
        super
×
788
      rescue Blacklight::Exceptions::RecordNotFound
789
      end
790
      # rubocop:enable Lint/SuppressedException
791
    end
792
  end
793

794
  def show
1✔
795
    if agent_is_crawler? && request.format.endnote?
29✔
796
      basic_response
×
797
    else
798
      super
29✔
799
    end
800
  end
801

802
  def citation
1✔
803
    if agent_is_crawler?
×
804
      basic_response
×
805
    else
806
      @documents = search_service.fetch(Array(params[:id]), { fl: "author_citation_display, title_citation_display, pub_citation_display, number_of_pages_citation_display, pub_date_start_sort, edition_display, format" })
×
807
      raise Blacklight::Exceptions::RecordNotFound if @documents.blank?
×
808
    end
809
  end
810

811
  def report_biased_results_form; end
1✔
812

813
  def biased_results_submit; end
1✔
814

815
  def advanced_search
1✔
816
    if no_search_yet?
34✔
817
      @response = empty_solr_response(empty_advanced_search_raw_response)
30✔
818
    else
819
      super
4✔
820
    end
821
  end
822

823
  private
1✔
824

825
    def json_request?
1✔
826
      request.format.json?
5,590✔
827
    end
828

829
    def render_empty_search
1✔
830
      # This code is a copy of Blacklight::Catalog.index() method but adapted to use
831
      # a cached version of the data rather than requesting the data from Solr.
832
      # See https://github.com/projectblacklight/blacklight/blob/v7.0.1/app/controllers/concerns/blacklight/catalog.rb#L25-L41
833
      @response = empty_solr_response
3✔
834
      @document_list = @response.documents
3✔
835
      respond_to do |format|
3✔
836
        format.html { store_preferred_view }
6✔
837
        format.rss  { render layout: false }
3✔
838
        format.atom { render layout: false }
3✔
839
        format.json do
3✔
840
          @presenter = Blacklight::JsonPresenter.new(@response, blacklight_config)
×
841
        end
842
        additional_response_formats(format)
3✔
843
        document_export_formats(format)
3✔
844
      end
845
    end
846

847
    def no_search_yet?
1✔
848
      # When only the "controller" and "action" keys are in the request (i.e. no query or facets)
849
      # we consider it the home page.
850
      params.keys.count == 2
91✔
851
    end
852

853
    def empty_solr_response(cached_response = empty_raw_response)
1✔
854
      raw_response = JSON.parse(cached_response)
33✔
855
      Blacklight::Solr::Response.new(raw_response, raw_response["responseHeader"]["params"], blacklight_config: @blacklight_config)
33✔
856
    end
857

858
    def empty_raw_response
1✔
859
      Rails.cache.fetch("home_page_empty_raw_response", expires_in: 3.hours) do
3✔
860
        Rails.logger.info "Cached home page results"
3✔
861
        # We cannot cache the Blacklight::Solr::Response as-is so we convert it to JSON first
862
        search_service.search_results.to_json
3✔
863
      end
864
    end
865

866
    def empty_advanced_search_raw_response
1✔
867
      Rails.cache.fetch('advanced_search_form_empty_raw_response', expires_in: 8.hours) do
30✔
868
        Rails.logger.info "Cached empty advanced search form solr query"
25✔
869
        blacklight_advanced_search_form_search_service.search_results.to_json
25✔
870
      end
871
    end
872

873
    def basic_response
1✔
874
      render plain: 'OK'
×
875
      nil
×
876
    end
877

878
    def bot_is_attempting_expensive_search?
1✔
879
      request.bot? && many_facets?
54✔
880
    end
881

882
    # :reek:TooManyStatements
883
    def many_facets?
1✔
884
      value_count_in_params = ->(facet) { facet.is_a?(Array) ? facet.length : 1 }
×
885

886
      facet_count_in_param = lambda do |param|
×
887
        if param.is_a? ActionController::Parameters
×
888
          param&.values&.sum(&value_count_in_params) || 0
×
889
        else
890
          0
×
891
        end
892
      end
893

894
      params.values_at(:f_inclusive, :f).sum(&facet_count_in_param) >= 5
×
895
    end
896

897
    def search_service_context
1✔
898
      if action_name == 'advanced_search'
125✔
899
        { search_builder_class: AdvancedFormSearchBuilder }
29✔
900
      elsif action_name == 'numismatics'
96✔
901
        { search_builder_class: NumismaticsFormSearchBuilder }
9✔
902
      else
903
        {}
87✔
904
      end
905
    end
906

907
    def solrize_boolean_params
1✔
908
      @search_state = search_state.reset(AdvancedBooleanOperators.new(search_state.params).for_boolqparser)
57✔
909
    end
910
end
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc