blacklight 8.0.0.beta1 → 8.0.0

data/app/components/blacklight/document_component.rb

@@ -1,7 +1,30 @@
 # frozen_string_literal: true
 
+require 'view_component/version'
+
 module Blacklight
+  ##
+  # A component for rendering a single document
+  #
+  # @note when subclassing this component, if you override the initializer,
+  #    you must explicitly specify the counter variable `document_counter` even if you don't use it.
+  #    Otherwise view_component will not provide the count value when calling the component.
+  #
+  # @see https://viewcomponent.org/guide/collections.html#collection-counter
+  #
+  # @example
+  #  class MyDocumentComponent < Blacklight::DocumentComponent
+  #    def initialize(document_counter: nil, **kwargs)
+  #      super
+  #      ... custom code ...
+  #    end
+  #  end
   class DocumentComponent < Blacklight::Component
+    with_collection_parameter :document
+
+    # ViewComponent 3 changes iteration counters to begin at 0 rather than 1
+    COLLECTION_INDEX_OFFSET = ViewComponent::VERSION::MAJOR < 3 ? 0 : 1
+
     # Content appearing before the document
     renders_one :header
 
@@ -14,7 +37,7 @@ module Blacklight
 
     # The document title with some reasonable default behavior
     renders_one :title, (lambda do |*args, component: nil, **kwargs|
-      component ||= Blacklight::DocumentTitleComponent
+      component ||= @presenter&.view_config&.title_component || Blacklight::DocumentTitleComponent
 
       component.new(*args, counter: @counter, document: @document, presenter: @presenter, as: @title_component, actions: !@show, link_to_document: !@show, document_component: self, **kwargs)
     end)
@@ -33,7 +56,7 @@ module Blacklight
     renders_one :metadata, (lambda do |static_content = nil, *args, component: nil, fields: nil, **kwargs|
       next static_content if static_content.present?
 
-      component ||= Blacklight::DocumentMetadataComponent
+      component ||= @presenter&.view_config&.metadata_component || Blacklight::DocumentMetadataComponent
 
       component.new(*args, fields: fields || @presenter&.field_presenters || [], **kwargs)
     end)
@@ -56,38 +79,36 @@ module Blacklight
     # Backwards compatibility
     renders_one :actions
 
-    with_collection_parameter :document
-
     # rubocop:disable Metrics/ParameterLists
-    # @param document [Blacklight::Document]
-    # @param presenter [Blacklight::DocumentPresenter]
+    # @param document [Blacklight::DocumentPresenter]
+    # @param presenter [Blacklight::DocumentPresenter] alias for document
+    # @param partials [Array, nil] view partial names that should be used to provide content for the `partials` slot
     # @param id [String] HTML id for the root element
     # @param classes [Array, String] additional HTML classes for the root element
     # @param component [Symbol, String] HTML tag type to use for the root element
     # @param title_component [Symbol, String] HTML tag type to use for the title element
     # @param counter [Number, nil] a pre-computed counter for the position of this document in a search result set
-    # @param document_counter [Number, nil] alternatively, the document's position in a collection and,
-    # @param counter_offset [Number] with `document_counter`, the offset of the start of that collection counter to the overall result set
+    # @param document_counter [Number, nil] provided by ViewComponent collection iteration
+    # @param counter_offset [Number] the offset of the start of the collection counter parameter for the component to the overall result set
     # @param show [Boolean] are we showing only a single document (vs a list of search results); used for backwards-compatibility
-    def initialize(document: nil, presenter: nil,
+    def initialize(document: nil, presenter: nil, partials: nil,
                    id: nil, classes: [], component: :article, title_component: nil,
                    counter: nil, document_counter: nil, counter_offset: 0,
-                   show: false)
-      if presenter.nil? && document.nil?
-        raise ArgumentError, 'missing keyword: :document or :presenter'
-      end
+                   show: false, **args)
+      Blacklight.deprecation.warn('the `presenter` argument to DocumentComponent#initialize is deprecated; pass the `presenter` in as document instead') if presenter
 
-      @document = document || presenter&.document
-      @presenter = presenter
+      @presenter = presenter || document || args[self.class.collection_parameter]
+      @document = @presenter.document
+      @view_partials = partials || []
 
       @component = component
       @title_component = title_component
       @id = id || ('document' if show)
       @classes = classes
 
-      @document_counter = document_counter
       @counter = counter
