blacklight-spotlight 3.0.0.alpha.2 → 3.0.0.alpha.3

data/app/controllers/spotlight/contacts_controller.rb

@@ -50,7 +50,7 @@ module Spotlight
     def contact_params
       params.require(:contact).permit(:name,
                                       contact_info: Spotlight::Contact.fields.keys,
-                                      avatar_attributes: [:iiif_tilesource, :iiif_region])
+                                      avatar_attributes: %i[iiif_tilesource iiif_region])
     end
   end
 end

data/app/controllers/spotlight/custom_fields_controller.rb

@@ -8,7 +8,7 @@ module Spotlight
 
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
     load_and_authorize_resource through: :exhibit
-    before_action :attach_breadcrumbs, only: [:new, :edit]
+    before_action :attach_breadcrumbs, only: %i[new edit]
 
     def new
       @custom_field.field_type ||= 'text'

data/app/controllers/spotlight/custom_search_fields_controller.rb

@@ -7,7 +7,7 @@ module Spotlight
 
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
     load_and_authorize_resource through: :exhibit
-    before_action :attach_breadcrumbs, only: [:new, :edit]
+    before_action :attach_breadcrumbs, only: %i[new edit]
 
     # GET /custom_search_fields/new
     def new

data/app/controllers/spotlight/exhibits_controller.rb

@@ -6,7 +6,7 @@ module Spotlight
   class ExhibitsController < Spotlight::ApplicationController
     include Spotlight::SearchHelper
     before_action :authenticate_user!, except: [:index]
-    before_action :set_tab, only: [:edit, :update]
+    before_action :set_tab, only: %i[edit update]
 
     load_and_authorize_resource
 
@@ -83,7 +83,7 @@ module Spotlight
     protected
 
     def current_exhibit
-      @exhibit if @exhibit && @exhibit.persisted?
+      @exhibit if @exhibit&.persisted?
     end
 
     def exhibit_params
@@ -93,8 +93,8 @@ module Spotlight
         :description,
         :published,
         :tag_list,
-        contact_emails_attributes: [:id, :email],
-        languages_attributes: [:id, :public]
+        contact_emails_attributes: %i[id email],
+        languages_attributes: %i[id public]
       )
     end
 

data/app/controllers/spotlight/feature_pages_controller.rb

@@ -26,9 +26,7 @@ module Spotlight
     end
 
     def attach_page_breadcrumbs
-      if action_name == 'edit'
-        add_breadcrumb t(:'spotlight.curation.sidebar.feature_pages'), exhibit_feature_pages_path(@exhibit)
-      end
+      add_breadcrumb t(:'spotlight.curation.sidebar.feature_pages'), exhibit_feature_pages_path(@exhibit) if action_name == 'edit'
 
       add_breadcrumb @page.parent_page.title, [spotlight, @page.exhibit, @page.parent_page] unless @page.top_level_page?
       add_breadcrumb @page.title, action_name == 'edit' ? [:edit, @page.exhibit, @page] : [spotlight, @page.exhibit, @page]
@@ -42,12 +40,12 @@ module Spotlight
     def update_all_page_params
       params.require(:exhibit).permit(
         'feature_pages_attributes' => page_attributes,
-        'home_page_attributes' => [:id, :title, :display_title]
+        'home_page_attributes' => %i[id title display_title]
       )
     end
 
     def allowed_page_params
-      super.concat [:display_sidebar, :published]
+      super.concat %i[display_sidebar published]
     end
   end
 end

data/app/controllers/spotlight/filters_controller.rb

@@ -17,9 +17,7 @@ module Spotlight
     end
 
     def update
-      unless @filter.update(filter_params)
-        flash[:alert] = @filter.errors.full_messages.join('<br/>'.html_safe)
-      end
+      flash[:alert] = @filter.errors.full_messages.join('<br/>'.html_safe) unless @filter.update(filter_params)
       redirect_to spotlight.edit_exhibit_path @exhibit, tab: 'filter'
     end
 

data/app/controllers/spotlight/home_pages_controller.rb

@@ -76,7 +76,7 @@ module Spotlight
     end
 
     def allowed_page_params
-      super.concat [:display_title, :display_sidebar]
+      super.concat %i[display_title display_sidebar]
     end
   end
 end

data/app/controllers/spotlight/metadata_configurations_controller.rb

