blacklight 9.0.0.beta6 → 9.0.0.beta8

data/app/presenters/blacklight/rendering/join.rb

@@ -5,12 +5,11 @@ module Blacklight
     class Join < AbstractStep
       def render
         options = config.separator_options || {}
-        if values.one? || values.none?
-          next_step(values.first)
-        elsif !html?
-          next_step(values.to_sentence(options))
-        else
+
+        if join? && html? && values.many?
           next_step(values.map { |x| x.html_safe? ? x : html_escape(x) }.to_sentence(options).html_safe)
+        else
+          next_step(values)
         end
       end
 
@@ -19,6 +18,11 @@ module Blacklight
       def html_escape(*)
         ERB::Util.html_escape(*)
       end
+
+      # @return [Boolean]
+      def join?
+        options[:join] || config.join || config.separator_options
+      end
     end
   end
 end

data/app/presenters/blacklight/rendering/terminator.rb

@@ -4,7 +4,7 @@ module Blacklight
   module Rendering
     class Terminator < AbstractStep
       def render
-        values
+        Array.wrap values
       end
     end
   end

data/app/views/catalog/_document.atom.builder

@@ -21,7 +21,7 @@ xml.entry do
   with_format(:html) do
     xml.summary "type" => "html" do
       document_component = blacklight_config.view_config(:atom).summary_component
-      xml.text! render document_component.new(document_component.collection_parameter => document_presenter(document), component: :div, show: true)
+      xml.text! render document_component.new(document: document_presenter(document), component: :div, show: true)
     end
   end
 

data/app/views/catalog/_document.html.erb

@@ -1,4 +1,4 @@
 <% # container for a single doc -%>
 <% view_config = local_assigns[:view_config] || blacklight_config.view_config(document_index_view_type, action_name: action_name) %>
 <% document_component = view_config.document_component -%>
-<%= render document_component.new(document_component.collection_parameter => document_presenter(document), counter: document_counter_with_offset(document_counter), partials: view_config&.partials) %>
+<%= render document_component.new(document: document_presenter(document), counter: document_counter_with_offset(document_counter), partials: view_config&.partials) %>

data/app/views/catalog/_show_main_content.html.erb

@@ -1,14 +1,18 @@
-<%= render blacklight_config.view_config(:show).document_header_component.new(document: @document, search_context: @search_context, search_session: search_session) %>
-<% @page_title = t('blacklight.search.show.title', document_title: document_presenter(@document).html_title, application_name: application_name).html_safe %>
+<%# locals: (presenter: nil) %>
+<% presenter ||= document_presenter(@document) %>
+
+<% @page_title = t('blacklight.search.show.title', document_title: presenter.html_title, application_name: application_name).html_safe %>
 <% content_for(:head) { render_link_rel_alternates } %>
 
-<% document_component = blacklight_config.view_config(:show).document_component -%>
-<%= render (document_component).new(document_component.collection_parameter => document_presenter(@document), component: :div, show: true, partials: blacklight_config.view_config(:show).partials) do |component| %>
+<%= render presenter.view_config.document_header_component.new(document: @document, search_context: @search_context, search_session: search_session) %>
+
+<% document_component = presenter.view_config.document_component -%>
+<%= render document_component.new(id: 'document', document: presenter, component: :div, show: true, partials: presenter.view_config.partials) do |component| %>
   <% component.with_title(as: 'h1', classes: '', link_to_document: false, actions: false) %>
   <% component.with_footer do %>
     <% if @document.respond_to?(:export_as_openurl_ctx_kev) %>
       <!-- COinS, for Zotero among others. -->
-      <span class="Z3988" title="<%= @document.export_as_openurl_ctx_kev(document_presenter(@document).display_type) %>"></span>
+      <span class="Z3988" title="<%= @document.export_as_openurl_ctx_kev(presenter.display_type) %>"></span>
     <% end %>
   <% end %>
 <% end %>

data/app/views/catalog/index.html.erb

@@ -11,7 +11,6 @@
 <% unless has_search_parameters? %>
   <%# if there are no input/search related params, display the "home" partial -%>
   <%= render 'home' %>
