blacklight-spotlight 2.13.0 → 3.0.0.alpha.1

data/spec/routing/spotlight/exhibit_catalog_spec.rb

@@ -4,17 +4,6 @@ RSpec.describe 'Catalog controller', type: :routing do
   describe 'routing' do
     routes { Spotlight::Engine.routes }
 
-    context 'when the routing constraint is set to allow periods' do
-      before do
-        allow(Blacklight::Engine.config.routes).to receive(:identifier_constraint).and_return(%r{[^/]+})
-        Rails.application.reload_routes!
-      end
-
-      it 'routes to #show' do
-        expect(get('/1/catalog/gallica.bnf.fr')).to route_to('spotlight/catalog#show', exhibit_id: '1', id: 'gallica.bnf.fr')
-      end
-    end
-
     it 'routes to #show with a format' do
       expect(get('/1/catalog/dq287tq6352.xml')).to route_to('spotlight/catalog#show', exhibit_id: '1', id: 'dq287tq6352', format: 'xml')
     end
@@ -26,5 +15,20 @@ RSpec.describe 'Catalog controller', type: :routing do
     it 'routes to #manifest' do
       expect(get('/1/catalog/1-1/manifest.json')).to route_to('spotlight/catalog#manifest', exhibit_id: '1', id: '1-1', format: 'json')
     end
+
+    context 'when the routing constraint is set to allow periods' do
+      before do
+        allow(Spotlight::Engine.config.routes).to receive(:solr_documents).and_return(constraints: { id: %r{[^/]+} })
+        Rails.application.reload_routes!
+      end
+
+      after do
+        Rails.application.reload_routes!
+      end
+
+      it 'routes to #show as expected' do
+        expect(get('/1/catalog/gallica.bnf.fr')).to route_to('spotlight/catalog#show', exhibit_id: '1', id: 'gallica.bnf.fr')
+      end
+    end
   end
 end

data/spec/serializers/spotlight/exhibit_export_serializer_spec.rb

@@ -64,6 +64,14 @@ describe Spotlight::ExhibitExportSerializer do
     expect(subject['attachments']).to have(source_exhibit.attachments.count).items
   end
 
+  it 'has languages' do
+    expect(subject['languages']).to have(source_exhibit.languages.count).items
+  end
+
+  it 'has translations' do
+    expect(subject['translations']).to have(source_exhibit.translations.count).items
+  end
+
   it 'has resources' do
     expect(subject['resources']).to have(source_exhibit.resources.count).items
   end
@@ -149,6 +157,30 @@ describe Spotlight::ExhibitExportSerializer do
       end
     end
 
+    context 'for exhibits with languages and translations' do
+      let!(:language) do
+        source_exhibit.languages.create!(locale: 'zz', public: true, text: 'abc')
+      end
+
+      let!(:translation) do
+        source_exhibit.translations.create!(locale: 'zz', key: 'abc', value: '123')
+      end
+
+      it 'has the language' do
+        expect(subject.languages.count).to eq 1
+
+        language = subject.languages.first
+        expect(language).to have_attributes(locale: 'zz', public: true, text: 'abc')
+      end
+
+      it 'has translations' do
+        expect(subject.translations.count).to eq 1
+
+        translation = subject.translations.unscope(where: :locale).first
+        expect(translation).to have_attributes(locale: 'zz', key: 'abc', value: '123')
+      end
+    end
+
     it 'has tags' do
       expect(subject.owned_taggings.length).to eq source_exhibit.owned_taggings.length
       expect(subject.owned_taggings.first).to be_persisted
@@ -360,4 +392,32 @@ describe Spotlight::ExhibitExportSerializer do
       end
     end
   end
+
+  context 'with engine configuration disabling all export types' do
+    let(:exports) do
+      {}
+    end
+
+    before do
+      allow(Spotlight::Engine.config).to receive(:exports).and_return(exports)
+    end
+
+    it 'includes nothing' do
+      expect(subject).to be_blank
+    end
+  end
+
+  context 'with engine configuration enabling only pages' do
+    let(:exports) do
+      { pages: true }
+    end
+
+    before do
+      allow(Spotlight::Engine.config).to receive(:exports).and_return(exports)
+    end
+
+    it 'includes only the page-related data' do
+      expect(subject.keys).to match_array %w[searches about_pages feature_pages home_page contacts]
+    end
+  end
 end

