blacklight 9.0.0.beta8 → 9.0.0

data/app/services/blacklight/search_service.rb

@@ -22,8 +22,10 @@ module Blacklight
       @search_state.class
     end
 
-    # a solr query method
-    # @yield [search_builder] optional block yields configured SearchBuilder, caller can modify or create new SearchBuilder to be used. Block should return SearchBuilder to be used.
+    # Fetch query results from solr
+    # @yield [search_builder] optional block yields configured SearchBuilder,  caller can modify or create new
+    #                         SearchBuilder to be used. Block should return SearchBuilder to be used.
+    #                         This is used in blacklight_range_limit
     # @return [Blacklight::Solr::Response] the solr response object
     def search_results
       builder = search_builder.with(search_state)

data/lib/blacklight/configuration.rb

@@ -47,7 +47,6 @@ module Blacklight
       property :header_component, default: Blacklight::HeaderComponent
       property :full_width_layout, default: false
 
-      # bootstrap_version may be set to 4 or 5
       bootstrap_version = ENV['BOOTSTRAP_VERSION'].presence || "5"
       property :bootstrap_version, default: /(\d)(?:\.\d){0,2}/.match(bootstrap_version)[1].to_i
 
@@ -104,9 +103,6 @@ module Blacklight
       # @!attribute search_builder_class
       # @return [Class] class for converting Blacklight parameters to request parameters for the repository_class
       property :search_builder_class, default: ::SearchBuilder
-      # @!attribute search_builder_class
-      # @return [Class] class for converting Blacklight parameters to request parameters for the repository_class
-      property :facet_search_builder_class, default: ::FacetSearchBuilder
       # @!attribute response_model
       # model that maps index responses to the blacklight response model
       # @return [Class]

data/lib/blacklight/routes/searchable.rb

@@ -18,7 +18,7 @@ module Blacklight
         mapper.get "opensearch"
         mapper.get 'suggest', as: 'suggest_index'
         mapper.get "facet/:id", action: 'facet', as: 'facet'
-        mapper.get "facet_suggest/:id/(:query_fragment)", action: 'facet', as: 'facet_suggest', defaults: { only_values: true }
+        mapper.get "facet_suggest/:id", action: 'facet', as: 'facet_suggest', defaults: { only_values: true }
       end
     end
   end

data/lib/blacklight/search_builder.rb

@@ -5,7 +5,45 @@ module Blacklight
   # Blacklight's SearchBuilder converts blacklight request parameters into
   # query parameters appropriate for search index. It does so by evaluating a
   # chain of processing methods to populate a result hash (see {#to_hash}).
-  class SearchBuilder < AbstractSearchBuilder
+  class SearchBuilder
+    class_attribute :default_processor_chain
+    self.default_processor_chain = []
+
+    attr_reader :processor_chain, :search_state, :blacklight_params
+
+    # @overload initialize(scope)
+    #   @param [Object] scope the scope where the filter methods reside in.
+    # @overload initialize(processor_chain, scope)
+    #   @param [List<Symbol>,TrueClass] processor_chain options a list of filter methods to run or true, to use the default methods
+    #   @param [Object] scope the scope where the filter methods reside in.
+    def initialize(*options)
+      case options.size
+      when 1
+        @processor_chain = default_processor_chain.dup
+        @scope = options.first
+      when 2
+        @processor_chain, @scope = options
+      else
+        raise ArgumentError, "wrong number of arguments. (#{options.size} for 1..2)"
+      end
+
+      @blacklight_params = {}
+      search_state_class = @scope.try(:search_state_class) || Blacklight::SearchState
+      @search_state = search_state_class.new(@blacklight_params, @scope&.blacklight_config, @scope)
+      @additional_filters = {}
+      @merged_params = {}
+      @reverse_merged_params = {}
+    end
+
+    ##
+    # Set the parameters to pass through the processor chain
+    def with(blacklight_params_or_search_state = {})
+      params_will_change!
+      @search_state = blacklight_params_or_search_state.is_a?(Blacklight::SearchState) ? blacklight_params_or_search_state : @search_state.reset(blacklight_params_or_search_state)
+      @blacklight_params = @search_state.params.dup
+      self
+    end
+
     ##
     # Update the :q (query) parameter
     # @param [Hash<Symbol,Object>] conditions the field and values to query on
@@ -21,6 +59,7 @@ module Blacklight
 
     ##
     # Append additional processor chain directives
