blacklight-spotlight 3.0.0.rc4 → 3.0.2

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

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

@@ -12,6 +12,7 @@ module Spotlight
     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
 
@@ -66,6 +67,14 @@ module Spotlight
       (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
@@ -82,8 +91,8 @@ module Spotlight
       status == 'failed'
     end
 
-    def append_log_entry(type:, **args)
-      events.create(type: type, data: args)
+    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

data/app/models/spotlight/page.rb

@@ -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

data/app/models/spotlight/page_configurations.rb

@@ -18,14 +18,12 @@ module Spotlight
     delegate :available_view_fields,
              :blacklight_config,
              :current_exhibit,
-             :document_show_link_field,
-             :index_fields,
-             :index_field_label,
              :spotlight,
              :t,
-             :view_label,
              to: :context
 
+    DOCUMENT_TITLE_KEY = '__spotlight_document_title___'
+
     attr_reader :context, :page
 
     def initialize(context:, page:)
@@ -35,7 +33,7 @@ module Spotlight
 
     def as_json(*)
       {
-        'blacklight-configuration-index-fields': available_index_fields,
+        'blacklight-configuration-index-fields': available_caption_fields,
         'blacklight-configuration-search-views': available_view_configs,
         'attachment-endpoint': attachment_endpoint,
         'autocomplete-exhibit-catalog-path': exhibit_autocomplete_endpoint,
@@ -48,15 +46,18 @@ module Spotlight
 
     private
 
-    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
+    def available_caption_fields
+      default_caption_fields + blacklight_config.index_fields.reject { |_k, v| v.caption == false }.map { |k, v| { key: k, label: v.display_label } }
+    end
 
+    def default_caption_fields
+      fields = []
+      fields << { key: DOCUMENT_TITLE_KEY, label: t(:'spotlight.pages.form.title_placeholder') } unless blacklight_config.index_fields.key? DOCUMENT_TITLE_KEY
       fields
     end
 
     def available_view_configs
-      available_view_fields.map { |k, _| { key: k, label: view_label(k) } }
+      available_view_fields.map { |k, v| { key: k, label: v.display_label(k) } }
     end
 
     def attachment_endpoint

data/app/models/spotlight/resource.rb

@@ -31,14 +31,14 @@ module Spotlight
     # Persist the record to the database, and trigger a reindex to solr
     #
     # @param [Hash] All arguments will be passed through to ActiveRecord's #save method
-    def save_and_index(*args)
-      save(*args) && reindex_later
+    def save_and_index(reindex_options: {}, **args)
+      save(*args) && reindex_later(**reindex_options)
     end
 
     ##
     # Enqueue an asynchronous reindexing job for this resource
-    def reindex_later
-      Spotlight::ReindexJob.perform_later(self)
+    def reindex_later(**args)
+      Spotlight::ReindexJob.perform_later(self, **args)
     end
 
     def document_model

data/app/models/spotlight/resources/iiif_harvester.rb

@@ -33,8 +33,8 @@ module Spotlight
 
       def url_is_iiif?(url)
         valid_content_types = ['application/json', 'application/ld+json']
-        req = Faraday.head(url)
-        req = Faraday.get(url) if req.status == 405
+        req = Spotlight::Resources::IiifService.http_client.head(url)
+        req = Spotlight::Resources::IiifService.http_client.get(url) if req.status == 405
         return unless req.success?
 
         valid_content_types.any? do |valid_type|

data/app/models/spotlight/resources/iiif_service.rb

@@ -29,6 +29,13 @@ module Spotlight
         recursive_manifests(new(url))
       end
 
+      def self.http_client
+        Faraday.new do |b|
+          b.use FaradayMiddleware::FollowRedirects
+          b.adapter Faraday.default_adapter
+        end
+      end
+
       protected
 
       def object
@@ -41,7 +48,7 @@ module Spotlight
 
       class << self
         def iiif_response(url)
-          Faraday.get(url).body
+          Spotlight::Resources::IiifService.http_client.get(url).body
         rescue Faraday::ConnectionFailed, Faraday::TimeoutError => e
           Rails.logger.warn("HTTP GET for #{url} failed with #{e}")
           {}.to_json

data/app/models/spotlight/resources/upload.rb

@@ -41,7 +41,7 @@ module Spotlight
       end
 
       def to_solr
-        return {} unless upload.file_present?
+        return {} unless upload&.file_present?
 
         spotlight_routes = Spotlight::Engine.routes.url_helpers
         riiif = Riiif::Engine.routes.url_helpers
@@ -51,7 +51,7 @@ module Spotlight
         {
           spotlight_full_image_width_ssm: dimensions.width,
           spotlight_full_image_height_ssm: dimensions.height,
-          Spotlight::Engine.config.thumbnail_field => riiif.image_path(upload_id, size: '!400,400'),
+          Spotlight::Engine.config.thumbnail_field => riiif.image_path(upload, size: '!400,400'),
           Spotlight::Engine.config.iiif_manifest_field => spotlight_routes.manifest_exhibit_solr_document_path(exhibit, compound_id)
         }
       end

data/app/models/spotlight/role.rb

@@ -4,11 +4,10 @@ module Spotlight
   ##
   # Exhibit authorization roles
   class Role < ActiveRecord::Base
-    ROLES = %w[admin curator].freeze
     belongs_to :resource, polymorphic: true, optional: true
     belongs_to :user, class_name: Spotlight::Engine.config.user_class, autosave: true, optional: false
 
-    validates :role, inclusion: { in: ROLES }
+    validates :role, inclusion: { in: Spotlight::Engine.config.exhibit_roles }
     validate :user_must_be_unique, if: :user
 
     def user_key

data/app/presenters/spotlight/iiif_manifest_presenter.rb

@@ -70,7 +70,7 @@ module Spotlight
     private
 
     def presenter
-      controller.view_context.show_presenter(resource)
+      controller.view_context.document_presenter(resource)
     end
 
     def endpoint
@@ -79,7 +79,7 @@ module Spotlight
 
     def iiif_url
       # yes this is hacky, and we are appropriately ashamed.
-      controller.riiif.info_url(uploaded_resource.upload.id).sub(%r{/info\.json\Z}, '')
+      controller.riiif.info_url(uploaded_resource.upload).sub(%r{/info\.json\Z}, '')
     end
   end
 end

data/app/services/spotlight/bulk_updates_csv_template_service.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module Spotlight
+  # A service to generate a CSV template suitable for re-uploading for bulk updates
+  class BulkUpdatesCsvTemplateService
+    attr_reader :exhibit
+
+    def initialize(exhibit:)
+      @exhibit = exhibit
+    end
+
+    def template(view_context:, title: true, tags: true, visibility: true)
+      return to_enum(:template, view_context: view_context, title: title, tags: tags, visibility: visibility) unless block_given?
+
+      yield ::CSV.generate_line(csv_headers(title: title, tags: tags, visibility: visibility))
+      each_document do |document|
+        sidecar = document.sidecar(exhibit)
+        yield ::CSV.generate_line([
+          document.id,
+          (title_column(view_context, document) if title),
+          (visibility_column(sidecar) if visibility),
+          (tags_column(sidecar) if tags)
+        ].flatten.compact)
+      end
+    end
+
+    private
+
+    def title_column(view_context, document)
+      CGI.unescapeHTML(view_context.document_presenter(document).heading)
+    end
+
+    def visibility_column(sidecar)
+      sidecar.public ? 'TRUE' : ' '
+    end
+
+    def tags_column(sidecar)
+      exhibit_tags.map do |tag|
+        sidecar.all_tags_list.include?(tag) ? 'TRUE' : ' '
+      end
+    end
+
+    def exhibit_tags
+      @exhibit_tags ||= exhibit.owned_tags.map(&:name)
+    end
+
+    def csv_headers(title:, tags:, visibility:)
+      headers = [bulk_updates_config.csv_id]
+      headers.append(bulk_updates_config.csv_title) if title
+      headers.append(bulk_updates_config.csv_visibility) if visibility
+      if tags
+        exhibit_tags.each do |tag|
+          headers.append(format(bulk_updates_config.csv_tags, tag))
+        end
+      end
+      headers
+    end
+
+    def bulk_updates_config
+      Spotlight::Engine.config.bulk_updates
+    end
+
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def each_document(&block)
+      return to_enum(:each_document) unless block_given?
+
+      cursor_mark = nil
+      next_cursor_mark = '*'
+
+      solr_params = exhibit&.exhibit_search_builder&.to_h || {}
+
+      until next_cursor_mark == cursor_mark || next_cursor_mark.nil?
+        cursor_mark = next_cursor_mark
+        response = exhibit.blacklight_config.repository.search(
+          solr_params.merge(
+            'q' => '*',
+            'rows' => Spotlight::Engine.config.bulk_actions_batch_size,
+            'cursorMark' => cursor_mark,
+            'sort' => "#{exhibit.blacklight_config.document_model.unique_key} asc"
+          )
+        )
+        response.documents.each do |document|
+          block.call(document)
+        end
+
+        next_cursor_mark = response['nextCursorMark']
+      end
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+  end
+end

data/app/services/spotlight/etl/executor.rb

@@ -47,9 +47,7 @@ module Spotlight
       #
       # @return [Number]
       def estimated_size
-        @estimated_size ||= begin
-          compile_steps(sources).sum { |source| source.call(context).count }
-        end
+        @estimated_size ||= compile_steps(sources).sum { |source| source.call(context).count }
       end
 
       ##

data/app/services/spotlight/iiif_resource_resolver.rb

@@ -57,7 +57,7 @@ module Spotlight
 
     def response
       @response ||= begin
-                      Faraday.get(iiif_manifest_url).body
+                      Spotlight::Resources::IiifService.http_client.get(iiif_manifest_url).body
                     rescue Faraday::Error => e
                       Rails.logger.warn("#{self.class.name} failed to fetch #{iiif_manifest_url} with: #{e}")
                       '{}'

data/app/uploaders/spotlight/bulk_updates_uploader.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Spotlight
+  class BulkUpdatesUploader < CarrierWave::Uploader::Base
+    storage Spotlight::Engine.config.uploader_storage
+  end
+end

data/app/uploaders/spotlight/featured_image_uploader.rb

@@ -6,7 +6,7 @@ module Spotlight
   class FeaturedImageUploader < CarrierWave::Uploader::Base
     storage Spotlight::Engine.config.uploader_storage
 
-    def extension_whitelist
+    def extension_allowlist
       Spotlight::Engine.config.allowed_upload_extensions
     end
 

data/app/views/catalog/_add_tags.html.erb

@@ -0,0 +1,28 @@
+<div class="modal fade" id="add-tags-modal" tabindex="-1" role="dialog" aria-labelledby="add-tag-modal" aria-hidden="true">
+  <div class="modal-dialog">
+  <%= bootstrap_form_for([:visibility, current_exhibit], url: add_tags_exhibit_bulk_actions_path(current_exhibit), method: 'post') do |f| %>
+    <div class="modal-content">
+      <div class="modal-header">
+        <h4 class="modal-title" id="add-tag-modal"><%= t(:'spotlight.bulk_actions.add_tags.heading') %></h4>
+        <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
+          <span aria-hidden="true">&times;</span>
+        </button>
+      </div>
+      <div class="modal-body">
+        <p>
+          <%= t(:'spotlight.bulk_actions.add_tags.description', count: @response.total) %>
+        </p>
+        <div class="form-group">
+          <%= label_tag :tags, t(:'spotlight.bulk_actions.add_tags.label') %>
+          <%= text_field_tag :tags, '', class: 'form-control', data: { autocomplete_tag: true, autocomplete_url: exhibit_tags_path(current_exhibit, format: 'json')} %>
+        </div>
+        <%= render Blacklight::HiddenSearchStateComponent.new(params: search_state.params_for_search) %>
+      </div>
+      <div class="modal-footer d-flex flex-row-reverse justify-content-start">
+        <%= f.submit t(:'spotlight.bulk_actions.add'), class: 'btn btn-primary', data: { confirm: t(:'spotlight.bulk_actions.confirm') } %>
+        <button type="button" class="btn btn-link" data-dismiss="modal"><%= t :cancel %></button>
+      </div>
+    </div>
+    <% end %>
+  </div>
+</div>