blacklight 9.0.0.beta7 → 9.0.0

data/app/components/blacklight/document_component.rb

@@ -34,27 +34,24 @@ module Blacklight
 
     # The document title with some reasonable default behavior
     renders_one :title, (lambda do |component: nil, **kwargs|
-      component ||= view_config.title_component || Blacklight::DocumentTitleComponent
+      component ||= view_config.document_title_component
 
-      component.new(counter: @counter, presenter: @presenter, as: @title_component, actions: !@show, link_to_document: !@show, document_component: self, **kwargs)
+      component&.new(counter: @counter, presenter: @presenter, as: @title_component, actions: !@show, link_to_document: !@show, document_component: self, **kwargs)
     end)
 
     renders_one :embed, (lambda do |static_content = nil, component: nil, **kwargs|
       next static_content if static_content.present?
 
-      component ||= view_config.embed_component
-
-      next unless component
-
-      component.new(presenter: @presenter, document_counter: @document_counter, **kwargs)
+      component ||= view_config.document_embed_component
+      component&.new(presenter: @presenter, document_counter: @document_counter, **kwargs)
     end)
 
     # The primary metadata section
     renders_one :metadata, (lambda do |static_content = nil, component: nil, fields: nil, **kwargs|
       next static_content if static_content.present?
 
-      component ||= view_config.metadata_component || Blacklight::DocumentMetadataComponent
-      component.new(fields: fields || @presenter&.field_presenters || [], **kwargs)
+      component ||= view_config.document_metadata_component
+      component&.new(fields: fields || @presenter&.field_presenters || [], **kwargs)
     end)
 
     # Additional metadata sections
@@ -63,9 +60,9 @@ module Blacklight
     renders_one :thumbnail, (lambda do |image_options_or_static_content = {}, component: nil, **kwargs|
       next image_options_or_static_content if image_options_or_static_content.is_a? String
 
-      component ||= view_config.thumbnail_component || Blacklight::Document::ThumbnailComponent
+      component ||= view_config.document_thumbnail_component
 
-      component.new(presenter: @presenter, counter: @counter, image_options: image_options_or_static_content, **kwargs)
+      component&.new(presenter: @presenter, counter: @counter, image_options: image_options_or_static_content, **kwargs)
     end)
 
     # A container for partials rendered using the view config partials configuration. Its use is discouraged, but necessary until
@@ -96,7 +93,7 @@ module Blacklight
 
       @component = component
       @title_component = title_component
-      @id = id || ('document' if show)
+      @id = id
       @classes = classes
 
       @counter = counter
@@ -119,7 +116,7 @@ module Blacklight
 
     def before_render
       with_title unless title
-      with_thumbnail unless thumbnail || show?
+      with_thumbnail unless thumbnail
       with_metadata(fields: presenter.field_presenters, show: @show) unless metadata
       with_embed unless embed
 

data/app/components/blacklight/facets/filters_component.rb

@@ -3,7 +3,7 @@
 module Blacklight::Facets
   class FiltersComponent < Blacklight::Component
     # @param [Blacklight::FacetFieldPresenter] presenter
