blacklight 8.0.1 → 8.2.0

data/lib/generators/blacklight/templates/solr/conf/solrconfig.xml

@@ -100,6 +100,75 @@
     </arr>
   </requestHandler>
 
+  <requestHandler name="/advanced" class="solr.SearchHandler">
+    <!-- a lucene request handler for using the JSON Query DSL,
+         specifically for advanced search.
+         Using a separate requestHandler is a workaround to
+         https://issues.apache.org/jira/browse/SOLR-16916, although
+         it could be desirable for other reasons as well.
+      -->
+     <lst name="defaults">
+       <str name="defType">lucene</str>
+       <str name="echoParams">explicit</str>
+        <str name="df">title_tsim</str>
+        <str name="qf">
+          id
+          full_title_tsim
+          short_title_tsim
+          alternative_title_tsim
+          active_fedora_model_ssi
+          title_tsim
+          author_tsim
+          subject_tsim
+          all_text_timv
+        </str>
+        <str name="pf">
+          all_text_timv^10
+        </str>
+
+       <str name="author_qf">
+          author_tsim
+       </str>
+       <str name="author_pf">
+       </str>
+       <str name="title_qf">
+          title_tsim
+          full_title_tsim
+          short_title_tsim
+          alternative_title_tsim
+       </str>
+       <str name="title_pf">
+       </str>
+       <str name="subject_qf">
+          subject_tsim
+       </str>
+       <str name="subject_pf">
+       </str>
+
+       <str name="fl">
+         *,
+         score
+       </str>
+
+       <str name="facet">true</str>
+       <str name="facet.mincount">1</str>
+       <str name="facet.limit">10</str>
+       <str name="facet.field">active_fedora_model_ssi</str>
+       <str name="facet.field">subject_ssim</str>
+
+       <str name="spellcheck">true</str>
+       <str name="spellcheck.dictionary">default</str>
+       <str name="spellcheck.onlyMorePopular">true</str>
+       <str name="spellcheck.extendedResults">true</str>
+       <str name="spellcheck.collate">false</str>
+       <str name="spellcheck.count">5</str>
+
+     </lst>
+    <arr name="last-components">
+      <str>spellcheck</str>
+    </arr>
+  </requestHandler>
+
   <requestHandler name="permissions" class="solr.SearchHandler" >
     <lst name="defaults">
       <str name="facet">off</str>

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "8.0.1",
+  "version": "8.2.0",
   "description": "The frontend code and styles for Blacklight",
   "main": "app/assets/javascripts/blacklight",
   "module": "app/assets/javascripts/blacklight/blacklight.esm.js",

data/spec/components/blacklight/facet_component_spec.rb

@@ -45,8 +45,18 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
       Blacklight::Configuration::FacetField.new(key: 'field', partial: 'catalog/facet_partial').normalize!
     end
 
+    # Not sure why we need to re-implement rspec's stub_template, but
+    # we already were, and need a Rails 7.1+ safe alternate too
+    # https://github.com/rspec/rspec-rails/commit/4d65bea0619955acb15023b9c3f57a3a53183da8
+    # https://github.com/rspec/rspec-rails/issues/2696
     before do
