blacklight 8.0.0.beta4 → 8.0.0.beta5

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')])

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

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

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -6,8 +6,6 @@ module Blacklight::BlacklightHelperBehavior
   include Blacklight::LayoutHelperBehavior
   include Blacklight::IconHelperBehavior
 
-  # @!group Layout helpers
-
   ##
   # Get the name of this application from an i18n string
   # key: blacklight.application_name
@@ -23,63 +21,6 @@ module Blacklight::BlacklightHelperBehavior
     end
   end
 
-  ##
-  # Get the page's HTML title
-  #
-  # @return [String]
-  def render_page_title
-    (content_for(:page_title) if content_for?(:page_title)) || @page_title || application_name
-  end
-
-  ##
-  # Create <link rel="alternate"> links from a documents dynamically
-  # provided export formats.
-  #
-  # Returns empty string if no links available.
-  #
-  # @param [SolrDocument] document
-  # @param [Hash] options
-  # @option options [Boolean] :unique ensures only one link is output for every
-  #     content type, e.g. as required by atom
-  # @option options [Array<String>] :exclude array of format shortnames to not include in the output
-  # @return [String]
-  def render_link_rel_alternates(document = @document, options = {})
-    return if document.nil?
-
-    document_presenter(document).link_rel_alternates(options)
-  end
-
-  ##
-  # Render classes for the <body> element
-  # @return [String]
-  def render_body_class
-    extra_body_classes.join " "
-  end
-
-  ##
-  # List of classes to be applied to the <body> element
-  # @see render_body_class
-  # @return [Array<String>]
-  def extra_body_classes
-    @extra_body_classes ||= ["blacklight-#{controller.controller_name}", "blacklight-#{[controller.controller_name, controller.action_name].join('-')}"]
-  end
-
-  ##
-  # Get the current "view type" (and ensure it is a valid type)
-  #
-  # @param [Hash] query_params the query parameters to check
-  # @return [Symbol]
-  def document_index_view_type query_params = params
-    view_param = query_params[:view]
-    view_param ||= session[:preferred_view]
-    if view_param && document_index_views.key?(view_param.to_sym)
-      view_param.to_sym
-    else
-      default_document_index_view_type
-    end
-  end
-
-  # @!group Search result helpers
   ##
   # Render a partial of an arbitrary format inside a
   # template of a different format. (e.g. render an HTML
@@ -97,45 +38,8 @@ module Blacklight::BlacklightHelperBehavior
     nil
   end
 
-  ##
-  # Should we render a grouped response (because the response
-  # contains a grouped response instead of the normal response)
-  #
-  # Default to false if there's no response object available (sometimes the case
-  #   for tests, but might happen in other circumstances too..)
-  # @return [Boolean]
-  def render_grouped_response? response = @response
-    response&.grouped?
-  end
-
-  ##
-  # Returns a document presenter for the given document
-  def document_presenter(document)
-    document_presenter_class(document).new(document, self)
-  end
-
-  ##
-  # Override this method if you want to use a differnet presenter for your documents
-  # @param [Blacklight::Document] _document optional, here for extension + backwards compatibility only
-  def document_presenter_class(_document = nil)
-    case action_name
-    when 'show', 'citation'
-      blacklight_config.view_config(:show, action_name: action_name).document_presenter_class
-    else
-      blacklight_config.view_config(document_index_view_type, action_name: action_name).document_presenter_class
-    end
-  end
-
   # @return [Class]
   def search_bar_presenter_class
     blacklight_config.view_config(action_name: :index).search_bar_presenter_class
   end
-
-  # @!group Layout helpers
-  ##
-  # Open Search discovery tag for HTML <head> links
-  # @return [String]
-  def opensearch_description_tag title, href
-    tag :link, href: href, title: title, type: "application/opensearchdescription+xml", rel: "search"
-  end
 end

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -4,6 +4,7 @@
 module Blacklight::CatalogHelperBehavior
   include Blacklight::ConfigurationHelperBehavior
   include Blacklight::ComponentHelperBehavior
