blacklight 7.33.0 → 7.34.0

data/spec/components/blacklight/document_component_spec.rb

@@ -74,6 +74,10 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
   end
 
   context 'index view' do
+    before do
+      controller.action_name = "index"
+    end
+
     let(:attr) { { counter: 5 } }
 
     it 'has data properties' do
@@ -92,9 +96,12 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     end
 
     context 'with a document rendered as part of a collection' do
-      let(:attr) { { document_counter: 10, counter_offset: 100 } }
+      # ViewComponent 3 changes iteration counters to begin at 0 rather than 1
+      let(:document_counter) { ViewComponent::VERSION::MAJOR < 3 ? 11 : 10 }
+      let(:attr) { { document_counter: document_counter, counter_offset: 100 } }
 
       it 'renders a counter with the title' do
+        # after ViewComponent 2.5, collection counter params are 1-indexed
         expect(rendered).to have_selector 'header', text: '111. Title'
       end
     end
@@ -106,13 +113,22 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     it 'renders a thumbnail' do
       expect(rendered).to have_selector 'a[href="/catalog/x"] img[src="http://example.com/image.jpg"]'
     end
+
+    context 'with default metadata component' do
+      it 'renders metadata' do
+        expect(rendered).to have_selector 'dl.document-metadata'
+        expect(rendered).to have_selector 'dt', text: 'Title:'
+        expect(rendered).to have_selector 'dd', text: 'Title'
+        expect(rendered).not_to have_selector 'dt', text: 'ISBN:'
+      end
+    end
   end
 
   context 'show view' do
     let(:attr) { { title_component: :h1, show: true } }
 
     before do
-      allow(view_context).to receive(:action_name).and_return('show')
+      controller.action_name = "show"
     end
 
     it 'renders with an id' do
@@ -143,13 +159,46 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       blacklight_config.show.embed_component = StubComponent
       expect(rendered).to have_content 'embed'
     end
-  end
 
-  it 'renders metadata' do
-    expect(rendered).to have_selector 'dl.document-metadata'
-    expect(rendered).to have_selector 'dt', text: 'Title:'
-    expect(rendered).to have_selector 'dd', text: 'Title'
-    expect(rendered).not_to have_selector 'dt', text: 'ISBN:'
+    context 'with configured metadata component' do
+      let(:custom_component_class) do
+        Class.new(Blacklight::DocumentMetadataComponent) do
+          # Override component rendering with our own value
+          def call
+            'blah'
+          end
+        end
+      end
+
+      before do
+        stub_const('MyMetadataComponent', custom_component_class)
+        blacklight_config.show.metadata_component = MyMetadataComponent
+      end
+
+      it 'renders custom component' do
+        expect(rendered).to have_text 'blah'
+      end
+    end
+
+    context 'with configured title component' do
+      let(:custom_component_class) do
+        Class.new(Blacklight::DocumentTitleComponent) do
+          # Override component rendering with our own value
+          def call
+            'Titleriffic'
+          end
+        end
+      end
+
+      before do
+        stub_const('MyTitleComponent', custom_component_class)
+        blacklight_config.show.title_component = MyTitleComponent
+      end
+
+      it 'renders custom component' do
+        expect(rendered).to have_text 'Titleriffic'
+      end
+    end
   end
 
   context 'with a thumbnail component' do
@@ -167,11 +216,11 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     end
   end
 
-  context 'with before_title' do
+  context 'with before_titles' do
     let(:render) do
       component.render_in(view_context) do
-        component.title do |c|
-          c.before_title { 'Prefix!' }
+        component.with_title do |c|
+          c.with_before_title { 'Prefix!' }
         end
       end
     end

data/spec/components/blacklight/facet_item_pivot_component_spec.rb

@@ -33,13 +33,14 @@ RSpec.describe Blacklight::FacetItemPivotComponent, type: :component do
 
   it 'links to the facet and shows the number of hits' do
     expect(rendered).to have_selector 'li'
-    expect(rendered).to have_link 'x', href: '/catalog?f%5Bz%5D=x'
+    expect(rendered).to have_link 'x', href: nokogiri_mediated_href(facet_item.href)
     expect(rendered).to have_selector '.facet-count', text: '10'
   end
 
   it 'has the facet hierarchy' do
+    pending
     expect(rendered).to have_selector 'li ul.pivot-facet'
-    expect(rendered).to have_link 'x:1', href: /f%5Bz%5D%5B%5D=x%3A1/
+    expect(rendered).to have_link 'x:1', href: nokogiri_mediated_href(facet_item.facet_item_presenters.first.href)
   end
 
   context 'with a selected facet' do

