blacklight-spotlight 3.0.0.rc2 → 3.0.0

data/app/models/spotlight/blacklight_configuration.rb

@@ -74,15 +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: '' }
@@ -185,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
@@ -353,7 +374,7 @@ module Spotlight
     def title_only_by_default?(view)
       return false if %i[show enabled].include?(view)
 
-      title_only = default_blacklight_config.view.send(:[], view).try(:title_only_by_default)
+      title_only = default_blacklight_config.view.send(:[], view)&.title_only_by_default
       title_only.nil? ? false : title_only
     end
 

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

@@ -22,11 +22,16 @@ module Spotlight
     paginates_per 48
 
     extend FriendlyId
-    friendly_id :title, use: %i[slugged finders]
+    friendly_id :title, use: %i[slugged finders] do |config|
+      config.reserved_words&.concat(%w[site])
+    end
+
     validates :title, presence: true, if: -> { I18n.locale == I18n.default_locale }
     validates :slug, uniqueness: true
     validates :theme, inclusion: { in: Spotlight::Engine.config.exhibit_themes }, allow_blank: true
 
+    after_validation :move_friendly_id_error_to_slug
+
     acts_as_tagger
     acts_as_taggable
     delegate :blacklight_config, to: :blacklight_configuration
@@ -50,8 +55,10 @@ module Spotlight
     has_many :custom_search_fields, dependent: :delete_all
 
     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
@@ -70,7 +77,7 @@ module Spotlight
     belongs_to :masthead, dependent: :destroy, optional: true
     belongs_to :thumbnail, class_name: 'Spotlight::ExhibitThumbnail', dependent: :destroy, optional: true
 
-    accepts_nested_attributes_for :about_pages, :attachments, :contacts, :custom_fields, :feature_pages, :languages,
+    accepts_nested_attributes_for :about_pages, :attachments, :contacts, :custom_fields, :feature_pages, :groups, :languages,
                                   :main_navigations, :owned_taggings, :pages, :resources, :searches, :solr_document_sidecars, :translations
     accepts_nested_attributes_for :blacklight_configuration, :home_page, :filters, update_only: true
     accepts_nested_attributes_for :masthead, :thumbnail, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
@@ -112,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
@@ -129,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
@@ -142,14 +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
+    def move_friendly_id_error_to_slug
+      errors.add :slug, *errors.delete(:friendly_id) if errors[:friendly_id].present?
     end
   end
 end

data/app/models/spotlight/feature_page.rb

@@ -6,7 +6,7 @@ module Spotlight
   class FeaturePage < Spotlight::Page
     extend FriendlyId
     friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale] do |config|
-      config.reserved_words.concat(%w[update_all])
+      config.reserved_words&.concat(%w[update_all])
     end
 
     has_many :child_pages, class_name: 'Spotlight::FeaturePage', inverse_of: :parent_page, foreign_key: 'parent_page_id'
@@ -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

@@ -12,7 +12,7 @@ module Spotlight
       # copy the image from the temp upload
       temp_image = Spotlight::TemporaryImage.find(upload_id)
       self.image = CarrierWave::SanitizedFile.new tempfile: StringIO.new(temp_image.image.read),
-                                                  filename: temp_image.image.identifier,
+                                                  filename: temp_image.image.filename || temp_image.image.identifier,
                                                   content_type: temp_image.image.content_type
 
       # Unset the incoming iiif_tilesource, which points at the temp image
@@ -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

data/app/models/spotlight/field_metadata.rb

@@ -45,18 +45,14 @@ module Spotlight
 
     # This gets the number of *documents* with a field
     def document_counts
-      @document_count ||= begin
-        solr_response.facet_queries.each_with_object({}) do |(k, v), h|
-          h[k.split(/:/).first] = v
-        end
+      @document_count ||= solr_response.facet_queries.each_with_object({}) do |(k, v), h|
+        h[k.split(/:/).first] = v
       end
     end
 
     def terms
-      @terms ||= begin
-        solr_response.aggregations.each_with_object({}) do |(facet_name, facet), h|
-          h[facet_name] = facet.items.map(&:label)
-        end
+      @terms ||= solr_response.aggregations.each_with_object({}) do |(facet_name, facet), h|
+        h[facet_name] = facet.items.map(&:label)
       end
     end
 

data/app/models/spotlight/group.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ##
+  # Exhibit saved searches
+  class Group < ActiveRecord::Base
+    include Spotlight::Translatables
+
+    extend FriendlyId
+    friendly_id :title, use: %i[slugged scoped finders history], scope: [:exhibit]
+    translates :title
+
+    self.table_name = 'spotlight_groups'
+    belongs_to :exhibit
+    has_many :group_members
+    has_many :searches, through: :group_members, source: :member, source_type: 'Spotlight::Search'
+    default_scope { order('weight ASC') }
+    scope :published, -> { where(published: true) }
+    accepts_nested_attributes_for :group_members
+    accepts_nested_attributes_for :searches
+  end
+end

