blacklight 7.32.0 → 8.0.0.beta1

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -1,15 +1,8 @@
 # frozen_string_literal: true
+
 ##
 # URL helper methods
 module Blacklight::UrlHelperBehavior
-  extend Deprecation
-
-  # @deprecated
-  def url_for_document(doc, options = {})
-    search_state.url_for_document(doc, options)
-  end
-  deprecation_deprecate url_for_document: 'Use SearchState#url_for_document directly'
-
   # Uses the catalog_path route to create a link to the show page for an item.
   # catalog_path accepts a hash. The solr query params are stored in the session,
   # so we only need the +counter+ param here. We also need to know if we are viewing to document as part of search results.
@@ -19,9 +12,9 @@ module Blacklight::UrlHelperBehavior
   # @param opts [Hash] the options to create the link with
   # @option opts [Number] :counter (nil) the count to set in the session (for paging through a query result)
   # @example Passing in an image
-  #   link_to_document(doc, '<img src="thumbnail.png">', counter: 3) #=> "<a href=\"catalog/123\" data-tracker-href=\"/catalog/123/track?counter=3&search_id=999\"><img src="thumbnail.png"></a>
+  #   link_to_document(doc, '<img src="thumbnail.png">', counter: 3) #=> "<a href=\"catalog/123\" data-context-href=\"/catalog/123/track?counter=3&search_id=999\"><img src="thumbnail.png"></a>
   # @example With the default document link field
-  #   link_to_document(doc, counter: 3) #=> "<a href=\"catalog/123\" data-tracker-href=\"/catalog/123/track?counter=3&search_id=999\">My Title</a>
+  #   link_to_document(doc, counter: 3) #=> "<a href=\"catalog/123\" data-context-href=\"/catalog/123/track?counter=3&search_id=999\">My Title</a>
   def link_to_document(doc, field_or_opts = nil, opts = { counter: nil })
     label = case field_or_opts
             when NilClass
@@ -29,18 +22,11 @@ module Blacklight::UrlHelperBehavior
             when Hash
               opts = field_or_opts
               document_presenter(doc).heading
-            when Proc, Symbol
-              Deprecation.warn(self, "passing a #{field_or_opts.class} to link_to_document is deprecated and will be removed in Blacklight 8")
-              Deprecation.silence(Blacklight::IndexPresenter) do
-                index_presenter(doc).label field_or_opts, opts
-              end
             else # String
               field_or_opts
             end
 
-    Deprecation.silence(Blacklight::UrlHelperBehavior) do
-      link_to label, url_for_document(doc), document_link_params(doc, opts)
-    end
+    link_to label, search_state.url_for_document(doc), document_link_params(doc, opts)
   end
 
   # @private
@@ -49,46 +35,19 @@ module Blacklight::UrlHelperBehavior
   end
   private :document_link_params
 