+  include Blacklight::DocumentHelperBehavior
   include Blacklight::FacetsHelperBehavior
   include Blacklight::RenderPartialsHelperBehavior
 
@@ -113,40 +114,6 @@ module Blacklight::CatalogHelperBehavior
     (@response.rows if @response && @response.rows > 0) || params.fetch(:per_page, blacklight_config.default_per_page).to_i
   end
 
-  ##
-  # Get the classes to add to a document's div
-  #
-  # @param [Blacklight::Document] document
-  # @return [String]
-  def render_document_class(document = @document)
-    types = document_presenter(document).display_type
-    return if types.blank?
-
-    Array(types).compact.map do |t|
-      "#{document_class_prefix}#{t.try(:parameterize) || t}"
-    end.join(' ')
-  end
-
-  ##
-  # Return a prefix for the document classes infered from the document
-  # @see #render_document_class
-  # @return [String]
-  def document_class_prefix
-    'blacklight-'
-  end
-
-  ##
-  # Render the sidebar partial for a document
-  # This is used as an integration point by downstream apps to add to the
-  # default sidebar.
-  # See: https://github.com/geoblacklight/geoblacklight/blob/7d3c31c7af3362879b97e2c1351a2496c728c59c/app/helpers/blacklight_helper.rb#L7
-  #
-  # @param [SolrDocument] document
-  # @return [String]
-  def render_document_sidebar_partial(document)
-    render 'show_sidebar', document: document
-  end
-
   ##
   # Should we display the sort and per page widget?
   #
@@ -167,26 +134,6 @@ module Blacklight::CatalogHelperBehavior
     response.limit_value > 0
   end
 
-  ##
-  # return the Bookmarks on a set of documents (all bookmarks on the page)
-  # @private
-  # @return [Enumerable<Bookmark>]
-  def current_bookmarks
-    @current_bookmarks ||= begin
-      documents = @document.presence || @response.documents
-      current_or_guest_user.bookmarks_for_documents(Array(documents)).to_a
-    end
-  end
-  private :current_bookmarks
-
-  ##
-  # Check if the document is in the user's bookmarks
-  # @param [Blacklight::Document] document
-  # @return [Boolean]
-  def bookmarked? document
-    current_bookmarks.any? { |x| x.document_id == document.id && x.document_type == document.class }
-  end
-
   # Render an html <title> appropriate string for a selected facet field and values
   #
   # @see #render_search_to_page_title
@@ -233,6 +180,32 @@ module Blacklight::CatalogHelperBehavior
     constraints.join(' / ')
   end
 
+  ##
+  # Should we render a grouped response (because the response
+  # contains a grouped response instead of the normal response)
+  #
+  # Default to false if there's no response object available (sometimes the case
+  #   for tests, but might happen in other circumstances too..)
+  # @return [Boolean]
+  def render_grouped_response? response = @response
+    response&.grouped?
+  end
+
+  ##
+  # Get the current "view type" (and ensure it is a valid type)
+  #
+  # @param [Hash] query_params the query parameters to check
+  # @return [Symbol]
+  def document_index_view_type query_params = params || {}
+    view_param = query_params[:view]
+    view_param ||= session[:preferred_view] if respond_to?(:session)
+    if view_param && document_index_views.key?(view_param.to_sym)
+      view_param.to_sym
+    else
+      default_document_index_view_type
+    end
+  end
+
   private
 
   # @param [String] format

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -2,17 +2,6 @@
 
 module Blacklight
   module ComponentHelperBehavior
-    ##
-    # Render "document actions" area for navigation header
-    # (normally renders "Saved Searches", "History", "Bookmarks")
-    # These things are added by add_nav_action
-    #
-    # @param [Hash] options
-    # @return [String]
-    def render_nav_actions(options = {}, &block)
-      render_filtered_partials(blacklight_config.navbar.partials, options, &block)
-    end
-
     ##
     # Render "document actions" area for search results view
     # (normally renders next to title in the list view)

