blacklight-spotlight 3.0.0.rc1 → 3.0.0.rc6

data/spec/test_app_templates/Gemfile.extra

@@ -0,0 +1,2 @@
+gem 'sprockets', '< 4' if ENV['RAILS_VERSION'] && ENV['RAILS_VERSION'] < '6'
+gem 'view_component', '!= 2.26.0'

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

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

data/spec/uploaders/spotlight/featured_image_uploader_spec.rb

@@ -5,9 +5,9 @@ describe Spotlight::FeaturedImageUploader do
 
   let(:mounter) { FactoryBot.create(:featured_image) }
 
-  describe '#extension_whitelist' do
+  describe '#extension_allowlist' do
     it 'is the configured array of approved extension to be uploaded' do
-      expect(featured_image_uploader.extension_whitelist).to eq Spotlight::Engine.config.allowed_upload_extensions
+      expect(featured_image_uploader.extension_allowlist).to eq Spotlight::Engine.config.allowed_upload_extensions
     end
   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/catalog/_edit_default.html.erb_spec.rb

@@ -25,7 +25,7 @@ describe 'spotlight/catalog/_edit_default.html.erb', type: :view do
   it 'has a edit tag form' do
     render
     expect(rendered).to have_field 'solr_document_exhibit_tag_list'
-    expect(rendered).to have_selector '#solr_document_exhibit_tag_list[@data-autocomplete_url="autocomplete-path.json"]'
+    expect(rendered).to have_selector '#solr_document_exhibit_tag_list[@data-autocomplete-url="autocomplete-path.json"]'
   end
 
   it 'does not have special metadata editing fields for non-uploaded resources' do

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,23 @@
 # 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' }
+  let(:exhibit) { FactoryBot.build(:exhibit) }
+
+  before do
+    assign(:recent_reindexing, recent_reindexing)
+    allow(view).to receive(:current_exhibit).and_return(exhibit)
+  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 +26,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 +67,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/job_trackers/show.html.erb_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+describe 'spotlight/job_trackers/show', type: :view do
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+  let(:job_tracker) { FactoryBot.create(:job_tracker, job_class: 'Spotlight::ReindexExhibitJob', on: exhibit, user: user) }
+  let(:user) { FactoryBot.create(:user) }
+
+  before do
+    assign(:exhibit, exhibit)
+    assign(:job_tracker, job_tracker)
+
+    allow(view).to receive_messages(current_exhibit: exhibit)
+  end
+
+  it 'displays the type of job' do
+    render
+    expect(rendered).to have_selector 'h2', text: 'Spotlight::ReindexExhibitJob'
+  end
+
+  it 'displays the job status for enqueued jobs' do
+    job_tracker.update(status: 'enqueued')
+    render
+    expect(rendered).to have_content '⏱'
+  end
+
+  it 'displays the job status for failed jobs' do
+    job_tracker.update(status: 'failed')
+    render
+    expect(rendered).to have_content '🟥'
+    expect(rendered).to have_content 'job failed'
+  end
+
+  it 'displays the job status for successful jobs' do
+    job_tracker.update(status: 'completed')
+    render
+    expect(rendered).to have_content '✅'
+    expect(rendered).to have_content 'job completed'
+  end
+
+  it 'display job started events' do
+    render
+    expect(rendered).to have_selector 'tr', text: '1 job started', normalize_ws: true
+  end
+
+  it 'records who started the job' do
+    render
+    expect(rendered).to have_selector 'tr', text: "2 job created by #{user.email}", normalize_ws: true
+  end
+
+  it 'displays logged messages' do
+    job_tracker.events.create(data: { message: 'this is a useful log message' })
+    job_tracker.events.create(data: { message: 'and so is this' })
+
+    render
+    expect(rendered).to have_selector 'tr', text: 'this is a useful log message'
+    expect(rendered).to have_selector 'tr', text: 'and so is this'
+  end
+
+  it 'displays job progress information' do
+    allow(job_tracker).to receive_messages(progress: 37, total: 51)
+
+    render
+    expect(rendered).to have_content 'processed 37 / 51'
+  end
+end

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

@@ -2,9 +2,9 @@
 
 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(:field) { Blacklight::Configuration::Field.new label: 'Some label', 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' }
+  let(:p) { 'spotlight/metadata_configurations/metadata_field' }
 
   before do
     assign(:exhibit, exhibit)
@@ -17,8 +17,7 @@ describe 'spotlight/metadata_configurations/_metadata_field', type: :view do
     )
   end
 
-  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'
+  it 'uses the metadata field label' do
     render partial: p, locals: { key: 'some_key', config: field, f: builder }
     expect(rendered).to have_selector '.field-label', text: 'Some label'
   end

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/sir_trevor/blocks/_browse_block.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_browse_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/browse_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/browse_block' }
   let(:page) { double('Page', display_sidebar?: true) }
   let(:search) { FactoryBot.create(:search) }
   let(:block) do

data/spec/views/spotlight/sir_trevor/blocks/_iframe_block.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_iframe_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/iframe_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/iframe_block' }
   let(:block) do
     OpenStruct.new
   end

