blacklight 7.40.0 → 8.0.0.beta1

data/config/locales/blacklight.nl.yml

@@ -144,7 +144,6 @@ nl:
       search_constraints_header: 'Zoek filters'
       search_results: 'Zoek resultaten'
       errors:
-        request_error: "Sorry, ik kon uw zoekopdracht niet begrijpen."
         invalid_solr_id: "Sorry, u vroeg een onbestaande record op."
       per_page:
         label: '%{count}<span class="sr-only visually-hidden"> per pagina</span>'

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

@@ -145,7 +145,6 @@ pt-BR:
       search_constraints_header: 'Busca'
       search_results: 'Resultados da Busca'
       errors:
-        request_error: "Desculpe, Eu não compreendi sua busca."
         invalid_solr_id: "Desculpe, você solicitou um cadastro que não existe."
       per_page:
         label: '%{count}<span class="hide-text"> por página</span>'

data/config/locales/blacklight.sq.yml

@@ -144,7 +144,6 @@ sq:
       search_constraints_header: 'Kufizimet e kërkimit'
       search_results: 'Rezultatet e kërkimit'
       errors:
-        request_error: "Na vjen keq, unë nuk e kuptoj kërkimin tuaj."
         invalid_solr_id: "Na vjen keq, ju keni kërkuar një të dhënë që nuk ekziston."
       per_page:
         label: '%{count}<span class="sr-only visually-hidden"> për faqe</span>'

data/config/locales/blacklight.zh.yml

@@ -144,7 +144,6 @@ zh:
       search_constraints_header: '搜索条件'
       search_results: '搜索结果'
       errors:
-        request_error: "抱歉，我不明白你要找什么。"
         invalid_solr_id: "抱歉，你要找的结果不存在。"
       per_page:
         label: '%{count}<span class="sr-only visually-hidden"> 每页</span>'

data/config/routes.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
+
 Blacklight::Engine.routes.draw do
-  get "search_history",             to: "search_history#index",   as: "search_history"
-  delete "search_history/clear",       to: "search_history#clear",   as: "clear_search_history"
+  get "search_history", to: "search_history#index", as: "search_history"
+  delete "search_history/clear", to: "search_history#clear", as: "clear_search_history"
 end

data/db/migrate/20140202020201_create_searches.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateSearches < ActiveRecord::Migration[4.2]
   def self.up
     create_table :searches do |t|

data/db/migrate/20140202020202_create_bookmarks.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateBookmarks < ActiveRecord::Migration[4.2]
   def self.up
     create_table :bookmarks do |t|

data/db/migrate/20140320000000_add_polymorphic_type_to_bookmarks.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class AddPolymorphicTypeToBookmarks < ActiveRecord::Migration[4.2]
   def change
     add_column(:bookmarks, :document_type, :string) unless Bookmark.connection.column_exists? :bookmarks, :document_type

data/docker-compose.yml

@@ -1,3 +1,5 @@
+version: "3.7"
+
 services:
   app:
     build:
@@ -7,7 +9,7 @@ services:
         - ALPINE_RUBY_VERSION
     # mounting . is causing seg-fault on macosx
     #volumes:
-    #- .:/app
+      #- .:/app
     depends_on:
       - solr
     ports:
@@ -15,7 +17,6 @@ services:
     environment:
       - SOLR_URL # Set via environment variable or use default defined in .env file
       - RAILS_VERSION # Set via environment variable or use default defined in .env file
-      - VIEW_COMPONENT_VERSION # Set via environment variable or use default defined in .env file
       - SOLR_ENV=docker-compose
       - ENGINE_CART_RAILS_OPTIONS=--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test --skip-solr
 

data/lib/blacklight/abstract_repository.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   # Base class for Blacklight repository adapters
   class AbstractRepository
@@ -34,12 +35,6 @@ module Blacklight
       raise NotImplementedError
     end
 
-    # Find multiple documents by their ids
-    # @param [Hash] _params query parameters
-    def find_many(params, **kwargs)
-      search(params, **kwargs)
-    end
-
     ##
     # Execute a search query against a search index
     # @param [Hash] _params query parameters

data/lib/blacklight/component.rb

@@ -3,20 +3,57 @@
 module Blacklight
   class Component < ViewComponent::Base
     class << self
-      alias upstream_sidecar_files sidecar_files
+      # Workaround for https://github.com/ViewComponent/view_component/issues/1565
+      def config
+        @config ||= ViewComponent::Config.defaults.merge(ViewComponent::Base.config)
+      end
 
-      def reset_compiler!
-        @__vc_compiler = nil
+      # rubocop:disable Naming/MemoizedInstanceVariableName
+      def compiler
+        @__vc_compiler ||= EngineCompiler.new(self)
       end