-  <%= render 'shared/sitelinks_search_box' %>
 <% else %>
   <%= render 'search_results' %>
 <% end %>

data/app/views/catalog/show.html.erb

@@ -1,6 +1,6 @@
-<%= render 'show_main_content' %>
+<% presenter = document_presenter(@document) %>
+<%= render 'show_main_content', presenter: presenter %>
 
 <% content_for(:sidebar) do %>
-  <% presenter = document_presenter(@document) %>
   <%= render presenter.view_config.sidebar_component.new(presenter: presenter) %>
 <% end %>

data/blacklight.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.add_dependency "kaminari", ">= 0.15" # the pagination (page 1,2,3, etc..) of our search results
   s.add_dependency "i18n", '>= 1.7.0' # added named parameters
   s.add_dependency "ostruct", '>= 0.3.2'
-  s.add_dependency "view_component", '~> 3.9'
+  s.add_dependency "view_component", '>= 3.0', '< 5.0'
   s.add_dependency "zeitwerk"
 
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.

data/config/locales/blacklight.ar.yml

@@ -120,7 +120,7 @@ ar:
         remove:
           label_value: "إزالة القيد %{label}: %{value}"
           value: إزالة القيد %{value}
-        title: "لقد بحثت عن:"
+        title: "اختياراتك:"
       form:
         search:
           label: ابحث عن
@@ -160,7 +160,6 @@ ar:
         submit: تحديث
         title: عدد النتائج المعروضة في الصفحة
       rss_feed: خلاصات RSS للنتائج
-      search_constraints_header: قيود البحث
       search_results: نتائج البحث
       show:
         label: "%{label}:"

data/config/locales/blacklight.ca.yml

@@ -136,7 +136,6 @@ ca:
         many_constraint_values: "%{values} seleccionat"
         joiner: " / "
       header: "Cerca"
-      search_constraints_header: "Filtres de la cerca"
       search_results: "Resultats de la cerca"
       errors:
         invalid_solr_id: "El registre que heu sol·licitat no existeix."
@@ -194,7 +193,7 @@ ca:
       group:
         more: "més »"
       filters:
-        title: "Heu cercat per:"
+        title: "Les teves seleccions:"
         label: "%{label}:"
         remove:
           value: "Eliminar el filtre %{value}"

data/config/locales/blacklight.de.yml

@@ -111,7 +111,7 @@ de:
         remove:
           label_value: "Filter %{label}: %{value} entfernen"
           value: Filter %{value} entfernen
-        title: "Sie suchten nach:"
+        title: "Ihre Auswahl:"
       form:
         search:
           label: suchen nach
@@ -147,7 +147,6 @@ de:
         submit: Aktualisieren
         title: Anzahl der Ergebnisse, die pro Seite angezeigt werden
       rss_feed: RSS für Ergebnisse
-      search_constraints_header: Suchen
       search_results: Suchergebnisse
       show:
         label: "%{label}:"

data/config/locales/blacklight.en.yml

@@ -11,7 +11,7 @@ en:
         sort_label: Sort results by
         start_over_html: Start over
         title: Advanced search
-      more_options: More options
+      more_options: Advanced search
       op:
         label: search operator
         must: all
@@ -129,7 +129,7 @@ en:
         remove:
           label_value: "Remove constraint %{label}: %{value}"
           value: Remove constraint %{value}
-        title: "You searched for:"
+        title: "Your selections:"
       form:
         search:
           label: search for
@@ -165,7 +165,6 @@ en:
         submit: Update
         title: Number of results to display per page
       rss_feed: RSS for results
-      search_constraints_header: Search Constraints
       search_results: Search Results
       show:
         label: "%{label}:"

data/config/locales/blacklight.es.yml

@@ -110,7 +110,7 @@ es:
         remove:
           label_value: "Eliminar la restricción%{label}: %{value}"
           value: Eliminar la restricción %{value}
-        title: "Usted ha buscado:"
+        title: "Tus selecciones:"
       form:
         search:
           label: buscar
@@ -146,7 +146,6 @@ es:
         submit: Actualización
         title: El número de resultados a mostrar por página
       rss_feed: RSS de los resultados
