blacklight 9.0.0.beta6 → 9.0.0.beta8

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -10,7 +10,7 @@ module Blacklight::Solr
         :add_query_to_solr, :add_facet_fq_to_solr,
         :add_facetting_to_solr, :add_solr_fields_to_query, :add_paging_to_solr,
         :add_sorting_to_solr, :add_group_config_to_solr,
-        :add_adv_search_clauses,
+        :add_adv_search_clauses, :add_facets_for_advanced_search_form,
         :add_additional_filters
       ]
     end
@@ -95,6 +95,13 @@ module Blacklight::Solr
     def add_adv_search_clauses(solr_parameters)
       return if search_state.clause_params.blank?
 
+      # We need to specify lucene as the top-level defType when using JSON Query DSL in Solr versions
+      # between 7.2.0 & 9.4.0. After 9.4.0 this is no longer necessary, but also not harmful to include.
+      solr_parameters[:defType] = 'lucene'
+
+      # Disable spellcheck, which doesn't work when using JSON Query DSL
+      solr_parameters[:spellcheck] = 'false'
+
       defaults = { must: [], must_not: [], should: [] }
       default_op = blacklight_params[:op]&.to_sym || :must
       solr_parameters[:mm] = 1 if default_op == :should && search_state.clause_params.values.any? { |clause| }
@@ -117,6 +124,16 @@ module Blacklight::Solr
       [op, field.clause_params.transform_values { |v| v.merge(query: clause[:query]) }]
     end
 
+    # Merge the advanced search form parameters into the solr parameters
+    # @param [Hash] solr_parameters the current solr parameters
+    # @return [Hash] the solr parameters with the additional advanced search form parameters
+    def add_facets_for_advanced_search_form(solr_parameters)
+      return unless search_state.controller&.action_name == 'advanced_search' &&
+                    blacklight_config.advanced_search[:form_solr_parameters]
+
+      solr_parameters.merge!(blacklight_config.advanced_search[:form_solr_parameters])
+    end
+
     ##
     # Add any existing facet limits, stored in app-level HTTP query
     # as :f, to solr as appropriate :fq query.
@@ -243,7 +260,7 @@ module Blacklight::Solr
 
     # Look up facet limit for given facet_field. Will look at config, and
     # if config is 'true' will look up from Solr @response if available. If
-    # no limit is avaialble, returns nil. Used from #add_facetting_to_solr
+    # no limit is available, returns nil. Used from #add_facetting_to_solr
     # to supply f.fieldname.facet.limit values in solr request (no @response
     # available), and used in display (with @response available) to create
     # a facet paginator with the right limit.

data/lib/blacklight/solr/single_doc_search_builder.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Blacklight::Solr
+  class SingleDocSearchBuilder < SearchBuilder
+    self.default_processor_chain = [:add_defaults, :add_qt, :add_unique_id]
+
+    def initialize(scope, id, other_params)
+      @other_params = other_params
+      @id = id
+      super(scope)
+    end
+
+    def add_defaults(request)
+      request.reverse_merge!(blacklight_config.default_document_solr_params).reverse_merge!(@other_params)
+    end
+
+    def add_qt(request)
+      request[:qt] ||= blacklight_config.document_solr_request_handler if blacklight_config.document_solr_request_handler
+    end
+
+    def add_unique_id(request)
+      request[blacklight_config.document_unique_id_param] = @id
+    end
+  end
+end

data/lib/generators/blacklight/templates/.solr_wrapper.yml

@@ -3,5 +3,5 @@
 env:
   SOLR_MODULES: analysis-extras
 collection:
-  dir: solr/conf/
+  dir: solr/
   name: blacklight-core

data/lib/generators/blacklight/templates/catalog_controller.rb

@@ -29,6 +29,13 @@ class <%= controller_name.classify %>Controller < ApplicationController
     #
     ## Should the raw solr document endpoint (e.g. /catalog/:id/raw) be enabled
     # config.raw_endpoint.enabled = false