+    # This is used in blacklight_range_limit
     def append(*addl_processor_chain)
       params_will_change!
       builder = self.class.new(processor_chain + addl_processor_chain, scope)
@@ -55,6 +94,68 @@ module Blacklight
       builder
     end
 
+    ##
+    # Merge additional, repository-specific parameters
+    def merge(extra_params, &)
+      if extra_params
+        params_will_change!
+        @merged_params.merge!(extra_params.to_hash, &)
+      end
+      self
+    end
+
+    ##
+    # "Reverse merge" additional, repository-specific parameters
+    def reverse_merge(extra_params, &)
+      if extra_params
+        params_will_change!
+        @reverse_merged_params.reverse_merge!(extra_params.to_hash, &)
+      end
+      self
+    end
+
+    delegate :[], :key?, to: :to_hash
+
+    # a solr query method
+    # @return [Blacklight::Solr::Response] the solr response object
+    def to_hash
+      return @params unless params_need_update?
+
+      @params = processed_parameters
+                .reverse_merge(@reverse_merged_params)
+                .merge(@merged_params)
+                .tap { clear_changes }
+    end
+
+    alias_method :query, :to_hash
+    alias_method :to_h, :to_hash
+
+    # The CatalogController #index action uses this.
+    # Solr parameters can come from a number of places. From lowest
+    # precedence to highest:
+    #  1. General defaults in blacklight config (are trumped by)
+    #  2. defaults for the particular search field identified by  params[:search_field] (are trumped by)
+    #  3. certain parameters directly on input HTTP query params
+    #     * not just any parameter is grabbed willy nilly, only certain ones are allowed by HTTP input)
+    #     * for legacy reasons, qt in http query does not over-ride qt in search field definition default.
+    #  4.  extra parameters passed in as argument.
+    #
+    # spellcheck.q will be supplied with the [:q] value unless specifically
+    # specified otherwise.
+    #
+    # Incoming parameter :f is mapped to :fq solr parameter.
+    #
+    # @return a params hash for searching solr.
+    def processed_parameters
+      request.tap do |request_parameters|
+        processor_chain.each do |method_name|
+          send(method_name, request_parameters)
+        end
+      end
+    end
+
+    delegate :blacklight_config, to: :scope
+
     def start=(value)
       params_will_change!
       @start = value.to_i
@@ -109,6 +210,34 @@ module Blacklight
 
     alias per rows
 
+    # sets the facet that this query pertains to, for the purpose of facet pagination
+    def facet=(value)
+      params_will_change!
+      @facet = value
+    end
+
+    # @param [Object] value
+    def facet(value = nil)
+      if value
+        self.facet = value
+        return self
+      end
+      @facet
+    end
+
+    def facet_suggestion_query=(value)
+      params_will_change!
+      @facet_suggestion_query = value
+    end
+
+    def facet_suggestion_query(value = nil)
+      if value
+        self.facet_suggestion_query = value
+        return self
+      end
+      @facet_suggestion_query
+    end
+
     # Decode the user provided 'sort' parameter into a sort string that can be
     # passed to the search.  This sanitizes the input by ensuring only
     # configured search values are passed through to the search.
@@ -116,5 +245,35 @@ module Blacklight
     def sort
       search_state.sort_field&.sort
     end
+
+    delegate :search_field, to: :search_state
+
+    private
+
+    def request
+      Blacklight::Solr::Request.new
+    end
+
+    def should_add_field_to_request? _field_name, field
+      field.include_in_request || (field.include_in_request.nil? && blacklight_config.add_field_configuration_to_solr_request)
+    end
+
+    attr_reader :scope
+
+    def params_will_change!
+      @dirty = true
+    end
+
+    def params_changed?
+      !!@dirty
+    end
+
+    def params_need_update?
+      params_changed? || @params.nil?
+    end
+
+    def clear_changes
+      @dirty = false
+    end
   end
 end

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -1,16 +1,25 @@
 # frozen_string_literal: true
 
 module Blacklight::Solr
+  # This depends on being imported into a class that extends AbstractSearchBuilder
   module SearchBuilderBehavior
     extend ActiveSupport::Concern
 
     included do
       self.default_processor_chain = [
-        :default_solr_parameters, :add_search_field_default_parameters,
-        :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_facets_for_advanced_search_form,
+        :default_solr_parameters,
+        :add_search_field_default_parameters,
+        :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_facets_for_advanced_search_form,
+        :add_facet_paging_to_solr,
+        :add_facet_suggestion_parameters,
         :add_additional_filters
       ]
     end
