blacklight-spotlight 5.1.0 → 5.2.0

data/app/assets/stylesheets/spotlight/_admin_users.scss

@@ -0,0 +1,28 @@
+.site-admin-label {
+  display: none;
+}
+
+.site-admin {
+  .site-admin-label {
+    display: inline;
+  }
+}
+
+.user-emails {
+  min-width: 300px;
+}
+
+.user-exhibit-roles {
+  width: 50%;
+
+  details {
+    ul {
+      overflow-y: auto;
+      max-height: 200px;
+    }
+
+    .exhibit-title {
+      font-style: italic;
+    }
+  }
+}

data/app/assets/stylesheets/spotlight/_browse.scss

@@ -80,7 +80,7 @@ $image-overlay-max-height: 300px;
     justify-content: flex-end;
 
     &:hover {
-      background: linear-gradient(rgba(46, 45, 41, 0.7), 0%, rgba(46, 45, 41, 0.7) 100%); 
+      background: linear-gradient(rgba(46, 45, 41, 0.8), 0%, rgba(46, 45, 41, 0.8) 100%); 
     }
 
     .browse-category-title {

data/app/assets/stylesheets/spotlight/_featured_browse_categories_block.scss

@@ -75,7 +75,7 @@ $xl-sidebar-five-tile-width: ($container-xl-sidebar * 0.2) - $tile-margin;
     justify-content: flex-end;
   
     &:hover {
-      background: linear-gradient(rgba(46, 45, 41, 0.7), 0%, rgba(46, 45, 41, 0.7) 100%); 
+      background: linear-gradient(rgba(46, 45, 41, 0.8), 0%, rgba(46, 45, 41, 0.8) 100%); 
     }
   }
 

data/app/assets/stylesheets/spotlight/_spotlight.scss

@@ -35,6 +35,7 @@
 @import "utilities";
 @import "view_larger";
 @import "accessibility";
+@import "admin_users";
 @import "autocomplete";
 
 

data/app/components/spotlight/admin_users/email_component.html.erb

@@ -0,0 +1,5 @@
+<%= content_tag :div, class: user_badge_classes do %>
+  <span class="text-break"><%= user.email %></span>
+  <span class="badge bg-secondary site-admin-label"><%= t('spotlight.admin_users.index.site_admin').downcase %></span>
+  <span class="badge bg-warning pending-label"><%= t('spotlight.admin_users.index.pending') %></span>
+<% end %>

data/app/components/spotlight/admin_users/email_component.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Spotlight
+  module AdminUsers
+    # Display email and badge for user
+    class EmailComponent < ViewComponent::Base
+      attr_reader :user
+
+      def initialize(user:)
+        super()
+        @user = user
+      end
+
+      def user_badge_classes
+        classes = []
+        classes << 'site-admin' if user.superadmin?
+        classes << 'invite-pending' if user.invite_pending?
+        classes
+      end
+    end
+  end
+end

data/app/components/spotlight/admin_users/exhibit_roles_component.html.erb

@@ -0,0 +1,28 @@
+<% if sorted_exhibit_roles.present? %>
+  <div class="d-flex justify-content-between">
+    <div><%= sorted_exhibit_roles.map { |r| r.role.titleize }.uniq.join(", ") %></div>
+    <div>
+      <%= link_to(t('spotlight.admin_users.index.remove_roles'), helpers.spotlight.remove_exhibit_roles_admin_user_path(user),
+            data: {
+              method: :delete,
+              turbo_method: :delete,
+              turbo_confirm: t('spotlight.admin_users.index.remove_roles_confirm', email: user.email)
+            },
+            class: 'btn btn-sm btn-danger ms-3 mb-3 text-nowrap') %>
+    </div>
+  </div>
+  <details>
+    <summary><%= t('spotlight.admin_users.index.show_exhibit_roles') %></summary>
+    <ul>
+      <% sorted_exhibit_roles.each do |exhibit_role| %>
+        <li>
+          <span class="exhibit-title">
+            <%= link_to(exhibit_role.resource.title, helpers.spotlight.exhibit_roles_path(exhibit_role.resource),
+                  target: :_blank) %>
+          </span>
+          (<%= exhibit_role.role.titleize %>)
+        </li>
+      <% end %>
+    </ul>
+  </details>
+<% end %>

data/app/components/spotlight/admin_users/exhibit_roles_component.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Spotlight
+  module AdminUsers
+    # Display all exhibit roles for a user
+    class ExhibitRolesComponent < ViewComponent::Base
+      attr_reader :user
+
+      def initialize(user:)
+        super()
+        @user = user
+      end
+
+      def sorted_exhibit_roles
+        @sorted_exhibit_roles ||= user.all_exhibit_roles.sort_by { |r| [r.role, r.resource.title] }
+      end
+    end
+  end
+end

