blacklight-spotlight 5.3.2 → 6.0.0.rc1

data/app/controllers/spotlight/lock_controller.rb

@@ -10,7 +10,7 @@ module Spotlight
     def destroy
       @lock.destroy
 
-      render plain: '', status: :no_content
+      head :no_content
     end
   end
 end

data/app/controllers/spotlight/pages_controller.rb

@@ -17,8 +17,7 @@ module Spotlight
     helper_method :get_search_results, :search_results, :fetch, :page_collection_name
 
     before_action do
-      blacklight_config.action_mapping.default = blacklight_config.index
-      blacklight_config.action_mapping.show = blacklight_config.index
+      blacklight_config.action_mapping.show.top_level_config = :index
       blacklight_config.view.gallery.classes = 'row-cols-2 row-cols-md-4' unless @page&.display_sidebar
     end
 
@@ -118,10 +117,11 @@ module Spotlight
 
     # Add a Page specific search_results method that takes user params as
     # an option and passes that off to the search service to get results
-    # @param [Hash] the query parameters
+    # @param [Hash] user_params the query parameters
     # @return [Object] the search results object from the configured search service
     def search_results(user_params)
-      search_service(user_params).search_results
+      state = search_state_class.new(user_params, blacklight_config, self)
+      search_service_class.new(config: blacklight_config, search_state: state, **search_service_context).search_results
     end
 
     def undo_link
@@ -197,13 +197,13 @@ module Spotlight
 
     def redirect_page_to_related_locale_version
       pages_for_id = current_exhibit.pages.find(params[:id])
-      if pages_for_id.default_locale_page
-        redirect_to polymorphic_path([current_exhibit, pages_for_id.default_locale_page])
-      elsif pages_for_id.translated_page_for(I18n.locale)
-        redirect_to polymorphic_path([current_exhibit, pages_for_id.translated_page_for(I18n.locale)])
-      else
-        raise ActiveRecord::RecordNotFound
-      end
+      default_page = pages_for_id.default_locale_page || pages_for_id
+      target = default_page.translated_page_for(I18n.locale) || pages_for_id.default_locale_page
+      raise ActiveRecord::RecordNotFound unless target
+
+      # Pass the locale explicitly. A host app route default (e.g., `locale: nil`) overrides default_url_options.
+      locale = target.locale unless target.default_locale?
+      redirect_to polymorphic_path([current_exhibit, target], locale:)
     end
   end
 end

data/app/controllers/spotlight/resources_controller.rb

@@ -28,7 +28,7 @@ module Spotlight
         redirect_to spotlight.admin_exhibit_catalog_path(@resource.exhibit, sort: :timestamp)
       else
         flash[:error] = @resource.errors.full_messages.to_sentence if @resource.errors.present?
-        render action: 'new'
+        render action: 'new', status: :unprocessable_content
       end
     end
     alias update create

data/app/helpers/spotlight/application_helper.rb

@@ -45,7 +45,7 @@ module Spotlight
       initial_exception = nil
 
       ([self] + additional_locale_routing_scopes).each do |scope|
-        return scope.public_send(:url_for, params.to_unsafe_h.merge(locale:))
+        return scope.url_for(params.to_unsafe_h.merge(locale:))
       rescue ActionController::UrlGenerationError => e
         initial_exception ||= e
       end
@@ -59,9 +59,9 @@ module Spotlight
 
     # Can search for named routes directly in the main app, omitting
     # the "main_app." prefix
-    def method_missing(method, *args, &)
+    def method_missing(method, *, &)
       if main_app_url_helper?(method)
-        main_app.send(method, *args)
+        main_app.send(method, *)
       else
         super
       end
@@ -93,6 +93,17 @@ module Spotlight
       end
     end
 
+    ##
+    # Helper to search the exhibit with a saved search's query. Falls back to the
+    # default search field so that a search without a query still lands on the
+    # results page instead of being redirected to the exhibit home page
+    def path_to_saved_search(search)
+      spotlight.search_exhibit_catalog_path(
+        search.exhibit,
+        search.query_params.presence || { search_field: search.blacklight_config.default_search_field.key }
+      )
+    end
+
     ##
     # Override Blacklight's #render_document_class to inject a private class
     def render_document_class(document = @document)

data/app/helpers/spotlight/main_app_helpers.rb

@@ -27,8 +27,8 @@ module Spotlight
     end
 
     # Expecting to upstream this override in https://github.com/projectblacklight/blacklight/pull/3343/files
-    def document_presenter(document, view_config: nil, **kwargs)
-      (view_config&.document_presenter_class || document_presenter_class(document)).new(document, self, view_config:, **kwargs)
+    def document_presenter(document, view_config: nil, **)
+      (view_config&.document_presenter_class || document_presenter_class(document)).new(document, self, view_config:, **)
     end
 
     def document_presenter_class(_document)