+      # rubocop:enable Naming/MemoizedInstanceVariableName
+
+      alias sidecar_files _sidecar_files unless ViewComponent::Base.respond_to? :sidecar_files
+    end
+
+    EXCLUDE_VARIABLES = [
+      :@lookup_context, :@view_renderer, :@view_flow, :@view_context,
+      :@tag_builder, :@current_template,
+      :@__vc_set_slots, :@__vc_original_view_context,
+      :@__vc_variant, :@__vc_content_evaluated,
+      :@__vc_render_in_block, :@__vc_content, :@__vc_helpers
+    ].freeze
+
+    def inspect
+      # Exclude variables added by render_in
+      render_variables = instance_variables - EXCLUDE_VARIABLES
+      fields = render_variables.map { |ivar| "#{ivar}:#{instance_variable_get(ivar).inspect}" }.join(', ')
+      "#<#{self.class.name}:#{object_id} #{fields}>"
+    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
 
-      def sidecar_files(*args, **kwargs)
-        upstream_sidecar_files(*args, **kwargs).map do |path|
-          app_path = Rails.root.join(path.slice(path.index(view_component_path)..-1).to_s).to_s
+          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)}"
 
-          if File.exist?(app_path)
-            app_path
-          else
-            path
+            memo << {
+              path: File.exist?(app_path) ? app_path : path,
+              variant: pieces.second.split("+").second&.to_sym,
+              handler: pieces.last
+            }
           end
         end
       end

data/lib/blacklight/configuration/context.rb

@@ -28,12 +28,12 @@ module Blacklight
         return config if config == true || config == false
 
         if_value = !config.respond_to?(:if) ||
-                        config.if.nil? ||
-                        evaluate_configuration_conditional(config.if, config, *args)
+                   config.if.nil? ||
+                   evaluate_configuration_conditional(config.if, config, *args)
 
         unless_value = !config.respond_to?(:unless) ||
-                          config.unless.nil? ||
-                          !evaluate_configuration_conditional(config.unless, config, *args)
+                       config.unless.nil? ||
+                       !evaluate_configuration_conditional(config.unless, config, *args)
 
         if_value && unless_value
       end

data/lib/blacklight/configuration/display_field.rb

@@ -1,6 +1,13 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::DisplayField < Blacklight::Configuration::Field
+    def initialize(*args, **kwargs, &block)
+      super
+
+      self.presenter ||= Blacklight::FieldPresenter
+      self.component ||= Blacklight::MetadataFieldComponent
+    end
     ##
     # The following is a non-exhaustive list of display field config parameters that are used
     # by Blacklight directly. Application-specific code or plugins may add or replace
@@ -33,18 +40,9 @@ module Blacklight
     # Default rendering pipeline:
     # @!attribute link_to_facet
     #   @return [Boolean]
-    # @!attribute link_to_search
-    #   @deprecated use link_to_facet instead.
-    #   @return [Boolean]
     # @!attribute itemprop
     #   @return [String]
     # @!attribute separator_options
     #   @return [Hash]
-
-    # @param [Blacklight::Configuration] _blacklight_config
-    def normalize! _blacklight_config = nil
-      super
-      self.presenter ||= Blacklight::FieldPresenter
-    end
   end
 end

data/lib/blacklight/configuration/facet_field.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::FacetField < Blacklight::Configuration::Field
     ##
@@ -19,9 +20,6 @@ module Blacklight
     #   @return [Symbol|Hash] the i18n localization option for a date or time value; used as the second parameter for the I18n.l method
     # @!attribute link_to_facet
     #   @return [Boolean]
-    # @!attribute link_to_search
-    #   @deprecated use link_to_facet instead.
-    #   @return [Boolean]
     # @!attribute helper_method
     #   @return [Symbol] the name of a helper method used to display the facet's value to the user; it receives the facet value.
     # @!attribute url_method
@@ -67,22 +65,20 @@ module Blacklight
     # @!attribute partial
     #   @return [String] Rails view partial used to render the facet field
 
-    extend Deprecation
-
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def normalize! blacklight_config = nil
       query.stringify_keys! if query
 
+      normalize_pivot_config! if pivot
       self.collapse = true if collapse.nil?
       self.show = true if show.nil?
       self.if = show if self.if.nil?
       self.index_range = 'A'..'Z' if index_range == true
       self.presenter ||= Blacklight::FacetFieldPresenter
-
-      if link_to_search
-        Deprecation.warn(Blacklight::Configuration::FacetField, '`link_to_search:` is deprecated, use `link_to_facet:` instead')
-        self.link_to_facet = link_to_search if link_to_facet.nil?
-      end
-
+      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
       super
 
       if single && tag.blank? && ex.blank?
