blacklight-spotlight 3.0.0.rc1 → 3.0.0.rc6

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

@@ -30,6 +30,25 @@ module Spotlight
       current_site.title if current_site.title.present?
     end
 
+    # Returns the url for the current page in the new locale. This may be
+    # overridden in downstream applications where our naive use of `url_for`
+    # is insufficient to generate the expected routes
+    def current_page_for_locale(locale)
+      initial_exception = nil
+
+      ([self] + additional_locale_routing_scopes).each do |scope|
+        return scope.public_send(:url_for, params.to_unsafe_h.merge(locale: locale))
+      rescue ActionController::UrlGenerationError => e
+        initial_exception ||= e
+      end
+
+      raise initial_exception
+    end
+
+    def additional_locale_routing_scopes
+      [spotlight, main_app]
+    end
+
     # Can search for named routes directly in the main app, omitting
     # the "main_app." prefix
     def method_missing(method, *args, &block)
@@ -73,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.filter(:exhibit_tags).add(tag).params)
       else
         search_action_url(q: tag)
       end
@@ -132,7 +151,7 @@ module Spotlight
 
     def uploaded_field_label(config)
       solr_field = Array(config.solr_field || config.field_name).first.to_s
-      blacklight_config.index_fields[solr_field].try(:label) || config.label || t(".#{solr_field}")
+      blacklight_config.index_fields[solr_field]&.label || config.label || t(".#{solr_field}")
     end
 
     def available_view_fields

data/app/helpers/spotlight/crud_link_helpers.rb

@@ -112,7 +112,7 @@ module Spotlight
       defaults << :"helpers.action.#{object_name}.#{key}"
       defaults << :"helpers.action.#{key}"
       defaults << "#{key.to_s.humanize} #{model}"
-      I18n.t(defaults.shift, model: model, default: defaults)
+      I18n.t(defaults.shift, model: model.downcase, default: defaults)
     end
     # rubocop:enable Metrics/MethodLength
   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/main_app_helpers.rb

@@ -24,16 +24,15 @@ module Spotlight
     end
 
     def link_back_to_catalog(opts = { label: nil })
-      opts[:route_set] ||= spotlight if (current_search_session.try(:query_params) || {}).fetch(:controller, '').starts_with? 'spotlight'
+      opts[:route_set] ||= spotlight if (current_search_session&.query_params || {}).fetch(:controller, '').starts_with? 'spotlight'
       super
     end
 
-    def presenter(document)
-      case action_name
-      when 'index'
+    def document_presenter_class(_document)
+      if action_name == 'index'
         super
       else
-        show_presenter(document)
+        blacklight_config.view_config(action_name: :show).document_presenter_class
       end
     end
 

data/app/helpers/spotlight/meta_helper.rb

@@ -81,7 +81,7 @@ module Spotlight
     end
 
     def document_twitter_card_content(document)
-      presenter = show_presenter(document)
+      presenter = document_presenter(document)
 
       twitter_card('summary_large_image') do |card|
         card.title presenter.heading
@@ -90,7 +90,7 @@ module Spotlight
     end
 
     def document_opengraph_content(document)
-      presenter = show_presenter(document)
+      presenter = document_presenter(document)
 
       opengraph do |graph|
         graph.site_name application_name

data/app/helpers/spotlight/pages_helper.rb

@@ -21,7 +21,7 @@ module Spotlight
     # a more complete markdown rendered
     def sir_trevor_markdown(text)
       clean_text = if text
-                     text.gsub('<br>', "\n").gsub('<p>', '').gsub('</p>', "\n\n")
+                     text.gsub('<br>', "\n\n").gsub('<p>', '').gsub('</p>', "\n\n")
                    else
                      ''
                    end
@@ -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/helpers/spotlight/searches_helper.rb

@@ -4,7 +4,7 @@ module Spotlight
   # Saved search helpers
   module SearchesHelper
     def available_document_index_views
