blacklight 7.24.0 → 7.25.0

data/app/views/shared/_header_navbar.html.erb

@@ -13,6 +13,10 @@
 
 <%= content_tag :div, class: 'navbar-search navbar navbar-light bg-light', role: 'navigation', aria: { label: t('blacklight.search.header') } do %>
   <div class="<%= container_classes %>">
-    <%= render_search_bar  %>
+    <%= render((blacklight_config&.view_config(document_index_view_type)&.search_bar_component ||Blacklight::SearchBarComponent).new(
+          url: search_action_url,
+          advanced_search_url: search_action_url(action: 'advanced_search'),
+          params: search_state.params_for_search.except(:qt),
+          autocomplete_path: search_action_path(action: :suggest))) %>
   </div>
 <% end %>

data/lib/blacklight/component.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class Component < ViewComponent::Base
+    class << self
+      # rubocop:disable Naming/MemoizedInstanceVariableName
+      def compiler
+        @__vc_compiler ||= EngineCompiler.new(self)
+      end
+      # rubocop:enable Naming/MemoizedInstanceVariableName
+    end
+
+    class EngineCompiler < ::ViewComponent::Compiler
+      # ViewComponent::Compiler locates and caches templates from sidecar files to the component source file.
+      # While this is sensible in a Rails application, it prevents component templates defined in an Engine
+      # from being overridden by an installing application without subclassing the component, which may also
+      # require modifying any partials rendering the component. This subclass of compiler overrides the template
+      # location algorithm to take the sidecar file names from the Engine, but look to see if a file of the
+      # same name existing in the installing application (ie, under Rails.root). If the latter exists, this
+      # compiler will cache that template instead of the engine-defined file; if not, the compiler will fall
+      # back to the engine-defined file.
+      def templates
+        @templates ||= begin
+          extensions = ActionView::Template.template_handler_extensions
+
+          component_class._sidecar_files(extensions).each_with_object([]) do |path, memo|
+            pieces = File.basename(path).split(".")
+            app_path = "#{Rails.root}/#{path.slice(path.index(component_class.view_component_path)..-1)}"
+
+            memo << {
+              path: File.exist?(app_path) ? app_path : path,
+              variant: pieces.second.split("+").second&.to_sym,
+              handler: pieces.last
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/blacklight/configuration/facet_field.rb

@@ -47,7 +47,7 @@ module Blacklight
     # @!attribute pivot
     #   @return []
     # @!attribute filter_query_builder
-    #   @return [nil, #call] a Proc (or other object responding to #call) that receives as parameters: 1) the search builder, 2) this facet config
+    #   @return [nil, #call] a Proc (or other object responding to #call) that receives as parameters: 1) the search builder, 2) the Blacklight::FilterField instance
     #     and 3) the solr parameters hash. The Proc returns a string suitable for e.g. Solr's fq parameter, or a 2-element array of the string and a hash of additional
     #     parameters to include with the query (i.e. for referenced subqueries); note that implementations are responsible for ensuring
     #     the additional parameter keys are unique.

data/lib/blacklight/configuration/fields.rb

@@ -10,18 +10,13 @@ module Blacklight
 
       class_methods do
         # Add a configuration block for a collection of solr fields
-        def define_field_access(key, options = {})
+        def define_field_access(key, base_class_name = nil, class: nil)
           key = key.to_s if respond_to? :to_s
 
           default_values[key.pluralize.to_sym] = ActiveSupport::OrderedHash.new
 
-          base_class_name = options.fetch(:class, Field)
-
-          unless const_defined? key.camelcase
-            class_eval <<-END_EVAL, __FILE__, __LINE__ + 1
-              class #{key.camelcase} < #{base_class_name}; end
-            END_EVAL
-          end
+          @field_type_for_class ||= {}
+          @field_type_for_class[key] = binding.local_variable_get(:class) || base_class_name
 
           class_eval <<-END_EVAL, __FILE__, __LINE__ + 1
             def add_#{key}(*args, &block)
@@ -29,8 +24,11 @@ module Blacklight
             end
           END_EVAL
         end
-      end
 
+        def field_type_for_class(key)
+          @field_type_for_class&.dig(key.to_s) || Blacklight::Configuration::Field
+        end
+      end
       # Add a solr field configuration to the given configuration key
       #
       # The recommended and strongly encouraged format is a field name, configuration pair, e.g.:
@@ -198,8 +196,9 @@ module Blacklight
       end
 
       # convert a config key to the appropriate Field class
-      def field_class_from_key key
-        "Blacklight::Configuration::#{key.camelcase}".constantize
+      # @param [String] key
+      def field_class_from_key(key)
+        self.class.field_type_for_class(key)
       end
     end
   end

data/lib/blacklight/configuration/view_config.rb

@@ -17,6 +17,12 @@ class Blacklight::Configuration
     #   @return [String, Symbol] icon file to use in the view picker
     # @!attribute document_actions
     #   @return [NestedOpenStructWithHashAccess{Symbol => Blacklight::Configuration::ToolConfig}] 'tools' to render for each document
+    # @!attribute facet_group_component
+    #   @return [Class] component class used to render a facet group
+    # @!attribute constraints_component
+    #   @return [Class] component class used to render the constraints
+    # @!attribute search_bar_component
+    #   @return [Class] component class used to render the search bar
     def search_bar_presenter_class
       super || Blacklight::SearchBarPresenter
     end