blacklight-spotlight 3.0.0.alpha.9 → 3.0.0.rc4

data/spec/services/spotlight/iiif_resource_resolver_spec.rb

@@ -68,7 +68,7 @@ describe Spotlight::IiifResourceResolver do
       end
     end
 
-    context 'when the stored canvas ID is not present' do
+    context 'when the stored image ID is not present' do
       it 'raises a ManifestError' do
         resource.iiif_image_id = 'not-a-real-image-id'
 

data/spec/spec_helper.rb

@@ -48,6 +48,8 @@ require 'spotlight'
 
 # configure spotlight with all the settings necessary to test functionality
 Spotlight::Engine.config.exhibit_themes = %w[default modern]
+Spotlight::Engine.config.reindexing_batch_count = 1
+Spotlight::Engine.config.assign_default_roles_to_first_user = false
 
 Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
 
@@ -62,11 +64,6 @@ RSpec.configure do |config|
 
   config.use_transactional_fixtures = true
 
-  config.before do
-    # The first user is automatically granted admin privileges; we don't want that behavior for many of our tests
-    Spotlight::Engine.user_class.create email: 'initial+admin@example.com', password: 'password', password_confirmation: 'password'
-  end
-
   if defined? Devise::Test::ControllerHelpers
     config.include Devise::Test::ControllerHelpers, type: :controller
     config.include Devise::Test::ControllerHelpers, type: :view
@@ -136,7 +133,7 @@ RSpec.configure do |config|
   Kernel.srand config.seed
 end
 
-def add_new_page_via_button(title = 'New Page')
+def add_new_via_button(title = 'New Page')
   add_link = find('[data-expanded-add-button]')
   within(add_link) do
     expect(page).to have_css("input[type='text']", visible: false)

data/spec/support/features/test_features_helpers.rb

@@ -15,6 +15,21 @@ module Spotlight
       find('.tt-suggestion', text: opts[:with], match: :first).click
     end
 
+    ##
+    # For typeahead "prefetched" fields, we need to wait for a resolved selector
+    # before proceeding.
+    def fill_in_prefetched_typeahead_field(opts)
+      type = opts[:type] || 'twitter'
+      # Poltergeist / Capybara doesn't fire the events typeahead.js
+      # is listening for, so we help it out a little:
+      find(opts[:wait_for]) if opts[:wait_for]
+      page.execute_script <<-EOF
+        $("[data-#{type}-typeahead]:visible").val("#{opts[:with]}").trigger("input");
+        $("[data-#{type}-typeahead]:visible").typeahead("open");
+        $(".tt-suggestion").click();
+      EOF
+    end
+
     # just like #fill_in_typeahead_field, but wait for the
     # form fields to show up on the page too
     def fill_in_solr_document_block_typeahead_field(opts)

data/spec/test_app_templates/Gemfile.extra

@@ -1,3 +1 @@
-gem 'blacklight', '~> 7.0'
-gem 'sprockets', '< 4'
-gem 'thor', '~> 0.20'
+gem 'sprockets', '< 4' if ENV['RAILS_VERSION'] && ENV['RAILS_VERSION'] < '6'

data/spec/test_app_templates/catalog_controller.rb

@@ -6,6 +6,12 @@ class CatalogController < ApplicationController
   before_action :set_paper_trail_whodunnit
 
   configure_blacklight do |config|
