blacklight-spotlight 3.0.0.alpha.6 → 3.0.0.rc1

data/app/models/spotlight/home_page.rb

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

data/app/models/spotlight/main_navigation.rb

@@ -26,8 +26,8 @@ module Spotlight
       end
     end
 
-    def default_label
-      I18n.t(:"spotlight.main_navigation.#{nav_type}")
+    def default_label(**options)
+      I18n.t(:"spotlight.main_navigation.#{nav_type}", **options)
     end
 
     private

data/app/models/spotlight/masthead.rb

@@ -11,7 +11,7 @@ module Spotlight
     private
 
     def image_size
-      [1800, 180]
+      Spotlight::Engine.config.featured_image_masthead_size
     end
   end
 end

data/app/models/spotlight/page.rb

@@ -4,10 +4,14 @@ module Spotlight
   ##
   # Base page class. See {Spotlight::AboutPage}, {Spotlight::FeaturePage}, {Spotlight::HomePage}
   class Page < ActiveRecord::Base
-    MAX_PAGES = 1000
+    MAX_PAGES = Spotlight::Engine.config.max_pages
 
     extend FriendlyId
-    friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale]
+    # 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])
+    end
 
     belongs_to :exhibit, touch: true
     belongs_to :created_by, class_name: Spotlight::Engine.config.user_class, optional: true
@@ -21,7 +25,7 @@ module Spotlight
              dependent: :destroy,
              inverse_of: :default_locale_page
 
-    validates :weight, inclusion: { in: proc { 0..Spotlight::Page::MAX_PAGES } }
+    validates :weight, allow_nil: true, numericality: { only_integer: true, greater_than_or_equal_to: 0, less_than_or_equal_to: Spotlight::Page::MAX_PAGES }
 
     default_scope { order('weight ASC') }
     scope :at_top_level, -> { where(parent_page_id: nil) }

data/app/models/spotlight/page_configurations.rb

@@ -27,6 +27,7 @@ module Spotlight
              to: :context
 
     attr_reader :context, :page
+
     def initialize(context:, page:)
       @context = context
       @page = page

data/app/models/spotlight/page_content.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'spotlight/page_content/sir_trevor'
+
 module Spotlight
   # Factory for picking the right page content renderer
   module PageContent

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

@@ -3,9 +3,10 @@
 module Spotlight
   module Resources
     ##
-    # Shim object for CSV Uploads. see {Spotlight::AddUploadsFromCSV}
+    # Shim object for CSV Uploads. see {Spotlight::AddUploadsFromCsv}
     class CsvUpload
       attr_reader :url
+
       include ActiveModel::Model
       extend ActiveModel::Translation
     end

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

@@ -6,6 +6,7 @@ module Spotlight
     # A PORO to construct a solr hash for a given IiifManifest
     class IiifManifest
       attr_reader :collection
+
       def initialize(attrs = {})
         @url = attrs[:url]
         @manifest = attrs[:manifest]
@@ -36,6 +37,7 @@ module Spotlight
       private
 
       attr_reader :url, :manifest, :exhibit, :solr_hash
+
       delegate :blacklight_config, to: :exhibit
 
       def add_document_id

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

@@ -48,7 +48,7 @@ module Spotlight
       end
 
       def custom_fields_data
-        data.slice(*exhibit.custom_fields.map(&:field).map(&:to_s)).select { |_k, v| v.present? }
+        data.slice(*exhibit.custom_fields.map(&:slug).map(&:to_s)).select { |_k, v| v.present? }
       end
 
       def configured_fields_data

data/app/models/spotlight/search.rb

@@ -17,7 +17,7 @@ module Spotlight
     scope :published, -> { where(published: true) }
     validates :title, presence: true
 
-    translates :title, :long_description
+    translates :title, :subtitle, :long_description
 
     has_paper_trail
 
@@ -26,6 +26,10 @@ module Spotlight
     accepts_nested_attributes_for :thumbnail, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
     accepts_nested_attributes_for :masthead, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
 
+    def full_title
+      [title, subtitle.presence].compact.join(' · ')
+    end
+
     def thumbnail_image_url
       return unless thumbnail&.iiif_url
 

data/app/models/spotlight/solr_document_sidecar.rb

@@ -33,11 +33,7 @@ module Spotlight
 
     # Roll our own polymorphism because our documents are not AREL-able
     def document
