blacklight-spotlight 3.5.0.2 → 3.6.0.beta1

data/app/{assets/javascripts/spotlight/admin/translation_progress.js → javascript/spotlight/admin/translation_progress.es6}

@@ -1,23 +1,16 @@
-Spotlight.onLoad(function() {
-  $('[data-behavior="translation-progress"]').translationProgress();
-});
-
 // translationProgress is a plugin that updates the "3/14" progress
 // counters in the tabs of the translation adminstration dashboard.
 // This works by counting the number of progress items and translations
 // present (indicated by data attributes) in each tab's content
-(function($) {
-  $.fn.translationProgress = function() {
-    var translationTabs = this;
-    $(translationTabs).each(function(){
+export default class {
+  connect() {
+    $('[data-behavior="translation-progress"]').each(function(){
       var currentTab = $(this);
       var tabName = $(this).attr('aria-controls');
       var translationFields = $('#' + tabName).find('[data-translation-progress-item="true"]');
       var completedTranslations = $('#' + tabName).find('[data-translation-present="true"]');
 
       currentTab.find('span').text(completedTranslations.length + '/' + translationFields.length);
-    });
-
-    return this;
-  };
-})(jQuery);
+    })
+  }
+}

data/app/{assets/javascripts/spotlight/admin/users.js → javascript/spotlight/admin/users.es6}

@@ -1,11 +1,6 @@
-(function( $ ){
-
-  $.fn.spotlight_users = function( options ) {
-
-    // Create some defaults, extending them with any options that were provided
-    var settings = $.extend( { }, options);
+export default class {
+  connect() {
     var container;
-
     function edit_user(event) {
       event.preventDefault();
       $(this).closest('tr').hide();
@@ -54,13 +49,13 @@
     }
 
     function open_errors() {
-      edit_row = container.find('.has-error').closest('[data-edit-for]');
+      const edit_row = container.find('.has-error').closest('[data-edit-for]');
       edit_row.show();
       // The following row has the controls, so show it too.
       edit_row.next().show();
     }
 
-    return this.each(function() {
+    $('.edit_exhibit, .admin-users').each(function() {
 
       container = $(this);
       $('[data-edit-for]', container).hide();
@@ -69,11 +64,6 @@
       $("[data-behavior='cancel-edit']", container).on('click', cancel_edit);
       $("[data-behavior='destroy-user']", container).on('click', destroy_user);
       $("[data-behavior='new-user']", container).on('click', new_user);
-    });
-  };
-})( jQuery );
-
-
-Spotlight.onLoad(function() {
-  $('.edit_exhibit, .admin-users').spotlight_users();
-});
+    })
+  }
+}

data/app/javascript/spotlight/admin/visibility_toggle.es6

@@ -0,0 +1,23 @@
+// Visibility toggle for items in an exhibit, based on Blacklight's bookmark toggle
+// See: https://github.com/projectblacklight/blacklight/blob/main/app/javascript/blacklight/bookmark_toggle.js
+
+import CheckboxSubmit from 'checkbox_submit'
+
+const VisibilityToggle = (e) => {
+  if (e.target.matches('[data-checkboxsubmit-target="checkbox"]')) {
+    const form = e.target.closest('form')
+    if (form) {
+      new CheckboxSubmit(form).clicked(e)
+
+      // Add/remove the "private" label to the document row when visibility is toggled
+      const docRow = form.closest('tr')
+      if (docRow) docRow.classList.toggle('blacklight-private')
+    }
+  }
+}
+
+VisibilityToggle.selector = 'form.visibility-toggle'
+
+document.addEventListener('click', VisibilityToggle)
+
+export default VisibilityToggle

data/app/javascript/spotlight/index.js

@@ -0,0 +1,10 @@
+import UserIndex from 'user/index'
+import AdminIndex from 'admin/index'
+import Spotlight from 'spotlight'
+
+Spotlight.onLoad(() => {
+  new UserIndex().connect()
+  new AdminIndex().connect()
+})
+
+export default Spotlight

data/app/javascript/spotlight/spotlight.js

