blacklight 8.11.0 → 9.0.0.beta2

data/config/locales/blacklight.es.yml

@@ -92,7 +92,7 @@ es:
           close: Ocultar facetas
           open: Mostrar facetas
         missing: "[Falta]"
-        more_html: más <span class="sr-only visually-hidden">%{field_name}</span> »
+        more_html: más <span class="visually-hidden">%{field_name}</span> »
         pivot:
           hide: Cerrar
           show: Abierto
@@ -141,7 +141,7 @@ es:
         aria_label: Navegación de resultados
         button_label: "%{count} por página"
         button_label_html: '%{count}<span class="d-none d-sm-inline"> por página</span>'
-        label: '%{count}<span class="sr-only visually-hidden"> por página</span>'
+        label: '%{count}<span class="visually-hidden"> por página</span>'
         submit: Actualización
         title: El número de resultados a mostrar por página
       rss_feed: RSS de los resultados

data/config/locales/blacklight.fr.yml

@@ -92,7 +92,7 @@ fr:
           close: Masquer les facettes
           open: Afficher les facettes
         missing: "[manquante]"
-        more_html: plus <span class="sr-only visually-hidden">%{field_name}</span> »
+        more_html: plus <span class="visually-hidden">%{field_name}</span> »
         pivot:
           hide: Fermer
           show: Ouvrir
@@ -141,7 +141,7 @@ fr:
         aria_label: Navigation dans les résultats
         button_label: "%{count} par page"
         button_label_html: '%{count}<span class="d-none d-sm-inline"> par page</span>'
-        label: '%{count}<span class="sr-only visually-hidden"> par page</span>'
+        label: '%{count}<span class="visually-hidden"> par page</span>'
         submit: mettre à jour
         title: Nombre de résultats à afficher par page
       rss_feed: RSS pour les résultats

data/config/locales/blacklight.hu.yml

@@ -90,7 +90,7 @@ hu:
           close: Fazetek elrejtése
           open: Szempontok megjelenítése
         missing: "[Hiányzó]"
-        more_html: több <span class="sr-only visually-hidden">%{field_name}</span> »
+        more_html: több <span class="visually-hidden">%{field_name}</span> »
         pivot:
           hide: Bezárás
           show: Megnyitás
@@ -139,7 +139,7 @@ hu:
         aria_label: Eredmények navigáció
         button_label: "%{count} oldalanként"
         button_label_html: '%{count}<span class="d-none d-sm-inline"> oldalanként</span>'
-        label: '%{count}<span class="sr-only visually-hidden"> oldalanként</span>'
+        label: '%{count}<span class="visually-hidden"> oldalanként</span>'
         submit: Frissítés
         title: Az eredmények száma oldalanként
       rss_feed: Eredmények RSS-ként

data/config/locales/blacklight.it.yml

@@ -142,7 +142,7 @@ it:
         aria_label: Navigazione dei risultati
         button_label: "%{count} per pagina"
         button_label_html: '%{count}<span class="d-none d-sm-inline"> per pagina</span>'
-        label: '%{count}<span class="sr-only visually-hidden"> per pagina</span>'
+        label: '%{count}<span class="visually-hidden"> per pagina</span>'
         submit: Aggiorna
         title: Risultati per pagina
       rss_feed: RSS per i risultati

data/config/locales/blacklight.nl.yml

@@ -90,7 +90,7 @@ nl:
           close: Verberg facetten
           open: Toon facetten
         missing: "[Ontbrekend]"
-        more_html: Meer <span class="sr-only visually-hidden">%{field_name}</span> »
+        more_html: Meer <span class="visually-hidden">%{field_name}</span> »
         pivot:
           hide: Sluiten
           show: Openen
@@ -139,7 +139,7 @@ nl:
         aria_label: Resultaten navigatie
         button_label: "%{count} per pagina"
         button_label_html: '%{count}<span class="d-none d-sm-inline"> per pagina</span>'
