blacklight-spotlight 5.3.2 → 6.0.0.rc2

data/app/components/spotlight/upload_field_form_group_component.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Renders an upload field (Spotlight::UploadFieldConfig) on the catalog edit and upload forms through its configured component
+  class UploadFieldFormGroupComponent < ViewComponent::Base
+    attr_reader :form, :config, :value, :inline
+
+    def initialize(form:, config:, value: nil, inline: false)
+      @form = form
+      @config = config
+      @value = value
+      @inline = inline
+      super()
+    end
+
+    def call
+      render config.component.new(
+        form:,
+        id: config.field_name,
+        label:,
+        value:,
+        field_type: config.form_field_type,
+        multiple: config.is_multiple?,
+        inline:
+      )
+    end
+
+    def label
+      solr_field = Array(config.solr_field || config.field_name).first.to_s
+      helpers.blacklight_config.index_fields[solr_field]&.label || config.label || solr_field
+    end
+  end
+end

data/app/controllers/concerns/spotlight/controller.rb

@@ -13,12 +13,21 @@ module Spotlight
     included do
       helper_method :current_site, :current_exhibit, :current_masthead, :exhibit_masthead?, :resource_masthead?, :breadcrumbs
       before_action :set_exhibit_locale_scope, :set_locale
+      after_action :add_previewable_exhibit_robots_header
+      # If your app overrides search_state_class, subclass Spotlight::SearchState (rather than
+      # Blacklight::SearchState) to keep exhibit-scoped document routing.
+      self.search_state_class = Spotlight::SearchState
     end
 
     def set_exhibit_locale_scope
       Translation.current_exhibit = current_exhibit
     end
 
+    # Previewable exhibits are only meant to be reachable by link, so ask search engines not to index them
+    def add_previewable_exhibit_robots_header
+      response.headers['X-Robots-Tag'] = 'noindex' if current_exhibit&.previewable?
+    end
+
     def current_site
       @current_site ||= Spotlight::Site.instance
     end
@@ -77,27 +86,19 @@ module Spotlight
       end
     end
 
-    def search_state
-      if current_exhibit
-        @search_state ||= Spotlight::SearchState.new(super, current_exhibit)
-      else
-        super
-      end
-    end
-
-    def search_action_url(*args, **kwargs)
+    def search_action_url(*, **)
       if current_exhibit
-        exhibit_search_action_url(*args, **kwargs)
+        exhibit_search_action_url(*, **)
       else
-        main_app.search_catalog_url(*args, **kwargs)
+        main_app.search_catalog_url(*, **)
       end
     end
 
-    def search_facet_path(*args, **kwargs)
+    def search_facet_path(*, **)
       if current_exhibit
-        exhibit_search_facet_path(*args, **kwargs)
+        exhibit_search_facet_path(*, **)
       else
-        main_app.facet_catalog_url(*args, **kwargs)
+        main_app.facet_catalog_url(*, **)
       end
     end
 

data/app/controllers/concerns/spotlight/search_helper.rb

@@ -3,11 +3,8 @@
 module Spotlight
   # ...
   module SearchHelper
-    def search_service(user_params = respond_to?(:search_state, true) ? search_state.to_h : {})
-      klass = respond_to?(:search_service_class) ? search_service_class : Blacklight::SearchService
-
-      klass.new(config: blacklight_config, user_params:, **search_service_context)
-    end
+    extend ActiveSupport::Concern
+    include Blacklight::Searchable
 
     # @return [Hash] a hash of context information to pass through to the search service
     def search_service_context

data/app/controllers/spotlight/browse_controller.rb

@@ -22,8 +22,7 @@ module Spotlight
     before_action do
       blacklight_config.track_search_session.storage = false
       blacklight_config.view.gallery.classes = 'row-cols-2 row-cols-md-4' if blacklight_config.view.key? :gallery
-      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
     end
 
     def index
@@ -121,10 +120,6 @@ module Spotlight
       Spotlight::Engine.config.default_browse_index_view_type
     end
 
-    def render_save_this_search?
-      false
-    end
-
     def render_curator_actions?
       false
     end

data/app/controllers/spotlight/catalog_controller.rb