@@ -0,0 +1,32 @@
+const Spotlight = function() {
+  var buffer = [];
+  return {
+    onLoad: function(func) {
+      buffer.push(func);
+    },
+
+    activate: function() {
+      for(var i = 0; i < buffer.length; i++) {
+        buffer[i].call();
+      }
+    },
+    csrfToken: function () {
+      return document.querySelector('meta[name=csrf-token]')?.content
+    },
+    ZprLinks: {
+      close: "<svg xmlns=\"http://www.w3.org/2000/svg\" height=\"24\" viewBox=\"0 0 24 24\" width=\"24\"><path d=\"M0 0h24v24H0V0z\" fill=\"none\"/><path d=\"M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z\"/></svg>",
+      zoomIn: "<svg xmlns=\"http://www.w3.org/2000/svg\" height=\"24\" viewBox=\"0 0 24 24\" width=\"24\"><path d=\"M0 0h24v24H0V0z\" fill=\"none\"/><path d=\"M15.5 14h-.79l-.28-.27C15.41 12.59 16 11.11 16 9.5 16 5.91 13.09 3 9.5 3S3 5.91 3 9.5 5.91 16 9.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19l-4.99-5zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14zm.5-7H9v2H7v1h2v2h1v-2h2V9h-2z\"/></svg>\n",
+      zoomOut: "<svg xmlns=\"http://www.w3.org/2000/svg\" height=\"24\" viewBox=\"0 0 24 24\" width=\"24\"><path d=\"M0 0h24v24H0V0z\" fill=\"none\"/><path d=\"M15.5 14h-.79l-.28-.27C15.41 12.59 16 11.11 16 9.5 16 5.91 13.09 3 9.5 3S3 5.91 3 9.5 5.91 16 9.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19l-4.99-5zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14zM7 9h5v1H7V9z\"/></svg>\n"
+    }
+  };
+}();
+
+// This allows us to configure Spotlight in app/views/layouts/base.html.erb
+window.Spotlight = Spotlight
+
+export default Spotlight
+
+Blacklight.onLoad(function() {
+  Spotlight.activate();
+});
+

data/app/{assets/javascripts/spotlight/user/analytics.js → javascript/spotlight/user/analytics.es6}

@@ -1,9 +1,9 @@
-(function($) {
-  Spotlight.onLoad(function(){
+export default class {
+  connect() {
     if (window._gaq != null) {
       return _gaq.push(['_trackPageview']);
     } else if (window.pageTracker != null) {
       return pageTracker._trackPageview();
     }
-  });
-})(jQuery);
+  }
+}

data/app/{assets/javascripts/spotlight/user/browse_group_categories.js → javascript/spotlight/user/browse_group_categories.es6}