-        label: '%{count}<span class="sr-only visually-hidden"> per pagina</span>'
+        label: '%{count}<span class="visually-hidden"> per pagina</span>'
         submit: Update
         title: Toon aantal zoekresultaten per pagina
       rss_feed: RSS voor zoekresultaten

data/config/locales/blacklight.pt-BR.yml

@@ -91,7 +91,7 @@ pt-BR:
           open: Mostrar facetas
         missing:
         - Ausência
-        more_html: mais <span class="sr-only visually-hidden">%{field_name}</span> »
+        more_html: mais <span class="visually-hidden">%{field_name}</span> »
         pivot:
           hide: Fechar
           show: Abrir

data/config/locales/blacklight.sq.yml

@@ -90,7 +90,7 @@ sq:
           close: Fshih aspektet
           open: Trego aspektet
         missing: "[Mungon]"
-        more_html: Më shumë <span class="sr-only visually-hidden">%{field_name}</span> »
+        more_html: Më shumë <span class="visually-hidden">%{field_name}</span> »
         pivot:
           hide: Mbylle
           show: Hape
@@ -139,7 +139,7 @@ sq:
         aria_label: Rezultatet e lundrimit
         button_label: "%{count} për faqe"
         button_label_html: '%{count}<span class="d-none d-sm-inline"> për faqe</span>'
-        label: '%{count}<span class="sr-only visually-hidden"> për faqe</span>'
+        label: '%{count}<span class="visually-hidden"> për faqe</span>'
         submit: Përditëso
         title: Numri i rezultateve që do të shfaqen për faqe
       rss_feed: RSS për rezultatet

data/config/locales/blacklight.zh.yml

@@ -90,7 +90,7 @@ zh:
           close: 隐藏方面
           open: 显示方面
         missing: "[未找到]"
-        more_html: 更多 <span class="sr-only visually-hidden">%{field_name}</span> »
+        more_html: 更多 <span class="visually-hidden">%{field_name}</span> »
         pivot:
           hide: 关
           show: 打开
@@ -139,7 +139,7 @@ zh:
         aria_label: 结果导航
         button_label: "%{count} 每页"
         button_label_html: '%{count}<span class="d-none d-sm-inline"> 每页</span>'
-        label: '%{count}<span class="sr-only visually-hidden"> 每页</span>'
+        label: '%{count}<span class="visually-hidden"> 每页</span>'
         submit: 更新
         title: 每页显示结果数
       rss_feed: 搜索结果RSS

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/display_field.rb

@@ -2,7 +2,7 @@
 
 module Blacklight
   class Configuration::DisplayField < Blacklight::Configuration::Field
-    def initialize(*args, **kwargs, &block)
+    def initialize(*args, **kwargs, &)
       super
 
       self.presenter ||= Blacklight::FieldPresenter

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

@@ -81,7 +81,7 @@ module Blacklight
       #
       #     add_blacklight_field :index_field, [{ :field => 'format', :label => 'Format' }, IndexField.new(:field => 'date', :label => 'Date')]
       #
-      def add_blacklight_field config_key, *args, &block
+      def add_blacklight_field(config_key, *args, &)
         field_config = case args.first
                        when String
                          field_config_from_key_and_hash(config_key, *args)
@@ -89,7 +89,7 @@ module Blacklight
                          args[0] = args[0].to_s
                          field_config_from_key_and_hash(config_key, *args)
                        when Array
-                         field_config_from_array(config_key, *args, &block)
+                         field_config_from_array(config_key, *args, &)
                          return # we've iterated over the array above.
                        else
                          field_config_from_field_or_hash(config_key, *args)
@@ -101,7 +101,7 @@ module Blacklight
 
         # look up any dynamic fields
         if field_config.match
-          handle_matching_fields(config_key, field_config, &block)
+          handle_matching_fields(config_key, field_config, &)
           return
         end
 
@@ -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

@@ -4,8 +4,6 @@ class Blacklight::Configuration
   class ViewConfig < Blacklight::OpenStructWithHashAccess
     # @!attribute template
     #   @return [String] partial to render around the documents
