blacklight 9.0.0.beta8 → 9.1.0

data/app/services/blacklight/search_service.rb

@@ -3,10 +3,16 @@
 # SearchService returns search results from the repository
 module Blacklight
   class SearchService
+    # @params [Blacklight::Configuration] config
+    # @params [Blacklight::SearchState] search_state
+    # @params [Class] search_builder_class a class that inherits from Blacklight::SearchBuilder
+    # @params [Hash] context any data the search builder needs to access. For example, the current user.
     def initialize(config:, search_state:, search_builder_class: config.search_builder_class, **context)
       @blacklight_config = config
       @search_state = search_state
-      @user_params = @search_state.params
+      @user_params = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(@search_state.params,
+                                                                           'Use @search_state.params instead of @user_params',
+                                                                           Blacklight.deprecation)
       @search_builder_class = search_builder_class
       @context = context
     end
@@ -15,15 +21,13 @@ module Blacklight
     attr_reader :blacklight_config, :context
 
     def search_builder
-      search_builder_class.new(self)
+      search_builder_class.new(self, blacklight_config: blacklight_config)
     end
 
-    def search_state_class
-      @search_state.class
-    end
-
-    # a solr query method
-    # @yield [search_builder] optional block yields configured SearchBuilder, caller can modify or create new SearchBuilder to be used. Block should return SearchBuilder to be used.
+    # Fetch query results from solr
+    # @yield [search_builder] optional block yields configured SearchBuilder,  caller can modify or create new
+    #                         SearchBuilder to be used. Block should return SearchBuilder to be used.
+    #                         This is used in blacklight_range_limit
     # @return [Blacklight::Solr::Response] the solr response object
     def search_results
       builder = search_builder.with(search_state)
@@ -69,11 +73,24 @@ module Blacklight
 
     # Get the previous and next document from a search result
     # @return [Blacklight::Solr::Response, Array<Blacklight::SolrDocument>] the solr response and a list of the first and last document
-    def previous_and_next_documents_for_search(index, request_params, extra_controller_params = {})
-      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(params: query)
+    def previous_and_next_documents_for_search(index, request_params, params: nil, **extra_controller_params)
+      unless params
+        new_state = request_params.is_a?(Blacklight::SearchState) ? request_params : Blacklight::SearchState.new(request_params, blacklight_config)
+        builder = search_builder.with(new_state)
+
+        search_service_params = Blacklight.deprecation.silence do
+          previous_and_next_document_params(index)
+        end
+
+        builder = if search_service_params.empty?
+                    builder.for_previous_and_next_documents(index).merge(extra_controller_params)
+                  else
+                    Blacklight.deprecation.warn("SearchService#previous_and_next_document_params returned parameters. Implement customizations in SearchBuilder#for_previous_and_next_document instead")
+                    builder.start(search_service_params.delete(:start)).rows(search_service_params.delete(:rows)).merge(extra_controller_params).merge(search_service_params)
+                  end
+      end
+
+      response = repository.search(params: params || builder)
       document_list = response.documents
 
       # only get the previous doc if there is one
@@ -88,14 +105,16 @@ module Blacklight
     # the second item is an other array. This second array contains
     # all of the field values for each of the documents...
     # where the field is the "field" argument passed in.
+    # @deprecated
     def opensearch_response(field = nil, extra_controller_params = {})
       field ||= blacklight_config.view_config(:opensearch).title_field
 
       query = search_builder.with(search_state).merge(solr_opensearch_params(field)).merge(extra_controller_params)
-      response = repository.search(query)
+      response = repository.search(params: query)
 
       [search_state.query_param, response.documents.flat_map { |doc| doc[field] }.uniq]
     end
+    Blacklight.deprecation.deprecate_methods Blacklight::SearchService, opensearch_response: "The opensearch_response method is deprecated without replacement."
 
     private
 
@@ -111,34 +130,20 @@ module Blacklight
 
     ##
     # Opensearch autocomplete parameters for plucking a field's value from the results
+    # @deprecated
     def solr_opensearch_params(field)
       solr_params = {}
       solr_params[:rows] ||= 10
       solr_params[:fl] = field || blacklight_config.view_config(:opensearch).title_field
       solr_params
     end
+    Blacklight.deprecation.deprecate_methods Blacklight::SearchService, solr_opensearch_params: "The solr_opensearch_params method is deprecated without replacement."
 
