blacklight 9.0.0.beta7 → 9.0.0.beta8

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

@@ -98,73 +98,6 @@
     </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
-          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">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": "9.0.0-beta7",
+  "version": "9.0.0-beta8",
   "description": "The frontend code and styles for Blacklight",
   "exports": {
     "./blacklight.esm.js": "./app/assets/javascripts/blacklight/blacklight.esm.js",

data/spec/components/blacklight/document_component_spec.rb

@@ -136,13 +136,6 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       vc_test_controller.action_name = "show"
     end
 
-    it 'renders with an id' do
-      component.with_body { '-' }
-      render_inline component
-
-      expect(page).to have_css 'article#document'
-    end
-
     it 'renders a title' do
       render_inline component
 

data/spec/components/blacklight/facets/filters_component_spec.rb

@@ -3,10 +3,10 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::Facets::FiltersComponent, type: :component do
-  let(:facet_field) { Blacklight::Configuration::FacetField.new key: 'language_facet', suggest: true }
+  let(:facet_field) { Blacklight::Configuration::FacetField.new key: 'language_facet', suggest?: true }
   let(:presenter) do
     instance_double(Blacklight::FacetFieldPresenter, facet_field: facet_field, label: 'Lang',
-                                                     view_context: view_context, suggest: true, key: 'lang')
+                                                     view_context: view_context, suggest?: true, key: 'lang')
   end
   let(:view_context) { vc_test_controller.view_context }
 

data/spec/components/blacklight/facets/suggest_component_spec.rb

@@ -58,6 +58,7 @@ RSpec.describe Blacklight::Facets::SuggestComponent, type: :component do
 
   context 'when the facet is not explicitly configured with a suggest key' do
     let(:facet) { Blacklight::Configuration::FacetField.new key: 'language_facet' }
+    let(:presenter) { Blacklight::FacetFieldPresenter.new(facet, nil, vc_test_controller.view_context, nil) }
 
     it 'displays' do
       with_request_url "/catalog/facet/language_facet" do
@@ -65,5 +66,17 @@ RSpec.describe Blacklight::Facets::SuggestComponent, type: :component do
         expect(rendered.css("input.facet-suggest").count).to eq 1
       end
     end
+
+    context "with blacklight_config.default_facet_suggest = false" do
+      before do
+        allow(vc_test_controller.view_context.blacklight_config).to receive(:default_facet_suggest).and_return(false)
+      end
+
+      it 'does not display' do
+        with_request_url "/catalog/facet/language_facet" do
+          expect(render_inline(component).to_s).to eq ''
+        end
+      end
+    end
   end
 end

data/spec/components/blacklight/search_bar_component_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::SearchBarComponent, type: :component do
-  let(:instance) { described_class.new(url: search_action_url, params: params_for_search) }
+  let(:instance) { described_class.new(url: search_action_url, params: params_for_search, advanced_search_url: '/advanced') }
 
   let(:search_action_url) { '/catalog' }
   let(:params_for_search) { { q: 'testParamValue' } }
@@ -104,4 +104,27 @@ RSpec.describe Blacklight::SearchBarComponent, type: :component do
       expect(render.css('.rounded-0')).to be_present
     end
   end
+
+  context 'advanced search link' do
+    subject(:render) { render_inline(instance) }
+
+    context 'when enabled (default)' do
+      it 'renders the advanced search link' do
+        expect(render.css("a.advanced_search.btn.btn-link[href='/advanced']")).to be_present
+        expect(render.css("a.advanced_search").text).to eq('Advanced search')
+      end
+    end
+
+    context 'when disabled via configuration' do
+      let(:blacklight_config) do
+        Blacklight::Configuration.new.configure do |config|
+          config.advanced_search.enabled = false
+        end
+      end
+
+      it 'does not render the advanced search link' do
+        expect(render.css("a.advanced_search")).not_to be_present
+      end
+    end
+  end
 end

data/spec/controllers/blacklight/catalog_spec.rb

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

data/spec/features/advanced_search_spec.rb

@@ -5,25 +5,7 @@ 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
+      visit '/catalog/advanced'
     end
 
     it "has field and facet blocks" do
