blacklight-spotlight 3.0.0.rc3 → 3.0.1

data/app/models/concerns/spotlight/exhibit_analytics.rb

@@ -8,18 +8,14 @@ module Spotlight
       return OpenStruct.new unless analytics_provider&.enabled?
 
       @analytics ||= {}
-      @analytics[start_date] ||= begin
-        analytics_provider.exhibit_data(path || self, start_date: start_date.ago)
-      end
+      @analytics[start_date] ||= analytics_provider.exhibit_data(path || self, start_date: start_date.ago)
     end
 
     def page_analytics(start_date = 1.month, path = nil)
       return [] unless analytics_provider&.enabled?
 
       @page_analytics ||= {}
-      @page_analytics[start_date] ||= begin
-        analytics_provider.page_data(path || self, start_date: start_date.ago)
-      end
+      @page_analytics[start_date] ||= analytics_provider.page_data(path || self, start_date: start_date.ago)
     end
 
     def analytics_provider

data/app/models/concerns/spotlight/exhibit_documents.rb

@@ -23,12 +23,12 @@ module Spotlight
       end
     end
 
-    private
-
     def exhibit_search_builder
       blacklight_config.search_builder_class.new(exhibit_search_builder_context).except(:apply_permissive_visibility_filter)
     end
 
+    private
+
     def exhibit_search_builder_context
       OpenStruct.new(blacklight_config: blacklight_config.tap { |x| x.current_exhibit = self })
     end

data/app/models/concerns/spotlight/resources/web.rb

@@ -30,7 +30,7 @@ module Spotlight
       def self.fetch(url)
         Faraday.new(url) do |b|
           b.use FaradayMiddleware::FollowRedirects
-          b.adapter :net_http
+          b.adapter Faraday.default_adapter
         end.get
       end
     end

data/app/models/concerns/spotlight/search_builder.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Enforce exhibit visibility for index queries
+  module SearchBuilder
+    extend ActiveSupport::Concern
+
+    include Spotlight::AccessControlsEnforcementSearchBuilder
+    include Spotlight::BrowseCategorySearchBuilder
+  end
+end

data/app/models/concerns/spotlight/solr_document.rb

@@ -24,7 +24,7 @@ module Spotlight
 
       def reindex(id)
         find(id).reindex
-      rescue Blacklight::Exceptions::InvalidSolrID => e
+      rescue Blacklight::Exceptions::RecordNotFound => e
         Rails.logger.debug "Unable to find document #{id}: #{e}"
       end
 

data/app/models/concerns/spotlight/solr_document/atomic_updates.rb

@@ -5,12 +5,12 @@ module Spotlight
     ##
     # Solr indexing strategy using Solr's Atomic Updates
     module AtomicUpdates
-      def reindex
+      def reindex(update_params: { commitWithin: 500 })
         return unless write?
 
         data = hash_for_solr_update(to_solr)
 
-        blacklight_solr.update params: { commitWithin: 500 }, data: data.to_json, headers: { 'Content-Type' => 'application/json' } unless data.empty?
+        blacklight_solr.update params: update_params, data: data.to_json, headers: { 'Content-Type' => 'application/json' } unless data.empty?
       end
 
       def write?

data/app/models/concerns/spotlight/user.rb

@@ -8,7 +8,6 @@ module Spotlight
     included do
       has_many :roles, class_name: 'Spotlight::Role', dependent: :destroy
       has_many :exhibits, class_name: 'Spotlight::Exhibit', through: :roles, source: 'resource', source_type: 'Spotlight::Exhibit'
-      has_many :reindexing_log_entries, class_name: 'Spotlight::ReindexingLogEntry'
 
       scope :with_roles, -> { where(id: Spotlight::Role.distinct.pluck(:user_id)) }
 
@@ -20,7 +19,11 @@ module Spotlight
     end
 
     def exhibit_roles
-      roles.where(resource_type: 'Spotlight::Exhibit')
+      roles.where(resource_type: 'Spotlight::Exhibit').where.not(role: 'viewer')
+    end
+
+    def viewer_roles
+      roles.where(resource_type: 'Spotlight::Exhibit', role: 'viewer')
     end
 
     def admin_roles
@@ -28,6 +31,8 @@ module Spotlight
     end
 
     def add_default_roles
+      return unless Spotlight::Engine.config.assign_default_roles_to_first_user
+
       roles.build role: 'admin', resource: Spotlight::Site.instance unless self.class.any?
     end
 

data/app/models/sir_trevor_rails/blocks/solr_documents_block.rb