-    ##
-    # Pagination parameters for selecting the previous and next documents
-    # out of a result set.
-    def previous_and_next_document_params(index, window = 1)
-      solr_params = blacklight_config.document_pagination_params.dup
-
-      if solr_params.empty?
-        solr_params[:fl] = blacklight_config.document_model.unique_key
-      end
-
-      if index > 0
-        solr_params[:start] = index - window # get one before
-        solr_params[:rows] = (2 * window) + 1 # and one after
-      else
-        solr_params[:start] = 0 # there is no previous doc
-        solr_params[:rows] = 2 * window # but there should be one after
-      end
-
-      solr_params[:facet] = false
-      solr_params
+    def previous_and_next_document_params(*, **)
+      {}
     end
+    Blacklight.deprecation.deprecate_methods(Blacklight::SearchService,
+                                             previous_and_next_document_params: "Use SearchBuilder#for_previous_and_next_documents instead of SearchService#previous_and_next_document_params")
 
     ##
     # Retrieve a set of documents by id
@@ -147,11 +152,20 @@ module Blacklight
     def fetch_many(ids, extra_controller_params)
       extra_controller_params ||= {}
 
+      requested_rows = extra_controller_params.delete(:rows)
+      if requested_rows
+        Blacklight.deprecation.warn("Passing :rows to fetch_many is deprecated. Create an issue in blacklight if you see this warning. " \
+                                    "Otherwise, :rows will be ignored in Blackight 10")
+      else
+        requested_rows = ids.count
+      end
+
       query = search_builder
               .with(search_state)
               .where(blacklight_config.document_model.unique_key => ids)
               .merge(blacklight_config.fetch_many_document_params)
               .merge(extra_controller_params)
+      query.rows(requested_rows)
 
       # find_many was introduced in Blacklight 8.4. Before that, we used the
       # regular search method (possibly with a find-many specific `qt` parameter).
@@ -160,7 +174,8 @@ module Blacklight
       solr_response = if repository.respond_to?(:find_many)
                         repository.find_many(query)
                       else
-                        repository.search(query)
+                        Blacklight.deprecation.warn("Repository#find_many is not implemented. Falling back to Repository#search.")
+                        repository.search(params: query)
                       end
 
       solr_response.documents

data/app/values/blacklight/types.rb

@@ -88,7 +88,7 @@ module Blacklight
       def cast(input)
         value = super
 
-        return value unless value.is_a?(String)
+        return value unless value.is_a?(::String)
 
         JSON.parse(value)
       end

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

@@ -6,7 +6,7 @@
 
   <div class="modal-body">
     <%= render '/shared/flash_msg' %>
-    <div class="row">
+    <div class="row mb-3">
       <label class="col-form-label col-sm-2" for="to">
         <%= t('blacklight.email.form.to') %>
       </label>
@@ -15,7 +15,7 @@
       </div>
     </div>
 
-    <div class="row">
+    <div class="row mb-3">
       <label class="col-form-label col-sm-2" for="message">
         <%= t('blacklight.email.form.message') %>
       </label>
@@ -25,7 +25,7 @@
     </div>
 
     <% @documents&.each do |doc| %>
-      <%=hidden_field_tag "id[]", doc.id %>
+      <%= hidden_field_tag "id[]", doc.id %>
     <% end %>
     <%- if params[:sort] -%>
       <%= hidden_field_tag "sort", params[:sort] %>

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

@@ -1,4 +1,4 @@
-<div class="text-center p-5 mb-4 bg-light rounded-3">
+<div class="text-center p-5 mb-4 bg-body-tertiary border 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/_sms_form.html.erb

@@ -5,7 +5,7 @@
              method: :post do %>
 <div class="modal-body">
   <%= render '/shared/flash_msg' %>
-    <div class="row">
+    <div class="row mb-3">
       <label class="col-form-label col-sm-2" for="to">
         <%= t('blacklight.sms.form.to') %>
       </label>
@@ -13,17 +13,17 @@
         <%= telephone_field_tag :to, params[:to], class: 'form-control', required: true %>
       </div>
     </div>
-    <div class="row">
+    <div class="row mb-3">
       <label class="col-form-label col-sm-2" for="carrier">
         <%= t('blacklight.sms.form.carrier') %>
       </label>
       <div class="col-sm-10">
-          <%= select_tag(:carrier, options_for_select(sms_mappings.to_a.sort.unshift([t('blacklight.sms.form.carrier_prompt'),'']), params[:carrier]), class: 'form-control') %><br/>
+          <%= select_tag(:carrier, options_for_select(sms_mappings.to_a.sort.unshift([t('blacklight.sms.form.carrier_prompt'),'']), params[:carrier]), class: 'form-control') %><br>
       </div>
 
     </div>
     <% @documents&.each do |doc| %>