-      @counter ||= document_counter + 1 + counter_offset if document_counter.present?
+      @document_counter = document_counter || args.fetch(self.class.collection_counter_parameter, nil)
+      @counter ||= @document_counter + COLLECTION_INDEX_OFFSET + counter_offset if @document_counter.present?
 
       @show = show
     end
@@ -108,13 +129,20 @@ module Blacklight
       set_slot(:thumbnail, nil) unless thumbnail || show?
       set_slot(:metadata, nil, fields: presenter.field_presenters) unless metadata
       set_slot(:embed, nil) unless embed
+      if view_partials.present?
+        view_partials.each do |view_partial|
+          with_partial(view_partial) do
+            helpers.render_document_partial @document, view_partial, component: self, document_counter: @counter
+          end
+        end
+      else
+        set_slot(:partials, nil)
+      end
     end
 
     private
 
-    def presenter
-      @presenter ||= helpers.document_presenter(@document)
-    end
+    attr_reader :document_counter, :presenter, :view_partials
 
     def show?
       @show

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

@@ -1,5 +1,7 @@
-<dl class="document-metadata dl-invert row">
+<% content = capture do %>
   <% fields.each do |field| -%>
     <%= field %>
   <% end -%>
-</dl>
+<% end %>
+
+<%= @tag.nil? ? content : tag.public_send(@tag, content, class: @classes, **@component_args) %>

data/app/components/blacklight/document_metadata_component.rb

@@ -8,17 +8,23 @@ module Blacklight
     with_collection_parameter :fields
 
     # @param fields [Enumerable<Blacklight::FieldPresenter>] Document field presenters
-    def initialize(fields: [], show: false, view_type: nil)
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(fields: [], tag: 'dl', classes: %w[document-metadata dl-invert row], show: false, view_type: nil, field_layout: nil, **component_args)
       @fields = fields
+      @tag = tag
+      @classes = classes
       @show = show
       @view_type = view_type
+      @field_layout = field_layout
+      @component_args = component_args
     end
+    # rubocop:enable Metrics/ParameterLists
 
     def before_render
       return unless fields
 
       @fields.each do |field|
-        field(component: field.component, field: field, show: @show, view_type: @view_type)
+        with_field(component: field.component, field: field, show: @show, view_type: @view_type, layout: @field_layout)
       end
     end
 

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

@@ -1,9 +1,9 @@
 <%= render(@layout.new(facet_field: @facet_field)) do |component| %>
-  <% component.label do %>
+  <% component.with_label do %>
     <%= @facet_field.label %>
   <% end %>
 
-  <% component.body do %>
+  <% component.with_body do %>
     <ul class="facet-values list-unstyled blacklight-facet-checkboxes">
       <% presenters.each_with_index do |presenter, idx| -%>
         <li>

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

@@ -1,8 +1,8 @@
 <%= render(@layout.new(facet_field: @facet_field)) do |component| %>
-  <% component.label do %>
+  <% component.with_label do %>
     <%= @facet_field.label %>
   <% end %>
-  <% component.body do %>
+  <% component.with_body do %>
     <%= helpers.render(Blacklight::FacetFieldInclusiveConstraintComponent.new(facet_field: @facet_field)) %>
     <ul class="facet-values list-unstyled">
       <%= render facet_items %>

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

@@ -1,8 +1,8 @@
 <%= render(@layout.new(field: @field)) do |component| %>
-  <% component.label do %>
+  <% component.with_label do %>
     <%= label %>
   <% end %>
-  <% component.value do %>
+  <% component.with_value do %>
     <%= @field.render %>
   <% end %>
 <% end %>

data/app/components/blacklight/metadata_field_layout_component.rb

@@ -5,18 +5,21 @@ module Blacklight
     with_collection_parameter :field
     renders_one :label
     renders_many :values, (lambda do |value: nil, &block|
-      if block
-        content_tag :dd, class: "#{@value_class} blacklight-#{@key}", &block
+      if @value_tag.nil?
+        block&.call || value
+      elsif block
+        content_tag @value_tag, class: "#{@value_class} blacklight-#{@key}", &block
       else
-        content_tag :dd, value, class: "#{@value_class} blacklight-#{@key}"
+        content_tag @value_tag, value, class: "#{@value_class} blacklight-#{@key}"
       end
     end)
 
     # @param field [Blacklight::FieldPresenter]