-    # @!attribute partials
-    #   @return [Array<String>] partials to render for each document(see #render_document_partials)
     # @!attribute document_presenter_class
     #   @return [Class] document presenter class used by helpers and views
     # @!attribute document_component
@@ -26,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: [
@@ -35,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]
@@ -138,8 +135,8 @@ module Blacklight
       # @!attribute bookmark_icon_component
       # @since v8.3.1
       # component class used to render a document
-      # set to Blacklight::Icons::BookmarkIconComponent to replace checkbox with icon
-      property :bookmark_icon_component, default: nil
+      # set to nil if a checkbox is prefered to the icon
+      property :bookmark_icon_component, default: Blacklight::Icons::BookmarkIconComponent
 
       # @!attribute index
       # General configuration for all views
@@ -157,8 +154,6 @@ module Blacklight
         display_type_field: nil,
         # the "field access" key to use to look up the document display fields
         document_fields_key: :index_fields,
-        # partials to render for each document(see #render_document_partials)
-        partials: [],
         document_actions: NestedOpenStructWithHashAccess.new(ToolConfig),
         collection_actions: NestedOpenStructWithHashAccess.new(ToolConfig),
         # what field, if any, to use to render grouped results
@@ -166,7 +161,9 @@ module Blacklight
         # additional response formats for search results
         respond_to: OpenStructWithHashAccess.new,
         # component class used to render the facet grouping
-        facet_group_component: nil,
+        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
@@ -184,9 +181,7 @@ module Blacklight
         # document presenter class used by helpers and views
         document_presenter_class: nil,
         document_component: Blacklight::DocumentComponent,
-        # in Blacklight 9, the default show_tools_component configuration will
-        # be Blacklight::Document::ShowToolsComponent
-        show_tools_component: nil,
+        show_tools_component: Blacklight::Document::ShowToolsComponent,
         show_header_tools_component: nil,
         document_header_component: Blacklight::Document::PageHeaderComponent,
         sidebar_component: Blacklight::Document::SidebarComponent,
@@ -197,8 +192,6 @@ module Blacklight
         # Set this to a hash with additional arguments to merge into the route,
         # or set `controller: :current` to route to the current controller.
         route: nil,
-        # partials to render for each document(see #render_document_partials)
-        partials: [],
         document_actions: NestedOpenStructWithHashAccess.new(ToolConfig),
         header_actions: NestedOpenStructWithHashAccess.new(ToolConfig)
       )
@@ -386,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
@@ -585,7 +578,7 @@ module Blacklight
 
     ##
     # Add a section of config that only applies to documents with a matching display type
-    def for_display_type display_type, &_block
+    def for_display_type(display_type, &)
       fields_for_type[display_type] ||= self.class.new
 
       fields_for_type[display_type].tap do |conf|

data/lib/blacklight/engine.rb

@@ -72,12 +72,6 @@ module Blacklight
       outer_window: 2
     }
 
-    # Blacklight 9 moves the next button after the page numbers. This behavior can be configured
-    # in Blacklight 8 by setting the next_button_position to :after
-    bl_global_config.paginator = {
-      next_button_position: :before
-    }
-
     bl_global_config.search_params_permitted_classes = [ActiveSupport::HashWithIndifferentAccess, Symbol]
 
     # Anything that goes into Blacklight::Engine.config is stored as a class

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

@@ -53,19 +53,19 @@ module Blacklight
       self.class.new @table.deep_dup
     end
 
-    def deep_transform_values(&method)
-      self.class.new @table.deep_transform_values(&method)
+    def deep_transform_values(&)
+      self.class.new @table.deep_transform_values(&)
     end
 
-    def try(method_name = nil, *args, &block)
+    def try(method_name = nil, *, &)
       if method_name.nil? && block_given?
         if b.arity.zero?
-          instance_eval(&block)
+          instance_eval(&)
         else
           yield self
         end
       elsif respond_to?(method_name)
-        public_send(method_name, *args, &b)
+        public_send(method_name, *, &b)
       end
     end
   end