blacklight 9.0.0.beta6 → 9.0.0.beta8

data/app/components/blacklight/constraints_component.rb

@@ -6,9 +6,10 @@ module Blacklight
     renders_many :facet_constraints_area
     renders_many :additional_constraints
 
+    # Constraints are stored and used to display search history - with this method, we initialize the ConstraintsComponent
+    # in a way that displays well in a table (and without a start-over button)
     def self.for_search_history(**)
-      new(tag: :span,
-          render_headers: false,
+      new(tag: :span, render_headers: false,
           id: nil,
           query_constraint_component: Blacklight::SearchHistoryConstraintLayoutComponent,
           facet_constraint_component_options: { layout: Blacklight::SearchHistoryConstraintLayoutComponent },
@@ -20,7 +21,8 @@ module Blacklight
     def initialize(search_state:,
                    tag: :div,
                    render_headers: true,
-                   id: 'appliedParams', classes: 'clearfix constraints-container mb-2',
+                   heading_classes: 'constraints-label h6 mb-0',
+                   id: 'appliedParams', classes: 'clearfix constraints-container mb-2 align-items-center',
                    query_constraint_component: Blacklight::ConstraintLayoutComponent,
                    query_constraint_component_options: {},
                    facet_constraint_component: Blacklight::ConstraintComponent,
@@ -33,12 +35,14 @@ module Blacklight
       @facet_constraint_component_options = facet_constraint_component_options
       @start_over_component = start_over_component
       @render_headers = render_headers
+      @heading_classes = heading_classes
       @tag = tag
       @id = id
       @classes = classes
     end
     # rubocop:enable Metrics/ParameterLists
 
+    # @return [String] HTML representation of query constraints
     def query_constraints
       if @search_state.query_param.present?
         render(
@@ -56,41 +60,54 @@ module Blacklight
       end + render(@facet_constraint_component.with_collection(clause_presenters.to_a, **@facet_constraint_component_options))
     end
 
+    # @return [String] URL path to remove the current query
     def remove_path
       helpers.search_action_path(@search_state.remove_query_params)
     end
 
+    # @return [String] HTML representation of facet constraints
     def facet_constraints
-      render(@facet_constraint_component.with_collection(facet_item_presenters.to_a, **@facet_constraint_component_options))
+      render(@facet_constraint_component.with_collection(constraint_presenters.to_a, **@facet_constraint_component_options))
     end
 
+    # @return [Boolean] true if search state has constraints
     def render?
       @search_state.has_constraints?
     end
 
     private
 
+    # @return [String, nil] label for the search field if not the default search field
     def label
       search_field = @search_state.params[:search_field]
       helpers.label_for_search_field(search_field) unless helpers.default_search_field?(search_field)
     end
 
-    def facet_item_presenters
-      return to_enum(:facet_item_presenters) unless block_given?
+    # Yields constraint presenters for each facet value
+    #
+    # @yield [Blacklight::ConstraintPresenter] facet constraint presenter
+    # @return [Enumerator] if no block given
+    def constraint_presenters
+      return to_enum(:constraint_presenters) unless block_given?
 
       @search_state.filters.map do |facet|
+        facet_field_presenter = helpers.facet_field_presenter(facet.config, {})
         facet.each_value do |val|
           next if val.blank?
 
           if val.is_a?(Array)
-            yield inclusive_facet_item_presenter(facet.config, val, facet.key) if val.any?(&:present?)
+            yield inclusive_facet_constraint_presenter(facet_field_presenter, facet.config, val, facet.key) if val.any?(&:present?)
           else
-            yield facet_item_presenter(facet.config, val)
+            yield facet_constraint_presenter(facet_field_presenter, facet.config, val)
           end
         end
       end
     end
 
+    # Yields clause presenters for search clauses
+    #
+    # @yield [Blacklight::ClausePresenter] clause presenter
+    # @return [Enumerator] if no block given
     def clause_presenters
       return to_enum(:clause_presenters) unless block_given?
 
@@ -100,14 +117,40 @@ module Blacklight
       end
     end
 
-    # @params [Blacklight::Configuration::FacetField] facet_config
-    # @params [String] facet_item the value of the facet item
-    def facet_item_presenter(facet_config, facet_item)
-      helpers.facet_field_presenter(facet_config, {}).item_presenter(facet_item)
+    # Creates a facet constraint presenter for a single facet item
+    #
+    # @param facet_field_presenter [Blacklight::FacetFieldPresenter] presenter for the facet field
+    # @param facet_config [Blacklight::Configuration::FacetField] configuration for the facet
+    # @param facet_item [String] the facet item
+    # @return [Blacklight::ConstraintPresenter] constraint presenter for the facet item
+    def facet_constraint_presenter(facet_field_presenter, facet_config, facet_item)
+      facet_config.constraint_presenter.new(facet_item_presenter: facet_field_presenter.item_presenter(facet_item), field_label: facet_field_presenter.label)
     end
 
-    def inclusive_facet_item_presenter(facet_config, facet_item, facet_field)
-      Blacklight::InclusiveFacetItemPresenter.new(facet_item, facet_config, helpers, facet_field)
+    # Creates a constraint presenter for an inclusive facet (multiple values)
+    #
+    # @param facet_field_presenter [Blacklight::FacetFieldPresenter] presenter for the facet field
+    # @param facet_config [Blacklight::Configuration::FacetField] configuration for the facet
+    # @param facet_item [Array] array of facet items
+    # @param facet_field [Symbol, String] the facet field name
+    # @return [Blacklight::ConstraintPresenter] constraint presenter for the inclusive facet
+    def inclusive_facet_constraint_presenter(facet_field_presenter, facet_config, facet_item, facet_field)
+      facet_config.constraint_presenter.new(
+        facet_item_presenter: Blacklight::InclusiveFacetItemPresenter.new(facet_item, facet_config, helpers, facet_field),
+        field_label: facet_field_presenter.label
+      )
+    end
+
+    # Returns a heading tag for the constraints section
+    #
+    # @return [ActiveSupport::SafeBuffer, nil] constraints heading html
+    def constraints_heading
+      return unless @render_headers
+
+      tag.h2(
+        t('blacklight.search.filters.title'),
+        class: @heading_classes
+      )
     end
   end
 end

data/app/components/blacklight/document/bookmark_component.rb

@@ -13,7 +13,7 @@ module Blacklight
         @checked = checked
         @bookmark_path = bookmark_path
         @action = action
-        super
+        super()
       end
 
       # Used by ActionsComponent

data/app/components/blacklight/document/page_header_component.rb

@@ -9,7 +9,7 @@ module Blacklight
       delegate :blacklight_config, to: :helpers
 
       def initialize(document:, search_context:, search_session:)
-        super
+        super()
         @search_context = search_context
         @search_session = search_session
         @document = document

data/app/components/blacklight/document_component.rb

@@ -33,40 +33,36 @@ module Blacklight
     renders_one :body
 
     # The document title with some reasonable default behavior
-    renders_one :title, (lambda do |*args, component: nil, **kwargs|
-      component ||= view_config.title_component || Blacklight::DocumentTitleComponent
+    renders_one :title, (lambda do |component: nil, **kwargs|
+      component ||= view_config.document_title_component
 
-      component.new(*args, 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, *args, component: nil, **kwargs|
+    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(*args, 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, *args, component: nil, fields: nil, **kwargs|
+    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(*args, fields: fields || @presenter&.field_presenters || [], **kwargs)
+      component ||= view_config.document_metadata_component
+      component&.new(fields: fields || @presenter&.field_presenters || [], **kwargs)
     end)
 
     # Additional metadata sections
     renders_many :metadata_sections
 
-    renders_one :thumbnail, (lambda do |image_options_or_static_content = {}, *args, component: nil, **kwargs|
+    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(*args, 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
@@ -90,18 +86,18 @@ module Blacklight
     def initialize(document: nil, partials: nil,
                    id: nil, classes: [], component: :article, title_component: nil,
                    counter: nil, document_counter: nil, counter_offset: 0,
-                   show: false, **args)
-      @presenter = document || args[self.class.collection_parameter]
+                   show: false)
+      @presenter = document
       @document = @presenter.document
       @view_partials = partials || []
 
       @component = component
       @title_component = title_component
-      @id = id || ('document' if show)
+      @id = id
       @classes = classes
 
       @counter = counter
-      @document_counter = document_counter || args.fetch(self.class.collection_counter_parameter, nil)
+      @document_counter = document_counter
       @counter ||= 1 + @document_counter + counter_offset if @document_counter.present?
 
       @show = show
@@ -119,10 +115,10 @@ module Blacklight
     end
 
     def before_render
-      set_slot(:title, nil) unless title
-      set_slot(:thumbnail, nil) unless thumbnail || show?
-      set_slot(:metadata, nil, fields: presenter.field_presenters, show: @show) unless metadata
-      set_slot(:embed, nil) unless embed
+      with_title unless title
+      with_thumbnail unless thumbnail
+      with_metadata(fields: presenter.field_presenters, show: @show) unless metadata
+      with_embed unless embed
 
       view_partials.each do |view_partial|
         with_partial(view_partial) do

data/app/components/blacklight/facet_item_pivot_component.rb

@@ -19,6 +19,10 @@ module Blacklight
 
     with_collection_parameter :facet_item
 
+    # @param [Blacklight::FacetItemPivotPresenter] facet_item
+    # @param [String] wrapping_element
+    # @param [Boolean] suppress_link
+    # @param [Boolean] collapsing
     def initialize(facet_item:, wrapping_element: 'li', suppress_link: false, collapsing: nil)
       @facet_item = facet_item
       @wrapping_element = wrapping_element

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

@@ -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/item_component.rb

@@ -7,6 +7,9 @@ module Blacklight
 
       with_collection_parameter :facet_item
 
+      # @param [Blacklight::FacetItemPresenter] facet_item
+      # @param [String] wrapping_element
+      # @param [Boolean] suppress_link
       def initialize(facet_item:, wrapping_element: 'li', suppress_link: false)
         @facet_item = facet_item
         @label = facet_item.label

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

@@ -7,7 +7,7 @@ module Blacklight
       def initialize(label:, href:)
         @label = label
         @href = href
-        super
+        super()
       end
 
       attr_reader :label, :href

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/header_component.rb

@@ -19,8 +19,8 @@ module Blacklight
     # Hack so that the default lambdas are triggered
     # so that we don't have to do c.with_top_bar() in the call.
     def before_render
-      set_slot(:top_bar, nil) unless top_bar
-      set_slot(:search_bar, nil) unless search_bar
+      with_top_bar unless top_bar
+      with_search_bar unless search_bar
     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

@@ -29,10 +29,7 @@ module Blacklight::Catalog
       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
+      format.json { @presenter = json_presenter(@response) }
       additional_response_formats(format)
       document_export_formats(format)
     end
@@ -143,7 +140,14 @@ module Blacklight::Catalog
 
   private
 
+  # @param [Blacklight::Solr::Response] repository_response
+  # @return [Blacklight::JsonPresenter]
+  def json_presenter(repository_response)
+    blacklight_config.index.json_presenter_class.new(repository_response, blacklight_config)
+  end
+
   # This method may be overridden to customize search behavior.
+  # @return [Blacklight::Solr::Response] the solr response object
   def retrieve_search_results
     search_service.search_results
   end

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

@@ -17,8 +17,9 @@ const FacetSuggest = async (e) => {
     // Drop facet.page so a filtered suggestion list will always start on page 1
     url.searchParams.delete('facet.page');
     const facetSearchParams = url.searchParams.toString();
+    const basePathComponent = url.pathname.split('/')[1];
 
-    const urlToFetch = `/catalog/facet_suggest/${facetField}/${queryFragment}?${facetSearchParams}`;
+    const urlToFetch = `/${basePathComponent}/facet_suggest/${facetField}/${queryFragment}?${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/constraint_presenter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class ConstraintPresenter
+    def initialize(facet_item_presenter:, field_label:)
+      @facet_item_presenter = facet_item_presenter
+      @field_label = field_label
+    end
+
+    attr_accessor :facet_item_presenter, :field_label
+
+    delegate :key, :remove_href, to: :facet_item_presenter
+
+    # Get the displayable version of the facet's value for use
+    # in e.g. the constraints widget
+    #
+    # @return [String]
+    def constraint_label
+      facet_item_presenter.label
+    end
+  end
+end

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/facet_item_pivot_presenter.rb

@@ -13,10 +13,6 @@ module Blacklight
       selected? || facet_item_presenters.any? { |x| x.try(:shown?) }
     end
 
-    def field_label
-      facet_field_presenter.label
-    end
-
     def facet_item_presenters
       return to_enum(:facet_item_presenters) unless block_given?
       return [] unless items
@@ -25,7 +21,7 @@ module Blacklight
     end
 
     def facet_item_presenter(facet_item)
-      facet_field_presenter.item_presenter(facet_item)
+      view_context.facet_field_presenter(facet_config, {}).item_presenter(facet_item)
     end
 
     ##

data/app/presenters/blacklight/facet_item_presenter.rb

@@ -38,10 +38,6 @@ module Blacklight
       search_state.filter(facet_config).include?(value)
     end
 
-    def field_label
-      facet_field_presenter.label
-    end
-
     ##
     # Get the displayable version of a facet's value
     #
@@ -67,14 +63,6 @@ module Blacklight
       end
     end
 
-    # Get the displayable version of the facet's value for use
-    # in e.g. the constraints widget
-    #
-    # @return [String]
-    def constraint_label
-      label
-    end
-
     def value
       if facet_item.respond_to? :value
         facet_item.value
@@ -104,11 +92,5 @@ module Blacklight
         view_context.search_action_path(search_state.add_facet_params_and_redirect(facet_config.key, facet_item).merge(path_options))
       end
     end
-
-    private
-
-    def facet_field_presenter
-      @facet_field_presenter ||= view_context.facet_field_presenter(facet_config, {})
-    end
   end
 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