-      controller.view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for('catalog/_facet_partial.html.erb' => 'facet partial'))
+      replace_hash = { 'catalog/_facet_partial.html.erb' => 'facet partial' }
+
+      if ::Rails.version.to_f >= 7.1
+        controller.prepend_view_path(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
+      else
+        controller.view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
+      end
     end
 
     it 'renders the partial' do

data/spec/components/blacklight/facet_item_pivot_component_spec.rb

@@ -35,13 +35,13 @@ 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
     expect(rendered).to have_selector 'li ul.pivot-facet'
-    expect(rendered).to have_link 'x:1', href: /f%5Bz%5D%5B%5D=x:1/
+    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/response/pagination_component_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::Response::PaginationComponent, type: :component do
+  let(:render) do
+    with_request_url '/catalog?q=foo' do
+      render_inline(instance)
+    end
+  end
+
+  let(:instance) { described_class.new(response: response) }
+
+  context 'when there are many results' do
+    let(:response) { instance_double(Blacklight::Solr::Response, total: 10, current_page: 5, limit_value: 10_000, total_pages: 100) }
+
+    context 'with default config' do
+      before { render }
+
+      it "has links to deep pages" do
+        expect(page).not_to have_link '98'
+        expect(page).to have_link '99'
+        expect(page).to have_link '100'
+        expect(page).not_to have_link '101'
+      end
+    end
+
+    context 'when a different configuration that removes deep links is passed as a parameter' do
+      let(:instance) { described_class.new(response: response, left: 5, right: 0, outer_window: nil) }
+
+      before { render }
+
+      it "does not link to deep pages" do
+        expect(page).to have_link '1'
+        expect(page).not_to have_link '100'
+      end
+    end
+
+    context 'when a different configuration that removes deep links is configured in the controller' do
+      before do
+        allow(controller.blacklight_config.index)
+          .to receive(:pagination_options)
+          .and_return(theme: 'blacklight', left: 5, right: 0)
+        render
+      end
+
+      it "does not link to deep pages" do
+        expect(page).to have_link '1'
+        expect(page).not_to have_link '100'
+      end
+    end
+  end
+end

data/spec/components/blacklight/search_context/server_applied_params_component_spec.rb

@@ -10,7 +10,17 @@ RSpec.describe Blacklight::SearchContext::ServerAppliedParamsComponent, type: :c
   let(:view_context) { controller.view_context }
 
   before do
-    view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for('application/_start_over.html.erb' => 'start over'))
+    # Not sure why we need to re-implement rspec's stub_template, but
+    # we already were, and need a Rails 7.1+ safe alternate too
+    # https://github.com/rspec/rspec-rails/commit/4d65bea0619955acb15023b9c3f57a3a53183da8
+    # https://github.com/rspec/rspec-rails/issues/2696
+    replace_hash = { 'application/_start_over.html.erb' => 'start over' }
+    if ::Rails.version.to_f >= 7.1
+      controller.prepend_view_path(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
+    else
+      view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
+    end
+
     allow(view_context).to receive(:current_search_session).and_return current_search_session
     allow(view_context).to receive(:link_back_to_catalog).with(any_args)
   end

data/spec/controllers/catalog_controller_spec.rb

@@ -54,7 +54,7 @@ RSpec.describe CatalogController, api: true do
       it "has no docs or facet values for query without results", integration: true do
         get :index, params: { q: 'sadfdsafasdfsadfsadfsadf' } # query for no results
         expect(assigns(:response).docs).to be_empty
-        assigns(:response).aggregations.each do |_key, facet|
+        assigns(:response).aggregations.each_value do |facet|
           expect(facet.items).to be_empty
         end
       end
@@ -815,7 +815,7 @@ end
 def assert_facets_have_values(aggregations)
   expect(aggregations).not_to be_empty
   # should have at least one value for each facet
-  aggregations.each do |_key, facet|
+  aggregations.each_value do |facet|
     expect(facet.items).to have_at_least(1).item
   end
 end

data/spec/features/advanced_search_spec.rb

@@ -5,9 +5,27 @@ 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}' }
+      }
       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 +63,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
 
@@ -63,5 +118,11 @@ RSpec.describe "Blacklight Advanced Search Form" do
       expect(page.current_url).to match(/bread/)
       expect(page.current_url).not_to match(/medicine/)
     end
+
+    it "clears the prepopulated fields when the Start Over button is pressed" do
+      expect(page).to have_field 'Title', with: 'medicine'
+      click_on 'Start over'
+      expect(page).not_to have_field 'Title', with: 'medicine'
+    end
   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
+  end
+
   it 'validates the single results page' do
     visit solr_document_path('2007020969')
     expect(page).to be_accessible

data/spec/features/citation_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+RSpec.describe 'Citation functionality' do
+  before { visit solr_document_path('2007020969') }
+
+  it 'displays the Cite modal with expected header' do
+    click_link 'Cite'
+    expect(find('div.modal-header')).to have_text 'Cite'
+  end
+end

data/spec/features/sms_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+RSpec.describe 'SMS functionality' do
+  before { visit solr_document_path('2007020969') }
+
+  it 'displays SMS modal with form' do
+    click_link 'SMS'
+    expect(find('div.modal-header')).to have_text 'SMS This'
+    fill_in 'Phone Number:', with: '555-555-5555'
+    select 'Verizon', from: 'Carrier'
+  end
+end

data/spec/helpers/blacklight_helper_spec.rb

@@ -185,12 +185,17 @@ RSpec.describe BlacklightHelper do
         blacklight_config.view.gallery(template: '/my/partial')
       end
 
-      def stub_template(hash)
-        view.view_paths.unshift(ActionView::FixtureResolver.new(hash))
-      end
-
       it 'renders that template' do
-        stub_template 'my/_partial.html.erb' => 'some content'
+        # Not sure why we need to re-implement rspec's stub_template, but
+        # we already were, and need a Rails 7.1+ safe alternate too
+        # https://github.com/rspec/rspec-rails/commit/4d65bea0619955acb15023b9c3f57a3a53183da8
+        # https://github.com/rspec/rspec-rails/issues/2696
+        replace_hash = { 'my/_partial.html.erb' => 'some content' }
+        if ::Rails.version.to_f >= 7.1
+          controller.prepend_view_path(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
+        else
+          view.view_paths.unshift(ActionView::FixtureResolver.new(replace_hash))
+        end
 
         response = helper.render_document_index_with_view :gallery, [obj1, obj1]
 

data/spec/models/blacklight/configurable_spec.rb

@@ -93,7 +93,7 @@ RSpec.describe "Blacklight::Configurable", api: true do
       instance.blacklight_config.bar << "123"
       expect(instance.blacklight_config).not_to eq klass.blacklight_config
       expect(klass.blacklight_config.foo).to eq "bar"
-      expect(instance.blacklight_config.foo).to eq  "bar"
+      expect(instance.blacklight_config.foo).to eq "bar"
       expect(klass.blacklight_config.bar).not_to include("123")
       expect(instance.blacklight_config.bar).to include("asd", "123")
     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/response_spec.rb

@@ -48,7 +48,7 @@ RSpec.describe Blacklight::Solr::Response, api: true do
 
     expect(received).to eq expected
 
-    r.aggregations.each do |_key, facet|
+    r.aggregations.each_value do |facet|
       expect(facet).to respond_to :name
       expect(facet).to respond_to :sort
       expect(facet).to respond_to :offset

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

@@ -335,6 +335,7 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
           qf: '$subject_qf',
           pf: '$subject_pf'
         }