@@ -44,7 +44,7 @@ module Spotlight
       views = @blacklight_configuration.default_blacklight_config.view.keys | [:show]
 
       @blacklight_configuration.blacklight_config.index_fields.keys.each_with_object({}) do |element, result|
-        result[element] = ([:enabled, :label, :weight] | views)
+        result[element] = (%i[enabled label weight] | views)
       end
     end
   end

data/app/controllers/spotlight/pages_controller.rb

@@ -8,7 +8,7 @@ module Spotlight
   # controller that gives other controllers their behavior
   class PagesController < Spotlight::ApplicationController
     before_action :authenticate_user!, except: [:show]
-    before_action :load_locale_specific_page, only: [:destroy, :edit, :show, :update]
+    before_action :load_locale_specific_page, only: %i[destroy edit show update]
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
     load_and_authorize_resource through: :exhibit, instance_name: 'page', only: [:index]
 
@@ -71,7 +71,7 @@ module Spotlight
 
     # PATCH/PUT /pages/1
     def update
-      @page.lock.delete if @page.lock
+      @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)
@@ -146,7 +146,7 @@ module Spotlight
     end
 
     def page_attributes
-      [:id, :published, :title, :weight, :display_sidebar, :parent_page_id]
+      %i[id published title weight display_sidebar parent_page_id]
     end
 
     def allowed_page_params
@@ -154,9 +154,9 @@ module Spotlight
     end
 
     def featured_image_attributes
-      [
-        :source, :image, :document_global_id, :iiif_region, :iiif_tilesource,
-        :iiif_manifest_url, :iiif_canvas_id, :iiif_image_id
+      %i[
+        source image document_global_id iiif_region iiif_tilesource
+        iiif_manifest_url iiif_canvas_id iiif_image_id
       ]
     end
 
@@ -188,7 +188,7 @@ module Spotlight
 
     def update_all_page_params
       params.require(:exhibit).permit(
-        pages_attributes: [:id, :published]
+        pages_attributes: %i[id published]
       )
     end
 

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

@@ -9,7 +9,7 @@ module Spotlight
       helper :all
 
       before_action :authenticate_user!
-      before_action :set_tab, only: [:new, :create]
+      before_action :set_tab, only: %i[new create]
 
       load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
       before_action :build_resource

data/app/controllers/spotlight/resources_controller.rb

@@ -5,7 +5,7 @@ module Spotlight
   # CRUD actions for exhibit resources
   class ResourcesController < Spotlight::ApplicationController
     before_action :authenticate_user!, except: [:show]
-    before_action :set_tab, only: [:new, :create]
+    before_action :set_tab, only: %i[new create]
 
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
 

data/app/controllers/spotlight/roles_controller.rb

@@ -34,7 +34,7 @@ module Spotlight
     protected
 
     def exhibit_params
-      params.require(:exhibit).permit(roles_attributes: [:id, :user_key, :role, :_destroy])
+      params.require(:exhibit).permit(roles_attributes: %i[id user_key role _destroy])
     end
 
     def any_deleted

data/app/controllers/spotlight/search_configurations_controller.rb

@@ -49,19 +49,19 @@ module Spotlight
 
     def exhibit_configuration_facet_params
       @blacklight_configuration.blacklight_config.facet_fields.keys.each_with_object({}) do |element, result|
-        result[element] = [:show, :label, :weight, :sort]
+        result[element] = %i[show label weight sort]
       end
     end
 
     def exhibit_configuration_search_params
       @blacklight_configuration.blacklight_config.search_fields.keys.each_with_object({}) do |element, result|
-        result[element] = [:enabled, :label, :weight]
+        result[element] = %i[enabled label weight]
       end
     end
 
     def exhibit_configuration_sort_params
       @blacklight_configuration.blacklight_config.sort_fields.keys.each_with_object({}) do |element, result|
-        result[element] = [:enabled, :label, :weight]
+        result[element] = %i[enabled label weight]
       end
     end
   end

data/app/controllers/spotlight/searches_controller.rb

@@ -10,7 +10,7 @@ module Spotlight
     before_action :only_curators!
     before_action :create_or_load_resource, only: [:create]
     load_and_authorize_resource through: :exhibit
-    before_action :attach_breadcrumbs, only: [:index, :edit], unless: -> { request.format.json? }
+    before_action :attach_breadcrumbs, only: %i[index edit], unless: -> { request.format.json? }
 
     include Spotlight::Base
     include Spotlight::SearchHelper
@@ -31,7 +31,7 @@ module Spotlight
       respond_to do |format|
         format.html
         format.json do
-          render json: @searches.as_json(methods: [:count, :thumbnail_image_url]), root: false
+          render json: @searches.as_json(methods: %i[count thumbnail_image_url]), root: false
         end
       end
     end
@@ -92,14 +92,14 @@ module Spotlight
     end
 
     def attach_breadcrumbs
-      e = @exhibit || (@search.exhibit if @search)
+      e = @exhibit || @search&.exhibit
       add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: e.title), e
       add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(e)
       add_breadcrumb t(:'spotlight.curation.sidebar.browse'), exhibit_searches_path(e)
     end
 
     def batch_search_params