-      search_constraints_header: Buscar
       search_results: Resultados de la búsqueda
       show:
         label: "%{label}:"

data/config/locales/blacklight.fr.yml

@@ -110,7 +110,7 @@ fr:
         remove:
           label_value: "Supprimer la restriction %{label}: %{value}"
           value: Supprimer la restriction %{value}
-        title: "Vous avez demandé :"
+        title: "Vos sélections:"
       form:
         search:
           label: Rechercher
@@ -146,7 +146,6 @@ fr:
         submit: mettre à jour
         title: Nombre de résultats à afficher par page
       rss_feed: RSS pour les résultats
-      search_constraints_header: Recherche
       search_results: Résultats de recherche
       show:
         label: "%{label}:"

data/config/locales/blacklight.hu.yml

@@ -108,7 +108,7 @@ hu:
         remove:
           label_value: "Feltétel eltávolítása %{label}: %{value}"
           value: Feltételek eltávolítása %{value}
-        title: "Ön ezt kereste:"
+        title: "Az Ön választása:"
       form:
         search:
           label: keresés
@@ -144,7 +144,6 @@ hu:
         submit: Frissítés
         title: Az eredmények száma oldalanként
       rss_feed: Eredmények RSS-ként
-      search_constraints_header: Keresés feltételei
       search_results: Keresés eredményei
       show:
         label: "%{label}:"

data/config/locales/blacklight.it.yml

@@ -111,7 +111,7 @@ it:
         remove:
           label_value: "Cancella il filtro %{label}: %{value}"
           value: Cancella il filtro %{value}
-        title: "Hai cercato per:"
+        title: "Le tue selezioni:"
       form:
         search:
           label: cerca per
@@ -147,7 +147,6 @@ it:
         submit: Aggiorna
         title: Risultati per pagina
       rss_feed: RSS per i risultati
-      search_constraints_header: Ricerca
       search_results: Risultati della ricerca
       show:
         label: "%{label}:"

data/config/locales/blacklight.nl.yml

@@ -108,7 +108,7 @@ nl:
         remove:
           label_value: "Verwijder zoekfilter %{label}: %{value}"
           value: Verwijder zoekfilter %{value}
-        title: "U zocht op:"
+        title: "Uw selecties:"
       form:
         search:
           label: zoeken op
@@ -144,7 +144,6 @@ nl:
         submit: Update
         title: Toon aantal zoekresultaten per pagina
       rss_feed: RSS voor zoekresultaten
-      search_constraints_header: Zoek filters
       search_results: Zoek resultaten
       show:
         label: "%{label}:"

data/config/locales/blacklight.pt-BR.yml

@@ -109,7 +109,7 @@ pt-BR:
         remove:
           label_value: "Remover %{label}: %{value}"
           value: Remover filtro %{value}
-        title: "Sua busca por:"
+        title: "Suas seleções:"
       form:
         search:
           label: busca
@@ -145,7 +145,6 @@ pt-BR:
         submit: Atualizar
         title: Número de resultados para mostrar por página
       rss_feed: RSS para resultadoss
-      search_constraints_header: Busca
       search_results: Resultados da Busca
       show:
         label: "%{label}:"

data/config/locales/blacklight.sq.yml

@@ -108,7 +108,7 @@ sq:
         remove:
           label_value: "Fshij kufizimin %{label}: %{value}"
           value: Fshij kufizimin %{value}
-        title: "Ju keni kërkuar për:"
+        title: "Zgjedhjet tuaja:"
       form:
         search:
           label: kërko për
@@ -144,7 +144,6 @@ sq:
         submit: Përditëso
         title: Numri i rezultateve që do të shfaqen për faqe
       rss_feed: RSS për rezultatet
-      search_constraints_header: Kufizimet e kërkimit
       search_results: Rezultatet e kërkimit
       show:
         label: "%{label}:"

data/config/locales/blacklight.zh.yml

@@ -108,7 +108,7 @@ zh:
         remove:
           label_value: "删除限定条件 %{label}: %{value}"
           value: 删除限定条件 %{value}
