blacklight-spotlight 4.2.0 → 4.3.0

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

@@ -32,7 +32,7 @@ module Spotlight
         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.t(attr_name, scope: slug, default: default, **options).presence
+          I18n.t(attr_name, scope: slug, default:, **options).presence
         end
       end
     end

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

@@ -115,7 +115,7 @@ module Spotlight
 
         @report_data = report_data
 
-        OpenStruct.new({ rows: rows, totals: totals })
+        OpenStruct.new({ rows:, totals: })
       end
 
       private

data/app/models/spotlight/attachment.rb

@@ -8,7 +8,7 @@ module Spotlight
     mount_uploader :file, Spotlight::AttachmentUploader
 
     def as_json(options = nil)
-      file.as_json(options).merge(name: name, uid: uid, attachment: to_global_id)
+      file.as_json(options).merge(name:, uid:, attachment: to_global_id)
     end
   end
 end

data/app/models/spotlight/background_job_progress.rb

@@ -20,7 +20,7 @@ module Spotlight
         finished_at: localized_finish_time,
         updated_at: localized_updated_time,
         total: [total, completed].max,
-        completed: completed,
+        completed:,
         finished: finished?,
         errored: errored?
       }

data/app/models/spotlight/contact_email.rb

@@ -33,7 +33,7 @@ module Spotlight
     end
 
     def send_devise_notification(notification, *args)
-      notice = notification_mailer.send(notification, self, *args, exhibit: exhibit)
+      notice = notification_mailer.send(notification, self, *args, exhibit:)
       if notice.respond_to? :deliver_now
         notice.deliver_now
       else

data/app/models/spotlight/contact_form.rb

@@ -19,8 +19,8 @@ module Spotlight
 
     def headers
       {
-        to: to,
-        subject: I18n.t(:'spotlight.contact_form.subject', application_name: application_name),
+        to:,
+        subject: I18n.t(:'spotlight.contact_form.subject', application_name:),
         cc: contact_emails.join(', ')
       }
     end

data/app/models/spotlight/custom_field.rb

@@ -34,7 +34,7 @@ module Spotlight
     end
 
     def label
-      conf = if field && blacklight_configuration && blacklight_configuration.index_fields.key?(field)
+      conf = if field && blacklight_configuration&.index_fields&.key?(field)
                blacklight_configuration.index_fields[field].reverse_merge(configuration)
              else
                configuration
@@ -74,7 +74,7 @@ module Spotlight
     end
 
     def update_blacklight_configuration_label(label)
-      return unless field && blacklight_configuration && blacklight_configuration.index_fields.key?(field)
+      return unless field && blacklight_configuration&.index_fields&.key?(field)
 
       blacklight_configuration.index_fields[field]['label'] = label
       blacklight_configuration.save

data/app/models/spotlight/custom_search_field.rb

@@ -17,7 +17,7 @@ module Spotlight
     end
 
     def label
-      conf = if slug && blacklight_configuration && blacklight_configuration.search_fields.key?(slug)
+      conf = if slug && blacklight_configuration&.search_fields&.key?(slug)
                blacklight_configuration.search_fields[slug].reverse_merge(configuration)
              else
                configuration
@@ -32,7 +32,7 @@ module Spotlight
     end
 
     def update_blacklight_configuration_label(label)
-      return unless slug && blacklight_configuration && blacklight_configuration.search_fields.key?(slug)
+      return unless slug && blacklight_configuration&.search_fields&.key?(slug)
 
       blacklight_configuration.search_fields[slug]['label'] = label
       blacklight_configuration.save

data/app/models/spotlight/job_tracker.rb

@@ -92,7 +92,7 @@ module Spotlight
     end
 
     def append_log_entry(type:, exhibit: nil, **args)
-      events.create(type: type, exhibit: exhibit, data: args)
+      events.create(type:, exhibit:, data: args)
     rescue StandardError => e
       Rails.logger.error("Unable to create log entry for job tracker #{id}: #{e}")
     end

data/app/models/spotlight/page.rb

@@ -31,7 +31,7 @@ module Spotlight
     scope :at_top_level, -> { where(parent_page_id: nil) }
     scope :published, -> { where(published: true) }
     scope :recent, -> { order('updated_at DESC').limit(10) }
