blacklight 8.9.0 → 9.0.0.beta1

data/app/helpers/blacklight/document_helper_behavior.rb

@@ -24,32 +24,6 @@ module Blacklight::DocumentHelperBehavior
     'blacklight-'
   end
 
-  ##
-  # Render the sidebar partial for a document
-  # This is used as an integration point by downstream apps to add to the
-  # default sidebar.
-  # 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/helpers/blacklight/icon_helper_behavior.rb

@@ -4,18 +4,10 @@
 # Module to help generate icon helpers for SVG images
 module Blacklight::IconHelperBehavior
   ##
-  # Returns the raw SVG (String) for a Blacklight Icon located in
-  # app/assets/images/blacklight/*.svg. Caches them so we don't have to look up
-  # the svg everytime.
+  # Returns the raw SVG (String) for a Blacklight Icon
   # @param [String, Symbol] icon_name
   # @return [String]
   def blacklight_icon(icon_name, **kwargs)
     render "Blacklight::Icons::#{icon_name.to_s.camelize}Component".constantize.new(**kwargs)
-  rescue NameError
-    Blacklight.deprecation.warn(
-      "Falling back on the LegacyIconComponent with \"#{icon_name}\" is deprecated. Instead create the component `Blacklight::Icons::#{icon_name.to_s.camelize}Component` for this icon."
-    )
-
-    render Blacklight::Icons::LegacyIconComponent.new(name: icon_name, **kwargs)
   end
 end

data/app/helpers/blacklight/layout_helper_behavior.rb

@@ -55,8 +55,8 @@ module Blacklight
     #
     # @param [Hash] options
     # @return [String]
-    def render_nav_actions(options = {}, &block)
-      render_filtered_partials(blacklight_config.navbar.partials, options, &block)
+    def render_nav_actions(options = {}, &)
+      render_filtered_partials(blacklight_config.navbar.partials, options, &)
     end
 
     ##

data/app/helpers/blacklight/render_partials_helper_behavior.rb

@@ -11,20 +11,6 @@ module Blacklight::RenderPartialsHelperBehavior
     render_document_index_with_view(document_index_view_type, documents, locals)
   end
 