-    def initialize(presenter:, classes: 'facet-filters card card-body bg-light p-3 mb-3 border-0',
+    def initialize(presenter:, classes: 'facet-filters mt-1 mb-3',
                    suggestions_component: Blacklight::Facets::SuggestComponent,
                    index_navigation_component: Blacklight::Facets::IndexNavigationComponent)
       @presenter = presenter
@@ -21,7 +21,7 @@ module Blacklight::Facets
     delegate :display_facet, to: :presenter
 
     def render?
-      facet.suggest != false || render_index_navigation?
+      presenter.suggest? || render_index_navigation?
     end
 
     def render_index_navigation?

data/app/components/blacklight/facets/suggest_component.html.erb

@@ -1,12 +1,17 @@
-<label class="form-label" for="facet_suggest_<%= key %>">
-  <%= I18n.t('blacklight.search.facets.suggest.label', field_label: label) %>
-</label>
-<%= text_field_tag "facet_suggest_#{key}",
-  nil,
-  class: "facet-suggest form-control mb-3",
-  data: {
-    facet_field: key,
-    facet_search_context: helpers.search_facet_path(id: key)
-  },
-  placeholder: I18n.t('blacklight.search.form.search.placeholder')
-%>
+<div class="input-group">
+  <label class="input-group-text" for="facet_suggest_<%= key %>">
+    <%= I18n.t('blacklight.search.facets.suggest.label', field_label: label.downcase.pluralize) %>
+  </label>
+  <%= search_field_tag "facet_suggest_#{key}",
+    nil,
+    class: "facet-suggest form-control",
+    data: {
+      facet_field: key,
+      facet_search_context: helpers.search_facet_path(id: key)
+    },
+    placeholder: I18n.t('blacklight.search.facets.suggest.placeholder')
+  %>
+  <span class="input-group-text">
+    <%= render Blacklight::Icons::SearchComponent.new %>
+  </span>
+</div>

data/app/components/blacklight/facets/suggest_component.rb

@@ -11,11 +11,10 @@ module Blacklight
 
       attr_accessor :presenter
 
-      delegate :suggest, :key, :label, to: :presenter
+      delegate :key, :label, to: :presenter
 
       def render?
-        # Draw if suggest is true or not present
-        suggest != false
+        presenter.suggest?
       end
     end
   end

data/app/components/blacklight/metadata_field_component.html.erb

@@ -2,7 +2,7 @@
   <% component.with_label do %>
     <%= label %>
   <% end %>
-  <% component.with_value do %>
-    <%= render_field %>
+  <% render_field_values.each_with_index do |value, index| %>
+    <% component.with_value(value: value, index: index) %>
   <% end %>
 <% end %>

data/app/components/blacklight/metadata_field_component.rb

@@ -27,7 +27,8 @@ module Blacklight
     end
 
     # Override this method in a subclass to change the way this value is rendered
-    def render_field
+    # @return [Array]
+    def render_field_values
       @field.render
     end
 

data/app/components/blacklight/metadata_field_layout_component.rb

@@ -4,23 +4,28 @@ module Blacklight
   class MetadataFieldLayoutComponent < Blacklight::Component
     with_collection_parameter :field
     renders_one :label
-    renders_many :values, (lambda do |value: nil, &block|
+    renders_many :values, (lambda do |index:, value: nil, &block|
+      classes = [@value_class, "blacklight-#{@key}"]
+      classes.unshift @offset_class unless index.zero?
+      classes.join(' ')
+
       if @value_tag.nil?
         block&.call || value
       elsif block
-        content_tag @value_tag, class: "#{@value_class} blacklight-#{@key}", &block
+        content_tag @value_tag, class: classes, &block
       else
-        content_tag @value_tag, value, class: "#{@value_class} blacklight-#{@key}"
+        content_tag @value_tag, value, class: classes
       end
     end)
 
     # @param field [Blacklight::FieldPresenter]
-    def initialize(field:, value_tag: 'dd', label_class: 'col-md-3', value_class: 'col-md-9')
+    def initialize(field:, value_tag: 'dd', label_class: 'col-md-3', value_class: 'col-md-9', offset_class: 'offset-md-3')
       @field = field
       @key = @field.key.parameterize
       @label_class = label_class
       @value_tag = value_tag
       @value_class = value_class
+      @offset_class = offset_class
     end
   end
 end

data/app/components/blacklight/search_bar_component.html.erb

@@ -36,6 +36,6 @@
   <% end %>
 
   <% if advanced_search_enabled? %>
-    <%= link_to t('blacklight.advanced_search.more_options'), @advanced_search_url, class: 'advanced_search btn btn-secondary'%>
+    <%= link_to t('blacklight.advanced_search.more_options'), @advanced_search_url, class: 'advanced_search btn btn-link text-body' %>
   <% end %>
 </search>

data/app/controllers/concerns/blacklight/catalog.rb

@@ -9,7 +9,6 @@ module Blacklight::Catalog
   include Blacklight::Configurable
   include Blacklight::SearchContext
   include Blacklight::Searchable
-  include Blacklight::Facetable
 
   # The following code is executed when someone includes blacklight::catalog in their
   # own controller.
@@ -82,11 +81,11 @@ module Blacklight::Catalog
     raise ActionController::RoutingError, 'Not Found' unless @facet
 
     @response = if params[:query_fragment].present?
-                  facet_search_service.facet_suggest_response(@facet.key, params[:query_fragment])
+                  search_service.facet_suggest_response(@facet.key, params[:query_fragment])
                 else
-                  facet_search_service.facet_field_response(@facet.key)
+                  search_service.facet_field_response(@facet.key)
                 end
-
+    # @display_facet is a Blacklight::Solr::Response::Facets::FacetField
     @display_facet = @response.aggregations[@facet.field]
 
     # @presenter is a Blacklight::FacetFieldPresenter

data/app/javascript/blacklight-frontend/checkbox_submit.js

@@ -10,7 +10,7 @@
        attribute (HTML5-style doc-*) that contains the id/primary key
        of the object in question -- used by plugin for a unique value for
        DOM id's.
-  Uses HTML for a checkbox compatible with Bootstrap 4.
+  Uses HTML for a checkbox compatible with Bootstrap.
    new CheckboxSubmit(document.querySelector('form.something')).render()
 */
 export default class CheckboxSubmit {
@@ -36,7 +36,7 @@ export default class CheckboxSubmit {
     }).then((json) => {
       this.labelTarget.removeAttribute('disabled')
       this.checkboxTarget.removeAttribute('disabled')
-      // For accessibility return keyboard focus 
+      // For accessibility return keyboard focus
       // back to the checkbox after form submission
       this.checkboxTarget.focus()
       this.updateStateFor(!this.checked)

data/app/javascript/blacklight-frontend/facet_suggest.js

@@ -16,10 +16,13 @@ const FacetSuggest = async (e) => {
 
     // Drop facet.page so a filtered suggestion list will always start on page 1
     url.searchParams.delete('facet.page');
+    // add our queryFragment for facet filtering
+    url.searchParams.append('query_fragment', queryFragment);
+
     const facetSearchParams = url.searchParams.toString();
     const basePathComponent = url.pathname.split('/')[1];
 
-    const urlToFetch = `/${basePathComponent}/facet_suggest/${facetField}/${queryFragment}?${facetSearchParams}`;
+    const urlToFetch = `/${basePathComponent}/facet_suggest/${facetField}?${facetSearchParams}`;
 
     const response = await fetch(urlToFetch);
     if (response.ok) {

data/app/javascript/blacklight-frontend/modal.js

@@ -160,11 +160,14 @@ const Modal = (() => {
 
     // Make sure user-agent dismissal of html 'dialog', etc `esc` key, triggers
     // our hide logic, including events and scroll restoration.
-    modal.target().addEventListener('cancel', (e) => {
-      e.preventDefault(); // 'hide' will close the modal unless cancelled
+    const modalDom = modal.target();
+    if (modalDom) {
+      modal.target().addEventListener('cancel', (e) => {
+        e.preventDefault(); // 'hide' will close the modal unless cancelled
 
-      modal.hide();
-    });
+        modal.hide();
+      });
+    }
   };
 
   modal.hide = function (el) {

data/app/presenters/blacklight/document_presenter.rb

@@ -44,11 +44,11 @@ module Blacklight
     #
     # @return [String]
     def heading
-      return field_value(view_config.title_field) if view_config.title_field.is_a? Blacklight::Configuration::Field
+      return field_value(view_config.title_field, join: true).first if view_config.title_field.is_a? Blacklight::Configuration::Field
 
       fields = Array.wrap(view_config.title_field) + [configuration.document_model.unique_key]
       f = fields.lazy.map { |field| field_config(field) }.detect { |field_config| field_presenter(field_config).any? }
-      f ? field_value(f, except_operations: [Rendering::HelperMethod]) : ""
+      f ? field_value(f, except_operations: [Rendering::HelperMethod], join: true).first : ""
     end
 
     ##
@@ -58,12 +58,12 @@ module Blacklight
     # @see #document_heading
     # @return [String]
     def html_title
-      return field_value(view_config.html_title_field) if view_config.html_title_field.is_a? Blacklight::Configuration::Field
+      return field_value(view_config.html_title_field, join: true).first if view_config.html_title_field.is_a? Blacklight::Configuration::Field
 
       if view_config.html_title_field
         fields = Array.wrap(view_config.html_title_field) + [configuration.document_model.unique_key]
         f = fields.lazy.map { |field| field_config(field) }.detect { |field_config| field_presenter(field_config).any? }
-        field_value(f)
+        field_value(f, join: true).first
       else
         heading
       end
@@ -93,8 +93,9 @@ module Blacklight
     # @param [Configuration::Field] field_config
     # @param [Hash] options
     # @option options [String] :value
+    # @return [Array]
     def field_value field_config, options = {}
-      field_presenter(field_config, options).render
+      Array.wrap(field_presenter(field_config, options).render)
     end
 
     def thumbnail_presenter_class

data/app/presenters/blacklight/facet_field_presenter.rb

@@ -4,18 +4,18 @@ module Blacklight
   class FacetFieldPresenter
     attr_reader :facet_field, :display_facet, :view_context, :search_state
 
-    delegate :key, :suggest, to: :facet_field
+    delegate :key, to: :facet_field
     delegate :field_name, to: :display_facet
 
     # @param [Blacklight::Configuration::FacetField] facet_field
     # @param [Blacklight::Solr::Response::Facets::FacetField] display_facet
     # @param [#search_action_path,#facet_field_presenter] view_context
     # @param [Blacklight::SearchState] search_state
-    def initialize(facet_field, display_facet, view_context, search_state = view_context.search_state)
+    def initialize(facet_field, display_facet, view_context, search_state = nil)
       @facet_field = facet_field
       @display_facet = display_facet
       @view_context = view_context
-      @search_state = search_state
+      @search_state = search_state || view_context&.search_state
     end
 
     # @param [Blacklight::Solr::Response::Facets::FacetItem, String] facet_item
@@ -23,6 +23,13 @@ module Blacklight
       facet_field.item_presenter.new(facet_item, facet_field, view_context, key, search_state)
     end
 
+    # Is facet suggest feature configured on for this facet, or by global default.
+    #
+    # @return [Boolean]
+    def suggest?
+      !!(facet_field.suggest.nil? ? blacklight_config.default_facet_suggest : facet_field.suggest)
+    end
+
     def collapsed?
       !active? && facet_field.collapse
     end

data/app/presenters/blacklight/field_presenter.rb

@@ -33,9 +33,11 @@ module Blacklight
 
     delegate :key, :component, to: :field_config
 
-    # @return [String]
+    # @return [Array<String>]
     def render
-      Rendering::Pipeline.new(values, field_config, document, view_context, pipeline_steps, options).render
+      Array.wrap(
+        Rendering::Pipeline.new(values, field_config, document, view_context, pipeline_steps, options).render
+      )
     end
 
     # @return [Enumerable]

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

@@ -22,7 +22,13 @@ module Blacklight
       end
 
       def html?
-        options[:format].nil? || options[:format].to_s == 'html'
+        format.nil? || format.to_s == 'html'
+      end
+
+      def format
+        return options[:format] unless context.respond_to?(:search_state)
+
+        options[:format] || context.search_state&.params&.dig(:format)
       end
     end
   end

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/services/blacklight/search_service.rb

@@ -22,8 +22,10 @@ module Blacklight
       @search_state.class
     end
 
-    # a solr query method
-    # @yield [search_builder] optional block yields configured SearchBuilder, caller can modify or create new SearchBuilder to be used. Block should return SearchBuilder to be used.
+    # Fetch query results from solr
+    # @yield [search_builder] optional block yields configured SearchBuilder,  caller can modify or create new
+    #                         SearchBuilder to be used. Block should return SearchBuilder to be used.
+    #                         This is used in blacklight_range_limit
     # @return [Blacklight::Solr::Response] the solr response object
     def search_results
       builder = search_builder.with(search_state)

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: 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/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

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

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

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