data/app/models/spotlight/group_member.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ##
+  # Exhibit saved searches
+  class GroupMember < ActiveRecord::Base
+    self.table_name = 'spotlight_groups_members'
+    belongs_to :group
+    belongs_to :member, polymorphic: true
+  end
+end

data/app/models/spotlight/home_page.rb

@@ -6,7 +6,7 @@ module Spotlight
   class HomePage < Spotlight::Page
     extend FriendlyId
     friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale] do |config|
-      config.reserved_words.concat(%w[update_all])
+      config.reserved_words&.concat(%w[update_all])
     end
 
     before_save :publish

data/app/models/spotlight/job_tracker.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Associate background jobs with records
+  class JobTracker < ActiveRecord::Base
+    scope :recent, -> { order('updated_at DESC').limit(5) }
+    scope :in_progress, -> { where.not(status: %w[completed failed]) }
+    scope :completed, -> { where(status: %w[completed failed]) }
+
+    belongs_to :on, polymorphic: true
+    belongs_to :resource, polymorphic: true
+    belongs_to :user, optional: true, class_name: Spotlight::Engine.config.user_class # rubocop:disable Rails/ReflectionClassName
+    has_many :events, as: :resource, dependent: :delete_all
+    has_many :job_trackers, as: :on, dependent: Rails.version > '6.1' ? :destroy_async : :destroy
+    has_many :subevents, through: :job_trackers, source: :events
+
+    serialize :data
+
+    after_initialize do
+      self.data ||= {}
+    end
+
+    after_commit do
+      next unless on.is_a? Spotlight::JobTracker
+
+      UpdateJobTrackersJob.perform_later(self)
+    end
+
+    def label
+      "[#{job_class.titleize}] #{resource_label}"
+    end
+
+    def resource_label
+      return resource.filename if resource.is_a? ActiveStorage::Blob
+      return resource.name if resource.is_a? Upload
+
+      resource_id
+    end
+
+    def job_status
+      return {} unless job_id
+
+      @job_status ||= ActiveJob::Status.get(job_id)
+    end
+
+    def progress_label
+      return number_with_delimiter(progress) unless total?
+
+      "#{number_with_delimiter(progress)} / #{number_with_delimiter(total)}"
+    end
+
+    def progress
+      data[:progress] || job_status[:progress] || 0
+    end
+
+    def total(default: progress)
+      [progress, data[:total] || job_status[:total] || default].max
+    end
+
+    def total?
+      total(default: 0).positive?
+    end
+
+    def percent
+      return nil unless total?
+
+      (100.0 * progress) / total
+    end
+
+    def status
+      @status ||= super
+      @status ||= 'missing'
+      @status = 'in_progress' if @status == 'completed' && job_trackers.any? { |t| t.in_progress? || t.enqueued? }
+
+      @status
+    end
+
+    def enqueued?
+      status == 'enqueued'
+    end
+
+    def in_progress?
+      status == 'in_progress'
+    end
+
+    def completed?
+      status == 'completed'
+    end
+
+    def failed?
+      status == 'failed'
+    end
+
+    def append_log_entry(type:, exhibit: nil, **args)
+      events.create(type: type, exhibit: exhibit, data: args)
+    rescue StandardError => e
+      Rails.logger.error("Unable to create log entry for job tracker #{id}: #{e}")
+    end
+
+    def top_level_job_tracker
+      if on.is_a?(Spotlight::JobTracker)
+        on.top_level_job_tracker
+      else
+        self
+      end
+    end
+
+    private
+
+    def number_with_delimiter(*args)
+      ActiveSupport::NumberHelper.number_to_delimited(*args)
+    end
+  end
+end

data/app/models/spotlight/page.rb

@@ -9,8 +9,8 @@ module Spotlight
     extend FriendlyId
     # Note: This configuration also needs to be duplicated on the
     # STI models ({Spotlight::AboutPage}, {Spotlight::FeaturePage}, {Spotlight::HomePage})
-    friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale] do |config|
-      config.reserved_words.concat(%w[update_all])
+    friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale], treat_reserved_as_conflict: true do |config|
+      config.reserved_words&.concat(%w[update_all contacts])
     end
 
     belongs_to :exhibit, touch: true
@@ -51,9 +51,7 @@ module Spotlight
     end
 
     def content
-      @content ||= begin
-        Spotlight::PageContent.for(self, :content)
-      end
+      @content ||= Spotlight::PageContent.for(self, :content)
     end
 
     def content_type