+    config.view.gallery.document_component = Blacklight::Gallery::DocumentComponent
+    # config.view.gallery.classes = 'row-cols-2 row-cols-md-3'
+    config.view.masonry.document_component = Blacklight::Gallery::DocumentComponent
+    config.view.slideshow.document_component = Blacklight::Gallery::SlideshowComponent
+    config.show.tile_source_field = :content_metadata_image_iiif_info_ssm
+    config.show.partials.insert(1, :openseadragon)
     ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
     config.default_solr_params = {
       qt: 'search',
@@ -29,9 +35,6 @@ class CatalogController < ApplicationController
     config.index.display_type_field = 'content_metadata_type_ssm'
     config.index.thumbnail_field = Spotlight::Engine.config.thumbnail_field
 
-    config.view.gallery.partials = %i[index_header index]
-    config.view.slideshow.partials = [:index]
-
     config.show.tile_source_field = :content_metadata_image_iiif_info_ssm
     config.show.partials.insert(1, :openseadragon)
 

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -11,7 +11,7 @@ class TestAppGenerator < Rails::Generators::Base
 
   def add_gems
     gem 'blacklight', '~> 7.0'
-    gem 'blacklight-gallery', '~> 1.1'
+    gem 'blacklight-gallery', '~> 3.0'
     Bundler.with_clean_env do
       run 'bundle install'
     end

data/spec/views/shared/_exhibit_navbar.html.erb_spec.rb

@@ -42,7 +42,7 @@ describe 'shared/_exhibit_navbar', type: :view do
     feature_page
     another_page = FactoryBot.create(:feature_page, exhibit: current_exhibit)
     render
-    expect(response).to have_selector '.dropdown .dropdown-toggle', text: 'Curated Features'
+    expect(response).to have_selector '.dropdown .dropdown-toggle', text: 'Curated features'
     expect(response).to have_link feature_page.title, visible: false, href: spotlight.exhibit_feature_page_path(current_exhibit, feature_page)
     expect(response).to have_link another_page.title, visible: false, href: spotlight.exhibit_feature_page_path(current_exhibit, another_page)
   end

data/spec/views/spotlight/browse/index.html.erb_spec.rb

@@ -7,11 +7,13 @@ describe 'spotlight/browse/index', type: :view do
   before { allow(view).to receive(:current_exhibit).and_return(search.exhibit) }
 
   it 'has a title' do
+    assign :groups, []
     render
     expect(response).to have_selector 'h1', text: 'Browse'
   end
 
   it 'renders the collection of searches' do
+    assign :groups, []
     assign :searches, [search, another_search]
     stub_template 'spotlight/browse/_search.html.erb' => '<%= search.id %> <br/>'
     render

data/spec/views/spotlight/dashboards/_analytics.html.erb_spec.rb

@@ -19,7 +19,7 @@ describe 'spotlight/dashboards/_analytics.html.erb', type: :view do
 
   it 'has header' do
     render
-    expect(rendered).to have_content 'User Activity Over the Past Month'
+    expect(rendered).to have_content 'User activity over the past month'
   end
 
   it 'has metric labels' do

data/spec/views/spotlight/dashboards/_reindexing_activity.html.erb_spec.rb

@@ -1,26 +1,21 @@
 # frozen_string_literal: true
 
 describe 'spotlight/dashboards/_reindexing_activity.html.erb', type: :view do
-  # recent reindexing entries should be sorted by start_time in descending order, so mock that behavior
-  let(:recent_reindexing) do
-    [FactoryBot.build(:unstarted_reindexing_log_entry)] + # nil start_time is trouble for the sort_by used to create the rest of the fixture's rows
-      [
-        FactoryBot.build(:reindexing_log_entry),
-        FactoryBot.build(:in_progress_reindexing_log_entry),
-        FactoryBot.build(:recent_reindexing_log_entry),
-        FactoryBot.build(:failed_reindexing_log_entry)
-      ].sort_by(&:start_time).reverse
-  end
   let(:p) { 'spotlight/dashboards/reindexing_activity' }
 
+  before do
+    assign(:recent_reindexing, recent_reindexing)
+  end
+
   context 'the reindexing log is empty' do
+    let(:recent_reindexing) { [] }
+
     before do
-      assign(:recent_reindexing, [])
       render p
     end
 
     it 'displays the section header' do
-      expect(rendered).to have_css('h2', text: 'Recent Item Indexing Activity')
+      expect(rendered).to have_css('h2', text: 'Recent item indexing activity')
     end
 
     it 'displays an explanatory message when there are no reindexing attempts in the log' do
@@ -29,21 +24,31 @@ describe 'spotlight/dashboards/_reindexing_activity.html.erb', type: :view do
   end
 
   context 'the reindexing log has entries' do
+    # recent reindexing entries should be sorted by start_time in descending order, so mock that behavior
+    let(:recent_reindexing) do
+      [
+        FactoryBot.build(:job_tracker, status: 'enqueued'),
+        FactoryBot.build(:job_tracker, status: 'completed', data: { progress: 10 }),
+        FactoryBot.build(:job_tracker, status: 'in_progress', created_at: Time.zone.parse('January 10, 2017 23:00')),
+        FactoryBot.build(:job_tracker, status: 'completed', data: { progress: 100 }),
+        FactoryBot.build(:job_tracker, status: 'failed', data: { progress: 10 })
+      ]
+    end
+
     before do
-      assign(:recent_reindexing, recent_reindexing)
       render p
     end
 
     it 'displays the correct localized column headings when there are reindexing attempts in the log' do
       expect(rendered).to have_css('table.table-striped th.col-3', text: 'Date', count: 1)
-      expect(rendered).to have_css('table.table-striped th.col-3', text: 'Requested By', count: 1)
-      expect(rendered).to have_css('table.table-striped th.col-1', text: 'Items Indexed', count: 1)
-      expect(rendered).to have_css('table.table-striped th.col-3', text: 'Elapsed Time', count: 1)
+      expect(rendered).to have_css('table.table-striped th.col-3', text: 'Requested by', count: 1)
+      expect(rendered).to have_css('table.table-striped th.col-1', text: 'Items indexed', count: 1)
+      expect(rendered).to have_css('table.table-striped th.col-3', text: 'Elapsed time', count: 1)
       expect(rendered).to have_css('table.table-striped th.col-2', text: 'Status', count: 1)
     end
 
     it 'formats the start time correctly' do
-      expect(rendered).to have_css('table.table-striped td', text: 'January 05, 2017 23:00', count: 1)
+      expect(rendered).to have_css('table.table-striped td', text: 'January 05, 2017 23:00', count: 4)
       expect(rendered).to have_css('table.table-striped td', text: 'January 10, 2017 23:00', count: 1)
     end
 
@@ -60,22 +65,20 @@ describe 'spotlight/dashboards/_reindexing_activity.html.erb', type: :view do
       expect(rendered).to have_css('table.table-striped td', text: '5 minutes', count: 3)
     end
 
-    it 'displays nothing in the duration column or start time column when the info is unavailable (e.g. unstarted or in_progress attempts)' do
-      # we expect 2 blank durations, and 1 blank start time (1 unstarted log entry w/ blank start and duration, 1 in_progress w/ blank duration)
-      expect(rendered).to have_css('table.table-striped td', text: /^$/, count: 3)
-    end
-
     it 'displays the status of the reindexing attempt using localized text' do
-      expect(rendered).to have_css('table.table-striped td', text: 'Not Yet Started', count: 1)
+      expect(rendered).to have_css('table.table-striped td', text: 'Not yet started', count: 1)
       expect(rendered).to have_css('table.table-striped td', text: 'Successful', count: 2)
-      expect(rendered).to have_css('table.table-striped td', text: 'In Progress', count: 1)
+      expect(rendered).to have_css('table.table-striped td', text: 'In progress', count: 1)
       expect(rendered).to have_css('table.table-striped td', text: 'Failed', count: 1)
     end
   end
 
   context 'a reindexing log entry has a null user' do
+    let(:recent_reindexing) do
+      [FactoryBot.build(:job_tracker, status: 'completed', data: { progress: 10 }, user: nil)]
+    end
+
     it 'displays blank in the user field and renders without error' do
-      assign(:recent_reindexing, [FactoryBot.build(:reindexing_log_entry_no_user)])
       expect { render p }.not_to raise_error
 
       # we expect one blank table cell for the user, and values for everything else

data/spec/views/spotlight/metadata_configurations/_metadata_field.html.erb_spec.rb

@@ -2,7 +2,10 @@
 
 describe 'spotlight/metadata_configurations/_metadata_field', type: :view do
   let(:exhibit) { FactoryBot.create(:exhibit) }
+  let(:field) { Blacklight::Configuration::Field.new immutable: OpenStruct.new(another_view_type: false) }
+  let(:builder) { ActionView::Helpers::FormBuilder.new 'z', nil, view, {} }
   let(:p) { 'spotlight/metadata_configurations/metadata_field.html.erb' }
+
   before do
     assign(:exhibit, exhibit)
     assign(:blacklight_configuration, exhibit.blacklight_configuration)
@@ -14,9 +17,6 @@ describe 'spotlight/metadata_configurations/_metadata_field', type: :view do
     )
   end
 
