blacklight 7.33.0 → 8.0.0

data/spec/controllers/catalog_controller_spec.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
 RSpec.describe CatalogController, api: true do
-  around { |test| Deprecation.silence(Blacklight::Catalog) { test.call } }
-
   let(:doc_id) { '2007020969' }
-  let(:mock_response) { instance_double(Blacklight::Solr::Response) }
   let(:mock_document) { instance_double(SolrDocument, export_formats: {}) }
   let(:search_service) { instance_double(Blacklight::SearchService) }
 
@@ -63,17 +60,17 @@ RSpec.describe CatalogController, api: true do
       end
 
       it "shows 0 results when the user asks for an invalid value to a custom facet query", integration: true do
-        get :index, params: { f: { example_query_facet_field: 'bogus' } } # bogus custom facet value
+        get :index, params: { f: { example_query_facet_field: ['bogus'] } } # bogus custom facet value
         expect(assigns(:response).docs).to be_empty
       end
 
       it "returns results (possibly 0) when the user asks for a valid value to a custom facet query", integration: true do
-        get :index, params: { f: { example_query_facet_field: 'years_25' } } # valid custom facet value with some results
+        get :index, params: { f: { example_query_facet_field: ['years_25'] } } # valid custom facet value with some results
         expect(assigns(:response).docs).not_to be_empty
       end
 
       it "returns no results when the users asks for a value that doesn't match any" do
-        get :index, params: { f: { example_query_facet_field: 'years_5' } } # valid custom facet value with NO results
+        get :index, params: { f: { example_query_facet_field: ['years_5'] } } # valid custom facet value with NO results
         expect(assigns(:response).docs).to be_empty
       end
 
@@ -161,20 +158,20 @@ RSpec.describe CatalogController, api: true do
 
         format = facets.find { |x| x['id'] == 'format' }
 
-        expect(format['attributes']['items'].map { |x| x['attributes'] }).to match_array([{ "value" => "Book", "hits" => 30, "label" => "Book" }])
+        expect(format['attributes']['items'].pluck('attributes')).to contain_exactly({ "value" => "Book", "hits" => 30, "label" => "Book" })
         expect(format['links']['self']).to eq facet_catalog_url(format: :json, id: 'format')
         expect(format['attributes']['items'].first['links']['self']).to eq search_catalog_url(format: :json, f: { format: ['Book'] })
       end
 
       it "gets the search fields" do
         expect(search_fields).to have(4).fields
-        expect(search_fields.map { |x| x['id'] }).to match_array %w[all_fields author subject title]
+        expect(search_fields.pluck('id')).to match_array %w[all_fields author subject title]
         expect(search_fields.first['links']['self']).to eq search_catalog_url(format: :json, search_field: 'all_fields')
       end
 
       describe "facets" do
         let(:query_facet) { facets.find { |x| x['id'] == 'example_query_facet_field' } }
-        let(:query_facet_items) { query_facet['attributes']['items'].map { |x| x['attributes'] } }
+        let(:query_facet_items) { query_facet['attributes']['items'].pluck('attributes') }
 
         it "has items with labels and values" do
           expect(query_facet_items.first['label']).to eq 'within 25 Years'
@@ -339,7 +336,7 @@ RSpec.describe CatalogController, api: true do
       before do
         allow(mock_document).to receive_messages(export_formats: {})
         allow(controller).to receive(:search_service).and_return(search_service)
-        expect(search_service).to receive(:fetch).and_return([mock_response, mock_document])
+        expect(search_service).to receive(:fetch).and_return(mock_document)
         allow(controller).to receive(:current_search_session).and_return(current_search)
       end
 
@@ -399,7 +396,7 @@ RSpec.describe CatalogController, api: true do
 
     it "renders show.html.erb" do
       allow(controller).to receive(:search_service).and_return(search_service)