-    scope :for_locale, ->(locale = I18n.locale) { unscope(where: :locale).where(locale: locale) }
+    scope :for_locale, ->(locale = I18n.locale) { unscope(where: :locale).where(locale:) }
     scope :for_default_locale, -> { for_locale(I18n.default_locale) }
 
     has_one :lock, as: :on, dependent: :destroy
@@ -171,7 +171,7 @@ module Spotlight
         end
       end
 
-      translated_pages.update(weight: weight) if saved_change_to_weight?
+      translated_pages.update(weight:) if saved_change_to_weight?
     end
   end
 end

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

@@ -56,21 +56,21 @@ module Spotlight
 
         private
 
-        def recursive_manifests(thing, &block)
+        def recursive_manifests(thing, &)
           return to_enum(:recursive_manifests, thing) unless block_given?
 
-          thing.manifests.each(&block)
+          thing.manifests.each(&)
 
           return if thing.collections.blank?
 
           thing.collections.each do |collection|
-            recursive_manifests(collection, &block)
+            recursive_manifests(collection, &)
           end
         end
       end
 
       def create_iiif_manifest(manifest, collection = nil)
-        IiifManifest.new(url: manifest['@id'], manifest: manifest, collection: collection)
+        IiifManifest.new(url: manifest['@id'], manifest:, collection:)
       end
 
       def manifest?

data/app/models/spotlight/role.rb

@@ -32,7 +32,7 @@ module Spotlight
     #    validates :user, uniqueness: { scope: :exhibit}
     # but it puts the error message on the user_key instead of user so that the form will render correctly
     def user_must_be_unique
-      errors.add(:user_key, 'already a member of this exhibit') if Spotlight::Role.where(resource: resource, user: user).where.not(id: id).any?
+      errors.add(:user_key, 'already a member of this exhibit') if Spotlight::Role.where(resource:, user:).where.not(id:).any?
     end
   end
 end

data/app/models/spotlight/search.rb

@@ -49,14 +49,14 @@ module Spotlight
       thumbnail.iiif_url
     end
 
-    def documents(&block)
+    def documents(&)
       start = 0
       response = repository.search(search_params.start(start))
 
       return to_enum(:documents) { response['response']['numFound'] } unless block_given?
 
       while response.documents.present?
-        response.documents.each(&block)
+        response.documents.each(&)
         start += response.documents.length
         response = repository.search(search_params.start(start))
       end

data/app/services/spotlight/bulk_updates_csv_template_service.rb

@@ -12,9 +12,9 @@ module Spotlight
     end
 
     def template(view_context:, title: true, tags: true, visibility: true)
-      return to_enum(:template, view_context: view_context, title: title, tags: tags, visibility: visibility) unless block_given?
+      return to_enum(:template, view_context:, title:, tags:, visibility:) unless block_given?
 
