blacklight-spotlight 3.0.0.rc2 → 3.0.0

data/app/builders/spotlight/bootstrap_breadcrumbs_builder.rb

@@ -21,18 +21,19 @@ module Spotlight
     end
 
     def render_element(element)
-      html_class = 'active' if @context.current_page?(compute_path(element))
+      current = @context.current_page?(compute_path(element)) || element.options&.dig(:current)
+
+      html_class = 'active' if current
 
       @context.content_tag(:li, class: "breadcrumb-item #{html_class}") do
-        @context.link_to_unless_current(element_label(element), compute_path(element), element.options)
+        @context.link_to_unless(current, element_label(element), compute_path(element), element.options&.except(:current))
       end
     end
 
     private
 
     def element_label(element)
-      label = compute_name(element)
-      @context.truncate(label, escape: !label.html_safe?, length: 30, separator: ' ')
+      @context.content_tag(:span, class: 'truncated-value') { compute_name(element) }
     end
   end
 end

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

@@ -32,7 +32,7 @@ module Spotlight
     def autocomplete_json_response_for_document(doc)
       {
         id: doc.id,
-        title: CGI.unescapeHTML(view_context.presenter(doc).heading.to_str),
+        title: CGI.unescapeHTML(view_context.document_presenter(doc).heading.to_str),
         thumbnail: doc.first(blacklight_config.index.thumbnail_field),
         full_image_url: doc.first(Spotlight::Engine.config.full_image_field),
         description: doc.id,

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

@@ -14,20 +14,26 @@ module Spotlight
 
     # Adds a facet to display document visibility for the current exhibit
     # if the user is a curator
+    # rubocop:disable Metrics/MethodLength
     def add_facet_visibility_field
       return unless current_exhibit && can?(:curate, current_exhibit)
 
       blacklight_config.add_facet_field 'exhibit_visibility',
                                         label: I18n.t(:'spotlight.catalog.facets.exhibit_visibility.label'),
                                         query: {
+                                          public: {
+                                            label: I18n.t(:'spotlight.catalog.facets.exhibit_visibility.public'),
+                                            fq: "-#{blacklight_config.document_model.visibility_field(current_exhibit)}:false"
+                                          },
                                           private: {
                                             label: I18n.t(:'spotlight.catalog.facets.exhibit_visibility.private'),
                                             fq: "#{blacklight_config.document_model.visibility_field(current_exhibit)}:false"
                                           }
                                         }
     end
+    # rubocop:enable Metrics/MethodLength
 
-    def render_save_this_search?
+    def render_curator_actions?
       (current_exhibit && can?(:curate, current_exhibit)) &&
         !(params[:controller] == 'spotlight/catalog' && params[:action] == 'admin')
     end

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

@@ -4,15 +4,9 @@ module Spotlight
   # ...
   module SearchHelper
     def search_service(user_params = respond_to?(:search_state, true) ? search_state.to_h : {})
-      search_service_class.new(config: blacklight_config, user_params: user_params, **search_service_context)
-    end
+      klass = respond_to?(:search_service_class) ? search_service_class : Blacklight::SearchService
 
-    def search_service_class
-      if defined?(super)
-        super
-      else
-        Blacklight::SearchService
-      end
+      klass.new(config: blacklight_config, user_params: user_params, **search_service_context)
     end
 
     # @return [Hash] a hash of context information to pass through to the search service

data/app/controllers/spotlight/appearances_controller.rb

@@ -30,18 +30,5 @@ module Spotlight
                                       masthead_attributes: featured_image_params,
                                       thumbnail_attributes: featured_image_params)
     end
-
-    def featured_image_params
-      %i[
-        iiif_region iiif_tilesource
-        iiif_manifest_url iiif_canvas_id
-        iiif_image_id
-        display
-        source
-        image
-        document_global_id
-        upload_id
-      ]
-    end
   end
 end

data/app/controllers/spotlight/browse_controller.rb

@@ -9,34 +9,35 @@ module Spotlight
     include Spotlight::Catalog
     include Blacklight::Facet
 
-    load_and_authorize_resource :search, except: :index, through: :exhibit, parent: false
+    load_and_authorize_resource :group, through: :exhibit
+    load_and_authorize_resource :search, through: %i[group exhibit], parent: false
     before_action :attach_breadcrumbs
     before_action :attach_search_breadcrumb, only: :show
     record_search_parameters only: :show
 