-  ##
-  # Link to the previous document in the current search context
-  # @deprecated
-  def link_to_previous_document(previous_document, classes: 'previous', **addl_link_opts)
-    link_opts = session_tracking_params(previous_document, search_session['counter'].to_i - 1).merge(class: classes, rel: 'prev').merge(addl_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
-  deprecation_deprecate link_to_previous_document: 'Moving to Blacklight::SearchContextComponent'
-
-  ##
-  # Link to the next document in the current search context
-  # @deprecated
-  def link_to_next_document(next_document, classes: 'next', **addl_link_opts)
-    link_opts = session_tracking_params(next_document, search_session['counter'].to_i + 1).merge(class: classes, rel: 'next').merge(addl_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
-  deprecation_deprecate link_to_previous_document: 'Moving to Blacklight::SearchContextComponent'
-
   ##
   # Attributes for a link that gives a URL we can use to track clicks for the current search session
-  # @private
   # @param [SolrDocument] document
   # @param [Integer] counter
   # @example
   #   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
-    path = session_tracking_path(document, per_page: params.fetch(:per_page, search_session['per_page']), counter: counter, search_id: current_search_session.try(:id), document_id: document&.id)
-
-    if path.nil?
-      return {}
-    end
+  #   => { 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)
+    return {} if path.nil?
 
-    { data: { 'context-href': path } }
+    { data: { context_href: path } }
   end
-  private :session_tracking_params
 
   ##
   # Get the URL for tracking search sessions across pages using polymorphic routing
@@ -100,7 +59,7 @@ module Blacklight::UrlHelperBehavior
     end
 
     raise "Unable to find #{controller_tracking_method} route helper. " \
-    "Did you add `concerns :searchable` routing mixin to your `config/routes.rb`?"
+          "Did you add `concerns :searchable` routing mixin to your `config/routes.rb`?"
   end
 
   def controller_tracking_method
@@ -111,28 +70,6 @@ module Blacklight::UrlHelperBehavior
   # link based helpers ->
   #
 
-  # create link to query (e.g. spelling suggestion)
-  # @deprecated
-  def link_to_query(query)
-    p = search_state.to_h.except(:page, :action)
-    p[:q] = query
-    link_to(query, search_action_path(p))
-  end
-  deprecation_deprecate link_to_query: 'Removed without replacement'
-
-  ##
-  # Get the path to the search action with any parameters (e.g. view type)
-  # that should be persisted across search sessions.
-  # @deprecated
-  def start_over_path query_params = params
-    h = {}
-    current_index_view_type = document_index_view_type(query_params)
-    h[:view] = current_index_view_type unless current_index_view_type == default_document_index_view_type
-
-    search_action_path(h)
-  end
-  deprecation_deprecate start_over_path: 'Removed without replacement'
-
   # Create a link back to the index screen, keeping the user's facet, query and paging choices intact by using session.
   # @example
   #   link_back_to_catalog(label: 'Back to Search')
@@ -165,30 +102,9 @@ module Blacklight::UrlHelperBehavior
     link_to label, link_url, opts
   end
 
-  # Search History and Saved Searches display
+  # Use in e.g. the search history display, where we want something more like text instead of the normal constraints
   def link_to_previous_search(params)
-    Deprecation.silence(Blacklight::SearchHistoryConstraintsHelperBehavior) do
-      link_to(render_search_to_s(params), search_action_path(params))
-    end
-  end
-
-  # Get url parameters to a search within a grouped result set
-  #
-  # @deprecated
-  # @param [Blacklight::Solr::Response::Group] group
-  # @return [Hash]
-  def add_group_facet_params_and_redirect group
-    search_state.add_facet_params_and_redirect(group.field, group.key)
-  end
-  deprecation_deprecate add_group_facet_params_and_redirect: 'Removed without replacement'
-
-  # A URL to refworks export, with an embedded callback URL to this app.
-  # the callback URL is to bookmarks#export, which delivers a list of
-  # user's bookmarks in 'refworks marc txt' format -- we tell refworks
-  # to expect that format.
-  # @deprecated
-  def bookmarks_export_url(format, params = {})
-    bookmarks_url(params.merge(format: format, encrypted_user_id: encrypt_user_id(current_or_guest_user.id)))
+    search_state = controller.search_state_class.new(params, blacklight_config, self)
+    link_to(render(Blacklight::ConstraintsComponent.for_search_history(search_state: search_state)), search_action_path(params))
   end
-  deprecation_deprecate bookmarks_export_url: 'Removed without replacement'
 end

data/app/helpers/blacklight_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module BlacklightHelper
   include Blacklight::BlacklightHelperBehavior
 end

data/app/helpers/catalog_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module CatalogHelper
   include Blacklight::CatalogHelperBehavior
 end

data/app/javascript/blacklight/bookmark_toggle.js

@@ -1,25 +1,19 @@
-(function($) {
-    //change form submit toggle to checkbox
+import Blacklight from './core'
+import CheckboxSubmit from './checkbox_submit'
+
+const BookmarkToggle = (() => {
+    // change form submit toggle to checkbox
     Blacklight.doBookmarkToggleBehavior = function() {
-      if (typeof Blacklight.do_bookmark_toggle_behavior == 'function') {
-        console.warn("do_bookmark_toggle_behavior is deprecated. Use doBookmarkToggleBehavior instead.");
-        return Blacklight.do_bookmark_toggle_behavior();
-      }
-      $(Blacklight.doBookmarkToggleBehavior.selector).blCheckboxSubmit({
-         // cssClass is added to elements added, plus used for id base
-         cssClass: 'toggle-bookmark',
-         success: function(checked, response) {
-           if (response.bookmarks) {
-             $('[data-role=bookmark-counter]').text(response.bookmarks.count);
-           }
-         }
+      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';
 
-Blacklight.onLoad(function() {
-  Blacklight.doBookmarkToggleBehavior();
-});
-
+    Blacklight.doBookmarkToggleBehavior();
+})()
 
-})(jQuery);
+export default BookmarkToggle

data/app/javascript/blacklight/button_focus.js

@@ -1,10 +1,12 @@
-Blacklight.onLoad(function() {
-  // 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
-  document.querySelectorAll('button.collapse-toggle').forEach((button) => {
-    button.addEventListener('click', () => {
-      event.target.focus();
-    });
-  });
-});
+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()
+    }
+  })
+})()
+
+export default ButtonFocus