+        blacklight_config.search_fields['subject'].clause_params = nil
       end
 
       it "looks up qt from field definition" do
@@ -374,6 +375,18 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
         expect(key_value_pairs).to include("pf=$subject_pf")
         expect(key_value_pairs).to include("qf=$subject_qf")
       end
+
+      context 'when subject field uses JSON query DSL' do
+        before do
+          blacklight_config.search_fields['subject'].clause_params = {
+            edismax: {}
+          }
+        end
+
+        it "includes spellcheck.q, without LocalParams" do
+          expect(subject["spellcheck.q"]).to eq "wome"
+        end
+      end
     end
 
     describe "solr json query parameters from the fielded search" do
@@ -406,6 +419,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 "sorting" do

data/spec/models/solr_document_spec.rb

@@ -49,6 +49,7 @@ RSpec.describe SolrDocument, api: true do
         attribute :author, :array, 'author_tesim', of: :string
         attribute :first_author, :select, 'author_tesim', by: :min
         attribute :date, :date, field: 'date_dtsi'
+        attribute :time, :time, field: 'date_dtsi'
         attribute :whatever, :string, default: ->(*) { 'default_value' }
       end
     end
@@ -56,14 +57,17 @@ RSpec.describe SolrDocument, api: true do
       doc_class.new(id: '123',
                     title_tesim: ['Good Omens'],
                     author_tesim: ['Neil Gaiman', 'Terry Pratchett'],
-                    date_dtsi: '1990-01-01T00:00:00Z')
+                    date_dtsi: '1990-01-01T17:23:13Z')
     end
 
     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.date).to be_a Date
+      expect(document.date.to_s).to eq '1990-01-01'
+      expect(document.time).to be_a Time
+      expect(document.time.to_s).to eq '1990-01-01 17:23:13 UTC'
       expect(document.whatever).to eq 'default_value'
     end
 

data/spec/services/blacklight/field_retriever_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::FieldRetriever, api: true do
+  let(:service) { described_class.new(document, blacklight_field_config) }
+
+  let(:blacklight_field_config) { Blacklight::Configuration::Field.new(field: 'author_field', highlight: true) }
+  let(:document) { SolrDocument.new({ 'id' => 'doc1', 'title_field' => 'doc1 title', 'author_field' => 'author_someone' }, 'highlighting' => { 'doc1' => { 'title_tsimext' => ['doc <em>1</em>'] } }) }
+  let(:view_context) { {} }
+
+  context "highlighting" do
+    describe '#fetch' do
+      it "retrieves an author even if it's not highlighted" do
+        expect(service.fetch).to eq(['author_someone'])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -17,7 +17,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'
@@ -35,7 +34,7 @@ Capybara.register_driver :headless_chrome do |app|
     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: capabilities)
 end
 
 # Requires supporting ruby files with custom matchers and macros, etc,

data/spec/support/view_component_test_helpers.rb

@@ -18,4 +18,18 @@ module ViewComponentTestHelpers
 
     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

data/spec/test_app_templates/Gemfile.extra

@@ -1,5 +1,4 @@
 gem 'rails-controller-testing'
-gem 'thor', '~> 0.20' if /^5.[12]/.match?(ENV['RAILS_VERSION'])
 
 unless ENV['VIEW_COMPONENT_VERSION'].to_s == ""
   gem 'view_component', ENV.fetch('VIEW_COMPONENT_VERSION')

data/spec/views/catalog/_paginate_compact.html.erb_spec.rb

@@ -2,9 +2,11 @@
 
 RSpec.describe "catalog/_paginate_compact.html.erb" do
   let(:user) { User.new { |u| u.save(validate: false) } }
+  let(:blacklight_config) { Blacklight::Configuration.new }
 
   before do
     controller.request.path_parameters[:action] = 'index'
+    allow(controller).to receive(:blacklight_config).and_return(blacklight_config)
   end
 
   it "renders paginatable arrays" do

data/template.demo.rb

@@ -2,12 +2,12 @@
 
 gem 'blacklight', '>= 7.0'
 
-run "bundle install"
+after_bundle do
+  # run the blacklight install generator
+  options = ENV.fetch("BLACKLIGHT_INSTALL_OPTIONS", '--devise --marc')
 
-# run the blacklight install generator
-options = ENV.fetch("BLACKLIGHT_INSTALL_OPTIONS", '--devise --marc')
+  generate 'blacklight:install', options
 
-generate 'blacklight:install', options
-
-# run the database migrations
-rake "db:migrate"
+  # run the database migrations
+  rake "db:migrate"
+end