-      expect(search_service).to receive(:fetch).and_return([mock_response, mock_document])
+      expect(search_service).to receive(:fetch).and_return(mock_document)
 
       get :show, params: { id: doc_id }
       expect(response).to render_template(:show)
@@ -408,7 +405,7 @@ RSpec.describe CatalogController, api: true do
     describe '@document' do
       before do
         allow(controller).to receive(:search_service).and_return(search_service)
-        expect(search_service).to receive(:fetch).and_return([mock_response, mock_document])
+        expect(search_service).to receive(:fetch).and_return(mock_document)
 
         get :show, params: { id: doc_id }
       end
@@ -434,7 +431,7 @@ RSpec.describe CatalogController, api: true do
         Mime::Type.register "application/mock", :mock
         SolrDocument.use_extension(FakeExtension)
         allow(controller).to receive(:search_service).and_return(search_service)
-        expect(search_service).to receive(:fetch).and_return([nil, SolrDocument.new(id: 'my_fake_doc')])
+        expect(search_service).to receive(:fetch).and_return(SolrDocument.new(id: 'my_fake_doc'))
       end
 
       after do
@@ -470,34 +467,15 @@ RSpec.describe CatalogController, api: true do
     end
   end
 
-  describe 'GET suggest' do
-    it 'returns JSON' do
-      get :suggest, params: { format: 'json' }
-      expect(response.body).to eq [].to_json
-    end
-
-    it 'returns suggestions' do
-      get :suggest, params: { format: 'json', q: 'new' }
-      json = JSON.parse(response.body)
-      expect(json.count).to eq 5
-      expect(json.first['term']).to eq 'new jersey'
-    end
-  end
-
   describe "email/sms" do
-    let(:mock_response) { instance_double(Blacklight::Solr::Response, documents: [SolrDocument.new(id: 'my_fake_doc'), SolrDocument.new(id: 'my_other_doc')]) }
+    let(:mock_document) { SolrDocument.new }
 
     before do
-      mock_document.extend(Blacklight::Document::Sms)
-      mock_document.extend(Blacklight::Document::Email)
-      allow(mock_document).to receive(:to_semantic_values).and_return({})
       allow(mock_document).to receive(:to_model).and_return(SolrDocument.new(id: 'my_fake_doc'))
 
       allow(controller).to receive(:search_service).and_return(search_service)
-      expect(search_service).to receive(:fetch).and_return([mock_response, [mock_document]])
+      expect(search_service).to receive(:fetch).and_return([mock_document])
       request.env["HTTP_REFERER"] = "/catalog/#{doc_id}"
-      SolrDocument.use_extension(Blacklight::Document::Email)
-      SolrDocument.use_extension(Blacklight::Document::Sms)
     end
 
     describe "email", api: false do
@@ -581,7 +559,7 @@ RSpec.describe CatalogController, api: true do
 
       it "redirects back to the record upon success" do
         post :sms, params: { id: doc_id, to: '5555555555', carrier: 'txt.att.net' }
-        expect(request.flash[:error]).to eq nil
+        expect(request.flash[:error]).to be_nil
         expect(request).to redirect_to(solr_document_path(doc_id))
       end
 
@@ -607,31 +585,6 @@ RSpec.describe CatalogController, api: true do
         get :citation, params: { id: "bad-record-identifer" }
       end.to raise_error Blacklight::Exceptions::RecordNotFound
     end
-
-    context "when there is an invalid search", api: false do
-      let(:service) { instance_double(Blacklight::SearchService) }
-      let(:fake_error) { Blacklight::Exceptions::InvalidRequest.new }
-
-      before do
-        allow(controller).to receive(:search_service).and_return(service)
-        allow(service).to receive(:search_results) { |*_args| raise fake_error }
-        allow(Rails.env).to receive_messages(test?: false)
-      end
-
-      it "redirects the user to the root url for a bad search" do
-        expect(controller.logger).to receive(:error).with(fake_error)
-        get :index, params: { q: '+' }
-        expect(response.redirect_url).to eq root_url
-        expect(request.flash[:notice]).to eq "Sorry, I don't understand your search."
-        expect(response).not_to be_successful
-        expect(response.status).to eq 302
-      end
-
-      it "returns status 500 if the catalog path is raising an exception" do
-        allow(controller).to receive(:flash).and_return(notice: I18n.t('blacklight.search.errors.request_error'))
-        expect { get :index, params: { q: '+' } }.to raise_error Blacklight::Exceptions::InvalidRequest
-      end
-    end
   end
 
   context "without a user authentication provider" do