data/app/javascript/blacklight/checkbox_submit.js

@@ -1,134 +1,80 @@
-/* A JQuery plugin (should this be implemented as a widget instead? not sure)
-   that will convert a "toggle" form, with single submit button to add/remove
+/* Converts a "toggle" form, with single submit button to add/remove
    something, like used for Bookmarks, into an AJAXy checkbox instead.
-
    Apply to a form. Does require certain assumption about the form:
     1) The same form 'action' href must be used for both ADD and REMOVE
        actions, with the different being the hidden input name="_method"
        being set to "put" or "delete" -- that's the Rails method to pretend
        to be doing a certain HTTP verb. So same URL, PUT to add, DELETE
        to remove. This plugin assumes that.
-
        Plus, the form this is applied to should provide a data-doc-id
        attribute (HTML5-style doc-*) that contains the id/primary key
        of the object in question -- used by plugin for a unique value for
        DOM id's.
-
-  Uses HTML for a checkbox compatible with Bootstrap 3.
-
-   Pass in options for your class name and labels:
-   $("form.something").blCheckboxSubmit({
-        //cssClass is added to elements added, plus used for id base
-        cssClass: "toggle_my_kinda_form",
-        error: function() {
-          #optional callback
-        },
-        success: function(after_success_check_state) {
-          #optional callback
-        }
-   });
+  Uses HTML for a checkbox compatible with Bootstrap 4.
+   new CheckboxSubmit(document.querySelector('form.something')).render()
 */
