blacklight 7.17.2 → 7.19.2

data/app/views/catalog/_document.html.erb

@@ -1,6 +1,7 @@
 <% # container for a single doc -%>
-<%= render (blacklight_config.view_config(document_index_view_type).document_component || Blacklight::DocumentComponent).new(presenter: document_presenter(document), counter: document_counter_with_offset(document_counter)) do |component| %>
-  <% component.public_send(blacklight_config.view_config(document_index_view_type).document_component.blank? && blacklight_config.view_config(document_index_view_type).partials.any? ? :body : :partial) do %>
-    <%= render_document_partials document, blacklight_config.view_config(document_index_view_type).partials, component: component, document_counter: document_counter %>
+<% view_config = local_assigns[:view_config] || blacklight_config.view_config(document_index_view_type) %>
+<%= render (view_config.document_component || Blacklight::DocumentComponent).new(presenter: document_presenter(document), counter: document_counter_with_offset(document_counter)) do |component| %>
+  <% component.public_send(view_config.document_component.blank? && view_config.partials.any? ? :body : :partial) do %>
+    <%= render_document_partials document, view_config.partials, component: component, document_counter: document_counter %>
   <% end %>
 <% end %>

data/app/views/catalog/_document_list.html.erb

@@ -1,4 +1,5 @@
 <% # container for all documents in index list view -%>
-<div id="documents" class="documents-<%= document_index_view_type %>">
-  <%= render documents, :as => :document %>
+<% view_config = local_assigns[:view_config] || blacklight_config&.view_config(document_index_view_type) %>
+<div id="documents" class="documents-<%= view_config&.key || document_index_view_type %>">
+  <%= render documents, as: :document, view_config: view_config %>
 </div>

data/app/views/catalog/_home_text.html.erb

@@ -31,7 +31,7 @@
 
 <%# This is the same panel shown in the Rails welcome template %>
 <div id="about" class="card">
-  <h2 class='card-header collapsed collapse-toggle' data-toggle="collapse" data-target="#about-content"><a href="/rails/info/properties">About your application&rsquo;s environment</a></h2>
+  <h2 class='card-header collapsed collapse-toggle' data-toggle="collapse" data-bs-toggle="collapse" data-bs-target="#about-content" data-target="#about-content"><a href="/rails/info/properties">About your application&rsquo;s environment</a></h2>
   <div id="about-content" class="card-body collapse"></div>
 </div>
 

data/app/views/catalog/_per_page_widget.html.erb

@@ -1,5 +1,5 @@
 <% if show_sort_and_per_page? %>