@@ -779,7 +732,7 @@ RSpec.describe CatalogController, api: true do
     end
 
     describe "with a facet" do
-      before { allow(controller).to receive_messages(params: { f: { "field" => ["value"] } }) }
+      before { allow(controller).to receive_messages(params: { f: { "format" => ["value"] } }) }
 
       it { is_expected.to be true }
     end
@@ -842,73 +795,18 @@ RSpec.describe CatalogController, api: true do
     end
   end
 
-  describe "facet_limit_for" do
-    let(:blacklight_config) { controller.blacklight_config }
-
-    it "returns specified value for facet_field specified" do
-      expect(controller.facet_limit_for("subject_ssim")).to eq blacklight_config.facet_fields["subject_ssim"].limit
+  describe "page_links" do
+    it "has prev/next docs and result set data for non-empty result sets", integration: true do
+      get :page_links, params: { f: { "format" => 'Book' }, counter: 2 }
+      expect(assigns(:page_link_data)).not_to be_empty
+      expect(assigns(:page_link_data).fetch(:prev, nil)).to end_with('counter=1')
+      expect(assigns(:page_link_data).fetch(:next, nil)).to end_with('counter=3')
+      expect(assigns(:page_link_data).fetch(:totalRaw, nil)).to be 30
     end
 
-    it "facet_limit_hash should return hash with key being facet_field and value being configured limit" do
-      # facet_limit_hash has been removed from solrhelper in refactor. should it go back?
-      skip "facet_limit_hash has been removed from solrhelper in refactor. should it go back?"
-      expect(controller.facet_limit_hash).to eq blacklight_config[:facet][:limits]
-    end
-
-    it "handles no facet_limits in config" do
-      blacklight_config.facet_fields = {}
-      expect(controller.facet_limit_for("subject_ssim")).to be_nil
-    end
-
-    describe "for 'true' configured values" do
-      before do
-        allow(controller).to receive(:blacklight_config).and_return(blacklight_config)
-      end
-
-      let(:blacklight_config) do
-        Blacklight::Configuration.new do |config|
-          config.add_facet_field "language_facet", limit: true
-        end
-      end
-
-      it "returns nil if no @response available" do
-        expect(controller.facet_limit_for("some_unknown_field")).to be_nil
-      end
-
-      it "gets from @response facet.limit if available" do
-        response = instance_double(Blacklight::Solr::Response, aggregations: { "language_facet" => double(limit: nil) })
-        controller.instance_variable_set(:@response, response)
-        blacklight_config.facet_fields['language_facet'].limit = 10
-        expect(controller.facet_limit_for("language_facet")).to eq 10
-      end
-
-      it "gets the limit from the facet field in @response" do
-        response = instance_double(Blacklight::Solr::Response, aggregations: { "language_facet" => double(limit: 16) })
-        controller.instance_variable_set(:@response, response)
-        expect(controller.facet_limit_for("language_facet")).to eq 15
-      end
-
-      it "defaults to 10" do
-        expect(controller.facet_limit_for("language_facet")).to eq 10
-      end
-    end
-
-    context 'for facet fields with a key that is different from the field name' do
-      before do
-        allow(controller).to receive(:blacklight_config).and_return(blacklight_config)
-      end
-
-      let(:blacklight_config) do
-        Blacklight::Configuration.new do |config|
-          config.add_facet_field 'some_key', field: 'x', limit: true
-        end
-      end
-
-      it 'gets the limit from the facet field in the @response' do
-        response = instance_double(Blacklight::Solr::Response, aggregations: { 'x' => double(limit: 16) })
-        controller.instance_variable_set(:@response, response)
-        expect(controller.facet_limit_for('some_key')).to eq 15
-      end
+    it "is empty for empty result sets", integration: true do
+      get :page_links, params: { f: { "format" => 'empty-result-set' }, counter: 1 }
+      expect(assigns(:page_link_data)).to be_empty
     end
   end
 end