-      yield ::CSV.generate_line(csv_headers(title: title, tags: tags, visibility: visibility))
+      yield ::CSV.generate_line(csv_headers(title:, tags:, visibility:))
       each_document do |document|
         sidecar = document.sidecar(exhibit)
         yield ::CSV.generate_line([

data/app/services/spotlight/clone_translated_page_from_locale.rb

@@ -13,7 +13,7 @@ module Spotlight
     end
 
     def self.call(locale:, page:)
-      new(locale: locale, page: page).clone
+      new(locale:, page:).clone
     end
 
     def clone

data/app/services/spotlight/etl/pipeline.rb

@@ -59,7 +59,7 @@ module Spotlight
       # @yield (optioanlly..) each transformed document after it is transformed but before
       #        it is sent to the loaders
       def call(context, data: {}, cache: nil, &block)
-        executor(context, cache: cache).call(data: data, &block)
+        executor(context, cache:).call(data:, &block)
       end
 
       ##

data/app/views/shared/_exhibit_navbar.html.erb

@@ -1,2 +1,2 @@
-<%- Spotlight.deprecator.warn("_exhibit_navbar.html.erb will be removed.  Customize the exhibit navbar using components instead.") %>
+<%- Spotlight.deprecator.warn("_exhibit_navbar.html.erb will be removed.  Customize the exhibit navbar using components instead.") if !blacklight_config.key?(:exhibit_navbar_component) %>
 <%= render (blacklight_config&.exhibit_navbar_component || Spotlight::ExhibitNavbarComponent).new %>

data/app/views/spotlight/sir_trevor/blocks/_solr_documents_block.html.erb

@@ -9,11 +9,11 @@
         <div class="box" data-id="<%= document.id %>">
           <div class="contents">
             <% if block_options[:thumbnail_image_url].present? %>
-              <%= link_to_document(document, image_tag(block_options[:thumbnail_image_url], class: 'img-thumbnail', alt: doc_presenter.heading, skip_pipeline: true), counter: -1) %>
+              <%= link_to_document(document, image_tag(block_options[:thumbnail_image_url], class: 'img-thumbnail', alt: resource_alt_text(block_options, doc_presenter.heading), skip_pipeline: true), counter: -1) %>
             <% elsif block_options[:iiif_tilesource_base].present?  %>
-              <%= link_to_document(document, image_tag(block_options[:iiif_tilesource_base] + '/full/!400,400/0/default.jpg', class: 'img-thumbnail', alt: doc_presenter.heading, skip_pipeline: true), counter: -1) %>
+              <%= link_to_document(document, image_tag(block_options[:iiif_tilesource_base] + '/full/!400,400/0/default.jpg', class: 'img-thumbnail', alt: resource_alt_text(block_options, doc_presenter.heading), skip_pipeline: true), counter: -1) %>
             <% elsif doc_presenter.thumbnail.exists? %>
-              <%= doc_presenter.thumbnail.thumbnail_tag({ class: 'img-thumbnail', alt: doc_presenter.heading }, document_counter: -1) %>
+              <%= doc_presenter.thumbnail.thumbnail_tag({ class: 'img-thumbnail', alt: resource_alt_text(block_options, doc_presenter.heading) }, document_counter: -1) %>
             <% end %>
             <% if solr_documents_block.primary_caption? %>
               <div class="caption primary-caption">

data/app/views/spotlight/sir_trevor/blocks/_solr_documents_carousel_block.html.erb

@@ -9,11 +9,11 @@
       <% doc_presenter = document_presenter(document) %>
       <div class="carousel-item <%= 'active' if index == 0 %>" data-id="<%= document.id %>">
         <% if block_options[:full_image_url].present? %>
-          <%= link_to_document(document, image_tag(block_options[:full_image_url], alt: doc_presenter.heading, skip_pipeline: true), counter: -1) %>
+          <%= link_to_document(document, image_tag(block_options[:full_image_url], alt: resource_alt_text(block_options, doc_presenter.heading), skip_pipeline: true), counter: -1) %>
         <% elsif block_options[:iiif_tilesource_base].present?  %>
-          <%= link_to_document(document, image_tag(block_options[:iiif_tilesource_base] + '/full/!800,800/0/default.jpg', alt: doc_presenter.heading, skip_pipeline: true), counter: -1) %>
+          <%= link_to_document(document, image_tag(block_options[:iiif_tilesource_base] + '/full/!800,800/0/default.jpg', alt: resource_alt_text(block_options, doc_presenter.heading), skip_pipeline: true), counter: -1) %>
         <% elsif doc_presenter.thumbnail.exists? %>
-          <%= doc_presenter.thumbnail.thumbnail_tag({ alt: doc_presenter.heading }, document_counter: -1) %>
+          <%= doc_presenter.thumbnail.thumbnail_tag({ alt: resource_alt_text(block_options, doc_presenter.heading) }, document_counter: -1) %>
         <% end %>
         <div class="carousel-caption">
           <% if solr_documents_carousel_block.primary_caption? %>

data/app/views/spotlight/sir_trevor/blocks/_solr_documents_features_block.html.erb

@@ -12,11 +12,11 @@
               <% doc_presenter = document_presenter(document) %>
               <div class="carousel-item <%= 'active' if index == 0 %>" data-id="<%= document.id %>">
                 <% if block_options[:full_image_url].present? %>
-                  <%= link_to_document(document, image_tag(block_options[:full_image_url], alt: doc_presenter.heading, skip_pipeline: true), counter: -1) %>
+                  <%= link_to_document(document, image_tag(block_options[:full_image_url], alt: resource_alt_text(block_options, doc_presenter.heading), skip_pipeline: true), counter: -1) %>
                 <% elsif block_options[:iiif_tilesource_base].present?  %>
-                  <%= link_to_document(document, image_tag(block_options[:iiif_tilesource_base] + '/full/!800,800/0/default.jpg', alt: doc_presenter.heading, skip_pipeline: true), counter: -1) %>
+                  <%= link_to_document(document, image_tag(block_options[:iiif_tilesource_base] + '/full/!800,800/0/default.jpg', alt: resource_alt_text(block_options, doc_presenter.heading), skip_pipeline: true), counter: -1) %>
                 <% elsif doc_presenter.thumbnail.exists? %>
-                  <%= doc_presenter.thumbnail.thumbnail_tag({ alt: doc_presenter.heading }, document_counter: -1) %>
+                  <%= doc_presenter.thumbnail.thumbnail_tag({ alt: resource_alt_text(block_options, doc_presenter.heading) }, document_counter: -1) %>
                 <% end %>
               </div>
 

data/app/views/spotlight/sir_trevor/blocks/_solr_documents_grid_block.html.erb

@@ -6,11 +6,11 @@
           <% doc_presenter = document_presenter(document) %>
           <div class="box item-<%= index %>" data-id="<%= document.id %>">
             <% if block_options[:thumbnail_image_url].present? %>
-              <%= link_to_document(document, image_tag(block_options[:thumbnail_image_url], class: 'img-thumbnail', alt: doc_presenter.heading, skip_pipeline: true), counter: -1) %>
+              <%= link_to_document(document, image_tag(block_options[:thumbnail_image_url], class: 'img-thumbnail', alt: resource_alt_text(block_options, doc_presenter.heading), skip_pipeline: true), counter: -1) %>
             <% elsif block_options[:iiif_tilesource_base].present?  %>
-              <%= link_to_document(document, image_tag(block_options[:iiif_tilesource_base] + '/full/!400,400/0/default.jpg', class: 'img-thumbnail', alt: doc_presenter.heading, skip_pipeline: true), counter: -1) %>
+              <%= link_to_document(document, image_tag(block_options[:iiif_tilesource_base] + '/full/!400,400/0/default.jpg', class: 'img-thumbnail', alt: resource_alt_text(block_options, doc_presenter.heading), skip_pipeline: true), counter: -1) %>
             <% elsif doc_presenter.thumbnail.exists? %>
-              <%= doc_presenter.thumbnail.thumbnail_tag({ class: 'img-thumbnail', alt: doc_presenter.heading }, document_counter: -1) %>
+              <%= doc_presenter.thumbnail.thumbnail_tag({ class: 'img-thumbnail', alt: resource_alt_text(block_options, doc_presenter.heading) }, document_counter: -1) %>
             <% end %>
           </div>
         <% end %>

data/app/views/spotlight/sir_trevor/blocks/_uploaded_items_block.html.erb

@@ -6,10 +6,11 @@
           <div class="contents">
             <% if file[:link].present? %>
               <%= link_to file[:link], rel: 'ugc' do %>
-                <%= image_tag file[:url], class: 'img-thumbnail', alt: file[:caption] %>
+                <%= image_tag file[:url], class: 'img-thumbnail', alt: resource_alt_text(file, file[:caption]) %>
               <% end %>
             <% else %>
-              <%= image_tag file[:url], class: 'img-thumbnail', alt: '', role: 'presentation' %>
+              <% alt_text = resource_alt_text(file, '') %>
+              <%= image_tag file[:url], class: 'img-thumbnail', alt: alt_text, role: alt_text.present? ? nil : 'presentation' %>
             <% end %>
             <% if file[:caption].present? %>
               <div class="caption">

data/lib/migration/iiif.rb

@@ -32,7 +32,7 @@ module Migration
     def migrate_contact_avatars
       Spotlight::Contact.all.find_each do |contact|
         avatar = copy_contact_image_to_avatar(contact)
-        contact.update(avatar: avatar) if avatar
+        contact.update(avatar:) if avatar
       end
     end
 
@@ -70,7 +70,7 @@ module Migration
       old_file = File.new(filepath)
       image = contact.create_avatar { |i| i.image.store!(old_file) }
       iiif_tilesource = Spotlight::Engine.config.iiif_service.info_url(image)
-      image.update(iiif_tilesource: iiif_tilesource, iiif_region: avatar_coordinates(contact))
+      image.update(iiif_tilesource:, iiif_region: avatar_coordinates(contact))
       image
     end
 
@@ -84,7 +84,7 @@ module Migration
       old_file = File.new(filepath)
       image = upload.create_upload { |i| i.image.store!(old_file) }
       iiif_tilesource = Spotlight::Engine.config.iiif_service.info_url(image)
-      image.update(iiif_tilesource: iiif_tilesource)
+      image.update(iiif_tilesource:)
       upload.upload_id = image.id
       upload.save_and_index
     end

data/lib/spotlight/engine.rb

@@ -330,23 +330,10 @@ module Spotlight
 
     config.exhibit_roles = %w[admin curator viewer]
     # PaperTrail serializes objects to YAML, so we need to permit these classes to be deserialized
-    if ActiveRecord.respond_to?(:yaml_column_permitted_classes)
-      # Rails >= 7.0
-      ActiveRecord.yaml_column_permitted_classes ||= []
-      ActiveRecord.yaml_column_permitted_classes += [Symbol,
-                                                     ActiveSupport::HashWithIndifferentAccess,
-                                                     ActiveSupport::TimeWithZone,
-                                                     ActiveSupport::TimeZone,
-                                                     Time]
-    elsif ActiveRecord::Base.respond_to?(:yaml_column_permitted_classes)
-      # Rails 6.1
-      ActiveRecord::Base.yaml_column_permitted_classes ||= []
-      ActiveRecord::Base.yaml_column_permitted_classes += [Symbol,
-                                                           ActiveSupport::HashWithIndifferentAccess,
-                                                           ActiveSupport::TimeWithZone,
-                                                           ActiveSupport::TimeZone,
-                                                           Time]
-    end
+    ActiveRecord.yaml_column_permitted_classes += [ActiveSupport::HashWithIndifferentAccess,
+                                                   ActiveSupport::TimeWithZone,
+                                                   ActiveSupport::TimeZone,
+                                                   Time]
   end
   # rubocop:enable Metrics/ClassLength
 end

data/lib/spotlight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spotlight
-  VERSION = '4.2.0'
+  VERSION = '4.3.0'
 end

data/lib/tasks/spotlight_tasks.rake

@@ -20,7 +20,7 @@ namespace :spotlight do
     email = 'admin@localhost'
     password = 'testing'
 
-    u = Spotlight::Engine.user_class.find_or_create_by!(email: email) do |user|
+    u = Spotlight::Engine.user_class.find_or_create_by!(email:) do |user|
       user.password = password
     end
     Spotlight::Role.create(user: u, resource: Spotlight::Site.instance, role: 'admin')
@@ -33,7 +33,7 @@ namespace :spotlight do
     title = prompt_for_title
     slug = prompt_for_slug
 
-    exhibit = Spotlight::Exhibit.create!({ title: title, slug: slug })
+    exhibit = Spotlight::Exhibit.create!({ title:, slug: })
 
     puts 'Who can admin this exhibit?'
 
@@ -55,7 +55,7 @@ namespace :spotlight do
 
     slug = args[:exhibit_slug] || data['slug']
 
-    exhibit = Spotlight::Exhibit.find_or_create_by! slug: slug do |e|
+    exhibit = Spotlight::Exhibit.find_or_create_by!(slug:) do |e|
       e.title = data['title']
     end
 

data/spec/factories/exhibits.rb

@@ -4,7 +4,7 @@ FactoryBot.define do
   factory :exhibit, class: 'Spotlight::Exhibit' do
     sequence(:title) { |n| "Exhibit Title #{n}" }
     published { true }
-    after(:build) { |exhibit| exhibit.searches << FactoryBot.build(:default_search, exhibit: exhibit) }
+    after(:build) { |exhibit| exhibit.searches << FactoryBot.build(:default_search, exhibit:) }
 
     trait :with_thumbnail do
       association :thumbnail, factory: :exhibit_thumbnail

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-spotlight
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Chris Beer
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-08 00:00:00.000000000 Z
+date: 2024-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob-status
@@ -1579,7 +1579,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="