data/app/components/spotlight/admin_users/site_admin_component.html.erb

@@ -0,0 +1,13 @@
+<% if user.superadmin? %>
+  <%= link_to(t('spotlight.admin_users.index.destroy'), helpers.admin_user_path(user),
+        data: {
+          method: :delete,
+          turbo_method: :delete,
+          turbo_confirm: t('spotlight.admin_users.index.destroy_confirm', email: user.email)
+        },
+        class: 'btn btn-sm btn-danger text-nowrap') unless user == current_user %>
+<% else %>
+  <%= link_to(t('spotlight.admin_users.index.update'), helpers.admin_user_path(user),
+        data: { method: :patch, turbo_method: :patch },
+        class: 'btn btn-sm btn-primary text-nowrap') %>
+<% end %>

data/app/components/spotlight/admin_users/site_admin_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Spotlight
+  module AdminUsers
+    # Display site admin role actions for user
+    class SiteAdminComponent < ViewComponent::Base
+      attr_reader :user
+
+      delegate :current_user, to: :helpers
+
+      def initialize(user:)
+        super()
+        @user = user
+      end
+    end
+  end
+end

data/app/components/spotlight/analytics/aggregation_component.rb

@@ -5,7 +5,7 @@ module Spotlight
     # Display Analytics aggregations as table
     class AggregationComponent < ViewComponent::Base
       def initialize(data:, exclude_fields: nil)
-        super
+        super()
         @exclude_fields = exclude_fields
         @data = data
       end

data/app/components/spotlight/analytics/dashboard_component.rb

@@ -7,7 +7,7 @@ module Spotlight
       attr_reader :current_exhibit, :dates
 
       def initialize(current_exhibit:)
-        super
+        super()
         @current_exhibit = current_exhibit
         @default_start_date = [min_date, 1.year.ago].max
         @default_end_date = [max_date, Time.zone.today].min

data/app/components/spotlight/breadcrumbs_component.rb

@@ -7,7 +7,7 @@ module Spotlight
 
     def initialize(breadcrumbs: [])
       @breadcrumbs = breadcrumbs
-      super
+      super()
     end
 
     def render?

data/app/components/spotlight/bulk_action_component.rb

@@ -6,7 +6,7 @@ module Spotlight
     def initialize(bulk_actions:, button_classes: 'btn btn-primary dropdown-toggle')
       @bulk_actions = bulk_actions
       @button_classes = button_classes
-      super
+      super()
     end
 
     attr_reader :button_classes, :bulk_actions

data/app/components/spotlight/edit_view_links_component.rb

@@ -6,7 +6,7 @@ module Spotlight
     attr_reader :page, :classes, :delete_link
 
     def initialize(page:, classes: 'page-links', delete_link: false)
-      super
+      super()
 
       @page = page
       @classes = classes

data/app/components/spotlight/header_navigation_link_component.rb

@@ -8,7 +8,7 @@ module Spotlight
       @path = path
       @active = active
       @label = label
-      super
+      super()
     end
   end
 end

data/app/components/spotlight/save_search_component.rb

@@ -5,7 +5,7 @@ module Spotlight
   class SaveSearchComponent < ViewComponent::Base
     def initialize(button_classes: 'btn btn-outline-primary')
       @button_classes = button_classes
-      super
+      super()
     end
 
     attr_reader :button_classes

data/app/components/spotlight/select_image_component.rb

@@ -4,7 +4,7 @@ module Spotlight
   # Component to select section of image
   class SelectImageComponent < ViewComponent::Base
     def initialize(index_id, block_item_id)
-      super
+      super()
       @index_id = index_id
       @block_item_id = block_item_id
     end

data/app/components/spotlight/skip_link_component.rb

@@ -6,7 +6,7 @@ module Spotlight
     def initialize(render_search_link: true)
       @render_search_link = render_search_link
 
-      super
+      super()
     end
 
     def link_to_search

data/app/components/spotlight/solr_document_legacy_embed_component.rb

@@ -6,13 +6,13 @@ module Spotlight
     attr_reader :block_context
 
     def initialize(*args, block: nil, **kwargs)
-      super
+      super(*args, **kwargs)
 
       @block_context = block
     end
 
     def before_render
-      set_slot(:embed, nil, block_context:) unless embed
+      with_embed(block_context: block_context) unless embed
 
       super
     end

