blacklight-spotlight 3.0.0.rc4 → 3.0.2

data/app/builders/spotlight/bootstrap_breadcrumbs_builder.rb

@@ -21,10 +21,12 @@ 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
 

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/spotlight/browse_controller.rb

@@ -15,13 +15,15 @@ module Spotlight
     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'
+      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
@@ -31,15 +33,11 @@ module Spotlight
 
     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
 
@@ -47,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
 
     ##
@@ -127,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,8 +27,7 @@ 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
 
       unless blacklight_config.sort_fields.key? :timestamp
@@ -38,8 +37,7 @@ module Spotlight
     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
@@ -126,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: '')
+        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
 
@@ -203,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
@@ -218,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/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.job_trackers.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/featured_images_controller.rb

@@ -16,7 +16,7 @@ module Spotlight
     private
 
     def tilesource
-      riiif.info_url(@featured_image.id)
+      riiif.info_url(@featured_image)
     end
 
     # The create action can be called from a number of different forms, so

data/app/controllers/spotlight/job_trackers_controller.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ##
+  # Locking mechanism for page-level locks
+  class JobTrackersController < Spotlight::ApplicationController
+    load_and_authorize_resource :exhibit
+    load_and_authorize_resource through: :exhibit
+
+    # GET /:exhibit_id/job_trackers/1
+    def show
+      add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), @exhibit
+      add_breadcrumb t(:'spotlight.curation.sidebar.dashboard'), exhibit_dashboard_path(@exhibit)
+      add_breadcrumb t(:'spotlight.configuration.sidebar.job_trackers'), [@job_tracker.on, @job_tracker]
+    end
+  end
+end

data/app/controllers/spotlight/pages_controller.rb

@@ -17,9 +17,11 @@ module Spotlight
     include Spotlight::Base
     include Blacklight::SearchContext
 
-    helper_method :get_search_results, :search_results, :fetch, :page_collection_name, :presenter
+    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.view.gallery.classes = 'row-cols-2 row-cols-md-4' unless @page&.display_sidebar
     end
 
@@ -63,7 +65,8 @@ module Spotlight
       @page.last_edited_by = @page.created_by = current_user
 
       if @page.save
-        redirect_to [spotlight, @page.exhibit, page_collection_name], notice: t(:'helpers.submit.page.created', model: @page.class.model_name.human.downcase)
+        redirect_to [spotlight, @page.exhibit, page_collection_name.to_sym],
+                    notice: t(:'helpers.submit.page.created', model: @page.class.model_name.human.downcase)
       else
         render action: 'new'
       end
@@ -84,7 +87,7 @@ module Spotlight
     def destroy
       @page.destroy
 
-      redirect_to [spotlight, @page.exhibit, page_collection_name], flash: { html_safe: true }, notice: undo_notice(:destroyed)
+      redirect_to [spotlight, @page.exhibit, page_collection_name.to_sym], flash: { html_safe: true }, notice: undo_notice(:destroyed)
     end
 
     def update_all
@@ -204,10 +207,6 @@ module Spotlight
         raise ActiveRecord::RecordNotFound
       end
     end
-
-    def presenter(document)
-      view_context.index_presenter(document)
-    end
   end
   # rubocop:enable Metrics/ClassLength
 end

data/app/controllers/spotlight/tags_controller.rb

@@ -6,9 +6,13 @@ module Spotlight
   class TagsController < Spotlight::ApplicationController
     before_action :authenticate_user!
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
+    load_resource :tag, through: :exhibit, through_association: :owned_tags, except: [:index], class: 'ActsAsTaggableOn::Tag'
 
-    def index
+    before_action do
       authorize! :tag, @exhibit
+    end
+
+    def index
       @tags = @exhibit.owned_tags
       add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), @exhibit
       add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit)
@@ -16,16 +20,46 @@ module Spotlight
 
       respond_to do |format|
         format.html
-        format.json { render json: @exhibit.owned_tags.map(&:name) }
+        format.json { render json: @tags.map(&:name) }
       end
     end
 
     def destroy
-      authorize! :tag, @exhibit
-      # warning: this causes every solr document with this tag to reindex.  That could be slow.
-      @exhibit.owned_taggings.where(tag_id: params[:id]).destroy_all
+      Spotlight::RenameTagsJob.perform_later(@exhibit, @tag, to: nil)
 
       redirect_to exhibit_tags_path(@exhibit)
     end
+
+    def rename
+      Spotlight::RenameTagsJob.perform_later(@exhibit, @tag, to: params[:new_tag])
+
+      redirect_to exhibit_tags_path(@exhibit)
+    end
+
+    def update_all
+      tags_to_rename = batch_update_params['owned_tags_attributes'].values.select do |tag|
+        tag[:name]&.present? && tag[:current_name]&.strip != tag[:name]&.strip
+      end
+
+      rename_tags_later!(tags_to_rename)
+
+      redirect_back fallback_location: fallback_url, notice: t(:'helpers.submit.tags.batch_updated', count: tags_to_rename.count)
+    end
+
+    private
+
+    def rename_tags_later!(tags_to_rename)
+      tags_to_rename.each do |tag|
+        Spotlight::RenameTagsJob.perform_later(@exhibit, @exhibit.owned_tags.find(tag[:id]), to: tag[:name])
+      end
+    end
+
+    def fallback_url
+      spotlight.exhibit_tags_path(@exhibit)
+    end
+
+    def batch_update_params
+      params.require(:exhibit).permit('owned_tags_attributes' => %i[id current_name name])
+    end
   end
 end