-        title: 你在搜索：
+        title: 您的选择：
       form:
         search:
           label: 搜索
@@ -144,7 +144,6 @@ zh:
         submit: 更新
         title: 每页显示结果数
       rss_feed: 搜索结果RSS
-      search_constraints_header: 搜索条件
       search_results: 搜索结果
       show:
         label: "%{label}:"

data/lib/blacklight/component.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'view_component/version'
+
 module Blacklight
   class Component < ViewComponent::Base
     class << self
@@ -9,9 +11,13 @@ module Blacklight
         @__vc_compiler = nil
       end
 
+      # This allows the host application to provide erb templates that override the templates
+      # provided by Blacklight.
       def sidecar_files(*args, **kwargs)
         upstream_sidecar_files(*args, **kwargs).map do |path|
-          app_path = Rails.root.join(path.slice(path.index(view_component_path)..-1).to_s).to_s
+          components_path = ViewComponent::VERSION::MAJOR == 3 ? view_component_path : config.generate.path
+
+          app_path = Rails.root.join(path.slice(path.index(components_path)..-1).to_s).to_s
 
           if File.exist?(app_path)
             app_path

data/lib/blacklight/configuration/facet_field.rb

@@ -16,6 +16,8 @@ module Blacklight
     #   @return [Boolean] whether to show the facet to the user or not (very similar to the more generic if/unless)
     # @!attribute index_range
     #   @return [Enumerable] a list of facet prefixes (default: A-Z) to allow users to 'jump' to particular values
+    # @!attribute suggest
+    #   @return [Boolean] whether to display a suggest/autocomplete on the detailed facet view that allows users to filter facet values
     # @!attribute date
     #   @return [Symbol|Hash] the i18n localization option for a date or time value; used as the second parameter for the I18n.l method
     # @!attribute link_to_facet
@@ -76,6 +78,8 @@ module Blacklight
       self.index_range = 'A'..'Z' if index_range == true
       self.presenter ||= Blacklight::FacetFieldPresenter
       self.item_presenter ||= Blacklight::FacetItemPresenter
+      self.constraint_presenter ||= Blacklight::ConstraintPresenter
+
       self.component = Blacklight::Facets::ListComponent if component.nil? || component == true
       self.advanced_search_component ||= Blacklight::Facets::CheckboxesComponent
       self.item_component ||= Blacklight::Facets::ItemComponent

data/lib/blacklight/configuration/view_config.rb

@@ -8,6 +8,14 @@ class Blacklight::Configuration
     #   @return [Class] document presenter class used by helpers and views
     # @!attribute document_component
     #   @return [Class] component class used to render a document; defaults to Blacklight::DocumentComponent
+    # @!attribute document_title_component
+    #   @return [Class] component class used to render a document title
+    # @!attribute document_metadata_component
+    #   @return [Class] component class used to render the document metadata
+    # @!attribute document_thumbnail_component
+    #   @return [Class] component class used to render a document thumbnail
+    # @!attribute document_embed_component
+    #   @return [Class] component class used to render a document embed
     # @!attribute title_field
     #   @return [String, Symbol] solr field to use to render a document title
     # @!attribute display_type_field
@@ -46,19 +54,33 @@ class Blacklight::Configuration
       end
     end
 
+    # Provide backwards compatibility with the configuration keys without the document_ prefix
+    def title_component(*) = document_title_component(*)
+    def metadata_component(*) = document_metadata_component(*)
+    def thumbnail_component(*) = document_thumbnail_component(*)
+    def embed_component(*) = document_embed_component(*)
+
+    def title_component=(value)
+      self.document_title_component = value
+    end
+
+    def metadata_component=(value)
+      self.document_metadata_component = value
+    end
+
+    def thumbnail_component=(value)
+      self.document_thumbnail_component = value
+    end
+
+    def embed_component=(value)
+      self.document_embed_component = value
+    end
+
     class Show < ViewConfig
       # @!attribute route
       #   @return [Hash] Default route parameters for 'show' requests.
       #     Set this to a hash with additional arguments to merge into the route,
       #     or set `controller: :current` to route to the current controller.
