blacklight-spotlight 3.0.0.rc2 → 3.0.0

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

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