blacklight-spotlight 0.32.0 → 0.33.0

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

@@ -6,7 +6,6 @@ module Spotlight
 
     include Spotlight::SolrDocument::ActiveModelConcern
     include Spotlight::SolrDocument::Finder
-    include Spotlight::SolrDocument::SpotlightImages
     include GlobalID::Identification
 
     included do
@@ -74,7 +73,7 @@ module Spotlight
 
     def update_exhibit_resource(resource_attributes)
       return unless resource_attributes && resource_attributes['url']
-      uploaded_resource.update url: resource_attributes['url']
+      uploaded_resource.upload.update image: resource_attributes['url']
     end
 
     def reindex

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

@@ -17,29 +17,7 @@ module Spotlight
       end
 
       def to_openseadragon(*_args)
-        self[Spotlight::Engine.config.full_image_field].each_with_index.map do |image_url, index|
-          { LegacyImagePyramidTileSource.new(
-            image_url,
-            width: self[:spotlight_full_image_width_ssm][index],
-            height: self[:spotlight_full_image_height_ssm][index]
-          ) => {} }
-        end
-      end
-
-      ##
-      # Stub legacy image pyramid property generators
-      class LegacyImagePyramidTileSource
-        attr_reader :to_tilesource
-        def initialize(url, dimensions = {})
-          @to_tilesource = {
-            type: 'legacy-image-pyramid',
-            levels: [{
-              url: url,
-              width: dimensions[:width],
-              height: dimensions[:height]
-            }]
-          }
-        end
+        [uploaded_resource.upload.iiif_tilesource] if uploaded_resource && uploaded_resource.upload
       end
     end
   end

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

@@ -28,6 +28,16 @@ module SirTrevorRails
       def display_item_counts?
         send(:'display-item-counts') == 'true'
       end
+
+      def as_json
+        result = super
+
+        result[:data][:item].each do |_k, v|
+          v['thumbnail_image_url'] = parent.exhibit.searches.find(v['id']).thumbnail_image_url
+        end
+
+        result
+      end
     end
   end
 end

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

@@ -18,6 +18,16 @@ module SirTrevorRails
       def pages?
         !pages.empty?
       end
+
+      def as_json
+        result = super
+
+        result[:data][:item].each do |_k, v|
+          v['thumbnail_image_url'] = parent.exhibit.pages.find(v['id']).thumbnail_image_url
+        end
+
+        result
+      end
     end
   end
 end

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

@@ -16,6 +16,7 @@ module SirTrevorRails
 
         items.each do |i|
           document = documents.detect { |doc| doc.id == i[:id] }
+          i[:iiif_tilesource_base] = i.fetch(:iiif_tilesource, '').sub('/info.json', '')
           yield i, document if document
         end
       end
@@ -40,6 +41,10 @@ module SirTrevorRails
         secondary_caption_field.present? && send(:'show-secondary-caption')
       end
 
+      def zpr_link?
+        zpr_link == 'true'
+      end
+
       def primary_caption_field
         val = send(:'primary-caption-field')
         val unless val.blank?

data/app/models/spotlight/analytics/ga.rb

@@ -4,7 +4,7 @@ require 'legato'
 module Spotlight
   module Analytics
     ##
-    # Google Analytics data provider for the curation dashboard
+    # Google Analytics data provider for the Exhibit dashboard
     class Ga
       extend Legato::Model
 

data/app/models/spotlight/blacklight_configuration.rb

@@ -17,7 +17,6 @@ module Spotlight
     serialize :document_index_view_types, Array
 
     include Spotlight::BlacklightConfigurationDefaults
-    include Spotlight::ImageDerivatives
 
     delegate :document_model, to: :default_blacklight_config
 
@@ -96,6 +95,10 @@ module Spotlight
           else
             set_index_field_defaults(v)
           end
