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

data/app/controllers/spotlight/admin_users_controller.rb

@@ -10,7 +10,10 @@ module Spotlight
 
     load_and_authorize_resource :site, class: 'Spotlight::Site'
 
-    def index; end
+    def index
+      add_breadcrumb t(:'spotlight.sites.home'), root_url
+      add_breadcrumb t(:'spotlight.admin_users.index.page_title')
+    end
 
     def create
       if update_roles

data/app/controllers/spotlight/appearances_controller.rb

@@ -40,6 +40,7 @@ module Spotlight
         source
         image
         document_global_id
+        upload_id
       ]
     end
   end

data/app/controllers/spotlight/browse_controller.rb

@@ -69,7 +69,7 @@ module Spotlight
     end
 
     def attach_search_breadcrumb
-      add_breadcrumb @search.title, exhibit_browse_path(@exhibit, @search)
+      add_breadcrumb @search.full_title, exhibit_browse_path(@exhibit, @search)
     end
 
     def _prefixes

data/app/controllers/spotlight/catalog_controller.rb

@@ -209,9 +209,9 @@ module Spotlight
       if current_browse_category
         add_breadcrumb current_browse_category.exhibit.main_navigations.browse.label_or_default, exhibit_browse_index_path(current_browse_category.exhibit)
         add_breadcrumb current_browse_category.title, exhibit_browse_path(current_browse_category.exhibit, current_browse_category)
-      elsif current_page_context && current_page_context.title.present? && !current_page_context.is_a?(Spotlight::HomePage)
+      elsif current_page_context&.title&.present? && !current_page_context.is_a?(Spotlight::HomePage)
         add_breadcrumb current_page_context.title, [current_page_context.exhibit, current_page_context]
-      elsif current_search_session
+      elsif current_search_session && !current_page_context&.is_a?(Spotlight::HomePage)
         add_breadcrumb t(:'spotlight.catalog.breadcrumb.index'), search_action_url(current_search_session.query_params)
       end
 

data/app/controllers/spotlight/exhibits_controller.rb

@@ -22,11 +22,12 @@ module Spotlight
 
     def new
       build_initial_exhibit_contact_emails
+      add_breadcrumb t(:'spotlight.sites.home'), root_url
+      add_breadcrumb t(:'spotlight.exhibits.new.page_title')
     end
 
     def process_import
-      @exhibit.import(JSON.parse(import_exhibit_params.read))
-      if @exhibit.save && @exhibit.reindex_later
+      if @exhibit.import(JSON.parse(import_exhibit_params.read)) && @exhibit.reindex_later
         redirect_to spotlight.exhibit_dashboard_path(@exhibit), notice: t(:'helpers.submit.exhibit.updated', model: @exhibit.class.model_name.human.downcase)
       else
         render action: :import
@@ -48,7 +49,7 @@ module Spotlight
       respond_to do |format|
         format.json do
           authorize! :export, @exhibit
-          send_data JSON.pretty_generate(Spotlight::ExhibitExportSerializer.new(@exhibit).as_json),
+          send_data JSON.pretty_generate(Spotlight::ExhibitImportExportService.new(@exhibit).as_json),
                     type: 'application/json',
                     disposition: 'attachment',
                     filename: "#{@exhibit.friendly_id}-export.json"

data/app/controllers/spotlight/featured_images_controller.rb

@@ -3,7 +3,7 @@
 module Spotlight
   # Handles requests to upload images for exhibit thumbnails
   class FeaturedImagesController < Spotlight::ApplicationController
-    load_and_authorize_resource instance_name: :featured_image
+    load_and_authorize_resource instance_name: :featured_image, class: 'Spotlight::TemporaryImage'
 
     def create
       if @featured_image.save && @featured_image.file_present?

data/app/controllers/spotlight/pages_controller.rb

@@ -19,10 +19,6 @@ module Spotlight
 
     helper_method :get_search_results, :search_results, :fetch, :page_collection_name, :presenter
 
-    before_action do
-      blacklight_config.track_search_session = false
-    end
-
     # GET /exhibits/1/pages
     def index
       # set up a model the inline "add a new page" form
