blacklight-spotlight 3.6.0.beta6 → 3.6.0.beta7

data/app/controllers/spotlight/tags_controller.rb

@@ -38,7 +38,7 @@ module Spotlight
 
     def update_all
       tags_to_rename = batch_update_params['owned_tags_attributes'].values.select do |tag|
-        tag[:name]&.present? && tag[:current_name]&.strip != tag[:name]&.strip
+        tag[:name].present? && tag[:current_name]&.strip != tag[:name]&.strip
       end
 
       rename_tags_later!(tags_to_rename)

data/app/javascript/spotlight/admin/blocks/solr_documents_base_block.js

@@ -48,19 +48,24 @@ SirTrevor.Blocks.SolrDocumentsBase = (function(){
       </div>
     `},
 
-    _itemPanelIiifFields: function(index, data) {
+    // Sets the first version of the IIIF information from autocomplete data.
+    _itemPanelIiifFields: function(index, autocomplete_data) {
       return [
         // '<input type="hidden" name="item[' + index + '][iiif_region]" value="' + (data.iiif_region) + '"/>',
         // for legacy compatiblity:
-        '<input type="hidden" name="item[' + index + '][thumbnail_image_url]" value="' + (data.thumbnail_image_url || data.thumbnail || "") + '"/>',
-        '<input type="hidden" name="item[' + index + '][full_image_url]" value="' + (data.full_image_url || data.thumbnail_image_url || data.thumbnail || "") + '"/>',
-        '<input type="hidden" name="item[' + index + '][iiif_tilesource]" value="' + (data.iiif_tilesource) + '"/>',
-        '<input type="hidden" name="item[' + index + '][iiif_manifest_url]" value="' + (data.iiif_manifest_url) + '"/>',
-        '<input type="hidden" name="item[' + index + '][iiif_canvas_id]" value="' + (data.iiif_canvas_id) + '"/>',
-        '<input type="hidden" name="item[' + index + '][iiif_image_id]" value="' + (data.iiif_image_id) + '"/>',
+        '<input type="hidden" name="item[' + index + '][thumbnail_image_url]" value="' + (autocomplete_data.thumbnail_image_url || autocomplete_data.thumbnail || "") + '"/>',
+        '<input type="hidden" name="item[' + index + '][full_image_url]" value="' + (autocomplete_data.full_image_url || autocomplete_data.thumbnail_image_url || autocomplete_data.thumbnail || "") + '"/>',
+        '<input type="hidden" name="item[' + index + '][iiif_tilesource]" value="' + (autocomplete_data.iiif_tilesource) + '"/>',
+        '<input type="hidden" name="item[' + index + '][iiif_manifest_url]" value="' + (autocomplete_data.iiif_manifest_url) + '"/>',
+        '<input type="hidden" name="item[' + index + '][iiif_canvas_id]" value="' + (autocomplete_data.iiif_canvas_id) + '"/>',
+        '<input type="hidden" name="item[' + index + '][iiif_image_id]" value="' + (autocomplete_data.iiif_image_id) + '"/>',
       ].join("\n");
     },
-    setIiifFields: function(panel, data, initialize) {
+    // Overwrites the hidden inputs from _itemPanelIiifFields with data from the
+    // manifest. Called by afterPanelRender - the manifest_data here is built
+    // from canvases in the manifest, transformed by spotlight/admin/iiif.js in
+    // the #images method.
+    setIiifFields: function(panel, manifest_data, initialize) {
       var legacyThumbnailField = $(panel).find('[name$="[thumbnail_image_url]"]')
       var legacyFullField = $(panel).find('[name$="[full_image_url]"]')
 
@@ -70,11 +75,11 @@ SirTrevor.Blocks.SolrDocumentsBase = (function(){
 
       legacyThumbnailField.val("");
       legacyFullField.val("");
-      $(panel).find('[name$="[iiif_image_id]"]').val(data.imageId);
-      $(panel).find('[name$="[iiif_tilesource]"]').val(data.tilesource);
-      $(panel).find('[name$="[iiif_manifest_url]"]').val(data.manifest);
-      $(panel).find('[name$="[iiif_canvas_id]"]').val(data.canvasId);
-      $(panel).find('img.img-thumbnail').attr('src', data.thumbnail_image_url || data.tilesource.replace("/info.json", "/full/100,100/0/default.jpg"));
+      $(panel).find('[name$="[iiif_image_id]"]').val(manifest_data.imageId);
+      $(panel).find('[name$="[iiif_tilesource]"]').val(manifest_data.tilesource);
+      $(panel).find('[name$="[iiif_manifest_url]"]').val(manifest_data.manifest);
+      $(panel).find('[name$="[iiif_canvas_id]"]').val(manifest_data.canvasId);
+      $(panel).find('img.img-thumbnail').attr('src', manifest_data.thumbnail_image_url || manifest_data.tilesource.replace("/info.json", "/full/100,100/0/default.jpg"));
     },
     afterPanelRender: function(data, panel) {
       var context = this;

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

@@ -31,12 +31,21 @@ module Spotlight
 
       solr_params.append_query(query) if query.present?
 
+      # for a browse category formed from a saved search, the query syntax reads as two "must" values
+      # e.g.  "json"=>{"query"=>{"bool"=>{"must"=>["savedsearchterm", "browsecategorysearchterm"]}}}}
+      must_values = solr_params.dig(:json, :query, :bool, :must)
+
+      return unless must_values&.any?
+
+      # this type of query must be parsed by lucene to function
+      solr_params[:defType] = 'lucene'
+
       # This replicates existing spotlight 2.x search behavior, more or less. It
       # doesn't take into account the possibility that the browse category query
       # could use a different search field (which.. doesn't have an existing UI
       # control.. and may require additional upstream work to properly encapsulate
       # the two query parameters)
-      solr_params.dig(:json, :query, :bool, :must)&.map! do |q|
+      must_values.map! do |q|
         q.is_a?(String) ? { edismax: { query: q } } : q
       end
     end

data/app/models/spotlight/blacklight_configuration.rb

@@ -10,15 +10,15 @@ module Spotlight
     has_paper_trail
 
     belongs_to :exhibit, touch: true, optional: true
-    serialize :facet_fields, Hash
-    serialize :index_fields, Hash
-    serialize :search_fields, Hash
-    serialize :sort_fields, Hash
-    serialize :default_solr_params, Hash
-    serialize :show, Hash
-    serialize :index, Hash
-    serialize :per_page, Array
-    serialize :document_index_view_types, Array
+    serialize :facet_fields, Hash, coder: YAML
+    serialize :index_fields, Hash, coder: YAML
+    serialize :search_fields, Hash, coder: YAML
+    serialize :sort_fields, Hash, coder: YAML
+    serialize :default_solr_params, Hash, coder: YAML
+    serialize :show, Hash, coder: YAML
+    serialize :index, Hash, coder: YAML
+    serialize :per_page, Array, coder: YAML
+    serialize :document_index_view_types, Array, coder: YAML
 
     include Spotlight::BlacklightConfigurationDefaults
 

data/app/models/spotlight/contact.rb

@@ -7,7 +7,7 @@ module Spotlight
     belongs_to :exhibit, touch: true, optional: true
     scope :published, -> { where(show_in_sidebar: true) }
     default_scope { order('weight ASC') }
-    serialize :contact_info, Hash
+    serialize :contact_info, Hash, coder: YAML
 
     extend FriendlyId
     friendly_id :name, use: %i[slugged scoped finders], scope: :exhibit

data/app/models/spotlight/contact_form.rb

@@ -8,7 +8,7 @@ module Spotlight
 
     attr_accessor :current_exhibit, :name, :email, Spotlight::Engine.config.spambot_honeypot_email_field, :message, :current_url, :request
 
-    validates :email, format: { with: /\A([\w.%+\-]+)@([\w\-]+\.)+(\w{2,})\z/i }
+    validates :email, format: { with: /\A([\w.%+-]+)@([\w-]+\.)+(\w{2,})\z/i }
 
     # the spambot_honeypot_email_field field is intended to be hidden visually from the user,
     # in hope that a spam bot filling out the form will enter a value, whereas a human with a

data/app/models/spotlight/custom_field.rb

@@ -4,7 +4,7 @@ module Spotlight
   ##
   # Exhibit custom fields
   class CustomField < ActiveRecord::Base
-    serialize :configuration, Hash
+    serialize :configuration, Hash, coder: YAML
     belongs_to :exhibit, optional: true
 
     extend FriendlyId

data/app/models/spotlight/custom_search_field.rb

@@ -3,7 +3,7 @@
 module Spotlight
   # Exhibit-specific custom search fields
   class CustomSearchField < ApplicationRecord
-    serialize :configuration, Hash
+    serialize :configuration, Hash, coder: YAML
     belongs_to :exhibit
 
     def label=(label)

data/app/models/spotlight/event.rb

@@ -6,7 +6,7 @@ module Spotlight
     belongs_to :resource, polymorphic: true
     belongs_to :exhibit, optional: true
 
-    serialize :data
+    serialize :data, coder: YAML
 
     self.inheritance_column = :event_class
   end

data/app/models/spotlight/exhibit.rb

@@ -35,7 +35,7 @@ module Spotlight
     acts_as_tagger
     acts_as_taggable
     delegate :blacklight_config, to: :blacklight_configuration
-    serialize :facets, Array
+    serialize :facets, Array, coder: YAML
 
     # NOTE: friendly id associations need to be 'destroy'ed to reap the slug history
     has_many :about_pages, -> { for_default_locale }, extend: FriendlyId::FinderMethods

data/app/models/spotlight/job_tracker.rb

@@ -14,7 +14,7 @@ module Spotlight
     has_many :job_trackers, as: :on, dependent: Rails.version > '6.1' ? :destroy_async : :destroy
     has_many :subevents, through: :job_trackers, source: :events
 
-    serialize :data
+    serialize :data, coder: YAML
 
     after_initialize do
       self.data ||= {}

data/app/models/spotlight/resource.rb

@@ -25,7 +25,7 @@ module Spotlight
     has_many :solr_document_sidecars
     has_many :events, as: :resource
 
-    serialize :data, Hash
+    serialize :data, Hash, coder: YAML
 
     ##
     # Persist the record to the database, and trigger a reindex to solr

data/app/models/spotlight/solr_document_sidecar.rb

@@ -11,8 +11,8 @@ module Spotlight
     belongs_to :exhibit, optional: false
     belongs_to :resource, optional: true
     belongs_to :document, optional: false, polymorphic: true
-    serialize :data, Hash
-    serialize :index_status, Hash
+    serialize :data, Hash, coder: YAML
+    serialize :index_status, Hash, coder: YAML
 
     delegate :has_key?, :key?, to: :data
 
@@ -101,8 +101,10 @@ module Spotlight
     def convert_stored_value_to_solr(value)
       if value.blank?
         nil
-      elsif value.is_a? Enumerable
+      elsif value.is_a? Array
         value.reject(&:blank?)
+      elsif value.is_a? Hash
+        value.values.reject(&:blank?)
       else
         value
       end

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

@@ -56,7 +56,7 @@ module Spotlight
       # @private
       # @yield Logger
       def with_logger
-        logger = (context&.logger || Rails.logger)
+        logger = context&.logger || Rails.logger
         logger.tagged(pipeline.class) do
           logger.tagged("#<#{source.class} id=#{source&.id if source.respond_to?(:id)}>") do
             @logger = logger

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

@@ -53,7 +53,7 @@ module Spotlight
                                data: [document].to_json,
                                headers: { 'Content-Type' => 'application/json' }
       rescue StandardError => e
-        pipeline&.on_error(self, e, document.to_json)
+        pipeline&.on_error(e, document.to_json)
       end
 
       def blacklight_solr

data/app/services/spotlight/invite_users_service.rb

@@ -7,7 +7,7 @@ module Spotlight
   # need to be persisted in order to generate the appropriate content in the invitation email.
   class InviteUsersService
     def self.call(resource:)
-      resource.roles.includes(:user).each do |role|
+      resource.roles.includes(:user).find_each do |role|
         user = role.user
 
         user.deliver_invitation if user.created_by_invite? && user.invitation_sent_at.blank?

data/lib/migration/iiif.rb

@@ -23,21 +23,21 @@ module Migration
     private
 
     def migrate_featured_images
-      Spotlight::FeaturedImage.all.each do |image|
+      Spotlight::FeaturedImage.all.find_each do |image|
         update_iiif_url(image)
         copy_exhibit_thumbnail_from_featured_image(image)
       end
     end
 
     def migrate_contact_avatars
-      Spotlight::Contact.all.each do |contact|
+      Spotlight::Contact.all.find_each do |contact|
         avatar = copy_contact_image_to_avatar(contact)
         contact.update(avatar: avatar) if avatar
       end
     end
 
     def migrate_upload_images
-      Spotlight::Resources::Upload.all.each do |upload|
+      Spotlight::Resources::Upload.all.find_each do |upload|
         copy_upload_to_featured_image(upload)
       end
     end

data/lib/spotlight/engine.rb

@@ -334,10 +334,23 @@ module Spotlight
     config.assign_default_roles_to_first_user = true
 
     config.exhibit_roles = %w[admin curator viewer]
-
-    if ActiveRecord.respond_to?(:yaml_column_permitted_classes) || ActiveRecord::Base.respond_to?(:yaml_column_permitted_classes)
-      config.active_record.yaml_column_permitted_classes ||= []
-      config.active_record.yaml_column_permitted_classes += [Symbol, ActiveSupport::HashWithIndifferentAccess]
+    # 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
   end
   # rubocop:enable Metrics/ClassLength

data/lib/spotlight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spotlight
-  VERSION = '3.6.0.beta6'
+  VERSION = '3.6.0.beta7'
 end

data/lib/tasks/spotlight_tasks.rake

@@ -152,7 +152,7 @@ namespace :spotlight do
         print " OK\n"
       rescue StandardError => e
         errors += 1
-        puts e.to_s
+        puts e
       end
 
       exit 1 if errors > 0

data/spec/factories/searches.rb

@@ -30,4 +30,16 @@ FactoryBot.define do
 
     after(:build) { |search| search.thumbnail = FactoryBot.create(:featured_image) }
   end
+
+  factory :search_field_search, class: 'Spotlight::Search' do
+    exhibit
+    title { 'Based on a search field' }
+    query_params { { 'search_field' => 'search', 'q' => 'model' } }
+  end
+
+  factory :facet_search, class: 'Spotlight::Search' do
+    exhibit
+    title { 'Based on a facet' }
+    query_params { { 'f' => { 'language_ssim' => 'Latin' } } }
+  end
 end

data/spec/support/features/test_features_helpers.rb

@@ -60,7 +60,7 @@ module Spotlight
       EOF
       click_button('Save changes')
       # verify that the page was created
-      expect(page).not_to have_selector('.alert-danger')
+      expect(page).to have_no_selector('.alert-danger')
       expect(page).to have_selector('.alert-info', text: 'page was successfully updated')
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-spotlight
 version: !ruby/object:Gem::Version
-  version: 3.6.0.beta6
+  version: 3.6.0.beta7
 platform: ruby
 authors:
 - Chris Beer
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob-status
@@ -36,7 +36,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -46,7 +46,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: autoprefixer-rails
   requirement: !ruby/object:Gem::Requirement
@@ -436,7 +436,7 @@ dependencies:
         version: '11.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -446,7 +446,7 @@ dependencies:
         version: '11.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '16'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -809,20 +809,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: webdrivers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -1564,7 +1550,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Enable librarians, curators, and others who are responsible for digital collections