blacklight-spotlight 3.0.0.alpha.8 → 3.0.0.rc3

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

@@ -5,9 +5,8 @@ module Spotlight
   # CRUD actions for curating browse categories (see
   # {Spotlight::BrowseController} for the end-user read and index actions)
   class SearchesController < Spotlight::ApplicationController
-    load_resource :exhibit, class: 'Spotlight::Exhibit'
+    load_and_authorize_resource :exhibit, class: 'Spotlight::Exhibit', parent_action: :curate
     before_action :authenticate_user!
-    before_action :only_curators!
     before_action :create_or_load_resource, only: [:create]
     load_and_authorize_resource through: :exhibit
     before_action :attach_breadcrumbs, only: %i[index edit], unless: -> { request.format.json? }
@@ -28,10 +27,11 @@ module Spotlight
     end
 
     def index
+      @groups = @exhibit.groups
       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,8 @@ module Spotlight
     end
 
     def edit
-      add_breadcrumb @search.title, edit_exhibit_search_path(@search.exhibit, @search)
+      @groups = @exhibit.groups
+      add_breadcrumb @search.full_title, edit_exhibit_search_path(@search.exhibit, @search)
       @exhibit = @search.exhibit
     end
 
@@ -105,9 +106,11 @@ module Spotlight
     def search_params
       params.require(:search).permit(
         :title,
+        :subtitle,
         :long_description,
         :search_box,
         :default_index_view_type,
+        group_ids: [],
         masthead_attributes: featured_image_params,
         thumbnail_attributes: featured_image_params
       )
@@ -117,21 +120,6 @@ module Spotlight
       params.to_unsafe_h.with_indifferent_access.except(:exhibit_id, :search, *blacklisted_search_session_params).reject { |_k, v| v.blank? }
     end
 
-    def featured_image_params
-      %i[
-        iiif_region iiif_tilesource
-        iiif_manifest_url iiif_canvas_id iiif_image_id
-        display
-        source
-        image
-        document_global_id
-      ]
-    end
-
-    def only_curators!
-      authorize! :curate, @exhibit if @exhibit
-    end
-
     def blacklisted_search_session_params
       %i[id commit counter total search_id page per_page authenticity_token utf8 action controller]
     end

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

@@ -132,7 +132,7 @@ module Spotlight
 
     def uploaded_field_label(config)
       solr_field = Array(config.solr_field || config.field_name).first.to_s
-      blacklight_config.index_fields[solr_field].try(:label) || config.label || t(".#{solr_field}")
+      blacklight_config.index_fields[solr_field]&.label || config.label || t(".#{solr_field}")
     end
 
     def available_view_fields

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

@@ -112,7 +112,7 @@ module Spotlight
       defaults << :"helpers.action.#{object_name}.#{key}"
       defaults << :"helpers.action.#{key}"
       defaults << "#{key.to_s.humanize} #{model}"
-      I18n.t(defaults.shift, model: model, default: defaults)
+      I18n.t(defaults.shift, model: model.downcase, default: defaults)
     end
     # rubocop:enable Metrics/MethodLength
   end

data/app/helpers/spotlight/main_app_helpers.rb

@@ -24,7 +24,7 @@ module Spotlight
     end
 
     def link_back_to_catalog(opts = { label: nil })
-      opts[:route_set] ||= spotlight if (current_search_session.try(:query_params) || {}).fetch(:controller, '').starts_with? 'spotlight'
+      opts[:route_set] ||= spotlight if (current_search_session&.query_params || {}).fetch(:controller, '').starts_with? 'spotlight'
       super
     end
 

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

@@ -29,7 +29,7 @@ module Spotlight
     def initialize_browse
       return unless searches.blank?
 
-      searches.create title: 'All Exhibit Items',
+      searches.create title: 'All exhibit items',
                       long_description: 'All items in this exhibit.'
     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/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/spotlight/ability.rb

@@ -25,6 +25,7 @@ module Spotlight
       can :manage, [
         Spotlight::Attachment,
         Spotlight::Search,
+        Spotlight::Group,
         Spotlight::Resource,
         Spotlight::Page,
         Spotlight::Contact,
@@ -43,6 +44,7 @@ module Spotlight
       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
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength

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

@@ -76,6 +76,7 @@ module Spotlight
 
         config.show.merge! show unless show.blank?
         config.index.merge! index unless index.blank?
+        config.index.respond_to[:iiif_json] = true
 
         config.index.thumbnail_field ||= Spotlight::Engine.config.thumbnail_field
 
@@ -353,7 +354,7 @@ module Spotlight
     def title_only_by_default?(view)
       return false if %i[show enabled].include?(view)
 
-      title_only = default_blacklight_config.view.send(:[], view).try(:title_only_by_default)
+      title_only = default_blacklight_config.view.send(:[], view)&.title_only_by_default
       title_only.nil? ? false : title_only
     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

@@ -4,6 +4,7 @@ require 'mail'
 module Spotlight
   ##
   # Spotlight exhibit
+  # rubocop:disable Metrics/ClassLength
   class Exhibit < ActiveRecord::Base
     class_attribute :themes_selector
     include Spotlight::ExhibitAnalytics
@@ -22,11 +23,16 @@ module Spotlight
     paginates_per 48
 
     extend FriendlyId
-    friendly_id :title, use: %i[slugged finders]
+    friendly_id :title, use: %i[slugged finders] do |config|
+      config.reserved_words&.concat(%w[site])
+    end
+
     validates :title, presence: true, if: -> { I18n.locale == I18n.default_locale }
     validates :slug, uniqueness: true
     validates :theme, inclusion: { in: Spotlight::Engine.config.exhibit_themes }, allow_blank: true
 
+    after_validation :move_friendly_id_error_to_slug
+
     acts_as_tagger
     acts_as_taggable
     delegate :blacklight_config, to: :blacklight_configuration
@@ -50,6 +56,7 @@ module Spotlight
     has_many :custom_search_fields, dependent: :delete_all
 
     has_many :feature_pages, -> { for_default_locale }, extend: FriendlyId::FinderMethods
+    has_many :groups, dependent: :delete_all
     has_many :main_navigations, dependent: :delete_all
     has_many :reindexing_log_entries, dependent: :destroy
     has_many :resources
@@ -70,7 +77,7 @@ module Spotlight
     belongs_to :masthead, dependent: :destroy, optional: true
     belongs_to :thumbnail, class_name: 'Spotlight::ExhibitThumbnail', dependent: :destroy, optional: true
 
-    accepts_nested_attributes_for :about_pages, :attachments, :contacts, :custom_fields, :feature_pages, :languages,
+    accepts_nested_attributes_for :about_pages, :attachments, :contacts, :custom_fields, :feature_pages, :groups, :languages,
                                   :main_navigations, :owned_taggings, :pages, :resources, :searches, :solr_document_sidecars, :translations
     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? }
@@ -100,8 +107,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
@@ -149,5 +158,10 @@ module Spotlight
     def current_reindexing_log_entry
       reindexing_log_entries.started_or_completed.first || reindexing_log_entries.build
     end
+
+    def move_friendly_id_error_to_slug
+      errors.add :slug, *errors.delete(:friendly_id) if errors[:friendly_id].present?
+    end
   end
+  # rubocop:enable Metrics/ClassLength
 end