@@ -74,7 +70,7 @@ module Spotlight
       @page.lock&.delete
 
       if @page.update(page_params.merge(last_edited_by: current_user))
-        redirect_to [spotlight, @page.exhibit, @page], flash: { html_safe: true }, notice: undo_notice(:updated)
+        redirect_to [spotlight, @page.exhibit, @page, format: params.permit(:format)], flash: { html_safe: true }, notice: undo_notice(:updated)
       else
         render action: 'edit'
       end

data/app/controllers/spotlight/resources/csv_upload_controller.rb

@@ -16,7 +16,7 @@ module Spotlight
 
       def create
         csv = CSV.parse(csv_io_param, headers: true, return_headers: false).map(&:to_hash)
-        Spotlight::AddUploadsFromCSV.perform_later(csv, current_exhibit, current_user)
+        Spotlight::AddUploadsFromCsv.perform_later(csv, current_exhibit, current_user)
         flash[:notice] = t('spotlight.resources.upload.csv.success', file_name: csv_io_name)
         redirect_to spotlight.admin_exhibit_catalog_path(current_exhibit)
       end

data/app/controllers/spotlight/searches_controller.rb

@@ -31,7 +31,7 @@ module Spotlight
       respond_to do |format|
         format.html
         format.json do
-          render json: @searches.as_json(methods: %i[count thumbnail_image_url]), root: false
+          render json: @searches.as_json(methods: %i[full_title count thumbnail_image_url]), root: false
         end
       end
     end
@@ -50,7 +50,7 @@ module Spotlight
     end
 
     def edit
-      add_breadcrumb @search.title, edit_exhibit_search_path(@search.exhibit, @search)
+      add_breadcrumb @search.full_title, edit_exhibit_search_path(@search.exhibit, @search)
       @exhibit = @search.exhibit
     end
 