data/spec/test_app_templates/Gemfile.extra

@@ -1 +1,4 @@
 gem 'thor', '~> 0.20'
+gem 'blacklight', '~> 7.0'
+gem 'blacklight-oembed', '>= 0.1', github: 'sul-dlss/blacklight-oembed'
+gem 'sprockets', '< 4'

data/spec/test_app_templates/catalog_controller.rb

@@ -35,6 +35,10 @@ class CatalogController < ApplicationController
     config.show.tile_source_field = :content_metadata_image_iiif_info_ssm
     config.show.partials.insert(1, :openseadragon)
 
+    config.add_results_collection_tool(:sort_widget)
+    config.add_results_collection_tool(:per_page_widget)
+    config.add_results_collection_tool(:view_type_group)
+
     # solr fields that will be treated as facets by the blacklight application
     #   The ordering of the field names is the order of the display
     #

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', '~> 6.0'
-    gem 'blacklight-gallery', '>= 0.3.0'
+    gem 'blacklight', '~> 7.0'
+    gem 'blacklight-gallery', '~> 1.1'
     Bundler.with_clean_env do
       run 'bundle install'
     end

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

@@ -2,7 +2,7 @@
 
 describe 'shared/_header_navbar', type: :view do
   before do
-    stub_template '_user_util_links.html.erb' => 'links'
+    stub_template 'shared/_user_util_links.html.erb' => 'links'
   end
 
   it 'has nav links' do

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

@@ -13,7 +13,7 @@ describe 'shared/_masthead', type: :view do
 
   it 'has the site title and subtitle' do
     render
-    expect(rendered).to have_selector '.h1', text: exhibit.title
+    expect(rendered).to have_selector '.h2', text: exhibit.title
     expect(rendered).to have_selector 'small', text: exhibit.subtitle
   end
 