@@ -43,6 +43,15 @@ module SirTrevorRails
         ActiveModel::Type::Boolean.new.cast(send(:'show-primary-caption'))
       end
 
+      def document_caption(presenter, caption_field, default: nil)
+        caption_field ||= default
+
+        return unless caption_field
+        return presenter.heading if caption_field == Spotlight::PageConfigurations::DOCUMENT_TITLE_KEY
+
+        presenter.field_value(solr_helper.blacklight_config.index_fields[caption_field] || Blacklight::Configuration::NullField.new(caption_field))
+      end
+
       def secondary_caption?
         secondary_caption_field.present? && show_secondary_caption?
       end

data/app/models/sir_trevor_rails/blocks/uploaded_items_block.rb

@@ -11,6 +11,10 @@ module SirTrevorRails
       def files
         (item || {}).map { |_, file| file }.select { |file| file[:display].to_s == 'true' }
       end
+
+      def zpr_link?
+        zpr_link == 'true'
+      end
     end
   end
 end

data/app/models/spotlight/ability.rb

@@ -19,7 +19,7 @@ module Spotlight
       can :manage, [Spotlight::BlacklightConfiguration, Spotlight::ContactEmail, Spotlight::Language], exhibit_id: user.admin_roles.pluck(:resource_id)
       can :manage, Spotlight::Role, resource_id: user.admin_roles.pluck(:resource_id), resource_type: 'Spotlight::Exhibit'
 
-      can :manage, [PaperTrail::Version, Spotlight::FeaturedImage] if user.roles.any?
+      can :manage, [PaperTrail::Version, Spotlight::FeaturedImage] if user.exhibit_roles.any?
 
       # exhibit curator
       can :manage, [
@@ -34,10 +34,12 @@ module Spotlight
         Translation
       ], exhibit_id: user.exhibit_roles.pluck(:resource_id)
 
+      can :read, Spotlight::JobTracker, on_id: user.exhibit_roles.pluck(:resource_id), on_type: 'Spotlight::Exhibit'
+
       can :manage, Spotlight::Lock, by: user
 
       can :read, Spotlight::Language, exhibit_id: user.exhibit_roles.pluck(:resource_id)
-      can %i[read curate tag], Spotlight::Exhibit, id: user.exhibit_roles.pluck(:resource_id)
+      can %i[read curate tag bulk_update], Spotlight::Exhibit, id: user.exhibit_roles.pluck(:resource_id)
 
       # public
       can :read, Spotlight::HomePage
@@ -46,6 +48,8 @@ module Spotlight
       can :read, Spotlight::Search, published: true
       can :read, Spotlight::Group, published: true
       can :read, Spotlight::Language, public: true
+
+      can :read, Spotlight::Exhibit, id: user.viewer_roles.pluck(:resource_id)
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
   end

data/app/models/spotlight/attachment.rb

@@ -8,7 +8,7 @@ module Spotlight
     mount_uploader :file, Spotlight::AttachmentUploader
 
     def as_json(options = nil)
-      file.as_json(options).merge(name: name, uid: uid, id: id, class: self.class.to_s)
+      file.as_json(options).merge(name: name, uid: uid, attachment: to_global_id)
     end
   end
 end

data/app/models/spotlight/background_job_progress.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ##
+  # BackgroundJobProgress is a class that models the progress of a list of resources
+  class BackgroundJobProgress
+    attr_reader :exhibit, :job_class
+
+    delegate :updated_at, to: :most_relevant_job_tracker
+
+    def initialize(exhibit, job_class:)
+      @exhibit = exhibit
+      @job_class = job_class
+    end
+
+    def as_json(*)
+      {
+        recently_in_progress: recently_in_progress?,
+        started_at: localized_start_time,
+        finished_at: localized_finish_time,
+        updated_at: localized_updated_time,
+        total: [total, completed].max,
+        completed: completed,
+        finished: finished?,
+        errored: errored?
+      }
+    end
+
+    private
+
+    def job_trackers
+      @job_trackers ||= exhibit.job_trackers.where(job_class: job_class.to_s).recent
+    end
+
+    def most_relevant_job_tracker
+      return @most_relevant_job_tracker if @most_relevant_job_tracker
+
+      @most_relevant_job_tracker ||= job_trackers.in_progress.first || job_trackers.completed.first || job_trackers.first || Spotlight::JobTracker.new
+    end
+
+    def recently_in_progress?
+      return false unless most_relevant_job_tracker.persisted?
+      return true if most_relevant_job_tracker.in_progress?
+
+      finished? && most_relevant_job_tracker.updated_at >= Spotlight::Engine.config.reindex_progress_window.ago
+    end
+
+    def started_at
+      most_relevant_job_tracker.created_at
+    end
+
+    def finished?
+      most_relevant_job_tracker.completed? || (errored? && most_relevant_job_tracker.job_trackers.none?(&:in_progress?))
+    end
+
+    def finished_at
+      return unless finished?
+
+      most_relevant_job_tracker.updated_at
+    end
+
+    def total
+      return most_relevant_job_tracker.total if finished? || most_relevant_job_tracker.job_trackers.none?
+
+      most_relevant_job_tracker.job_trackers.sum(&:total)
+    end
+
+    def completed
+      return most_relevant_job_tracker.progress if finished? || most_relevant_job_tracker.job_trackers.none?
+
+      most_relevant_job_tracker.job_trackers.sum(&:progress)
+    end
+
+    def errored?
+      most_relevant_job_tracker.failed?
+    end
+
+    def localized_start_time
+      return unless started_at
+
+      I18n.l(started_at, format: :long)
+    end
+
+    def localized_finish_time
+      return unless finished_at
+
+      I18n.l(finished_at, format: :long)
+    end
+
+    def localized_updated_time
+      return unless updated_at
+
+      I18n.l(updated_at, format: :long)
+    end
+  end
+end