@@ -92,5 +88,15 @@ module Blacklight
 
       self
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+    private
+
+    def normalize_pivot_config!
+      self.item_presenter ||= Blacklight::FacetItemPivotPresenter
+      self.item_component ||= Blacklight::FacetItemPivotComponent
+      self.filter_class ||= Blacklight::SearchState::PivotFilterField
+      self.filter_query_builder ||= Blacklight::SearchState::PivotFilterField::QueryBuilder
+    end
   end
 end

data/lib/blacklight/configuration/field.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::Field < OpenStructWithHashAccess
     # @!attribute field

data/lib/blacklight/configuration/fields.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration
     # This mixin provides Blacklight::Configuration with generic
     # solr fields configuration
     module Fields
       extend ActiveSupport::Concern
-      extend Deprecation
-      self.deprecation_horizon = 'blacklight version 8.0.0'
 
       class_methods do
         # Add a configuration block for a collection of solr fields
@@ -84,20 +83,20 @@ module Blacklight
       #
       def add_blacklight_field config_key, *args, &block
         field_config = case args.first
-                         when String
-                           field_config_from_key_and_hash(config_key, *args)
-                         when Symbol
-                           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)
-                           return # we've iterated over the array above.
-                         else
-                           field_config_from_field_or_hash(config_key, *args)
+                       when String
+                         field_config_from_key_and_hash(config_key, *args)
+                       when Symbol
+                         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)
+                         return # we've iterated over the array above.
+                       else
+                         field_config_from_field_or_hash(config_key, *args)
                        end
 
         if (field_config.field || field_config.key).to_s =~ /\*/
-          field_config.match = Regexp.new("^" + (field_config.field || field_config.key).to_s.gsub('*', '.+') + "$")
+          field_config.match = Regexp.new("^#{(field_config.field || field_config.key).to_s.gsub('*', '.+')}$")
         end
 
         # look up any dynamic fields
@@ -155,8 +154,6 @@ module Blacklight
 
         @table[:reflected_fields] || {}
       end
-      alias luke_fields reflected_fields
-      deprecation_deprecate luke_fields: 'use reflected_fields instead'
 
       # Add a solr field by a solr field name and hash
       def field_config_from_key_and_hash config_key, field_name, field_or_hash = {}

data/lib/blacklight/configuration/index_field.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::IndexField < Blacklight::Configuration::DisplayField
   end

data/lib/blacklight/configuration/null_display_field.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Blacklight
+  # Returned if no config is defined for a display field in the Blacklight::Configuration
+  class Configuration::NullDisplayField < Blacklight::Configuration::DisplayField
+    def initialize(field_or_hash = nil)
+      case field_or_hash
+      when String, Symbol
+        super(field: field_or_hash)
+      else
+        super
+      end
+
+      normalize!
+    end
+  end
+end

data/lib/blacklight/configuration/search_field.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::SearchField < Blacklight::Configuration::Field
     # @!attribute include_in_simple_select

data/lib/blacklight/configuration/show_field.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::ShowField < Blacklight::Configuration::DisplayField
   end

data/lib/blacklight/configuration/sort_field.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::SortField < Blacklight::Configuration::Field
     # @!attribute sort

data/lib/blacklight/configuration/tool_config.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::ToolConfig < OpenStructWithHashAccess
     # @!attribute partial

data/lib/blacklight/configuration/view_config.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
+
 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 [w] render_partials_in_component
-    #   @return [Boolean] whether to render partials in the component. This is false by default in Blacklight 7, but true in Blacklight 8.
     # @!attribute document_presenter_class
     #   @return [Class] document presenter class used by helpers and views
     # @!attribute document_component
@@ -25,27 +24,32 @@ class Blacklight::Configuration
     #   @return [Class] component class used to render the constraints
     # @!attribute search_bar_component
     #   @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 search_bar_presenter_class
       super || Blacklight::SearchBarPresenter
     end
 
-    def display_label(deprecated_key = nil, **options)
-      Deprecation.warn(Blacklight::Configuration::ViewConfig, 'Passing the key argument to ViewConfig#display_label is deprecated') if deprecated_key.present?
-
+    def display_label(**options)
       I18n.t(
-        :"blacklight.search.view_title.#{deprecated_key || key}",
+        :"blacklight.search.view_title.#{key}",
         default: [
-          :"blacklight.search.view.#{deprecated_key || key}",
+          :"blacklight.search.view.#{key}",
           label,
           title,
-          (deprecated_key || key).to_s.humanize
+          key.to_s.humanize
         ],
         **options
       )
     end
 
-    def render_partials_in_component?
-      render_partials_in_component
+    # Translate an ordinary field into the expected DisplayField object
+    def title_field=(value)
+      if value.is_a?(Blacklight::Configuration::Field) && !value.is_a?(Blacklight::Configuration::DisplayField)
+        super(Blacklight::Configuration::DisplayField.new(value.to_h))
+      else
+        super
+      end
     end
 
     class Show < ViewConfig