@@ -1,8 +1,5 @@
-(function( $ ){
-
-  $.fn.browseGroupCategories = function( options ) {
-    // Create some defaults, extending them with any options that were provided
-    var settings = $.extend( { }, options);
+export default class {
+  connect() {
     var $container, slider;
 
     function init() {
@@ -44,16 +41,10 @@
       return sidebar ? 3 : 4;
     }
 
-    return this.each(function() {
+    return $('[data-browse-group-categories-carousel]').each(function() {
       $container = $(this);
       init();
       setupDestroy();
     });
   }
-})( jQuery );
-
-Spotlight.onLoad(function() {
-  $('[data-browse-group-categories-carousel]').each(function(i, el) {
-    $(el).browseGroupCategories();
-  });
-});
+}

data/app/javascript/spotlight/user/carousel.es6

@@ -0,0 +1,5 @@
+export default class {
+  connect() {
+    $('.carousel').carousel();
+  }
+}

data/app/{assets/javascripts/spotlight/user/clear_form_button.js → javascript/spotlight/user/clear_form_button.es6}

@@ -1,10 +1,6 @@
-Spotlight.onLoad(function() {
-  $('.btn-reset').ClearFormButton();
-});
-
-(function($) {
-  $.fn.ClearFormButton = function() {
-    var $clearBtn = $(this);
+export default class {
+  connect() {
+    var $clearBtn = $('.btn-reset');
     var $input = $clearBtn.parent().prev('input');
     var btnCheck = function(){
       if ($input.val() !== '') {
@@ -23,5 +19,5 @@ Spotlight.onLoad(function() {
       event.preventDefault();
       $input.val('');
     });
-  };
-})(jQuery);
+  }
+}

data/app/javascript/spotlight/user/index.js

@@ -0,0 +1,17 @@
+import Analytics from 'analytics'
+import BrowseGroupCateogries from 'browse_group_categories'
+import Carousel from 'carousel'
+import ClearFormButton from 'clear_form_button'
+import ReportProblem from 'report_a_problem'
+import ZprLinks from 'zpr_links'
+
+export default class {
+  connect() {
+    new Analytics().connect()
+    new BrowseGroupCateogries().connect()
+    new Carousel().connect()
+    new ClearFormButton().connect()
+    new ReportProblem().connect()
+    new ZprLinks().connect()
+  }
+}

data/app/{assets/javascripts/spotlight/user/report_a_problem.js → javascript/spotlight/user/report_a_problem.es6}

@@ -1,12 +1,9 @@
-(function( $ ){
-
-  $.fn.reportProblem = function( options ) {
-    // Create some defaults, extending them with any options that were provided
-    var settings = $.extend( { }, options);
-    var container, target, cancel;
+export default class {
+  connect(){
+    var container, target;
 
     function init() {
-      target_val = container.attr('data-target')
+      const target_val = container.attr('data-target')
       if (!target_val) 
         return
 
@@ -25,15 +22,9 @@
       target.slideUp('fast');
     }
 
-    return this.each(function() {        
+    return $('[data-behavior="contact-link"]').each(function() {        
       container = $(this);
       init();
     });
   }
-})( jQuery );
-
-Spotlight.onLoad(function() {
-  $('[data-behavior="contact-link"]').reportProblem();
-});
-
-
+}

data/app/javascript/spotlight/user/zpr_links.es6

@@ -0,0 +1,44 @@
+export default class {
+  connect() {
+    $('.zpr-link').on('click', function() {
+      var modalDialog = $('#blacklight-modal .modal-dialog');
+      var modalContent = modalDialog.find('.modal-content')
+      modalDialog.removeClass('modal-lg')
+      modalDialog.addClass('modal-xl')
+      modalContent.html('<div id="osd-modal-container"></div>');
+      var controls = `<div class="controls d-flex justify-content-center justify-content-md-end">
+          <div class="custom-close-controls pr-3 pt-3">
+            <button type="button" class="btn btn-dark" data-dismiss="modal" aria-hidden="true">${Spotlight.ZprLinks.close}</button>
+          </div>
+          <div class="zoom-controls mb-3 mr-md-3">
+            <button id="osd-zoom-in" type="button" class="btn btn-dark">${Spotlight.ZprLinks.zoomIn}</button>
+            <button id="osd-zoom-out" type="button" class="btn btn-dark">${Spotlight.ZprLinks.zoomOut}</button>
+          </div>
+          <div id="empty-div-required-by-osd"></div>
+        </div>`
+
+      $('#osd-modal-container').append('<div id="osd-div"></div>');
+      $('#osd-modal-container').append(controls);
+
+      $('#blacklight-modal').modal('show');
+      
+      $('#blacklight-modal').one('hidden.bs.modal', function (event) {
+        modalDialog.removeClass('modal-xl')
+        modalDialog.addClass('modal-lg')
+      });
+
+      OpenSeadragon({
+        id: 'osd-div',
+        zoomInButton: "osd-zoom-in",
+        zoomOutButton: "osd-zoom-out",
+        // This is a hack where OpenSeadragon (if using mapped buttons) requires you
+        // to map all of the buttons.
+        homeButton: "empty-div-required-by-osd",
+        fullPageButton: "empty-div-required-by-osd",
+        nextButton: "empty-div-required-by-osd",
+        previousButton: "empty-div-required-by-osd",
+        tileSources: [$(this).data('iiif-tilesource')]
+      })
+    });
+  }
+}

data/app/jobs/spotlight/add_uploads_from_csv.rb

@@ -7,8 +7,7 @@ module Spotlight
     include Spotlight::JobTracking
     with_job_tracking(resource: ->(job) { job.arguments[1] })
 
-    attr_reader :count
-    attr_reader :errors
+    attr_reader :count, :errors
 
     after_perform do |job|
       csv_data, exhibit, user = job.arguments

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

@@ -15,7 +15,7 @@ module Spotlight
     def apply_browse_category_defaults(solr_params)
       return unless current_browse_category
 
-      solr_params.merge!(browse_category_search_builder.to_hash)
+      solr_params.merge!(browse_category_search_builder.to_hash.except(:q))
     end
 
     def fix_up_browse_category_defaults(solr_params)
@@ -25,14 +25,18 @@ module Spotlight
     end
 
     def fix_up_browse_category_queries(solr_params)
-      return unless solr_params.dig(:json, :query, :bool, :must) && blacklight_params[:q]
+      return unless current_browse_category
+
+      query = browse_category_search_builder.to_hash[:q]
+
+      solr_params.append_query(query) if query.present?
 
       # 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[:json][:query][:bool][:must].map! do |q|
+      solr_params.dig(:json, :query, :bool, :must)&.map! do |q|
         q.is_a?(String) ? { edismax: { query: q } } : q
       end
     end

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

@@ -27,7 +27,7 @@ module Spotlight
     end
 
     def initialize_browse
-      return unless searches.blank?
+      return if searches.present?
 
       searches.create title: 'All exhibit items',
                       long_description: 'All items in this exhibit.'

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

@@ -8,7 +8,7 @@ module Spotlight
     # filtered by the exhibit-specific solr field.
     #
     # @return [Enumerable<SolrDocument>]
-    def solr_documents
+    def solr_documents(&block)
       return to_enum(:solr_documents) unless block_given?
 
       start = 0
@@ -17,7 +17,7 @@ module Spotlight
       response = repository.search(search_params.start(start).to_h)
 
       while response.documents.present?
-        response.documents.each { |x| yield x }
+        response.documents.each(&block)
         start += response.documents.length
         response = repository.search(search_params.start(start).to_h)
       end

data/app/models/concerns/spotlight/resources/web.rb

@@ -29,7 +29,7 @@ module Spotlight
 
       def self.fetch(url)
         Faraday.new(url) do |b|
-          b.use FaradayMiddleware::FollowRedirects
+          b.response :follow_redirects
           b.adapter Faraday.default_adapter
         end.get
       end

data/app/models/concerns/spotlight/solr_document/atomic_updates.rb

@@ -31,7 +31,7 @@ module Spotlight
                       { set: v }
                     end
         end
-        output[Blacklight::Configuration.default_values[:index].timestamp_field] ||= { set: nil }
+        output[Spotlight::Engine.blacklight_config.index.timestamp_field] ||= { set: nil }
         output
       end
     end

data/app/models/concerns/spotlight/solr_document/finder.rb

@@ -19,7 +19,7 @@ module Spotlight
           @index ||= blacklight_config.repository_class.new(blacklight_config)
         end
 
-        def find_each
+        def find_each(&block)
           return to_enum(:find_each) unless block_given?
 
           start = 0
@@ -27,7 +27,7 @@ module Spotlight
           response = index.search(search_params.merge(start: start))
 
           while response.documents.present?
-            response.documents.each { |x| yield x }
+            response.documents.each(&block)
             start += response.documents.length
             response = index.search(search_params.merge(start: start))
           end

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

@@ -25,7 +25,7 @@ module Spotlight
       def reindex(id)
         find(id).reindex
       rescue Blacklight::Exceptions::RecordNotFound => e
-        Rails.logger.debug "Unable to find document #{id}: #{e}"
+        Rails.logger.debug { "Unable to find document #{id}: #{e}" }
       end
 
       def reindex_all
@@ -62,7 +62,7 @@ module Spotlight
 
       sidecar(current_exhibit).update(custom_data) if custom_data
 
-      # Note: this causes a save
+      # NOTE: this causes a save
       current_exhibit.tag(sidecar(current_exhibit), with: tags, on: :tags) if tags
 
       update_exhibit_resource(resource_attributes) if uploaded_resource?

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

data/app/models/sir_trevor_rails/blocks/displayable.rb

@@ -10,11 +10,11 @@ module SirTrevorRails
       end
 
       def item_ids
-        items.map { |v| v[:id] }
+        items.pluck(:id)
       end
 
       def ordered_items
-        items.sort_by { |x| x[:weight].to_i }.map { |x| x[:id] }
+        items.sort_by { |x| x[:weight].to_i }.pluck(:id)
       end
 
       private

data/app/models/sir_trevor_rails/blocks/solr_documents_block.rb

@@ -25,9 +25,14 @@ module SirTrevorRails
 
       def documents
         @documents ||= begin
-          doc_ids = items.map { |v| v[:id] }
-          _, documents = solr_helper.controller.send(:search_service).fetch(doc_ids)
-          documents
+          doc_ids = items.pluck(:id)
+          result = solr_helper.controller.send(:search_service).fetch(doc_ids)
+
+          if result.first.is_a? Blacklight::Solr::Response
+            result.last
+          else
+            result
+          end
         end
       end
 
@@ -49,7 +54,7 @@ module SirTrevorRails
         return unless caption_field
         return presenter.heading if caption_field == Spotlight::PageConfigurations::DOCUMENT_TITLE_KEY
 
-        presenter.field_value(solr_helper.blacklight_config.index_fields[caption_field] || Blacklight::Configuration::NullField.new(caption_field))
+        presenter.field_value(solr_helper.blacklight_config.index_fields[caption_field] || null_display_field_class.new(caption_field))
       end
 
       def secondary_caption?
@@ -66,12 +71,18 @@ module SirTrevorRails
 
       def primary_caption_field
         val = send(:'primary-caption-field')
-        val unless val.blank?
+        val.presence
       end
 
       def secondary_caption_field
         val = send(:'secondary-caption-field')
-        val unless val.blank?
+        val.presence
+      end
+
+      def null_display_field_class
+        return Blacklight::Configuration::NullDisplayField if defined?(Blacklight::Configuration::NullDisplayField)
+
+        Blacklight::Configuration::NullField
       end
     end
   end

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

@@ -31,11 +31,11 @@ module Spotlight
 
       def user(scope = 'https://www.googleapis.com/auth/analytics.readonly')
         @user ||= begin
-                    Legato::User.new(oauth_token(scope))
-                  rescue StandardError => e
-                    Rails.logger.info(e)
-                    nil
-                  end
+          Legato::User.new(oauth_token(scope))
+        rescue StandardError => e
+          Rails.logger.info(e)
+          nil
+        end
       end
 
       def site

data/app/models/spotlight/blacklight_configuration.rb

@@ -27,7 +27,7 @@ module Spotlight
     # get rid of empty values
     before_validation do |model|
       model.index_fields&.each do |_k, v|
-        v[:enabled] ||= v.any? { |_k1, v1| !v1.blank? }
+        v[:enabled] ||= v.any? { |_k1, v1| v1.present? }
 
         default_blacklight_config.view.keys.each do |view|
           v[view] &&= value_to_boolean(v[view])
@@ -82,8 +82,8 @@ module Spotlight
           end
         end
 
-        config.show.merge! show unless show.blank?
-        config.index.merge! index unless index.blank?
+        config.show.merge! show if show.present?
+        config.index.merge! index if index.present?
         config.index.respond_to[:iiif_json] = true
 
         config.index.thumbnail_field ||= Spotlight::Engine.config.thumbnail_field
@@ -165,7 +165,7 @@ module Spotlight
         config.show_fields = config.index_fields
 
         config.search_fields.merge! custom_search_fields(config)
-        unless search_fields.blank?
+        if search_fields.present?
           config.search_fields = Hash[config.search_fields.sort_by { |k, _v| field_weight(search_fields, k) }]
 
           config.search_fields.each do |k, v|
@@ -179,7 +179,7 @@ module Spotlight
           end
         end
 
-        unless sort_fields.blank?
+        if sort_fields.present?
           config.sort_fields = Hash[config.sort_fields.sort_by { |k, _v| field_weight(sort_fields, k) }]
 
           config.sort_fields.each do |k, v|
@@ -194,7 +194,7 @@ module Spotlight
         end
 
         config.facet_fields.merge! custom_facet_fields
-        unless facet_fields.blank?
+        if facet_fields.present?
           config.facet_fields = Hash[config.facet_fields.sort_by { |k, _v| field_weight(facet_fields, k) }]
 
           config.facet_fields.each do |k, v|
@@ -209,9 +209,9 @@ module Spotlight
           end
         end
 
-        config.per_page = (config.per_page & per_page) unless per_page.blank?
+        config.per_page = (config.per_page & per_page) if per_page.present?
 
-        unless document_index_view_types.blank?
+        if document_index_view_types.present?
           config.view.each do |k, v|
             v.original = v.dup
             v.key = k
@@ -364,10 +364,10 @@ module Spotlight
 
     # rubocop:disable Naming/AccessorMethodName
     def set_index_field_defaults(field)
-      return unless index_fields.blank?
+      return if index_fields.present?
 
       views = default_blacklight_config.view.keys | %i[show enabled]
-      field.merge!((views - field.keys).map { |v| [v, !title_only_by_default?(v)] }.to_h)
+      field.merge!((views - field.keys).index_with { |v| !title_only_by_default?(v) })
     end
 
     # Check to see whether config.view.foobar.title_only_by_default is available
@@ -379,10 +379,10 @@ module Spotlight
     end
 
     def set_show_field_defaults(field)
-      return unless index_fields.blank?
+      return if index_fields.present?
 
       views = default_blacklight_config.view.keys
-      field.merge! Hash[views.map { |v| [v, false] }]
+      field.merge! views.index_with { |_v| false }
       field.enabled = true
       field.show = true
     end

data/app/models/spotlight/bulk_update.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Spotlight
+  # :nodoc:
   class BulkUpdate < ActiveRecord::Base
     mount_uploader :file, Spotlight::BulkUpdatesUploader
     belongs_to :exhibit

data/app/models/spotlight/contact_email.rb

@@ -26,7 +26,7 @@ module Spotlight
       begin
         parsed = Mail::Address.new(email)
       rescue Mail::Field::ParseError => e
-        Rails.logger.debug "Failed to parse email #{email}: #{e}"
+        Rails.logger.debug { "Failed to parse email #{email}: #{e}" }
       end
 
       errors.add :email, 'is not valid' if parsed.nil? || parsed.address != email || parsed.local == email

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