c9d0eaec-c698-418e-a1b2-1ebc338545f6

Committed 14 Nov 2024 04:42PM UTC coverage: 96.691% (+0.01%) from 96.678%

Build # c9d0eaec-c698-418e-a1b2-1ebc338545f6

Build Type

push

circleci

Committed by

christinach

Commit Message

Upgrade to Blacklight 8.6.1 (#4546)

* Blacklight 8 - take (something)

* Upgrade blacklight to 8.6.1

* Remove a concern that is unused in Blacklight 8

This way, coveralls does not complain about a dramatic drop in code coverage

---------

Co-authored-by: Max Kadel <mkadel@princeton.edu>
Co-authored-by: Max Kadel <mk8066@princeton.edu>

Run Details

5990 of 6195 relevant lines covered (96.69%)

1538.74 hits per line

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

99.22

/app/controllers/catalog_controller.rb

# frozen_string_literal: false

class CatalogController < ApplicationController
  include Blacklight::Catalog

  include Blacklight::Marc::Catalog
  include BlacklightRangeLimit::ControllerOverride
  include Orangelight::Catalog
  include Orangelight::Stackmap
  include BlacklightHelper

  before_action :redirect_browse

  rescue_from Blacklight::Exceptions::RecordNotFound do
    alma_id = "99#{params[:id]}3506421"
    search_service_compatibility_wrapper.fetch(alma_id)
    redirect_to solr_document_path(id: alma_id)
  rescue Blacklight::Exceptions::RecordNotFound
    redirect_to '/404'
  end

  rescue_from ActionController::InvalidAuthenticityToken do
    redirect_to solr_document_path(params[:id])
  end

  rescue_from BlacklightRangeLimit::InvalidRange do
    redirect_to '/', flash: { error: 'The start year must be before the end year.' }
  end

  configure_blacklight do |config|
    # config.add_field_configuration_to_solr_request!
    config.raw_endpoint.enabled = true

    config.json_solr_path = 'advanced'

    # default advanced config values
    # TODO: remove for advanced search gem deprecation
    config.advanced_search ||= Blacklight::OpenStructWithHashAccess.new
    config.advanced_search[:url_key] ||= 'advanced'
    config.advanced_search[:query_parser] ||= 'edismax'
    config.advanced_search[:form_solr_parameters] ||= {}
    config.advanced_search[:form_solr_parameters]['facet.field'] ||= %w[access_facet format language_facet advanced_location_s]
    config.advanced_search[:form_solr_parameters]['facet.query'] ||= ''
    config.advanced_search[:form_solr_parameters]['facet.limit'] ||= -1
    config.advanced_search[:form_solr_parameters]['facet.pivot'] ||= ''
    config.advanced_search[:form_solr_parameters]['f.language_facet.facet.limit'] ||= -1
    config.advanced_search[:form_solr_parameters]['f.language_facet.facet.sort'] ||= 'index'
    # end remove for advanced search gem deprecation

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

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

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

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

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

    # config.default_document_solr_params = {
    #  :qt => 'document',
    #  ## These are hard-coded in the blacklight 'document' requestHandler
    #  # :fl => '*',
    #  # :rows => 1
    #   :q => query
    # }

    config.add_show_tools_partial(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
    config.add_show_tools_partial(:email, callback: :email_action, validator: :validate_email_params)
    config.add_show_tools_partial(:sms, if: :render_sms_action?, callback: :sms_action, validator: :validate_sms_params)
    config.add_show_tools_partial(:citation)

    config.navbar.partials.delete(:search_history)
    config.add_nav_action(:bookmark, partial: 'blacklight/nav/bookmark')

    # solr field configuration for search results/index views
    config.index.title_field = 'title_display'
    config.index.title_component = IndexTitleComponent
    config.index.document_component = IndexDocumentComponent
    config.index.display_type_field = 'format'

    # solr field configuration for document/show views
    config.show.partials = %i[show_identifiers show]
    # config.show.title_field = 'title_display'
    # config.show.display_type_field = 'format'

    # solr fields that will be treated as facets by the blacklight application
    #   The ordering of the field names is the order of the display
    #
    # Setting a limit will trigger Blacklight's 'more' facet values link.
    # * If left unset, then all facet values returned by solr will be displayed.
    # * If set to an integer, then "f.somefield.facet.limit" will be added to
    # solr request, with actual solr request being +1 your configured limit --
    # you configure the number of items you actually want _displayed_ in a page.
    # * If set to 'true', then no additional parameters will be sent to solr,
    # but any 'sniffed' request limit parameters will be used for paging, with
    # paging at requested limit -1. Can sniff from facet.limit or
    # f.specific_field.facet.limit solr request params. This 'true' config
    # can be used if you set limits in :default_solr_params, or as defaults
    # on the solr side in the request handler itself. Request handler defaults
    # sniffing requires solr requests to be made with "echoParams=all", for
    # app code to actually have it echo'd back to see it.
    #
    # :show may be set to false if you don't want the facet to be drawn in the
    # facet bar
    config.add_facet_field 'access_facet', label: 'Access', sort: 'index', collapse: false, home: true, include_in_advanced_search: true
    config.add_facet_field 'location', label: 'Library', limit: 20, sort: 'index',
                                       home: true, solr_params: { 'facet.mincount' => Blacklight.blacklight_yml['mincount'] || 1 }, include_in_advanced_search: false
    config.add_facet_field 'format', label: 'Format', item_component: FormatFacetItemComponent, sort: 'index', limit: 15,
                                     collapse: false, home: true, solr_params: { 'facet.mincount' => Blacklight.blacklight_yml['mincount'] || 1 }, include_in_advanced_search: true

    # num_segments and segments set to defaults here, included to show customizable features
    config.add_facet_field 'pub_date_start_sort', label: 'Publication year', single: true, range: {
      num_segments: 10,
      assumed_boundaries: [1100, Time.now.year + 1],
      segments: true
    }
    config.add_facet_field 'language_facet', label: 'Language', limit: true, include_in_advanced_search: true
    config.add_facet_field 'subject_topic_facet', label: 'Subject: Topic', limit: true, include_in_advanced_search: false
    config.add_facet_field 'genre_facet', label: 'Subject: Genre', limit: true, include_in_advanced_search: false
    config.add_facet_field 'subject_era_facet', label: 'Subject: Era', limit: true, include_in_advanced_search: false
    config.add_facet_field 'geographic_facet', label: 'Subject: Geographic', limit: true, include_in_advanced_search: false
    config.add_facet_field 'recently_added_facet', label: 'Recently added', home: true, query: {
      weeks_1: { label: 'Within 1 week', fq: 'cataloged_tdt:[NOW/DAY-7DAYS TO NOW/DAY+1DAY]' },
      weeks_2: { label: 'Within 2 weeks', fq: 'cataloged_tdt:[NOW/DAY-14DAYS TO NOW/DAY+1DAY]' },
      weeks_3: { label: 'Within 3 weeks', fq: 'cataloged_tdt:[NOW/DAY-21DAYS TO NOW/DAY+1DAY]' },
      months_1: { label: 'Within 1 month', fq: 'cataloged_tdt:[NOW/DAY-1MONTH TO NOW/DAY+1DAY]' },
      months_2: { label: 'Within 2 months', fq: 'cataloged_tdt:[NOW/DAY-2MONTHS TO NOW/DAY+1DAY]' },
      months_3: { label: 'Within 3 months', fq: 'cataloged_tdt:[NOW/DAY-3MONTHS TO NOW/DAY+1DAY]' },
      months_6: { label: 'Within 6 months', fq: 'cataloged_tdt:[NOW/DAY-6MONTHS TO NOW/DAY+1DAY]' }
    }, include_in_advanced_search: false

    config.add_facet_field 'instrumentation_facet', label: 'Instrumentation', limit: true, include_in_advanced_search: false
    config.add_facet_field 'publication_place_facet', label: 'Place of publication', limit: true, include_in_advanced_search: false

    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? }
    config.add_facet_field 'classification_pivot_field', label: 'Classification', pivot: %w[lc_1letter_facet lc_rest_facet], collapsing: true, include_in_advanced_search: false, unless: ->(_controller, _config, _field) { Flipflop.blacklight_hierarchy_facet? }

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

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

    config.add_facet_field 'call_number_scheme_facet', label: 'Call number scheme', limit: 25, include_in_request: false, sort: 'index'
    config.add_facet_field 'call_number_group_facet', label: 'Call number group', limit: 25, include_in_request: false, sort: 'index'
    config.add_facet_field 'call_number_full_facet', label: 'Full call number', limit: 25, include_in_request: false, sort: 'index'
    config.add_facet_field 'advanced_location_s', label: 'Holding location', include_in_request: true, show: false,
                                                  helper_method: :render_location_code, include_in_advanced_search: true, sort: 'alpha'
    config.add_facet_field 'name_title_browse_s', label: 'Author-title heading', include_in_request: false
    config.add_facet_field 'subject_facet', show: false, include_in_advanced_search: false

    # Numismatics facets
    config.add_facet_field 'numismatic_collection_s', label: 'Numismatic Collection', include_in_request: false
    config.add_facet_field 'issue_date_s', label: 'Date', include_in_request: false
    config.add_facet_field 'issue_artists_s', label: 'Artist', include_in_request: false
    config.add_facet_field 'issue_subject_s', label: 'Subject', include_in_request: false
    config.add_facet_field 'numismatic_accession_s', label: 'Accession', include_in_request: false
    config.add_facet_field 'numismatic_provenance_s', label: 'Provenance', include_in_request: false
    config.add_facet_field 'issue_number_s', label: 'Issue', include_in_request: false
    config.add_facet_field 'issue_monogram_title_s', label: 'Monogram', include_in_request: false
    config.add_facet_field 'issue_citations_s', label: 'Citations', include_in_request: false
    config.add_facet_field 'issue_references_s', label: 'References', include_in_request: false
    config.add_facet_field 'donor_s', label: 'Donor', include_in_request: false
    config.add_facet_field 'analysis_s', label: 'Analysis', include_in_request: false
    config.add_facet_field 'counter_stamp_s', label: 'Counter Stamp', include_in_request: false
    config.add_facet_field 'die_axis_s', label: 'Die Axis', include_in_request: false
    config.add_facet_field 'find_date_s', label: 'Find Date', include_in_request: false
    config.add_facet_field 'find_description_s', label: 'Find Description', include_in_request: false
    config.add_facet_field 'find_feature_s', label: 'Find Feature', include_in_request: false
    config.add_facet_field 'find_locus_s', label: 'Find Locus', include_in_request: false
    config.add_facet_field 'find_number_s', label: 'Find Number', include_in_request: false
    config.add_facet_field 'find_place_s', label: 'Find Place', include_in_request: false
    config.add_facet_field 'issue_color_s', label: 'Color', include_in_request: false
    config.add_facet_field 'issue_denomination_s', label: 'Denomination', include_in_request: false
    config.add_facet_field 'issue_edge_s', label: 'Edge', include_in_request: false
    config.add_facet_field 'issue_era_s', label: 'Era', include_in_request: false
    config.add_facet_field 'issue_master_s', label: 'Master', include_in_request: false
    config.add_facet_field 'issue_metal_s', label: 'Metal', include_in_request: false
    config.add_facet_field 'issue_city_s', label: 'City', include_in_request: false
    config.add_facet_field 'issue_state_s', label: 'State', include_in_request: false
    config.add_facet_field 'issue_region_s', label: 'Region', include_in_request: false
    config.add_facet_field 'issue_object_type_s', label: 'Object Type', include_in_request: false
    config.add_facet_field 'issue_obverse_attributes_s', label: 'Obverse Attributes', include_in_request: false
    config.add_facet_field 'issue_obverse_figure_description_s', label: 'Obverse Figure Description', include_in_request: false
    config.add_facet_field 'issue_obverse_figure_relationship_s', label: 'Obverse Figure Relationship', include_in_request: false
    config.add_facet_field 'issue_obverse_figure_s', label: 'Obverse Figure', include_in_request: false
    config.add_facet_field 'issue_obverse_legend_s', label: 'Obverse Legend', include_in_request: false
    config.add_facet_field 'issue_obverse_orientation_s', label: 'Obverse Orientation', include_in_request: false
    config.add_facet_field 'issue_obverse_part_s', label: 'Obverse Part', include_in_request: false
    config.add_facet_field 'issue_obverse_symbol_s', label: 'Obverse Symbol', include_in_request: false
    config.add_facet_field 'issue_reverse_attributes_s', label: 'Reverse Attributes', include_in_request: false
    config.add_facet_field 'issue_reverse_figure_description_s', label: 'Reverse Figure Description', include_in_request: false
    config.add_facet_field 'issue_reverse_figure_relationship_s', label: 'Reverse Figure Relationship', include_in_request: false
    config.add_facet_field 'issue_reverse_figure_s', label: 'Reverse Figure', include_in_request: false
    config.add_facet_field 'issue_reverse_legend_s', label: 'Reverse Legend', include_in_request: false
    config.add_facet_field 'issue_reverse_orientation_s', label: 'Reverse Orientation', include_in_request: false
    config.add_facet_field 'issue_reverse_part_s', label: 'Reverse Part', include_in_request: false
    config.add_facet_field 'issue_reverse_symbol_s', label: 'Reverse Symbol', include_in_request: false
    config.add_facet_field 'issue_ruler_s', label: 'Ruler', include_in_request: false
    config.add_facet_field 'issue_series_s', label: 'Series', include_in_request: false
    config.add_facet_field 'issue_shape_s', label: 'Shape', include_in_request: false
    config.add_facet_field 'issue_workshop_s', label: 'Workshop', include_in_request: false
    config.add_facet_field 'size_s', label: 'Size', include_in_request: false
    config.add_facet_field 'technique_s', label: 'Technique', include_in_request: false
    config.add_facet_field 'weight_s', label: 'Weight', include_in_request: false
    config.add_facet_field 'coin_citations_s', label: 'Citations', include_in_request: false
    config.add_facet_field 'coin_references_s', label: 'References', include_in_request: false

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

    # Config for heirarcy options
    config.facet_display = {
      hierarchy: {
        'lc' => [['facet'], ':']
      }
    }

    # solr fields to be displayed in the index (search results) view
    #   The ordering of the field names is the order of the display
    # NOTE: Most of these are added with show: false so they show up in the JSON
    #   output for bento search. If you need to add a field to JSON display
    #   (catalog.json), add it here!
    config.add_index_field 'series_display', label: 'Series', helper_method: :series_results
    config.add_index_field 'author_display', label: 'Author/Artist', browse_link: :name, presenter: Orangelight::HighlightPresenter
    config.add_index_field 'pub_created_display', label: 'Published/Created'
    config.add_index_field 'format', label: 'Format', helper_method: :format_icon
    config.add_index_field 'holdings_1display', if: :json_request?
    config.add_index_field 'contained_in_s', if: :json_request?
    config.add_index_field 'isbn_t', if: :json_request?
    config.add_index_field 'score', if: :json_request?
    config.add_index_field 'marc_relator_display', if: :json_request?
    config.add_index_field 'title_display', if: :json_request?, presenter: Orangelight::HighlightPresenter
    config.add_index_field 'title_vern_display', if: :json_request?, presenter: Orangelight::HighlightPresenter
    config.add_index_field 'isbn_s', if: :json_request?
    config.add_index_field 'oclc_s', if: :json_request?
    config.add_index_field 'lccn_s', if: :json_request?
    config.add_index_field 'electronic_access_1display', if: :json_request?
    config.add_index_field 'cataloged_tdt', if: :json_request?
    config.add_index_field 'electronic_portfolio_s', if: :json_request?
    config.add_index_field 'lc_subject_display', label: 'Subjects', browse_link: :name, presenter: Orangelight::HighlightPresenter
    config.add_index_field 'siku_subject_display', if: false, presenter: Orangelight::HighlightPresenter
    config.add_index_field 'homoit_subject_display', if: false, presenter: Orangelight::HighlightPresenter
    config.add_index_field 'lcgft_s', if: false, presenter: Orangelight::HighlightPresenter
    config.add_index_field 'homoit_genre_s', if: false, presenter: Orangelight::HighlightPresenter
    config.add_index_field 'rbgenr_s', if: false, presenter: Orangelight::HighlightPresenter
    config.add_index_field 'aat_s', if: false, presenter: Orangelight::HighlightPresenter
    config.add_index_field 'notes_display', label: 'Notes', presenter: Orangelight::HighlightPresenter

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

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

    # Senior Thesis linked fields
    config.add_show_field 'advisor_display', label: 'Advisor(s)', browse_link: :name
    config.add_show_field 'contributor_display', label: 'Contributor(s)', browse_link: :name
    config.add_show_field 'department_display', label: 'Department', browse_link: :name
    config.add_show_field 'certificate_display', label: 'Certificate', browse_link: :name

    config.add_show_field 'class_year_s', label: 'Class year', link_to_search_value: true
    # Linked fields pushed to top of supplemental info
    config.add_show_field 'lc_subject_display', label: 'Subject(s)', helper_method: :subjectify
    config.add_show_field 'siku_subject_display', label: 'Chinese traditional subject(s)', helper_method: :subjectify
    config.add_show_field 'homoit_subject_display', label: 'Homosaurus term(s)', helper_method: :subjectify
    config.add_show_field 'related_name_json_1display', hash: true
    config.add_show_field 'lcgft_s', label: 'Library of Congress genre(s)', helper_method: :subjectify
    config.add_show_field 'homoit_genre_s', label: 'Homosaurus genre(s)', helper_method: :subjectify
    config.add_show_field 'rbgenr_s', label: 'Rare books genre', helper_method: :subjectify
    config.add_show_field 'aat_s', label: 'Getty AAT genre', helper_method: :subjectify
    config.add_show_field 'fast_subject_display', label: 'FaST Subject(s)', helper_method: :subjectify
    config.add_show_field 'related_works_1display', label: 'Related work(s)', helper_method: :name_title_hierarchy
    config.add_show_field 'series_display', label: 'Series', series_link: true
    config.add_show_field 'contains_1display', label: 'Contains', helper_method: :name_title_hierarchy
    config.add_show_field 'data_source_display', label: 'Data source', browse_link: :name_title
    config.add_show_field 'contained_in_s', label: 'Contained in', link_field: 'id'
    config.add_show_field 'related_record_s', label: 'Related record(s)', link_field: 'id'
    config.add_show_field 'other_editions_s', label: 'Other available editions', link_field: 'id'
    config.add_show_field 'translation_of_display', label: 'Translation of', browse_link: :name_title
    config.add_show_field 'translated_as_display', label: 'Translated as', browse_link: :name_title
    config.add_show_field 'issued_with_display', label: 'Issued with', browse_link: :name_title
    config.add_show_field 'continues_display', label: 'Continues', browse_link: :name_title
    config.add_show_field 'continues_in_part_display', label: 'Continues in part', browse_link: :name_title
    config.add_show_field 'formed_from_display', label: 'Formed from', browse_link: :name_title
    config.add_show_field 'absorbed_display', label: 'Absorbed', browse_link: :name_title
    config.add_show_field 'absorbed_in_part_display', label: 'Absorbed in part', browse_link: :name_title
    config.add_show_field 'separated_from_display', label: 'Separated from', browse_link: :name_title
    config.add_show_field 'continued_by_display', label: 'Continued by', browse_link: :name_title
    config.add_show_field 'continued_in_part_by_display', label: 'Continued in part by', browse_link: :name_title
    config.add_show_field 'absorbed_by_display', label: 'Absorbed by', browse_link: :name_title
    config.add_show_field 'absorbed_in_part_by_display', label: 'Absorbed in part by', browse_link: :name_title
    config.add_show_field 'split_into_display', label: 'Split into', browse_link: :name_title
    config.add_show_field 'merged_to_form_display', label: 'Merged to form', browse_link: :name_title
    config.add_show_field 'changed_back_to_display', label: 'Changed back to', browse_link: :name_title
    config.add_show_field 'subseries_of_display', label: 'Subseries of', browse_link: :name_title
    config.add_show_field 'has_subseries_display', label: 'Has subseries', browse_link: :name_title
    config.add_show_field 'has_supplement_display', label: 'Has supplement', browse_link: :name_title
    config.add_show_field 'supplement_to_display', label: 'Supplement to', browse_link: :name_title

    # Fields that are not links
    config.add_show_field 'url_fulltext_display', label: 'URL'
    config.add_show_field 'url_suppl_display', label: 'More information'
    config.add_show_field 'compiled_created_display', label: "Compiled/\u200BCreated"
    config.add_show_field 'medium_support_display', label: "Medium/\u200BSupport"
    config.add_show_field 'numbering_pec_notes_display', label: 'Numbering peculiarities'
    config.add_show_field 'arrangement_display', label: 'Arrangement'
    config.add_show_field 'frequency_display', label: 'Frequency'
    config.add_show_field 'former_frequency_display', label: 'Former frequency'
    config.add_show_field 'linking_notes_display', label: 'Linking notes'
    config.add_show_field 'restrictions_note_display', label: 'Restrictions note', mark_as_safe: true
    config.add_show_field 'biographical_historical_note_display', label: "Biographical/\u200BHistorical note"
    config.add_show_field 'summary_note_display', label: 'Summary note'
    config.add_show_field 'content_advice_display', label: 'Content advice'
    config.add_show_field 'notes_display', label: 'Notes'
    config.add_show_field 'holdings_1display', label: 'Location has', if: :online_holding_note?, helper_method: :location_has
    config.add_show_field 'with_notes_display', label: 'With'
    config.add_show_field 'bibliographic_notes_display', label: 'Bibliographic history'
    config.add_show_field 'dissertation_notes_display', label: 'Dissertation note'
    config.add_show_field 'bib_ref_notes_display', label: 'Bibliographic references'
    config.add_show_field 'scale_notes_display', label: 'Scale'
    config.add_show_field 'credits_notes_display', label: "Creation/\u200BProduction credits"
    config.add_show_field 'type_period_notes_display', label: 'Type of report and period covered'
    config.add_show_field 'data_quality_notes_display', label: 'Data quality'
    config.add_show_field 'type_comp_data_notes_display', label: 'Type of data'
    config.add_show_field 'date_place_event_notes_display', label: 'Time and place of event'
    config.add_show_field 'target_aud_notes_display', label: 'Target audience'
    config.add_show_field 'geo_cov_notes_display', label: 'Geographic coverage'
    config.add_show_field 'time_period_notes_display', label: 'Time period of content'
    config.add_show_field 'supplement_notes_display', label: 'Supplement note'
    config.add_show_field 'study_prog_notes_display', label: 'Study program information'
    config.add_show_field 'censorship_notes_display', label: 'Censorship note'
    config.add_show_field 'reproduction_notes_display', label: 'Reproduction note'
    config.add_show_field 'original_version_notes_display', label: 'Original version'
    config.add_show_field 'location_originals_notes_display', label: 'Location of originals'
    config.add_show_field 'funding_info_notes_display', label: 'Funding information'
    config.add_show_field 'source_data_notes_display', label: 'Source of data'
    config.add_show_field 'system_details_notes_display', label: 'System details'
    config.add_show_field 'related_copyright_notes_display', label: 'Copyright note'
    config.add_show_field 'location_other_arch_notes_display', label: 'Location of other archival materials'
    config.add_show_field 'former_title_complex_notes_display', label: 'Former title complexity'
    config.add_show_field 'issuing_body_notes_display', label: 'Issuing body'
    config.add_show_field 'info_document_notes_display', label: 'Information about documentation'
    config.add_show_field 'copy_version_notes_display', label: 'Copy and version identification'
    config.add_show_field 'case_file_notes_display', label: 'Case file characteristics'
    config.add_show_field 'methodology_notes_display', label: 'Methodology note'
    config.add_show_field 'editor_notes_display', label: 'Editor note'
    config.add_show_field 'action_notes_1display', label: 'Action note', helper_method: :action_notes_display
    config.add_show_field 'accumulation_notes_display', label: 'Accumulation and frequency of use'
    config.add_show_field 'awards_notes_display', label: 'Awards'
    config.add_show_field 'source_desc_notes_display', label: 'Source of description'
    config.add_show_field 'binding_note_display', label: 'Binding note'
    config.add_show_field 'local_notes_display', label: 'Local notes'
    config.add_show_field 'rights_reproductions_note_display', label: 'Rights and reproductions note', mark_as_safe: true
    config.add_show_field 'exhibitions_note_display', label: 'Exhibitions note'
    config.add_show_field 'participant_performer_display', label: "Participant(s)/\u200BPerformer(s)"
    config.add_show_field 'language_display', label: 'Language note'
    config.add_show_field 'script_display', label: 'Script'
    config.add_show_field 'contents_display', label: 'Contents', component: DisplayMoreFieldComponent, maxInitialDisplay: 3
    config.add_show_field 'incomplete_contents_display', label: 'Incomplete contents'
    config.add_show_field 'partial_contents_display', label: 'Partial contents'
    config.add_show_field 'provenance_display', label: 'Provenance'
    config.add_show_field 'source_acquisition_display', label: 'Source acquisition'
    config.add_show_field 'publications_about_display', label: 'Publications about'
    config.add_show_field 'indexed_in_display', label: 'Indexed in'
    config.add_show_field 'references_url_display', label: 'References', references_url: true
    config.add_show_field 'cite_as_display', label: 'Cite as'
    config.add_show_field 'other_format_display', label: 'Other format(s)'
    config.add_show_field 'indexes_display', label: 'Indexes'
    config.add_show_field 'finding_aid_display', label: 'Finding aid'
    config.add_show_field 'cumulative_index_finding_aid_display', label: "Cumulative index/\u200BFinding aid"
    config.add_show_field 'place_name_display', label: 'Place name(s)'
    config.add_show_field 'other_title_display', label: 'Other title(s)'
    config.add_show_field 'other_title_1display', hash: true
    config.add_show_field 'in_display', label: 'In'
    config.add_show_field 'other_editions_display', label: 'Other editions'
    config.add_show_field 'isbn_display', label: 'ISBN'
    config.add_show_field 'issn_display', label: 'ISSN'
    config.add_show_field 'sudoc_no_display', label: 'SuDoc no.'
    config.add_show_field 'tech_report_no_display', label: 'Tech. report no.'
    config.add_show_field 'publisher_no_display', label: 'Publisher no.'
    config.add_show_field 'lccn_display', label: 'LCCN'
    config.add_show_field 'oclc_s', label: 'OCLC'
    config.add_show_field 'coden_display', label: 'Coden designation'
    config.add_show_field 'standard_no_1display', hash: true
    config.add_show_field 'original_language_display', label: 'Original language'
    config.add_show_field 'recap_notes_display', label: 'RCP'

    # Numismatics fields
    ## Issue Description
    config.add_show_field 'numismatic_collection_s', label: 'Numismatic Collection', link_to_search_value: true, if: false, coin_top_field: true
    config.add_show_field 'issue_number_s', label: 'Issue', link_to_search_value: true, if: false, coin_top_field: true
    config.add_show_field 'issue_object_type_s', label: 'Object Type', link_to_search_value: true
    config.add_show_field 'issue_denomination_s', label: 'Denomination', link_to_search_value: true
    config.add_show_field 'issue_metal_s', label: 'Metal', link_to_search_value: true
    config.add_show_field 'issue_region_s', label: 'Region', link_to_search_value: true
    config.add_show_field 'issue_state_s', label: 'State', link_to_search_value: true
    config.add_show_field 'issue_city_s', label: 'City', link_to_search_value: true
    config.add_show_field 'issue_ruler_s', label: 'Ruler', link_to_search_value: true
    config.add_show_field 'issue_date_s', label: 'Date', link_to_search_value: true
    config.add_show_field 'issue_obverse_description_s', label: 'Obverse Figure Description', link_to_search_value: true
    config.add_show_field 'issue_obverse_legend_s', label: 'Obverse Legend', link_to_search_value: true
    config.add_show_field 'issue_obverse_attributes_s', label: 'Obverse Attributes', link_to_search_value: true
    config.add_show_field 'issue_obverse_figure_relationship_s', label: 'Obverse Figure Relationship', link_to_search_value: true
    config.add_show_field 'issue_obverse_symbol_s', label: 'Obverse Symbol', link_to_search_value: true
    config.add_show_field 'issue_reverse_description_s', label: 'Reverse Figure Description', link_to_search_value: true
    config.add_show_field 'issue_reverse_legend_s', label: 'Reverse Legend', link_to_search_value: true
    config.add_show_field 'issue_reverse_attributes_s', label: 'Reverse Attributes', link_to_search_value: true
    config.add_show_field 'issue_reverse_figure_relationship_s', label: 'Reverse Figure Relationship', link_to_search_value: true
    config.add_show_field 'issue_reverse_symbol_s', label: 'Reverse Symbol', link_to_search_value: true
    config.add_show_field 'issue_era_s', label: 'Era', link_to_search_value: true
    config.add_show_field 'issue_master_s', label: 'Master', link_to_search_value: true
    config.add_show_field 'issue_workshop_s', label: 'Workshop', link_to_search_value: true
    config.add_show_field 'issue_series_s', label: 'Series', link_to_search_value: true
    config.add_show_field 'issue_artists_s', label: 'Artist', link_to_search_value: true
    config.add_show_field 'issue_subject_s', label: 'Subject', link_to_search_value: true
    config.add_show_field 'issue_citations_s', label: 'Citations', link_to_search_value: true
    config.add_show_field 'issue_references_s', label: 'References', link_to_search_value: true

    ## Coin Description
    config.add_show_field 'size_s', label: 'Size', link_to_facet: true, coin_description: true
    config.add_show_field 'die_axis_s', label: 'Die Axis', link_to_facet: true, coin_description: true
    config.add_show_field 'weight_s', label: 'Weight', link_to_facet: true, coin_description: true
    config.add_show_field 'numismatic_accession_s', label: 'Accession', link_to_facet: true, coin_description: true
    config.add_show_field 'find_place_s', label: 'Find Place', link_to_facet: true, coin_description: true
    config.add_show_field 'find_number_s', label: 'Find Number', link_to_facet: true, coin_description: true
    config.add_show_field 'find_date_s', label: 'Find Date', link_to_facet: true, coin_description: true
    config.add_show_field 'find_locus_s', label: 'Find Locus', link_to_facet: true, coin_description: true
    config.add_show_field 'find_feature_s', label: 'Find Feature', link_to_facet: true, coin_description: true
    config.add_show_field 'find_description_s', label: 'Find Description', link_to_facet: true, coin_description: true
    config.add_show_field 'technique_s', label: 'Technique', link_to_facet: true, coin_description: true
    config.add_show_field 'issue_shape_s', label: 'Shape', link_to_facet: true, coin_description: true
    config.add_show_field 'issue_edge_s', label: 'Edge', link_to_facet: true, coin_description: true
    config.add_show_field 'issue_color_s', label: 'Color', link_to_facet: true, coin_description: true
    config.add_show_field 'counter_stamp_s', label: 'Counter Stamp', link_to_facet: true, coin_description: true
    config.add_show_field 'analysis_s', label: 'Analysis', link_to_facet: true, coin_description: true
    config.add_show_field 'coin_citations_s', label: 'Citations', link_to_facet: true, coin_description: true
    config.add_show_field 'coin_references_s', label: 'References', link_to_facet: true, coin_description: true

    ## Provenance
    config.add_show_field 'numismatic_provenance_s', label: 'Provenance'

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

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

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

    config.add_search_field 'all_fields', label: 'Keyword'

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

    config.add_search_field('title') do |field|
      # solr_parameters hash are sent to Solr as ordinary url query params.
      field.solr_parameters = {
        'spellcheck.dictionary': 'title',
        qf: '${title_qf}',
        pf: '${title_pf}'
      }
      field.dropdown_label = 'Title (keyword)'
      field.solr_adv_parameters = {
        qf: '$title_qf',
        pf: '$title_pf'
      }
    end

    config.add_search_field('author') do |field|
      field.solr_parameters = {
        'spellcheck.dictionary' => 'author',
        qf: '${author_qf}',
        pf: '${author_pf}'
      }
      field.dropdown_label = 'Author (keyword)'
      field.label = 'Author/Creator'
      field.solr_adv_parameters = {
        qf: '$author_qf',
        pf: '$author_pf'
      }
    end

    # Specifying a :qt only to show it's possible, and so our internal automated
    # tests can test it. In this case it's the same as
    # config[:default_solr_parameters][:qt], so isn't actually neccesary.
    config.add_search_field('subject') do |field|
      field.solr_parameters = {
        'spellcheck.dictionary': 'subject',
        qf: '${subject_qf}',
        pf: '${subject_pf}'
      }
      field.dropdown_label = 'Subject (keyword)'
      field.qt = 'search'
      field.solr_adv_parameters = {
        qf: '$subject_qf',
        pf: '$subject_pf'
      }
    end

    config.add_search_field('left_anchor') do |field|
      field.label = 'Title starts with'
      field.solr_parameters = {
        qf: '${left_anchor_qf}',
        pf: '${left_anchor_pf}'
      }
      field.solr_adv_parameters = {
        qf: '$left_anchor_qf',
        pf: '$left_anchor_pf'
      }
      field.advanced_parse = false
    end

    config.add_search_field('publisher') do |field|
      field.include_in_simple_select = false
      field.label = 'Publisher'
      field.solr_adv_parameters = {
        qf: '$publisher_qf',
        pf: '$publisher_pf'
      }
    end

    config.add_search_field('in_series') do |field|
      field.include_in_advanced_search = false
      field.include_in_simple_select = false
      field.label = 'Series starts with'
      field.solr_adv_parameters = {
        qf: '$in_series_qf',
        pf: '$in_series_pf'
      }
    end

    config.add_search_field('notes') do |field|
      field.include_in_simple_select = false
      field.label = 'Notes'
      field.solr_adv_parameters = {
        qf: '$notes_qf',
        pf: '$notes_pf'
      }
    end

    config.add_search_field('series_title') do |field|
      field.include_in_simple_select = false
      field.label = 'Series title'
      field.solr_adv_parameters = {
        qf: '$series_title_qf',
        pf: '$series_title_pf'
      }
    end

    config.add_search_field('isbn') do |field|
      field.include_in_simple_select = false
      field.label = 'ISBN'
      field.solr_adv_parameters = {
        qf: 'isbn_t'
      }
      field.solr_parameters = {
        qf: 'isbn_t'
      }
    end

    config.add_search_field('issn') do |field|
      field.include_in_simple_select = false
      field.label = 'ISSN'
      field.solr_adv_parameters = {
        qf: 'issn_s'
      }
      field.solr_parameters = {
        qf: 'issn_s'
      }
    end

    config.add_search_field('lccn') do |field|
      field.include_in_simple_select = false
      field.include_in_advanced_search = false
      field.label = 'LCCN'
      field.solr_adv_parameters = {
        qf: 'lccn_s'
      }
      field.solr_parameters = {
        qf: 'lccn_s'
      }
    end

    config.add_search_field('oclc') do |field|
      field.include_in_simple_select = false
      field.include_in_advanced_search = false
      field.label = 'OCLC'
      field.solr_adv_parameters = {
        qf: 'oclc_s'
      }
      field.solr_adv_parameters = {
        qf: 'oclc_s'
      }
    end

    config.add_search_field('browse_subject') do |field|
      field.include_in_advanced_search = false
      field.label = 'Subject (browse)'
    end
    config.add_search_field('browse_name') do |field|
      field.include_in_advanced_search = false
      field.label = 'Author (browse)'
      field.placeholder_text = 'Last name, first name'
    end
    config.add_search_field('name_title') do |field|
      field.include_in_advanced_search = false
      field.label = 'Author (sorted by title)'
      field.placeholder_text = 'Last name, first name. Title'
    end
    config.add_search_field('browse_cn') do |field|
      field.include_in_advanced_search = false
      field.label = 'Call number (browse)'
      field.placeholder_text = 'e.g. P19.737.3'
    end

    # "sort results by" select (pulldown)
    # label in pulldown is followed by the name of the SOLR field to sort by and
    # whether the sort is ascending or descending (it must be asc or desc
    # except in the relevancy case).
    config.add_sort_field 'score desc, pub_date_start_sort desc, title_sort asc', label: 'relevance'
    config.add_sort_field 'location asc, advanced_location_s asc, call_number_browse_s asc', label: 'library',
                                                                                             if: lambda { |controller, _config|
                                                                                               controller.controller_path == 'bookmarks'
                                                                                             }
    config.add_sort_field 'pub_date_start_sort desc, title_sort asc, score desc', label: 'year (newest first)'
    config.add_sort_field 'pub_date_start_sort asc, title_sort asc, score desc', label: 'year (oldest first)'
    config.add_sort_field 'author_sort asc, title_sort asc, score desc', label: 'author'
    config.add_sort_field 'title_sort asc, pub_date_start_sort desc, score desc', label: 'title'
    config.add_sort_field 'cataloged_tdt desc, title_sort asc, score desc', label: 'date cataloged'

    config.add_email_field 'title_display', label: 'Title'
    config.add_email_field 'title_vern_display', label: 'Title'
    config.add_email_field 'author_display', label: 'Author'
    config.add_email_field 'pub_created_display', label: 'Published/Created'
    config.add_email_field 'format', label: 'Format'
    config.add_email_field 'electronic_access_1display', label: 'Online access', presenter: Orangelight::ElectronicAccessPlainTextPresenter

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

    config.add_results_document_tool(:bookmark, partial: 'bookmark_control')

    config.filter_search_state_fields = true
    config.search_state_fields = config.search_state_fields + [
      :advanced_type, :clause, :boolean_operator1, :boolean_operator2
    ]

    config.index.constraints_component = Orangelight::ConstraintsComponent

    config.crawler_detector = lambda { |request|
      return true if request.env['HTTP_USER_AGENT'].blank?
      request.bot?
    }
  end

  def render_search_results_as_json
    { response: { docs: @document_list, facets: search_facets_as_json, pages: pagination_info(@response) } }
  end

  def index
    solrize_boolean_params
    if no_search_yet?
      render_empty_search
    else
      super
    end
  rescue ActionController::BadRequest
    render file: Rails.public_path.join('x400.html'), layout: true, status: :bad_request
  end

  def numismatics
    unless request.method == :post
      @response = search_service_compatibility_wrapper.search_results do |search_builder|
        search_builder.except(:add_advanced_search_to_solr).append(:facets_for_advanced_search_form)
      end
    end
    respond_to do |format|
      format.html { render "advanced/numismatics" }
      format.json { render plain: "Format not supported", status: :bad_request }
    end
  end

  def librarian_view
    if agent_is_crawler?
      basic_response
    else
      # rubocop:disable Lint/SuppressedException
      # This exception is handled in the view layer
      begin
        super
      rescue Blacklight::Exceptions::RecordNotFound
      end
      # rubocop:enable Lint/SuppressedException
    end
  end

  def show
    if agent_is_crawler? && request.format.endnote?
      basic_response
    else
      super
    end
  end

  def citation
    if agent_is_crawler?
      basic_response
    elsif Orangelight.using_blacklight7?
      # Taken from Blacklight::ActionBuilder#build, which would
      # otherwise generate the citation method dynamically
      #
      # See https://github.com/projectblacklight/blacklight/blob/f6bdb20248c0eee91dbd480b20d1b60f93783b3e/app/builders/blacklight/action_builder.rb#L29-L53
      @response, @documents = action_documents
    else
      @documents = action_documents
    end
  end

  def report_biased_results_form; end

  def biased_results_submit; end

  def advanced_search
    if no_search_yet?
      @response = empty_solr_response(empty_advanced_search_raw_response)
    else
      super
    end
  end

  private

    def json_request?
      request.format.json?
    end

    def render_empty_search
      # This code is a copy of Blacklight::Catalog.index() method but adapted to use
      # a cached version of the data rather than requesting the data from Solr.
      # See https://github.com/projectblacklight/blacklight/blob/v7.0.1/app/controllers/concerns/blacklight/catalog.rb#L25-L41
      @response = empty_solr_response
      @document_list = @response.documents
      respond_to do |format|
        format.html { store_preferred_view }
        format.rss  { render layout: false }
        format.atom { render layout: false }
        format.json do
          @presenter = Blacklight::JsonPresenter.new(@response, blacklight_config)
        end
        additional_response_formats(format)
        document_export_formats(format)
      end
    end

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

    def empty_solr_response(cached_response = empty_raw_response)
      raw_response = JSON.parse(cached_response)
      Blacklight::Solr::Response.new(raw_response, raw_response["responseHeader"]["params"], blacklight_config: @blacklight_config)
    end

    def empty_raw_response
      Rails.cache.fetch("home_page_empty_raw_response", expires_in: 3.hours) do
        Rails.logger.info "Cached home page results"
        # We cannot cache the Blacklight::Solr::Response as-is so we convert it to JSON first
        search_service_compatibility_wrapper.search_results.to_json
      end
    end

    def empty_advanced_search_raw_response
      Rails.cache.fetch('advanced_search_form_empty_raw_response', expires_in: 8.hours) do
        Rails.logger.info "Cached empty advanced search form solr query"
        SearchServiceCompatibilityWrapper.new(blacklight_advanced_search_form_search_service).search_results.to_json
      end
    end

    def basic_response
      render plain: 'OK'
      nil
    end

    def search_service_context
      return {} unless Flipflop.multi_algorithm?
      return {} unless alternate_search_builder_class # use default if none specified
      { search_builder_class: alternate_search_builder_class }
    end

    def alternate_search_builder_class
      return unless search_algorithm_param && allowed_search_algorithms.include?(search_algorithm_param)

      "#{search_algorithm_param}_search_builder".camelize.constantize
    end

    # When adding a new Ranking Algorithm the name will need to be added to this list before it can be utilized
    # For example if you added a cats ranking algorithm, with a CatsSearchBuilder you would add "cats" to this list ["engineering","cats"]
    # This is to make sure the user can not just execute any SearchBuilder in the system
    def allowed_search_algorithms
      ["engineering"]
    end

    def search_algorithm_param
      params[:search_algorithm]
    end

    def search_service_compatibility_wrapper
      @search_service_compatibility_wrapper ||= SearchServiceCompatibilityWrapper.new(search_service)
    end

    def solrize_boolean_params
      @search_state = search_state.reset(AdvancedBooleanOperators.new(search_state.params).for_boolqparser)
    end
end

pulibrary / orangelight / c9d0eaec-c698-418e-a1b2-1ebc338545f6

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

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