blacklight 8.3.0 → 8.5.0

data/app/helpers/blacklight/document_helper_behavior.rb

@@ -31,11 +31,25 @@ module Blacklight::DocumentHelperBehavior
   # See: https://github.com/geoblacklight/geoblacklight/blob/7d3c31c7af3362879b97e2c1351a2496c728c59c/app/helpers/blacklight_helper.rb#L7
   #
   # @param [SolrDocument] document
+  # @deprecated
   # @return [String]
   def render_document_sidebar_partial(document)
+    unless @render_document_sidebar_partials_deprecation_warning_shown
+      partials = lookup_context.find_all('show_sidebar', lookup_context.prefixes, true, [], {})
+      unless partials.first.identifier.starts_with? Blacklight.root
+        Blacklight.deprecation.warn('The partial catalog/_show_sidebar.html.erb will not be rendered by #render_document_sidebar_partial in Blacklight 9.0.' \
+                                    'Configure blacklight_config.show.sidebar_component instead (default Blacklight::Search::SidebarComponent).')
+        @render_document_sidebar_partials_deprecation_warning_shown = true
+      end
+    end
+
     render 'show_sidebar', document: document
   end
 
+  Blacklight.deprecation.deprecate_methods(self,
+                                           render_document_sidebar_partial: 'has been replaced by calling the sidebar component (Blacklight::Search::SidebarComponent) directly. ' \
+                                                                            'Set sidebar_component in the view config.')
+
   ##
   # return the Bookmarks on a set of documents (all bookmarks on the page)
   # @private

data/app/javascript/blacklight/checkbox_submit.js

@@ -37,7 +37,9 @@ export default class CheckboxSubmit {
       this.labelTarget.removeAttribute('disabled')
       this.checkboxTarget.removeAttribute('disabled')
       this.updateStateFor(!this.checked)
-      document.querySelector('[data-role=bookmark-counter]').innerHTML = json.bookmarks.count
+      this.bookmarksCounter().forEach(counter => {
+        counter.innerHTML = json.bookmarks.count;
+      });
     }).catch((error) => {
       this.handleError(error)
     })
@@ -63,6 +65,10 @@ export default class CheckboxSubmit {
     return this.form.querySelector('[data-checkboxsubmit-target="span"]')
   }
 
+  bookmarksCounter() {
+    return document.querySelectorAll('[data-role="bookmark-counter"]')
+  }
+
   handleError() {
     alert("Unable to save the bookmark at this time.")
   }

data/app/javascript/blacklight/core.js