data/spec/components/blacklight/header_component_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::HeaderComponent, type: :component do
+  before do
+    with_controller_class(CatalogController) do
+      allow(controller).to receive(:current_user).and_return(nil)
+      allow(controller).to receive(:search_action_url).and_return('/search')
+      render
+    end
+  end
+
+  context 'with no slots' do
+    let(:render) { render_inline(described_class.new(blacklight_config: CatalogController.blacklight_config)) }
+
+    it 'draws the topbar' do
+      expect(page).to have_css 'nav.topbar'
+      expect(page).to have_link 'Blacklight', href: '/'
+    end
+  end
+end

data/spec/components/blacklight/search_bar_component_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe Blacklight::SearchBarComponent, type: :component do
   context 'when a button is passed in' do
     subject(:render) do
       render_inline(instance) do |c|
-        c.search_button do
+        c.with_search_button do
           controller.view_context.tag.button "hello", id: 'custom_search'
         end
       end

data/spec/controllers/blacklight/base_spec.rb

@@ -3,7 +3,7 @@
 RSpec.describe Blacklight::Base do
   subject { controller }
 
-  let(:controller) { (Class.new(ApplicationController) { include Blacklight::Base }).new }
+  let(:controller) { Deprecation.silence(described_class) { (Class.new(ApplicationController) { include Blacklight::Base }).new } }
 
   describe "#search_state" do
     subject { controller.send(:search_state) }

data/spec/controllers/catalog_controller_spec.rb

@@ -535,6 +535,10 @@ RSpec.describe CatalogController, api: true do
         post :email, xhr: true, params: { id: doc_id, to: 'test_email@projectblacklight.org' }
         expect(request).to render_template 'email_success'
         expect(request.flash[:success]).to eq "Email Sent"
+        allow(search_service).to receive(:search_results)
+        # When we go to another page, the flash message should no longer display
+        get :index
+        expect(request.flash[:success]).to be_nil
       end
     end
 
@@ -589,6 +593,10 @@ RSpec.describe CatalogController, api: true do
         post :sms, xhr: true, params: { id: doc_id, to: '5555555555', carrier: 'txt.att.net' }
         expect(request).to render_template 'sms_success'
         expect(request.flash[:success]).to eq "SMS Sent"
+        allow(search_service).to receive(:search_results)
+        # When we go to another page, the flash message should no longer display
+        get :index
+        expect(request.flash[:success]).to be_nil
       end
     end
   end

data/spec/features/advanced_search_spec.rb

@@ -5,9 +5,28 @@ require 'spec_helper'
 RSpec.describe "Blacklight Advanced Search Form" do
   describe "advanced search form" do
     before do
+      CatalogController.blacklight_config.search_fields['all_fields']['clause_params'] = {
+        edismax: {}
+      }
+      CatalogController.blacklight_config.search_fields['author']['clause_params'] = {
+        edismax: { qf: '${author_qf}' }
+      }
+      CatalogController.blacklight_config.search_fields['title']['clause_params'] = {
+        edismax: { qf: '${title_qf}' }
+      }
+      CatalogController.blacklight_config.search_fields['subject']['clause_params'] = {
+        edismax: { qf: '${subject_qf}' }
+      }
+      CatalogController.blacklight_config.json_solr_path = 'advanced'
       visit '/catalog/advanced?hypothetical_existing_param=true&q=ignore+this+existing+query'
     end
 
+    after do
+      %w[all_fields author title subject].each do |field|
+        CatalogController.blacklight_config.search_fields[field].delete(:clause_params)
+      end
+    end
+
     it "has field and facet blocks" do
       expect(page).to have_selector('.query-criteria')
       expect(page).to have_selector('.limit-criteria')
@@ -45,6 +64,43 @@ RSpec.describe "Blacklight Advanced Search Form" do
       click_on 'advanced-search-submit'
       expect(page).to have_content 'Remove constraint Title: Medicine'
       expect(page).to have_content 'Strong Medicine speaks'
