blacklight-spotlight 3.0.0.rc2 → 3.0.0

data/app/jobs/spotlight/remove_tags_job.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ###
+  class RemoveTagsJob < Spotlight::ApplicationJob
+    include Spotlight::JobTracking
+    include Spotlight::GatherDocuments
+    with_job_tracking(resource: ->(job) { job.arguments.last[:exhibit] })
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def perform(solr_params:, exhibit:, tags:, **)
+      @errors = 0
+
+      each_document(solr_params, exhibit) do |document|
+        sidecar = document.sidecar(exhibit)
+        all_tags = sidecar.all_tags_list
+        all_tags -= tags
+        exhibit.tag(document.sidecar(exhibit), with: all_tags, on: :tags)
+        document.reindex(update_params: {})
+        progress&.increment
+      rescue StandardError => e
+        job_tracker.append_log_entry(type: :error, exhibit: exhibit, message: e.to_s)
+        @errors += 1
+        mark_job_as_failed!
+      end
+      exhibit.blacklight_config.repository.connection.commit
+      job_tracker.append_log_entry(type: :info, exhibit: exhibit, message: "#{progress.progress} of #{progress.total} (#{@errors} errors)")
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end

data/app/jobs/spotlight/rename_sidecar_field_job.rb

@@ -4,8 +4,9 @@ module Spotlight
   ##
   # After renaming an exhibit-specific field, we also
   # need to update the sidecars that may contain that field
-  class RenameSidecarFieldJob < ActiveJob::Base
-    queue_as :default
+  class RenameSidecarFieldJob < Spotlight::ApplicationJob
+    include Spotlight::JobTracking
+    with_job_tracking(resource: ->(job) { job.arguments.first })
 
     def perform(exhibit, old_field, new_field, old_slug = nil, new_slug = nil)
       exhibit.solr_document_sidecars.find_each do |s|

data/app/jobs/spotlight/rename_tags_job.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ###
+  class RenameTagsJob < Spotlight::ApplicationJob
+    include Spotlight::JobTracking
+
+    with_job_tracking(resource: ->(job) { job.arguments.first })
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def perform(exhibit, tag, to: nil, **)
+      @errors = 0
+
+      tag.taggings.owned_by(exhibit).find_each do |tagging|
+        sidecar = tagging.taggable
+        all_tags = sidecar.all_tags_list
+        all_tags -= [tag.name]
+        all_tags += [to] unless to.nil?
+
+        exhibit.tag(sidecar, with: all_tags, on: :tags)
+        sidecar.document.reindex(update_params: {})
+      rescue StandardError => e
+        job_tracker.append_log_entry(type: :error, exhibit: exhibit, message: e.to_s)
+        @errors += 1
+        mark_job_as_failed!
+      end
+
+      exhibit.blacklight_config.repository.connection.commit
+      job_tracker.append_log_entry(type: :info, exhibit: exhibit, message: "#{progress.progress} of #{progress.total} (#{@errors} errors)")
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end

data/app/jobs/spotlight/update_job_trackers_job.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ###
+  # Calls the #set_default_thumbnail method
+  # on the object passed in and calls save
+  ###
+  class UpdateJobTrackersJob < Spotlight::ApplicationJob
+    def perform(job_tracker)
+      reports_on = job_tracker.on
+
+      return unless reports_on.is_a? Spotlight::JobTracker
+
+      reports_on.update(status: 'completed') if reports_on.job_trackers.all?(&:completed?)
+      reports_on.update(status: 'failed') if reports_on.job_trackers.any?(&:failed?)
+
+      reports_on.update(data: { progress: reports_on.job_trackers.sum(&:progress), total: reports_on.job_trackers.sum(&:total) })
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Enforce exhibit visibility for index queries
+  module BrowseCategorySearchBuilder
+    extend ActiveSupport::Concern
+
+    included do
+      self.default_processor_chain = %i[apply_browse_category_defaults] +
+                                     default_processor_chain +
+                                     %i[fix_up_browse_category_defaults fix_up_browse_category_queries]
+    end
+
+    # Adds a filter that excludes resources that have been marked as not-visible
+    def apply_browse_category_defaults(solr_params)
+      return unless current_browse_category
+
+      solr_params.merge!(browse_category_search_builder.to_hash)
+    end
+
+    def fix_up_browse_category_defaults(solr_params)
+      return if current_browse_category.nil? || search_state.send(:sort_field_key).present?
+
+      solr_params[:sort] = browse_category_search_builder.sort
+    end
+
+    def fix_up_browse_category_queries(solr_params)
+      return unless solr_params.dig(:json, :query, :bool, :must) && blacklight_params[:q]
+
+      # This replicates existing spotlight 2.x search behavior, more or less. It
+      # doesn't take into account the possibility that the browse category query
+      # could use a different search field (which.. doesn't have an existing UI
+      # control.. and may require additional upstream work to properly encapsulate
+      # the two query parameters)
+      solr_params[:json][:query][:bool][:must].map! do |q|
+        q.is_a?(String) ? { edismax: { query: q } } : q
+      end
+    end
+
+    private
+
+    def current_exhibit
+      blacklight_config.current_exhibit
+    end
+
+    def current_browse_category
+      return unless current_exhibit && blacklight_params[:browse_category_id].present?
+
+      @current_browse_category ||= current_exhibit.searches.find(blacklight_params[:browse_category_id])
+    end
+
+    def browse_category_search_builder
+      @browse_category_search_builder ||= begin
+        search_builder = self.class.new(@processor_chain, @scope)
+        search_builder.with(current_browse_category.query_params)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SirTrevorRails
+  module Blocks
+    ##
+    # Browese Group Categories
+    class BrowseGroupCategoriesBlock < SirTrevorRails::Block
+      include Displayable
+
+      def display_item_counts?
+        send(:'display-item-counts') == 'true'
+      end
+
+      def groups
+        @groups ||= parent.exhibit.groups.published.where(slug: item_ids).sort do |a, b|
+          ordered_items.index(a.slug) <=> ordered_items.index(b.slug)
+        end
+      end
+
+      def groups?
+        !groups.empty?
+      end
+    end
+  end
+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,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