data/spec/features/autocomplete_spec.rb

@@ -3,6 +3,6 @@
 RSpec.describe 'Autocomplete suggestions' do
   it 'search form has suggest path' do
     visit root_path
-    expect(page).to have_css 'input[data-autocomplete-path="/catalog/suggest"]'
+    expect(page).to have_css 'auto-complete[src="/catalog/suggest"]'
   end
 end

data/spec/features/axe_spec.rb

@@ -28,6 +28,6 @@ RSpec.describe 'Accessibility testing', api: false, js: true do
 
   def be_accessible(skipping: [])
     # typeahead does funny things with the search bar
-    be_axe_clean.excluding('.tt-hint').skipping(skipping + [('color-contrast' if Bootstrap::VERSION < '5')].compact)
+    be_axe_clean.excluding('.tt-hint').skipping(skipping + [('color-contrast' if defined?(Bootstrap) && Bootstrap::VERSION < '5')].compact)
   end
 end

data/spec/features/bookmarks_spec.rb

@@ -45,7 +45,7 @@ RSpec.describe "Bookmarks" do
     check 'Bookmark'
 
     visit solr_document_path('2007020969')
-    expect(page).to have_css('input[type="checkbox"]:checked')
+    expect(page).to have_css('input[type="checkbox"][checked]')
     uncheck 'In Bookmarks'
   end
 

data/spec/features/component_template_override_spec.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+RSpec.describe 'Generated test application template at default path' do
+  it 'unobtrusively overrides default top navbar component template' do
+    visit root_path
+    expect(page).to have_css 'nav[data-template-override="top_navbar_component"]'
+  end
+end

data/spec/features/facets_spec.rb

@@ -69,7 +69,7 @@ RSpec.describe "Facets" do
     page.find('h3.facet-field-heading button', text: 'Pivot Field').click
 
     within '#facet-example_pivot_field' do
-      expect(page).to have_css('.facet-leaf-node', text: "Book 30")
+      expect(page).to have_css('.facet-leaf-node', text: "Book 30", normalize_ws: true)
       expect(page).not_to have_css('.facet-select', text: 'Tibetan')
       page.find('.facet-toggle-handle').click
       click_link 'Tibetan'

data/spec/features/modal_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+RSpec.describe 'Modal' do
+  it 'can open and dismiss the email modal', js: true do
+    visit solr_document_path('2007020969')
+    expect(page).to have_no_selector 'dialog#blacklight-modal'
+    click_link 'Email'
+    expect(page).to have_selector 'dialog#blacklight-modal'
+    click_button '×'
+    expect(page).to have_no_selector 'dialog#blacklight-modal'
+  end
+end

data/spec/features/search_context_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-RSpec.describe "Search Results context", js: true do
-  it "passes the current search id through" do
+RSpec.describe "Search Results context" do
+  it "passes the current search id through", js: true do
     search_for ''
     click_on 'Pluvial nectar of blessings'
     search_id = Search.last.id.to_s
@@ -16,7 +16,7 @@ RSpec.describe "Search Results context", js: true do
     expect(prev['data-context-href']).to eq "/catalog/2004310986/track?counter=8&document_id=2004310986&search_id=#{search_id}"
   end
 
-  it "redirects context urls to the original url" do
+  it "redirects context urls to the original url", js: true do
     search_for ''
     first('.index_title a').click
     expect(page).to have_content "« Previous | 1 of 30 | Next »"