-      document_type.new document_type.unique_key => document_id
-    end
-
-    def document_type
-      (super.constantize if defined?(super)) || default_document_type
+      document_type_class.new document_type_class.unique_key => document_id
     end
 
     def default_document_type
@@ -46,6 +42,12 @@ module Spotlight
 
     private
 
+    def document_type_class
+      return default_document_type unless document_type.is_a?(String)
+
+      document_type.constantize
+    end
+
     def visibility_field
       blacklight_config.document_model.visibility_field(exhibit)
     end

data/app/models/spotlight/temporary_image.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ##
+  # Featured images for browse categories, feature pages, and exhibits
+  class TemporaryImage < Spotlight::FeaturedImage
+  end
+end

data/app/services/spotlight/exhibit_import_export_service.rb

@@ -0,0 +1,454 @@
+# frozen_string_literal: true
+
+require 'roar/decorator'
+require 'roar/json'
+require 'base64'
+require 'tempfile'
+
+module Spotlight
+  # Utility service for importing and exporting exhibit data
+  class ExhibitImportExportService
+    class_attribute :serialization_pipeline, default: %i[
+      raw_json
+      add_feature_page_hierarchy
+      add_page_content
+      attach_featured_images
+      attach_attachments
+    ]
+
+    attr_reader :exhibit, :include
+
+    def initialize(exhibit, include: Spotlight::Engine.config.exports)
+      @exhibit = exhibit
+      @include = include
+    end
+
+    def from_hash!(hash)
+      hash = hash.deep_symbolize_keys.reverse_merge(
+        main_navigations: {},
+        contact_emails: {},
+        searches: {},
+        about_pages: {},
+        feature_pages: {},
+        contacts: {},
+        custom_fields: {},
+        solr_document_sidecars: {},
+        resources: {},
+        attachments: {},
+        languages: {},
+        translations: {},
+        owned_taggings: {}
+      )
+
+      exhibit_attributes = hash.reject { |_k, v| v.is_a?(Array) || v.is_a?(Hash) }
+      exhibit.update_attributes(exhibit_attributes.except(:theme))
+      exhibit.theme = exhibit_attributes[:theme] if exhibit.themes.include? exhibit_attributes[:theme]
+
+      deserialize_featured_image(exhibit, :masthead, hash[:masthead]) if hash[:masthead]
+      deserialize_featured_image(exhibit, :thumbnail, hash[:thumbnail]) if hash[:thumbnail]
+
+      exhibit.blacklight_configuration.update_attributes hash[:blacklight_configuration].deep_stringify_keys if hash[:blacklight_configuration]
+
+      hash[:main_navigations].each do |attr|
+        ar = exhibit.main_navigations.find_or_initialize_by(nav_type: attr[:nav_type])
+        ar.update_attributes(attr)
+      end
+
+      hash[:contact_emails].each do |attr|
+        ar = exhibit.contact_emails.find_or_initialize_by(email: attr[:email])
+        ar.update_attributes(attr)
+      end
+
+      hash[:searches].each do |attr|
+        masthead = attr.delete(:masthead)
+        thumbnail = attr.delete(:thumbnail)
+
+        ar = exhibit.searches.find_or_initialize_by(slug: attr[:slug])
+        ar.update_attributes(attr)
+
+        deserialize_featured_image(ar, :masthead, masthead) if masthead
+        deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
+      end
+
+      hash[:about_pages].each do |attr|
+        masthead = attr.delete(:masthead)
+        thumbnail = attr.delete(:thumbnail)
+        translated_pages = attr.delete(:translated_pages) || []
+
+        ar = exhibit.about_pages.find_or_initialize_by(slug: attr[:slug])
+        ar.update_attributes(attr)
+
+        deserialize_featured_image(ar, :masthead, masthead) if masthead
+        deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
+
+        translated_pages.each do |tattr|
+          masthead = tattr.delete(:masthead)
+          thumbnail = tattr.delete(:thumbnail)
+
+          tar = ar.translated_page_for(tattr[:locale]) || ar.clone_for_locale(tattr[:locale])
+          tar.update_attributes(tattr)
+
+          deserialize_featured_image(ar, :masthead, masthead) if masthead
+          deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
+        end
+      end
+
+      hash[:feature_pages].each do |attr|
+        masthead = attr.delete(:masthead)
+        thumbnail = attr.delete(:thumbnail)
+
+        ar = exhibit.feature_pages.find_or_initialize_by(slug: attr[:slug])
+        ar.update_attributes(attr.except(:parent_page_slug, :translated_pages))
+
+        deserialize_featured_image(ar, :masthead, masthead) if masthead
+        deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
+      end
+
+      feature_pages = exhibit.feature_pages.index_by(&:slug)
+      hash[:feature_pages].each do |attr|
+        next unless attr[:parent_page_slug]
+
+        feature_pages[attr[:slug]].parent_page_id = feature_pages[attr[:parent_page_slug]].id
+      end
+
+      hash[:feature_pages].each do |attr|
+        ar = exhibit.feature_pages.find_or_initialize_by(slug: attr[:slug])
+
+        (attr[:translated_pages] || []).each do |tattr|
+          masthead = tattr.delete(:masthead)
+          thumbnail = tattr.delete(:thumbnail)
+
+          tar = ar.translated_page_for(tattr[:locale]) || ar.clone_for_locale(tattr[:locale])
+          tar.update_attributes(tattr)
+
+          deserialize_featured_image(ar, :masthead, masthead) if masthead
+          deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
+        end
+      end
+
+      if hash[:home_page]
+        translated_pages = hash[:home_page].delete(:translated_pages) || []
+        exhibit.home_page.update_attributes(hash[:home_page].except(:thumbnail))
+        deserialize_featured_image(exhibit.home_page, :thumbnail, hash[:home_page][:thumbnail]) if hash[:home_page][:thumbnail]
+
+        translated_pages.each do |tattr|
+          masthead = tattr.delete(:masthead)
+          thumbnail = tattr.delete(:thumbnail)
+
+          tar = exhibit.home_page.translated_page_for(tattr[:locale]) || exhibit.home_page.clone_for_locale(tattr[:locale])
+          tar.update_attributes(tattr)
+
+          deserialize_featured_image(ar, :masthead, masthead) if masthead
+          deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
+        end
+      end
+
+      hash[:contacts].each do |attr|
+        avatar = attr.delete(:avatar)
+
+        ar = exhibit.contacts.find_or_initialize_by(slug: attr[:slug])
+        ar.update_attributes(attr)
+
+        deserialize_featured_image(ar, :avatar, avatar) if avatar
+      end
+
+      hash[:custom_fields].each do |attr|
+        ar = exhibit.custom_fields.find_or_initialize_by(slug: attr[:slug])
+        ar.update_attributes(attr)
+      end
+
+      hash[:solr_document_sidecars].each do |attr|
+        ar = exhibit.solr_document_sidecars.find_or_initialize_by(document_id: attr[:document_id])
+        ar.update_attributes(attr)
+      end
+
+      hash[:resources].each do |attr|
+        upload = attr.delete(:upload)
+
+        ar = exhibit.resources.find_or_initialize_by(type: attr[:type], url: attr[:url])
+        ar.update_attributes(attr)
+
+        deserialize_featured_image(ar, :upload, upload) if upload
+      end
+
+      hash[:attachments].each do |attr|
+        file = attr.delete(:file)
+
+        # dedupe by something??
+        ar = exhibit.attachments.build(attr)
+        ar.file = CarrierWave::SanitizedFile.new tempfile: StringIO.new(Base64.decode64(file[:content])),
+                                                 filename: file[:filename],
+                                                 content_type: file[:content_type]
+      end
+
+      hash[:languages].each do |attr|
+        ar = exhibit.languages.find_or_initialize_by(locale: attr[:locale])
+        ar.update_attributes(attr)
+      end
+
+      hash[:translations].each do |attr|
+        ar = exhibit.translations.find_or_initialize_by(locale: attr[:locale], key: attr[:key])
+        ar.update_attributes(attr)
+      end
+
+      hash[:owned_taggings].each do |attr|
+        tag = ActsAsTaggableOn::Tag.find_or_create_by(name: attr[:tag][:name])
+        exhibit.owned_taggings.build(attr.except(:tag).merge(tag_id: tag.id))
+      end
+    end
+
+    def deserialize_featured_image(obj, method, data)
+      file = data.delete(:image)
+      image = obj.public_send("build_#{method}")
+      image.update_attributes(data)
+      if file
+        image.image = CarrierWave::SanitizedFile.new tempfile: StringIO.new(Base64.decode64(file[:content])),
+                                                     filename: file[:filename],
+                                                     content_type: file[:content_type]
+      end
+      image.save!
+      obj.update(method => image)
+    end
+
+    def as_json(**args)
+      self.class.serialization_pipeline.inject(args) do |memo, step|
+        method(step).call(memo)
+      end
+    end
+
+    private
+
+    def attach_featured_images(json)
+      json[:masthead] = serialize_featured_image(json[:masthead_id]) if json[:masthead_id]
+      json.delete(:masthead_id)
+      json[:thumbnail] = serialize_featured_image(json[:thumbnail_id]) if json[:thumbnail_id]
+      json.delete(:thumbnail_id)
+
+      (json[:searches] || []).each do |search|
+        search[:masthead] = serialize_featured_image(search[:masthead_id]) if search[:masthead_id]
+        search.delete(:masthead_id)
+        search[:thumbnail] = serialize_featured_image(search[:thumbnail_id]) if search[:thumbnail_id]
+        search.delete(:thumbnail_id)
+      end
+
+      (json[:about_pages] || []).each do |page|
+        page[:masthead] = serialize_featured_image(page[:masthead_id]) if page[:masthead_id]
+        page.delete(:masthead_id)
+        page[:thumbnail] = serialize_featured_image(page[:thumbnail_id]) if page[:thumbnail_id]
+        page.delete(:thumbnail_id)
+
+        (page[:translated_pages] || []).each do |translated_page|
+          translated_page[:masthead] = serialize_featured_image(translated_page[:masthead_id]) if translated_page[:masthead_id]
+          translated_page.delete(:masthead_id)
+          translated_page[:thumbnail] = serialize_featured_image(translated_page[:thumbnail_id]) if translated_page[:thumbnail_id]
+          translated_page.delete(:thumbnail_id)
+        end
+      end
+
+      (json[:feature_pages] || []).each do |page|
+        page[:masthead] = serialize_featured_image(page[:masthead_id]) if page[:masthead_id]
+        page.delete(:masthead_id)
+        page[:thumbnail] = serialize_featured_image(page[:thumbnail_id]) if page[:thumbnail_id]
+        page.delete(:thumbnail_id)
+
+        (page[:translated_pages] || []).each do |translated_page|
+          translated_page[:masthead] = serialize_featured_image(translated_page[:masthead_id]) if translated_page[:masthead_id]
+          translated_page.delete(:masthead_id)
+          translated_page[:thumbnail] = serialize_featured_image(translated_page[:thumbnail_id]) if translated_page[:thumbnail_id]
+          translated_page.delete(:thumbnail_id)
+        end
+      end
+
+      if json[:home_page]
+        json[:home_page][:masthead] = serialize_featured_image(json[:home_page][:masthead_id]) if json[:home_page][:masthead_id]
+        json[:home_page].delete(:masthead_id)
+        json[:home_page][:thumbnail] = serialize_featured_image(json[:home_page][:thumbnail_id]) if json[:home_page][:thumbnail_id]
+        json[:home_page].delete(:thumbnail_id)
+
+        (json[:home_page][:translated_pages] || []).each do |translated_page|
+          translated_page[:masthead] = serialize_featured_image(translated_page[:masthead_id]) if translated_page[:masthead_id]
+          translated_page.delete(:masthead_id)
+          translated_page[:thumbnail] = serialize_featured_image(translated_page[:thumbnail_id]) if translated_page[:thumbnail_id]
+          translated_page.delete(:thumbnail_id)
+        end
+      end
+
+      (json[:contacts] || []).each do |page|
+        page[:avatar] = serialize_featured_image(page[:avatar_id]) if page[:avatar_id]
+        page.delete(:avatar_id)
+      end
+
+      (json[:resources] || []).each do |page|
+        page[:upload] = serialize_featured_image(page[:upload_id]) if page[:upload_id]
+        page.delete(:upload_id)
+      end
+
+      json
+    end
+
+    def serialize_featured_image(id)
+      image = Spotlight::FeaturedImage.find(id)
+      file = image.image.file
+      if file
+        img = {
+          image: {
+            filename: file.identifier, content_type: file.content_type, content: Base64.encode64(file.read)
+          }
+        }
+      end
+
+      image.as_json(except: %i[id image]).merge(img || {}).deep_symbolize_keys
+    end
+
+    def attach_attachments(json)
+      return json unless json[:attachments]
+
+      json[:attachments].each do |attachment|
+        a = exhibit.attachments.find(attachment[:id])
+        file = a.file.file
+
+        attachment[:file] = {
+          filename: file.filename,
+          content_type: file.content_type,
+          content: Base64.encode64(file.read)
+        }
+
+        attachment.delete(:id)
+      end
+
+      json
+    end
+
+    def add_feature_page_hierarchy(json)
+      return json unless json[:feature_pages]
+
+      page_id_map = json[:feature_pages].map { |x| [x[:id], x[:slug]] }.to_h
+
+      json[:feature_pages].each do |page|
+        page.delete(:id)
+        next unless page[:parent_page_id]
+
+        page[:parent_page_slug] = page_id_map[page[:parent_page_id]]
+        page.delete(:parent_page_id)
+      end
+
+      json
+    end
+
+    def add_page_content(json)
+      (json[:feature_pages] || []).each do |page|
+        p = exhibit.feature_pages.find_by(slug: page[:slug])
+        page[:content] = p.read_attribute(:content)
+        (page[:translated_pages]).each do |translated_page|
+          translated_page[:content] = p.translated_page_for(translated_page[:locale]).read_attribute(:content)
+        end
+      end
+
+      (json[:about_pages] || []).each do |page|
+        p = exhibit.about_pages.find_by(slug: page[:slug])
+        page[:content] = p.read_attribute(:content)
+        (page[:translated_pages]).each do |translated_page|
+          translated_page[:content] = p.translated_page_for(translated_page[:locale]).read_attribute(:content)
+        end
+      end
+
+      json[:home_page][:content] = exhibit.home_page.read_attribute(:content) if json[:home_page]
+      (json.dig(:home_page, :translated_pages) || []).each do |translated_page|
+        translated_page[:content] = exhibit.home_page.translated_page_for(translated_page[:locale]).read_attribute(:content)
+      end
+      json
+    end
+
+    def raw_json(_input = nil)
+      exhibit.as_json(
+        {
+          except: %i[id slug site_id],
+          include: {}.merge(
+            if_include?(:config,
+                        main_navigations: {
+                          except: %i[id exhibit_id]
+                        },
+                        contact_emails: {
+                          except: %i[id exhibit_id confirmation_token]
+                        },
+                        languages: {
+                          except: %i[id exhibit_id]
+                        },
+                        translations: {
+                          only: %i[locale key value interpolations is_proc]
+                        })
+          ).merge(
+            if_include?(:pages,
+                        searches: { # thumbnail
+                          except: %i[id scope exhibit_id]
+                        },
+                        about_pages: { # thumbnail
+                          except: %i[id scope exhibit_id parent_page_id content],
+                          include: {
+                            translated_pages: {
+                              except: %i[id scope exhibit_id parent_page_id default_locale_page_id content]
+                            }
+                          }
+                        },
+                        home_page: { # thumbnail
+                          except: %i[id slug scope exhibit_id parent_page_id content],
+                          include: {
+                            translated_pages: {
+                              except: %i[id scope exhibit_id parent_page_id default_locale_page_id content]
+                            }
+                          }
+                        },
+                        feature_pages: { # thumbnail
+                          except: %i[scope exhibit_id content],
+                          include: {
+                            translated_pages: {
+                              except: %i[id scope exhibit_id parent_page_id default_locale_page_id content]
+                            }
+                          }
+                        },
+                        contacts: {
+                          except: %i[id exhibit_id]
+                        })
+          ).merge(
+            if_include?(:blacklight_configuration,
+                        blacklight_configuration: {
+                          except: %i[id exhibit_id]
+                        },
+                        # blacklight_configuration
+                        custom_fields: {
+                          except: %i[id exhibit_id]
+                        })
+          ).merge(
+            if_include?(:resources,
+                        # resources
+                        solr_document_sidecars: {
+                          except: %i[id exhibit_id]
+                        },
+                        owned_taggings: {
+                          only: %i[taggable_id taggable_type context],
+                          include: {
+                            tag: {
+                              only: [:name]
+                            }
+                          }
+                        },
+                        resources: { # upload
+                          except: %i[id exhibit_id],
+                          methods: :type
+                        })
+          ).merge(
+            if_include?(:attachments,
+                        # attachments
+                        attachments: { # file
+                          except: %i[exhibit_id]
+                        })
+          )
+        }.merge(include[:config] ? {} : { only: %i[does_not_exist] })
+      ).deep_symbolize_keys
+    end
+
+    def if_include?(config, res)
+      include[config] ? res : {}
+    end
+  end
+end