data/app/components/spotlight/tag_list_form_component.rb

@@ -7,7 +7,7 @@ module Spotlight
 
     def initialize(form:)
       @form = form
-      super
+      super()
     end
   end
 end

data/app/components/spotlight/tag_selector_component.rb

@@ -11,7 +11,7 @@ module Spotlight
       @selected_tags_value = selected_tags_value || ''
       @all_tags = all_tags&.sort_by { |tag| (tag.respond_to?(:name) ? tag.name : tag).downcase }
 
-      super
+      super()
     end
 
     def selected_tags

data/app/components/spotlight/title_component.rb

@@ -6,7 +6,7 @@ module Spotlight
     def initialize(title:, subtitle:)
       @title = title
       @subtitle = subtitle
-      super
+      super()
     end
 
     def title

data/app/components/spotlight/translations/subheading_component.rb

@@ -6,7 +6,7 @@ module Spotlight
     class SubheadingComponent < ViewComponent::Base
       def initialize(key:)
         @key = key
-        super
+        super()
       end
 
       def text

data/app/components/spotlight/uneditable_non_default_language_component.rb

@@ -7,7 +7,7 @@ module Spotlight
     def initialize(current_exhibit:, current_language:)
       @current_exhibit = current_exhibit
       @current_language = current_language
-      super
+      super()
     end
 
     def edit_translations_button

data/app/controllers/spotlight/admin_users_controller.rb

@@ -2,7 +2,7 @@
 
 module Spotlight
   ##
-  # A controller to handle the adminstration of site admin users
+  # A controller to handle the administration of users
   class AdminUsersController < Spotlight::ApplicationController
     before_action :authenticate_user!
     before_action :load_site
@@ -48,6 +48,16 @@ module Spotlight
       redirect_to spotlight.admin_users_path
     end
 
+    def remove_exhibit_roles
+      user = Spotlight::Engine.user_class.find(params[:id])
+      if user.all_exhibit_roles.destroy_all
+        flash[:notice] = t('.success')
+      else
+        flash[:error] = t('.error')
+      end
+      redirect_to spotlight.admin_users_path
+    end
+
     private
 
     def load_users

data/app/controllers/spotlight/browse_controller.rb

@@ -20,11 +20,7 @@ module Spotlight
     before_action :swap_actions_configuration, only: :show
 
     before_action do
-      if Blacklight::VERSION > '8'
-        blacklight_config.track_search_session.storage = false
-      else
-        blacklight_config.track_search_session = false
-      end
+      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
@@ -36,9 +32,7 @@ module Spotlight
     end
 
     def show
-      # For Blacklight 8, @document_list will be nil but
-      # will be required for Blacklight 7 to work correctly.
-      @response, @document_list = search_service.search_results do |builder|
+      @response = search_service.search_results do |builder|
         builder.with(params.merge(browse_category_id: @search.id))
       end
 

data/app/controllers/spotlight/bulk_actions_controller.rb

@@ -39,7 +39,7 @@ module Spotlight
 
     def solr_response
       @solr_response ||= begin
-        response, _docs = search_service.search_results do |builder|
+        response = search_service.search_results do |builder|
           builder.merge(fl: 'id', rows: 0)
         end
 

data/app/controllers/spotlight/bulk_updates_controller.rb

@@ -24,7 +24,7 @@ module Spotlight
       headers['Content-Disposition'] = "attachment; filename=\"#{current_exhibit.slug}-bulk-update-template.csv\""
       headers.delete('Content-Length')
 
-      self.response_body = csv_template
+      stream_csv_template
     end
 
     def update
@@ -43,16 +43,31 @@ module Spotlight
 
     private
 
+    def stream_csv_template
+      csv_template.each do |row|
+        response.stream.write row
+      end
+    ensure
+      response.stream.close
+    end
+
     def csv_template