-    helper_method :should_render_spotlight_search_bar?, :presenter
+    helper_method :should_render_spotlight_search_bar?
 
     before_action :swap_actions_configuration, only: :show
 
     before_action do
       blacklight_config.track_search_session = 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
     end
 
     def index
-      @searches = @exhibit.searches.published
+      @groups = @exhibit.groups.published
+      @searches = @searches.published
     end
 
     def show
       @response, @document_list = search_service.search_results do |builder|
-        builder.with(search_query)
+        builder.with(params.merge(browse_category_id: @search.id))
       end
 
       respond_to do |format|
         format.html
-        format.json do
-          @presenter = Blacklight::JsonPresenter.new(@response, blacklight_config)
-          render template: 'catalog/index'
-        end
       end
     end
 
@@ -44,11 +45,7 @@ module Spotlight
 
     def swap_actions_configuration
       blacklight_config.index.document_actions = blacklight_config.browse.document_actions
-    end
-
-    def search_query
-      @search.query_params['q'] = [@search.query_params['q'], params[:browse_q]].join(' ')
-      @search.merge_params_for_search(params, blacklight_config)
+      blacklight_config.action_mapping.show.top_level_config = :index if blacklight_config.key?(:action_mapping)
     end
 
     ##
@@ -66,10 +63,11 @@ module Spotlight
     def attach_breadcrumbs
       add_breadcrumb t(:'spotlight.curation.nav.home', title: @exhibit.title), @exhibit
       add_breadcrumb(@exhibit.main_navigations.browse.label_or_default, exhibit_browse_index_path(@exhibit))
+      add_breadcrumb(@group.title, exhibit_browse_groups_path(@exhibit, @group)) if @group.present?
     end
 
     def attach_search_breadcrumb
-      add_breadcrumb @search.full_title, exhibit_browse_path(@exhibit, @search)
+      add_breadcrumb @search.full_title, (@group.present? ? exhibit_browse_group_path(@exhibit, @group, @search) : exhibit_browse_path(@exhibit, @search))
     end
 
     def _prefixes
@@ -123,11 +121,11 @@ module Spotlight
       Spotlight::Engine.config.default_browse_index_view_type
     end
 
-    def presenter(document)
-      view_context.index_presenter(document)
+    def render_save_this_search?
+      false
     end
 
-    def render_save_this_search?
+    def render_curator_actions?
       false
     end
   end

data/app/controllers/spotlight/bulk_actions_controller.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ##
+  # Controller enabling bulk functionality for search results
+  class BulkActionsController < Spotlight::CatalogController
+    before_action :authenticate_user!
+    before_action :check_authorization
+
+    def add_tags
+      handle_bulk_action_with_job(Spotlight::AddTagsJob, tags: add_tags_params)
+    end
+
+    def remove_tags
+      handle_bulk_action_with_job(Spotlight::RemoveTagsJob, tags: remove_tags_params)
+    end
+
+    def change_visibility
+      handle_bulk_action_with_job(Spotlight::ChangeVisibilityJob, visibility: change_visibility_params)
+    end
+
+    private
+
+    def handle_bulk_action_with_job(job, i18n_key: action_name, **params)
+      job.perform_later(
+        solr_params: solr_params,
+        exhibit: current_exhibit,
+        user: current_user,
+        **params
+      )
+
+      redirect_back fallback_location: spotlight.search_exhibit_catalog_path(current_search_session.query_params),
+                    notice: t(:"spotlight.bulk_actions.#{i18n_key}.changed", count: solr_response.total)
+    end
+
+    def solr_params
+      solr_response.request_params
+    end
+
+    def solr_response
+      @solr_response ||= begin
+        response, _docs = search_service.search_results do |builder|
+          builder.merge(fl: 'id', rows: 0)
+        end
+
+        response
+      end
+    end
+
+    def add_tags_params
+      params.require(:tags).split(',').map(&:strip)
+    end
+
+    def remove_tags_params
+      params.require(:tags).split(',').map(&:strip)
+    end
+
+    def change_visibility_params
+      params.require(:visibility)
+    end
+  end
+end

