blacklight-spotlight 5.1.0 → 5.2.0

data/app/models/spotlight/resources/iiif_manifest_v3.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Spotlight
+  module Resources
+    # A PORO to construct a solr hash for a given v3 IiifManifest
+    class IiifManifestV3 < Spotlight::Resources::IiifManifest
+      private
+
+      def add_thumbnail_url
+        return unless thumbnail_field && manifest['thumbnail'].present?
+
+        solr_hash[thumbnail_field] = manifest.thumbnail.map(&:id)
+      end
+
+      def image_urls
+        resources.map do |resource|
+          image_url = (resource['id'] || resource['@id']).dup # break reference, otherwise it changes values of other fields
+          image_url << '/info.json' unless image_url.downcase.ends_with?('/info.json')
+          image_url
+        end
+      end
+
+      def full_image_url
+        resources.first.try(:[], 'id') || resources.first.try(:[], '@id')
+      end
+
+      def resources
+        @resources ||=
+          canvases
+          .flat_map(&:items).select { |item| item.type == 'AnnotationPage' }
+          .flat_map(&:items).select { |item| item.motivation == 'painting' }
+          .flat_map(&:body)
+          .flat_map(&:service)
+      end
+
+      def canvases
+        manifest.try(:items).select { |canvas| canvas.type == 'Canvas' }
+      end
+    end
+  end
+end

data/app/models/spotlight/resources/iiif_service.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'iiif/presentation'
+require 'iiif/v3/presentation'
 module Spotlight
   module Resources
     ###
@@ -20,6 +21,8 @@ module Spotlight
       def manifests
         @manifests ||= if manifest?
                          [create_iiif_manifest(object)]
+                       elsif v3_manifest?
+                         [create_iiif_v3_manifest(object)]
                        else
                          build_collection_manifest.to_a
                        end
@@ -39,13 +42,26 @@ module Spotlight
       protected
 
       def object
-        @object ||= IIIF::Service.parse(response)
+        # If it's a v3 manifest, the v2 library will parse it as an OrderedHash
+        @object ||= parse_v2? ? manifest_v2 : manifest_v3
       end
 
       private
 
       attr_reader :url
 
+      def parse_v2?
+        manifest_v2.is_a?(IIIF::Presentation::Manifest) || manifest_v2.is_a?(IIIF::Presentation::Collection)
+      end
+
+      def manifest_v2
+        @manifest_v2 ||= IIIF::Presentation::Service.parse(response)
+      end
+
+      def manifest_v3
+        IIIF::V3::Presentation::Service.parse(response)
+      end
+
       class << self
         def iiif_response(url)
           Spotlight::Resources::IiifService.http_client.get(url).body
@@ -73,10 +89,18 @@ module Spotlight
         IiifManifest.new(url: manifest['@id'], manifest:, collection:)
       end
 
+      def create_iiif_v3_manifest(manifest, collection = nil)
+        IiifManifestV3.new(url: manifest['id'], manifest:, collection:)
+      end
+
       def manifest?
         object.is_a?(IIIF::Presentation::Manifest)
       end
 
+      def v3_manifest?
+        object.is_a?(IIIF::V3::Presentation::Manifest)
+      end
+
       def collection?
         object.is_a?(IIIF::Presentation::Collection)
       end

data/app/models/spotlight/search.rb

@@ -8,6 +8,7 @@ module Spotlight
     include Spotlight::SearchHelper
 
     extend FriendlyId
+
     friendly_id :title, use: %i[slugged scoped finders history], scope: :exhibit
 
     self.table_name = 'spotlight_searches'
@@ -25,7 +26,7 @@ module Spotlight
         serialize :query_params, Hash
       end
     end
-    default_scope { order('weight ASC') }
+    default_scope { order(:weight) }
     scope :published, -> { where(published: true) }
     scope :unpublished, -> { where(published: [nil, false]) }
     validates :title, presence: true

data/app/services/spotlight/exhibit_import_export_service.rb