data/spec/views/spotlight/sir_trevor/blocks/_link_to_search_block.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_link_to_search_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/link_to_search_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/link_to_search_block' }
   let(:page) { double('Page', display_sidebar?: true) }
   let(:search) { FactoryBot.create(:search, query_params: { a: 1 }) }
   let(:block) do

data/spec/views/spotlight/sir_trevor/blocks/_rule_block.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_rule_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/rule_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/rule_block' }
 
   it 'has an hr' do
     render partial: p

data/spec/views/spotlight/sir_trevor/blocks/_solr_documents_block.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_solr_documents_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_block' }
   let(:page) { double('Page') }
   let(:block) do
     SirTrevorRails::Blocks::SolrDocumentsBlock.new({ type: 'block', data: { title: 'Some title', text: 'Some text', 'text-align' => 'right' } }, page)
@@ -9,10 +9,14 @@ describe 'spotlight/sir_trevor/blocks/_solr_documents_block.html.erb', type: :vi
   let(:doc) { blacklight_config.document_model.new(id: 1) }
   let(:blacklight_config) do
     Blacklight::Configuration.new do |config|
-      config.view.embed.partials = %w[a b c]
-      config.view.embed.locals = { a: 1 }
+      config.view.embed(partials: %w[a b c], locals: { a: 1 })
     end
   end
+  let(:stub_presenter) do
+    instance_double(Blacklight::DocumentPresenter, heading: 'blah', thumbnail: thumbnail_presenter)
+  end
+
+  let(:thumbnail_presenter) { instance_double(Blacklight::ThumbnailPresenter, exists?: true, thumbnail_tag: 'thumb') }
 
   before do
     allow(block).to receive(:each_document).and_yield({}, doc)
@@ -21,7 +25,7 @@ describe 'spotlight/sir_trevor/blocks/_solr_documents_block.html.erb', type: :vi
 
   before do
     allow(view).to receive(:blacklight_config).and_return(blacklight_config)
-    allow(view).to receive_messages(has_thumbnail?: true, render_thumbnail_tag: 'thumb', document_link_params: {})
+    allow(view).to receive_messages(document_presenter: stub_presenter, document_link_params: {})
   end
 
   context 'with a multi-image object' do

data/spec/views/spotlight/sir_trevor/blocks/_solr_documents_carousel_block.html.erb_spec.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_solr_documents_carousel_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_carousel_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_carousel_block' }
   let(:block) do
     SirTrevorRails::Blocks::SolrDocumentsCarouselBlock.new({ type: 'block', data: {} }, page)
   end
+  let(:stub_presenter) do
+    instance_double(Blacklight::DocumentPresenter, heading: 'blah', thumbnail: thumbnail_presenter)
+  end
+
+  let(:thumbnail_presenter) { instance_double(Blacklight::ThumbnailPresenter, exists?: true, thumbnail_tag: 'thumb') }
 
   before do
     allow(block).to receive(:each_document).and_return([
@@ -14,7 +19,7 @@ describe 'spotlight/sir_trevor/blocks/_solr_documents_carousel_block.html.erb',
                                                        ])
     allow(block).to receive_messages(documents?: true)
     allow(view).to receive_messages(solr_documents_carousel_block: block)
-    allow(view).to receive_messages(has_thumbnail?: true, render_thumbnail_tag: 'thumb', blacklight_config: Blacklight::Configuration.new)
+    allow(view).to receive_messages(document_presenter: stub_presenter, blacklight_config: Blacklight::Configuration.new)
   end
 
   it 'has a slideshow block' do

data/spec/views/spotlight/sir_trevor/blocks/_solr_documents_embed_block.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_solr_documents_embed_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_embed_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_embed_block' }
   let(:page) { double('Page') }
   let(:block) do
     SirTrevorRails::Blocks::SolrDocumentsEmbedBlock.new({ type: 'block', data: { title: 'Some title', text: 'Some text', 'text-align' => 'right' } }, page)
@@ -9,10 +9,14 @@ describe 'spotlight/sir_trevor/blocks/_solr_documents_embed_block.html.erb', typ
   let(:doc) { blacklight_config.document_model.new(id: 1) }
   let(:blacklight_config) do
     Blacklight::Configuration.new do |config|
-      config.view.embed.partials = %w[a b c]
-      config.view.embed.locals = { a: 1 }
+      config.view.embed(partials: %w[a b c], locals: { a: 1 })
     end
   end
+  let(:stub_presenter) do
+    instance_double(Blacklight::DocumentPresenter, heading: 'blah', thumbnail: thumbnail_presenter)
+  end
+
+  let(:thumbnail_presenter) { instance_double(Blacklight::ThumbnailPresenter, exists?: true, thumbnail_tag: 'thumb') }
 
   before do
     allow(block).to receive(:each_document).and_yield({}, doc)
@@ -20,8 +24,7 @@ describe 'spotlight/sir_trevor/blocks/_solr_documents_embed_block.html.erb', typ
   end
 
   before do
-    allow(view).to receive(:blacklight_config).and_return(blacklight_config)
-    allow(view).to receive_messages(has_thumbnail?: true, render_thumbnail_tag: 'thumb')
+    allow(view).to receive_messages(blacklight_config: blacklight_config, document_presenter: stub_presenter)
   end
 
   it 'has a embed block' do