@@ -232,8 +241,6 @@ module Blacklight::Solr
     # copy paging params from BL app over to solr, changing
     # app level per_page and page to Solr rows and start.
     def add_paging_to_solr(solr_params)
-      rows(solr_params[:rows] || 10) if rows.nil?
-
       solr_params[:rows] = rows
 
       solr_params[:start] = start if start.nonzero?
@@ -250,6 +257,48 @@ module Blacklight::Solr
       solr_parameters[:group] = false if search_state.filter(grouped_key_for_results).any?
     end
 
+    def add_facet_paging_to_solr(solr_params)
+      return if facet.blank?
+
+      facet_config = blacklight_config.facet_fields[facet]
+
+      solr_params[:rows] = 0
+
+      limit = if solr_params["facet.limit"]
+                solr_params["facet.limit"].to_i
+              else
+                facet_config.fetch(:more_limit, blacklight_config.default_more_limit)
+              end
+
+      page = search_state.facet_page
+      sort = search_state.facet_sort
+      prefix = search_state.facet_prefix
+      offset = (page - 1) * limit
+
+      if facet_config.json
+        add_solr_facet_json_params(solr_parameters, facet, facet_config, limit: limit + 1, offset: offset, sort: sort, prefix: prefix)
+        return
+      end
+
+      # Now override with our specific things for fetching facet values
+      facet_ex = facet_config.respond_to?(:ex) ? facet_config.ex : nil
+      solr_params[:'facet.field'] = with_ex_local_param(facet_ex, facet_config.field)
+
+      # Need to set as f.facet_field.facet.* to make sure we
+      # override any field-specific default in the solr request handler.
+      solr_params[:"f.#{facet_config.field}.facet.limit"] = limit + 1
+      solr_params[:"f.#{facet_config.field}.facet.offset"] = offset
+      solr_params[:"f.#{facet_config.field}.facet.sort"] = sort if sort
+      solr_params[:"f.#{facet_config.field}.facet.prefix"] = prefix if prefix
+    end
+
+    def add_facet_suggestion_parameters(solr_params)
+      return if facet.blank? || facet_suggestion_query.blank?
+
+      solr_params[:'facet.contains'] = facet_suggestion_query[0..50]
+      solr_params[:'facet.contains.ignoreCase'] = true
+    end
+
     def with_ex_local_param(ex, value)
       if ex
         "{!ex=#{ex}}#{value}"

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

@@ -12,7 +12,7 @@ class <%= controller_name.classify %>Controller < ApplicationController
   # rescue_from Blacklight::Exceptions::InvalidRequest, with: :my_handling_method
 
   configure_blacklight do |config|