@@ -105,6 +105,7 @@ module Spotlight
     def search_params
       params.require(:search).permit(
         :title,
+        :subtitle,
         :long_description,
         :search_box,
         :default_index_view_type,

data/app/controllers/spotlight/sites_controller.rb

@@ -8,9 +8,15 @@ module Spotlight
     before_action :load_site
     load_and_authorize_resource
 
-    def edit; end
+    def edit
+      add_breadcrumb t(:'spotlight.sites.home'), root_url
+      add_breadcrumb t(:'spotlight.sites.edit.page_title')
+    end
 
-    def edit_exhibits; end
+    def edit_exhibits
+      add_breadcrumb t(:'spotlight.sites.home'), root_url
+      add_breadcrumb t(:'spotlight.sites.edit_exhibits.page_title')
+    end
 
     def update
       if @site.update(site_params)

data/app/controllers/spotlight/translations_controller.rb

@@ -21,6 +21,22 @@ module Spotlight
       end
     end
 
+    def show
+      respond_to do |format|
+        format.yaml
+      end
+    end
+
+    def import
+      if current_exhibit.update(import_exhibit_params)
+        I18n.reload! # reload since we're memoizing
+        notice = t(:'helpers.submit.spotlight_default.updated', model: current_exhibit.class.model_name.human.downcase)
+        redirect_to edit_exhibit_translations_path(current_exhibit, language: @language), notice: notice
+      else
+        render 'edit'
+      end
+    end
+
     private
 
     def attach_breadcrumbs
@@ -33,6 +49,21 @@ module Spotlight
       params.require(:exhibit).permit(translations_attributes: %i[id locale key value])
     end
 
+    def import_exhibit_params
+      imported_translations = YAML.safe_load(params.require(:file).read)
+
+      # set language from YML root locale
+      language = imported_translations.keys.first
+
+      # convert YML to hash
+      translation = unfold(imported_translations.values.first).map do |k, v|
+        current_translation = Translation.find_or_initialize_by(exhibit: current_exhibit, key: k, locale: language)
+        { key: k, value: v, locale: language, id: current_translation.id }
+      end
+
+      { translations_attributes: translation }
+    end
+
     def set_language
       @language = params[:language] || current_exhibit.available_locales.first
     end
@@ -40,5 +71,20 @@ module Spotlight
     def set_tab
       @tab = params[:tab]
     end
+
+    def unfold(value, key = nil)
+      return to_enum(:unfold, value, key) unless block_given?
+
+      if value.is_a? Hash
+        value.each do |k, v|
+          arr = unfold(v, [key, k].compact.join('.'))
+          arr.each do |k1, v1|
+            yield k1, v1
+          end
+        end
+      else
+        yield key, value
+      end
+    end
   end
 end

data/app/helpers/spotlight/crop_helper.rb

@@ -25,7 +25,10 @@ module Spotlight
     end
 
     def iiif_upload_tag(f)
-      f.file_field_without_bootstrap :file, name: 'featured_image[image]', data: { endpoint: polymorphic_path(f.object.model_name.route_key) }
+      content_tag(:div) do
+        concat f.file_field_without_bootstrap :file, name: 'featured_image[image]', data: { endpoint: polymorphic_path(f.object.model_name.route_key) }
+        concat f.hidden_field :upload_id
+      end
     end
 
     def form_prefix(f)

data/app/helpers/spotlight/title_helper.rb

@@ -13,8 +13,18 @@ module Spotlight
     end
 
     def page_title(section, title = nil)
-      set_html_page_title(t(:'spotlight.html_admin_title', section: section, title: title || t(:'.title', default: :'.header')))
-      content_tag(:h1, safe_join([section, content_tag(:small, title || t(:'.header'))], "\n"), class: 'page-header')
+      title ||= t(:'.header', default: '').presence
+
+      head_content = t(:'spotlight.html_admin_title', section: section, title: title) if section && title
+      head_content ||= section || title
+      set_html_page_title(head_content)
+
+      html_content = safe_join([
+        (section if section.present?),
+        (content_tag(:small, title) if title.present?)
+      ].compact, "\n")
+
+      content_tag(:h1, html_content, class: 'page-header')
     end
 
     # rubocop:disable Naming/AccessorMethodName

data/app/jobs/spotlight/add_uploads_from_csv.rb

@@ -3,15 +3,41 @@
 module Spotlight
   ##
   # Process a CSV upload into new Spotlight::Resource::Upload objects
-  class AddUploadsFromCSV < ActiveJob::Base
+  class AddUploadsFromCsv < ActiveJob::Base
+    attr_reader :count
+    attr_reader :errors
+
     queue_as :default
 
     after_perform do |job|
       csv_data, exhibit, user = job.arguments
-      Spotlight::IndexingCompleteMailer.documents_indexed(csv_data, exhibit, user).deliver_now
+      Spotlight::IndexingCompleteMailer.documents_indexed(
+        csv_data,
+        exhibit,
+        user,
+        indexed_count: job.count,
+        errors: job.errors
+      ).deliver_now
     end
 
     def perform(csv_data, exhibit, _user)
+      @count = 0
+      @errors = {}
+
+      resources(csv_data, exhibit).each_with_index do |resource, index|
+        if resource.save_and_index
+          @count += 1
+        else
+          @errors[index + 1] = resource.errors.full_messages + resource.upload&.errors&.full_messages
+        end
+      end
+    end
+
+    private
+
+    def resources(csv_data, exhibit)
+      return to_enum(:resources, csv_data, exhibit) unless block_given?
+
       encoded_csv(csv_data).each do |row|
         url = row.delete('url')
         next unless url.present?
@@ -21,12 +47,11 @@ module Spotlight
           exhibit: exhibit
         )
         resource.build_upload(remote_image_url: url) unless url == '~'
-        resource.save_and_index
+
+        yield resource
       end
     end
 
-    private
-
     def encoded_csv(csv)
       csv.map do |row|
         row.map do |label, column|

data/app/mailers/spotlight/indexing_complete_mailer.rb

@@ -5,9 +5,10 @@ module Spotlight
   # Notify the curator that we're finished processing a
   # batch upload
   class IndexingCompleteMailer < ActionMailer::Base
-    def documents_indexed(csv_data, exhibit, user)
-      @number = csv_data.length
+    def documents_indexed(csv_data, exhibit, user, indexed_count: nil, errors: [])
+      @number = indexed_count || csv_data.length
       @exhibit = exhibit
+      @errors = errors
       mail(to: user.email, subject: 'Document indexing complete')
     end
   end

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