data/app/controllers/spotlight/bulk_updates_controller.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module Spotlight
+  ##
+  # Controller enabling bulk functionality for items defined in a spreadsheet.
+  class BulkUpdatesController < Spotlight::ApplicationController
+    before_action :authenticate_user!
+    before_action :check_authorization
+
+    def edit; end
+
+    def download_template
+      # Set Last-Modified as a work-around for https://github.com/rack/rack/issues/1619
+      headers['Last-Modified'] = ''
+      headers['Cache-Control'] = 'no-cache'
+      headers['Content-Type'] = 'text/csv'
+      headers['Content-Disposition'] = "attachment; filename=\"#{current_exhibit.slug}-bulk-update-template.csv\""
+      headers.delete('Content-Length')
+
+      self.response_body = csv_template
+    end
+
+    def update
+      bulk_update = Spotlight::BulkUpdate.new(exhibit: current_exhibit, file: file_params)
+      if bulk_update.save
+        ProcessBulkUpdatesCsvJob.perform_later(current_exhibit, bulk_update)
+        redirect_back fallback_location: spotlight.edit_exhibit_bulk_updates_path(current_exhibit), notice: t(:'spotlight.bulk_updates.update.submitted')
+      else
+        redirect_back fallback_location: spotlight.edit_exhibit_bulk_updates_path(current_exhibit), alert: t(:'spotlight.bulk_updates.update.error')
+      end
+    end
+
+    def monitor
+      render json: BackgroundJobProgress.new(current_exhibit, job_class: Spotlight::ProcessBulkUpdatesCsvJob)
+    end
+
+    private
+
+    def csv_template
+      boolean = ActiveModel::Type::Boolean.new
+      Spotlight::BulkUpdatesCsvTemplateService.new(exhibit: current_exhibit).template(
+        view_context: view_context,
+        title: boolean.cast(reference_field_params[:item_title]),
+        tags: boolean.cast(updatable_field_params[:tags]),
+        visibility: boolean.cast(updatable_field_params[:visibility])
+      )
+    end
+
+    def reference_field_params
+      params.require(:reference_fields).permit(:item_title)
+    end
+
+    def updatable_field_params
+      params.require(:updatable_fields).permit(:visibility, :tags)
+    end
+
+    def file_params
+      params.require(:file)
+    end
+
+    def check_authorization
+      authorize! :bulk_update, current_exhibit
+    end
+  end
+end

data/app/controllers/spotlight/catalog_controller.rb

@@ -27,16 +27,17 @@ module Spotlight
 
     before_action only: :admin do
       blacklight_config.view.select! { |k, _v| k == :admin_table }
-      blacklight_config.view.admin_table.partials = [:index_compact]
-      blacklight_config.view.admin_table.document_actions = []
+      blacklight_config.view.admin_table(partials: [:index_compact], document_actions: []) unless blacklight_config.view.key? :admin_table
       blacklight_config.track_search_session = false
 
-      blacklight_config.add_sort_field :timestamp, sort: "#{blacklight_config.index.timestamp_field} desc" unless blacklight_config.sort_fields.key? :timestamp
+      unless blacklight_config.sort_fields.key? :timestamp
+        blacklight_config.add_sort_field :timestamp, default: true,
+                                                     sort: "#{blacklight_config.index.timestamp_field} desc"
+      end
     end
 
     before_action only: :edit do
-      blacklight_config.view.edit.partials = blacklight_config.view_config(:show).partials.dup
-      blacklight_config.view.edit.partials.insert(2, :edit)
+      blacklight_config.view.edit(partials: blacklight_config.view_config(:show).partials.dup.insert(2, :edit)) unless blacklight_config.view.key? :edit
     end
 
     def show
@@ -123,15 +124,11 @@ module Spotlight
     protected
 
     def attach_breadcrumbs
-      # The "q: ''" is necessary so that the breadcrumb builder recognizes that a path like this:
-      # /exhibits/1?f%5Bgenre_sim%5D%5B%5D=map&q= is not the same as /exhibits/1
-      # Otherwise the exhibit breadcrumb won't be a link.
-      # see http://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-current_page-3F
-      if view_context.current_page?(action: :admin)
-        add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), exhibit_root_path(@exhibit, q: '')
+      if view_context.current_page?({ action: :admin })
+        add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), exhibit_root_path(@exhibit)
       else
         # When not on the admin page, get the translated value for the "Home" breadcrumb