data/spec/views/{_user_util_links.html.erb_spec.rb → shared/_user_util_links.html.erb_spec.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe '_user_util_links', type: :view do
+describe 'shared/_user_util_links', type: :view do
   let(:current_exhibit) { FactoryBot.create(:exhibit) }
   before do
     allow(view).to receive(:blacklight_config).and_return(Blacklight::Configuration.new)

data/spec/views/spotlight/about_pages/_sidebar.html.erb_spec.rb

@@ -15,8 +15,8 @@ describe 'spotlight/about_pages/_sidebar.html.erb', type: :view do
   it 'renders a list of pages' do
     render
     # Checking that they are sorted accoding to weight
-    expect(rendered).to have_selector '#sidebar ul.sidenav li:nth-child(1) a', text: 'Three'
-    expect(rendered).to have_selector '#sidebar ul.sidenav li:nth-child(2) a', text: 'One'
+    expect(rendered).to have_selector 'ul.sidenav li:nth-child(1) a', text: 'Three'
+    expect(rendered).to have_selector 'ul.sidenav li:nth-child(2) a', text: 'One'
     expect(rendered).to have_link 'Three', href: "/spotlight/#{exhibit.slug}/about/three"
     expect(rendered).to have_link 'One', href: "/spotlight/#{exhibit.slug}/about/one"
     expect(rendered).not_to have_link 'Two'

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

@@ -40,8 +40,8 @@ describe 'spotlight/about_pages/index.html.erb', type: :view do
     assign(:pages, pages)
     allow(exhibit).to receive(:about_pages).and_return pages
     render
-    expect(rendered).to have_selector '.panel-title', text: 'Title1'
-    expect(rendered).to have_selector '.panel-title', text: 'Title2'
+    expect(rendered).to have_selector '.card-title', text: 'Title1'
+    expect(rendered).to have_selector '.card-title', text: 'Title2'
 
     expect(rendered).to have_selector '.contacts_admin ol.dd-list li[data-id]', count: 2
     expect(rendered).to have_selector '.contacts_admin ol.dd-list li input[data-property=weight]', visible: false, count: 2

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

@@ -24,6 +24,6 @@ describe 'spotlight/browse/search', type: :view do
 
   it 'displays the item count' do
     render partial: 'spotlight/browse/search', locals: { search: search }
-    expect(response).to have_selector 'small', text: /#{search.documents.size} items/i
+    expect(response).to have_selector 'small', text: /#{search.count} items/i
   end
 end

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

@@ -1,23 +1,12 @@
 # frozen_string_literal: true
 
 describe 'spotlight/browse/_sort_and_per_page', type: :view do
-  let :blacklight_config do
-    Blacklight::Configuration.new
-  end
-
   before do
-    allow(view).to receive_messages(blacklight_config: blacklight_config)
+    allow(view).to receive_messages(render_results_collection_tools: 'collection tools')
   end
 
   it 'renders the pagination, sort, per page and view type controls' do
-    stub_template '_paginate_compact.html.erb' => "paginate_compact\n"
-    stub_template '_sort_widget.html.erb' => "sort_widget\n"
-    stub_template '_per_page_widget.html.erb' => "per_page_widget\n"
-    stub_template '_view_type_group.html.erb' => "view_type_group\n"
     render
-    expect(rendered).to_not have_content 'paginate_compact'
-    expect(rendered).to have_content 'sort_widget'
-    expect(rendered).to have_content 'per_page_widget'
-    expect(rendered).to have_content 'view_type_group'
+    expect(rendered).to have_content 'collection tools'
   end
 end

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

@@ -23,14 +23,14 @@ describe 'spotlight/browse/show', type: :view do
   it 'has a heading and item count when there is no current search masthead' do
     render
     expect(response).to have_selector 'h1', text: search.title
-    expect(response).to have_selector '.item-count', text: "#{search.documents.size} items"
+    expect(response).to have_selector '.item-count', text: "#{search.count} items"
   end
 
   it 'does not have the heading and item count when there is a current search masthead' do
     allow(view).to receive_messages(resource_masthead?: true)
     render
     expect(response).to_not have_selector 'h1', text: search.title
-    expect(response).to_not have_selector '.item-count', text: "#{search.documents.size} items"
+    expect(response).to_not have_selector '.item-count', text: "#{search.count} items"
   end
 
   it 'has an edit button' do

data/spec/views/spotlight/catalog/admin.html.erb_spec.rb

@@ -21,7 +21,7 @@ describe 'spotlight/catalog/admin.html.erb', type: :view do
 
   it 'renders the sidebar' do
     render
-    expect(rendered).to have_link 'Browse'
+    expect(view.content_for(:sidebar)).to have_link 'Browse'
   end
 
   it "renders the 'add items' link if any repository sources are configured" do

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

@@ -35,11 +35,11 @@ describe 'spotlight/dashboards/_reindexing_activity.html.erb', type: :view do
     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-md-3', text: 'Date', count: 1)
-      expect(rendered).to have_css('table.table-striped th.col-md-2', text: 'Requested By', count: 1)
-      expect(rendered).to have_css('table.table-striped th.col-md-1', text: 'Items Indexed', count: 1)
-      expect(rendered).to have_css('table.table-striped th.col-md-2', text: 'Elapsed Time', count: 1)
-      expect(rendered).to have_css('table.table-striped th.col-md-2', text: 'Status', count: 1)
+      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-2', text: 'Status', count: 1)
     end
 
     it 'formats the start time correctly' do

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

@@ -20,7 +20,7 @@ describe 'spotlight/dashboards/analytics.html.erb', type: :view do
 
   context 'with a configured analytics integration' do
     before do
-      allow(Spotlight::Analytics::Ga).to receive(:enabled?).and_return(true)
+      allow(current_exhibit).to receive(:analytics_provider).and_return(double(Spotlight::Analytics::Ga, enabled?: true))
       stub_template 'spotlight/dashboards/_analytics.html.erb' => 'Analytics data'
     end
 

data/spec/views/spotlight/exhibits/_exhibit_card_front.html.erb_spec.rb

@@ -25,7 +25,7 @@ describe 'spotlight/exhibits/_exhibit_card_front.html.erb', type: :view do
   it 'has a title' do
     render p, exhibit: exhibit
 
-    expect(rendered).to have_selector '.card-title', text: exhibit.title
+    expect(rendered).to have_selector '.exhibit-card-title', text: exhibit.title
   end
 
   context 'for an unpublished exhibit' do
@@ -36,7 +36,7 @@ describe 'spotlight/exhibits/_exhibit_card_front.html.erb', type: :view do
     it 'has an unpublished banner' do
       render p, exhibit: exhibit
 
-      expect(rendered).to have_selector '.label.unpublished', text: 'Unpublished'
+      expect(rendered).to have_selector '.badge.unpublished', text: 'Unpublished'
     end
   end
 end

data/spec/views/spotlight/exhibits/edit.html.erb_spec.rb

@@ -20,7 +20,7 @@ describe 'spotlight/exhibits/edit', type: :view do
     render
 
     expect(rendered).to have_selector "form[action=\"#{spotlight.exhibit_path(exhibit)}\"]"
-    expect(rendered).to have_selector '.callout.callout-danger.row'
+    expect(rendered).to have_selector '.alert.alert-danger'
     expect(rendered).to have_content 'This action is irreversible'
     expect(rendered).to have_link 'Export data', href: spotlight.import_exhibit_path(exhibit)
     expect(rendered).to have_button 'Import data'

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

@@ -134,7 +134,7 @@ describe 'spotlight/exhibits/index', type: :view do
     it 'has a sidebar with a button to create a new exhibit' do
       render
 
-      expect(rendered).to have_selector 'aside .btn', text: 'Create a new exhibit'
+      expect(view.content_for(:sidebar)).to have_selector '.btn', text: 'Create a new exhibit'
     end
   end
 end

data/spec/views/spotlight/feature_pages/_sidebar.html.erb_spec.rb

@@ -21,10 +21,10 @@ describe 'spotlight/feature_pages/_sidebar.html.erb', type: :view do
     allow(view).to receive(:current_page?).and_return(true, false)
     render
     # Checking that they are sorted accoding to weight
-    expect(rendered).to have_selector 'li.active h4', text: 'Parent Page'
-    expect(rendered).to have_selector '#sidebar ol.sidenav li:nth-child(1) a', text: 'Five'
-    expect(rendered).to have_selector '#sidebar ol.sidenav li:nth-child(2) a', text: 'Three'
-    expect(rendered).to have_selector 'li h4 a', text: 'Two' # a different parent page
+    expect(rendered).to have_selector 'li.active', text: 'Parent Page'
+    expect(rendered).to have_selector 'ol.sidenav li:nth-child(1) a', text: 'Five'
+    expect(rendered).to have_selector 'ol.sidenav li:nth-child(2) a', text: 'Three'
+    expect(rendered).to have_selector 'li a', text: 'Two' # a different parent page
     expect(rendered).to have_link 'Four' # different parent
     expect(rendered).not_to have_link 'Six' # not published
     expect(rendered).not_to have_link 'Seven' # different exhibit
@@ -34,9 +34,9 @@ describe 'spotlight/feature_pages/_sidebar.html.erb', type: :view do
     assign(:page, child1)
     render
     # Checking that they are sorted accoding to weight
-    expect(rendered).to have_selector 'h4', text: 'Parent Page'
-    expect(rendered).to have_selector '#sidebar ol.sidenav li:nth-child(1) a', text: 'Five'
-    expect(rendered).to have_selector '#sidebar ol.sidenav li:nth-child(2) a', text: 'Three'
+    expect(rendered).to have_selector 'li', text: 'Parent Page'
+    expect(rendered).to have_selector 'ol.sidenav li:nth-child(1) a', text: 'Five'
+    expect(rendered).to have_selector 'ol.sidenav li:nth-child(2) a', text: 'Three'
     expect(rendered).to have_content 'Two' # not selected page
     expect(rendered).to have_link 'Four' # different parent
     expect(rendered).not_to have_link 'Six' # not published

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

@@ -8,7 +8,7 @@ describe 'spotlight/metadata_configurations/_metadata_field', type: :view do
     assign(:blacklight_configuration, exhibit.blacklight_configuration)
     allow(view).to receive_messages(
       current_exhibit: exhibit,
-      blacklight_config: exhibit.blacklight_configuration,
+      blacklight_config: exhibit.blacklight_configuration.blacklight_config,
       available_view_fields: { some_view_type: 1, another_view_type: 2 },
       select_deselect_button: nil
     )
@@ -18,12 +18,13 @@ describe 'spotlight/metadata_configurations/_metadata_field', type: :view do
   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(nil, 'some_key').and_return 'Some label'
+    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 }
     expect(rendered).to have_selector '.field-label', text: 'Some label'
   end
 
   it 'marks views as disabled if they are immutable' do