@@ -43,7 +43,7 @@ RSpec.describe "Search Results context", js: true do
   end
 
   context "navigating between search results using context pagination" do
-    it "updates the back to search link with the current search pagination context" do
+    it "updates the back to search link with the current search pagination context", js: true do
       search_for ''
       expect(page).to have_content "1 - 10"
       find_all('.index_title a').last.click
@@ -55,9 +55,3 @@ RSpec.describe "Search Results context", js: true do
     end
   end
 end
-
-def search_for q
-  visit root_path
-  fill_in "q", with: q
-  click_button 'search'
-end

data/spec/features/search_results_spec.rb

@@ -58,36 +58,3 @@ RSpec.describe "Search Results" do
     expect(page).to have_xpath("//a[contains(@href, 77826928)]")
   end
 end
-
-def search_for q
-  visit root_path
-  fill_in "q", with: q
-  click_button 'search'
-end
-
-def position_in_result_page(page, id)
-  i = -1
-  page.all(".index_title a").each_with_index do |link, idx|
-    i = (idx + 1) if link['href'] =~ Regexp.new(Regexp.escape(id) + "$")
-  end
-  i.to_i
-end
-
-def number_of_results_for_query(query)
-  visit root_path
-  fill_in "q", with: query
-  click_button "search"
-  get_number_of_results_from_page(page)
-end
-
-def number_of_results_from_page(page)
-  tmp_value = Capybara.ignore_hidden_elements
-  Capybara.ignore_hidden_elements = false
-  val = begin
-          page.find("meta[name=totalResults]")['content'].to_i
-        rescue StandardError
-          0
-        end
-  Capybara.ignore_hidden_elements = tmp_value
-  val
-end

data/spec/features/sitelinks_search_box_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.describe 'Sitelinks search box' do
+  it 'is home page' do
+    visit root_path
+    expect(page).to have_selector 'script[type="application/ld+json"]', visible: :hidden
+  end
+
+  it 'on search page' do
+    visit search_catalog_path q: 'book'
+    expect(page).not_to have_selector 'script[type="application/ld+json"]', visible: :hidden
+  end
+end

data/spec/helpers/blacklight/configuration_helper_behavior_spec.rb

@@ -8,14 +8,6 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
     allow(helper).to receive_messages(blacklight_config: blacklight_config)
   end
 
-  describe "#index_fields" do
-    it "passes through the configuration" do
-      allow(Deprecation).to receive(:warn)
-      allow(blacklight_config).to receive_messages(index_fields: config_value)
-      expect(helper.index_fields).to eq config_value
-    end
-  end
-
   describe "#active_sort_fields" do
     it "restricts the configured sort fields to only those that should be displayed" do
       allow(blacklight_config).to receive_messages(sort_fields: { a: double(if: false, unless: false), b: double(if: true, unless: true) })
@@ -23,17 +15,9 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
     end
   end
 
-  describe "#document_show_fields" do
-    it "passes through the configuration" do
-      allow(Deprecation).to receive(:warn)
-      allow(blacklight_config).to receive_messages(show_fields: config_value)
-      expect(helper.document_show_fields).to eq config_value
-    end
-  end
-
   describe "#default_document_index_view_type" do
     it "uses the first view with default set to true" do
-      blacklight_config.view.a({})
+      blacklight_config.view.a
       blacklight_config.view.b(default: true)
       expect(helper.default_document_index_view_type).to eq :b
     end
@@ -71,62 +55,6 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
     end
   end
 