+      expect(page).to have_selector('article.document', count: 1)
+    end
+
+    it 'can limit to facets' do
+      fill_in 'Subject', with: 'Women'
+      click_on 'Language'
+      check 'Urdu 3'
+      click_on 'advanced-search-submit'
+      expect(page).to have_content 'Pākistānī ʻaurat dorāhe par'
+      expect(page).not_to have_content 'Ajikto kŭrŏk chŏrŏk sasimnikka : and 아직도　그럭　저럭　사십니까'
+      expect(page).to have_selector('article.document', count: 1)
+    end
+
+    it 'handles boolean queries' do
+      fill_in 'All Fields', with: 'history NOT strong'
+      click_on 'advanced-search-submit'
+      expect(page).to have_content('Ci an zhou bian')
+      expect(page).not_to have_content('Strong Medicine speaks')
+      expect(page).to have_selector('article.document', count: 10)
+    end
+
+    it 'handles queries in multiple fields with the ALL operator' do
+      fill_in 'All Fields', with: 'history'
+      fill_in 'Author', with: 'hearth'
+      click_on 'advanced-search-submit'
+      expect(page).to have_content('Strong Medicine speaks')
+      expect(page).to have_selector('article.document', count: 1)
+    end
+
+    it 'handles queries in multiple fields with the ANY operator' do
+      select 'any', from: 'op'
+      fill_in 'All Fields', with: 'history'
+      fill_in 'Subject', with: 'women'
+      click_on 'advanced-search-submit'
+      expect(page).to have_content('Ci an zhou bian')
+      expect(page).to have_content('Pākistānī ʻaurat dorāhe par')
+      expect(page).to have_selector('article.document', count: 10)
     end
   end
 

data/spec/features/axe_spec.rb

@@ -21,6 +21,11 @@ RSpec.describe 'Accessibility testing', api: false, js: true do
     expect(page).to be_accessible
   end
 
+  it 'validates the advanced search form' do
+    visit advanced_search_catalog_path
+    expect(page).to be_accessible.excluding('.search-query-form')
+  end
+
   it 'validates the single results page' do
     visit solr_document_path('2007020969')
     expect(page).to be_accessible

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/search_history_constraints_helper_behavior_spec.rb

@@ -25,8 +25,8 @@ RSpec.describe Blacklight::SearchHistoryConstraintsHelperBehavior do
       it "renders basic element" do
         response = helper.render_search_to_s_element("key", "value")
         expect(response).to have_selector("span.constraint") do |span|
-          expect(span).to have_selector("span.filter-name", content: "key:")
-          expect(span).to have_selector("span.filter-value", content: "value")
+          expect(span).to have_selector("span.filter-name", text: "key:")
+          expect(span).to have_selector("span.filter-values", text: "value")
         end
         expect(response).to be_html_safe
       end
@@ -34,24 +34,17 @@ RSpec.describe Blacklight::SearchHistoryConstraintsHelperBehavior do
       it "escapes them that need escaping" do
         response = helper.render_search_to_s_element("key>", "value>")
         expect(response).to have_selector("span.constraint") do |span|
-          expect(span).to have_selector("span.filter-name") do |s2|
-            # Note: nokogiri's gettext will unescape the inner html
-            # which seems to be what rspecs "contains" method calls on
-            # text nodes - thus the to_s inserted below.
-            expect(s2).to match(/key>:/)
-          end
-          expect(span).to have_selector("span.filter-value") do |s3|
-            expect(s3).to match(/value>/)
-          end
+          expect(span).to have_selector("span.filter-name", text: 'key>:')
+          expect(span).to have_selector("span.filter-values", text: 'value>')
         end
         expect(response).to be_html_safe
       end
 
-      it "does not escape with options set thus" do
-        response = helper.render_search_to_s_element("key>", "value>", escape_key: false, escape_value: false)
+      xit "does not escape with options set thus" do
+        response = helper.render_search_to_s_element("<key>", "value>", escape_key: false, escape_value: false)
         expect(response).to have_selector("span.constraint") do |span|
-          expect(span).to have_selector("span.filter-name", content: "key>:")
-          expect(span).to have_selector("span.filter-value", content: "value>")
+          expect(span).to have_selector("span.filter-name", text: "key>:")
+          expect(span).to have_selector("span.filter-values", text: "value>")
         end
         expect(response).to be_html_safe
       end

data/spec/models/blacklight/configuration_spec.rb

@@ -723,4 +723,26 @@ RSpec.describe "Blacklight::Configuration", api: true do
       expect { config.view.a = '123' }.to raise_error(FrozenError)
     end
   end