-      params.require(:exhibit).permit('searches_attributes' => [:id, :published, :weight])
+      params.require(:exhibit).permit('searches_attributes' => %i[id published weight])
     end
 
     def search_params
@@ -118,13 +118,13 @@ module Spotlight
     end
 
     def featured_image_params
-      [
-        :iiif_region, :iiif_tilesource,
-        :iiif_manifest_url, :iiif_canvas_id, :iiif_image_id,
-        :display,
-        :source,
-        :image,
-        :document_global_id
+      %i[
+        iiif_region iiif_tilesource
+        iiif_manifest_url iiif_canvas_id iiif_image_id
+        display
+        source
+        image
+        document_global_id
       ]
     end
 
@@ -133,7 +133,7 @@ module Spotlight
     end
 
     def blacklisted_search_session_params
-      [:id, :commit, :counter, :total, :search_id, :page, :per_page, :authenticity_token, :utf8, :action, :controller]
+      %i[id commit counter total search_id page per_page authenticity_token utf8 action controller]
     end
 
     def fallback_url

data/app/controllers/spotlight/sites_controller.rb

@@ -40,15 +40,15 @@ module Spotlight
         :title,
         :subtitle,
         masthead_attributes: masthead_params,
-        exhibits_attributes: [:id, :weight]
+        exhibits_attributes: %i[id weight]
       )
     end
 
     def masthead_params
