blacklight 9.0.0.beta1 → 9.0.0.beta3

data/app/javascript/blacklight-frontend/checkbox_submit.js

@@ -36,10 +36,16 @@ export default class CheckboxSubmit {
     }).then((json) => {
       this.labelTarget.removeAttribute('disabled')
       this.checkboxTarget.removeAttribute('disabled')
+      // For accessibility return keyboard focus 
+      // back to the checkbox after form submission
+      this.checkboxTarget.focus()
       this.updateStateFor(!this.checked)
       this.bookmarksCounter().forEach(counter => {
         counter.innerHTML = json.bookmarks.count;
       });
+
+      var e = new CustomEvent('bookmark.blacklight', { detail: { checked: !this.checked } });
+      window.dispatchEvent(e)
     }).catch((error) => {
       this.handleError(error)
     })
@@ -74,7 +80,8 @@ export default class CheckboxSubmit {
   }
 
   updateStateFor(state) {
-    this.checkboxTarget.checked = state
+    if (state) { this.checkboxTarget.setAttribute('checked', state) }
+    else { this.checkboxTarget.removeAttribute('checked') }
 
     if (state) {
       this.labelTarget.classList.add('checked')

data/app/javascript/blacklight-frontend/debounce.js

@@ -3,7 +3,7 @@
 // const basicFunction = (entry) => console.log(entry)
 // const debounced = debounce(basicFunction("I should only be called once"));
 //
-// debounced // does NOT print to the screen becase it is invoked again less than 200 milliseconds later
+// debounced // does NOT print to the screen because it is invoked again less than 200 milliseconds later
 // debounced // does print to the screen
 // ```
 export default function debounce(func, timeout = 200) {

data/app/javascript/blacklight-frontend/facet_suggest.js

@@ -4,20 +4,40 @@ const FacetSuggest = async (e) => {
   if (e.target.matches('.facet-suggest')) {
     const queryFragment = e.target.value?.trim();
     const facetField = e.target.dataset.facetField;
+    const facetArea = document.querySelector('.facet-extended-list');
+    const prevNextLinks = document.querySelectorAll('.prev_next_links');
+
     if (!facetField) { return; }
 
-    const urlToFetch = `/catalog/facet_suggest/${facetField}/${queryFragment}${window.location.search}`
+    // Get the search params from the current query so the facet suggestions
+    // can retain that context.
+    const facetSearchContext = e.target.dataset.facetSearchContext;
+    const url = new URL(facetSearchContext, window.location.origin);
+
+    // Drop facet.page so a filtered suggestion list will always start on page 1
+    url.searchParams.delete('facet.page');
+    const facetSearchParams = url.searchParams.toString();
+
+    const urlToFetch = `/catalog/facet_suggest/${facetField}/${queryFragment}?${facetSearchParams}`;
+
     const response = await fetch(urlToFetch);
     if (response.ok) {
         const blob = await response.blob()
         const text = await blob.text()
 
-        const facetArea = document.querySelector('.facet-extended-list');
-
         if (text && facetArea) {
             facetArea.innerHTML = text
         }
     }
+
+    // Hide the prev/next links when a user enters text in the facet
+    // suggestion input. They don't work with a filtered list.
+    prevNextLinks.forEach(element => {
+      element.classList.toggle('invisible', !!queryFragment);
+    });
+
+    // Add a class to distinguish suggested facet values vs. regular.
+    facetArea.classList.toggle('facet-suggestions', !!queryFragment);
   }
 };
 

data/app/javascript/blacklight-frontend/index.js

@@ -2,7 +2,6 @@ import BookmarkToggle from 'blacklight-frontend/bookmark_toggle'
 import ButtonFocus from 'blacklight-frontend/button_focus'
 import FacetSuggest from 'blacklight-frontend/facet_suggest'
 import Modal from 'blacklight-frontend/modal'
-import ModalForm from 'blacklight-frontend/modalForm'
 import SearchContext from 'blacklight-frontend/search_context'
 import Core from 'blacklight-frontend/core'
 
@@ -11,7 +10,6 @@ export default {
   ButtonFocus,
   FacetSuggest,
   Modal,
-  ModalForm,
   SearchContext,
   Core,
   onLoad: Core.onLoad

data/app/javascript/blacklight-frontend/modal.js

@@ -56,9 +56,6 @@
 const Modal = (() => {
   const modal = {}
 
-  // bootstrap class that will stop body scrolling when modal is open
-  const bootstrapBodyClassOpen = "modal-open";
-
   // a Bootstrap modal div that should be already on the page hidden
   modal.modalSelector = '#blacklight-modal';
 
@@ -84,8 +81,7 @@ const Modal = (() => {
 
       const contents = `<div class="modal-header">
         <div class="modal-title">There was a problem with your request.</div>
-        <button type="button" class="blacklight-modal-close btn-close close" data-bl-dismiss="modal" aria-label="Close">
-          <span aria-hidden="true" class="visually-hidden">&times;</span>
+        <button type="button" class="blacklight-modal-close btn-close" data-bl-dismiss="modal" aria-label="Close">
         </button>
         </div>
         <div class="modal-body">
@@ -137,7 +133,7 @@ const Modal = (() => {
 
   modal.modalAjaxLinkClick = function(e) {
     e.preventDefault();
-    const href = e.target.getAttribute('href')
+    const href = e.target.closest('a').getAttribute('href')
     fetch(href)
       .then(response => {
          if (!response.ok) {

data/app/javascript/blacklight-frontend/search_context.js

@@ -1,6 +1,7 @@
 const SearchContext = (e) => {
-  if (e.target.matches('[data-context-href]')) {
-    SearchContext.handleSearchContextMethod.call(e.target, e)
+  const contextLink = e.target.closest('[data-context-href]')
+  if (contextLink) {
+    SearchContext.handleSearchContextMethod.call(contextLink, e)
   }
 }
 

data/app/models/facet_search_builder.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class FacetSearchBuilder < Blacklight::FacetSearchBuilder
+  include Blacklight::Solr::FacetSearchBuilderBehavior
+end

data/app/presenters/blacklight/facet_field_presenter.rb

@@ -4,7 +4,7 @@ module Blacklight
   class FacetFieldPresenter
     attr_reader :facet_field, :display_facet, :view_context, :search_state
 
-    delegate :key, to: :facet_field
+    delegate :key, :suggest, to: :facet_field
     delegate :field_name, to: :display_facet
 
     def initialize(facet_field, display_facet, view_context, search_state = view_context.search_state)

data/app/presenters/blacklight/json_presenter.rb

@@ -11,11 +11,9 @@ module Blacklight
 
     attr_reader :blacklight_config
 
-    delegate :facet_field_names, :facet_configuration_for_field, to: :blacklight_config
+    delegate :facet_fields, :facet_configuration_for_field, to: :blacklight_config
 
-    def documents
-      @response.documents
-    end
+    delegate :documents, to: :@response
 
     # @return [Array<Blacklight::Solr::Response::Facets::FacetField>]
     def search_facets
@@ -25,6 +23,12 @@ module Blacklight
         .select { |display_facet| display_facet.items.present? }
     end
 
+    # NOTE: we don't use the facet_field_names method in Blacklight::Configuration because that
+    # only returns the field names of the group where the name is nil.
+    def facet_field_names
+      facet_fields.values.map(&:field)
+    end
+
     # extract the pagination info from the response object
     def pagination_info
       h = {}

data/app/presenters/blacklight/rendering/helper_method.rb

@@ -15,10 +15,10 @@ module Blacklight
 
       def render_helper
         context.send(config.helper_method,
-                     **options.merge(document: document,
-                                     field: config.field,
-                                     config: config,
-                                     value: values))
+                     **options, document: document,
+                                field: config.field,
+                                config: config,
+                                value: values)
       end
     end
   end

data/app/presenters/blacklight/rendering/join.rb

@@ -16,8 +16,8 @@ module Blacklight
 
       private
 
-      def html_escape(*args)
-        ERB::Util.html_escape(*args)
+      def html_escape(*)
+        ERB::Util.html_escape(*)
       end
     end
   end

data/app/services/blacklight/facet_search_service.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# FacetSearchService returns a facet list from the repository. This is for drawing the "more facets" modal
+module Blacklight
+  class FacetSearchService
+    def initialize(config:, search_state:, search_builder_class: config.facet_search_builder_class, **context)
+      @blacklight_config = config
+      @search_state = search_state
+      @user_params = @search_state.params
+      @search_builder_class = search_builder_class
+      @context = context
+    end
+
+    # The blacklight_config + controller are accessed by the search_builder
+    attr_reader :blacklight_config, :context
+
+    def search_builder
+      search_builder_class.new(self)
+    end
+
+    def search_state_class
+      @search_state.class
+    end
+
+    ##
+    # Get the solr response when retrieving only a single facet field
+    # @return [Blacklight::Solr::Response] the solr response
+    def facet_field_response(facet_field, extra_controller_params = {})
+      query = search_builder.with(search_state).facet(facet_field)
+      repository.search(params: query.merge(extra_controller_params))
+    end
+
+    def facet_suggest_response(facet_field, facet_suggestion_query, extra_controller_params = {})
+      query = search_builder.with(search_state).facet(facet_field).facet_suggestion_query(facet_suggestion_query)
+      repository.search(params: query.merge(extra_controller_params))
+    end
+
+    private
+
+    attr_reader :search_builder_class, :search_state
+
+    delegate :repository, to: :blacklight_config
+  end
+end

data/app/services/blacklight/field_retriever.rb

@@ -41,7 +41,7 @@ module Blacklight
 
     def retrieve_simple
       # regular document field
-      if field_config.default && field_config.default.is_a?(Proc)
+      if field_config.default.is_a?(Proc)
         document.fetch(field_config.field, &field_config.default)
       else
         document.fetch(field_config.field, field_config.default)

data/app/services/blacklight/search_service.rb

@@ -3,9 +3,9 @@
 # SearchService returns search results from the repository
 module Blacklight
   class SearchService
-    def initialize(config:, search_state: nil, user_params: nil, search_builder_class: config.search_builder_class, **context)
+    def initialize(config:, search_state:, search_builder_class: config.search_builder_class, **context)
       @blacklight_config = config
-      @search_state = search_state || Blacklight::SearchState.new(user_params || {}, config)
+      @search_state = search_state
       @user_params = @search_state.params
       @search_builder_class = search_builder_class
       @context = context
@@ -31,7 +31,7 @@ module Blacklight
       builder.rows = search_state.per_page
 
       builder = yield(builder) if block_given?
-      response = repository.search(builder)
+      response = repository.search(params: builder)
 
       if response.grouped? && grouped_key_for_results
         response.group(grouped_key_for_results)
@@ -59,12 +59,12 @@ module Blacklight
     # @return [Blacklight::Solr::Response] the solr response
     def facet_field_response(facet_field, extra_controller_params = {})
       query = search_builder.with(search_state).facet(facet_field)
-      repository.search(query.merge(extra_controller_params))
+      repository.search(params: query.merge(extra_controller_params))
     end
 
     def facet_suggest_response(facet_field, facet_suggestion_query, extra_controller_params = {})
       query = search_builder.with(search_state).facet(facet_field).facet_suggestion_query(facet_suggestion_query)
-      repository.search(query.merge(extra_controller_params))
+      repository.search(params: query.merge(extra_controller_params))
     end
 
     # Get the previous and next document from a search result
@@ -73,7 +73,7 @@ module Blacklight
       p = previous_and_next_document_params(index)
       new_state = request_params.is_a?(Blacklight::SearchState) ? request_params : Blacklight::SearchState.new(request_params, blacklight_config)
       query = search_builder.with(new_state).start(p.delete(:start)).rows(p.delete(:rows)).merge(extra_controller_params).merge(p)
-      response = repository.search(query)
+      response = repository.search(params: query)
       document_list = response.documents
 
       # only get the previous doc if there is one

data/app/values/blacklight/types.rb

@@ -95,8 +95,8 @@ module Blacklight
     end
 
     class Selector < Array
-      def initialize(by: nil, block: nil, **kwargs)
-        super(**kwargs)
+      def initialize(by: nil, block: nil, **)
+        super(**)
         @by = by
         @block = block
       end

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

@@ -1,3 +1,3 @@
-<%= render(Blacklight::FacetFieldListComponent.new(
+<%= render(Blacklight::Facets::ListComponent.new(
       facet_field: facet_field_presenter(facet_field.merge(item_component: Blacklight::FacetItemPivotComponent), display_facet),
       layout: false)) %>

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

@@ -1,5 +1,5 @@
-<div class="jumbotron text-center p-5 mb-4 bg-light rounded-3">
-  <h1 class="jumbotron-heading"><%= t('blacklight.welcome') %></h1>
+<div class="text-center p-5 mb-4 bg-light rounded-3">
+  <h1 class="fw-bold"><%= t('blacklight.welcome') %></h1>
 
   <p class="lead">Blacklight is a multi-institutional open-source collaboration building a better discovery platform framework.</p>
 

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

@@ -1,4 +1,4 @@
-<div id="sortAndPerPage" class="sort-pagination pb-3 d-md-flex justify-content-between" role="navigation" aria-label="<%= t('blacklight.search.per_page.aria_label')%>">
+<div id="sortAndPerPage" class="sort-pagination pb-3 mb-3 d-md-flex justify-content-between" role="navigation" aria-label="<%= t('blacklight.search.per_page.aria_label')%>">
   <%= render partial: "paginate_compact", object: @response if show_pagination? %>
   <%= render_results_collection_tools wrapping_class: "search-widgets" %>
 </div>

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

@@ -1,14 +1,12 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.with_prefix do %>
-    <div class="facet-pagination top d-flex w-100 justify-content-between">
-      <%= render :partial=>'facet_pagination' %>
-    </div>
-  <% end %>
-
   <% component.with_title { facet_field_label(@facet.key) } %>
-  <%= render Blacklight::Search::FacetSuggestInput.new(facet: @facet, presenter: @presenter) %>
+  <% view_config = blacklight_config.view_config(document_index_view_type) %>
 
-  <%= render partial: 'facet_index_navigation' if @facet.index_range && @display_facet.index? %>
+  <%= render view_config.facet_filters_component.new(presenter: @presenter) %>
+
+  <div class="facet-pagination top d-flex flex-wrap w-100 justify-content-between border-bottom pb-3 mb-3">
+    <%= render view_config.facet_pagination_component.new(facet_field: @presenter) %>
+  </div>
 
   <div class="facet-extended-list">
     <%= render Blacklight::FacetComponent.new(display_facet: @display_facet,
@@ -17,8 +15,8 @@
   </div>
 
   <% component.with_footer do %>
-    <div class="facet-pagination bottom flex-row justify-content-between">
-      <%= render :partial=>'facet_pagination' %>
+    <div class="facet-pagination bottom d-flex flex-wrap w-100 justify-content-between">
+      <%= render view_config.facet_pagination_component.new(facet_field: @presenter) %>
     </div>
   <% end %>
 <% end %>

data/config/locales/blacklight.ar.yml

@@ -36,29 +36,29 @@ ar:
       apa: الجمعية الأمريكية لعلم النفس APA
       chicago: شيكاغو
       mla: جمعية اللغة الحديثة MLA
-    did_you_mean: 'هل كنت تقصد كتابة: %{options}؟'
+    did_you_mean: "هل كنت تقصد كتابة: %{options}؟"
     email:
       errors:
         to:
           blank: يجب إدخال مُستلم من أجل إرسال هذه الرسالة
           invalid: يجب إدخال عنوان بريد إلكتروني صحيح
       form:
-        message: 'الرسالة:'
+        message: "الرسالة:"
         submit: إرسال
         title: إرسله عبرالبريد الإلكتروني
-        to: 'بريد إلكتروني:'
+        to: "بريد إلكتروني:"
       success: تم إرسال البريد الإلكتروني
       text:
         default_title: لا يوجد
-        message: 'الرسالة: %{message}'
+        message: "الرسالة: %{message}"
         subject:
           few: سجلات المادة
           many: سجلات المادة
-          one: 'سجل المادة: %{title}'
+          one: "سجل المادة: %{title}"
           other: سجلات المادة
           two: سجلان للمادة
           zero: لا يوجد سجل للمادة
-        url: 'الرابط: %{url}'
+        url: "الرابط: %{url}"
     entry_name:
       default: إدخال
       grouped:
@@ -112,15 +112,15 @@ ar:
           count: ترتيب رقمي
           index: ترتيب أبجدي
         suggest:
-          label: Filter %{field_label}
-          placeholder: Filter...
+          label: الفلتر %{field_label}
+          placeholder: فلتر...
         title: تحديد نطاق البحث
       filters:
         label: "%{label}:"
         remove:
-          label_value: 'إزالة القيد %{label}: %{value}'
+          label_value: "إزالة القيد %{label}: %{value}"
           value: إزالة القيد %{value}
-        title: 'لقد بحثت عن:'
+        title: "لقد بحثت عن:"
       form:
         search:
           label: ابحث عن
@@ -139,6 +139,7 @@ ar:
         constraint: "%{label}: %{value}"
         many_constraint_values: تم تحديد %{values}
         title: "%{constraints} - %{application_name} نتائج البحث"
+        joiner: " / "
       pagination:
         title: تصفح النتائج
       pagination_info:
@@ -171,7 +172,7 @@ ar:
       start_over: البدء من جديد
       view:
         list: قائمة
-      view_title: 'عرض النتائج ك: '
+      view_title: "عرض النتائج ك: "
       zero_results:
         modify_search: حاول تعديل معايير البحث
         search_everything: حاول البحث عن كل شيء
@@ -208,10 +209,10 @@ ar:
         carrier_prompt: يرجى تحديد شركة الاتصالات
         submit: إرسال
         title: إرسله كرسالة نصية قصيرة
-        to: 'رقم الهاتف:'
+        to: "رقم الهاتف:"
       success: تم الإرسال كرسالة نصية قصيرة
       text:
-        url: 'الرابط: %{url}'
+        url: "الرابط: %{url}"
     tools:
       citation: استشهاد مرجعي
       clear: مسح

data/config/locales/blacklight.ca.yml

@@ -134,6 +134,7 @@ ca:
         title: "%{constraints} - %{application_name} Resultats de la cerca"
         constraint: "%{label}: %{value}"
         many_constraint_values: "%{values} seleccionat"
+        joiner: " / "
       header: "Cerca"
       search_constraints_header: "Filtres de la cerca"
       search_results: "Resultats de la cerca"

data/config/locales/blacklight.de.yml

@@ -32,25 +32,25 @@ de:
       apa: APA
       chicago: Chicago
       mla: MLA
-    did_you_mean: 'Meinten Sie: %{options}?'
+    did_you_mean: "Meinten Sie: %{options}?"
     email:
       errors:
         to:
           blank: Sie müssen einen Empfänger eingeben, um diese Mitteilung zu schicken
           invalid: Sie müssen eine gültige E-Mail-Addresse eingeben
       form:
-        message: 'Nachricht:'
+        message: "Nachricht:"
         submit: Senden
         title: E-Mail
-        to: 'E-Mail-Adresse:'
+        to: "E-Mail-Adresse:"
       success: E-Mail verschickt
       text:
         default_title: N/A
-        message: 'Mitteilung: %{message}'
+        message: "Mitteilung: %{message}"
         subject:
-          one: 'Artikeldatensatz: %{title}'
+          one: "Artikeldatensatz: %{title}"
           other: Artikeldatensätze
-        url: 'URL: %{url}'
+        url: "URL: %{url}"
     entry_name:
       default:
         one: Eintrag
@@ -92,7 +92,7 @@ de:
           close: Facetten ausblenden
           open: Facetten zeigen
         missing:
-        - fehlt
+          - fehlt
         more_html: mehr <span class="visually-hidden">%{field_name}</span> »
         pivot:
           hide: Schließen
@@ -109,9 +109,9 @@ de:
       filters:
         label: "%{label}:"
         remove:
-          label_value: 'Filter %{label}: %{value} entfernen'
+          label_value: "Filter %{label}: %{value} entfernen"
           value: Filter %{value} entfernen
-        title: 'Sie suchten nach:'
+        title: "Sie suchten nach:"
       form:
         search:
           label: suchen nach
@@ -130,6 +130,7 @@ de:
         constraint: "%{label}: %{value}"
         many_constraint_values: "%{values} ausgewählt"
         title: "%{constraints} - %{application_name} Suchergebnisse"
+        joiner: " / "
       pagination:
         title: Ergebnisse Navigation
       pagination_info:
@@ -158,7 +159,7 @@ de:
       start_over: Neu anfangen
       view:
         list: Liste
-      view_title: 'Ergebnisse ansehen als: '
+      view_title: "Ergebnisse ansehen als: "
       zero_results:
         modify_search: Ändern Sie Ihre Suche
         search_everything: Suchen Sie nach allem
@@ -195,10 +196,10 @@ de:
         carrier_prompt: Bitte wählen Sie Ihren Netzbetreiber aus
         submit: Schicken
         title: SMS
-        to: 'Telefonnummer:'
+        to: "Telefonnummer:"
       success: SMS verschickt
       text:
-        url: 'Link: %{url}'
+        url: "Link: %{url}"
     tools:
       citation: Zitieren
       clear: Löschen

data/config/locales/blacklight.en.yml

@@ -148,6 +148,7 @@ en:
         constraint: "%{label}: %{value}"
         many_constraint_values: "%{values} selected"
         title: "%{constraints} - %{application_name} Search Results"
+        joiner: " / "
       pagination:
         title: Results navigation
       pagination_info:

data/config/locales/blacklight.es.yml

@@ -39,18 +39,18 @@ es:
           blank: Debe introducir un destinatario para enviar este mensaje
           invalid: Debe entrar un email válido
       form:
-        message: 'Mensaje:'
+        message: "Mensaje:"
         submit: Enviar
         title: Enviar
-        to: 'Email:'
+        to: "Email:"
       success: Email enviado
       text:
         default_title: N/A
-        message: 'Mensaje: %{message}'
+        message: "Mensaje: %{message}"
         subject:
-          one: 'Ficha artículo: %{title}'
+          one: "Ficha artículo: %{title}"
           other: Ficha artículos
-        url: 'URL: %{url}'
+        url: "URL: %{url}"
     entry_name:
       default:
         one: entrada
@@ -102,15 +102,15 @@ es:
           count: Ordenación numérica
           index: Ordenación A-Z
         suggest:
-          label: Filter %{field_label}
-          placeholder: Filter...
+          label: Filtro %{field_label}
+          placeholder: Filtrar...
         title: Limite su búsqueda
       filters:
         label: "%{label}:"
         remove:
-          label_value: 'Eliminar la restricción%{label}: %{value}'
+          label_value: "Eliminar la restricción%{label}: %{value}"
           value: Eliminar la restricción %{value}
-        title: 'Usted ha buscado:'
+        title: "Usted ha buscado:"
       form:
         search:
           label: buscar
@@ -129,6 +129,7 @@ es:
         constraint: "%{label}: %{value}"
         many_constraint_values: "%{values} seleccionado"
         title: "%{constraints} - %{application_name} Resultados de la búsqueda"
+        joiner: " / "
       pagination:
         title: Resultados de navegación
       pagination_info:
@@ -157,7 +158,7 @@ es:
       start_over: Volver a empezar
       view:
         list: Lista
-      view_title: 'Ver Resultados por: '
+      view_title: "Ver Resultados por: "
       zero_results:
         modify_search: Intente modificar su búsqueda
         search_everything: Pruebe a buscar de todo
@@ -194,10 +195,10 @@ es:
         carrier_prompt: Por favor, seleccione su compañía telefónica
         submit: Enviar
         title: Enviar SMS
-        to: 'Número de teléfono:'
+        to: "Número de teléfono:"
       success: SMS enviado
       text:
-        url: 'Link: %{url}'
+        url: "Link: %{url}"
     tools:
       citation: Cité
       clear: Borrar