@@ -56,6 +38,16 @@ RSpec.describe "Blacklight Advanced Search Form" do
           expect(page).to have_content 'Language'
         end
       end
+
+      it "omits facets configured with include_in_advanced_search: false" do
+        expect(page).to have_no_css('.blacklight-example_pivot_field')
+      end
+
+      it "lists all the values for an included facet" do
+        within('.blacklight-subject_ssim') do
+          expect(page).to have_css('ul.facet-values li', count: 45)
+        end
+      end
     end
 
     it 'scopes searches to fields' do
@@ -66,6 +58,14 @@ RSpec.describe "Blacklight Advanced Search Form" do
       expect(page).to have_css('article.document', count: 1)
     end
 
+    it 'does not render spellcheck/did you mean? section' do
+      fill_in 'All Fields', with: 'tibet'
+      click_on 'advanced-search-submit'
+      expect(page).to have_content 'Remove constraint All Fields: tibet'
+      expect(page).to have_css('article.document', count: 2)
+      expect(page).to have_no_css('#spell')
+    end
+
     it 'can limit to facets' do
       fill_in 'Subject', with: 'Women'
       click_on 'Language'
@@ -107,7 +107,7 @@ RSpec.describe "Blacklight Advanced Search Form" do
 
   describe "prepopulated advanced search form" do
     before do
-      visit '/catalog/advanced?op=must&clause[1][field]=title&clause[1]query=medicine&f_inclusive[language_ssim][]=Tibetan&sort=author'
+      visit '/catalog/advanced?op=must&clause[1][field]=title&clause[1]query=medicine&f_inclusive[language_ssim][]=Tibetan&f[format][]=Book&sort=author'
     end
 
     it 'prepopulates the expected fields' do
@@ -117,6 +117,12 @@ RSpec.describe "Blacklight Advanced Search Form" do
       expect(page).to have_select 'sort', selected: 'author'
     end
 
+    it 'creates hidden inputs for fields not included in the advanced search form' do
+      within('form.advanced') do
+        expect(page).to have_field 'f[format][]', type: :hidden, with: 'Book'
+      end
+    end
+
     it "does not create hidden inputs for fields included in adv search form" do
       within('form.advanced') do
         expect(page).to have_no_field('clause[1][query]', type: :hidden, with: 'medicine')
@@ -140,5 +146,18 @@ RSpec.describe "Blacklight Advanced Search Form" do
       expect(page).to have_no_field 'Title', with: 'medicine'
       expect(page).to have_no_field 'Tibetan', checked: true
     end
+
+    it 'creates constraints for fields not included in advanced search form' do
+      within('div.constraints') do
+        expect(page).to have_content('Format:Book')
+      end
+    end
+
+    it 'does not create constraints for fields included in the advanced search form' do
+      within('div.constraints') do
+        expect(page).to have_no_content('Title:medicine')
+        expect(page).to have_no_content('Language:Tibetan')
+      end
+    end
   end
 end

data/spec/models/blacklight/configuration_spec.rb

@@ -735,4 +735,130 @@ RSpec.describe Blacklight::Configuration, :api do
       described_class.default_configuration.delete_at(2)
     end
   end