-    def initialize(field:, 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')
       @field = field
       @key = @field.key.parameterize
       @label_class = label_class
+      @value_tag = value_tag
       @value_class = value_class
     end
   end

data/app/components/blacklight/metadata_field_plain_text_layout_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class MetadataFieldPlainTextLayoutComponent < Blacklight::MetadataFieldLayoutComponent
+    with_collection_parameter :field
+
+    def initialize(field:, **kwargs)
+      super(field: field, **kwargs, value_tag: nil)
+    end
+
+    # rubocop:disable Rails/OutputSafety
+    def call
+      [label.to_s.strip, helpers.strip_tags(CGI.unescape_html(safe_join(values, "\n")).strip)].compact.join(' ').html_safe
+    end
+    # rubocop:enable Rails/OutputSafety
+  end
+end

data/app/components/blacklight/response/facet_group_component.html.erb

@@ -17,7 +17,8 @@
         expanded: 'false',
         label: t('blacklight.search.facets.group.toggle'),
       } do %>
-      <span class="navbar-toggler-icon"></span>
+      <span data-show-label><%= t('blacklight.search.facets.group.open') %></span>
+      <span data-hide-label><%= t('blacklight.search.facets.group.close') %></span>
     <% end %>
   </div>
 

data/app/components/blacklight/response/facet_group_component.rb

@@ -23,7 +23,7 @@ module Blacklight
 
       # Provide fallback behavior for rendering this object without a body slot
       def before_render
-        set_slot(:body, nil) { default_body } unless body
+        set_slot(:body, nil) { default_body } unless body?
       end
 
       def render?

data/app/components/blacklight/response/sort_component.rb

@@ -2,7 +2,7 @@
 
 module Blacklight
   module Response
-    class SortComponent < ViewComponent::Base
+    class SortComponent < Blacklight::Component
       def initialize(search_state:, param: 'sort', choices: {}, id: 'sort-dropdown', classes: [], selected: nil)
         @param = param
         @choices = choices

data/app/components/blacklight/response/spellcheck_component.rb

@@ -3,7 +3,7 @@
 module Blacklight
   module Response
     # Render spellcheck results for a search query
-    class SpellcheckComponent < ViewComponent::Base
+    class SpellcheckComponent < Blacklight::Component
       # @param [Blacklight::Response] response
       # @param [Array<String>] options explicit spellcheck options to render
       def initialize(response:, options: nil)

data/app/components/blacklight/response/view_type_button_component.rb

@@ -3,7 +3,7 @@
 module Blacklight
   module Response
     # Render spellcheck results for a search query
-    class ViewTypeButtonComponent < ViewComponent::Base
+    class ViewTypeButtonComponent < Blacklight::Component
       with_collection_parameter :view
       # @param [Blacklight::Configuration::View] view
       def initialize(view:, key: nil, selected: false, search_state: nil, classes: 'btn btn-outline-secondary btn-icon')

data/app/components/blacklight/response/view_type_component.rb

@@ -3,7 +3,7 @@
 module Blacklight
   module Response
     # Render spellcheck results for a search query
-    class ViewTypeComponent < ViewComponent::Base
+    class ViewTypeComponent < Blacklight::Component
       renders_many :views, 'Blacklight::Response::ViewTypeButtonComponent'
 
       # @param [Blacklight::Response] response
@@ -18,7 +18,7 @@ module Blacklight
         return if views.any?
 
         @views.each do |key, config|
-          view(key: key, view: config, selected: @selected == key, search_state: @search_state)
+          with_view(key: key, view: config, selected: @selected == key, search_state: @search_state)
         end
       end
 

data/app/components/blacklight/search/sidebar_component.html.erb

@@ -1,7 +1,7 @@
 <% facet_group_names.each do |groupname| %>
   <% fields = facet_fields_in_group(groupname) %>
   <%= render group_component_class.new(id: groupname, fields: fields, response: response) do |component| %>
-    <% component.body do %>
+    <% component.with_body do %>
       <%= render Blacklight::FacetComponent.with_collection(fields, response: response) %>
     <% end %>
   <% end %>

data/app/components/blacklight/search_context/server_applied_params_component.html.erb

@@ -0,0 +1,4 @@
+<div id="appliedParams" class="clearfix constraints-container">
+  <%= render 'start_over' %>
+  <%= link_back_to_catalog class: 'btn btn-outline-secondary' %>
+</div>

data/app/components/blacklight/search_context/server_applied_params_component.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module SearchContext
+    class ServerAppliedParamsComponent < Blacklight::Component
+      delegate :current_search_session, :link_back_to_catalog, to: :helpers
+
+      def render?
+        current_search_session
+      end
+    end
+  end
+end