-      boolean = ActiveModel::Type::Boolean.new
-      Spotlight::BulkUpdatesCsvTemplateService.new(exhibit: current_exhibit).template(
-        view_context:,
-        title: boolean.cast(reference_field_params[:item_title]),
-        tags: boolean.cast(updatable_field_params[:tags]),
-        visibility: boolean.cast(updatable_field_params[:visibility])
+      @csv_template ||= csv_template_service.template(
+        view_context: view_context,
+        title: active_model_boolean.cast(reference_field_params[:item_title]),
+        visibility: active_model_boolean.cast(updatable_field_params[:visibility]),
+        tags: active_model_boolean.cast(updatable_field_params[:tags])
       )
     end
 
+    def csv_template_service
+      @csv_template_service ||= Spotlight::BulkUpdatesCsvTemplateService.new(exhibit: current_exhibit)
+    end
+
+    def active_model_boolean
+      @active_model_boolean ||= ActiveModel::Type::Boolean.new
+    end
+
     def reference_field_params
       params.require(:reference_fields).permit(:item_title)
     end

data/app/controllers/spotlight/catalog_controller.rb

@@ -24,14 +24,10 @@ module Spotlight
     before_action :load_document, only: %i[edit update make_private make_public manifest]
 
     before_action only: :show do
-      # Substitute the default document component with the custom one for Blacklight 8,
-      # and add the necessary partials for Blacklight 7 (if they haven't configured the document component)
+      # Substitute the default document component with the custom one for Blacklight 8
+      # (if they haven't configured the document component)
       if blacklight_config.show.document_component.nil? || blacklight_config.show.document_component == Blacklight::DocumentComponent
-        if Blacklight::VERSION > '8'
-          blacklight_config.show.document_component = Spotlight::DocumentComponent
-        else
-          blacklight_config.show.partials.unshift 'curation_mode_toggle'
-        end
+        blacklight_config.show.document_component = Spotlight::DocumentComponent
       end
     end
 
@@ -42,13 +38,9 @@ module Spotlight
                                            partials: [:index_compact],
                                            document_actions: [])
       end
-      blacklight_config.view.admin_table.document_component ||= Spotlight::DocumentAdminTableComponent
 
-      if Blacklight::VERSION > '8'
-        blacklight_config.track_search_session.storage = false
-      else
-        blacklight_config.track_search_session = false
-      end
+      blacklight_config.view.admin_table.document_component ||= Spotlight::DocumentAdminTableComponent
+      blacklight_config.track_search_session.storage = false
 
       unless blacklight_config.sort_fields.key? :timestamp
         blacklight_config.add_sort_field :timestamp, default: true,
@@ -73,7 +65,7 @@ module Spotlight
     # setup within their index analyzer. This will ensure that this method returns
     # results when a partial match is passed in the "q" parameter.
     def autocomplete
-      @response, = search_service.search_results do |builder|
+      @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))
       end
 
@@ -87,7 +79,7 @@ module Spotlight
     def admin
       add_breadcrumb(t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit))
       add_breadcrumb(t(:'spotlight.curation.sidebar.items'), admin_exhibit_catalog_path(@exhibit))
-      (@response,) = search_service.search_results
+      @response = search_service.search_results
       @filters = params[:f] || []
 
       respond_to do |format|

data/app/controllers/spotlight/dashboards_controller.rb

@@ -16,11 +16,7 @@ module Spotlight
 
       blacklight_config.index.document_component = Spotlight::DocumentAdminTableComponent
       blacklight_config.index.document_actions = []
-      if Blacklight::VERSION > '8'
-        blacklight_config.track_search_session.storage = false
-      else
-        blacklight_config.track_search_session = false
-      end
+      blacklight_config.track_search_session.storage = false
     end
 
     def show
@@ -57,7 +53,7 @@ module Spotlight
 
     def load_recent_solr_documents(count)
       solr_params = { sort: "#{blacklight_config.index.timestamp_field} desc" }
-      @response, _docs = search_service.search_results do |builder|
+      @response = search_service.search_results do |builder|
         builder.merge(solr_params)
       end
       @response.documents.take(count)

data/app/controllers/spotlight/exhibits_controller.rb

@@ -5,6 +5,7 @@ module Spotlight
   # Administrative CRUD actions for an exhibit
   class ExhibitsController < Spotlight::ApplicationController
     include Spotlight::SearchHelper
+
     before_action :authenticate_user!, except: [:index]
     before_action :set_tab, only: %i[edit update]
 

data/app/controllers/spotlight/home_pages_controller.rb

@@ -17,7 +17,7 @@ module Spotlight
     end
 
     def show
-      @response, @document_list = search_service.search_results if @page.display_sidebar?
+      @response = search_service.search_results if @page.display_sidebar?
 
       if @page.nil? || !@page.published?
         render '/catalog/index'

data/app/controllers/spotlight/searches_controller.rb

@@ -49,7 +49,7 @@ module Spotlight
 
     def autocomplete
       search_params = autocomplete_params.merge(search_field: Spotlight::Engine.config.autocomplete_search_field)
-      (response, _document_list) = search_service.search_results do |builder|
+      response = search_service.search_results do |builder|
         builder.with(search_params)
       end
 

data/app/controllers/spotlight/solr_controller.rb