+
+  describe "#copy_search_field_config_to_advanced!" do
+    let(:config) { described_class.new }
+
+    before do
+      config.add_search_field('title',
+                              solr_parameters: {
+                                'spellcheck.dictionary': 'title',
+                                qf: '${title_qf}',
+                                pf: '${title_pf}'
+                              })
+      config.add_search_field('excluded_field',
+                              solr_parameters: { qf: '${excluded_qf}' },
+                              include_in_advanced_search: false)
+      config.add_search_field('already_configured',
+                              solr_parameters: { qf: '${configured_qf}' },
+                              clause_params: { edismax: { existing_custom: 'params' } })
+    end
+
+    it "copies solr_parameters to clause_params for eligible search fields" do
+      config.copy_search_field_config_to_advanced!
+
+      title_field = config.search_fields['title']
+      expect(title_field.clause_params).to be_present
+      expect(title_field.clause_params[:edismax]).to eq({ 'spellcheck.dictionary': 'title', qf: '${title_qf}', pf: '${title_pf}' })
+    end
+
+    it "skips fields with include_in_advanced_search set to false" do
+      config.copy_search_field_config_to_advanced!
+
+      excluded_field = config.search_fields['excluded_field']
+      expect(excluded_field.clause_params).to be_nil
+    end
+
+    it "skips fields that already have a clause_params config" do
+      config.copy_search_field_config_to_advanced!
+
+      already_configured_field = config.search_fields['already_configured']
+      expect(already_configured_field.clause_params).to eq({ edismax: { existing_custom: 'params' } })
+    end
+
+    it "handles fields with nil solr_parameters" do
+      config.add_search_field('no_solr_params')
+
+      expect { config.copy_search_field_config_to_advanced! }.not_to raise_error
+
+      field = config.search_fields['no_solr_params']
+      expect(field.clause_params).to be_present
+      expect(field.clause_params[:edismax]).to eq({})
+    end
+  end
+
+  describe "#copy_facet_field_config_to_advanced!" do
+    let(:config) { described_class.new }
+
+    before do
+      config.add_facet_field('format',
+                             field: 'format')
+      config.add_facet_field('subject_ssim')
+      config.add_facet_field('excluded_facet',
+                             field: 'excluded_field',
+                             include_in_advanced_search: false)
+      config.add_facet_field('query_facet',
+                             query: { 'recent' => { fq: 'pub_date_ssim:[2020 TO *]' } })
+      config.add_facet_field('pivot_facet',
+                             pivot: %w[author_ssim subject_ssim])
+      config.add_facet_field('range_facet',
+                             range: true,
+                             field: 'pub_date_ssim')
+    end
+
+    it "sets default facet.sort to 'count'" do
+      config.copy_facet_field_config_to_advanced!
+
+      expect(config.advanced_search.form_solr_parameters['facet.sort']).to eq 'count'
+    end
+
+    it "adds eligible facet fields to facet.field array" do
+      config.copy_facet_field_config_to_advanced!
+
+      facet_fields = config.advanced_search.form_solr_parameters['facet.field']
+      expect(facet_fields).to eq(%w[format subject_ssim])
+    end
+
+    it "skips fields with include_in_advanced_search set to false" do
+      config.copy_facet_field_config_to_advanced!
+
+      facet_fields = config.advanced_search.form_solr_parameters['facet.field']
+      expect(facet_fields).not_to include('excluded_field')
+    end
+
+    it "skips fields that are query, pivot, or range facets" do
+      config.copy_facet_field_config_to_advanced!
+
+      facet_fields = config.advanced_search.form_solr_parameters['facet.field']
+      expect(facet_fields).not_to include('query_facet', 'pivot_facet', 'range_facet')
+    end
+
+    it "sets facet limit to -1 to show all values for eligible fields" do
+      config.copy_facet_field_config_to_advanced!
+
+      expect(config.advanced_search.form_solr_parameters['f.format.facet.limit']).to eq(-1)
+      expect(config.advanced_search.form_solr_parameters['f.subject_ssim.facet.limit']).to eq(-1)
+    end
+
+    context "preserving existing advanced search config if present" do
+      before do
+        config.advanced_search.form_solr_parameters = {
+          'facet.sort' => 'index',
+          'f.subject_ssim.facet.limit' => 50
+        }
+      end
+
+      it "preserves existing facet.limit configuration if set" do
+        config.copy_facet_field_config_to_advanced!
+
+        expect(config.advanced_search.form_solr_parameters['f.subject_ssim.facet.limit']).to eq(50)
+      end
+
+      it "preserves existing default facet.sort configuration if set" do
+        config.copy_facet_field_config_to_advanced!
+
+        expect(config.advanced_search.form_solr_parameters['facet.sort']).to eq('index')
+      end
+    end
+  end
 end

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

@@ -87,6 +87,12 @@ RSpec.describe Blacklight::Solr::Repository, :api do
       expect(subject.search(params: {})).to be_a Blacklight::Solr::Response
     end
 
+    it "can be called with no args" do
+      blacklight_config.solr_path = 'xyz'
+      allow(subject.connection).to receive(:send_and_receive).with('xyz', anything).and_return(mock_response)
+      expect(subject.search).to be_a Blacklight::Solr::Response
+    end
+
     it "uses the default solr path" do
       allow(subject.connection).to receive(:send_and_receive).with('select', anything).and_return(mock_response)
       expect(subject.search(params: {})).to be_a Blacklight::Solr::Response

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