data/app/javascript/spotlight/admin/add_another.js

@@ -1,31 +1,43 @@
 export default class {
   connect() {
-    $("[data-action='add-another']").on("click", function (event) {
-      event.preventDefault()
-
-      var templateId = $(this).data("template-id")
-
-      var template = document.querySelector("#" + templateId)
-      var clone = document.importNode(template.content, true)
-
-      var count =
-        $(this)
-          .closest(".form-group")
-          .find('[name="' + $(clone).find("[name]").attr("name") + '"]')
-          .length + 1
-      $(clone)
-        .find("[id]")
-        .each(function (index, el) {
-          $(el).attr("id", $(el).attr("id") + "_" + String(count))
-        })
+    document
+      .querySelectorAll("[data-action='add-another']")
+      .forEach((button) => {
+        button.addEventListener("click", (event) => {
+          event.preventDefault()
 
-      $(clone)
-        .find("[for]")
-        .each(function (index, el) {
-          $(el).attr("for", $(el).attr("for") + "_" + String(count))
-        })
+          const templateId = button.dataset.templateId
+          if (!templateId) return
+
+          const template = document.getElementById(templateId)
+          if (!template) return
+
+          const clone = document.importNode(template.content, true)
+
+          const formGroup = button.closest(".form-group")
+          if (!formGroup) return
 
-      $(clone).insertBefore(this)
-    })
+          const firstNamedElement = clone.querySelector("[name]")
+          if (!firstNamedElement) return
+
+          const nameAttr = firstNamedElement.getAttribute("name")
+          const existingElements = formGroup.querySelectorAll(
+            `[name="${nameAttr}"]`,
+          )
+          const count = existingElements.length + 1
+
+          clone.querySelectorAll("[id]").forEach((el) => {
+            const currentId = el.getAttribute("id")
+            el.setAttribute("id", `${currentId}_${count}`)
+          })
+
+          clone.querySelectorAll("[for]").forEach((el) => {
+            const currentFor = el.getAttribute("for")
+            el.setAttribute("for", `${currentFor}_${count}`)
+          })
+
+          button.parentNode.insertBefore(clone, button)
+        })
+      })
   }
 }

data/app/javascript/spotlight/admin/add_image_selector.js

@@ -1,40 +1,57 @@
 import Iiif from "spotlight/admin/iiif"
+import multiImageSelector from "spotlight/admin/multi_image_selector"
 
 export function addImageSelector(input, panel, manifestUrl, initialize) {
   if (!manifestUrl) {
     showNonIiifAlert(input)
     return
   }
-  var cropper = input.data("iiifCropper")
-  $.ajax(manifestUrl).done(function (manifest) {
-    var iiifManifest = new Iiif(manifestUrl, manifest)
-
-    var thumbs = iiifManifest.imagesArray()
-
-    hideNonIiifAlert(input)
-
-    if (initialize) {
-      cropper.setIiifFields(thumbs[0])
-      panel.multiImageSelector() // Clears out existing selector
-    }
-
-    if (thumbs.length > 1) {
-      panel.show()
-      panel.multiImageSelector(
-        thumbs,
-        function (selectorImage) {
-          cropper.setIiifFields(selectorImage)
-        },
-        cropper.iiifImageField.val(),
-      )
-    }
-  })
+  var cropper = input.iiifCropper
+  fetch(manifestUrl)
+    .then(function (response) {
+      return response.json()
+    })
+    .then(function (manifest) {
+      var iiifManifest = new Iiif(manifestUrl, manifest)
+
+      var thumbs = iiifManifest.imagesArray()
+
+      hideNonIiifAlert(input)
+
+      if (initialize) {
+        cropper.setIiifFields(thumbs[0])
+        multiImageSelector(panel) // Clears out existing selector
+      }
+
+      if (thumbs.length > 1) {
+        panel.style.display = ""
+        multiImageSelector(
+          panel,
+          thumbs,
+          function (selectorImage) {
+            cropper.setIiifFields(selectorImage)
+          },
+          cropper.iiifImageField.value,
+        )
+      }
+    })
+}
+
+function findNonIiifAlert(input) {
+  if (!input || !input.parentElement) return null
+  var prev = input.parentElement.previousElementSibling
+  if (prev && prev.matches('[data-behavior="non-iiif-alert"]')) {
+    return prev
+  }
+  return null
 }
 
 function showNonIiifAlert(input) {
-  input.parent().prev('[data-behavior="non-iiif-alert"]').show()
+  var alert = findNonIiifAlert(input)
+  if (alert) alert.style.display = ""
 }
 
 function hideNonIiifAlert(input) {
-  input.parent().prev('[data-behavior="non-iiif-alert"]').hide()
+  var alert = findNonIiifAlert(input)
+  if (alert) alert.style.display = "none"
 }

