blacklight-spotlight 3.0.0.rc1 → 3.0.0.rc6

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

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ##
+  # Base CRUD controller for groups
+  class GroupsController < Spotlight::ApplicationController
+    before_action :authenticate_user!
+    load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
+    load_and_authorize_resource through: :exhibit
+
+    def index
+      respond_to do |format|
+        format.json do
+          render json: @groups.as_json, root: false
+        end
+      end
+    end
+
+    # POST /exhibits/1/groups
+    def create
+      @group.attributes = group_params
+
+      if @group.save
+        redirect_to(
+          spotlight.exhibit_searches_path(anchor: 'browse-groups'),
+          notice: t(:'helpers.submit.group.created', model: human_name)
+        )
+      else
+        redirect_to spotlight.exhibit_searches_path(anchor: 'browse-groups')
+      end
+    end
+
+    # PATCH/PUT /groups/1
+    def update
+      @group.update(group_params)
+
+      redirect_to spotlight.exhibit_searches_path(anchor: 'browse-groups'), notice: t(:'helpers.submit.group.updated', model: human_name)
+    end
+
+    # DELETE /groups/1
+    def destroy
+      @group.destroy
+
+      redirect_to spotlight.exhibit_searches_path(anchor: 'browse-groups'), alert: t(:'helpers.submit.group.destroyed', model: human_name)
+    end
+
+    def update_all
+      notice = if @exhibit.update update_all_group_params
+                 t(:'helpers.submit.group.batch_updated', model: human_name)
+               else
+                 t(:'helpers.submit.group.batch_error', model: human_name)
+               end
+      redirect_to spotlight.exhibit_searches_path(anchor: 'browse-groups'), notice: notice
+    end
+
+    protected
+
+    def allowed_group_params
+      [:title]
+    end
+
+    private
+
+    def human_name
+      @human_name ||= @group ? @group.class.model_name.human.downcase : Spotlight::Group.model_name.human.pluralize
+    end
+
+    alias group_collection_name controller_name
+
+    def update_all_group_params
+      params.require(:exhibit).permit(
+        groups_attributes: %i[id title published weight]
+      )
+    end
+
+    def group_params
+      params.require(controller_name.singularize).permit(allowed_group_params)
+    end
+  end
+end

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,7 +17,13 @@ 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
 
     # GET /exhibits/1/pages
     def index
@@ -146,14 +152,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
@@ -207,10 +206,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/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,6 +27,7 @@ module Spotlight
     end
 
     def index
+      @groups = @exhibit.groups
       respond_to do |format|
         format.html
         format.json do
@@ -50,6 +50,7 @@ module Spotlight
     end
 
     def edit
+      @groups = @exhibit.groups
       add_breadcrumb @search.full_title, edit_exhibit_search_path(@search.exhibit, @search)
       @exhibit = @search.exhibit
     end
@@ -109,6 +110,7 @@ module Spotlight
         :long_description,
         :search_box,
         :default_index_view_type,
+        group_ids: [],
         masthead_attributes: featured_image_params,
         thumbnail_attributes: featured_image_params
       )
@@ -118,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