@@ -164,12 +164,13 @@ module Spotlight
 
       hash[:custom_fields].each do |attr|
         ar = exhibit.custom_fields.find_or_initialize_by(slug: attr[:slug])
-        attr[:configuration] = attr[:configuration].clone.transform_keys(&:to_s)
+        attr[:configuration] = attr[:configuration].clone.deep_transform_keys(&:to_s) if attr[:configuration]
         ar.update(attr)
       end
 
       hash[:solr_document_sidecars].each do |attr|
         ar = exhibit.solr_document_sidecars.find_or_initialize_by(document_id: attr[:document_id])
+        attr[:data] = attr[:data].clone.deep_transform_keys(&:to_s) if attr[:data]
         ar.update(attr)
       end
 
@@ -177,6 +178,7 @@ module Spotlight
         upload = attr.delete(:upload)
 
         ar = exhibit.resources.find_or_initialize_by(type: attr[:type], url: attr[:url])
+        attr[:data] = attr[:data].clone.deep_transform_keys(&:to_s) if attr[:data]
         ar.update(attr)
 
         deserialize_featured_image(ar, :upload, upload) if upload

data/app/views/spotlight/admin_users/index.html.erb

@@ -5,20 +5,18 @@
     <table class="table table-striped">
       <thead>
         <tr>
-          <th colspan="2"><%= Spotlight::Engine.user_class.human_attribute_name(:email)  %></th>
+          <th scope="col"><%= Spotlight::Engine.user_class.human_attribute_name(:email) %></th>
+          <th scope="col"><%= t('.site_admin') %></th>
         </tr>
       </thead>
-      <tbody class="table">
+      <tbody>
         <% @site.roles.map(&:user).each do |user| %>
           <tr>
-            <td class="<%= 'invite-pending' if user.invite_pending? %>">
-              <%= user.email %>
-              <span class='badge bg-warning pending-label'><%= t('.pending') %></span>
+            <td>
+              <%= render Spotlight::AdminUsers::EmailComponent.new(user:) %>
             </td>
             <td>
-              <%= link_to(t('.destroy'), admin_user_path(user),
-                    data: { method: :delete, turbo_method: :delete },
-                    class: 'btn btn-sm btn-danger float-end') unless user == current_user %>
+              <%= render Spotlight::AdminUsers::SiteAdminComponent.new(user:) %>
             </td>
           </tr>
         <% end %>
@@ -67,30 +65,22 @@
     <table class="table table-striped ">
       <thead>
         <tr>
-          <th><%= Spotlight::Engine.user_class.human_attribute_name(:email)  %></th>
-          <th><%= Spotlight::Engine.user_class.human_attribute_name(:role)  %></th>
+          <th scope="col"><%= Spotlight::Engine.user_class.human_attribute_name(:email) %></th>
+          <th scope="col"><%= t('.site_admin') %></th>
+          <th scope="col"><%= t('.exhibit_roles') %></th>
         </tr>
       </thead>
-      <tbody class="table">
+      <tbody>
         <% @users.each do |user| %>
           <tr>
-            <td class="<%= 'invite-pending' if user.invite_pending? %>">
-              <%= user.email %>
-              <span class='badge bg-warning pending-label'><%= t('.pending') %></span>
+            <td class="user-emails">
+              <%= render Spotlight::AdminUsers::EmailComponent.new(user:) %>
             </td>
-            <td class="role">
-              <%= user.roles.map { |r| r.role.titleize }.uniq.join(", ") %>
+            <td>
+              <%= render Spotlight::AdminUsers::SiteAdminComponent.new(user:) %>
             </td>
-            <td class="text-end">
-              <% if user.superadmin? %>
-                <%= link_to(t('.destroy'), admin_user_path(user),
-                      data: { method: :delete, turbo_method: :delete },
-                      class: 'btn btn-sm btn-danger') unless user == current_user %>
-              <% else %>
-                <%= link_to(t('.update'), admin_user_path(user),
-                      data: { method: :patch, turbo_method: :patch },
-                      class: 'btn btn-sm btn-primary') %>
-              <% end %>
+            <td class="user-exhibit-roles">
+              <%= render Spotlight::AdminUsers::ExhibitRolesComponent.new(user:) %>
             </td>
           </tr>
         <% end %>