+
+  describe '.default_configuration' do
+    it 'adds additional default configuration properties' do
+      Blacklight::Configuration.default_configuration do
+        Blacklight::Configuration.default_values[:a] = '123'
+      end
+
+      Blacklight::Configuration.default_configuration do
+        Blacklight::Configuration.default_values[:b] = 'abc'
+      end
+
+      expect(Blacklight::Configuration.default_values[:a]).to eq '123'
+      expect(Blacklight::Configuration.default_values[:b]).to eq 'abc'
+    ensure
+      # reset the default configuration
+      Blacklight::Configuration.default_values.delete(:a)
+      Blacklight::Configuration.default_values.delete(:b)
+
+      Blacklight::Configuration.default_configuration.delete_at(1)
+      Blacklight::Configuration.default_configuration.delete_at(2)
+    end
+  end
 end

data/spec/models/blacklight/solr/repository_spec.rb

@@ -153,6 +153,33 @@ RSpec.describe Blacklight::Solr::Repository, api: true do
         expect(JSON.parse(actual_params[:data]).with_indifferent_access).to include(query: { bool: {} })
         expect(actual_params[:headers]).to include({ 'Content-Type' => 'application/json' })
       end
+
+      context "without a json solr path configured" do
+        before do
+          blacklight_config.json_solr_path = nil
+        end
+
+        it "uses the default solr path" do
+          blacklight_config.solr_path = 'xyz'
+          allow(subject.connection).to receive(:send_and_receive) do |path|
+            expect(path).to eq 'xyz'
+          end
+          subject.search(input_params)
+        end
+      end
+
+      context "with a json solr path configured" do
+        before do
+          blacklight_config.json_solr_path = 'my-great-json'
+        end
+
+        it "uses the configured json_solr_path" do
+          allow(subject.connection).to receive(:send_and_receive) do |path|
+            expect(path).to eq 'my-great-json'
+          end
+          subject.search(input_params)
+        end
+      end
     end
   end
 

data/spec/models/blacklight/solr/search_builder_spec.rb

@@ -191,6 +191,14 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       end
     end
 
+    describe "for a missing string search" do
+      let(:user_params) { { q: nil } }
+
+      it "does not populate the q parameter in solr parameters" do
+        expect(subject).not_to have_key :q
+      end
+    end
+
     describe "for an empty string search" do
       let(:user_params) { { q: "" } }
 
@@ -398,6 +406,14 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       it 'includes addtional clause parameters for the field' do
         expect(subject.dig(:json, :query, :bool, :must, 0, :edismax)).to include another: :parameter
       end
+
+      context 'with an empty search' do
+        let(:subject_search_params) { { commit: "search", search_field: "subject", action: "index", controller: "catalog", rows: "10", q: nil } }
+
+        it 'does not add nil query value clauses to json query' do
+          expect(subject).not_to have_key :json
+        end
+      end
     end
 
     describe "overriding of qt parameter" do

data/spec/models/solr_document_spec.rb

@@ -45,9 +45,11 @@ RSpec.describe SolrDocument, api: true do
 
     let(:doc_class) do
       Class.new(SolrDocument) do
-        attribute :title, Blacklight::Types::String, 'title_tesim'
-        attribute :author, Blacklight::Types::Array, 'author_tesim'
-        attribute :date, Blacklight::Types::Date, 'date_dtsi'
+        attribute :title, :string, 'title_tesim'
+        attribute :author, :array, 'author_tesim', of: :string
+        attribute :first_author, :select, 'author_tesim', by: :min
+        attribute :date, :date, field: 'date_dtsi'
+        attribute :whatever, :string, default: ->(*) { 'default_value' }
       end
     end
     let(:document) do
@@ -60,7 +62,23 @@ RSpec.describe SolrDocument, api: true do
     it "casts the attributes" do
       expect(document.title).to eq 'Good Omens'
       expect(document.author).to eq ['Neil Gaiman', 'Terry Pratchett']
+      expect(document.first_author).to eq 'Neil Gaiman'
       expect(document.date).to eq Date.new(1990)
+      expect(document.whatever).to eq 'default_value'
+    end
+
+    context 'with missing data' do
+      let(:document) { doc_class.new(id: '123') }
+
+      it 'returns nil for scalar values' do
+        expect(document.title).to be_nil
+        expect(document.first_author).to be_nil
+        expect(document.date).to be_nil
+      end
+
+      it 'returns an array for array values' do
+        expect(document.author).to eq []
+      end
     end
   end
 end

data/spec/presenters/blacklight/show_presenter_spec.rb

@@ -52,10 +52,6 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
 
       MockDocument.use_extension(MockExtension)
 
-      def mock_document_app_helper_url *args
-        solr_document_url(*args)
-      end
-
       allow(request_context).to receive(:polymorphic_url) do |_, opts|
         "url.#{opts[:format]}"
       end
