RubyGems - blacklight - Versions diffs - 7.33.0 → 8.0.0.beta1 - Mend

blacklight 7.33.0 → 8.0.0.beta1

Files changed (387) hide show

data/app/views/catalog/index.rss.builder CHANGED Viewed

@@ -4,7 +4,7 @@ xml.instruct! :xml, version: "1.0"
 xml.rss(version: "2.0") {
   xml.channel {
     xml.title(t('blacklight.search.page_title.title', constraints: render_search_to_page_title(params), application_name: application_name))
-    xml.link(search_action_url(params.to_unsafe_h))
+    xml.link(search_action_url(search_state.to_h.merge(only_path: false)))
     xml.description(t('blacklight.search.page_title.title', constraints: render_search_to_page_title(params), application_name: application_name))
     xml.language('en-us')
     @response.documents.each_with_index do |document, document_counter|

data/app/views/catalog/opensearch.xml.builder CHANGED Viewed

@@ -8,5 +8,5 @@ xml.OpenSearchDescription(xmlns: 'http://a9.com/-/spec/opensearch/1.1/') {
   xml.Contact
   xml.Url type: 'text/html', method: 'get', template: "#{url_for controller: 'catalog', only_path: false}?q={searchTerms}&amp;page={startPage?}"
   xml.Url type: 'application/rss+xml', method: 'get', template: "#{url_for controller: 'catalog', only_path: false}.rss?q={searchTerms}&amp;page={startPage?}"
-  xml.Url type: 'application/x-suggestions+json', method: 'get', template: "#{url_for controller: 'catalog',action: 'opensearch', format: 'json', only_path: false}?q={searchTerms}"
+  xml.Url type: 'application/x-suggestions+json', method: 'get', template: "#{url_for controller: 'catalog', action: 'opensearch', format: 'json', only_path: false}?q={searchTerms}"
 }

data/app/views/catalog/sms_success.html.erb CHANGED Viewed

@@ -1,6 +1,5 @@
-<%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.title { t('blacklight.sms.form.title') } %>
-  <%= render partial: '/shared/flash_msg' %>
-  <span data-blacklight-modal="close"></span>
-<% end %>
+<turbo-stream action="append" target="main-flashes">
+  <template>
+    <%= render '/shared/flash_msg' %>
+  </template>
+</turbo-stream>

data/app/views/catalog/suggest.html.erb ADDED Viewed

@@ -0,0 +1,3 @@
+<% @suggestions.each do |suggestion| %>
+  <li role="option"><span><%= suggestion['term'] %></span></li>
+<% end %>

data/app/views/layouts/blacklight/base.html.erb CHANGED Viewed

@@ -14,11 +14,22 @@
     </script>
     <%= opensearch_description_tag application_name, opensearch_catalog_url(format: 'xml') %>
     <%= favicon_link_tag %>
-    <%= stylesheet_link_tag "application", media: "all", "data-turbo-track": "reload" %>
-    <%= javascript_include_tag "application", "data-turbo-track": "reload" %>
+    <%= stylesheet_link_tag "application", media: "all", "data-turbo-track": "reload"  %>
+    <%= stylesheet_link_tag "https://ga.jspm.io/npm:dialog-polyfill@0.5.6/dist/dialog-polyfill.css" %>
+    <% if defined? Importmap %>
+      <%= javascript_importmap_tags %>
+    <% elsif defined? Propshaft %>
+      <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>
+    <% else %>
+      <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>
+      <%= javascript_include_tag "blacklight/blacklight", type: 'module' %>
+    <% end %>
     <%= csrf_meta_tags %>
     <%= content_for(:head) %>
+    <script type="module">
+      import githubAutoCompleteElement from 'https://cdn.skypack.dev/@github/auto-complete-element';
+    </script>
   </head>
   <body class="<%= render_body_class %>">
     <nav id="skip-link" role="navigation" aria-label="<%= t('blacklight.skip_links.label') %>">
@@ -28,15 +39,15 @@
     </nav>
     <%= render partial: 'shared/header_navbar' %>
-  <main id="main-container" class="<%= container_classes %>" role="main" aria-label="<%= t('blacklight.main.aria.main_container') %>">
-    <%= content_for(:container_header) %>
+    <main id="main-container" class="<%= container_classes %>" role="main" aria-label="<%= t('blacklight.main.aria.main_container') %>">
+      <%= content_for(:container_header) %>
-    <%= render partial: 'shared/flash_msg', layout: 'shared/flash_messages' %>
+      <%= render partial: 'shared/flash_msg', layout: 'shared/flash_messages' %>
-    <div class="row">
-      <%= content_for?(:content) ? yield(:content) : yield %>
-    </div>
-  </main>
+      <div class="row">
+        <%= content_for?(:content) ? yield(:content) : yield %>
+      </div>
+    </main>
     <%= render partial: 'shared/footer' %>
     <%= render partial: 'shared/modal' %>

data/app/views/search_history/index.html.erb CHANGED Viewed

@@ -7,8 +7,12 @@
 <% else %>
   <%= link_to t('blacklight.search_history.clear.action_title'),
               blacklight.clear_search_history_path,
-              method: :delete,
-              data: { confirm: t('blacklight.search_history.clear.action_confirm') },
+              method: :delete, # for rails-ujs
+              data: {
+                confirm: t('blacklight.search_history.clear.action_confirm'), # for rails-ujs
+                turbo_confirm: t('blacklight.search_history.clear.action_confirm'),
+                turbo_method: :delete
+              },
               class: 'btn btn-danger float-md-right float-md-end' %>
   <h2 class='section-heading'><%= t('blacklight.search_history.recent') %></h2>
   <table class="table table-striped search-history">

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

@@ -1,22 +1 @@
-<nav class="navbar navbar-expand-md navbar-dark bg-dark topbar" role="navigation">
-  <div class="<%= container_classes %>">
-    <%= link_to application_name, root_path, class: 'mb-0 navbar-brand navbar-logo' %>
-    <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-bs-toggle="collapse" data-target="#user-util-collapse" data-bs-target="#user-util-collapse" aria-controls="user-util-collapse" aria-expanded="false" aria-label="Toggle navigation">
-      <span class="navbar-toggler-icon"></span>
-    </button>
-    <div class="collapse navbar-collapse justify-content-md-end" id="user-util-collapse">
-      <%= render 'shared/user_util_links' %>
-    </div>
-  </div>
-</nav>
-<%= 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((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 %>
+<%= render blacklight_config.header_component.new(blacklight_config: blacklight_config) %>

data/app/views/shared/_modal.html.erb CHANGED Viewed

@@ -1,6 +1,6 @@
-<div id="blacklight-modal" class="modal fade" tabindex="-1" role="dialog" aria-hidden="true">
-  <div class="modal-dialog modal-lg" role="document">
+<dialog id="blacklight-modal" class="modal" data-turbo="false">
+  <div class="modal-dialog modal-lg">
     <div class="modal-content">
     </div>
   </div>
-</div>
+</dialog>

data/blacklight.gemspec CHANGED Viewed

@@ -23,20 +23,18 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.required_ruby_version = '>= 2.5'
+  s.required_ruby_version = '>= 2.7'
-  s.add_dependency "rails", '>= 5.1', '< 7.1'
+  s.add_dependency "rails", '>= 6.1', '< 8'
   s.add_dependency "globalid"
   s.add_dependency "jbuilder", '~> 2.7'
   s.add_dependency "kaminari", ">= 0.15" # the pagination (page 1,2,3, etc..) of our search results
-  s.add_dependency "deprecation"
   s.add_dependency "i18n", '>= 1.7.0' # added named parameters
   s.add_dependency "ostruct", '>= 0.3.2'
   s.add_dependency "view_component", '~> 2.66'
-  s.add_dependency 'hashdiff'
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.
-  s.add_development_dependency "rspec-rails", "~> 5.0"
+  s.add_development_dependency "rspec-rails", "~> 6.0"
   s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
   s.add_development_dependency 'axe-core-rspec'
   s.add_development_dependency "capybara", '~> 3'
@@ -45,9 +43,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'engine_cart', '~> 2.1'
   s.add_development_dependency "equivalent-xml"
   s.add_development_dependency "simplecov"
-  s.add_development_dependency "rubocop", '~> 0.85'
-  s.add_development_dependency "rubocop-rails", '~> 2.6'
-  s.add_development_dependency "rubocop-rspec", '~> 1.43'
+  s.add_development_dependency "rubocop", '~> 1.0'
+  s.add_development_dependency "rubocop-rails"
+  s.add_development_dependency "rubocop-rspec"
   s.add_development_dependency "i18n-tasks"
   s.add_development_dependency "solr_wrapper"
 end

data/config/importmap.rb ADDED Viewed

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+pin_all_from File.expand_path("../app/javascript/blacklight", __dir__)

data/config/locales/blacklight.ar.yml CHANGED Viewed

@@ -154,7 +154,6 @@ ar:
       search_constraints_header: 'قيود البحث'
       search_results: 'نتائج البحث'
       errors:
-        request_error: "معذرة، لم أفهم ما تبحث عنه."
         invalid_solr_id: "معذرة! لقد طلبت سجلًا غير موجود."
       per_page:
         label: '%{count}<span class="sr-only visually-hidden"> لكل صفحة</span>'

data/config/locales/blacklight.ca.yml CHANGED Viewed

@@ -144,7 +144,6 @@ ca:
       search_constraints_header: 'Filtres de la cerca'
       search_results: 'Resultats de la cerca'
       errors:
-        request_error: "No ha estat possible entendre la cerca"
         invalid_solr_id: "El registre que heu sol·licitat no existeix."
       per_page:
         label: '%{count}<span class="sr-only visually-hidden"> per pàgina</span>'

data/config/locales/blacklight.de.yml CHANGED Viewed

@@ -144,7 +144,6 @@ de:
       search_constraints_header: 'Suchen'
       search_results: 'Suchergebnisse'
       errors:
-        request_error: "Entschuldigung, ich habe Ihre Suche nicht verstanden."
         invalid_solr_id: "Entschuldigung, Sie haben einen nicht vorhandenen Datensatz angefordert."
       per_page:
         label: '%{count}<span class="sr-only visually-hidden"> pro Seite</span>'

data/config/locales/blacklight.en.yml CHANGED Viewed

@@ -144,7 +144,6 @@ en:
       search_constraints_header: 'Search Constraints'
       search_results: 'Search Results'
       errors:
-        request_error: "Sorry, I don't understand your search."
         invalid_solr_id: "Sorry, you have requested a record that doesn't exist."
       per_page:
         label: '%{count}<span class="sr-only visually-hidden"> per page</span>'

data/config/locales/blacklight.es.yml CHANGED Viewed

@@ -144,7 +144,6 @@ es:
       search_constraints_header: 'Buscar'
       search_results: 'Resultados de la búsqueda'
       errors:
-        request_error: "Lo siento, no entiendo esta búsqueda"
         invalid_solr_id: "Lo sentimos, usted ha solicitado un registro que no existe."
       per_page:
         label: '%{count}<span class="sr-only visually-hidden"> por página</span>'

data/config/locales/blacklight.fr.yml CHANGED Viewed

@@ -147,7 +147,6 @@ fr:
       search_constraints_header: 'Recherche'
       search_results: 'Résultats de recherche'
       errors:
-        request_error: "Pardon, nous n'avons pas compris votre recherche."
         invalid_solr_id: "Vous avez demandé une notice qui n'existe pas."
       per_page:
         label: '%{count}<span class="sr-only visually-hidden"> par page</span>'

data/config/locales/blacklight.hu.yml CHANGED Viewed

@@ -144,7 +144,6 @@ hu:
       search_constraints_header: 'Keresés feltételei'
       search_results: 'Keresés eredményei'
       errors:
-        request_error: "Elnézést, nem tudom értelmezni a keresést."
         invalid_solr_id: "Elnézést, de az Ön által kért rekord nem létezik."
       per_page:
         label: '%{count}<span class="sr-only visually-hidden"> oldalanként</span>'

data/config/locales/blacklight.it.yml CHANGED Viewed

@@ -144,7 +144,6 @@ it:
       search_constraints_header: 'Ricerca'
       search_results: 'Risultati della ricerca'
       errors:
-        request_error: "La richiesta non è comprensibile."
         invalid_solr_id: "Il numero di scheda richiesto non esiste."
       per_page:
         label: '%{count}<span class="sr-only visually-hidden"> per pagina</span>'

data/config/locales/blacklight.nl.yml CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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/lib/blacklight/abstract_repository.rb CHANGED Viewed

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 module Blacklight
   # Base class for Blacklight repository adapters
   class AbstractRepository

data/lib/blacklight/configuration/context.rb CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

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

data/lib/blacklight/configuration/fields.rb CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 ADDED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

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

data/lib/blacklight/configuration/sort_field.rb CHANGED Viewed

@@ -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 CHANGED Viewed

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

data/lib/blacklight/configuration/view_config.rb CHANGED Viewed

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 class Blacklight::Configuration
   class ViewConfig < Blacklight::OpenStructWithHashAccess
     # @!attribute template
@@ -23,25 +24,34 @@ 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
+    # 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
       # @!attribute route
       #   @return [Hash] Default route parameters for 'show' requests.