-  <span class="sr-only"><%= t('blacklight.search.per_page.title') %></span>
+  <span class="sr-only visually-hidden"><%= t('blacklight.search.per_page.title') %></span>
   <%= render(Blacklight::System::DropdownComponent.new(
     param: :per_page,
     choices: per_page_options_for_select,

data/app/views/catalog/_search_results.html.erb

@@ -12,14 +12,14 @@
 <% end %>
 
 <% content_for(:container_header) do -%>
-  <h1 class="sr-only top-content-title"><%= t('blacklight.search.header') %></h1>
+  <h1 class="sr-only visually-hidden top-content-title"><%= t('blacklight.search.header') %></h1>
 
   <%= render 'constraints' %>
 <% end %>
 
 <%= render 'search_header' %>
 
-<h2 class="sr-only"><%= t('blacklight.search.search_results') %></h2>
+<h2 class="sr-only visually-hidden"><%= t('blacklight.search.search_results') %></h2>
 
 <%- if @response.empty? %>
   <%= render "zero_results" %>

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

@@ -9,7 +9,7 @@
               blacklight.clear_search_history_path,
               method: :delete,
               data: { confirm: t('blacklight.search_history.clear.action_confirm') },
-              class: 'btn btn-danger float-md-right' %>
+              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">
     <% @searches.each_with_index do |search,index| %>

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

@@ -1,7 +1,7 @@
 <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-target="#user-util-collapse" aria-controls="user-util-collapse" aria-expanded="false" aria-label="Toggle navigation">
+    <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>
 

data/config/locales/blacklight.ar.yml

@@ -157,7 +157,7 @@ ar:
         request_error: "معذرة، لم أفهم ما تبحث عنه."
         invalid_solr_id: "معذرة! لقد طلبت سجلًا غير موجود."
       per_page:
-        label: '%{count}<span class="sr-only"> لكل صفحة</span>'
+        label: '%{count}<span class="sr-only visually-hidden"> لكل صفحة</span>'
         button_label: '%{count} لكل صفحة' # TODO: Remove during major release
         button_label_html: '%{count}<span class="d-none d-sm-inline"> لكل صفحة</span>'
         title: 'عدد النتائج المعروضة في الصفحة'
@@ -209,7 +209,7 @@ ar:
           count: 'ترتيب رقمي'
           index: 'ترتيب أبجدي'
         count: '%{number}'
-        more_html: 'المزيد <span class="sr-only">%{field_name}</span> »'
+        more_html: 'المزيد <span class="sr-only visually-hidden">%{field_name}</span> »'
         selected:
           remove: '[إزالة]'
         missing: "[غير موجود]"

data/config/locales/blacklight.ca.yml

@@ -147,7 +147,7 @@ ca:
         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"> per pàgina</span>'
+        label: '%{count}<span class="sr-only visually-hidden"> per pàgina</span>'
         button_label: '%{count} per pàgina' # TODO: Remove during major release
         button_label_html: '%{count}<span class="d-none d-sm-inline"> per pàgina</span>'
         title: 'Nombre de resultats a mostrar per pàgina'
@@ -189,7 +189,7 @@ ca:
           count: 'Numèricament'
           index: 'Alfabèticament'
         count: '%{number}'
-        more_html: 'més <span class="sr-only">%{field_name}</span> »'
+        more_html: 'més <span class="sr-only visually-hidden">%{field_name}</span> »'
         selected:
           remove: '[eliminar]'
         missing: "[Desaparegut]"

data/config/locales/blacklight.de.yml

@@ -147,7 +147,7 @@ de:
         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"> pro Seite</span>'
+        label: '%{count}<span class="sr-only visually-hidden"> pro Seite</span>'
         button_label: '%{count} pro Seite' # TODO: Remove during major release
         button_label_html: '%{count}<span class="d-none d-sm-inline"> pro Seite</span>'
         title: 'Anzahl der Ergebnisse, die pro Seite angezeigt werden'
@@ -190,7 +190,7 @@ de:
           count: 'Numerisch ordnen'
           index: 'A-Z Ordnen'
         count: '%{number}'
-        more_html: 'mehr <span class="sr-only">%{field_name}</span> »'
+        more_html: 'mehr <span class="sr-only visually-hidden">%{field_name}</span> »'
         selected:
           remove: '[entfernen]'
         missing: [fehlt]

data/config/locales/blacklight.en.yml

@@ -147,7 +147,7 @@ en:
         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"> per page</span>'
+        label: '%{count}<span class="sr-only visually-hidden"> per page</span>'
         button_label: '%{count} per page' # TODO: Remove during major release
         button_label_html: '%{count}<span class="d-none d-sm-inline"> per page</span>'
         title: 'Number of results to display per page'
@@ -189,7 +189,7 @@ en:
           count: 'Numerical Sort'
           index: 'A-Z Sort'
         count: '%{number}'
-        more_html: 'more <span class="sr-only">%{field_name}</span> »'
+        more_html: 'more <span class="sr-only visually-hidden">%{field_name}</span> »'
         selected:
           remove: '[remove]'
         missing: "[Missing]"

data/config/locales/blacklight.es.yml

@@ -147,7 +147,7 @@ es:
         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"> por página</span>'
+        label: '%{count}<span class="sr-only visually-hidden"> por página</span>'
         button_label: '%{count} por página' # TODO: Remove during major release
         button_label_html: '%{count}<span class="d-none d-sm-inline"> por página</span>'
         title: 'El número de resultados a mostrar por página'
@@ -190,7 +190,7 @@ es:
           count: 'Ordenación numérica'
           index: 'Ordenación A-Z'
         count: '%{number}'
-        more_html: 'más <span class="sr-only">%{field_name}</span> »'
+        more_html: 'más <span class="sr-only visually-hidden">%{field_name}</span> »'
         selected:
           remove: '[borrar]'
         missing: '[Falta]'

data/config/locales/blacklight.fr.yml

@@ -150,7 +150,7 @@ fr:
         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"> par page</span>'
+        label: '%{count}<span class="sr-only visually-hidden"> par page</span>'
         button_label: '%{count} par page' # TODO: Remove during major release
         button_label_html: '%{count}<span class="d-none d-sm-inline"> par page</span>'
         title: 'Nombre de résultats à afficher par page'
@@ -193,7 +193,7 @@ fr:
           count: 'Du + au - fréquent'
           index: 'Tri de A à Z'
         count: '%{number}'
-        more_html: 'plus <span class="sr-only">%{field_name}</span> »'
+        more_html: 'plus <span class="sr-only visually-hidden">%{field_name}</span> »'
         selected:
           remove: '[ X ]'
         missing: '[manquante]'

data/config/locales/blacklight.hu.yml

@@ -147,7 +147,7 @@ hu:
         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"> oldalanként</span>'
+        label: '%{count}<span class="sr-only visually-hidden"> oldalanként</span>'
         button_label: '%{count} oldalanként' # TODO: Remove during major release
         button_label_html: '%{count}<span class="d-none d-sm-inline"> oldalanként</span>'
         title: 'Az eredmények száma oldalanként'
@@ -190,7 +190,7 @@ hu:
           count: 'Numerikus rendezés'
           index: 'A-Z rendezés'
         count: '%{number}'
-        more_html: 'több <span class="sr-only">%{field_name}</span> »'
+        more_html: 'több <span class="sr-only visually-hidden">%{field_name}</span> »'
         selected:
           remove: '[eltávolítás]'
         missing: "[Hiányzó]"

data/config/locales/blacklight.it.yml

@@ -147,7 +147,7 @@ it:
         request_error: "La richiesta non è comprensibile."
         invalid_solr_id: "Il numero di scheda richiesto non esiste."
       per_page:
-        label: '%{count}<span class="sr-only"> per pagina</span>'
+        label: '%{count}<span class="sr-only visually-hidden"> per pagina</span>'
         button_label: '%{count} per pagina' # TODO: Remove during major release
         button_label_html: '%{count}<span class="d-none d-sm-inline"> per pagina</span>'
         title: 'Risultati per pagina'
@@ -190,7 +190,7 @@ it:
           count: 'Ordina per numero'
           index: 'Ordina A-Z'
         count: '%{number}'
-        more_html: 'altri <span class="sr-only">%{field_name}</span> »'
+        more_html: 'altri <span class="sr-only visually-hidden">%{field_name}</span> »'
         selected:
           remove: '[cancella]'
         missing: [Mancante]

data/config/locales/blacklight.nl.yml

@@ -147,7 +147,7 @@ nl:
         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"> per pagina</span>'
+        label: '%{count}<span class="sr-only visually-hidden"> per pagina</span>'
         button_label: '%{count} per pagina' # TODO: Remove during major release
         button_label_html: '%{count}<span class="d-none d-sm-inline"> per pagina</span>'
         title: 'Toon aantal zoekresultaten per pagina'
@@ -190,7 +190,7 @@ nl:
           count: 'Numeriek sorteren'
           index: 'A-Z Sorteren'
         count: '%{number}'
-        more_html: 'Meer <span class="sr-only">%{field_name}</span> »'
+        more_html: 'Meer <span class="sr-only visually-hidden">%{field_name}</span> »'
         selected:
           remove: '[verwijder]'
         missing: "[Ontbrekend]"

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

@@ -191,7 +191,7 @@ pt-BR:
           count: 'Ordenar por Número'
           index: 'Ordem Alfabética A-Z'
         count: '%{number}'
-        more_html: 'mais <span class="sr-only">%{field_name}</span> »'
+        more_html: 'mais <span class="sr-only visually-hidden">%{field_name}</span> »'
         selected:
           remove: '[remover]'
         missing: [Ausência]

data/config/locales/blacklight.sq.yml

@@ -147,7 +147,7 @@ sq:
         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"> për faqe</span>'
+        label: '%{count}<span class="sr-only visually-hidden"> për faqe</span>'
         button_label: '%{count} për faqe' # TODO: Remove during major release
         button_label_html: '%{count}<span class="d-none d-sm-inline"> për faqe</span>'
         title: 'Numri i rezultateve që do të shfaqen për faqe'
@@ -190,7 +190,7 @@ sq:
           count: 'Renditja numerike'
           index: 'A-Z Renditja'
         count: '%{number}'
-        more_html: 'Më shumë <span class="sr-only">%{field_name}</span> »'
+        more_html: 'Më shumë <span class="sr-only visually-hidden">%{field_name}</span> »'
         selected:
           remove: '[fshije]'
         missing: "[Mungon]"

data/config/locales/blacklight.zh.yml

@@ -147,7 +147,7 @@ zh:
         request_error: "抱歉，我不明白你要找什么。"
         invalid_solr_id: "抱歉，你要找的结果不存在。"
       per_page:
-        label: '%{count}<span class="sr-only"> 每页</span>'
+        label: '%{count}<span class="sr-only visually-hidden"> 每页</span>'
         button_label: '%{count} 每页' # TODO: Remove during major release
         button_label_html: '%{count}<span class="d-none d-sm-inline"> 每页</span>'
         title: '每页显示结果数'
@@ -190,7 +190,7 @@ zh:
           count: '按数量排序'
           index: '按字母排序'
         count: '%{number}'
-        more_html: '更多 <span class="sr-only">%{field_name}</span> »'
+        more_html: '更多 <span class="sr-only visually-hidden">%{field_name}</span> »'
         selected:
           remove: '[删除]'
         missing: "[未找到]"

data/lib/blacklight/configuration.rb

@@ -170,6 +170,8 @@ module Blacklight
     def initialize(hash = {})
       super(self.class.default_values.deep_dup.merge(hash))
       yield(self) if block_given?
+
+      @view_config ||= {}
     end
 
     def document_model
@@ -333,7 +335,6 @@ module Blacklight
         view_type = nil
       end
 
-      @view_config ||= {}
       @view_config[[view_type, action_name]] ||= begin
         if view_type.nil?
           action_config(action_name)
@@ -428,6 +429,11 @@ module Blacklight
       fields.merge(show_fields)
     end
 
+    def freeze
+      each { |_k, v| v.is_a?(OpenStruct) && v.freeze }
+      super
+    end
+
     private
 
     def add_action(config_hash, name, opts)

data/lib/blacklight/configuration/view_config.rb

@@ -1,6 +1,8 @@
 # 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 document_presenter_class
@@ -20,7 +22,7 @@ class Blacklight::Configuration
     end
 
     def display_label(deprecated_key = nil, **options)
-      Deprecation.warn('Passing the key argument to ViewConfig#display_label is deprecated') if deprecated_key.present?
+      Deprecation.warn(Blacklight::Configuration::ViewConfig, 'Passing the key argument to ViewConfig#display_label is deprecated') if deprecated_key.present?
 
       I18n.t(
         :"blacklight.search.view_title.#{deprecated_key || key}",

data/lib/blacklight/nested_open_struct_with_hash_access.rb

@@ -5,18 +5,21 @@ module Blacklight
   # An OpenStruct refinement that converts any hash-keys into
   # additional instances of NestedOpenStructWithHashAccess
   class NestedOpenStructWithHashAccess < OpenStructWithHashAccess
+    extend Deprecation
+    self.deprecation_horizon = 'blacklight 8.0'
+
     attr_reader :nested_class
 
     delegate :default_proc=, to: :to_h
 
     def initialize(klass, hash = {})
       @nested_class = klass
-      value = hash.transform_values do |v|
-        if v.is_a? Hash
-          nested_class.new(v)
-        else
-          v
-        end
+      value = hash.each_with_object({}) do |(k, v), h|
+        h[k] = if v.is_a? Hash
+                 nested_class.new({ key: k.to_sym }.merge(v))
+               else
+                 v
+               end
       end
 
       super value
@@ -34,7 +37,7 @@ module Blacklight
     # into another NestedOpenStructWithHashAccess
     def []=(key, value)
       if value.is_a? Hash
-        send "#{key}=", nested_class.new(value)
+        send "#{key}=", nested_class.new({ key: key.to_sym }.merge(value))
       else
         super
       end
@@ -86,15 +89,31 @@ module Blacklight
     ##
     # Override #method_missing from OpenStruct to ensure the default_proc logic
     # gets triggered.
-    def method_missing(mid, *args)
+    def method_missing(mid, *args, **kwargs, &block)
       len = args.length
 
-      if len.zero?
-        new_ostruct_member!(mid)
-        @table[mid]
-      else
-        super
-      end
+      res = if mid.to_s.end_with?('!')
+              m = mid[0...-1].to_sym
+              new_ostruct_member!(m)
+              @table[m]
+            elsif mid.to_s.end_with?('=')
+              m = mid[0...-1].to_sym
+              new_ostruct_member!(m)
+              @table[m] = args.first
+            elsif len.zero? && kwargs.blank? && !block
+              Deprecation.warn(Blacklight::NestedOpenStructWithHashAccess,
+                               "Initializing a #{nested_class} implicitly (by calling #{mid}) is deprecated. Call it as #{mid}! or pass initialize arguments")
+
+              new_ostruct_member!(mid)
+              @table[mid]
+            else
+              new_ostruct_member!(mid)
+              @table[mid] = nested_class.new(key: mid, **(args.first || {}), **kwargs)
+            end
+
+      block&.call(res)
+
+      res
     end
 
     private

data/lib/blacklight/open_struct_with_hash_access.rb

@@ -6,7 +6,7 @@ module Blacklight
   class OpenStructWithHashAccess < OpenStruct
     delegate :keys, :each, :map, :has_key?, :key?, :include?, :empty?,
              :length, :delete, :delete_if, :keep_if, :clear, :reject!, :select!,
-             :replace, :fetch, :to_json, :as_json, :any?, to: :to_h
+             :replace, :fetch, :to_json, :as_json, :any?, :freeze, :unfreeze, :frozen?, to: :to_h
 
     ##
     # Expose the internal hash

data/lib/blacklight/search_builder.rb

@@ -45,6 +45,7 @@ module Blacklight
     ##
     # Update the :q (query) parameter
     def where(conditions)
+      Deprecation.warn(Blacklight::SearchBuilder, "SearchBuilder#where must be called with a hash, received #{conditions.inspect}.") unless conditions.is_a? Hash
       params_will_change!
       @search_state = @search_state.reset(@search_state.params.merge(q: conditions))
       @blacklight_params = @search_state.params.dup

data/lib/blacklight/solr/request.rb

@@ -2,7 +2,10 @@
 class Blacklight::Solr::InvalidParameter < ArgumentError; end
 
 class Blacklight::Solr::Request < ActiveSupport::HashWithIndifferentAccess
+  # @deprecated
   SINGULAR_KEYS = %w(facet fl q qt rows start spellcheck spellcheck.q sort per_page wt hl group defType)
+
+  # @deprecated
   ARRAY_KEYS = %w(facet.field facet.query facet.pivot fq hl.fl)
 
   def initialize(constructor = {})
@@ -12,9 +15,6 @@ class Blacklight::Solr::Request < ActiveSupport::HashWithIndifferentAccess
     else
       super(constructor)
     end
-    ARRAY_KEYS.each do |key|
-      self[key] ||= []
-    end
   end
 
   def append_query(query)
@@ -49,26 +49,29 @@ class Blacklight::Solr::Request < ActiveSupport::HashWithIndifferentAccess
   end
 
   def append_filter_query(query)
+    self['fq'] ||= []
+    self['fq'] = Array(self['fq']) if self['fq'].is_a? String
+
     self['fq'] << query
   end
 
   def append_facet_fields(values)
+    self['facet.field'] ||= []
     self['facet.field'] += Array(values)
   end
 
   def append_facet_query(values)
+    self['facet.query'] ||= []
     self['facet.query'] += Array(values)
   end
 
   def append_facet_pivot(query)
+    self['facet.pivot'] ||= []
     self['facet.pivot'] << query
   end
 
   def append_highlight_field(query)
+    self['hl.fl'] ||= []
     self['hl.fl'] << query
   end
-
-  def to_hash
-    reject { |key, value| ARRAY_KEYS.include?(key) && value.blank? }
-  end
 end