@@ -70,12 +66,10 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
         tmp_value = Capybara.ignore_hidden_elements
         Capybara.ignore_hidden_elements = false
         document.export_formats.each_pair do |format, _spec|
-          expect(subject).to have_selector("link[href$='.#{format}']") do |matches|
-            expect(matches).to have(1).match
-            tag = matches[0]
-            expect(tag.attributes["rel"].value).to eq "alternate"
-            expect(tag.attributes["title"].value).to eq format.to_s
-            expect(tag.attributes["href"].value).to eq mock_document_app_helper_url(document, format: format)
+          expect(subject).to have_selector("link[href$='.#{format}']", count: 1) do |tag|
+            expect(tag["rel"]).to eq "alternate"
+            expect(tag["title"]).to eq format.to_s
+            expect(tag["href"]).to eq "url.#{format}"
           end
         end
         Capybara.ignore_hidden_elements = tmp_value

data/spec/spec_helper.rb

@@ -16,7 +16,6 @@ EngineCart.load_application!
 require 'rspec/rails'
 require 'rspec/collection_matchers'
 require 'capybara/rails'
-require 'webdrivers'
 require 'selenium-webdriver'
 require 'equivalent-xml'
 require 'axe-rspec'
@@ -28,13 +27,13 @@ Capybara.javascript_driver = :headless_chrome
 
 Capybara.register_driver :headless_chrome do |app|
   Capybara::Selenium::Driver.load_selenium
-  capabilities = ::Selenium::WebDriver::Chrome::Options.new.tap do |opts|
+  options = ::Selenium::WebDriver::Chrome::Options.new.tap do |opts|
     opts.args << '--headless'
     opts.args << '--disable-gpu'
     opts.args << '--no-sandbox'
     opts.args << '--window-size=1280,1696'
   end
-  Capybara::Selenium::Driver.new(app, browser: :chrome, capabilities: capabilities)
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
 end
 
 # Requires supporting ruby files with custom matchers and macros, etc,
@@ -50,7 +49,7 @@ RSpec.configure do |config|
   config.filter_run api: true if ENV['BLACKLIGHT_API_TEST']
 
   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  config.fixture_path = Rails.root.join("spec/fixtures")
 
   # If you're not using ActiveRecord, or you'd prefer not to run each of your
   # examples within a transaction, remove the following line or assign false
@@ -67,7 +66,7 @@ RSpec.configure do |config|
   config.infer_spec_type_from_file_location!
   config.include PresenterTestHelpers, type: :presenter
   config.include ViewComponent::TestHelpers, type: :component
-  config.include ViewComponentCapybaraTestHelpers, type: :component
+  config.include ViewComponentTestHelpers, type: :component
 
   config.include(ControllerLevelHelpers, type: :helper)
   config.before(:each, type: :helper) { initialize_controller_helpers(helper) }

data/spec/support/view_component_test_helpers.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ViewComponentTestHelpers
+  # Work around for https://github.com/teamcapybara/capybara/issues/2466
+  def render_inline_to_capybara_node(component)
+    Capybara::Node::Simple.new(render_inline(component).to_s)
+  end
+
+  # Work-around for https://github.com/ViewComponent/view_component/pull/1661
+  # which made the component test's controller method (more) private. This makes
+  # it available so we can set up controller-level state for our tests.
+  def controller
+    # ViewComponent 2.x
+    return super if defined?(super)
+
+    # ViewComponent 3.x
+    return vc_test_controller if defined?(vc_test_controller)
+
+    ApplicationController.new.extend(Rails.application.routes.url_helpers)
+  end
+
+  # Nokogiri 1.15.0 upgrades the vendored libxml2 from v2.10.4 to v2.11.3
+  # libxml2 v2.11.0 introduces a change to parsing HTML href attributes
+  # in nokogiri < 1.15, brackets in href attributes are escaped:
+  # - <a class="facet-select" rel="nofollow" href="/catalog?f%5Bz%5D%5B%5D=x:1">x:1</a>
+  # in nokogiri >= 1.15, brackets in href attributes are not escaped:
+  # - <a class="facet-select" rel="nofollow" href="/catalog?f[z][]=x:1">x:1</a>
+  # until we can spec a minimum nokogiri version of 1.15.0, we need to see how
+  # the installed version parsed the html
+  def nokogiri_mediated_href(href)
+    start = "<a href=\"".length
+    stop = -"\"></a>".length
+    Nokogiri::HTML.fragment("<a href=\"#{href}\"></a>").to_s[start...stop]
+  end
+end