data/app/models/spotlight/blacklight_configuration.rb

@@ -74,16 +74,41 @@ module Spotlight
 
         config.current_exhibit = exhibit
 
+        config.document_presenter_class = lambda do |context|
+          if context.action_name == 'index'
+            config.index.document_presenter_class
+          else
+            config.show.document_presenter_class
+          end
+        end
+
         config.show.merge! show unless show.blank?
         config.index.merge! index unless index.blank?
         config.index.respond_to[:iiif_json] = true
 
         config.index.thumbnail_field ||= Spotlight::Engine.config.thumbnail_field
 
-        config.add_results_collection_tool 'save_search', if: :render_save_this_search?
+        config.add_results_collection_tool 'curator_actions', if: :render_curator_actions?
+
+        unless config.curator_actions
+          config.curator_actions ||= Blacklight::NestedOpenStructWithHashAccess.new(Blacklight::Configuration::ToolConfig)
+          config.curator_actions.save_search!
+          config.curator_actions.bulk_actions!
+        end
+
+        unless config.bulk_actions
+          config.bulk_actions ||= Blacklight::NestedOpenStructWithHashAccess.new(Blacklight::Configuration::ToolConfig)
+
+          config.bulk_actions.change_visibility!
+          config.bulk_actions.add_tags!
+          config.bulk_actions.remove_tags!
+        end
 
         config.default_solr_params = config.default_solr_params.merge(default_solr_params)
 
+        config.default_per_page = default_per_page if default_per_page
+
+        config.view.embed!
         config.view.embed.partials ||= ['openseadragon']
         config.view.embed.if = false
         config.view.embed.locals ||= { osd_container_class: '' }
@@ -186,11 +211,6 @@ module Spotlight
 
         config.per_page = (config.per_page & per_page) unless per_page.blank?
 
-        if default_per_page
-          config.per_page.delete(default_per_page)
-          config.per_page.unshift(default_per_page)
-        end
-
         unless document_index_view_types.blank?
           config.view.each do |k, v|
             v.original = v.dup

data/app/models/spotlight/bulk_update.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Spotlight
+  class BulkUpdate < ActiveRecord::Base
+    mount_uploader :file, Spotlight::BulkUpdatesUploader
+    belongs_to :exhibit
+  end
+end

data/app/models/spotlight/event.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Logged events for Spotlight exhibits
+  class Event < ActiveRecord::Base
+    belongs_to :resource, polymorphic: true
+    belongs_to :exhibit, optional: true
+
+    serialize :data
+
+    self.inheritance_column = :event_class
+  end
+end

data/app/models/spotlight/exhibit.rb

@@ -4,7 +4,6 @@ require 'mail'
 module Spotlight
   ##
   # Spotlight exhibit
-  # rubocop:disable Metrics/ClassLength
   class Exhibit < ActiveRecord::Base
     class_attribute :themes_selector
     include Spotlight::ExhibitAnalytics
@@ -57,8 +56,9 @@ module Spotlight
 
     has_many :feature_pages, -> { for_default_locale }, extend: FriendlyId::FinderMethods
     has_many :groups, dependent: :delete_all
+    has_many :job_trackers, as: :on, dependent: :delete_all
+    has_many :bulk_updates, dependent: :delete_all
     has_many :main_navigations, dependent: :delete_all