-    ## Specify the style of markup to be generated (may be 4 or 5)
+    ## Specify the style of markup to be generated
     # config.bootstrap_version = 5
     #
     ## Class for sending and receiving requests from a search index

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "9.0.0-beta8",
+  "version": "9.0.0",
   "description": "The frontend code and styles for Blacklight",
   "exports": {
     "./blacklight.esm.js": "./app/assets/javascripts/blacklight/blacklight.esm.js",

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

@@ -22,7 +22,7 @@ RSpec.describe Blacklight::Facets::FiltersComponent, type: :component do
     let(:component) { described_class.new(presenter: presenter) }
 
     it 'draws default classes' do
-      expect(page).to have_css(".facet-filters.card.card-body.bg-light.p-3.mb-3.border-0")
+      expect(page).to have_css(".facet-filters.mt-1.mb-3")
     end
   end
 

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

@@ -37,7 +37,7 @@ RSpec.describe Blacklight::Facets::SuggestComponent, type: :component do
     with_request_url "/catalog/facet/language_facet" do
       rendered = render_inline component
       label = rendered.css('label').first
-      expect(label.text.strip).to eq 'Filter Language'
+      expect(label.text.strip).to eq 'Filter languages'
 
       id_in_label_for = label.attribute('for').text
       expect(id_in_label_for).to eq('facet_suggest_language_facet')

data/spec/features/facets_spec.rb

@@ -112,6 +112,15 @@ RSpec.describe "Facets" do
       expect(page).to have_css 'a.facet-select', count: 2
     end
 
+    it 'can show suggestions including a period', :js do
+      visit '/catalog/facet/subject_ssim'
+      fill_in 'facet_suggest_subject_ssim', with: 'iran.'
+
+      expect(page).to have_css '.facet-suggestions'
+      expect(page).to have_link 'Iran. Vizārat-i Kishvar'
+      expect(page).to have_css 'a.facet-select', count: 1
+    end
+
     it 'shows the user facet suggestions that are relevant to their q param', :js do
       visit '/catalog/facet/subject_ssim?q=tibet&search_field=all_fields'
       fill_in 'facet_suggest_subject_ssim', with: 'la'

data/spec/models/blacklight/search_builder_spec.rb

@@ -125,7 +125,7 @@ RSpec.describe Blacklight::SearchBuilder, :api do
       end
 
       subject.with(a: 1)
-      expect(subject.send(:processed_parameters)).to include step_1: 'builder'
+      expect(subject.processed_parameters).to include step_1: 'builder'
     end
   end
 
@@ -225,6 +225,16 @@ RSpec.describe Blacklight::SearchBuilder, :api do
     end
   end
 
+  describe "#facet_suggestion_query" do
+    it "is nil if no value is set" do
+      expect(subject.facet_suggestion_query).to be_nil
+    end
+
+    it "sets facet_suggestion_query value" do
+      expect(subject.facet_suggestion_query('antel').facet_suggestion_query).to eq 'antel'
+    end
+  end
+
   describe "#search_field" do
     it "uses the requested search field" do
       blacklight_config.add_search_field 'x'

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

@@ -43,7 +43,7 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, :api do
   end
 
   context "with a complex parameter environment" do
-    subject { search_builder.with(user_params).send(:processed_parameters) }
+    subject { search_builder.with(user_params).processed_parameters }
 
     let(:user_params) do
       { :search_field => "test_field", :q => "test query", "facet.field" => "extra_facet" }
@@ -90,7 +90,7 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, :api do
   # SPECS for actual search parameter generation
   describe "#processed_parameters" do
     subject do
-      search_builder.with(user_params).send(:processed_parameters)
+      search_builder.with(user_params).processed_parameters
     end
 
     context "when search_params_logic is customized" do
@@ -718,6 +718,166 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, :api do
     end
   end
 
+  describe "#add_facet_paging_to_solr" do
+    let(:facet_field) { 'format' }
+    let(:sort_key) { Blacklight::Solr::FacetPaginator.request_keys[:sort] }
+    let(:page_key) { Blacklight::Solr::FacetPaginator.request_keys[:page] }
+    let(:prefix_key) { Blacklight::Solr::FacetPaginator.request_keys[:prefix] }
+
+    let(:blacklight_config) do
+      Blacklight::Configuration.new do |config|
+        config.add_facet_fields_to_solr_request!
+        config.add_facet_field 'format'
+        config.add_facet_field 'format_ordered', sort: :count
+        config.add_facet_field 'format_limited', limit: 5
+        config.add_facet_field 'format_more_limited', limit: 5, more_limit: 50
+      end
+    end
+
+    let(:solr_parameters) do
+      solr_parameters = Blacklight::Solr::Request.new
+      subject.facet(facet_field).add_facet_paging_to_solr(solr_parameters)
+      solr_parameters
+    end
+
+    it 'sets rows to 0' do
+      expect(solr_parameters[:rows]).to eq 0
+    end
+
+    it 'sets facets requested to facet_field argument' do
+      expect(solr_parameters[:'facet.field']).to eq facet_field
+    end
+
+    it 'defaults offset to 0' do
+      expect(solr_parameters[:"f.#{facet_field}.facet.offset"]).to eq 0
+    end
+
+    context 'when offset is manually set' do
+      let(:user_params) { { page_key => 2 } }
+
+      it 'uses offset manually set, and converts it to an integer' do
+        expect(solr_parameters[:"f.#{facet_field}.facet.offset"]).to eq 20
+      end
+    end
+
+    context 'for a field with a configured more_limit' do
+      let(:facet_field) { 'format_more_limited' }
+
+      it 'uses the more_limit configuration' do
+        expect(solr_parameters[:"f.#{facet_field}.facet.limit"]).to eq 51
+      end
+    end
+
+    context 'for a field with a param key different from the field name' do
+      let(:user_params) { { page_key => 2, 'facet.sort': 'index', 'facet.prefix': 'x' } }
+      let(:facet_field) { 'param_key' }
+
+      let(:blacklight_config) do
+        Blacklight::Configuration.new.tap do |config|
+          config.add_facet_field key: 'param_key', field: 'solr_field', more_limit: 50, ex: 'other'
+
+          config.add_facet_fields_to_solr_request!
+        end
+      end
+
+      it "uses the configured solr field name in queries" do
+        expect(solr_parameters).to include 'f.solr_field.facet.limit': 51,
+                                           'f.solr_field.facet.offset': 50,
+                                           'f.solr_field.facet.sort': 'index',
+                                           'f.solr_field.facet.prefix': 'x',
+                                           'facet.field': '{!ex=other}solr_field'
+      end
+    end
+
+    it 'defaults limit to 20' do
+      expect(solr_parameters[:"f.#{facet_field}.facet.limit"]).to eq 21
+    end
+
+    it 'uses the default sort' do
+      expect(solr_parameters[:"f.#{facet_field}.facet.sort"]).to be_blank
+    end
+
+    context 'when sort is provided' do
+      let(:user_params) { { sort_key => 'index' } }
+
+      it 'uses sort provided in the parameters' do
+        expect(solr_parameters[:"f.#{facet_field}.facet.sort"]).to eq 'index'
+      end
+    end
+
+    context 'when a prefix is provided' do
+      let(:user_params) { { prefix_key => 'A' } }
+
+      it 'includes the prefix in the query' do
+        expect(solr_parameters[:"f.#{facet_field}.facet.prefix"]).to eq 'A'
+      end
+    end
+  end
+
+  describe "#add_facet_suggestion_parameters" do
+    it "does not add anything when the builder has no facet_suggestion_query and no facet" do
+      expect(subject.facet).to be_nil
+      expect(subject.facet_suggestion_query).to be_nil
+      solr_params = Blacklight::Solr::Request.new
+
+      expect do
+        subject.add_facet_suggestion_parameters(solr_params)
+      end.not_to(change { solr_params })
+    end
+
+    it "does not add anything when the builder has a facet_suggestion_query but no facet" do
+      subject.facet_suggestion_query = 'artic'
+      expect(subject.facet_suggestion_query).to eq 'artic'
+      expect(subject.facet).to be_nil
+      solr_params = Blacklight::Solr::Request.new
+
+      expect do
+        subject.add_facet_suggestion_parameters(solr_params)
+      end.not_to(change { solr_params })
+    end
+
+    it "does not add anything when the builder has a facet but no facet_suggestion_query" do
+      subject.facet = 'subject_facet'
+      expect(subject.facet_suggestion_query).to be_nil
+      expect(subject.facet).to eq 'subject_facet'
+      solr_params = Blacklight::Solr::Request.new
+
+      expect do
+        subject.add_facet_suggestion_parameters(solr_params)
+      end.not_to(change { solr_params })
+    end
+
+    it "adds the facet_suggestion_query to facet.contains" do
+      subject.facet = 'subject_facet'
+      subject.facet_suggestion_query = 'artic'
+      solr_params = Blacklight::Solr::Request.new
+
+      subject.add_facet_suggestion_parameters(solr_params)
+
+      expect(solr_params[:'facet.contains']).to eq 'artic'
+    end
+
+    it "adds the first part of facet_suggestion_query to facet.contains if it is extremely long" do
+      subject.facet = 'subject_facet'
+      subject.facet_suggestion_query = 'Call me Ishmael. Some years ago—never mind how long precisely'
+      solr_params = Blacklight::Solr::Request.new
+
+      subject.add_facet_suggestion_parameters(solr_params)
+
+      expect(solr_params[:'facet.contains']).to eq 'Call me Ishmael. Some years ago—never mind how long'
+    end
+
+    it "adds facet.contains.ignoreCase" do
+      subject.facet = 'subject_facet'
+      subject.facet_suggestion_query = 'artic'
+      solr_params = Blacklight::Solr::Request.new
+
+      subject.add_facet_suggestion_parameters(solr_params)
+
+      expect(solr_params[:'facet.contains.ignoreCase']).to be true
+    end
+  end
+
   describe "#with_tag_ex" do
     it "adds an !ex local parameter if the facet configuration requests it" do
       expect(subject.with_ex_local_param("xyz", "some-value")).to eq "{!ex=xyz}some-value"