@@ -523,6 +523,58 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, :api do
     end
   end
 
+  describe "#add_facets_for_advanced_search_form" do
+    let(:solr_parameters) { Blacklight::Solr::Request.new }
+    let(:mock_controller) { instance_double(CatalogController, action_name: 'advanced_search') }
+    let(:mock_search_state) { instance_double(Blacklight::SearchState, controller: mock_controller) }
+
+    before do
+      allow(search_builder).to receive(:search_state).and_return(mock_search_state)
+    end
+
+    context "when action is advanced_search and form_solr_parameters are configured" do
+      before do
+        blacklight_config.advanced_search.enabled = true
+        blacklight_config.advanced_search.form_solr_parameters = {
+          'facet.sort' => 'count',
+          'facet.field' => %w[format subject_ssim],
+          'f.format.facet.limit' => -1,
+          'f.subject_ssim.facet.limit' => -1
+        }
+      end
+
+      it "merges advanced search form parameters into solr parameters" do
+        solr_parameters['existing.param'] = 'keep_me'
+        subject.add_facets_for_advanced_search_form(solr_parameters)
+
+        expect(solr_parameters['facet.sort']).to eq 'count'
+        expect(solr_parameters['facet.field']).to eq %w[format subject_ssim]
+        expect(solr_parameters['f.format.facet.limit']).to eq(-1)
+        expect(solr_parameters['f.subject_ssim.facet.limit']).to eq(-1)
+        expect(solr_parameters['existing.param']).to eq 'keep_me'
+      end
+    end
+
+    context "when action is not advanced_search" do
+      before do
+        allow(mock_controller).to receive(:action_name).and_return('index')
+        blacklight_config.advanced_search.enabled = true
+        blacklight_config.advanced_search.form_solr_parameters = {
+          'facet.sort' => 'count',
+          'facet.field' => ['format']
+        }
+      end
+
+      it "does not merge advanced search form parameters" do
+        solr_parameters['f.format.facet.limit'] = 21
+
+        subject.add_facets_for_advanced_search_form(solr_parameters)
+
+        expect(solr_parameters['f.format.facet.limit']).to eq 21
+      end
+    end
+  end
+
   describe "#add_facet_fq_to_solr" do
     it "converts a String fq into an Array" do
       solr_parameters = { fq: 'a string' }
@@ -677,12 +729,6 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, :api do
   end
 
   context 'with advanced search clause parameters' do
-    before do
-      blacklight_config.search_fields.each_value do |v|
-        v.clause_params = { edismax: v.solr_parameters.dup }
-      end
-    end
-
     let(:user_params) { { op: 'must', clause: { '0': { field: 'title', query: 'the book' }, '1': { field: 'author', query: 'the person' } } } }
 
     it "has proper solr parameters" do

data/spec/presenters/blacklight/document_presenter_spec.rb

@@ -29,13 +29,13 @@ RSpec.describe Blacklight::DocumentPresenter do
   end
 
   describe '#field_value' do
-    let(:field_presenter) { instance_double(Blacklight::FieldPresenter, render: 'xyz') }
+    let(:field_presenter) { instance_double(Blacklight::FieldPresenter, render: ['xyz']) }
     let(:field_config) { Blacklight::Configuration::DisplayField.new }
     let(:options) { { a: 1 } }
 
     it 'calls the field presenter' do
       allow(Blacklight::FieldPresenter).to receive(:new).with(request_context, doc, field_config, options).and_return(field_presenter)
-      expect(presenter.field_value(field_config, options)).to eq 'xyz'
+      expect(presenter.field_value(field_config, options)).to eq ['xyz']
     end
 
     it 'can be configured to use an alternate presenter' do
@@ -44,7 +44,7 @@ RSpec.describe Blacklight::DocumentPresenter do
       field_config.presenter = SomePresenter
       allow(SomePresenter).to receive(:new).and_return(instance)
 
-      expect(presenter.field_value(field_config, options)).to eq 'abc'
+      expect(presenter.field_value(field_config, options)).to eq ['abc']
     end
   end