-  let(:field) { Blacklight::Configuration::Field.new immutable: OpenStruct.new(another_view_type: false) }
-  let(:builder) { ActionView::Helpers::FormBuilder.new 'z', nil, view, {} }
-
   it 'uses the index_field_label helper to render the label' do
     allow(view).to receive(:index_field_label).with(anything, 'some_key').and_return 'Some label'
     render partial: p, locals: { key: 'some_key', config: field, f: builder }

data/spec/views/spotlight/pages/show.html.erb_spec.rb

@@ -11,6 +11,7 @@ describe 'spotlight/pages/show', type: :view do
 
   before do
     allow(view).to receive(:current_exhibit).and_return(exhibit)
+    allow(view).to receive(:render_body_class).and_return('')
     assign(:page, page)
     stub_template 'spotlight/pages/_sidebar.html.erb' => 'Sidebar'
     stub_template 'spotlight/pages/_tophat.html.erb' => ''

data/spec/views/spotlight/search_configurations/_facets.html.erb_spec.rb

@@ -29,7 +29,7 @@ describe 'spotlight/search_configurations/_facets', type: :view do
   end
 
   it 'shows the config for the non-empty personal name facet' do
-    expect(rendered).to have_content 'Personal Names'
+    expect(rendered).to have_content 'Personal names'
   end
 
   it 'shows the config for the empty custom facet' do