-      blacklight_config.view.to_h.reject { |_k, v| v.if == false }.keys
+      blacklight_config.view.to_h.reject { |_k, v| v.if == false }
     end
   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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Job status tracking
+  module JobTracking
+    extend ActiveSupport::Concern
+    include ActiveJob::Status
+
+    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'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Job status tracking
+  module LimitConcurrency
+    extend ActiveSupport::Concern
+
+    VALIDITY_TOKEN_PARAMETER = 'validity_token'
+
+    included do
+      # The validity checker is a seam for implementations to expire unnecessary
+      # indexing tasks if it becomes redundant while waiting in the job queue.
+      class_attribute :validity_checker, default: Spotlight::ValidityChecker.new
+
+      before_enqueue do |job|
+        token = job.arguments.last[VALIDITY_TOKEN_PARAMETER] if job.arguments.last.is_a?(Hash)
+        token ||= validity_checker.mint(job)
+
+        job.arguments << {} unless job.arguments.last.is_a? Hash
+        job.arguments.last[VALIDITY_TOKEN_PARAMETER] = token
+      end
+
+      before_perform do |job|
+        next unless job.arguments.last.is_a?(Hash)
+
+        token = job.arguments.last.delete(VALIDITY_TOKEN_PARAMETER)
+        throw(:abort) unless token.nil? || validity_checker.check(job, validity_token: token)
+
+        job.arguments.pop if job.arguments.last.empty?
+      end
+    end
+  end
+end

data/app/jobs/spotlight/add_tags_job.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+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
+    def perform(solr_params:, exhibit:, tags:, **)
+      @errors = 0
+
+      each_document(solr_params, exhibit) do |document|
+        sidecar = document.sidecar(exhibit)
+        all_tags = sidecar.all_tags_list
+        all_tags += tags
+        exhibit.tag(document.sidecar(exhibit), with: all_tags, on: :tags)
+        document.reindex(update_params: {})
+        progress&.increment
+      rescue StandardError => e
+        job_tracker.append_log_entry(type: :error, exhibit: exhibit, message: e.to_s)
+        @errors += 1
+        mark_job_as_failed!
+      end
+      exhibit.blacklight_config.repository.connection.commit
+      job_tracker.append_log_entry(type: :info, exhibit: exhibit, message: "#{progress.progress} of #{progress.total} (#{@errors} errors)")
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end

data/app/jobs/spotlight/add_uploads_from_csv.rb

@@ -3,12 +3,13 @@
 module Spotlight
   ##
   # Process a CSV upload into new Spotlight::Resource::Upload objects
-  class AddUploadsFromCsv < ActiveJob::Base
+  class AddUploadsFromCsv < Spotlight::ApplicationJob
+    include Spotlight::JobTracking
+    with_job_tracking(resource: ->(job) { job.arguments[1] })
+
     attr_reader :count
     attr_reader :errors
 
-    queue_as :default
-
     after_perform do |job|
       csv_data, exhibit, user = job.arguments
       Spotlight::IndexingCompleteMailer.documents_indexed(

data/app/jobs/spotlight/application_job.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # :nodoc:
+  class ApplicationJob < ActiveJob::Base
+    queue_as :default
+  end
+end

data/app/jobs/spotlight/change_visibility_job.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+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
+    def perform(solr_params:, exhibit:, visibility:, **)
+      @errors = 0
+
+      each_document(solr_params, exhibit) do |document|
+        case visibility
+        when 'public'
+          document.make_public!(exhibit)
+        when 'private'
+          document.make_private!(exhibit)
+        end
+        document.reindex(update_params: {})
+        progress&.increment
+      rescue StandardError => e
+        job_tracker.append_log_entry(type: :error, exhibit: exhibit, message: e.to_s)
+        @errors += 1
+        mark_job_as_failed!
+      end
+      exhibit.blacklight_config.repository.connection.commit
+      job_tracker.append_log_entry(type: :info, exhibit: exhibit, message: "#{progress.progress} of #{progress.total} (#{@errors} errors)")
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end