data/app/helpers/blacklight/document_helper_behavior.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# Helper methods for catalog-like controllers that work with documents
+module Blacklight::DocumentHelperBehavior
+  ##
+  # Get the classes to add to a document's div
+  #
+  # @param [Blacklight::Document] document
+  # @return [String]
+  def render_document_class(document = @document)
+    types = document_presenter(document).display_type
+    return if types.blank?
+
+    Array(types).compact.map do |t|
+      "#{document_class_prefix}#{t.try(:parameterize) || t}"
+    end.join(' ')
+  end
+
+  ##
+  # Return a prefix for the document classes infered from the document
+  # @see #render_document_class
+  # @return [String]
+  def document_class_prefix
+    'blacklight-'
+  end
+
+  ##
+  # Render the sidebar partial for a document
+  # This is used as an integration point by downstream apps to add to the
+  # default sidebar.
+  # See: https://github.com/geoblacklight/geoblacklight/blob/7d3c31c7af3362879b97e2c1351a2496c728c59c/app/helpers/blacklight_helper.rb#L7
+  #
+  # @param [SolrDocument] document
+  # @return [String]
+  def render_document_sidebar_partial(document)
+    render 'show_sidebar', document: document
+  end
+
+  ##
+  # return the Bookmarks on a set of documents (all bookmarks on the page)
+  # @private
+  # @return [Enumerable<Bookmark>]
+  def current_bookmarks
+    @current_bookmarks ||= begin
+      documents = @document.presence || @response.documents
+      current_or_guest_user.bookmarks_for_documents(Array(documents)).to_a
+    end
+  end
+  private :current_bookmarks
+
+  ##
+  # Check if the document is in the user's bookmarks
+  # @param [Blacklight::Document] document
+  # @return [Boolean]
+  def bookmarked? document
+    current_bookmarks.any? { |x| x.document_id == document.id && x.document_type == document.class }
+  end
+
+  ##
+  # Returns a document presenter for the given document
+  def document_presenter(document)
+    document_presenter_class(document).new(document, self)
+  end
+
+  ##
+  # Override this method if you want to use a differnet presenter for your documents
+  # @param [Blacklight::Document] _document optional, here for extension + backwards compatibility only
+  def document_presenter_class(_document = nil)
+    case action_name
+    when 'show', 'citation'
+      blacklight_config.view_config(:show, action_name: action_name).document_presenter_class
+    else
+      blacklight_config.view_config(document_index_view_type, action_name: action_name).document_presenter_class
+    end
+  end
+end

data/app/helpers/blacklight/layout_helper_behavior.rb

@@ -47,5 +47,64 @@ module Blacklight
     def container_classes
       'container'
     end
+
+    ##
+    # Render "document actions" area for navigation header
+    # (normally renders "Saved Searches", "History", "Bookmarks")
+    # These things are added by add_nav_action
+    #
+    # @param [Hash] options
+    # @return [String]
+    def render_nav_actions(options = {}, &block)
+      render_filtered_partials(blacklight_config.navbar.partials, options, &block)
+    end
+
+    ##
+    # Open Search discovery tag for HTML <head> links
+    # @return [String]
+    def opensearch_description_tag title, href
+      tag :link, href: href, title: title, type: "application/opensearchdescription+xml", rel: "search"
+    end
+
+    ##
+    # Get the page's HTML title
+    #
+    # @return [String]
+    def render_page_title
+      (content_for(:page_title) if content_for?(:page_title)) || @page_title || application_name
+    end
+
+    ##
+    # Create <link rel="alternate"> links from a documents dynamically
+    # provided export formats.
+    #
+    # Returns empty string if no links available.
+    #
+    # @param [SolrDocument] document
+    # @param [Hash] options
+    # @option options [Boolean] :unique ensures only one link is output for every
+    #     content type, e.g. as required by atom
+    # @option options [Array<String>] :exclude array of format shortnames to not include in the output
+    # @return [String]
+    def render_link_rel_alternates(document = @document, options = {})
+      return if document.nil?
+
+      document_presenter(document).link_rel_alternates(options)
+    end
+
+    ##
+    # Render classes for the <body> element
+    # @return [String]
+    def render_body_class
+      extra_body_classes.join " "
+    end
+
+    ##
+    # List of classes to be applied to the <body> element
+    # @see render_body_class
+    # @return [Array<String>]
+    def extra_body_classes
+      @extra_body_classes ||= ["blacklight-#{controller.controller_name}", "blacklight-#{[controller.controller_name, controller.action_name].join('-')}"]
+    end
   end
 end

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -43,16 +43,22 @@ module Blacklight::UrlHelperBehavior
   #   session_tracking_params(SolrDocument.new(id: 123), 7)
   #   => { data: { context_href: '/catalog/123/track?counter=7&search_id=999' } }
   def session_tracking_params document, counter, per_page: search_session['per_page'], search_id: current_search_session&.id