@@ -9,6 +9,7 @@ module Spotlight
   # workflows with exhibit-specific content
   class SolrController < Spotlight::ApplicationController
     include Spotlight::SearchHelper
+
     before_action :authenticate_user!
     before_action :validate_writable_index!
 

data/app/helpers/spotlight/main_app_helpers.rb

@@ -4,11 +4,7 @@ module Spotlight
   ##
   # Helpers that are injected into the main application (because they used in layouts)
   module MainAppHelpers
-    if Blacklight.version < '8'
-      include Blacklight::BlacklightHelperBehavior
-    else
-      include Blacklight::DocumentHelperBehavior
-    end
+    include Blacklight::DocumentHelperBehavior
     include Spotlight::NavbarHelper
     include Spotlight::MastheadHelper
 

data/app/helpers/spotlight/rendering_helper.rb

@@ -3,7 +3,10 @@
 module Spotlight
   module RenderingHelper # :nodoc:
     def render_markdown(text)
-      GitHub::Markup.render('.md', text).html_safe
+      # Extend Redcarpet renderer to add HTML anchors to each heading in the output HTML
+      renderer = Redcarpet::Render::HTML.new(with_toc_data: true)
+      # Use Redcarpet to render markdown as html
+      Redcarpet::Markdown.new(renderer).render(text).html_safe
     end
   end
 end

data/app/javascript/spotlight/admin/blocks/pages_block.js

@@ -7,6 +7,8 @@ SirTrevor.Blocks.FeaturedPages = (function(){
 
     icon_name: "pages",
 
+    show_image_selection: false,
+
     autocomplete_url: function() { return document.getElementById(this.instanceID).closest('form[data-autocomplete-exhibit-pages-path]').dataset.autocompleteExhibitPagesPath; },
     autocomplete_fetch: function(url) {
       return this.fetchOnceAndFilterLocalResults(url);

data/app/javascript/spotlight/user/carousel.js

@@ -1,7 +1,37 @@
 export default class {
   connect() {
     if ($.fn.carousel) {
-      $('.carousel').carousel();
+      const $carousel = $('.carousel');
+
+      // updates the aria-describedby on the next and prev btns
+      const updateAriaDescribedBy = function ($carousel) {
+        const $activeItem = $carousel.find('.carousel-item.active');
+        const $items = $carousel.find('.carousel-item');
+        const curIndex = $items.index($activeItem);
+        const prevIndex = (curIndex - 1 + $items.length) % $items.length;
+        const nextIndex = (curIndex + 1) % $items.length;
+
+        const prevDataId = $items.eq(prevIndex).data('id');
+        const nextDataId = $items.eq(nextIndex).data('id');
+        if (prevDataId) {
+          $carousel.find('.carousel-control-prev').attr('aria-describedby', 'carousel-caption-' + prevDataId);
+        }
+        if (nextDataId) {
+          $carousel.find('.carousel-control-next').attr('aria-describedby', 'carousel-caption-' + nextDataId);
+        }
+      };
+
+      // on initial page load, set the aria-describedby on the btns for each carousel
+      $carousel.each(function () {
+        const $this = $(this);
+        $this.carousel();
+        updateAriaDescribedBy($this);
+      });
+
+      // on slide change
+      $carousel.on('slid.bs.carousel', function () {
+        updateAriaDescribedBy($(this));
+      });
     }
   }
-}
+}

data/app/jobs/spotlight/add_tags_job.rb

@@ -5,6 +5,7 @@ module Spotlight
   class AddTagsJob < Spotlight::ApplicationJob
     include Spotlight::JobTracking
     include Spotlight::GatherDocuments
+
     with_job_tracking(resource: ->(job) { job.arguments.last[:exhibit] })
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength

data/app/jobs/spotlight/add_uploads_from_csv.rb

@@ -5,6 +5,7 @@ module Spotlight
   # Process a CSV upload into new Spotlight::Resource::Upload objects
   class AddUploadsFromCsv < Spotlight::ApplicationJob
     include Spotlight::JobTracking
+
     with_job_tracking(resource: ->(job) { job.arguments[1] })
 
     attr_reader :count, :errors

data/app/jobs/spotlight/change_visibility_job.rb

@@ -5,6 +5,7 @@ module Spotlight
   class ChangeVisibilityJob < Spotlight::ApplicationJob
     include Spotlight::JobTracking
     include Spotlight::GatherDocuments
+
     with_job_tracking(resource: ->(job) { job.arguments.last[:exhibit] })
 
     # rubocop:disable Metrics/MethodLength