blacklight 8.0.0.beta1 → 8.0.0

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
@@ -96,46 +37,4 @@ module Blacklight::BlacklightHelperBehavior
     self.formats = old_formats
     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/render_partials_helper_behavior.rb

@@ -59,6 +59,7 @@ render document_component.new(presenter: document_presenter(document), component
     if template
       template.render(self, locals.merge(document: doc))
     else
+      logger.warn("No template was found for base_name: '#{base_name}', view_type: '#{view_type}' in render_document_partial")
       ''
     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/bookmark_toggle.js

@@ -1,19 +1,12 @@
-import Blacklight from './core'
-import CheckboxSubmit from './checkbox_submit'
+import CheckboxSubmit from 'blacklight/checkbox_submit'
 
-const BookmarkToggle = (() => {
-    // change form submit toggle to checkbox
-    Blacklight.doBookmarkToggleBehavior = function() {
-      document.addEventListener('click', (e) => {
-        if (e.target.matches('[data-checkboxsubmit-target="checkbox"]')) {
-          const form = e.target.closest('form')
-          if (form) new CheckboxSubmit(form).clicked(e);
-        }
-      });
-    };
-    Blacklight.doBookmarkToggleBehavior.selector = 'form.bookmark-toggle';
+const BookmarkToggle = (e) => {
+  if (e.target.matches('[data-checkboxsubmit-target="checkbox"]')) {
+    const form = e.target.closest('form')
+    if (form) new CheckboxSubmit(form).clicked(e);
+  }
+};
 
-    Blacklight.doBookmarkToggleBehavior();
-})()
+document.addEventListener('click', BookmarkToggle);
 
 export default BookmarkToggle

data/app/javascript/blacklight/button_focus.js

@@ -1,12 +1,12 @@
-const ButtonFocus = (() => {
-  document.addEventListener('click', (e) => {
-    // Button clicks should change focus. As of 10/3/19, Firefox for Mac and
-    // Safari both do not set focus to a button on button click.
-    // See https://zellwk.com/blog/inconsistent-button-behavior/ for background information
-    if (e.target.matches('[data-toggle="collapse"]') || e.target.matches('[data-bs-toggle="collapse"]')) {
-      e.target.focus()
-    }
-  })
-})()
+const ButtonFocus = (e) => {
+  // Button clicks should change focus. As of 10/3/19, Firefox for Mac and
+  // Safari both do not set focus to a button on button click.
+  // See https://zellwk.com/blog/inconsistent-button-behavior/ for background information
+  if (e.target.matches('[data-toggle="collapse"]') || e.target.matches('[data-bs-toggle="collapse"]')) {
+    e.target.focus()
+  }
+}
+
+document.addEventListener('click', ButtonFocus)
 
 export default ButtonFocus

data/app/javascript/blacklight/index.js

@@ -1,13 +1,14 @@
-import BookmarkToggle from './bookmark_toggle'
-import ButtonFocus from './button_focus'
-import Modal from './modal'
-import SearchContext from './search_context'
-import Core from './core'
+import BookmarkToggle from 'blacklight/bookmark_toggle'
+import ButtonFocus from 'blacklight/button_focus'
+import Modal from 'blacklight/modal'
+import SearchContext from 'blacklight/search_context'
+import Core from 'blacklight/core'
 
 export default {
   BookmarkToggle,
   ButtonFocus,
   Modal,
   SearchContext,
+  Core,
   onLoad: Core.onLoad
 }

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>
 
@@ -52,17 +52,10 @@
   can be a turbo-stream that defines some HTML fragementsand where on the page to put them:
   https://turbo.hotwired.dev/handbook/streams
 */
-import Blacklight from './core'
-import ModalForm from './modalForm'
+import ModalForm from 'blacklight/modalForm'
 
 const Modal = (() => {
-  // We keep all our data in Blacklight.modal object.
-  // Create lazily if someone else created first.
-  if (Blacklight.modal === undefined) {
-    Blacklight.modal = {};
-  }
-
-  const modal = Blacklight.modal
+  const modal = {}
 
   // a Bootstrap modal div that should be already on the page hidden
   modal.modalSelector = '#blacklight-modal';
@@ -83,20 +76,19 @@ const Modal = (() => {
   modal.containerSelector    = '[data-blacklight-modal~=container]';
 
   // Called on fatal failure of ajax load, function returns content
-  // to show to user in modal.  Right now called only for extreme
-  // network errors.
-  modal.onFailure = function (jqXHR, textStatus, errorThrown) {
-      console.error('Server error:', this.url, jqXHR.status, errorThrown);
+  // to show to user in modal.  Right now called only for network errors.
+  modal.onFailure = function (error) {
+      console.error('Server error:', this.url, error);
 
       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">
-          <span aria-hidden="true">&times;</span>
+        <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>
         <div class="modal-body">
           <p>Expected a successful response from the server, but got an error</p>
-          <pre>${this.type} ${this.url}\n${jqXHR.status}: ${errorThrown}</pre>
+          <pre>${this.url}\n${error}</pre>
         </div>`
 
       document.querySelector(`${modal.modalSelector} .modal-content`).innerHTML = contents
@@ -105,10 +97,16 @@ const Modal = (() => {
   }
 
   // Add the passed in contents to the modal and display it.
-modal.receiveAjax = function (contents) {
+  modal.receiveAjax = function (contents) {
       const domparser = new DOMParser();
       const dom = domparser.parseFromString(contents, "text/html")
-      const elements = dom.querySelectorAll(`${modal.containerSelector} > *`)
+      // If there is a containerSelector on the document, use its children.
+      let elements = dom.querySelectorAll(`${modal.containerSelector} > *`)
+      if (elements.length == 0) {
+        // If the containerSelector wasn't found, use the whole document
+        elements = dom.body.childNodes
+      }
+
       document.querySelector(`${modal.modalSelector} .modal-content`).replaceChildren(...elements)
 
       modal.show();
@@ -134,28 +132,30 @@ modal.receiveAjax = function (contents) {
     // 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()
     })
   };
 
   modal.hide = function (el) {
-    const dom = document.querySelector(Blacklight.modal.modalSelector)
+    const dom = document.querySelector(modal.modalSelector)
 
     if (!dom.open) return
     dom.close()
   }
 
   modal.show = function(el) {
-    const dom = document.querySelector(Blacklight.modal.modalSelector)
+    const dom = document.querySelector(modal.modalSelector)
 
     if (dom.open) return
     dom.showModal()
   }
 
   modal.setupModal()
+
+  return modal;
 })()
 
 export default Modal