@@ -35,7 +35,6 @@ module Spotlight
       blacklight_config.view.select! { |k, _v| k == :admin_table }
       unless blacklight_config.view.key? :admin_table
         blacklight_config.view.admin_table(document_component: Spotlight::DocumentAdminTableComponent,
-                                           partials: [:index_compact],
                                            document_actions: [])
       end
 
@@ -66,7 +65,7 @@ module Spotlight
     # results when a partial match is passed in the "q" parameter.
     def autocomplete
       @response = search_service.search_results do |builder|
-        builder.with(builder.blacklight_params.merge(search_field: Spotlight::Engine.config.autocomplete_search_field, public: true, rows: 100))
+        builder.with(search_state.params.merge(search_field: Spotlight::Engine.config.autocomplete_search_field, public: true, rows: 100))
       end
 
       respond_to do |format|
@@ -200,7 +199,7 @@ module Spotlight
 
     def uploaded_resource_params
       if @document.uploaded_resource?
-        [{ configured_fields: Spotlight::Resources::Upload.fields(current_exhibit).map(&:field_name) }]
+        [{ configured_fields: Spotlight::Resources::Upload.as_strong_params(current_exhibit) }]
       else
         []
       end

data/app/controllers/spotlight/concerns/application_controller.rb

@@ -29,8 +29,8 @@ module Spotlight
         end
       end
 
-      def enabled_in_spotlight_view_type_configuration?(config, *args)
-        if config.respond_to?(:original) && !blacklight_configuration_context.evaluate_if_unless_configuration(config.original, *args)
+      def enabled_in_spotlight_view_type_configuration?(config, *)
+        if config.respond_to?(:original) && !blacklight_configuration_context.evaluate_if_unless_configuration(config.original, *)
           false
         elsif current_exhibit.nil? || is_a?(Spotlight::PagesController)
           true
@@ -39,10 +39,8 @@ module Spotlight
         end
       end
 
-      def field_enabled?(field, *args)
-        if !field.enabled
-          false
-        elsif field.respond_to?(:original) && !blacklight_configuration_context.evaluate_if_unless_configuration(field.original, *args)
+      def field_enabled?(field, *)
+        if !field.enabled || (field.respond_to?(:original) && !blacklight_configuration_context.evaluate_if_unless_configuration(field.original, *))
           false
         elsif field.is_a?(Blacklight::Configuration::SortField) || field.is_a?(Blacklight::Configuration::SearchField)
           field.enabled

data/app/controllers/spotlight/exhibits_controller.rb

@@ -8,17 +8,16 @@ module Spotlight
 
     before_action :authenticate_user!, except: [:index]
     before_action :set_tab, only: %i[edit update]
+    before_action :load_exhibits, only: [:index]
 
     load_and_authorize_resource
 
     def index
-      @published_exhibits = @exhibits.includes(:thumbnail).published.ordered_by_weight.page(params[:page])
-      @published_exhibits = @published_exhibits.tagged_with(params[:tag]) if params[:tag]
-      if @exhibits.one?
-        redirect_to @exhibits.first, flash: flash.to_h
-      else
-        render layout: 'spotlight/home'
-      end
+      return redirect_to @exhibits.first, flash: flash.to_h if @exhibits.one?
+
+      @published_exhibits = @exhibits.includes(:thumbnail).discoverable.ordered_by_weight.page(params[:page])
+      @published_exhibits = @published_exhibits.tagged_with(params[:tag]) if params[:tag].present?
+      render layout: 'spotlight/home'
     end
 
     def show
@@ -86,18 +85,18 @@ module Spotlight
       redirect_to main_app.root_url, notice: t(:'helpers.submit.exhibit.destroyed', model: @exhibit.class.model_name.human.downcase)
     end
 
-    protected
-
     def current_exhibit
       @exhibit if @exhibit&.persisted?
     end
 
+    protected
+
     def exhibit_params
       params.require(:exhibit).permit(
         :title,
         :subtitle,
         :description,
-        :published,
+        :publishing_status,
         :tag_list,
         tag_list: [],
         contact_emails_attributes: %i[id email],
@@ -105,6 +104,19 @@ module Spotlight
       )
     end
 