-       <%=hidden_field_tag "id[]", doc.id %>
+       <%= hidden_field_tag "id[]", doc.id %>
     <% end %>
 </div>
 <div class="modal-footer">

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 xml.instruct! :xml, version: "1.0"
-xml.rss(version: "2.0") {
-  xml.channel {
+xml.rss(version: "2.0") do
+  xml.channel do
     xml.title(t('blacklight.search.page_title.title', constraints: render_search_to_page_title(params), application_name: application_name))
     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))
@@ -10,5 +10,5 @@ xml.rss(version: "2.0") {
     @response.documents.each_with_index do |document, document_counter|
       xml << render_xml_partials(document, blacklight_config.view_config(:rss).partials, document_counter: document_counter)
     end
-  }
-}
+  end
+end

data/app/views/catalog/opensearch.json.jbuilder

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+json.array! [search_state.query_param] + @presenter.documents.map { |document| document_presenter(document).heading }.uniq

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 xml.instruct! :xml, version: '1.0'
-xml.OpenSearchDescription(xmlns: 'http://a9.com/-/spec/opensearch/1.1/') {
+xml.OpenSearchDescription(xmlns: 'http://a9.com/-/spec/opensearch/1.1/') do
   xml.ShortName application_name
   xml.Description "#{application_name} Search"
   xml.Image asset_url('favicon.ico'), height: 16, width: 16, type: 'image/x-icon'
@@ -9,4 +9,4 @@ xml.OpenSearchDescription(xmlns: 'http://a9.com/-/spec/opensearch/1.1/') {
   xml.Url type: 'text/html', method: 'get', template: "#{url_for controller: 'catalog', only_path: false}?q={searchTerms}&page={startPage?}"
   xml.Url type: 'application/rss+xml', method: 'get', template: "#{url_for controller: 'catalog', only_path: false}.rss?q={searchTerms}&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}"
-}
+end

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

@@ -6,9 +6,21 @@
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
 
     <title><%= render_page_title %></title>
+
+    <% if dark_mode_support? %>
     <script>
-      document.querySelector('html').classList.remove('no-js');
+      (() => {
+        const theme = localStorage.getItem('theme') || 'auto';
+        if (theme === 'auto') {
+          document.documentElement.setAttribute('data-bs-theme', window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light');
+        } else {
+          document.documentElement.setAttribute('data-bs-theme', theme);
+        }
+        document.querySelector('html').classList.remove('no-js');
+      })();
     </script>
+    <% end %>
+    
     <%= opensearch_description_tag application_name, opensearch_catalog_url(format: 'xml') %>
     <%= favicon_link_tag %>
     <%= stylesheet_link_tag "application", media: "all", "data-turbo-track": "reload"  %>

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

@@ -4,19 +4,32 @@
   <% end %>
 
   <% if has_user_authentication_provider? %>
-    <% if current_user %>
+    <% user = current_user if respond_to?(:current_user) %>
+    <% if user %>
+    <% if blacklight_logout_path %>
     <li class="nav-item">
-      <%= link_to t('blacklight.header_links.logout'), destroy_user_session_path, class: 'nav-link' %>
+      <%= link_to t('blacklight.header_links.logout'), blacklight_logout_path, { class: 'nav-link' }.merge(blacklight_logout_link_options) %>
     </li>
-    <% unless current_user.to_s.blank? -%>
+    <% end %>
+    <% if blacklight_account_path && user.to_s.present? -%>
     <li class="nav-item">
-      <%= link_to current_user, edit_user_registration_path, class: 'nav-link' %>
+      <%= link_to user, blacklight_account_path, class: 'nav-link' %>
     </li>
     <% end %>
     <% else %>
+    <% if blacklight_login_path %>
     <li class="nav-item">
-      <%= link_to t('blacklight.header_links.login'), new_user_session_path, class: 'nav-link' %>
+      <%= link_to t('blacklight.header_links.login'), blacklight_login_path, class: 'nav-link' %>
     </li>
     <% end %>
+    <% end %>
+  <% end %>
+
+  <% if dark_mode_support? %>
+    <li class="nav-item py-2 py-md-1 col-12 col-md-auto">
+      <div class="vr d-none d-md-flex h-100 mx-md-2 text-white"></div>
+      <hr class="d-md-none my-2 text-white-50">
+    </li>
+    <%= render Blacklight::ThemeSwitcherComponent.new %>
   <% end %>
 </ul>

data/blacklight.gemspec

@@ -23,15 +23,15 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = '>= 3.1'
+  s.required_ruby_version = '>= 3.3'
 
-  s.add_dependency "rails", '>= 7.0', '< 9'
+  s.add_dependency "rails", '>= 7.2', '< 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", '>= 3.0', '< 5.0'
+  s.add_dependency "view_component", '~> 4.0'
   s.add_dependency "zeitwerk"
 
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.

data/config/locales/blacklight.ar.yml

@@ -212,6 +212,11 @@ ar:
       success: تم الإرسال كرسالة نصية قصيرة
       text:
         url: "الرابط: %{url}"
+    theme:
+      auto: تلقائي
+      dark: داكن
+      light: فاتح
+      toggle: تبديل المظهر
     tools:
       citation: استشهاد مرجعي
       clear: مسح

data/config/locales/blacklight.ca.yml

@@ -76,6 +76,11 @@ ca:
       forget: "oblida-ho"
       save: "desa-ho"
 
+    theme:
+      auto: Automàtic
+      dark: Fosc
+      light: Clar
+      toggle: Canvia el tema
     tools:
       title: "Eines"
       citation: "Citació"

data/config/locales/blacklight.de.yml

@@ -91,8 +91,7 @@ de:
         group:
           close: Facetten ausblenden
           open: Facetten zeigen
-        missing:
-          - fehlt
+        missing: "[fehlt]"
         more_html: mehr <span class="visually-hidden">%{field_name}</span> »
         pivot:
           hide: Schließen
@@ -199,6 +198,11 @@ de:
       success: SMS verschickt
       text:
         url: "Link: %{url}"
+    theme:
+      auto: Automatisch
+      dark: Dunkel
+      light: Hell
+      toggle: Design umschalten
     tools:
       citation: Zitieren
       clear: Löschen

data/config/locales/blacklight.en.yml

@@ -217,6 +217,11 @@ en:
       success: SMS Sent
       text:
         url: "Link: %{url}"
+    theme:
+      auto: Auto
+      dark: Dark
+      light: Light
+      toggle: Toggle theme
     tools:
       citation: Cite
       clear: Clear

data/config/locales/blacklight.es.yml

@@ -198,6 +198,11 @@ es:
       success: SMS enviado
       text:
         url: "Link: %{url}"
+    theme:
+      auto: Automático
+      dark: Oscuro
+      light: Claro
+      toggle: Cambiar tema
     tools:
       citation: Cité
       clear: Borrar

data/config/locales/blacklight.fr.yml

@@ -198,6 +198,11 @@ fr:
       success: SMS envoyé
       text:
         url: "Lien : %{url}"
+    theme:
+      auto: Automatique
+      dark: Sombre
+      light: Clair
+      toggle: Changer le thème
     tools:
       citation: Citer
       clear: Effacer

data/config/locales/blacklight.hu.yml

@@ -196,6 +196,11 @@ hu:
       success: SMS elküldve
       text:
         url: "Link: %{url}"
+    theme:
+      auto: Automatikus
+      dark: Sötét
+      light: Világos
+      toggle: Téma váltása
     tools:
       citation: Hivatkozás
       clear: Eltávolítás

data/config/locales/blacklight.it.yml

@@ -91,8 +91,7 @@ it:
         group:
           close: Nascondi sfaccettature
           open: Mostra sfaccettature
-        missing:
-          - Mancante
+        missing: "[Mancante]"
         more_html: altri <span class="visually-hidden">%{field_name}</span> »
         pivot:
           hide: Chiudi
@@ -199,6 +198,11 @@ it:
       success: SMS inviato
       text:
         url: "Link: %{url}"
+    theme:
+      auto: Automatico
+      dark: Scuro
+      light: Chiaro
+      toggle: Cambia tema
     tools:
       citation: Cita
       clear: Cancella

data/config/locales/blacklight.nl.yml

@@ -196,6 +196,11 @@ nl:
       success: SMS Verzonden
       text:
         url: "Link: %{url}"
+    theme:
+      auto: Automatisch
+      dark: Donker
+      light: Licht
+      toggle: Thema wisselen
     tools:
       citation: Citeer
       clear: Leeg maken

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

@@ -89,8 +89,7 @@ pt-BR:
         group:
           close: Ocultar facetas
           open: Mostrar facetas
-        missing:
-          - Ausência
+        missing: "[Ausência]"
         more_html: mais <span class="visually-hidden">%{field_name}</span> »
         pivot:
           hide: Fechar
@@ -197,6 +196,11 @@ pt-BR:
       success: SMS Enviado
       text:
         url: "Link: %{url}"
+    theme:
+      auto: Automático
+      dark: Escuro
+      light: Claro
+      toggle: Alternar tema
     tools:
       citation: Citar
       clear: Limpar

data/config/locales/blacklight.sq.yml

@@ -196,6 +196,11 @@ sq:
       success: SMS-i u dëgua
       text:
         url: "Link: %{url}"
+    theme:
+      auto: Automatik
+      dark: E errët
+      light: E çelët
+      toggle: Ndrysho temën
     tools:
       citation: Citati
       clear: Fshij

data/config/locales/blacklight.zh.yml

@@ -196,6 +196,11 @@ zh:
       success: 已发送短信
       text:
         url: "链接: %{url}"
+    theme:
+      auto: 自动
+      dark: 深色
+      light: 浅色
+      toggle: 切换主题
     tools:
       citation: 引用
       clear: 清除

data/lib/blacklight/component.rb

@@ -15,7 +15,7 @@ module Blacklight
       # provided by Blacklight.
       def sidecar_files(*args, **kwargs)
         upstream_sidecar_files(*args, **kwargs).map do |path|
-          components_path = ViewComponent::VERSION::MAJOR == 3 ? view_component_path : config.generate.path
+          components_path = config.generate.path
 
           app_path = Rails.root.join(path.slice(path.index(components_path)..-1).to_s).to_s
 

data/lib/blacklight/configuration/action_config_map_entry.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class Configuration::ActionConfigMapEntry < OpenStructWithHashAccess
+    # @!attribute parent_action_key
+    # Pull in the configuration for this action from another action's config
+    # @return [Symbol]
+
+    def parent_config = parent_action_key
+
+    def parent_config=(value)
+      self.parent_action_key = value
+    end
+
+    #
+    # @!attribute blacklight_config_property
+    # Pull in the configuration for this action from a top-level config
+    # @return [Symbol]
+
+    def top_level_config = blacklight_config_property
+
+    def top_level_config=(value)
+      self.blacklight_config_property = value
+    end
+
+    #
+    # @!attribute default
+    # Pull in additional default configuration for this action from a top-level config
+    # @return [Array<Symbol>]
+  end
+end

data/lib/blacklight/configuration/display_field.rb

@@ -35,6 +35,7 @@ module Blacklight
     #   @return [Blacklight::FieldPresenter]
     # @!attribute component
     #   @return [Blacklight::MetadataFieldComponent]
+    # @!attribute layout_component
 
     ##
     # Default rendering pipeline:

data/lib/blacklight/configuration/field.rb

@@ -17,20 +17,20 @@ module Blacklight
 
     def normalize! _blacklight_config = nil
       self.field ||= key
-      self.key ||= self.field
+      self.key ||= field
 
       self.label ||= default_label
 
       self.if = true if self.if.nil?
       self.unless = false if self.unless.nil?
 
-      self.field &&= self.field.to_s
+      self.field &&= field.to_s
 
       self
     end
 
     def validate!
-      raise ArgumentError, "Must supply a field name" if self.field.nil?
+      raise ArgumentError, "Must supply a field name" if field.nil?
     end
 
     def display_label(context = nil, **)
@@ -44,10 +44,10 @@ module Blacklight
     end
 
     def default_label
-      if self.key.respond_to?(:titleize)
-        self.key.titleize
+      if key.respond_to?(:titleize)
+        key.titleize
       else
-        self.key.to_s.titleize
+        key.to_s.titleize
       end
     end
 

data/lib/blacklight/configuration/fields.rb

@@ -146,7 +146,7 @@ module Blacklight
 
         @table[:reflected_fields] ||= Rails.cache.fetch("blacklight_configuration/admin/reflected_fields", expires_in: 1.hour) do
           repository.reflect_fields
-        rescue => e
+        rescue StandardError => e
           Blacklight.logger&.warn "Error retrieving field metadata: #{e}"
           false
         end

data/lib/blacklight/configuration/sort_field.rb

@@ -10,13 +10,13 @@ module Blacklight
       self.field ||= label&.parameterize
       self.field ||= sort
 
-      self.sort ||= self.field
+      self.sort ||= field
 
       self
     end
 
     def validate!
-      raise ArgumentError.new, "Must supply a sort string" if self.sort.nil?
+      raise ArgumentError.new, "Must supply a sort string" if sort.nil?
     end
   end
 end