@@ -15,8 +15,24 @@ module Spotlight
       # Set up a reader for the specified attribute that uses the I18n backend,
       # and defaults to the ActiveRecord value
       def define_translated_attr_reader(attr_name)
+        # Define a dynamic method for translating database-backed attributes,
+        # falling back to the database information as needed.
+        #
+        # Note: the empty string is provided as the final fallback to avoid i18n blowing
+        # up on nil attributes.
         define_method(:"#{attr_name}") do
-          I18n.translate(attr_name, scope: slug, default: attr_translation(attr_name))
+          send("translated_#{attr_name}", default: [attr_translation(attr_name), ''])
+        end
+
+        # Define an accessor that gets the value of the attribute in a given locale,
+        # returning `nil` for untranslated values.
+        #
+        # Note: For the default locale, we actually want to dig into the database,
+        # because that is the source of truth for the data.
+        define_method(:"translated_#{attr_name}") do |default: [], **options|
+          default = Array.wrap(default)
+          default.prepend(attr_translation(attr_name)) if I18n.locale == I18n.default_locale
+          I18n.translate(attr_name, scope: slug, default: default, **options).presence
         end
       end
     end

data/app/models/spotlight/about_page.rb

@@ -5,6 +5,8 @@ module Spotlight
   # About pages
   class AboutPage < Spotlight::Page
     extend FriendlyId
-    friendly_id :title, use: %i[slugged scoped finders history], 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 contacts])
+    end
   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/exhibit.rb

@@ -100,8 +100,10 @@ module Spotlight
     end
 
     def import(hash)
-      Spotlight::ExhibitExportSerializer.prepare(self).from_hash(hash)
-      self
+      ActiveRecord::Base.transaction do
+        Spotlight::ExhibitImportExportService.new(self).from_hash!(hash)
+        save
+      end
     end
 
     def solr_data

data/app/models/spotlight/feature_page.rb

@@ -5,7 +5,9 @@ module Spotlight
   # Feature pages
   class FeaturePage < Spotlight::Page
     extend FriendlyId
-    friendly_id :title, use: %i[slugged scoped finders history], 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
 
     has_many :child_pages, class_name: 'Spotlight::FeaturePage', inverse_of: :parent_page, foreign_key: 'parent_page_id'
     belongs_to :parent_page, class_name: 'Spotlight::FeaturePage', optional: true

data/app/models/spotlight/featured_image.rb

@@ -6,6 +6,24 @@ module Spotlight
   class FeaturedImage < ActiveRecord::Base
     mount_uploader :image, Spotlight::FeaturedImageUploader
 
+    before_validation do
+      next unless upload_id.present? && source == 'remote'
+
+      # 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,
+                                                  content_type: temp_image.image.content_type
+
+      # Unset the incoming iiif_tilesource, which points at the temp image
+      self.iiif_tilesource = nil
+    end
+
+    after_commit do
+      # Clean up the temporary image
+      Spotlight::TemporaryImage.find(upload_id).delete if upload_id.present?
+    end
+
     after_save do
       if image.present?
         image.cache! unless image.cached?
@@ -13,7 +31,7 @@ module Spotlight
       end
     end
 
-    after_create :set_tilesource_from_uploaded_resource
+    attr_accessor :upload_id
 
     def iiif_url
       return unless iiif_service_base.present?
@@ -45,24 +63,23 @@ module Spotlight
       image.file.present?
     end
 
-    private
-
-    def set_tilesource_from_uploaded_resource
-      return if iiif_tilesource
-
-      riiif = Riiif::Engine.routes.url_helpers
-      self.iiif_tilesource = riiif.info_path(id)
-      save
+    def iiif_tilesource
+      if self[:iiif_tilesource]
+        self[:iiif_tilesource]
+      elsif file_present?
+        riiif = Riiif::Engine.routes.url_helpers
+        riiif.info_path(id)
+      end
     end
 
+    private
+
     def image_size
       Spotlight::Engine.config.featured_image_thumb_size
     end
 
     def iiif_service_base
-      return unless iiif_tilesource
-
-      iiif_tilesource.sub('/info.json', '')
+      iiif_tilesource&.sub('/info.json', '')
     end
   end
 end