-      [
-        :display,
-        :iiif_region,
-        :iiif_tilesource
+      %i[
+        display
+        iiif_region
+        iiif_tilesource
       ]
     end
   end

data/app/controllers/spotlight/translations_controller.rb

@@ -22,7 +22,7 @@ module Spotlight
     private
 
     def exhibit_params
-      params.require(:exhibit).permit(translations_attributes: [:id, :locale, :key, :value])
+      params.require(:exhibit).permit(translations_attributes: %i[id locale key value])
     end
 
     def set_language

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
-      config.label || blacklight_config.index_fields[solr_field].try(:label) || t(".#{solr_field}")
+      blacklight_config.index_fields[solr_field].try(:label) || config.label || t(".#{solr_field}")
     end
 
     def available_view_fields
@@ -143,13 +143,13 @@ module Spotlight
       if current_exhibit_theme && current_exhibit.theme != 'default'
         stylesheet_link_tag "#{tag}_#{current_exhibit_theme}"
       else
-        Rails.logger.warn "Exhibit theme '#{current_exhibit_theme}' not in white-list of available themes: #{Spotlight::Engine.config.exhibit_themes}"
+        Rails.logger.warn "Exhibit theme '#{current_exhibit_theme}' not in white-list of available themes: #{current_exhibit.themes}"
         stylesheet_link_tag(tag)
       end
     end
 
     def current_exhibit_theme
-      current_exhibit.theme if current_exhibit && current_exhibit.theme.present? && Spotlight::Engine.config.exhibit_themes.include?(current_exhibit.theme)
+      current_exhibit.theme if current_exhibit && current_exhibit.theme.present? && current_exhibit.themes.include?(current_exhibit.theme)
     end
 
     private

data/app/helpers/spotlight/main_app_helpers.rb

@@ -5,6 +5,8 @@ module Spotlight
   # Helpers that are injected into the main application (because they used in layouts)
   module MainAppHelpers
     include Spotlight::NavbarHelper
+    include Spotlight::MastheadHelper
+
     def cache_key_for_spotlight_exhibits
       "#{Spotlight::Exhibit.count}/#{Spotlight::Exhibit.maximum(:updated_at).try(:utc)}"
     end
@@ -22,9 +24,7 @@ module Spotlight
     end
 
     def link_back_to_catalog(opts = { label: nil })
-      if (current_search_session.try(:query_params) || {}).fetch(:controller, '').starts_with? 'spotlight'
-        opts[:route_set] ||= spotlight
-      end
+      opts[:route_set] ||= spotlight if (current_search_session.try(:query_params) || {}).fetch(:controller, '').starts_with? 'spotlight'
       super
     end
 
@@ -38,16 +38,16 @@ module Spotlight
     end
 
     def exhibit_stylesheet_link_tag(tag)
-      if current_exhibit_theme && current_exhibit.theme != 'default'
+      if current_exhibit_theme && current_exhibit&.theme != 'default'
         stylesheet_link_tag "#{tag}_#{current_exhibit_theme}"
       else
-        Rails.logger.warn "Exhibit theme '#{current_exhibit_theme}' not in white-list of available themes: #{Spotlight::Engine.config.exhibit_themes}"
+        Rails.logger.warn "Exhibit theme '#{current_exhibit_theme}' not in white-list of available themes: #{current_exhibit&.themes}"
         stylesheet_link_tag(tag)
       end
     end
 
     def current_exhibit_theme
-      current_exhibit.theme if current_exhibit && current_exhibit.theme.present? && Spotlight::Engine.config.exhibit_themes.include?(current_exhibit.theme)
+      current_exhibit.theme if current_exhibit && current_exhibit.theme.present? && current_exhibit.themes.include?(current_exhibit.theme)
     end
   end
 end

data/app/helpers/spotlight/masthead_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ##
+  # Helper module for content in mastheads
+  module MastheadHelper
+    def masthead_heading_content
+      return current_exhibit.title if current_exhibit
+
+      application_name
+    end
+
+    def masthead_subheading_content
+      return current_exhibit&.subtitle&.presence if current_exhibit
+
+      current_site&.subtitle&.presence
+    end
+  end
+end

data/app/helpers/spotlight/search_configurations_helper.rb

@@ -10,13 +10,15 @@ module Spotlight
     def translate_sort_fields(sort_config)
       sort_description = sort_config[:sort_description] if sort_config[:sort_description]
 
-      sort_description ||= sort_config[:sort].split(',').map do |sort|
-        sort_field, sort_order = sort.split(' ')
-        safe_join([
-                    t(:"spotlight.search_configurations.sort.keys.#{sort_field.strip}", default: sort_field.humanize.downcase),
-                    t(:"spotlight.search_configurations.sort.keys.#{sort_order.strip}", default: '')
-                  ], ' ')
-      end.to_sentence if sort_config[:sort]
+      if sort_config[:sort]
+        sort_description ||= sort_config[:sort].split(',').map do |sort|
+          sort_field, sort_order = sort.split(' ')
+          safe_join([
+                      t(:"spotlight.search_configurations.sort.keys.#{sort_field.strip}", default: sort_field.humanize.downcase),
+                      t(:"spotlight.search_configurations.sort.keys.#{sort_order.strip}", default: '')
+                    ], ' ')
+        end.to_sentence
+      end
 
       sort_description
     end

data/app/helpers/spotlight/searches_helper.rb

@@ -4,7 +4,7 @@ module Spotlight
   # Saved search helpers
   module SearchesHelper
     def available_document_index_views
-      blacklight_config.view.select { |_k, v| v.if != false }.keys
+      blacklight_config.view.to_h.reject { |_k, v| v.if == false }.keys
     end
   end
 end

data/app/jobs/spotlight/add_uploads_from_csv.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module Spotlight

data/app/jobs/spotlight/reindex_job.rb

@@ -23,16 +23,16 @@ module Spotlight
 
     around_perform do |job, block|
       job_log_entry = log_entry(job)
-      job_log_entry.in_progress! if job_log_entry
+      job_log_entry&.in_progress!
 
       begin
         block.call
-      rescue
-        job_log_entry.failed! if job_log_entry
+      rescue StandardError
+        job_log_entry&.failed!
         raise
       end
 
-      job_log_entry.succeeded! if job_log_entry
+      job_log_entry&.succeeded!
     end
 
     def self.perform_later(exhibit_or_resources, log_entry = nil)