data/app/components/blacklight/search_context/server_item_pagination_component.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module SearchContext
+    class ServerItemPaginationComponent < Blacklight::Component
+      with_collection_parameter :search_context
+
+      def initialize(search_context:, search_session:, current_document:)
+        @search_context = search_context
+        @search_session = search_session
+        @current_document_id = current_document.id
+      end
+
+      def render?
+        @search_context.present? && (@search_context[:prev] || @search_context[:next]) && (@search_session['document_id'] == @current_document_id)
+      end
+
+      ##
+      # Displays "showing X of Y items" message.
+      #
+      # @return [String]
+      def item_page_entry_info
+        t('blacklight.search.entry_pagination_info.other', current: number_with_delimiter(count),
+                                                           total: number_with_delimiter(total),
+                                                           count: total).html_safe
+      end
+
+      def link_to_previous_document(previous_document = nil, classes: 'previous', **link_opts)
+        previous_document ||= @search_context[:prev]
+        link_opts = session_tracking_params(previous_document, count - 1, per_page: per_page, search_id: search_id).merge(class: classes, rel: 'prev').merge(link_opts)
+        link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), url_for_document(previous_document), link_opts do
+          tag.span raw(t('views.pagination.previous')), class: 'previous'
+        end
+      end
+
+      def link_to_next_document(next_document = nil, classes: 'next', **link_opts)
+        next_document ||= @search_context[:next]
+        link_opts = session_tracking_params(next_document, count + 1, per_page: per_page, search_id: search_id).merge(class: classes, rel: 'next').merge(link_opts)
+        link_to_unless next_document.nil?, raw(t('views.pagination.next')), url_for_document(next_document), link_opts do
+          tag.span raw(t('views.pagination.next')), class: 'next'
+        end
+      end
+
+      private
+
+      def count
+        @search_session['counter'].to_i
+      end
+
+      def per_page
+        @search_session['per_page']
+      end
+
+      def total
+        @search_session['total'].to_i
+      end
+
+      def search_id
+        @search_session['id'] || helpers.current_search_session&.id
+      end
+
+      def session_tracking_params(...)
+        helpers.session_tracking_params(...)
+      end
+
+      def url_for_document(...)
+        helpers.search_state.url_for_document(...)
+      end
+    end
+  end
+end

data/app/components/blacklight/system/dropdown_component.rb

@@ -2,7 +2,7 @@
 
 module Blacklight
   module System