+    #
+    ## Should advanced search be enabled
+    # config.advanced_search.enabled = true
+    #
+    ## Optional fine-tuning for advanced search, e.g., set different limits for
+    ## different facets.
+    # config.advanced_search.form_solr_parameters = {}
 
     ## Default parameters to send to solr for all search-like requests. See also SearchBuilder#processed_parameters
     config.default_solr_params = {
@@ -38,7 +45,7 @@ class <%= controller_name.classify %>Controller < ApplicationController
     # solr path which will be added to solr base url before the other solr params.
     #config.solr_path = 'select'
     #config.document_solr_path = 'get'
-    #config.json_solr_path = 'advanced'
+    #config.json_solr_path = 'select'
 
     # items to show per page, each number in the array represent another option to choose from.
     #config.per_page = [10,20,50,100]
@@ -105,6 +112,12 @@ class <%= controller_name.classify %>Controller < ApplicationController
     # :show may be set to false if you don't want the facet to be drawn in the
     # facet bar
     #
+    # Set :include_in_advanced_search to false for any search field or facet field
+    # that you want to exclude from appearing in the advanced search page.
+    #
+    # Set :include_in_simple_select to false for any search field you want to render
+    # in the Advanced Search page but exclude from the main search box scope selector.
+    #
     # Set :index_range to true if you want the facet pagination view to have facet prefix-based navigation.
     #  (useful when user clicks "more" on a large facet and wants to navigate alphabetically across a large set of results)
     # :index_range can be an array or range of prefixes that will be used to create the navigation (note: It is case sensitive when searching values)
@@ -121,7 +134,9 @@ class <%= controller_name.classify %>Controller < ApplicationController
 
     config.add_facet_field 'example_pivot_field',
                            label: 'Pivot Field',
-                           pivot: ['language_ssim', 'subject_geo_ssim', 'subject_ssim'], collapsing: true
+                           pivot: ['language_ssim', 'subject_geo_ssim', 'subject_ssim'],
+                           collapsing: true,
+                           include_in_advanced_search: false
 
     config.add_facet_field 'example_query_facet_field', label: 'Publish Date', :query => {
        :years_5 => { label: 'within 5 Years', fq: "pub_date_ssim:[#{Time.zone.now.year - 5 } TO *]" },
@@ -165,7 +180,7 @@ class <%= controller_name.classify %>Controller < ApplicationController
     config.add_show_field 'isbn_ssim', label: 'ISBN'
 
     # "fielded" search configuration. Used by pulldown among other places.
-    # For supported keys in hash, see rdoc for Blacklight::SearchFields
+    # For supported keys in hash, see rdoc for Blacklight::Configuration::SearchField
     #
     # Search fields will inherit the :qt solr request handler from
     # config[:default_solr_parameters], OR can specify a different one
@@ -208,7 +223,7 @@ class <%= controller_name.classify %>Controller < ApplicationController
 
     # Specifying a :qt only to show it's possible, and so our internal automated
     # tests can test it. In this case it's the same as
-    # config[:default_solr_parameters][:qt], so isn't actually neccesary.
+    # config[:default_solr_parameters][:qt], so isn't actually necessary.
     config.add_search_field('subject') do |field|
       field.qt = 'search'
       field.solr_parameters = {
@@ -218,6 +233,13 @@ class <%= controller_name.classify %>Controller < ApplicationController
       }
     end
 
+    # Set up a default advanced search configuration by using the current
+    # search_fields and facet_fields configs.
+    if config.advanced_search.enabled
+      config.copy_search_field_config_to_advanced!
+      config.copy_facet_field_config_to_advanced!
+    end
+
     # "sort results by" select (pulldown)
     # label in pulldown is followed by the name of the Solr field to sort by and
     # whether the sort is ascending or descending (it must be asc or desc

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-beta5",
+  "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/constraints_component_spec.rb

@@ -36,7 +36,7 @@ RSpec.describe Blacklight::ConstraintsComponent, type: :component do
     end
 
     it 'has a header' do
-      expect(page).to have_css('h2', text: 'Search Constraints')
+      expect(page).to have_css('h2', text: 'Your selections:')
     end
 
     it 'wraps the output in a div' do
@@ -79,7 +79,7 @@ RSpec.describe Blacklight::ConstraintsComponent, type: :component do
     end
 
     it 'omits the headers' do
-      expect(page).to have_no_css('h2', text: 'Search Constraints')
+      expect(page).to have_no_css('h2', text: 'Your selections:')
     end
   end
 end

data/spec/components/blacklight/document_component_spec.rb

@@ -34,11 +34,11 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
   end
 
   it 'has some defined content areas' do
-    component.set_slot(:title) { 'Title' }
-    component.set_slot(:embed, nil, 'Embed')
-    component.set_slot(:metadata, nil, 'Metadata')
-    component.set_slot(:thumbnail, nil, 'Thumbnail')
-    component.set_slot(:actions) { 'Actions' }
+    component.with_title { 'Title' }
+    component.with_embed('Embed')
+    component.with_metadata('Metadata')
+    component.with_thumbnail('Thumbnail')
+    component.with_actions { 'Actions' }
     render_inline component
 
     expect(page).to have_content 'Title'
@@ -49,7 +49,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
   end
 
   it 'has schema.org properties' do
-    component.set_slot(:body) { '-' }
+    component.with_body { '-' }
     render_inline component
 
     expect(page).to have_css 'article[@itemtype="http://schema.org/Thing"]'
@@ -58,7 +58,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
 
   context 'with a provided body' do
     it 'opts-out of normal component content' do
-      component.set_slot(:body) { 'Body content' }
+      component.with_body { 'Body content' }
       render_inline component
 
       expect(page).to have_content 'Body content'
@@ -75,7 +75,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     let(:attr) { { counter: 5 } }
 
     it 'has data properties' do
-      component.set_slot(:body) { '-' }
+      component.with_body { '-' }
       render_inline component
 
       expect(page).to have_css 'article[@data-document-id="x"]'
@@ -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.set_slot(: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/index_navigation_component_spec.rb

@@ -16,7 +16,8 @@ RSpec.describe Blacklight::Facets::IndexNavigationComponent, type: :component do
 
   it 'renders the facet index navigation range' do
     expect(page).to have_css '.pagination'
-    expect(page).to have_link '0', href: '/catalog/facet/language.html?facet.prefix=0&facet.sort=index'
+    facet_path = ViewComponent::VERSION::MAJOR == 3 ? '/catalog/facet/language.html' : '/catalog/facet/language'
+    expect(page).to have_link '0', href: "#{facet_path}?facet.prefix=0&facet.sort=index"
     expect(page).to have_link '1'
     expect(page).to have_link '8'
     expect(page).to have_link '9'

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

@@ -28,7 +28,8 @@ RSpec.describe Blacklight::Facets::SuggestComponent, type: :component do
   it 'has an input with the data-facet-search-context attribute, which the javascript needs to determine the current search context' do
     with_request_url "/catalog/facet/language_facet?f%5Bformat%5D%5B%5D=Book&facet.prefix=R&facet.sort=index&q=tibet&search_field=all_fields" do
       rendered = render_inline component
-      expect(rendered.css('input[data-facet-search-context="/catalog/facet/language_facet.html?f%5Bformat%5D%5B%5D=Book&facet.prefix=R&facet.sort=index&q=tibet&search_field=all_fields"]').count).to eq 1
+      facet_path = ViewComponent::VERSION::MAJOR == 3 ? '/catalog/facet/language_facet.html' : '/catalog/facet/language_facet'
+      expect(rendered.css("input[data-facet-search-context=\"#{facet_path}?f%5Bformat%5D%5B%5D=Book&facet.prefix=R&facet.sort=index&q=tibet&search_field=all_fields\"]").count).to eq 1
     end
   end
 
@@ -57,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
@@ -64,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/features/search_filters_spec.rb

@@ -53,7 +53,7 @@ RSpec.describe "Facets" do
       expect(page).to have_css("span.facet-count.selected", text: "2")
     end
     within "#appliedParams" do
-      expect(page).to have_content "You searched for:"
+      expect(page).to have_content "Your selections:"
       expect(page).to have_content "history"
     end
 
@@ -140,7 +140,7 @@ RSpec.describe "Facets" do
       expect(page).to have_css("span.facet-count.selected", text: "2")
     end
     within "#appliedParams" do
-      expect(page).to have_content "You searched for:"
+      expect(page).to have_content "Your selections:"
       expect(page).to have_content "history"
     end
   end
@@ -164,7 +164,7 @@ RSpec.describe "Facets" do
       expect(page).to have_css("span.facet-count.selected", text: "2")
     end
     within "#appliedParams" do
-      expect(page).to have_content "You searched for:"
+      expect(page).to have_content "Your selections:"
       expect(page).to have_content "history"
     end
   end

data/spec/features/search_spec.rb

@@ -44,7 +44,7 @@ RSpec.describe "Search Page" do
     Capybara.ignore_hidden_elements = tmp_value
 
     within "#appliedParams" do
-      expect(page).to have_content "You searched for:"
+      expect(page).to have_content "Your selections:"
       expect(page).to have_content "history"
     end
 
@@ -74,7 +74,7 @@ RSpec.describe "Search Page" do
     click_on 'search'
 
     within "#appliedParams" do
-      expect(page).to have_content "You searched for:"
+      expect(page).to have_content "Your selections:"
       expect(page).to have_content "Title"
       expect(page).to have_content "inmul"
     end
@@ -104,7 +104,7 @@ RSpec.describe "Search Page" do
     fill_in "q", with: 'history'
     click_on 'search'
     within "#appliedParams" do
-      expect(page).to have_content "You searched for:"
+      expect(page).to have_content "Your selections:"
       expect(page).to have_content "history"
     end