-    has_many :reindexing_log_entries, dependent: :destroy
     has_many :resources
     has_many :roles, as: :resource, dependent: :delete_all
     has_many :searches, dependent: :destroy, extend: FriendlyId::FinderMethods
@@ -119,8 +119,8 @@ module Spotlight
       end
     end
 
-    def reindex_later(user = nil)
-      Spotlight::ReindexJob.perform_later(self, new_reindexing_log_entry(user))
+    def reindex_later(current_user = nil)
+      Spotlight::ReindexExhibitJob.perform_later(self, user: current_user)
     end
 
     def uploaded_resource_fields
@@ -136,7 +136,7 @@ module Spotlight
     end
 
     def reindex_progress
-      @reindex_progress ||= ReindexProgress.new(current_reindexing_log_entry)
+      @reindex_progress ||= BackgroundJobProgress.new(self, job_class: Spotlight::ReindexExhibitJob)
     end
 
     def available_locales
@@ -149,19 +149,10 @@ module Spotlight
       self.description = ::Rails::Html::FullSanitizer.new.sanitize(description)
     end
 
-    def new_reindexing_log_entry(user = nil)
-      Spotlight::ReindexingLogEntry.create(exhibit: self, user: user, items_reindexed_count: 0, job_status: 'unstarted')
-    end
-
     private
 
-    def current_reindexing_log_entry
-      reindexing_log_entries.started_or_completed.first || reindexing_log_entries.build
-    end
-
     def move_friendly_id_error_to_slug
       errors.add :slug, *errors.delete(:friendly_id) if errors[:friendly_id].present?
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/app/models/spotlight/feature_page.rb

@@ -14,8 +14,6 @@ module Spotlight
 
     accepts_nested_attributes_for :child_pages
 
-    belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy, optional: true
-
     before_validation unless: :top_level_page? do
       self.exhibit = top_level_page_or_self.exhibit
     end

data/app/models/spotlight/featured_image.rb

@@ -31,6 +31,8 @@ module Spotlight
       end
     end
 
+    after_save :bust_containing_resource_caches
+
     attr_accessor :upload_id
 
     def iiif_url
@@ -68,10 +70,16 @@ module Spotlight
         self[:iiif_tilesource]
       elsif file_present?
         riiif = Riiif::Engine.routes.url_helpers
-        riiif.info_path(id)
+        riiif.info_path(self)
       end
     end
 
+    # Include a hashed updated_at timestamp in the parameter key to bust any
+    # browser caching.
+    def to_param
+      "#{id}-#{Digest::MD5.hexdigest(updated_at.iso8601)}"
+    end
+
     private
 
     def image_size
@@ -81,5 +89,36 @@ module Spotlight
     def iiif_service_base
       iiif_tilesource&.sub('/info.json', '')
     end
+
+    # This is an unfortunate work-around because:
+    #   - when this instance is updated through accepts_nested_attributes_for on a parent model,
+    #        the parent model is not necessarily updated (to bust caches, etc)
+    #   - this model doesn't have an association back to where it is being used
+    #   - these images can be used by multiple model instances (e.g. various translations of a feature page)
+    #   - this model is used by different types of models (polymorphic use), so belongs_to/has_many doesn't help
+    #   - potentially a problem with https://github.com/rails/rails/issues/26726
+    #
+    # Ideally, we might create a join table to connect this model to where it is used, but 🤷‍♂️
+    # Instead, we check each place this might be used and touch it
+    def bust_containing_resource_caches
+      if Rails.version > '6'
+        Spotlight::Search.where(thumbnail: self).or(Spotlight::Search.where(masthead: self)).touch_all
+        Spotlight::Page.where(thumbnail: self).touch_all
+        Spotlight::Exhibit.where(thumbnail: self).or(Spotlight::Exhibit.where(masthead: self)).touch_all
+        Spotlight::Contact.where(avatar: self).touch_all
+        Spotlight::Resources::Upload.where(upload: self).touch_all
+      else
+        bust_containing_resource_caches_rails5
+      end
+    end
+
+    # Rails 5 doesn't support touch_all.
+    def bust_containing_resource_caches_rails5
+      Spotlight::Search.where(thumbnail: self).or(Spotlight::Search.where(masthead: self)).find_each(&:touch)
+      Spotlight::Page.where(thumbnail: self).find_each(&:touch)
+      Spotlight::Exhibit.where(thumbnail: self).or(Spotlight::Exhibit.where(masthead: self)).find_each(&:touch)
+      Spotlight::Contact.where(avatar: self).find_each(&:touch)
+      Spotlight::Resources::Upload.where(upload: self).find_each(&:touch)
+    end
   end
 end