-  describe "#has_alternative_views?" do
-    subject { helper.has_alternative_views? }
-
-    before do
-      blacklight_config.view.clear
-    end
-
-    describe "with a single view defined" do
-      it { is_expected.to be false }
-    end
-
-    describe "with multiple views defined" do
-      before do
-        blacklight_config.view.abc
-        blacklight_config.view.xyz
-      end
-
-      it { is_expected.to be true }
-    end
-  end
-
-  describe "#spell_check_max" do
-    it "passes through the configuration" do
-      allow(blacklight_config).to receive_messages(spell_max: config_value)
-      expect(helper.spell_check_max).to eq config_value
-    end
-  end
-
-  describe "#document_show_link_field" do
-    let(:document) { SolrDocument.new id: 123, a: 1, b: 2, c: 3 }
-
-    before do
-      allow(Deprecation).to receive(:warn)
-    end
-
-    it "allows single values" do
-      blacklight_config.index.title_field = :a
-      f = helper.document_show_link_field document
-      expect(f).to eq :a
-    end
-
-    it "retrieves the first field with data" do
-      blacklight_config.index.title_field = [:zzz, :b]
-      f = helper.document_show_link_field document
-      expect(f).to eq :b
-    end
-  end
-
-  describe "#view_label" do
-    it "looks up the label to display for the view" do
-      allow(blacklight_config).to receive(:view).and_return("my_view" => double(display_label: "some label"))
-
-      helper.view_label "my_view"
-    end
-  end
-
   describe "#field_label" do
     it "looks up the label as an i18n string" do
       expect(helper).to receive(:t).with(:some_key, default: []).and_return "my label"
@@ -148,32 +76,6 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
     end
   end
 
-  describe "#default_per_page" do
-    before do
-      expect(Deprecation).to receive(:warn)
-    end
-
-    context "when default_per_page is configured" do
-      before do
-        blacklight_config.default_per_page = 42
-      end
-
-      it "is the configured value" do
-        expect(helper.default_per_page).to eq 42
-      end
-    end
-
-    context "when default_per_page is not configured" do
-      before do
-        blacklight_config.per_page = [11, 22]
-      end
-
-      it "is the first per-page value if a default isn't set" do
-        expect(helper.default_per_page).to eq 11
-      end
-    end
-  end
-
   describe "#default_sort_field" do
     it "is the configured default field" do
       allow(helper).to receive_messages(blacklight_config: double(sort_fields: { a: double(default: nil), b: double(key: 'b', default: true) }))
@@ -203,11 +105,6 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
   describe "#should_render_field?" do
     let(:field_config) { double('field config', if: true, unless: false) }
 
-    before do
-      allow(Deprecation).to receive(:warn)
-      allow(helper).to receive_messages(document_has_value?: true)
-    end
-
     it "is true" do
       expect(helper.should_render_field?(field_config)).to be true
     end
@@ -223,39 +120,6 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
     end
   end
 
-  describe "#search_field_options_for_select" do
-    before do
-      @config = Blacklight::Configuration.new do |config|
-        config.default_solr_params = { qt: 'search' }
-
-        config.add_search_field 'all_fields', label: 'All Fields'
-        config.add_search_field 'title', qt: 'title_search'
-        config.add_search_field 'author', qt: 'author_search'
-        config.add_search_field 'subject', qt: 'subject_search'
-        config.add_search_field 'no_display', qt: 'something', include_in_simple_select: false
-      end
-
-      allow(helper).to receive_messages(blacklight_config: @config)
-    end
-
-    it "returns proper options_for_select arguments" do
-      select_arguments = helper.search_field_options_for_select
-
-      select_arguments.each do |(label, key)|
-        config_hash = @config.search_fields[key]
-
-        expect(label).to eq config_hash.label
-        expect(key).to eq config_hash.key
-      end
-    end
-
-    it "does not include fields in select if :display_in_simple_search=>false" do
-      select_arguments = helper.search_field_options_for_select
-
-      expect(select_arguments).not_to include(["No Display", "no_display"])
-    end
-  end
-
   context 'labels' do
     let(:field_config) { { 'my-key' => double('field', display_label: 'My Field') } }
 
@@ -275,7 +139,7 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
       end
 
       it 'handles a missing field' do
-        expect(helper.label_for_search_field(nil)).to eq nil
+        expect(helper.label_for_search_field(nil)).to be_nil
       end
     end