-
-      def document_presenter_class
-        super || Blacklight::ShowPresenter
-      end
-
-      def to_h
-        super.merge(document_presenter_class: document_presenter_class)
-      end
     end
 
     class Index < ViewConfig
@@ -69,14 +91,6 @@ class Blacklight::Configuration
       #      see Blacklight::Catalog#additional_response_formats for information about the OpenStruct data
       # @!attribute collection_actions
       #   @return [String, Symbol]
-
-      def document_presenter_class
-        super || Blacklight::IndexPresenter
-      end
-
-      def to_h
-        super.merge(document_presenter_class: document_presenter_class)
-      end
     end
   end
 end

data/lib/blacklight/configuration.rb

@@ -73,7 +73,8 @@ module Blacklight
       # @!attribute json_solr_path
       # @since v7.34.0
       # @return [String] The url path (relative to the solr base url) to use when using Solr's JSON Query DSL (as with the advanced search)
-      property :json_solr_path, default: 'advanced'
+      # @note You can configure a separate custom 'advanced' requestHandler in solrconfig.xml if desired, but it isn't necessary; the default 'select' handler will work.
+      property :json_solr_path, default: 'select'
       # @!attribute document_unique_id_param
       # @since v5.2.0
       # @return [Symbol] The solr query parameter used for sending the unique identifiers for one or more documents