data/app/views/spotlight/catalog/_document_admin_table.html.erb

@@ -10,10 +10,6 @@
     </tr>
   </thead>
 
-  <% if Blacklight.version < '8.0' %>
-    <%= render (view_config.document_component || Spotlight::DocumentAdminTableComponent).with_collection(documents) %>
-  <% else %>
-    <% document_presenters = documents.map { |doc| document_presenter(doc) } -%>
-    <%= render view_config.document_component.with_collection(document_presenters) %>
-  <% end %>
+  <% document_presenters = documents.map { |doc| document_presenter(doc) } -%>
+  <%= render view_config.document_component.with_collection(document_presenters) %>
 </table>

data/app/views/spotlight/catalog/edit.html.erb

@@ -1,13 +1,8 @@
 <div class="container">
   <div class="row">
     <%- view_config = blacklight_config.view_config(action_name: :edit) %>
-    <%= render (view_config.document_component || Blacklight::DocumentComponent).new((Blacklight.version > '8.0' ? :document : :presenter) => document_presenter(@document), classes: ['col-md-8'], component: :div, show: true, actions: false, partials: view_config.partials) do |component| %>
+    <%= render (view_config.document_component || Blacklight::DocumentComponent).new(document: document_presenter(@document), classes: ['col-md-8'], component: :div, show: true, partials: view_config.partials) do |component| %>
       <% component.with_title(as: 'h1', classes: '', link_to_document: false) %>
-      <% component.with_body do %>
-        <% view_config.partials.each do |view_partial| %>
-          <%= render_document_partial @document, view_partial, component: component, document_counter: 1 %>
-        <% end %>
-      <% end if Blacklight.version < '8.0' && view_config.document_component.blank? %>
     <% end %>
     <div class="col-md-4">
       <%= render 'edit_default', document: @document %>

data/app/views/spotlight/exhibits/_exhibit_card.html.erb

@@ -28,7 +28,7 @@
 
           <% if exhibit.description %>
             <p class="description">
-              <%= exhibit.description %>
+              <%= strip_tags(exhibit.description) %>
             </p>
           <% end %>
         <% end %>

data/app/views/spotlight/pages/_order_pages.html.erb

@@ -5,7 +5,7 @@
 
       <%= render partial: 'header', locals: {f: f} %>
       <h2 class="mt-4"><%= t :'.pages_header' %></h2>
-      <p class="instructions"><%= t :'.instructions' %></p>
+      <div class="instructions"><%= t :'.instructions_html' %></div>
       <div class="panel-group dd <%= page_collection_name %>_admin" id="nested-pages" data-behavior="nestable" <%= nestable_data_attributes(page_collection_name).html_safe %> >
         <ol class="dd-list">
           <%= f.fields_for page_collection_name do |p| %>

data/app/views/spotlight/pages/show.html.erb

@@ -9,9 +9,11 @@
   <div class="clearfix">
     <%= render 'edit_page_link' if can? :edit, @page %>
     <% if @page.should_display_title? %>
-      <h1 class="page-title">
+      <h2 class="page-title h1">
         <%= @page.title %>
-      </h1>
+      </h2>
+    <% else %>
+      <h2 class="visually-hidden"><%= t '.default_page_title'%></h2>
     <% end %>
   </div>
   <div>

data/app/views/spotlight/resources/csv_upload/_form.html.erb