-  ##
-  # Return the list of partials for a given solr document
-  # @param [SolrDocument] doc solr document to render partials for
-  # @param [Array<String>] partials list of partials to render
-  # @param [Hash] locals local variables to pass to the render call
-  # @return [String]
-  def render_document_partials(doc, partials = [], locals = {})
-    safe_join(partials.map do |action_name|
-      render_document_partial(doc, action_name, locals)
-    end, "\n")
-  end
-  Blacklight.deprecation.deprecate_methods(self, render_document_partials: 'Replace this call with: "document_component = blacklight_config.view_config(:atom).summary_component
-render document_component.new(presenter: document_presenter(document), component: :div, show: true)"')
-
   ##
   # Return the list of xml for a given solr document. Doesn't safely escape for HTML.
   # @param [SolrDocument] doc solr document to render partials for

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -114,6 +114,6 @@ module Blacklight::UrlHelperBehavior
   # Use in e.g. the search history display, where we want something more like text instead of the normal constraints
   def link_to_previous_search(params)
     search_state = controller.search_state_class.new(params, blacklight_config, self)
-    link_to(render(Blacklight::ConstraintsComponent.for_search_history(search_state: search_state)), search_action_path(params))
+    link_to(render(Blacklight::ConstraintsComponent.for_search_history(search_state: search_state, classes: 'clearfix constraints-container mb-0')), search_action_path(params))
   end
 end

data/app/javascript/{blacklight → blacklight-frontend}/bookmark_toggle.js

@@ -1,4 +1,4 @@
-import CheckboxSubmit from 'blacklight/checkbox_submit'
+import CheckboxSubmit from 'blacklight-frontend/checkbox_submit'
 
 const BookmarkToggle = (e) => {
   if (e.target.matches('[data-checkboxsubmit-target="checkbox"]')) {

data/app/javascript/{blacklight → blacklight-frontend}/core.js

@@ -15,14 +15,6 @@ const Core = function() {
       const listeners = [];
       if (typeof Turbo !== 'undefined') {
         listeners.push('turbo:load', 'turbo:frame-load');
-      } else if (typeof Turbolinks !== 'undefined' && Turbolinks.supported) {
-        // Turbolinks 5
-        if (Turbolinks.BrowserAdapter) {
-          listeners.push('turbolinks:load');
-        } else {
-          // Turbolinks < 5
-          listeners.push('page:load', 'DOMContentLoaded');
-        }
       } else {
         listeners.push('DOMContentLoaded');
       }
@@ -32,8 +24,8 @@ const Core = function() {
   };
 }();
 
-// turbolinks triggers page:load events on page transition
-// If app isn't using turbolinks, this event will never be triggered, no prob.
+// turbo triggers turbo:load events on page transition
+// If app isn't using turbo, this event will never be triggered, no prob.
 Core.listeners().forEach(function(listener) {
   document.addEventListener(listener, function() {
     Core.activate()

data/app/javascript/{blacklight → 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 because it is invoked again less than 200 milliseconds later
+// debounced // does NOT print to the screen becase 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

@@ -0,0 +1,26 @@
+import debounce from "blacklight-frontend/debounce";
+
+const FacetSuggest = async (e) => {
+  if (e.target.matches('.facet-suggest')) {
+    const queryFragment = e.target.value?.trim();
+    const facetField = e.target.dataset.facetField;
+    if (!facetField) { return; }
+
+    const urlToFetch = `/catalog/facet_suggest/${facetField}/${queryFragment}${window.location.search}`
+    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
+        }
+    }
+  }
+};
+
+document.addEventListener('input', debounce(FacetSuggest));
+
+export default FacetSuggest

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

@@ -0,0 +1,18 @@
+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'
+
+export default {
+  BookmarkToggle,
+  ButtonFocus,
+  FacetSuggest,
+  Modal,
+  ModalForm,
+  SearchContext,
+  Core,
+  onLoad: Core.onLoad
+}

data/app/javascript/{blacklight → blacklight-frontend}/modal.js

@@ -113,7 +113,7 @@ const Modal = (() => {
     }
     elements.forEach((el) => frag.appendChild(el))
     modal.activateScripts(frag)
-    
+
     modal.target().querySelector('.modal-content').replaceChildren(frag)
 
     // send custom event with the modal dialog div as the target
@@ -122,7 +122,6 @@ const Modal = (() => {
 
     // if they did preventDefault, don't show the dialog
     if (e.defaultPrevented) return;
-
     modal.show();
   };
 

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

@@ -31,17 +31,6 @@ module Blacklight::Document
     class_attribute :inspector_fields, default: [:_source]
   end
 
-  Email = Module.new do
-    def self.included(mod)
-      Blacklight.deprecation.warn("Blacklight::Document::Email is deprecated and will be removed (included in #{mod}).")
-    end
-  end
-  Sms = Module.new do
-    def self.included(mod)
-      Blacklight.deprecation.warn("Blacklight::Document::Sms is deprecated and will be removed (included in #{mod}).")
-    end
-  end
-
   attr_reader :response, :_source
   alias_method :solr_response, :response
 

data/app/models/concerns/blacklight/user.rb

@@ -5,7 +5,7 @@ module Blacklight::User
   # SEE ALSO:  The lib/blacklight/generator/user_generator.rb class for where this
   # is generated into the hosting application.
   included do
-    class_attribute :string_display_key
+    class_attribute :string_display_key, default: :email
 
     has_many :bookmarks, dependent: :destroy, as: :user
     has_many :searches,  dependent: :destroy, as: :user

data/app/presenters/blacklight/facet_field_presenter.rb

@@ -50,8 +50,8 @@ module Blacklight
     end
 
     # Appease rubocop rules by implementing #each_value
-    def each_value(&block)
-      values.each(&block)
+    def each_value(&)
+      values.each(&)
     end
 
     def paginator

data/app/presenters/blacklight/json_presenter.rb

@@ -13,7 +13,9 @@ module Blacklight
 
     delegate :facet_field_names, :facet_configuration_for_field, to: :blacklight_config
 
-    delegate :documents, to: :@response
+    def documents
+      @response.documents
+    end
 
     # @return [Array<Blacklight::Solr::Response::Facets::FacetField>]
     def search_facets

data/app/services/blacklight/search_params_yaml_coder.rb

@@ -21,7 +21,6 @@ module Blacklight
       params.with_indifferent_access
     end
 
-    # rubocop:disable Security/YAMLLoad
     if YAML.respond_to?(:unsafe_load)
       def self.yaml_load(payload)
         if ActiveRecord.try(:use_yaml_unsafe_load) || ActiveRecord::Base.try(:use_yaml_unsafe_load)
@@ -43,6 +42,5 @@ module Blacklight
         end
       end
     end
-    # rubocop:enable Security/YAMLLoad
   end
 end

data/app/views/bookmarks/_clear_bookmarks_widget.html.erb

@@ -1,7 +1,5 @@
   <%= link_to t('blacklight.bookmarks.clear.action_title'), clear_bookmarks_path,
-      method: :delete, # for rails-UJS
       data: {
-        confirm: t('blacklight.bookmarks.clear.action_confirm'), # for rails-UJS
         turbo_method: :delete,
         turbo_confirm: t('blacklight.bookmarks.clear.action_confirm')
       },

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

@@ -13,7 +13,7 @@
   <% else %>
     <%= render 'sort_and_per_page' %>
     <%= render partial: 'tools', locals: { document_list: @response.documents } %>
-    <h2 class='section-heading sr-only visually-hidden'><%= t('blacklight.bookmarks.list_title') %></h2>
+    <h2 class='section-heading visually-hidden'><%= t('blacklight.bookmarks.list_title') %></h2>
     <%= render_document_index @response.documents %>
     <%= render 'results_pagination' %>
   <% end %>

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

@@ -1,7 +1,4 @@
 <% if show_pagination? and @response.total_pages > 1 %>
- <div class="row record-padding">
-  <div class="col-md-12">
-    <%= render Blacklight::Response::PaginationComponent.new(response: @response) %>
-  </div>
- </div>
+  <%= render Blacklight::Response::PaginationComponent.new(response: @response,
+    classes: 'paginate-section mt-2') %>
 <% end %>

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

@@ -8,17 +8,17 @@
 <% end %>
 
 <% content_for(:skip_links) do -%>
-    <%= link_to t('blacklight.skip_links.first_result'), '#documents', class: 'd-inline-flex p-2 m-1', data: { turbolinks: 'false' } %>
+  <%= render Blacklight::SkipLinkItemComponent.new(text: t('blacklight.skip_links.first_result'), href: '#documents') %>
 <% end %>
 
 <% content_for(:container_header) do -%>
   <%= render 'search_results_header' %>
-  <%= render 'constraints' %>
+  <%= render blacklight_config.view_config(document_index_view_type).constraints_component.new(search_state: search_state) %>
 <% end %>
 
-<%= render 'search_header' %>
+<%= render blacklight_config.view_config(document_index_view_type).search_header_component.new %>
 
-<h2 class="sr-only visually-hidden"><%= t('blacklight.search.search_results') %></h2>
+<h2 class="visually-hidden"><%= t('blacklight.search.search_results') %></h2>
 
 <%- if @response.empty? %>
   <%= render "zero_results" %>

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

@@ -1 +1 @@
-<h1 class="sr-only visually-hidden top-content-title"><%= t('blacklight.search.header') %></h1>
+<h1 class="visually-hidden top-content-title"><%= t('blacklight.search.header') %></h1>

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

@@ -1,4 +1,4 @@
-<div id="sortAndPerPage" class="sort-pagination 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 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/_sort_widget.html.erb

@@ -1,6 +1,7 @@
 <% if show_sort_and_per_page? %>
   <%= render(Blacklight::Response::SortComponent.new(
     choices: active_sort_fields.map { |key, config| [sort_field_label(config.key), key] },
+    classes: ['mx-1'],
     search_state: search_state,
     selected: current_sort_field&.key)) %>
 <% end %>

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

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

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

@@ -1,7 +1,6 @@
 <%= render 'show_main_content' %>
 
 <% content_for(:sidebar) do %>
-  <% Blacklight.deprecation.silence do %>
-    <%= render_document_sidebar_partial @document %>
-  <% end %>
+  <% presenter = document_presenter(@document) %>
+  <%= render presenter.view_config.sidebar_component.new(presenter: presenter) %>
 <% end %>

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

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

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

@@ -12,15 +12,11 @@
     <%= opensearch_description_tag application_name, opensearch_catalog_url(format: 'xml') %>
     <%= favicon_link_tag %>
     <%= stylesheet_link_tag "application", media: "all", "data-turbo-track": "reload"  %>
+
     <% 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 %>
-      <script type="module">
-        import githubAutoCompleteElement from 'https://cdn.skypack.dev/@github/auto-complete-element';
-      </script>
     <% end %>
 
     <%= csrf_meta_tags %>
@@ -31,9 +27,9 @@
       <%= content_for(:skip_links) %>
     <% end %>
 
-    <%= render partial: 'shared/header_navbar' %>
+    <%= render blacklight_config.header_component.new(blacklight_config: blacklight_config) %>
 
-    <main id="main-container" class="<%= container_classes %>" role="main" aria-label="<%= t('blacklight.main.aria.main_container') %>">
+    <main id="main-container" class="<%= container_classes %>" aria-label="<%= t('blacklight.main.aria.main_container') %>">
       <%= content_for(:container_header) %>
 
       <%= render partial: 'shared/flash_msg', layout: 'shared/flash_messages' %>

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

@@ -7,9 +7,7 @@
 <% else %>
   <%= link_to t('blacklight.search_history.clear.action_title'),
               blacklight.clear_search_history_path,
-              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
               },

data/blacklight.gemspec

@@ -23,19 +23,19 @@ 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.7'
+  s.required_ruby_version = '>= 3.1'
 
-  s.add_dependency "rails", '>= 6.1', '< 9'
+  s.add_dependency "rails", '>= 7.0', '< 9'
   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 "i18n", '>= 1.7.0' # added named parameters
   s.add_dependency "ostruct", '>= 0.3.2'
-  s.add_dependency "view_component", '>= 2.74', '< 4'
+  s.add_dependency "view_component", '~> 3.9'
   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", "< 8"
+  s.add_development_dependency "rspec-rails", "~> 7.0"
   s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
   s.add_development_dependency 'axe-core-rspec'
   s.add_development_dependency "capybara", '~> 3'

data/config/importmap.rb

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

data/config/locales/blacklight.ar.yml

@@ -102,7 +102,7 @@ ar:
           close: إخفاء الأوجه
           open: عرض الأوجه
         missing: "[غير موجود]"
-        more_html: المزيد <span class="sr-only visually-hidden">%{field_name}</span> »
+        more_html: المزيد <span class="visually-hidden">%{field_name}</span> »
         pivot:
           hide: إغلاق
           show: فتح
@@ -112,8 +112,8 @@ ar:
           count: ترتيب رقمي
           index: ترتيب أبجدي
         suggest:
-          label: الفلتر %{field_label}
-          placeholder: فلتر...
+          label: Filter %{field_label}
+          placeholder: Filter...
         title: تحديد نطاق البحث
       filters:
         label: "%{label}:"
@@ -155,7 +155,7 @@ ar:
         aria_label: تصفح النتائج
         button_label: "%{count} لكل صفحة"
         button_label_html: '%{count}<span class="d-none d-sm-inline"> لكل صفحة</span>'
-        label: '%{count}<span class="sr-only visually-hidden"> لكل صفحة</span>'
+        label: '%{count}<span class="visually-hidden"> لكل صفحة</span>'
         submit: تحديث
         title: عدد النتائج المعروضة في الصفحة
       rss_feed: خلاصات RSS للنتائج