-    class DropdownComponent < ViewComponent::Base
+    class DropdownComponent < Blacklight::Component
       renders_one :button, (lambda do |classes:, label:|
         button_tag class: classes, aria: { expanded: false }, data: { toggle: 'dropdown', 'bs-toggle': 'dropdown' } do
           safe_join([label, content_tag(:span, '', class: 'caret')])
@@ -29,11 +29,11 @@ module Blacklight
       end
 
       def before_render
-        button(classes: 'btn btn-outline-secondary dropdown-toggle', label: button_label) unless button
+        with_button(classes: 'btn btn-outline-secondary dropdown-toggle', label: button_label) unless button
 
         return if options.any?
 
-        options(@choices.map do |option|
+        with_options(@choices.map do |option|
           text, value = option_text_and_value(option)
           { text: text, url: helpers.url_for(@search_state.params_for_search(@param => value)), selected: @selected == value }
         end)

data/app/components/blacklight/system/flash_message_component.rb

@@ -2,7 +2,7 @@
 
 module Blacklight
   module System
-    class FlashMessageComponent < ViewComponent::Base
+    class FlashMessageComponent < Blacklight::Component
       renders_one :message
 
       with_collection_parameter :message
@@ -13,7 +13,7 @@ module Blacklight
       end
 
       def before_render
-        message { @message } if @message
+        with_message { @message } if @message
       end
 
       # Bootstrap 4 requires the span, but Bootstrap 5 should not have it.

data/app/components/blacklight/system/modal_component.rb

@@ -2,7 +2,7 @@
 
 module Blacklight
   module System
-    class ModalComponent < ViewComponent::Base
+    class ModalComponent < Blacklight::Component
       renders_one :prefix
       renders_one :header
       renders_one :title

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

@@ -1,6 +1,6 @@
 <nav class="navbar navbar-expand-md navbar-dark bg-dark topbar" role="navigation">
   <div class="<%= container_classes %>">
-    <%= link_to application_name, blacklight_config.logo_link, class: 'mb-0 navbar-brand navbar-logo' %>
+    <%= logo_link %>
     <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-bs-toggle="collapse" data-target="#user-util-collapse" data-bs-target="#user-util-collapse" aria-controls="user-util-collapse" aria-expanded="false" aria-label="Toggle navigation">
       <span class="navbar-toggler-icon"></span>
     </button>

data/app/components/blacklight/top_navbar_component.rb

@@ -9,5 +9,9 @@ module Blacklight
     attr_reader :blacklight_config
 
     delegate :application_name, :container_classes, to: :helpers
+
+    def logo_link(title: application_name)
+      link_to title, blacklight_config.logo_link, class: 'mb-0 navbar-brand navbar-logo'
+    end
   end
 end

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

@@ -15,7 +15,7 @@ module Blacklight::Bookmarks
 
     before_action :verify_user
 
-    blacklight_config.track_search_session = false
+    blacklight_config.track_search_session.storage = false
     blacklight_config.http_method = Blacklight::Engine.config.blacklight.bookmarks_http_method
     blacklight_config.add_results_collection_tool(:clear_bookmarks_widget)
 

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

@@ -28,6 +28,28 @@ module Blacklight::SearchContext
     session[:history].blank? ? ::Search.none : ::Search.where(id: session[:history]).order("updated_at desc")
   end
 
+  # GET previous and next document json for the document specified by
+  # the counter param in current search
+  def page_links
+    counter_param = params.delete(:counter)
+    @page_link_data = {}
+    if counter_param
+      index = counter_param.to_i - 1
+      response, documents = search_service.previous_and_next_documents_for_search index, search_state.reset_search
+      if documents.detect(&:present?)
+        @page_link_data[:prev] = page_links_document_path(documents.first, index)
+        @page_link_data[:next] = page_links_document_path(documents.last, index + 2)
+      end
+      if response&.total && response.total.positive?
+        @page_link_data[:counterRaw] = counter_param
+        @page_link_data[:counterDelimited] = helpers.number_with_delimiter(counter_param.to_i)
+        @page_link_data[:totalRaw] = response.total
+        @page_link_data[:totalDelimited] = helpers.number_with_delimiter(response.total)
+      end
+    end
+    render json: @page_link_data
+  end
+
   private
 
   # sets up the session[:search] hash if it doesn't already exist
@@ -85,6 +107,8 @@ module Blacklight::SearchContext
   end
 
   def find_or_initialize_search_session_from_params params
+    return unless blacklight_config.track_search_session.storage == 'server'
+
     params_copy = params.reject { |k, v| nonpersisted_search_session_params.include?(k.to_sym) || v.blank? }
 
     return if params_copy.reject { |k, _v| [:action, :controller].include? k.to_sym }.blank?
@@ -127,15 +151,31 @@ module Blacklight::SearchContext
   # calls setup_previous_document then setup_next_document.
   # used in the show action for single view pagination.
   def setup_next_and_previous_documents
-    if search_session['counter'] && current_search_session
-      index = search_session['counter'].to_i - 1
-      response, documents = search_service.previous_and_next_documents_for_search index, search_state.reset(current_search_session.query_params)
+    return { counter: params[:counter] } if setup_next_and_previous_on_client?
+    return nil unless setup_next_and_previous_on_server?
 
-      search_session['total'] = response.total
-      { prev: documents.first, next: documents.last }
-    end
+    index = search_session['counter'].to_i - 1
+    response, documents = search_service.previous_and_next_documents_for_search index, search_state.reset(current_search_session.query_params)
+
+    search_session['total'] = response.total
+    { prev: documents.first, next: documents.last }
   rescue Blacklight::Exceptions::InvalidRequest => e
     logger&.warn "Unable to setup next and previous documents: #{e}"
     nil
   end
+
+  def setup_next_and_previous_on_server?
+    search_session['counter'] && current_search_session && blacklight_config.track_search_session.storage == 'server'
+  end
+
+  def setup_next_and_previous_on_client?
+    params[:counter] && blacklight_config.track_search_session.storage == 'client'
+  end
+
+  def page_links_document_path(document, counter)
+    return nil unless document
+    return search_state.url_for_document(document, counter: counter) if blacklight_config.view_config(:show).route
+
+    solr_document_path(document, counter: counter)
+  end
 end