+
+          v.immutable = Blacklight::OpenStructWithHashAccess.new(v.immutable)
+          v.merge! v.immutable.to_h.symbolize_keys
+
           v.upstream_if = v.if unless v.if.nil?
           v.if = :field_enabled? unless v.if == false
 
@@ -114,6 +117,9 @@ module Spotlight
             set_show_field_defaults(v)
           end
 
+          v.immutable = Blacklight::OpenStructWithHashAccess.new(v.immutable)
+          v.merge! v.immutable.to_h.symbolize_keys
+
           v.upstream_if = v.if unless v.if.nil?
           v.if = :field_enabled? unless v.if == false
 
@@ -162,6 +168,7 @@ module Spotlight
             v.upstream_if = v.if unless v.if.nil?
             v.enabled = v.show
             v.if = :field_enabled? unless v.if == false
+            v.upstream_if = nil if v.upstream_if == v.if
             v.normalize! config
             v.validate!
           end
@@ -204,6 +211,8 @@ module Spotlight
         field = Blacklight::Configuration::FacetField.new x.configuration.merge(
           key: x.field, field: x.solr_field, show: false, custom_field: true
         )
+        field.if = :field_enabled?
+        field.enabled = false
         [x.field, field]
       end]
     end
@@ -295,13 +304,12 @@ module Spotlight
     end
 
     def default_autocomplete_field_list(config)
-      "#{config.document_model.unique_key} #{config.view_config(:show).title_field} #{spotlight_image_version_fields.join(' ')}"
-    end
-
-    def spotlight_image_version_fields
-      spotlight_image_derivatives.map do |version|
-        version[:field]
-      end
+      [
+        config.document_model.unique_key,
+        config.view_config(:show).title_field,
+        config.index.thumbnail_field || Spotlight::Engine.config.thumbnail_field,
+        Spotlight::Engine.config.iiif_manifest_field
+      ].flatten.join(' ')
     end
 
     # rubocop:disable Style/AccessorMethodName

data/app/models/spotlight/contact.rb

@@ -10,24 +10,13 @@ module Spotlight
     extend FriendlyId
     friendly_id :name, use: [:slugged, :scoped, :finders], scope: :exhibit
 
-    mount_uploader :avatar, Spotlight::AvatarUploader
+    belongs_to :avatar, class_name: 'Spotlight::ContactImage', dependent: :destroy
+    accepts_nested_attributes_for :avatar, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
 
     before_save do
       self.contact_info = contact_info.symbolize_keys
     end
 
-    ## carrierwave-crop doesn't want to store the crop points. we do.
-    # so instead of this:
-    # crop_uploaded :avatar  ## Add this
-    # we do this:
-    after_save do
-      if avatar.present?
-        avatar.cache! unless avatar.cached?
-        avatar.store!
-        recreate_avatar_versions
-      end
-    end
-
     before_save on: :create do
       self.show_in_sidebar = true if show_in_sidebar.nil?
     end

data/app/models/spotlight/contact_image.rb

@@ -0,0 +1,11 @@
+module Spotlight
+  ###
+  # A simple sub class of FeaturedImage to set a small square size for contacts
+  class ContactImage < FeaturedImage
+    private
+
+    def image_size
+      Spotlight::Engine.config.contact_square_size
+    end
+  end
+end

data/app/models/spotlight/exhibit.rb

@@ -17,6 +17,7 @@ module Spotlight
     friendly_id :title, use: [:slugged, :finders]
     validates :title, presence: true
     validates :slug, uniqueness: true
+    validates :theme, inclusion: { in: Spotlight::Engine.config.exhibit_themes }, allow_blank: true
 
     acts_as_tagger
     acts_as_taggable
@@ -46,16 +47,16 @@ module Spotlight
 
     belongs_to :site
     belongs_to :masthead, dependent: :destroy
-    belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy
+    belongs_to :thumbnail, class_name: 'Spotlight::ExhibitThumbnail', dependent: :destroy
 
     accepts_nested_attributes_for :about_pages, :attachments, :contacts, :custom_fields, :feature_pages,
                                   :main_navigations, :owned_taggings, :resources, :searches, :solr_document_sidecars