+    allow(controller).to receive(:enabled_in_spotlight_view_type_configuration?).and_return(true)
     render partial: p, locals: { key: 'some_key', config: field, f: builder }
     expect(rendered).to have_selector 'input[disabled][name="z[some_key][another_view_type]"]'
   end

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

@@ -7,10 +7,11 @@ describe 'spotlight/metadata_configurations/edit', type: :view do
     assign(:blacklight_configuration, exhibit.blacklight_configuration)
     allow(view).to receive_messages(
       current_exhibit: exhibit,
-      blacklight_config: exhibit.blacklight_configuration,
+      blacklight_config: exhibit.blacklight_configuration.blacklight_config,
       available_view_fields: { some_view_type: 1, another_view_type: 2 },
       select_deselect_button: nil
     )
+    allow(controller).to receive(:enabled_in_spotlight_view_type_configuration?).and_return(true)
   end
 
   it 'has columns for the available view types' do

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

@@ -26,8 +26,8 @@ describe 'spotlight/pages/index.html.erb', type: :view do
     assign(:pages, pages)
     allow(exhibit).to receive(:feature_pages).and_return pages
     render
-    expect(rendered).to have_selector '.panel-title', text: 'Title1'
-    expect(rendered).to have_selector '.panel-title', text: 'Title2'
+    expect(rendered).to have_selector '.card-title', text: 'Title1'
+    expect(rendered).to have_selector '.card-title', text: 'Title2'
   end
 
   describe 'Without pages' do

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