-    path = session_tracking_path(document, per_page: params.fetch(:per_page, per_page), counter: counter, search_id: search_id, document_id: document&.id)
+    path_params = { per_page: params.fetch(:per_page, per_page), counter: counter, search_id: search_id }
+    if blacklight_config.track_search_session.storage == 'server'
+      path_params[:document_id] = document&.id
+      path_params[:search_id] = search_id
+    end
+    path = session_tracking_path(document, path_params)
     return {} if path.nil?
 
-    { data: { context_href: path } }
+    context_method = blacklight_config.track_search_session.storage == 'client' ? 'get' : 'post'
+    { data: { context_href: path, context_method: context_method } }
   end
 
   ##
   # Get the URL for tracking search sessions across pages using polymorphic routing
   def session_tracking_path document, params = {}
-    return if document.nil? || !blacklight_config&.track_search_session
+    return if document.nil? || !blacklight_config.track_search_session.storage
 
     if main_app.respond_to?(controller_tracking_method)
       return main_app.public_send(controller_tracking_method, params.merge(id: document))
@@ -63,6 +69,8 @@ module Blacklight::UrlHelperBehavior
   end
 
   def controller_tracking_method
+    return blacklight_config.track_search_session.url_helper if blacklight_config.track_search_session.url_helper
+
     "track_#{controller_name}_path"
   end
 

data/app/javascript/blacklight/modal.js

@@ -32,7 +32,7 @@
 
     <div data-blacklight-modal="container">
       <div class="modal-header">
-        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
+        <button type="button" class="close" data-bl-dismiss="modal" aria-hidden="true">×</button>
         <h3 class="modal-title">Request Placed</h3>
       </div>
 
@@ -43,7 +43,7 @@
 
 
       <div class="modal-footer">
-        <button type="button" class="btn btn-secondary" data-dismiss="modal">Close</button>
+        <button type="button" class="btn btn-secondary" data-bl-dismiss="modal">Close</button>
       </div>
     </div>
 
@@ -89,7 +89,7 @@ const Modal = (() => {
 
       const contents = `<div class="modal-header">
         <div class="modal-title">There was a problem with your request.</div>
-        <button type="button" class="blacklight-modal-close btn-close close" data-dismiss="modal" data-bs-dismiss="modal" aria-label="Close">
+        <button type="button" class="blacklight-modal-close btn-close close" data-bl-dismiss="modal" aria-label="Close">
           <span aria-hidden="true" class="visually-hidden">&times;</span>
         </button>
         </div>
@@ -139,9 +139,9 @@ const Modal = (() => {
     // into one selector with a comma, so if something matches BOTH selectors, it
     // still only gets the event handler called once.
     document.addEventListener('click', (e) => {
-      if (e.target.matches(`${modal.triggerLinkSelector}, ${modal.preserveLinkSelector}`))
+      if (e.target.closest(`${modal.triggerLinkSelector}, ${modal.preserveLinkSelector}`))
         modal.modalAjaxLinkClick(e)
-      else if (e.target.matches('[data-bl-dismiss="modal"]'))
+      else if (e.target.closest('[data-bl-dismiss="modal"]'))
         modal.hide()
     })
   };