@@ -1,4 +1,4 @@
-const Blacklight = function() {
+const Core = function() {
   const buffer = new Array;
   return {
     onLoad: function(func) {
@@ -34,13 +34,13 @@ const Blacklight = function() {
 
 // turbolinks triggers page:load events on page transition
 // If app isn't using turbolinks, this event will never be triggered, no prob.
-Blacklight.listeners().forEach(function(listener) {
+Core.listeners().forEach(function(listener) {
   document.addEventListener(listener, function() {
-    Blacklight.activate()
+    Core.activate()
   })
 })
 
-Blacklight.onLoad(function () {
+Core.onLoad(function () {
   const elem = document.querySelector('.no-js');
 
   // The "no-js" class may already have been removed because this function is
@@ -52,4 +52,4 @@ Blacklight.onLoad(function () {
 })
 
 
-export default Blacklight
+export default Core

data/app/models/concerns/blacklight/document/semantic_fields.rb

@@ -31,7 +31,7 @@ module Blacklight::Document
     # but extensions should call super and modify hash returned, to avoid
     # unintentionally erasing values provided by other extensions.
     def to_semantic_values
-      @semantic_value_hash ||= self.class.field_semantics.each_with_object(Hash.new([])) do |(key, field_names), hash|
+      @semantic_value_hash ||= self.class.field_semantics.each_with_object(Hash.new { |hash, key| hash[key] = [] }) do |(key, field_names), hash|
         ##
         # Handles single string field_name or an array of field_names
         value = Array.wrap(field_names).map { |field_name| self[field_name] }.flatten.compact

data/app/presenters/blacklight/facet_checkbox_item_presenter.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetCheckboxItemPresenter < Blacklight::FacetItemPresenter
+    # Check if the query parameters have any inclusive facets with the given value
+    # @return [Boolean]
+    def selected?
+      search_state.filter(facet_config).values(except: [:filters, :missing]).flatten.include?(value)
+    end
+  end
+end

data/app/presenters/blacklight/facet_field_presenter.rb

@@ -19,7 +19,15 @@ module Blacklight
     end
 
     def active?
-      search_state.filter(facet_field).any?
+      if in_advanced_search?
+        search_state.filter(facet_field).values(except: [:filters, :missing]).any?
+      else
+        search_state.filter(facet_field).any?
+      end
+    end
+
+    def in_advanced_search?
+      search_state.params[:action] == "advanced_search"
     end
 
     def in_modal?

data/app/services/blacklight/search_service.rb

@@ -148,7 +148,15 @@ module Blacklight
               .merge(blacklight_config.fetch_many_document_params)
               .merge(extra_controller_params)
 
-      solr_response = repository.search(query)
+      # find_many was introduced in Blacklight 8.4. Before that, we used the
+      # regular search method (possibly with a find-many specific `qt` parameter).
+      # In order to support Repository implementations that may not have a find_many,
+      # we'll fall back to search if find_many isn't available.
+      solr_response = if repository.respond_to?(:find_many)
+                        repository.find_many(query)
+                      else
+                        repository.search(query)
+                      end
 
       solr_response.documents
     end

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

@@ -1,10 +1 @@
-<% if show_sort_and_per_page? %>
-  <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,
-    id: 'per_page-dropdown',
-    search_state: search_state,
-    selected: current_per_page,
-    interpolation: :count)) %>
-<% end %>
+<%= render Blacklight::Search::PerPageComponent.new(search_state:, blacklight_config:, response: @response) %>

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

@@ -8,7 +8,7 @@
 <% end %>
 
 <% content_for(:skip_links) do -%>
-    <%= link_to t('blacklight.skip_links.first_result'), '#documents', class: 'element-invisible element-focusable rounded-bottom py-2 px-3', data: { turbolinks: 'false' } %>
+    <%= link_to t('blacklight.skip_links.first_result'), '#documents', class: 'd-inline-flex p-2 m-1', data: { turbolinks: 'false' } %>
 <% end %>
 
 <% content_for(:container_header) do -%>

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

@@ -1,4 +1,4 @@
-<%= render blacklight_config.track_search_session.item_pagination_component.new(search_context: @search_context, search_session: search_session, current_document: @document) if blacklight_config.track_search_session.item_pagination_component %>
+<%= render blacklight_config.view_config(:show).document_header_component.new(document: @document, search_context: @search_context, search_session: search_session) %>
 <% @page_title = t('blacklight.search.show.title', document_title: document_presenter(@document).html_title, application_name: application_name).html_safe %>
 <% content_for(:head) { render_link_rel_alternates } %>
 

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

@@ -1,2 +1,3 @@
+<% Blacklight.deprecation.warn('The partial catalog/_show_sidebar.html.erb will be removed in Blacklight 9.0. Configure blacklight_config.show.sidebar_component instead (default Blacklight::Search::SidebarComponent).') unless local_assigns[:silence_deprecation] %>
 <% presenter = document_presenter(document) %>
 <%= render presenter.view_config.sidebar_component.new(presenter: presenter) %>

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

@@ -1,7 +1,7 @@
-<%= render blacklight_config.track_search_session.applied_params_component.new if blacklight_config.track_search_session.applied_params_component %>
-
 <%= render 'show_main_content' %>
 
 <% content_for(:sidebar) do %>
-  <%= render_document_sidebar_partial @document %>
+  <% Blacklight.deprecation.silence do %>
+    <%= render_document_sidebar_partial @document %>
+  <% end %>
 <% end %>

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

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

data/app/views/kaminari/blacklight/_page.html.erb

@@ -8,12 +8,18 @@
     remote:        data-remote
 -%>
 <% page_display = number_with_delimiter(page.to_s) %>
-
-<li class="page-item <%= 'active' if page.current? %>">
-  <% if page.current? %>
-    <span class="page-link" aria-current="true"><%= page_display %><span class="sr-only visually-hidden"> <%= t('views.pagination.aria.current_page', page: page_display) %></span></span>
-  <% else %>
-    <%= link_to page_display, url, :remote => remote, :rel => page.next? ? 'next' : page.prev? ? 'prev' : nil, class: 'page-link', aria: { label: t('views.pagination.aria.go_to_page', page: page_display) } %>
+<% link_attrs = {
+                  remote: remote,
+                  rel: page.next? ? 'next' : page.prev? ? 'prev' : nil,
+                  class: 'page-link',
+                }
+%>
+<% if page.current? %>
+  <%= tag.li class: class_names('page-item', 'active'), aria_current: 'page'  do %>
+    <%= link_to page_display, url, link_attrs.merge(aria: { label:  t('views.pagination.aria.current_page', page: page_display) }) %>
   <% end %>
-</li>
-
+<% else %>
+  <%= tag.li class: 'page-item' do %>
+    <%= link_to page_display, url, link_attrs.merge(aria: { label:  t('views.pagination.aria.go_to_page', page: page_display) }) %>
+  <% end %>
+<% end %>

data/app/views/kaminari/blacklight/_paginator.html.erb

@@ -11,7 +11,7 @@
 <%= paginator.render do -%>
   <ul class="pagination">
     <%= prev_page_tag %>
-    <%= next_page_tag  %>
+    <%= next_page_tag if Blacklight::Engine.config.blacklight.paginator[:next_page_position] == :before %>
     <% each_relevant_page do |page| -%>
       <% if page.left_outer? || page.right_outer? || page.inside_window? -%>
         <%= page_tag page %>
@@ -19,5 +19,6 @@
         <%= gap_tag %>
       <% end -%>
     <% end -%>  
+    <%= next_page_tag if Blacklight::Engine.config.blacklight.paginator[:next_page_position] == :after %>
   </ul>
 <% end -%>

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

@@ -18,7 +18,6 @@
       <%= 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' %>
       <script type="module">
         import githubAutoCompleteElement from 'https://cdn.skypack.dev/@github/auto-complete-element';
       </script>
@@ -28,11 +27,10 @@
     <%= content_for(:head) %>
   </head>
   <body class="<%= render_body_class %>">
-    <nav id="skip-link" role="navigation" aria-label="<%= t('blacklight.skip_links.label') %>">
-      <%= link_to t('blacklight.skip_links.search_field'), '#search_field', class: 'element-invisible element-focusable rounded-bottom py-2 px-3', data: { turbolinks: 'false' } %>
-      <%= link_to t('blacklight.skip_links.main_content'), '#main-container', class: 'element-invisible element-focusable rounded-bottom py-2 px-3', data: { turbolinks: 'false' } %>
+    <%= render blacklight_config.skip_link_component.new do %>
       <%= content_for(:skip_links) %>
-    </nav>
+    <% end %>
+
     <%= render partial: 'shared/header_navbar' %>
 
     <main id="main-container" class="<%= container_classes %>" role="main" aria-label="<%= t('blacklight.main.aria.main_container') %>">

data/blacklight.gemspec

@@ -31,10 +31,11 @@ Gem::Specification.new do |s|
   s.add_dependency "kaminari", ">= 0.15" # the pagination (page 1,2,3, etc..) of our search results
   s.add_dependency "i18n", '>= 1.7.0' # added named parameters
   s.add_dependency "ostruct", '>= 0.3.2'
-  s.add_dependency "view_component", '>= 2.66', '< 4'
+  s.add_dependency "view_component", '>= 2.74', '< 4'
+  s.add_dependency "zeitwerk"
 
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.
-  s.add_development_dependency "rspec-rails", "~> 6.1"
+  s.add_development_dependency "rspec-rails", ">= 6.1", "< 8"
   s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
   s.add_development_dependency 'axe-core-rspec'
   s.add_development_dependency "capybara", '~> 3'
@@ -45,6 +46,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rubocop", '~> 1.0'
   s.add_development_dependency "rubocop-rails"
   s.add_development_dependency "rubocop-rspec"
+  s.add_development_dependency "rubocop-capybara"
+  s.add_development_dependency "rubocop-rspec_rails"
+  s.add_development_dependency "rubocop-factory_bot"
   s.add_development_dependency "i18n-tasks"
   s.add_development_dependency "solr_wrapper"
 end

data/{docker-compose.yml → compose.yaml}

@@ -7,7 +7,7 @@ services:
         - ALPINE_RUBY_VERSION
     # mounting . is causing seg-fault on macosx
     #volumes:
-      #- .:/app
+    #- .:/app
     depends_on:
       - solr
     ports:

data/config/locales/blacklight.ar.yml

@@ -215,6 +215,9 @@ ar:
       email: بريد إلكتروني
       sms: إرسله كرسالة نصية قصيرة
       title: أدوات
+    top_navbar:
+      aria:
+        container_label: التنقل الرئيسي
     welcome: مرحبًا!
   views:
     pagination:

data/config/locales/blacklight.de.yml

@@ -202,6 +202,9 @@ de:
       email: E-Mail
       sms: SMS
       title: Werkzeuge
+    top_navbar:
+      aria:
+        container_label: Hauptnavigation
     welcome: Willkommen!
   views:
     pagination: