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

pulibrary / orangelight / 4e01fe00-694b-47b4-8b30-2de4dc4acc66

31 Jul 2025 07:56PM UTC coverage: 92.891% (-2.5%) from 95.4%
4e01fe00-694b-47b4-8b30-2de4dc4acc66

Pull #4962

circleci

web-flow
Merge pull request #5130 from pulibrary/clean_up_scss_comments

Remove SCSS commented code.
Pull Request #4962: Orangelight pos workcycle 07-07-2025

193 of 197 new or added lines in 24 files covered. (97.97%)

161 existing lines in 35 files now uncovered.

5932 of 6386 relevant lines covered (92.89%)

1443.08 hits per line

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

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

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

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

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

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

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

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

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

35
    config.json_solr_path = 'advanced'
2✔
36

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

52
    config.advanced_search[:form_solr_parameters]['f.publication_place_hierarchical_pipe_facet.facet.limit'] ||= -1
2✔
53
    config.advanced_search[:form_solr_parameters]['f.publication_place_hierarchical_pipe_facet.facet.sort'] ||= 'index'
2✔
54

55
    config.numismatics_search ||= Blacklight::OpenStructWithHashAccess.new
2✔
56
    config.numismatics_search[:facet_fields] ||= %w[issue_metal_s issue_city_s issue_state_s issue_region_s issue_denomination_s
2✔
57
                                                    issue_ruler_s issue_artists_s find_place_s donor_s issue_object_type_s]
58

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

61
    # solr path which will be added to solr base url before the other solr params.
62
    # config.solr_path = 'select'
63

64
    # items to show per page, each number in the array represent another option to choose from.
65
    # config.per_page = [10,20,50,100]
66
    config.default_per_page = 20
2✔
67

68
    ## Default parameters to send on single-document requests to Solr. These settings are the Blackligt defaults (see SolrHelper#solr_doc_params) or
69
    ## parameters included in the Blacklight-jetty document requestHandler.
70
    #
71

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

80
    config.add_show_tools_partial(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
2✔
81
    config.add_show_tools_partial(:email, callback: :email_action, validator: :validate_email_params)
2✔
82
    config.add_show_tools_partial(:sms, if: :render_sms_action?, callback: :sms_action, validator: :validate_sms_params)
2✔
83
    config.add_show_tools_partial(:citation)
2✔
84

85
    config.navbar.partials.delete(:search_history)
2✔
86
    config.add_nav_action(:bookmark, partial: 'blacklight/nav/bookmark')
2✔
87

88
    # solr field configuration for search results/index views
89
    config.index.title_field = 'title_display'
2✔
90
    config.index.title_component = IndexTitleComponent
2✔
91
    config.index.document_component = IndexDocumentComponent
2✔
92
    config.index.display_type_field = 'format'
2✔
93

94
    # solr field configuration for document/show views
95
    config.show.partials = %i[show_identifiers show]
2✔
96
    # config.show.title_field = 'title_display'
97
    # config.show.display_type_field = 'format'
98

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

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

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

158
    config.add_facet_field 'instrumentation_facet', label: 'Instrumentation', limit: true, include_in_advanced_search: false
2✔
159
    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? }
87✔
160
    # TODO: Remove non-pipe options after re-index with pipe delimiter
161
    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? }
87✔
162
    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? }
87✔
163
    # TODO: Remove non-pipe options after re-index with pipe delimiter
164
    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? }
87✔
165

166
    config.add_facet_field 'lc_1letter_facet', label: 'Classification', limit: 25, include_in_request: false, sort: 'index'
2✔
167
    config.add_facet_field 'lc_rest_facet', label: 'Full call number code', limit: 25, include_in_request: false, sort: 'index'
2✔
168
    config.add_facet_field 'sudoc_facet', label: 'SuDocs', limit: true, sort: 'index', include_in_advanced_search: false
2✔
169

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

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

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

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

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

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

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

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

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

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

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

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

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

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

497
    ## Provenance
498
    config.add_show_field 'numismatic_provenance_s', label: 'Provenance'
2✔
499

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

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

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

525
    config.add_search_field 'all_fields', label: 'Keyword', placeholder_text: I18n.t('blacklight.search.form.search.placeholder')
2✔
526

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

737
    config.add_results_document_tool(:bookmark, partial: 'bookmark_control')
2✔
738

739
    config.filter_search_state_fields = true
2✔
740
    config.search_state_fields = config.search_state_fields + [
2✔
741
      :advanced_type, :clause, :boolean_operator1, :boolean_operator2
742
    ]
743

744
    config.index.constraints_component = Orangelight::ConstraintsComponent
2✔
745

746
    config.crawler_detector = lambda { |request|
2✔
747
      return true if request.env['HTTP_USER_AGENT'].blank?
727✔
748
      request.bot?
92✔
749
    }
750
  end
751

752
  def render_search_results_as_json
2✔
753
    { response: { docs: @document_list, facets: search_facets_as_json, pages: pagination_info(@response) } }
×
754
  end
755

756
  def index
2✔
757
    solrize_boolean_params
124✔
758
    if no_search_yet?
124✔
759
      render_empty_search
10✔
760
    elsif bot_is_attempting_expensive_search?
114✔
761
      head :uri_too_long
5✔
762
    else
763
      super
109✔
764
    end
765
  rescue ActionController::BadRequest
766
    render file: Rails.public_path.join('x400.html'), layout: true, status: :bad_request
×
767
  end
768

769
  def numismatics
2✔
770
    unless request.method == :post
9✔
771
      @response = search_service.search_results do |search_builder|
9✔
772
        search_builder.except(:add_advanced_search_to_solr).append(:facets_for_advanced_search_form)
9✔
773
      end
774
    end
775
    respond_to do |format|
9✔
776
      format.html { render "advanced/numismatics" }
18✔
777
      format.json { render plain: "Format not supported", status: :bad_request }
9✔
778
    end
779
  end
780

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

795
  def show
2✔
796
    if agent_is_crawler? && request.format.endnote?
100✔
797
      basic_response
1✔
798
    else
799
      super
99✔
800
    end
801
  end
802

803
  def citation
2✔
804
    if agent_is_crawler?
1✔
805
      basic_response
1✔
806
    else
UNCOV
807
      @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" })
×
UNCOV
808
      raise Blacklight::Exceptions::RecordNotFound if @documents.blank?
×
809
    end
810
  end
811

812
  def report_biased_results_form; end
2✔
813

814
  def biased_results_submit; end
2✔
815

816
  def advanced_search
2✔
817
    if no_search_yet?
25✔
818
      @response = empty_solr_response(empty_advanced_search_raw_response)
19✔
819
    else
820
      super
6✔
821
    end
822
  end
823

824
  private
2✔
825

826
    def json_request?
2✔
827
      request.format.json?
14,066✔
828
    end
829

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

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

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

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

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

874
    def basic_response
2✔
875
      render plain: 'OK'
3✔
876
      nil
3✔
877
    end
878

879
    def bot_is_attempting_expensive_search?
2✔
880
      request.bot? && many_facets?
114✔
881
    end
882

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

887
      facet_count_in_param = lambda do |param|
9✔
888
        if param.is_a? ActionController::Parameters
18✔
889
          param&.values&.sum(&value_count_in_params) || 0
6✔
890
        else
891
          0
12✔
892
        end
893
      end
894

895
      params.values_at(:f_inclusive, :f).sum(&facet_count_in_param) >= 5
9✔
896
    end
897

898
    def search_service_context
2✔
899
      if action_name == 'advanced_search'
267✔
900
        { search_builder_class: AdvancedFormSearchBuilder }
25✔
901
      elsif action_name == 'numismatics'
242✔
902
        { search_builder_class: NumismaticsFormSearchBuilder }
9✔
903
      else
904
        {}
233✔
905
      end
906
    end
907

908
    def solrize_boolean_params
2✔
909
      @search_state = search_state.reset(AdvancedBooleanOperators.new(search_state.params).for_boolqparser)
124✔
910
    end
911
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