blacklight 9.0.0.beta1 → 9.0.0.beta2

data/config/locales/blacklight.zh.yml

@@ -100,8 +100,8 @@ zh:
           count: 按数量排序
           index: 按字母排序
         suggest:
-          label: Filter %{field_label}
-          placeholder: Filter...
+          label: 过滤器 %{field_label}
+          placeholder: 筛选...
         title: 限定搜索
       filters:
         label: "%{label}:"

data/lib/blacklight/abstract_repository.rb

@@ -37,8 +37,8 @@ module Blacklight
 
     # Find multiple documents by their ids
     # @param [Hash] _params query parameters
-    def find_many(params, **kwargs)
-      search(params, **kwargs)
+    def find_many(params, **)
+      search(params, **)
     end
 
     ##

data/lib/blacklight/abstract_search_builder.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+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 AbstractSearchBuilder
+    class_attribute :default_processor_chain
+    self.default_processor_chain = []
+
+    attr_reader :processor_chain, :search_state, :blacklight_params
+
+    # @overload initialize(scope)
+    #   @param [Object] scope 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
+
+    delegate :blacklight_config, to: :scope
+
+    ##
+    # 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
+
+    # 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
+
+    ##
+    # 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 query to_hash
+    alias to_h to_hash
+
+    delegate :search_field, to: :search_state
+
+    private
+
+    attr_reader :scope
+
+    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
+
+    def request
+      Blacklight::Solr::Request.new
+    end
+
+    # The CatalogController #index and #facet actions use 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
+
+    def params_will_change!
+      @dirty = true
+    end
+
+    def params_changed?
+      !!@dirty
+    end
+
+    def clear_changes
+      @dirty = false
+    end
+
+    def params_need_update?
+      params_changed? || @params.nil?
+    end
+  end
+end

data/lib/blacklight/configuration/context.rb

@@ -24,16 +24,16 @@ module Blacklight
       #
       # @param [#if,#unless] config an object that responds to if/unless
       # @return [Boolean]
-      def evaluate_if_unless_configuration(config, *args)
+      def evaluate_if_unless_configuration(config, *)
         return config if config == true || config == false
 
         if_value = !config.respond_to?(:if) ||
                    config.if.nil? ||
-                   evaluate_configuration_conditional(config.if, config, *args)
+                   evaluate_configuration_conditional(config.if, config, *)
 
         unless_value = !config.respond_to?(:unless) ||
                        config.unless.nil? ||
-                       !evaluate_configuration_conditional(config.unless, config, *args)
+                       !evaluate_configuration_conditional(config.unless, config, *)
 
         if_value && unless_value
       end

data/lib/blacklight/configuration/facet_field.rb

@@ -59,15 +59,15 @@ module Blacklight
     # @!attribute item_presenter
     #   @return [Blacklight::FacetItemPresenter]
     # @!attribute component
-    #   @return [Blacklight::FacetFieldListComponent]
+    #   @return [Blacklight::Facets::ListComponent]
     # @!attribute item_component
-    #   @return [Blacklight::FacetItemComponent]
+    #   @return [Blacklight::Facets::ItemComponent]
     # @!attribute partial
     #   @return [String] Rails view partial used to render the facet field
 
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def normalize! blacklight_config = nil
-      query.stringify_keys! if query
+      query&.stringify_keys!
 
       normalize_pivot_config! if pivot
       self.collapse = true if collapse.nil?
@@ -76,9 +76,9 @@ module Blacklight
       self.index_range = 'A'..'Z' if index_range == true
       self.presenter ||= Blacklight::FacetFieldPresenter
       self.item_presenter ||= Blacklight::FacetItemPresenter
-      self.component = Blacklight::FacetFieldListComponent if component.nil? || component == true
-      self.advanced_search_component ||= Blacklight::FacetFieldCheckboxesComponent
-      self.item_component ||= Blacklight::FacetItemComponent
+      self.component = Blacklight::Facets::ListComponent if component.nil? || component == true
+      self.advanced_search_component ||= Blacklight::Facets::CheckboxesComponent
+      self.item_component ||= Blacklight::Facets::ItemComponent
       super
 
       if single && tag.blank? && ex.blank?

data/lib/blacklight/configuration/field.rb

@@ -33,13 +33,13 @@ module Blacklight
       raise ArgumentError, "Must supply a field name" if self.field.nil?
     end
 
-    def display_label(context = nil, **options)
+    def display_label(context = nil, **)
       field_label(
         (:"blacklight.search.fields.#{context}.#{key}" if context),
         :"blacklight.search.fields.#{key}",
         label,
         default_label,
-        **options
+        **
       )
     end
 
@@ -65,10 +65,10 @@ module Blacklight
     #     before falling  back to the label
     #   @param [Symbol] any number of additional keys
     #   @param [Symbol] ...
-    def field_label *i18n_keys, **options
+    def field_label(*i18n_keys, **)
       first, *rest = i18n_keys.compact
 
-      I18n.t(first, default: rest, **options)
+      I18n.t(first, default: rest, **)
     end
   end
 end

data/lib/blacklight/configuration/fields.rb

@@ -145,7 +145,6 @@ module Blacklight
         end
 
         @table[:reflected_fields] ||= Rails.cache.fetch("blacklight_configuration/admin/reflected_fields", expires_in: 1.hour) do
-          repository = repository_class.new(self)
           repository.reflect_fields
         rescue => e
           Blacklight.logger&.warn "Error retrieving field metadata: #{e}"

data/lib/blacklight/configuration/search_field.rb

@@ -14,7 +14,7 @@ module Blacklight
       self.if = include_in_simple_select if self.if.nil?
 
       super
