blacklight-spotlight 3.0.0.alpha.10 → 3.0.0.rc5

data/app/models/spotlight/ability.rb

@@ -19,12 +19,13 @@ 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, [
         Spotlight::Attachment,
         Spotlight::Search,
+        Spotlight::Group,
         Spotlight::Resource,
         Spotlight::Page,
         Spotlight::Contact,
@@ -33,17 +34,22 @@ 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
       can :read, Spotlight::Exhibit, published: true
       can :read, Spotlight::Page, published: true
       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/about_page.rb

@@ -6,7 +6,7 @@ module Spotlight
   class AboutPage < 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 contacts])
+      config.reserved_words&.concat(%w[update_all contacts])
     end
   end
 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

@@ -76,13 +76,30 @@ module Spotlight
 
         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.partials ||= ['openseadragon']
         config.view.embed.if = false
         config.view.embed.locals ||= { osd_container_class: '' }
@@ -185,11 +202,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 +365,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/contact.rb

@@ -19,7 +19,7 @@ module Spotlight
       self.contact_info = contact_info.symbolize_keys
     end
 
-    before_save on: :create do
+    before_create do
       self.show_in_sidebar = true if show_in_sidebar.nil?
     end
 

data/app/models/spotlight/custom_field.rb

@@ -18,10 +18,10 @@ module Spotlight
       self.field_type ||= 'text'
     end
 
-    before_save :update_field_name, on: :update, if: -> { field_type_changed? || readonly_field_changed? }
+    before_update :update_field_name, if: -> { field_type_changed? || readonly_field_changed? }
 
-    after_commit :update_blacklight_configuration_after_field_name_change, on: :update, if: -> { saved_change_to_field? || saved_change_to_slug? }
-    after_commit :update_sidecar_data_after_field_name_change, on: :update, if: -> { saved_change_to_field? || saved_change_to_slug? }
+    after_update_commit :update_blacklight_configuration_after_field_name_change, if: -> { saved_change_to_field? || saved_change_to_slug? }
+    after_update_commit :update_sidecar_data_after_field_name_change, if: -> { saved_change_to_field? || saved_change_to_slug? }
 
     def label=(label)
       configuration['label'] = label

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
@@ -66,12 +66,18 @@ module Spotlight
     def iiif_tilesource
       if self[:iiif_tilesource]
         self[:iiif_tilesource]
-      elsif source == 'remote' && file_present?
+      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

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