@@ -1,3 +1,5 @@
+<div class="instructions mb-4"><%= t('.instructions_html') %></div>
+
 <%= bootstrap_form_for([current_exhibit, @resource.becomes(Spotlight::Resources::CsvUpload)], layout: :horizontal, label_col: 'col-md-2', control_col: 'col-sm-6 col-md-6', html: { class: 'item-upload-form', multipart: true } ) do |f| %>
   <%= f.url_field :url, type: "file", help: t('.help_html', link: link_to(t('.template'), template_exhibit_resources_csv_uploads_path, data: { turbo: false })), label: t('.file_label') %>
   <div class="form-actions">

data/app/views/spotlight/sir_trevor/blocks/_embedded_document.html.erb

@@ -1,8 +1,8 @@
 <div class="box" data-id="<%= document.id %>">
   <% view_config = blacklight_config.view_config(:embed) %>
-  <%= render (view_config.document_component || Spotlight::SolrDocumentLegacyEmbedComponent).new((Blacklight.version > '8.0' ? :document : :presenter) => document_presenter(document, view_config: view_config), counter: nil, block: local_assigns[:block]) do |component| %>
+  <%= render (view_config.document_component || Spotlight::SolrDocumentLegacyEmbedComponent).new(document: document_presenter(document, view_config: view_config), counter: nil, block: local_assigns[:block]) do |component| %>
     <% component.with_partial do %>
       <%= render_document_partials document, view_config.partials, component: component, document_counter: nil, view_config: view_config, block: local_assigns[:block], **(view_config.locals) %>
-    <% end if view_config&.partials&.any? %>
+    <% end if Blacklight.version < '9.0' && view_config&.partials&.any? %>
   <% end %>
 </div>

data/app/views/spotlight/sir_trevor/blocks/_search_results_block.html.erb

@@ -1,12 +1,12 @@
 <% if search_results_block.searches? %>
 <div class="content-block documents">
-  <% response, document_list = get_search_widget_search_results(search_results_block) %>
+  <% response = get_search_widget_search_results(search_results_block) %>
   <%- unless response.documents.present? %>
     <div class="alert alert-warning">
       <strong>No items to display.</strong> There are currently no items in this exhibit that match the curator's search criteria.
     </div>
   <%- else %>
-      <% @response, @document_list = [response, document_list] %>
+      <% @response = response %>
 
       <% views = blacklight_view_config_for_search_block(search_results_block) %>
       <% if views.length > 1 -%>

data/app/views/spotlight/sir_trevor/blocks/_solr_documents_carousel_block.html.erb

@@ -15,7 +15,7 @@
         <% elsif doc_presenter.thumbnail.exists? %>
           <%= doc_presenter.thumbnail.thumbnail_tag({ alt: resource_alt_text(block_options, doc_presenter.heading) }, document_counter: -1) %>
         <% end %>
-        <div class="carousel-caption">
+        <div class="carousel-caption" id="carousel-caption-<%= document.id %>">
           <% if solr_documents_carousel_block.primary_caption? %>
             <h3 class="primary">
               <%= solr_documents_carousel_block.document_caption(doc_presenter, solr_documents_carousel_block.primary_caption_field) %>
@@ -40,10 +40,12 @@
     </ol>
 
     <!-- Controls -->
-    <a class="left carousel-control-prev" href="#<%= html_id %>" data-bs-slide="prev">
+    <a class="left carousel-control-prev" href="#<%= html_id %>" data-bs-slide="prev"
+      aria-label="<%= t('spotlight.sir_trevor.blocks.solr_documents_carousel_block.controls.previous_item') %>">
       <%= blacklight_icon('arrow_back_ios') %>
     </a>
-    <a class="right carousel-control-next" href="#<%= html_id %>" data-bs-slide="next">
+    <a class="right carousel-control-next" href="#<%= html_id %>" data-bs-slide="next"
+      aria-label="<%= t('spotlight.sir_trevor.blocks.solr_documents_carousel_block.controls.next_item') %>">
       <%= blacklight_icon('arrow_forward_ios') %>
     </a>
   </div>

data/app/views/spotlight/sir_trevor/blocks/_text_block.html.erb

@@ -1,4 +1,4 @@
 <div class="st__content-block st__content-block--text">