-    accepts_nested_attributes_for :blacklight_configuration, :home_page, :masthead, :thumbnail, :filters, update_only: true
+    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? }
     accepts_nested_attributes_for :contact_emails, reject_if: proc { |attr| attr['email'].blank? }
     accepts_nested_attributes_for :roles, allow_destroy: true, reject_if: proc { |attr| attr['user_key'].blank? && attr['id'].blank? }
 
     before_save :sanitize_description, if: :description_changed?
-    include Spotlight::DefaultThumbnailable
 
     def main_about_page
       @main_about_page ||= about_pages.published.first
@@ -92,16 +93,12 @@ module Spotlight
       blacklight_config.search_fields.any? { |_k, v| v.enabled && v.include_in_simple_select != false }
     end
 
-    def set_default_thumbnail
-      self.thumbnail ||= searches.first.try(:thumbnail)
-    end
-
     def requested_by
       roles.first.user if roles.first
     end
 
     def reindex_progress
-      @reindex_progress ||= ReindexProgress.new(self)
+      @reindex_progress ||= ReindexProgress.new(current_reindexing_log_entry)
     end
 
     protected
@@ -113,5 +110,11 @@ module Spotlight
     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
   end
 end

data/app/models/spotlight/exhibit_thumbnail.rb

@@ -0,0 +1,12 @@
+module Spotlight
+  ##
+  # A simple sub-class of FeaturedImage to store the
+  # square thumbnail used on the exhibits landing page
+  class ExhibitThumbnail < Spotlight::FeaturedImage
+    private
+
+    def image_size
+      Spotlight::Engine.config.featured_image_square_size
+    end
+  end
+end

data/app/models/spotlight/feature_page.rb

@@ -9,7 +9,9 @@ module Spotlight
     belongs_to :parent_page, class_name: 'Spotlight::FeaturePage'
 
     accepts_nested_attributes_for :child_pages
-    accepts_nested_attributes_for :thumbnail, update_only: true
+
+    belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy
+    accepts_nested_attributes_for :thumbnail, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
 
     before_validation unless: :top_level_page? do
       self.exhibit = top_level_page_or_self.exhibit
@@ -18,9 +20,5 @@ module Spotlight
     def display_sidebar?
       child_pages.published.present? || display_sidebar
     end
-
-    def thumbnail_image_url
-      thumbnail.image.thumb.url if thumbnail && thumbnail.image
-    end
   end
 end

data/app/models/spotlight/featured_image.rb

@@ -4,20 +4,24 @@ module Spotlight
   class FeaturedImage < ActiveRecord::Base
     mount_uploader :image, Spotlight::FeaturedImageUploader
 
-    before_validation :set_image_from_uploaded_resource
-
     after_save do
       if image.present?
         image.cache! unless image.cached?
         image.store!
-        recreate_image_versions
       end
     end
 
+    after_create :set_tilesource_from_uploaded_resource
+
+    def iiif_url
+      return unless iiif_service_base.present?
+      [iiif_service_base, iiif_region || 'full', image_size.join(','), '0', 'default.jpg'].join('/')
+    end
+
+    # This is used to fetch images given the URL field in the CSV uploads
+    # If the image is local, this step will fail, which is okay since the only
+    # consumer is CSV uploads and the URL is intended to be remote
     def remote_image_url=(url)
-      # if the image is local, this step will fail..
-      # hopefully it's local because it's an uploaded resource, and we'll
-      # catch is in before_validation..
       super url unless url.starts_with? '/'
     end
 
@@ -37,11 +41,26 @@ module Spotlight
       nil
     end
 
+    def file_present?
+      image.file.present?
+    end
+
     private
 