-      self.qt ||= blacklight_config.default_solr_params[:qt] if blacklight_config && blacklight_config.default_solr_params
+      self.qt ||= blacklight_config.default_solr_params[:qt] if blacklight_config&.default_solr_params
 
       self
     end

data/lib/blacklight/configuration/view_config.rb

@@ -24,7 +24,7 @@ class Blacklight::Configuration
     #   @return [Class] component class used to render the search bar
     # @!attribute search_header_component
     #   @return [Class] component class used to render the header above the documents
-    def display_label(**options)
+    def display_label(**)
       I18n.t(
         :"blacklight.search.view_title.#{key}",
         default: [
@@ -33,7 +33,7 @@ class Blacklight::Configuration
           title,
           key.to_s.humanize
         ],
-        **options
+        **
       )
     end
 

data/lib/blacklight/configuration.rb

@@ -66,9 +66,6 @@ module Blacklight
 
       # === Single document request configuration
 
-      # @!attribute document_solr_request_handler
-      # @return [String] The solr request handler to use when requesting only a single document
-      property :document_solr_request_handler, default: nil
       # @!attribute document_solr_path
       # @since v5.2.0
       # @return [String] The url path (relative to the solr base url) to use when requesting only a single document
@@ -99,12 +96,12 @@ module Blacklight
       ##
       # == Response models
 
-      # @!attribute repository_class
-      # @return [Class] Class for sending and receiving requests from a search index
-      property :repository_class, default: Blacklight::Solr::Repository
       # @!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]
@@ -165,6 +162,8 @@ module Blacklight
         respond_to: OpenStructWithHashAccess.new,
         # component class used to render the facet grouping
         facet_group_component: Blacklight::Response::FacetGroupComponent,
+        # component class used to render the facet pagination
+        facet_pagination_component: Blacklight::FacetFieldPaginationComponent,
         # component class used to render search constraints
         constraints_component: Blacklight::ConstraintsComponent,
         # component class used to render the search bar
@@ -380,7 +379,7 @@ module Blacklight
 
     # @return [Blacklight::Repository]
     def repository
-      repository_class.new(self)
+      Blacklight.repository_class.new(self)
     end
 
     # @return [String] The destination for the link around the logo in the header

data/lib/blacklight/facet_search_builder.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetSearchBuilder < AbstractSearchBuilder
+    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
+  end
+end

data/lib/blacklight/nested_open_struct_with_hash_access.rb

@@ -114,7 +114,7 @@ module Blacklight
 
     def set_default_proc!
       self.default_proc = lambda do |hash, key|
-        hash[key] = nested_class.new(key: key)
+        hash[key] = nested_class.new({ key: key })
       end
     end
   end

data/lib/blacklight/open_struct_with_hash_access.rb

@@ -57,7 +57,7 @@ module Blacklight
       self.class.new @table.deep_transform_values(&)
     end
 
-    def try(method_name = nil, *args, &)
+    def try(method_name = nil, *, &)
       if method_name.nil? && block_given?
         if b.arity.zero?
           instance_eval(&)
@@ -65,7 +65,7 @@ module Blacklight
           yield self
         end
       elsif respond_to?(method_name)
-        public_send(method_name, *args, &b)
+        public_send(method_name, *, &b)
       end
     end
   end

data/lib/blacklight/search_builder.rb

@@ -5,45 +5,7 @@ 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
-    class_attribute :default_processor_chain
-    self.default_processor_chain = []
-
-    attr_reader :processor_chain, :search_state, :blacklight_params
-
-    # @overload initialize(scope)
-    #   @param [Object] scope 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
-
+  class SearchBuilder < AbstractSearchBuilder
     ##
     # Update the :q (query) parameter
     # @param [Hash<Symbol,Object>] conditions the field and values to query on
@@ -93,68 +55,6 @@ 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
@@ -209,34 +109,6 @@ 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.
@@ -244,35 +116,5 @@ 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/search_state/filter_field.rb

@@ -120,8 +120,8 @@ module Blacklight
       delegate :any?, to: :values
 
       # Appease rubocop rules by implementing #each_value
-      def each_value(except: [], &block)
-        values(except: except).each(&block)
+      def each_value(except: [], &)
+        values(except: except).each(&)
       end
 
       # @param [String,#value] item a filter to remove from the url
@@ -145,8 +145,8 @@ module Blacklight
       def permitted_params
         if config.pivot
           {
-            filters_key => config.pivot.each_with_object({}) { |key, filter| filter.merge(key => [], "-#{key}" => []) },
-            inclusive_filters_key => config.pivot.each_with_object({}) { |key, filter| filter.merge(key => []) }
+            filters_key => config.pivot.each_with_object({}) { |key, filter| filter.merge!(key => [], "-#{key}" => []) },
+            inclusive_filters_key => config.pivot.each_with_object({}) { |key, filter| filter.merge!(key => []) }
           }
         else
           {

data/lib/blacklight/search_state/pivot_filter_field.rb

@@ -89,16 +89,16 @@ module Blacklight
         end
       end
 
-      class QueryBuilder
+      class QueryBuilder < Solr::AbstractFilterQueryBuilder
         # @return [Array] filter_query, subqueries
-        def self.call(search_builder, filter, solr_parameters)
+        def call(filter, solr_parameters)
           existing = solr_parameters['fq']&.dup || []
           queries = []
           filter.values.compact_blank.each do |value|
-            queries << search_builder.send(:facet_value_to_fq_string, filter.pivot.first, value.value)
+            queries << facet_value_to_fq_string(filter.pivot.first, value.value)
             value.fq.each do |entry|
               k, v = entry
-              queries << search_builder.send(:facet_value_to_fq_string, k, v) if v
+              queries << facet_value_to_fq_string(k, v) if v
             end
             queries.uniq!
           end