@@ -147,9 +148,15 @@ module Blacklight
       # @return [Blacklight::Configuration::ViewConfig::Index]
       property :index, default: ViewConfig::Index.new(
         # document presenter class used by helpers and views
-        document_presenter_class: nil,
+        document_presenter_class: Blacklight::IndexPresenter,
+        # document presenter used for json responses
+        json_presenter_class: Blacklight::JsonPresenter,
         # component class used to render a document
         document_component: Blacklight::DocumentComponent,
+        document_embed_component: nil,
+        document_metadata_component: Blacklight::DocumentMetadataComponent,
+        document_thumbnail_component: Blacklight::Document::ThumbnailComponent,
+        document_title_component: Blacklight::DocumentTitleComponent,
         sidebar_component: Blacklight::Search::SidebarComponent,
         dropdown_component: Blacklight::System::DropdownComponent,
         # solr field to use to render a document title
@@ -185,8 +192,9 @@ module Blacklight
       # @return [Blacklight::Configuration::ViewConfig::Show]
       property :show, default: ViewConfig::Show.new(
         # document presenter class used by helpers and views
-        document_presenter_class: nil,
+        document_presenter_class: Blacklight::ShowPresenter,
         document_component: Blacklight::DocumentComponent,
+        document_thumbnail_component: nil,
         show_tools_component: Blacklight::Document::ShowToolsComponent,
         show_header_tools_component: nil,
         document_header_component: Blacklight::Document::PageHeaderComponent,
@@ -267,6 +275,10 @@ module Blacklight
       # @since v5.10.0
       # @return [Integer]
       property :default_facet_limit, default: 10
+      # @!attribute default_facet_suggest
+      # @since v9.0.0
+      # @return [Boolean]
+      property :default_facet_suggest, default: true
       # @!attribute default_more_limit
       # @since v7.0.0
       # @return [Integer]
@@ -297,8 +309,13 @@ module Blacklight
 
       # @!attribute advanced_search
       # @since v7.15.0
-      # @return [#enabled]
-      property :advanced_search, default: OpenStruct.new(enabled: false)
+      # @return [OpenStructWithHashAccess] Configuration for advanced search, including:
+      #   enabled: (Boolean) whether advanced search is enabled
+      #   form_solr_parameters: (Hash) optional parameters to send to Solr for the advanced search
+      #                                form; can override values that are set automatically via the
+      #                                #copy_facet_field_config_to_advanced! method
+      property :advanced_search, default: OpenStructWithHashAccess.new(enabled: true,
+                                                                       form_solr_parameters: {})
 
       # @!attribute enable_search_bar_autofocus
       # @since v7.2.0
@@ -455,6 +472,42 @@ module Blacklight
       facet_fields.map { |_facet, opts| opts[:group] }.uniq
     end
 
+    # Use existing search field configs to automatically prepare fields for use
+    # by the advanced search form.
+    def copy_search_field_config_to_advanced!
+      search_fields.each_value do |field|
+        next if field.include_in_advanced_search == false
+        next if field.clause_params
+
+        field.clause_params = {}
+        field.clause_params[:edismax] = field.solr_parameters.dup || {}
+      end
+    end
+
+    # Use existing facet field configs to automatically prepare fields for use
+    # by the advanced search form. If more specific config is needed, e.g., to
+    # set the facet limit for one field to a value other than -1, it can be
+    # expressed in the configuration in advanced_search.form_solr_parameters
+    def copy_facet_field_config_to_advanced!
+      advanced_search.form_solr_parameters ||= {}
+      advanced_search.form_solr_parameters['facet.sort'] ||= 'count'
+      advanced_search.form_solr_parameters['facet.field'] ||= []
+
+      facet_fields.each_value do |field|
+        next if field.include_in_advanced_search == false
+        # Skip query-type and pivot facets that can't be requested via facet.field
+        next if field.query || field.pivot || field.range
+
+        # Add the facet field to the advanced search configuration
+        advanced_search.form_solr_parameters['facet.field'] << field.field unless
+          advanced_search.form_solr_parameters['facet.field'].include?(field.field)
+
+        # Set the facet field's limit to -1 to show ALL values in advanced search
+        advanced_search.form_solr_parameters["f.#{field.field}.facet.limit"] = -1 unless
+          advanced_search.form_solr_parameters["f.#{field.field}.facet.limit"]
+      end
+    end
+
     # Add any configured facet fields to the default solr parameters hash
     # @overload add_facet_fields_to_solr_request!
     #    add all facet fields to the solr request

data/lib/blacklight/search_state/pivot_filter_field.rb

@@ -102,7 +102,7 @@ module Blacklight
             end
             queries.uniq!
           end
-          [(queries - existing)]
+          [queries - existing]
         end
       end
 

data/lib/blacklight/solr/field_reflection_search_builder.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Blacklight::Solr
+  class FieldReflectionSearchBuilder < SearchBuilder
+    self.default_processor_chain = [:add_params]
+
+    def add_params(request)
+      request.reverse_merge!({ fl: '*', 'json.nl' => 'map' })
+    end
+  end
+end

data/lib/blacklight/solr/repository.rb

@@ -7,8 +7,7 @@ module Blacklight::Solr
     # @param [String] id document's unique key value
     # @param [Hash] params additional solr query parameters
     def find id, params = {}
-      doc_params = params.reverse_merge(blacklight_config.default_document_solr_params)
-                         .merge(blacklight_config.document_unique_id_param => id)
+      doc_params = SingleDocSearchBuilder.new(self, id, params)
 
       solr_response = send_and_receive blacklight_config.document_solr_path || blacklight_config.solr_path, doc_params
       raise Blacklight::Exceptions::RecordNotFound if solr_response.documents.empty?
@@ -24,14 +23,14 @@ module Blacklight::Solr
 
     ##
     # Execute a search query against solr
-    # @param [Hash] params solr query parameters
+    # @param [Hash,Blacklight::SearchBuilder] params solr query parameters
     # @param [String] path solr request handler path
     def search pos_params = nil, path: nil, params: nil, **kwargs
       if pos_params
         Blacklight.deprecation.warn("Passing positional arguments to search() is deprecated. Use the params kwarg instead.")
       end
 
-      request_params = (params || pos_params).reverse_merge(kwargs).reverse_merge({ qt: blacklight_config.qt })
+      request_params = (params || pos_params || {}).reverse_merge(kwargs).reverse_merge({ qt: blacklight_config.qt })
 
       send_and_receive(path || default_search_path(request_params), request_params)
     end
@@ -47,7 +46,8 @@ module Blacklight::Solr
     # Gets a list of available fields
     # @return [Hash]
     def reflect_fields
-      send_and_receive('admin/luke', params: { fl: '*', 'json.nl' => 'map' })['fields']
+      doc_params = FieldReflectionSearchBuilder.new(self)
+      send_and_receive('admin/luke', doc_params)['fields']
     end
 
     ##