data/spec/views/spotlight/search_configurations/_sort.html.erb_spec.rb

@@ -2,6 +2,13 @@
 
 describe 'spotlight/search_configurations/_sort', type: :view do
   let(:exhibit) { FactoryBot.create(:exhibit) }
+  let(:f) do
+    form_helper = nil
+    controller.view_context.bootstrap_form_for(exhibit.blacklight_configuration, url: '/update') do |f|
+      form_helper = f
+    end
+    form_helper
+  end
 
   before do
     original_config = Spotlight::Engine.blacklight_config.deep_dup
@@ -16,14 +23,6 @@ describe 'spotlight/search_configurations/_sort', type: :view do
     )
   end
 
-  let(:f) do
-    form_helper = nil
-    controller.view_context.bootstrap_form_for(exhibit.blacklight_configuration, url: '/update') do |f|
-      form_helper = f
-    end
-    form_helper
-  end
-
   it 'has a disabled relevance sort option' do
     render partial: 'spotlight/search_configurations/sort', locals: { f: f }
     expect(rendered).to have_selector "input[name='blacklight_configuration[sort_fields][relevance][enable]'][disabled='disabled']"

data/spec/views/spotlight/translations/_import.html.erb_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+describe 'spotlight/translations/_import.html.erb', type: :view do
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+
+  before do
+    allow(view).to receive(:can?).and_return(true)
+    allow(view).to receive(:current_exhibit).and_return(exhibit)
+    assign(:language, :es)
+    I18n.default_locale = 'en'
+  end
+
+  it 'has a link to export the translation data' do
+    render
+    expect(rendered).to have_link 'Export English', href: spotlight.exhibit_translations_path(exhibit_id: exhibit, format: 'yaml', locale: 'en')
+    expect(rendered).to have_link 'Export Spanish', href: spotlight.exhibit_translations_path(exhibit_id: exhibit, format: 'yaml', locale: 'es')
+  end
+
+  it 'has a form to import the translation data' do
+    render
+    expect(rendered).to have_selector "form[action='#{spotlight.import_exhibit_translations_path(exhibit_id: exhibit)}']"
+    expect(rendered).to have_selector 'input[name="file"]'
+  end
+end

data/vendor/assets/javascripts/leaflet-iiif.js

@@ -1,5 +1,5 @@
 /*
- * Leaflet-IIIF 2.0.0
+ * Leaflet-IIIF 3.0.0
  * IIIF Viewer for Leaflet
  * by Jack Reed, @mejackreed
  */