+    # Runs before load_and_authorize_resource to set @exhibits from discoverable
+    # exhibits, not just exhibits that can be accessed.
+    def load_exhibits
+      exhibits = Spotlight::Exhibit.accessible_by(current_ability)
+      return @exhibits = exhibits.discoverable unless current_user
+
+      @exhibits = if can?(:manage, Spotlight::Exhibit)
+                    exhibits
+                  else
+                    exhibits.discoverable.or(exhibits.where(id: current_user.exhibits.select(:id)))
+                  end
+    end
+
     def set_tab
       @tab = params[:tab]
     end

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/upload_controller.rb

@@ -48,7 +48,7 @@ module Spotlight
       end
 
       def data_param_keys
-        Spotlight::Resources::Upload.fields(current_exhibit).map(&:field_name) +
+        Spotlight::Resources::Upload.as_strong_params(current_exhibit) +
           current_exhibit.custom_fields.as_strong_params
       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/controllers/spotlight/solr_controller.rb

@@ -50,7 +50,7 @@ module Spotlight
 
         create_or_update_solr_document_sidecar(doc, r)
 
-        doc.to_solr.merge(@exhibit.solr_data).merge(other_field_data)
+        doc.to_solr.stringify_keys.merge(@exhibit.solr_data.stringify_keys).merge(other_field_data)
       end
     end
 
@@ -69,6 +69,10 @@ module Spotlight
     end
 
     def create_or_update_solr_document_sidecar(doc, data)
+      # The sidecar already records the unique key as its document_id. (The payload is a raw
+      # Solr document, so here "id" is always the unique key; in other sidecar data it may be
+      # the slug of an "ID" custom field.)
+      data = data.except(doc.class.unique_key.to_s)
       return if data.blank?
 
       sidecar = doc.sidecar(@exhibit)

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)
@@ -125,13 +136,6 @@ module Spotlight
       selected_view || default_document_index_view_type
     end
 
-    # Return the list of views that are configured to display for a block
-    def selected_search_block_views(block)
-      block.as_json[:data].select do |_key, value|
-        value == 'on'
-      end.keys.map(&:to_s)
-    end
-
     # Create checkbox for selecting/deselecting metadata fields for a given view in metadata configuration
     def select_deselect_action(id)
       check_box_tag(
@@ -143,26 +147,10 @@ module Spotlight
       )
     end
 
-    def uploaded_field_label(config)
-      solr_field = Array(config.solr_field || config.field_name).first.to_s
-      blacklight_config.index_fields[solr_field]&.label || config.label || t(".#{solr_field}")
-    end
-
     def available_view_fields
       current_exhibit.blacklight_configuration.default_blacklight_config.view.to_h.reject { |_k, v| v.if == false }
     end
 
-    def render_search_bar
-      return super if defined?(super)
-
-      render((blacklight_config&.view_config(document_index_view_type)&.search_bar_component || Blacklight::SearchBarComponent).new(
-               url: search_action_url,
-               advanced_search_url: search_action_url(action: 'advanced_search'),
-               params: search_state.params_for_search.except(:qt),
-               autocomplete_path: suggest_index_catalog_path
-             ))
-    end
-
     def render_constraints(localized_params = nil, local_search_state = nil)
       return super if defined?(super)
 

data/app/helpers/spotlight/crud_link_helpers.rb

@@ -20,24 +20,12 @@ module Spotlight
       link_to action_default_value(model, :view), link, link_to_options
     end
 
-    def create_link(model, *args)
-      link_to_options = args.extract_options!
-      link = args.first || polymorphic_path([spotlight, model], action: :new)
-      link_to action_default_value(model), link, link_to_options
-    end
-
     def exhibit_create_link(model, *args)
       link_to_options = args.extract_options!
       link = args.first || polymorphic_path([spotlight, current_exhibit, model], action: :new)
       link_to action_default_value(model), link, link_to_options
     end
 
-    def edit_link(model, *args)
-      link_to_options = args.extract_options!
-      link = args.first || polymorphic_path([spotlight, model], action: :edit)
-      link_to action_default_value(model), link, link_to_options
-    end
-
     def exhibit_edit_link(model, *args)
       link_to_options = args.extract_options!
       link = args.first || polymorphic_path([spotlight, model.exhibit, model], action: :edit)

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"
 }