-(function($) {
-    $.fn.blCheckboxSubmit = function(argOpts) {
-      this.each(function() {
-        var options = $.extend({}, $.fn.blCheckboxSubmit.defaults, argOpts);
-
-
-        var form = $(this);
-        form.children().hide();
-        //We're going to use the existing form to actually send our add/removes
-        //This works conveneintly because the exact same action href is used
-        //for both bookmarks/$doc_id.  But let's take out the irrelevant parts
-        //of the form to avoid any future confusion.
-        form.find('input[type=submit]').remove();
-
-        //View needs to set data-doc-id so we know a unique value
-        //for making DOM id
-        var uniqueId = form.attr('data-doc-id') || Math.random();
-        // if form is currently using method delete to change state,
-        // then checkbox is currently checked
-        var checked = (form.find('input[name=_method][value=delete]').length != 0);
-
-        var checkbox = $('<input type="checkbox">')
-          .addClass( options.cssClass )
-          .attr('id', options.cssClass + '_' + uniqueId);
-        var label = $('<label>')
-          .addClass( options.cssClass )
-          .attr('for', options.cssClass + '_' + uniqueId)
-          .attr('title', form.attr('title') || '');
-        var span = $('<span>');
-
-        label.append(checkbox);
-        label.append(' ');
-        label.append(span);
-
-        var checkboxDiv = $('<div class="checkbox" />')
-          .addClass(options.cssClass)
-          .append(label);
-
-        function updateStateFor(state) {
-            checkbox.prop('checked', state);
-            label.toggleClass('checked', state);
-            if (state) {
-               //Set the Rails hidden field that fakes an HTTP verb
-               //properly for current state action.
-               form.find('input[name=_method]').val('delete');
-               span.html(form.attr('data-present'));
-            } else {
-               form.find('input[name=_method]').val('put');
-               span.html(form.attr('data-absent'));
-            }
-          }
-
-        form.append(checkboxDiv);
-        updateStateFor(checked);
-
-        checkbox.click(function() {
-            span.html(form.attr('data-inprogress'));
-            label.attr('disabled', 'disabled');
-            checkbox.attr('disabled', 'disabled');
-
-            $.ajax({
-                url: form.attr('action'),
-                dataType: 'json',
-                type: form.attr('method').toUpperCase(),
-                data: form.serialize(),
-                error: function() {
-                   label.removeAttr('disabled');
-                   checkbox.removeAttr('disabled');
-                   options.error.call();
-                },
-                success: function(data, status, xhr) {
-                  //if app isn't running at all, xhr annoyingly
-                  //reports success with status 0.
-                  if (xhr.status != 0) {
-                    checked = ! checked;
-                    updateStateFor(checked);
-                    label.removeAttr('disabled');
-                    checkbox.removeAttr('disabled');
-                    options.success.call(form, checked, xhr.responseJSON);
-                  } else {
-                    label.removeAttr('disabled');
-                    checkbox.removeAttr('disabled');
-                    options.error.call();
-                  }
-                }
-            });
-
-            return false;
-        }); //checkbox.click
-
-
-      }); //this.each
-      return this;
-    };
-
-  $.fn.blCheckboxSubmit.defaults =  {
-            //cssClass is added to elements added, plus used for id base
-            cssClass: 'blCheckboxSubmit',
-            error: function() {
-              alert("Error");
-            },
-            success: function() {} //callback
-  };
-})(jQuery);
+export default class CheckboxSubmit {
+  constructor(form) {
+    this.form = form
+  }
+
+  async clicked(evt) {
+    this.spanTarget.innerHTML = this.form.getAttribute('data-inprogress')
+    this.labelTarget.setAttribute('disabled', 'disabled');
+    this.checkboxTarget.setAttribute('disabled', 'disabled');
+    const response = await fetch(this.formTarget.getAttribute('action'), {
+      body: new FormData(this.formTarget),
+      method: this.formTarget.getAttribute('method').toUpperCase(),
+      headers: {
+        'Accept': 'application/json',
+        'X-Requested-With': 'XMLHttpRequest',
+        'X-CSRF-Token': document.querySelector('meta[name=csrf-token]')?.content
+      }
+    })
+    this.labelTarget.removeAttribute('disabled')
+    this.checkboxTarget.removeAttribute('disabled')
+    if (response.ok) {
+      const json = await response.json()
+      this.updateStateFor(!this.checked)
+      document.querySelector('[data-role=bookmark-counter]').innerHTML = json.bookmarks.count
+    } else {
+      alert('Error')
+    }
+  }
+
+  get checked() {
+    return (this.form.querySelectorAll('input[name=_method][value=delete]').length != 0)
+  }
+
+  get formTarget() {
+    return this.form
+  }
+
+  get labelTarget() {
+    return this.form.querySelector('[data-checkboxsubmit-target="label"]')
+  }
+
+  get checkboxTarget() {
+    return this.form.querySelector('[data-checkboxsubmit-target="checkbox"]')
+  }
+
+  get spanTarget() {
+    return this.form.querySelector('[data-checkboxsubmit-target="span"]')
+  }
+
+  updateStateFor(state) {
+    this.checkboxTarget.checked = state
+
+    if (state) {
+      this.labelTarget.classList.add('checked')
+      //Set the Rails hidden field that fakes an HTTP verb
+      //properly for current state action.
+      this.formTarget.querySelector('input[name=_method]').value = 'delete'
+      this.spanTarget.innerHTML = this.form.getAttribute('data-present')
+    } else {
+      this.labelTarget.classList.remove('checked')
+      this.formTarget.querySelector('input[name=_method]').value = 'put'
+      this.spanTarget.innerHTML = this.form.getAttribute('data-absent')
+    }
+  }
+}

data/app/javascript/blacklight/core.js

@@ -1,20 +1,20 @@
 const Blacklight = function() {
-  var buffer = new Array;
+  const buffer = new Array;
   return {
     onLoad: function(func) {
       buffer.push(func);
     },
 
     activate: function() {
-      for(var i = 0; i < buffer.length; i++) {
+      for(let i = 0; i < buffer.length; i++) {
         buffer[i].call();
       }
     },
 
     listeners: function () {
-      var listeners = [];
+      const listeners = [];
       if (typeof Turbo !== 'undefined') {
-        listeners.push('turbo:load');
+        listeners.push('turbo:load', 'turbo:frame-load');
       } else if (typeof Turbolinks !== 'undefined' && Turbolinks.supported) {
         // Turbolinks 5
         if (Turbolinks.BrowserAdapter) {
@@ -51,4 +51,5 @@ Blacklight.onLoad(function () {
   elem.classList.add('js')
 })
 
-window.Blacklight = Blacklight
+
+export default Blacklight

data/app/javascript/blacklight/index.js

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