data/app/javascript/spotlight/admin/add_new_button.js

@@ -1,81 +1,96 @@
 export default class {
   connect() {
-    $("[data-expanded-add-button]").each((_i, el) =>
-      this.addExpandBehaviorToButton($(el)),
-    )
+    document
+      .querySelectorAll("[data-expanded-add-button]")
+      .forEach((el) => this.addExpandBehaviorToButton(el))
   }
 
   addExpandBehaviorToButton(button) {
     var settings = {
-      speed: button.data("speed") || 450,
-      animate_width: button.data("animate_width") || 425,
+      speed: parseInt(button.dataset.speed || "450", 10),
+      animate_width: parseInt(button.dataset.animateWidth || "425", 10),
     }
-    var target = $(button.data("field-target"))
-    var save = $("input[data-behavior='save']", target)
-    var cancel = $("input[data-behavior='cancel']", target)
-    var input = $("input[type='text']", target)
-    var original_width = button.outerWidth()
+    var target = document.querySelector(button.dataset.fieldTarget)
+    var save = target.querySelector("input[data-behavior='save']")
+    var cancel = target.querySelector("input[data-behavior='cancel']")
+    var input = target.querySelector("input[type='text']")
+    var original_width = button.offsetWidth
     var expanded = false
 
     // Animate button open when the mouse enters or
     // the button is given focus (i.e. clicked/tabbed)
-    button.on("mouseenter focus", function () {
-      expandButton()
-    })
+    button.addEventListener("mouseenter", expandButton)
+    button.addEventListener("focus", expandButton)
 
     // Don't allow blank titles
-    save.on("click", function () {
+    save.addEventListener("click", function (e) {
       if (inputEmpty()) {
-        return false
+        e.preventDefault()
+        e.stopPropagation()
       }
     })
 
     // Empty input and collapse
     // button on cancel click
-    cancel.on("click", function (e) {
+    cancel.addEventListener("click", function (e) {
       e.preventDefault()
-      input.val("")
+      input.value = ""
       collapseButton()
     })
 
     // Collapse the button on when
     // an empty input loses focus
-    input.on("blur", function () {
+    input.addEventListener("blur", function () {
       if (inputEmpty()) {
         collapseButton()
       }
     })
+
     function expandButton() {
       // If this has not yet been expanded, recalculate original_width to
       // handle things that may have been originally hidden.
       if (!expanded) {
-        original_width = button.outerWidth()
+        original_width = button.offsetWidth
       }
-      if (button.outerWidth() <= original_width + 5) {
+      if (button.offsetWidth <= original_width + 5) {
         expanded = true
-        button.animate(
+        var anim = button.animate(
           { width: settings.animate_width + "px" },
-          settings.speed,
-          function () {
-            target.show(0, function () {
-              input.focus()
-              // Set the button to auto width to make
-              // sure it has room for any inputs
-              button.width("auto")
-              // Explicitly set the width of the button
-              // so the close animation works properly
-              button.width(button.width())
-            })
-          },
+          { duration: settings.speed },
         )
+        anim.onfinish = function () {
+          button.style.width = settings.animate_width + "px"
+          showElement(target)
+          input.focus()
+          // Set the button to auto width to make
+          // sure it has room for any inputs
+          button.style.width = "auto"
+          // Explicitly set the width of the button
+          // so the close animation works properly
+          button.style.width = button.offsetWidth + "px"
+        }
       }
     }
     function collapseButton() {
-      target.hide()
-      button.animate({ width: original_width + "px" }, settings.speed)
+      target.style.display = "none"
+      var anim = button.animate(
+        { width: original_width + "px" },
+        { duration: settings.speed },
+      )
+      anim.onfinish = function () {
+        button.style.width = original_width + "px"
+      }
+    }
+    // Show an element that may be hidden via a CSS class by overriding with an
+    // appropriate inline display value (mirrors jQuery's .show()).
+    function showElement(el) {
+      el.style.display = ""
+      if (window.getComputedStyle(el).display === "none") {
+        el.style.display = "inline-block"
+      }
     }
     function inputEmpty() {
-      return $.trim(input.val()) == ""
+      return input.value.trim() == ""
     }
   }
 }

data/app/javascript/spotlight/admin/blacklight_configuration.js

@@ -7,70 +7,92 @@ export default class {
 
   // Add Select/Deselect all behavior for metadata field names for a given view e.g. Item details.
   addCheckboxToggleBehavior() {
-    $("[data-behavior='metadata-select']").each(function () {
-      var selectCheckbox = $(this)
-      var parentCell = selectCheckbox.parents("th")
-      var table = parentCell.closest("table")
-      var columnRows = $(
-        "tr td:nth-child(" + (parentCell.index() + 1) + ")",
-        table,
-      )
-      var checkboxes = $("input[type='checkbox']", columnRows)
-      updateSelectAllInput(selectCheckbox, columnRows)
-      // Add the check/uncheck behavior to the select/deselect all checkbox
-      selectCheckbox.on("click", function () {
-        var allChecked = allCheckboxesChecked(columnRows)
-        columnRows.each(function () {
-          $("input[type='checkbox']", $(this)).prop("checked", !allChecked)
-        })
-      })
-      // When a single checkbox is selected/unselected, the "All" checkbox should be updated accordingly.
-      checkboxes.each(function () {
-        $(this).on("change", function () {
-          updateSelectAllInput(selectCheckbox, columnRows)
-        })
-      })
-    })
-
     // Check number of checkboxes against the number of checked
     // checkboxes to determine if all of them are checked or not
-    function allCheckboxesChecked(elements) {
-      return (
-        $("input[type='checkbox']", elements).length ==
-        $("input[type='checkbox']:checked", elements).length
-      )
+    function allCheckboxesChecked(cells) {
+      let total = 0
+      let checked = 0
+      cells.forEach((cell) => {
+        cell.querySelectorAll("input[type='checkbox']").forEach((cb) => {
+          total++
+          if (cb.checked) {
+            checked++
+          }
+        })
+      })
+      return total === checked
     }
 
     // Check or uncheck the "All" checkbox for each view column, e.g. Item details, List, etc.
-    function updateSelectAllInput(checkbox, elements) {
-      if (allCheckboxesChecked(elements)) {
-        checkbox.prop("checked", true)
-      } else {
-        checkbox.prop("checked", false)
-      }
+    function updateSelectAllInput(checkbox, cells) {
+      checkbox.checked = allCheckboxesChecked(cells)
     }
+
+    document
+      .querySelectorAll("[data-behavior='metadata-select']")
+      .forEach((selectCheckbox) => {
+        const parentCell = selectCheckbox.closest("th")
+        if (!parentCell) return
+
+        const table = parentCell.closest("table")
+        if (!table) return
+
+        const columnIndex = Array.from(parentCell.parentNode.children).indexOf(
+          parentCell,
+        )
+        const columnRows = table.querySelectorAll(
+          `tr td:nth-child(${columnIndex + 1})`,
+        )
+
+        const checkboxes = []
+        columnRows.forEach((cell) => {
+          cell.querySelectorAll("input[type='checkbox']").forEach((cb) => {
+            checkboxes.push(cb)
+          })
+        })
+
+        updateSelectAllInput(selectCheckbox, columnRows)
+
+        // Add the check/uncheck behavior to the select/deselect all checkbox
+        selectCheckbox.addEventListener("click", () => {
+          const allChecked = allCheckboxesChecked(columnRows)
+          columnRows.forEach((cell) => {
+            cell.querySelectorAll("input[type='checkbox']").forEach((cb) => {
+              cb.checked = !allChecked
+              cb.dispatchEvent(new Event("change", { bubbles: true }))
+            })
+          })
+          updateSelectAllInput(selectCheckbox, columnRows)
+        })
+
+        // When a single checkbox is selected/unselected, the "All" checkbox should be updated accordingly.
+        checkboxes.forEach((cb) => {
+          cb.addEventListener("change", () => {
+            updateSelectAllInput(selectCheckbox, columnRows)
+          })
+        })
+      })
   }
 
   addEnableToggleBehavior() {
-    $("[data-behavior='enable-feature']").each(function () {
-      var checkbox = $(this)
-      var target = $($(this).data("target"))
+    document
+      .querySelectorAll("[data-behavior='enable-feature']")
+      .forEach((checkbox) => {
+        const targetSelector = checkbox.dataset.target
+        if (!targetSelector) return
+        const target = document.querySelector(targetSelector)
+        if (!target) return
 
-      checkbox.on("change", function () {
-        if ($(this).is(":checked")) {
-          target
-            .find("input:checkbox")
-            .not("[data-behavior='enable-feature']")
-            .prop("checked", true)
-            .attr("disabled", false)
-        } else {
-          target
-            .find("input:checkbox")
-            .not("[data-behavior='enable-feature']")
-            .prop("checked", false)
-            .attr("disabled", true)
-        }
+        checkbox.addEventListener("change", () => {
+          const isChecked = checkbox.checked
+          target.querySelectorAll("input[type='checkbox']").forEach((cb) => {
+            if (!cb.matches("[data-behavior='enable-feature']")) {
+              cb.checked = isChecked
+              cb.disabled = !isChecked
+              cb.dispatchEvent(new Event("change", { bubbles: true }))
+            }
+          })
+        })
       })
-    })
   }
 }