-  <%# We prefer the GitHub markup here. %>
+  <%# We prefer the Redcarpet markup here. %>
   <%= sir_trevor_markdown text_block.text %>
 </div>

data/config/initializers/devise_rails8_patch.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'devise' # make sure it's already loaded
+
+# Starting from Rails 8.0, routes are lazy-loaded by default in test and development environments.
+# However, Devise's mappings are built during the routes loading phase.
+# To ensure it works correctly, we need to load the routes first before accessing @@mappings.
+module Devise
+  def self.mappings
+    Rails.application.try(:reload_routes_unless_loaded)
+    @@mappings
+  end
+end

data/config/locales/spotlight.en.yml

@@ -213,13 +213,22 @@ en:
         admins_curators: Administrators and curators of all exhibits
         all_users: All registered users
         copy: Copy
-        create: Add new administrator
-        destroy: Remove from admin role
-        instructions: Existing exhibits administrators
+        create: Add new site admin
+        destroy: Remove site admin role
+        destroy_confirm: Are you sure you want to remove the site admin role for %{email}?
+        exhibit_roles: Exhibit roles
+        instructions: Existing exhibits site administrators
         page_title: Manage users
         pending: pending
+        remove_roles: Remove all exhibit roles
+        remove_roles_confirm: Are you sure you want to remove all exhibit roles for %{email}?
         save: Add role
-        update: Make user an administrator
+        show_exhibit_roles: Show exhibit title (role)
+        site_admin: Site admin
+        update: Make user a site admin
+      remove_exhibit_roles:
+        error: There was a problem removing the user's exhibit roles
+        success: Removed all exhibit roles for user
     appearances:
       edit:
         header: Appearance
@@ -762,16 +771,31 @@ en:
         header: New page
       order_pages:
         cancel: Cancel
-        instructions: Add new pages below. Drag and drop pages to change the order in which they are displayed in the sidebar.
+        instructions_html: |
+          <p>Add new pages below. Drag and drop pages to change the order in which they are displayed in the sidebar.</p>
+          <p><b>Note About Page Titles and URLs</b></p>
+          <p>When renaming pages, keep in mind that Spotlight automatically creates a unique URL (called a slug) based on the page title. If another page is already using that slug—even if it has been renamed—the new page's URL will include extra characters to make it unique.</p>
+          <p><b>Tip:</b> If you want a new or renamed page to have a clean URL (e.g., /collection-highlights), make sure to delete the original page that first used that title before renaming.</p>
         new_page: Add new page
         pages_header: Custom pages
         save: Save
+      show:
+        default_page_title: Main Content
     resources:
       csv_upload:
         form:
           add_item: Add item
           file_label: CSV file
           help_html: "%{link}"
+          instructions_html: |
+            <p><b>Tips for uploading items via CSV</b></p>
+            <ul>
+              <li>Only .jpg, .jpeg, or .png files can be uploaded as items.</li>
+              <li>Each item file must be under 10 MB.</li>
+              <li>Images from phones/tablets may display sideways or upside-down. Re-saving the image in Photoshop or another editor can help correct this.</li>
+              <li>Rows with a blank URL field will be skipped. Use ~ to skip the field but still index the item.</li>
+              <li>CSVs saved from Excel may include hidden characters. Use a plain text editor to clean and re-save the file if errors occur.</li>
+            </ul>
           template: Download template
           title: Upload multiple items
       external_resources_form:
@@ -827,6 +851,7 @@ en:
       fields:
         abstract_tesim: Abstract
         corporate_name_ssm: Corporate names
+        exhibit_tags: Exhibit tags
         facet:
           corporate_name_ssm: Corporate names
           exhibit_tags: Exhibit tags
@@ -980,6 +1005,10 @@ en:
             other: "%{count} items"
         solr_documents_block:
           zpr_link_html: View <span class="visually-hidden">%{title}</span> larger