@@ -32,7 +32,7 @@ L.TileLayer.Iiif = L.TileLayer.extend({
     }
 
     options = L.setOptions(this, options);
-    this._infoDeferred = new $.Deferred();
+    this._infoPromise = null;
     this._infoUrl = url;
     this._baseUrl = this._templateUrl();
     this._getInfo();
@@ -48,27 +48,39 @@ L.TileLayer.Iiif = L.TileLayer.extend({
       miny = (y * tileBaseSize),
       maxx = Math.min(minx + tileBaseSize, _this.x),
       maxy = Math.min(miny + tileBaseSize, _this.y);
-    
+
     var xDiff = (maxx - minx);
     var yDiff = (maxy - miny);
 
+    // Canonical URI Syntax for v2
+    var size = Math.ceil(xDiff / scale) + ',';
+    if (_this.type === 'ImageService3') {
+      // Cannonical URI Syntax for v3
+      size = size + Math.ceil(yDiff / scale);
+    }
+
     return L.Util.template(this._baseUrl, L.extend({
       format: _this.options.tileFormat,
       quality: _this.quality,
       region: [minx, miny, xDiff, yDiff].join(','),
       rotation: 0,
-      size: Math.ceil(xDiff / scale) + ','
+      size: size
     }, this.options));
   },
   onAdd: function(map) {
     var _this = this;
 
-    // Wait for deferred to complete
-    $.when(_this._infoDeferred).done(function() {
+    // Wait for info.json fetch and parse to complete
+    Promise.all([_this._infoPromise]).then(function() {
+      // Store unmutated imageSizes
+      _this._imageSizesOriginal = _this._imageSizes.slice(0);
 
       // Set maxZoom for map
       map._layersMaxZoom = _this.maxZoom;
 
+      // Call add TileLayer
+      L.TileLayer.prototype.onAdd.call(_this, map);
+
       // Set minZoom and minNativeZoom based on how the imageSizes match up
       var smallestImage = _this._imageSizes[0];
       var mapSize = _this._map.getSize();
@@ -88,9 +100,6 @@ L.TileLayer.Iiif = L.TileLayer.extend({
       _this._prev_map_layersMinZoom = _this._map._layersMinZoom;
       _this._map._layersMinZoom = newMinZoom;
 
-      // Call add TileLayer
-      L.TileLayer.prototype.onAdd.call(_this, map);
-
       if (_this.options.fitBounds) {
         _this._fitBounds();
       }
@@ -112,12 +121,16 @@ L.TileLayer.Iiif = L.TileLayer.extend({
         tile.tile.style.height = height + 'px';
 
       });
+    })
+    .catch(function(err){
+        console.error(err);
     });
   },
   onRemove: function(map) {
     var _this = this;
-    
+
     map._layersMinZoom = _this._prev_map_layersMinZoom;
+    _this._imageSizes = _this._imageSizesOriginal;
 
     // Remove maxBounds set for this image
     if(_this.options.setMaxBounds) {
@@ -156,9 +169,14 @@ L.TileLayer.Iiif = L.TileLayer.extend({
   _getInfo: function() {
     var _this = this;
 
-    // Look for a way to do this without jQuery
-    $.getJSON(_this._infoUrl)
-      .done(function(data) {
+    _this._infoPromise = fetch(_this._infoUrl)
+      .then(function(response) {
+        return response.json();
+      })
+      .catch(function(err){
+          console.error(err);
+      })
+      .then(function(data) {
         _this.y = data.height;
         _this.x = data.width;
 
@@ -176,6 +194,7 @@ L.TileLayer.Iiif = L.TileLayer.extend({
         }else {
           _this.profile = data.profile;
         }
+        _this.type = data.type;
 
         _this._setQuality();
 
@@ -197,10 +216,13 @@ L.TileLayer.Iiif = L.TileLayer.extend({
         };
 
         // Calculates maximum native zoom for the layer
-        _this.maxNativeZoom = Math.max(ceilLog2(_this.x / _this.options.tileSize),
-          ceilLog2(_this.y / _this.options.tileSize));
+        _this.maxNativeZoom = Math.max(
+          ceilLog2(_this.x / _this.options.tileSize),
+          ceilLog2(_this.y / _this.options.tileSize),
+          0
+        );
         _this.options.maxNativeZoom = _this.maxNativeZoom;
-        
+
         // Enable zooming further than native if maxZoom option supplied
         if (_this._customMaxZoom && _this.options.maxZoom > _this.maxNativeZoom) {
           _this.maxZoom = _this.options.maxZoom;
@@ -208,7 +230,7 @@ L.TileLayer.Iiif = L.TileLayer.extend({
         else {
           _this.maxZoom = _this.maxNativeZoom;
         }
-        
+
         for (var i = 0; i <= _this.maxZoom; i++) {
           scale = Math.pow(2, _this.maxNativeZoom - i);
           width_ = Math.ceil(_this.x / scale);
@@ -221,10 +243,11 @@ L.TileLayer.Iiif = L.TileLayer.extend({
 
         _this._tierSizes = tierSizes;
         _this._imageSizes = imageSizes;
-
-        // Resolved Deferred to initiate tilelayer load
-        _this._infoDeferred.resolve();
+      })
+      .catch(function(err){
+          console.error(err);
       });
+
   },
 
   _setQuality: function() {
@@ -259,7 +282,6 @@ L.TileLayer.Iiif = L.TileLayer.extend({
     return this._infoToBaseUrl() + '{region}/{size}/{rotation}/{quality}.{format}';
   },
   _isValidTile: function(coords) {
-    var tileBounds = this._tileCoordsToBounds(coords);
     var _this = this;
     var zoom = _this._getZoomForUrl();
     var sizes = _this._tierSizes[zoom];
@@ -276,6 +298,9 @@ L.TileLayer.Iiif = L.TileLayer.extend({
       return true;
     }
   },
+  _tileShouldBeLoaded: function(coords) {
+    return this._isValidTile(coords);
+  },
   _getInitialZoom: function (mapSize) {
     var _this = this;
     var tolerance = 0.8;