blacklight 9.0.0.beta8 → 9.1.0

data/lib/blacklight/abstract_search_builder.rb

@@ -1,154 +0,0 @@
-# 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/facet_search_builder.rb

@@ -1,18 +0,0 @@
-# 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/solr/facet_search_builder_behavior.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-module Blacklight::Solr
-  module FacetSearchBuilderBehavior
-    extend ActiveSupport::Concern
-
-    included do
-      include Blacklight::Solr::SearchBuilderBehavior
-      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_additional_filters,
-                                      :add_facet_paging_to_solr,
-                                      :add_facet_suggestion_parameters]
-    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
-  end
-end

data/spec/models/blacklight/facet_search_builder_spec.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Blacklight::FacetSearchBuilder, :api do
-  subject(:builder) { described_class.new processor_chain, scope }
-
-  let(:processor_chain) { [] }
-  let(:blacklight_config) { Blacklight::Configuration.new }
-  let(:scope) { double blacklight_config: blacklight_config, search_state_class: nil }
-
-  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
-end