blacklight-spotlight 3.0.0.rc4 → 3.0.0.rc5

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/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

@@ -47,6 +47,7 @@ module Spotlight
 
     def swap_actions_configuration
       blacklight_config.index.document_actions = blacklight_config.browse.document_actions
+      blacklight_config.action_mapping.show.top_level_config = :index if blacklight_config.key?(:action_mapping)
     end
 
     def search_query
@@ -134,5 +135,9 @@ module Spotlight
     def render_save_this_search?
       false
     end
+
+    def render_curator_actions?
+      false
+    end
   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

@@ -126,15 +126,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
 
@@ -204,7 +200,9 @@ module Spotlight
     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

data/app/controllers/spotlight/dashboards_controller.rb

@@ -15,6 +15,7 @@ module Spotlight
       blacklight_config.view.admin_table.partials = ['index_compact']
       blacklight_config.view.admin_table.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/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

data/app/helpers/spotlight/application_helper.rb

@@ -92,7 +92,7 @@ module Spotlight
     # Helper to turn tag data into facets
     def url_to_tag_facet(tag)
       if current_exhibit
-        search_action_url(search_state.reset.add_facet_params(blacklight_config.document_model.solr_field_for_tagger(current_exhibit), tag))
+        search_action_url(search_state.reset.add_facet_params(:exhibit_tags, tag))
       else
         search_action_url(q: tag)
       end

data/app/helpers/spotlight/job_trackers_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # HTML <meta> tag helpers
+  module JobTrackersHelper
+    def job_status_icon(job_tracker)
+      content_tag :span, title: t(job_tracker.status || 'missing', scope: 'spotlight.job_trackers.status') do # rubocop:disable Rails/ContentTag
+        if job_tracker.enqueued? || job_tracker.in_progress?
+          '⏱'
+        elsif job_tracker.completed?
+          '✅'
+        elsif job_tracker.failed?
+          '🟥'
+        else
+          ''
+        end
+      end
+    end
+
+    def job_tracker_event_table_row_class(event)
+      case event.type
+      when 'error'
+        'table-danger'
+      when 'info', 'summary'
+        ''
+      else
+        "table-#{event.type}"
+      end
+    end
+  end
+end

data/app/helpers/spotlight/pages_helper.rb

@@ -29,13 +29,6 @@ module Spotlight
       render_markdown(clean_text)
     end
 
-    def available_index_fields
-      fields = blacklight_config.index_fields.map { |k, _v| { key: k, label: index_field_label(blacklight_config.document_model.new, k) } }
-      fields.unshift(key: document_show_link_field, label: t(:'spotlight.pages.form.title_placeholder')) unless index_fields.include? document_show_link_field
-
-      fields
-    end
-
     def disable_save_pages_button?
       page_collection_name == 'about_pages' && @pages.empty?
     end

data/app/helpers/spotlight/roles_helper.rb

@@ -7,7 +7,7 @@ module Spotlight
     ##
     # Format the available roles for a select_tag
     def roles_for_select
-      Spotlight::Role::ROLES.each_with_object({}) do |key, object|
+      Spotlight::Engine.config.exhibit_roles.each_with_object({}) do |key, object|
         object[t("spotlight.role.#{key}")] = key
       end
     end

data/app/jobs/concerns/spotlight/gather_documents.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Gather documents by a given query that can be used in a job
+  # Will also increment job tracking total
+  module GatherDocuments
+    extend ActiveSupport::Concern
+
+    # rubocop:disable Metrics/MethodLength
+    def each_document(solr_params, exhibit, &block)
+      return to_enum(:each_document, solr_params, exhibit) unless block_given?
+
+      cursor_mark = nil
+      next_cursor_mark = '*'
+
+      until next_cursor_mark == cursor_mark || next_cursor_mark.nil?
+        cursor_mark = next_cursor_mark
+        response = exhibit.blacklight_config.repository.search(
+          solr_params.merge(
+            'rows' => Spotlight::Engine.config.bulk_actions_batch_size,
+            'cursorMark' => cursor_mark,
+            'sort' => "#{exhibit.blacklight_config.document_model.unique_key} asc"
+          )
+        )
+        progress.total = response.total
+        response.documents.each do |document|
+          block.call(document)
+        end
+
+        next_cursor_mark = response['nextCursorMark']
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/app/jobs/concerns/spotlight/job_tracking.rb

@@ -6,42 +6,59 @@ module Spotlight
     extend ActiveSupport::Concern
     include ActiveJob::Status
 
-    def self.with_job_tracking
-      before_perform :find_or_initialize_job_tracker
-      after_perform :finalize_job_tracker
+    class_methods do
+      # @param resource [Proc] receives the job and returns the resource connect to the job tracking status
+      # @param reports_on [Proc] optional, receives the job and returns a Spotlight::JobTracker to "roll up" statuses to
+      # @param user [Proc] optional, receives the job and returns the User that initiated the job
+      def with_job_tracking(
+        resource:,
+        reports_on: ->(job) { job.arguments.last[:reports_on] if job.arguments.last.is_a?(Hash) },
+        user: ->(job) { job.arguments.last[:user] if job.arguments.last.is_a?(Hash) }
+      )
+        around_perform do |job, block|
+          resource_object = resource&.call(job)
+
+          job.initialize_job_tracker!(
+            resource: resource_object,
+            on: reports_on&.call(job) || resource_object,
+            user: user&.call(job)
+          )
+
+          block.call
+        ensure
+          job.finalize_job_tracker!
+        end
+      end
+    end
+
+    def mark_job_as_failed!
+      @failed = true
     end
 
     def job_tracker
       @job_tracker ||= find_or_initialize_job_tracker
     end
 
+    def initialize_job_tracker!(**params)
+      job_tracker.update(params.merge(status: 'in_progress').compact)
+    end
+
+    def finalize_job_tracker!
+      return unless job_tracker.status == 'in_progress' || job_tracker.status == 'enqueued'
+
+      job_tracker.update(
+        status: @failed ? 'failed' : 'completed',
+        data: { progress: progress.progress, total: progress.total }
+      )
+    end
+
     private
 
     def find_or_initialize_job_tracker
       JobTracker.find_or_create_by(job_id: job_id) do |tracker|
         tracker.job_class = self.class.name
         tracker.status = 'enqueued'
-        update_job_tracker_properties(tracker)
       end
     end
-
-    def finalize_job_tracker
-      job_tracker.update(status: 'completed') if job_tracker.status == 'enqueued'
-    end
-
-    def update_job_tracker_properties(tracker)
-      tracker.resource = job_tracking_resource
-      tracker.on = reports_on_resource || tracker.resource
-
-      tracker.user = arguments.last[:user] if arguments.last.is_a?(Hash)
-    end
-
-    def job_tracking_resource
-      arguments.first
-    end
-
-    def reports_on_resource
-      arguments.last[:reports_on] if arguments.last.is_a?(Hash)
-    end
   end
 end