-        add_breadcrumb t(:'spotlight.curation.nav.home', title: @exhibit.title), exhibit_root_path(@exhibit, q: '')
+        add_breadcrumb t(:'spotlight.curation.nav.home', title: @exhibit.title), exhibit_root_path(@exhibit)
       end
     end
 
@@ -200,8 +197,14 @@ module Spotlight
       redirect_to spotlight.exhibit_root_path(@exhibit) unless has_search_parameters?
     end
 
+    def has_search_parameters? # rubocop:disable Naming/PredicateName
+      super || params[:browse_category_id].present?
+    end
+
     def add_breadcrumb_with_search_params
-      add_breadcrumb t(:'spotlight.catalog.breadcrumb.index'), spotlight.search_exhibit_catalog_path(params.to_unsafe_h) if has_search_parameters?
+      return unless has_search_parameters?
+
+      add_breadcrumb t(:'spotlight.catalog.breadcrumb.index'), spotlight.search_exhibit_catalog_path(params.to_unsafe_h), current: action_name == 'index'
     end
 
     # rubocop:disable Metrics/AbcSize
@@ -215,7 +218,7 @@ module Spotlight
         add_breadcrumb t(:'spotlight.catalog.breadcrumb.index'), search_action_url(current_search_session.query_params)
       end
 
-      add_breadcrumb view_context.show_presenter(document).heading, polymorphic_path([current_exhibit, document])
+      add_breadcrumb view_context.document_presenter(document).heading, polymorphic_path([current_exhibit, document])
     end
     # rubocop:enable Metrics/AbcSize
 

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

@@ -38,7 +38,6 @@ module Spotlight
         end
       end
 
-      # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       def field_enabled?(field, *args)
         if !field.enabled
           false
@@ -52,7 +51,6 @@ module Spotlight
           field.send(document_index_view_type)
         end
       end
-      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
       private
 
@@ -82,6 +80,19 @@ module Spotlight
       def default_document_index_view_type
         document_index_views.select { |_k, config| config.respond_to?(:default) && config.default }.keys.first || document_index_views.keys.first
       end
+
+      def featured_image_params
+        %i[
+          iiif_region iiif_tilesource
+          iiif_manifest_url iiif_canvas_id
+          iiif_image_id
+          display
+          source
+          image
+          document_global_id
+          upload_id
+        ]
+      end
     end
   end
 end

data/app/controllers/spotlight/dashboards_controller.rb

@@ -11,10 +11,11 @@ module Spotlight
     include Spotlight::SearchHelper
 
     before_action only: [:show] do
-      blacklight_config.view.reject! { |_k, _v| true }
-      blacklight_config.view.admin_table.partials = ['index_compact']
-      blacklight_config.view.admin_table.document_actions = []
+      blacklight_config.action_mapping&.delete(:show)
+      blacklight_config.view.clear
+      blacklight_config.view.admin_table(partials: ['index_compact'], document_actions: [])
       blacklight_config.track_search_session = false
+      blacklight_config.action_mapping.show.top_level_config = :index if blacklight_config.key?(:action_mapping)
     end
 
     def show
@@ -22,7 +23,7 @@ module Spotlight
 
       @pages = @exhibit.pages.recent.limit(5)
       @solr_documents = load_recent_solr_documents 5
-      @recent_reindexing = @exhibit.reindexing_log_entries.recent
+      @recent_reindexing = @exhibit.job_trackers.where.not(job_class: Spotlight::Engine.config.hidden_job_classes).recent
 
       attach_dashboard_breadcrumbs
     end

data/app/controllers/spotlight/exhibits_controller.rb

@@ -27,7 +27,7 @@ module Spotlight
     end
 
     def process_import
-      if @exhibit.import(JSON.parse(import_exhibit_params.read)) && @exhibit.reindex_later
+      if @exhibit.import(JSON.parse(import_exhibit_params.read)) && @exhibit.reindex_later(current_user)
         redirect_to spotlight.exhibit_dashboard_path(@exhibit), notice: t(:'helpers.submit.exhibit.updated', model: @exhibit.class.model_name.human.downcase)
       else
         render action: :import