-    def set_image_from_uploaded_resource
-      return unless document && document.uploaded_resource?
-      self.image = document.uploaded_resource.url.file
+    def set_tilesource_from_uploaded_resource
+      return if iiif_tilesource
+      riiif = Riiif::Engine.routes.url_helpers
+      self.iiif_tilesource = riiif.info_path(id)
+      save
+    end
+
+    def image_size
+      Spotlight::Engine.config.featured_image_thumb_size
+    end
+
+    def iiif_service_base
+      return unless iiif_tilesource
+      iiif_tilesource.sub('/info.json', '')
     end
   end
 end

data/app/models/spotlight/home_page.rb

@@ -8,6 +8,8 @@ module Spotlight
     before_save :publish
     before_create :default_content
 
+    accepts_nested_attributes_for :thumbnail, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
+
     class << self
       def default_title_text
         I18n.t('spotlight.pages.index.home_pages.title')

data/app/models/spotlight/masthead.rb

@@ -2,20 +2,14 @@ module Spotlight
   ##
   # Exhibit and browse category mastheads
   class Masthead < Spotlight::FeaturedImage
-    mount_uploader :image, Spotlight::MastheadUploader
-
     def display?
-      display && image.cropped.present?
+      display && iiif_url.present?
     end
 
-    # Duplicated from Spotlight::FeaturedImage, because mount_uploader
-    # will overwrite it..
-    #
-    # if the image is local, this step will fail..
-    # hopefully it's local because it's an uploaded resource, and we'll
-    # catch is in before_validation..
-    def remote_image_url=(url)
-      super url unless url.starts_with? '/'
+    private
+
+    def image_size
+      [1800, 180]
     end
   end
 end

data/app/models/spotlight/page.rb

@@ -55,6 +55,11 @@ module Spotlight
       nil
     end
 
+    def thumbnail_image_url
+      return unless thumbnail && thumbnail.iiif_url
+      thumbnail.iiif_url
+    end
+
     # explicitly set the partial path so that
     # we don't have to duplicate view logic.
     def to_partial_path

data/app/models/spotlight/reindex_progress.rb

@@ -2,46 +2,41 @@ module Spotlight
   ##
   # ReindexProgress is a class that models the progress of reindexing a list of resources
   class ReindexProgress
-    attr_reader :exhibit
+    attr_reader :current_log_entry
 
-    def initialize(exhibit)
-      @exhibit = exhibit
+    delegate :updated_at, to: :current_log_entry
+
+    def initialize(current_log_entry)
+      @current_log_entry = current_log_entry
     end
 
     def recently_in_progress?
-      return false if current_log_entry.blank?
       return true if current_log_entry.in_progress?
 
       current_log_entry.end_time.present? && (current_log_entry.end_time > Spotlight::Engine.config.reindex_progress_window.minutes.ago)
     end
 
     def started_at
-      current_log_entry.try(:start_time)
-    end
-
-    def updated_at
-      current_log_entry.try(:updated_at)
+      current_log_entry.start_time
     end
 
     def finished?
-      return false if current_log_entry.blank?
       current_log_entry.succeeded? || current_log_entry.failed?
     end
 
     def finished_at
-      current_log_entry.try(:end_time)
+      current_log_entry.end_time
     end
 
     def total
-      current_log_entry.try(:items_reindexed_estimate)
+      current_log_entry.items_reindexed_estimate
     end
 
     def completed
-      current_log_entry.try(:items_reindexed_count)
+      current_log_entry.items_reindexed_count
     end
 
     def errored?
-      return false if current_log_entry.blank?
       current_log_entry.failed?
     end
 
@@ -53,16 +48,13 @@ module Spotlight
         updated_at: localized_updated_time,
         total: total,
         completed: completed,
+        finished: finished?,
         errored: errored?
       }
     end
 
     private
 
-    def current_log_entry
-      exhibit.reindexing_log_entries.where.not(job_status: 'unstarted').first
-    end
-
     def localized_start_time
       return unless started_at
       I18n.l(started_at, format: :short)