blacklight-spotlight 3.0.0.alpha.9 → 3.0.0.rc4

data/app/controllers/spotlight/pages_controller.rb

@@ -19,6 +19,10 @@ module Spotlight
 
     helper_method :get_search_results, :search_results, :fetch, :page_collection_name, :presenter
 
+    before_action do
+      blacklight_config.view.gallery.classes = 'row-cols-2 row-cols-md-4' unless @page&.display_sidebar
+    end
+
     # GET /exhibits/1/pages
     def index
       # set up a model the inline "add a new page" form
@@ -70,7 +74,7 @@ module Spotlight
       @page.lock&.delete
 
       if @page.update(page_params.merge(last_edited_by: current_user))
-        redirect_to [spotlight, @page.exhibit, @page], flash: { html_safe: true }, notice: undo_notice(:updated)
+        redirect_to [spotlight, @page.exhibit, @page, format: params.permit(:format)], flash: { html_safe: true }, notice: undo_notice(:updated)
       else
         render action: 'edit'
       end
@@ -146,14 +150,7 @@ module Spotlight
     end
 
     def allowed_page_params
-      [:title, :content, thumbnail_attributes: featured_image_attributes]
-    end
-
-    def featured_image_attributes
-      %i[
-        source image document_global_id iiif_region iiif_tilesource
-        iiif_manifest_url iiif_canvas_id iiif_image_id
-      ]
+      [:title, :content, thumbnail_attributes: featured_image_params]
     end
 
     def human_name

data/app/controllers/spotlight/resources/csv_upload_controller.rb

@@ -16,7 +16,7 @@ module Spotlight
 
       def create
         csv = CSV.parse(csv_io_param, headers: true, return_headers: false).map(&:to_hash)
-        Spotlight::AddUploadsFromCSV.perform_later(csv, current_exhibit, current_user)
+        Spotlight::AddUploadsFromCsv.perform_later(csv, current_exhibit, current_user)
         flash[:notice] = t('spotlight.resources.upload.csv.success', file_name: csv_io_name)
         redirect_to spotlight.admin_exhibit_catalog_path(current_exhibit)
       end

data/app/controllers/spotlight/searches_controller.rb

@@ -5,9 +5,8 @@ module Spotlight
   # CRUD actions for curating browse categories (see
   # {Spotlight::BrowseController} for the end-user read and index actions)
   class SearchesController < Spotlight::ApplicationController
-    load_resource :exhibit, class: 'Spotlight::Exhibit'
+    load_and_authorize_resource :exhibit, class: 'Spotlight::Exhibit', parent_action: :curate
     before_action :authenticate_user!
-    before_action :only_curators!
     before_action :create_or_load_resource, only: [:create]
     load_and_authorize_resource through: :exhibit
     before_action :attach_breadcrumbs, only: %i[index edit], unless: -> { request.format.json? }
@@ -28,10 +27,11 @@ module Spotlight
     end
 
     def index
+      @groups = @exhibit.groups
       respond_to do |format|
         format.html
         format.json do
-          render json: @searches.as_json(methods: %i[count thumbnail_image_url]), root: false
+          render json: @searches.as_json(methods: %i[full_title count thumbnail_image_url]), root: false
         end
       end
     end
@@ -50,7 +50,8 @@ module Spotlight
     end
 
     def edit
-      add_breadcrumb @search.title, edit_exhibit_search_path(@search.exhibit, @search)
+      @groups = @exhibit.groups
+      add_breadcrumb @search.full_title, edit_exhibit_search_path(@search.exhibit, @search)
       @exhibit = @search.exhibit
     end
 
@@ -105,9 +106,11 @@ module Spotlight
     def search_params
       params.require(:search).permit(
         :title,
+        :subtitle,
         :long_description,
         :search_box,
         :default_index_view_type,
+        group_ids: [],
         masthead_attributes: featured_image_params,
         thumbnail_attributes: featured_image_params
       )
@@ -117,21 +120,6 @@ module Spotlight
       params.to_unsafe_h.with_indifferent_access.except(:exhibit_id, :search, *blacklisted_search_session_params).reject { |_k, v| v.blank? }
     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
-      ]
-    end
-
-    def only_curators!
-      authorize! :curate, @exhibit if @exhibit
-    end
-
     def blacklisted_search_session_params
       %i[id commit counter total search_id page per_page authenticity_token utf8 action controller]
     end

data/app/controllers/spotlight/translations_controller.rb

@@ -21,6 +21,22 @@ module Spotlight
       end
     end
 
+    def show
+      respond_to do |format|
+        format.yaml
+      end
+    end
+
+    def import
+      if current_exhibit.update(import_exhibit_params)
+        I18n.reload! # reload since we're memoizing
+        notice = t(:'helpers.submit.spotlight_default.updated', model: current_exhibit.class.model_name.human.downcase)
+        redirect_to edit_exhibit_translations_path(current_exhibit, language: @language), notice: notice
+      else
+        render 'edit'
+      end
+    end
+
     private
 
     def attach_breadcrumbs