@@ -33,7 +33,7 @@ describe 'spotlight/pages/show', type: :view do
 
   it 'does not double-escape HTML entities in the HTML title' do
     allow(page).to receive_messages(title: 'Abbott & Costello')
-    stub_template '_user_util_links.html.erb' => ''
+    stub_template 'shared/_user_util_links.html.erb' => ''
     stub_template 'shared/_masthead.html.erb' => ''
     render template: 'spotlight/pages/show', layout: 'layouts/spotlight/spotlight'
     expect(rendered).to have_content('Abbott & Costello | Blacklight')
@@ -53,13 +53,13 @@ describe 'spotlight/pages/show', type: :view do
   it 'renders the sidebar' do
     page.display_sidebar = true
     render
-    expect(rendered).to match('Sidebar')
+    expect(view.content_for(:sidebar)).to match('Sidebar')
   end
 
   it 'does not render the sidebar if the page has it disabled' do
     allow(page).to receive_messages(display_sidebar?: false)
     render
-    expect(rendered).to_not match('Sidebar')
+    expect(view.content_for(:sidebar)).to_not match('Sidebar')
   end
 
   it 'renders an empty partial if the page has no content' do

data/spec/views/spotlight/searches/_search.html.erb_spec.rb

@@ -30,7 +30,7 @@ describe 'spotlight/searches/_search.html.erb', type: :view do
     render partial: 'spotlight/searches/search', locals: { f: @f }
     # rubocop:enable RSpec/InstanceVariable
     expect(rendered).to have_selector "li[data-id='99']"
-    expect(rendered).to have_selector '.panel-heading .main .title', text: 'Title1'
+    expect(rendered).to have_selector '.card-title', text: 'Title1'
     expect(rendered).to have_selector 'img[src="/images/7777/full/400,300/0/default.jpg"]'
     expect(rendered).to have_selector 'input[type=hidden][data-property=weight]', visible: false
   end

data/spec/views/spotlight/searches/edit.html.erb_spec.rb

@@ -33,8 +33,8 @@ describe 'spotlight/searches/edit.html.erb', type: :view do
 
   it 'renders active search constraints' do
     render
-    expect(rendered).to have_selector '.appliedFilter .constraint-value'
-    expect(rendered).to have_selector '.appliedFilter .constraint-value .filterName', text: 'Some Field'
-    expect(rendered).to have_selector '.appliedFilter .constraint-value .filterValue', text: 'xyz'
+    expect(rendered).to have_selector '.appliedParams .constraint-value'
+    expect(rendered).to have_selector '.appliedParams .constraint-value .filter-name', text: 'Some Field'
+    expect(rendered).to have_selector '.appliedParams .constraint-value .filter-value', text: 'xyz'
   end
 end