+        solr_documents_carousel_block:
+          controls:
+            next_item: Next item
+            previous_item: Previous item
         uploaded_items_block:
           zpr_link_html: View <span class="visually-hidden">%{title}</span> larger
     sites:

data/config/routes.rb

@@ -16,7 +16,11 @@ Spotlight::Engine.routes.draw do
 
   get '/exhibits/edit', to: 'sites#edit_exhibits', as: 'edit_site_exhibits'
 
-  resources :admin_users, only: %i[index create update destroy]
+  resources :admin_users, only: %i[index create update destroy] do
+    member do
+      delete 'remove_exhibit_roles'
+    end
+  end
 
   resources :exhibits, path: '/', except: [:show] do
     member do

data/lib/spotlight/engine.rb

@@ -25,8 +25,7 @@ module Spotlight
     isolate_namespace Spotlight
 
     require 'carrierwave'
-    require 'redcarpet' # required for markdown support in github/markup https://github.com/github/markup#markups
-    require 'github/markup'
+    require 'redcarpet' # required for markdown support
     require 'openseadragon'
 
     config.assets.precompile += %w[spotlight/fallback/*.png] if defined?(Sprockets)
@@ -158,7 +157,7 @@ module Spotlight
     ]
 
     config.iiif_manifest_field = :iiif_manifest_url_ssi
-    config.iiif_metadata_class = -> { Spotlight::Resources::IiifManifest::Metadata }
+    config.iiif_metadata_class = -> { Spotlight::Resources::IiifManifestMetadata }
     config.iiif_collection_id_field = :collection_id_ssim
     config.iiif_title_fields = nil
     config.default_json_ld_language = 'en'
@@ -265,31 +264,16 @@ module Spotlight
 
     config.spambot_honeypot_email_field = :email_address
 
-    if Blacklight::VERSION > '8'
-      Blacklight::Configuration.default_configuration do
-        # Field containing the last modified date for a Solr document
-        Blacklight::Configuration.default_values[:index].timestamp_field ||= 'timestamp'
+    Blacklight::Configuration.default_configuration do
+      # Field containing the last modified date for a Solr document
+      Blacklight::Configuration.default_values[:index].timestamp_field ||= 'timestamp'
 
-        # Default configuration for the browse view
-        Blacklight::Configuration.property :browse, default: Blacklight::OpenStructWithHashAccess.new(document_actions: [])
+      # Default configuration for the browse view
+      Blacklight::Configuration.property :browse, default: Blacklight::OpenStructWithHashAccess.new(document_actions: [])
 
-        Blacklight::Configuration.default_values[:search_state_fields] ||= []
-        Blacklight::Configuration.default_values[:search_state_fields] += %i[id exhibit_id browse_category_id]
-        Blacklight::Configuration.default_values[:skip_link_component] = Spotlight::SkipLinkComponent
-      end
-    else
-      config.to_prepare do
-        Blacklight::Configuration.try(:initialize_default_configuration) unless Blacklight::Configuration.try(:initialized_default_configuration?)
-
-        # Field containing the last modified date for a Solr document
-        Blacklight::Configuration.default_values[:index].timestamp_field ||= 'timestamp'
-
-        # Default configuration for the browse view
-        Blacklight::Configuration.default_values[:browse] ||= Blacklight::OpenStructWithHashAccess.new(document_actions: [])
-
-        Blacklight::Configuration.default_values[:search_state_fields] ||= []
-        Blacklight::Configuration.default_values[:search_state_fields] += %i[id exhibit_id browse_category_id]
-      end
+      Blacklight::Configuration.default_values[:search_state_fields] ||= []
+      Blacklight::Configuration.default_values[:search_state_fields] += %i[id exhibit_id browse_category_id]
+      Blacklight::Configuration.default_values[:skip_link_component] = Spotlight::SkipLinkComponent
     end
 
     # make blacklight configuration play nice with bootstrap_form

data/lib/spotlight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spotlight
-  VERSION = '5.1.0'
+  VERSION = '5.2.0'
 end