@@ -33,6 +49,21 @@ module Spotlight
       params.require(:exhibit).permit(translations_attributes: %i[id locale key value])
     end
 
+    def import_exhibit_params
+      imported_translations = YAML.safe_load(params.require(:file).read)
+
+      # set language from YML root locale
+      language = imported_translations.keys.first
+
+      # convert YML to hash
+      translation = unfold(imported_translations.values.first).map do |k, v|
+        current_translation = Translation.find_or_initialize_by(exhibit: current_exhibit, key: k, locale: language)
+        { key: k, value: v, locale: language, id: current_translation.id }
+      end
+
+      { translations_attributes: translation }
+    end
+
     def set_language
       @language = params[:language] || current_exhibit.available_locales.first
     end
@@ -40,5 +71,20 @@ module Spotlight
     def set_tab
       @tab = params[:tab]
     end
+
+    def unfold(value, key = nil)
+      return to_enum(:unfold, value, key) unless block_given?
+
+      if value.is_a? Hash
+        value.each do |k, v|
+          arr = unfold(v, [key, k].compact.join('.'))
+          arr.each do |k1, v1|
+            yield k1, v1
+          end
+        end
+      else
+        yield key, value
+      end
+    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)
@@ -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/crop_helper.rb

@@ -25,7 +25,10 @@ module Spotlight
     end
 
     def iiif_upload_tag(f)
-      f.file_field_without_bootstrap :file, name: 'featured_image[image]', data: { endpoint: polymorphic_path(f.object.model_name.route_key) }
+      content_tag(:div) do
+        concat f.file_field_without_bootstrap :file, name: 'featured_image[image]', data: { endpoint: polymorphic_path(f.object.model_name.route_key) }
+        concat f.hidden_field :upload_id
+      end
     end
 
     def form_prefix(f)

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/main_app_helpers.rb

@@ -24,7 +24,7 @@ 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
 

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

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Job status tracking
+  module JobTracking
+    extend ActiveSupport::Concern
+    include ActiveJob::Status
+
+    def self.with_job_tracking
+      before_perform :find_or_initialize_job_tracker
+      after_perform :finalize_job_tracker
+    end
+
+    def job_tracker
+      @job_tracker ||= find_or_initialize_job_tracker
+    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

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_uploads_from_csv.rb

@@ -3,15 +3,40 @@
 module Spotlight
   ##
   # Process a CSV upload into new Spotlight::Resource::Upload objects
-  class AddUploadsFromCSV < ActiveJob::Base
-    queue_as :default
+  class AddUploadsFromCsv < Spotlight::ApplicationJob
+    include Spotlight::JobTracking
+    attr_reader :count
+    attr_reader :errors
 
     after_perform do |job|
       csv_data, exhibit, user = job.arguments
-      Spotlight::IndexingCompleteMailer.documents_indexed(csv_data, exhibit, user).deliver_now
+      Spotlight::IndexingCompleteMailer.documents_indexed(
+        csv_data,
+        exhibit,
+        user,
+        indexed_count: job.count,
+        errors: job.errors
+      ).deliver_now
     end
 
     def perform(csv_data, exhibit, _user)
+      @count = 0
+      @errors = {}
+
+      resources(csv_data, exhibit).each_with_index do |resource, index|
+        if resource.save_and_index
+          @count += 1
+        else
+          @errors[index + 1] = resource.errors.full_messages + resource.upload&.errors&.full_messages
+        end
+      end
+    end
+
+    private
+
+    def resources(csv_data, exhibit)
+      return to_enum(:resources, csv_data, exhibit) unless block_given?
+
       encoded_csv(csv_data).each do |row|
         url = row.delete('url')
         next unless url.present?
@@ -21,12 +46,11 @@ module Spotlight
           exhibit: exhibit
         )
         resource.build_upload(remote_image_url: url) unless url == '~'
-        resource.save_and_index
+
+        yield resource
       end
     end
 
-    private
-
     def encoded_csv(csv)
       csv.map do |row|
         row.map do |label, column|
@@ -34,5 +58,9 @@ module Spotlight
         end.compact.to_h
       end.compact
     end
+
+    def job_tracking_resource
+      arguments[1]
+    end
   end
 end

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/cleanup_job_trackers_job.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ###
+  # Calls the #set_default_thumbnail method
+  # on the object passed in and calls save
+  ###
+  class CleanupJobTrackersJob < Spotlight::ApplicationJob
+    def perform
+      Spotlight::JobTracker.where(status: 'completed', updated_at: Time.zone.at(0)...Spotlight::Engine.config.reindex_progress_window.minutes.ago).delete_all
+    end
+  end
+end

data/app/jobs/spotlight/default_thumbnail_job.rb

@@ -5,9 +5,7 @@ module Spotlight
   # Calls the #set_default_thumbnail method
   # on the object passed in and calls save
   ###
-  class DefaultThumbnailJob < ActiveJob::Base
-    queue_as :default
-
+  class DefaultThumbnailJob < Spotlight::ApplicationJob
     def perform(thumbnailable)
       thumbnailable.set_default_thumbnail
       thumbnailable.save