blacklight 7.33.0 → 8.0.0

data/app/components/blacklight/response/spellcheck_component.rb

@@ -3,7 +3,7 @@
 module Blacklight
   module Response
     # Render spellcheck results for a search query
-    class SpellcheckComponent < ViewComponent::Base
+    class SpellcheckComponent < Blacklight::Component
       # @param [Blacklight::Response] response
       # @param [Array<String>] options explicit spellcheck options to render
       def initialize(response:, options: nil)
@@ -13,15 +13,26 @@ module Blacklight
       end
 
       def link_to_query(query)
-        Deprecation.silence(Blacklight::UrlHelperBehavior) do
-          helpers.link_to_query(query)
-        end
+        p = helpers.search_state.to_h.except(:page, :action)
+        p[:q] = query
+        link_to(query, helpers.search_action_path(p))
       end
 
       def render?
-        Deprecation.silence(Blacklight::BlacklightHelperBehavior) do
-          @options&.any? && helpers.should_show_spellcheck_suggestions?(@response)
-        end
+        Array(@options).any? && show_spellcheck_suggestions?(@response)
+      end
+
+      # @!group Search result helpers
+      ##
+      # Determine whether to display spellcheck suggestions
+      #
+      # @param [Blacklight::Solr::Response] response
+      # @return [Boolean]
+      def show_spellcheck_suggestions? response
+        # The spelling response field may be missing from non solr repositories.
+        response.total <= helpers.blacklight_config.spell_max &&
+          !response.spelling.nil? &&
+          response.spelling.words.any?
       end
 
       private

data/app/components/blacklight/response/view_type_button_component.rb

@@ -3,7 +3,7 @@
 module Blacklight
   module Response
     # Render spellcheck results for a search query
-    class ViewTypeButtonComponent < ViewComponent::Base
+    class ViewTypeButtonComponent < Blacklight::Component
       with_collection_parameter :view
       # @param [Blacklight::Configuration::View] view
       def initialize(view:, key: nil, selected: false, search_state: nil, classes: 'btn btn-outline-secondary btn-icon')
@@ -18,15 +18,11 @@ module Blacklight
         return render(@view.icon.new) if @view.icon.is_a?(Class)
         return render(@view.icon) if @view.icon.is_a?(ViewComponent::Base)
 
-        Deprecation.silence(Blacklight::CatalogHelperBehavior) do
-          helpers.render_view_type_group_icon(@view.icon || @key)
-        end
+        helpers.blacklight_icon(@view.icon || @key)
       end
 
       def label
-        Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
-          helpers.view_label(@key)
-        end
+        @view.display_label
       end
 
       def url

data/app/components/blacklight/response/view_type_component.rb

@@ -3,11 +3,11 @@
 module Blacklight
   module Response
     # Render spellcheck results for a search query
-    class ViewTypeComponent < ViewComponent::Base
+    class ViewTypeComponent < Blacklight::Component
       renders_many :views, 'Blacklight::Response::ViewTypeButtonComponent'
 
       # @param [Blacklight::Response] response
-      def initialize(response:, views: {}, search_state:, selected: nil)
+      def initialize(response:, search_state:, views: {}, selected: nil)
         @response = response
         @views = views
         @search_state = search_state
@@ -18,14 +18,12 @@ module Blacklight
         return if views.any?
 
         @views.each do |key, config|
-          view(key: key, view: config, selected: @selected == key, search_state: @search_state)
+          with_view(key: key, view: config, selected: @selected == key, search_state: @search_state)
         end
       end
 
       def render?
-        Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
-          helpers.has_alternative_views?
-        end
+        views.many? && !@response.empty?
       end
     end
   end

data/app/components/blacklight/search/sidebar_component.html.erb

@@ -0,0 +1,8 @@
+<% facet_group_names.each do |groupname| %>
+  <% fields = facet_fields_in_group(groupname) %>
+  <%= render group_component_class.new(id: groupname, fields: fields, response: response) do |component| %>
+    <% component.with_body do %>
+      <%= render Blacklight::FacetComponent.with_collection(fields, response: response) %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/components/blacklight/search/sidebar_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Search
+    class SidebarComponent < Blacklight::Component
+      def initialize(blacklight_config:, response:, view_config:)
+        @blacklight_config = blacklight_config
+        @response = response
+        @group_component_class = view_config.facet_group_component || Blacklight::Response::FacetGroupComponent
+      end
+
+      attr_reader :group_component_class, :response
+
+      delegate :facet_group_names, :facet_fields_in_group, to: :@blacklight_config
+    end
+  end
+end

data/app/components/blacklight/search_bar_component.html.erb

@@ -1,7 +1,7 @@
-<%= form_tag @url, method: @method, class: @classes.join(' '), role: 'search', aria: { label: scoped_t('submit') }, **@form_options do %>
-  <%= render_hash_as_hidden_fields(@params) %>
+<%= form_with url: @url, local: true, method: @method, class: @classes.join(' '), scope: @prefix, role: 'search', aria: { label: scoped_t('submit') }, **@form_options do |f| %>
+  <%= render Blacklight::HiddenSearchStateComponent.new(params: @params) %>
   <% if search_fields.length > 1 %>
-    <label for="search_field" class="sr-only visually-hidden"><%= scoped_t('search_field.label') %></label>
+    <%= f.label :search_field, scoped_t('search_field.label'), class: 'sr-only visually-hidden' %>
   <% end %>
   <% before_input_groups.each do |input_group| %>
     <%= input_group %>
@@ -10,22 +10,27 @@
     <%= prepend %>
 
     <% if search_fields.length > 1 %>
-        <%= select_tag(:search_field,
-                       options_for_select(search_fields, h(@search_field)),
-                       title: scoped_t('search_field.title'),
-                       id: "#{@prefix}search_field",
-                       class: "custom-select form-select search-field") %>
+      <%= f.select(:search_field,
+                   options_for_select(search_fields, h(@search_field)),
+                   {},
+                   title: scoped_t('search_field.title'),
+                   class: "custom-select form-select search-field") %>
     <% elsif search_fields.length == 1 %>
-      <%= hidden_field_tag :search_field, search_fields.first.last %>
+      <%= f.hidden_field :search_field, value: search_fields.first.last %>
     <% end %>
 
-    <label for="<%= @prefix %><%= @query_param %>" class="sr-only visually-hidden"><%= scoped_t('search.label') %></label>
-    <%= text_field_tag @query_param, @q, placeholder: scoped_t('search.placeholder'), class: "search-q q form-control rounded-#{search_fields.length > 1 ? '0' : 'left'}", id: "#{@prefix}q", autocomplete: autocomplete_path.present? ? "off" : "", autofocus: @autofocus, aria: { label: scoped_t('search.label') }, data: { autocomplete_enabled: autocomplete_path.present?, autocomplete_path: autocomplete_path }  %>
+    <%= f.label @query_param, scoped_t('search.label'), class: 'sr-only visually-hidden' %>
+    <% if autocomplete_path.present? %>
+      <auto-complete src="<%= autocomplete_path %>" for="autocomplete-popup" class="search-autocomplete-wrapper">
+        <%= f.search_field @query_param, value: @q, placeholder: scoped_t('search.placeholder'), class: "search-q q form-control rounded-#{search_fields.length > 1 ? '0' : 'left'}", autofocus: @autofocus, aria: { label: scoped_t('search.label'), autocomplete: 'list', controls: 'autocomplete-popup' }  %>
+        <ul id="autocomplete-popup" role="listbox" aria-label="<%= scoped_t('search.label') %>"></ul>
+      </auto-complete>
+    <% else %>
+      <%= f.search_field @query_param, value: @q, placeholder: scoped_t('search.placeholder'), class: "search-q q form-control rounded-#{search_fields.length > 1 ? '0' : 'left'}", autofocus: @autofocus, aria: { label: scoped_t('search.label') }  %>
+    <% end %>
 
-    <span class="input-group-append">
-      <%= append %>
-      <%= search_button || render(Blacklight::SearchButtonComponent.new(id: "#{@prefix}search", text: scoped_t('submit'))) %>
-    </span>
+    <%= append %>
+    <%= search_button || render(Blacklight::SearchButtonComponent.new(id: "#{@prefix}search", text: scoped_t('submit'))) %>
   </div>
 <% end %>
 

data/app/components/blacklight/search_bar_component.rb

@@ -2,8 +2,6 @@
 
 module Blacklight
   class SearchBarComponent < Blacklight::Component
-    include Blacklight::ContentAreasShim
-
     renders_one :append
     renders_one :prepend
     renders_one :search_button
@@ -12,10 +10,10 @@ module Blacklight
     # rubocop:disable Metrics/ParameterLists
     def initialize(
       url:, params:,
-      advanced_search_url: nil, presenter: nil,
+      advanced_search_url: nil,
       classes: ['search-query-form'], prefix: nil,
       method: 'GET', q: nil, query_param: :q,
-      search_field: nil, search_fields: nil, autocomplete_path: nil,
+      search_field: nil, autocomplete_path: nil,
       autofocus: nil, i18n: { scope: 'blacklight.search.form' },
       form_options: {}
     )
@@ -30,14 +28,8 @@ module Blacklight
       @method = method
       @autocomplete_path = autocomplete_path
       @autofocus = autofocus
-      @search_fields = search_fields
       @i18n = i18n
       @form_options = form_options
-
-      return if presenter.nil?
-
-      Deprecation.warn(self, 'SearchBarComponent no longer uses a SearchBarPresenter, the presenter: param will be removed in 8.0. ' \
-        'Set advanced_search.enabled, autocomplete_enabled, and enable_search_bar_autofocus on BlacklightConfiguration')
     end
     # rubocop:enable Metrics/ParameterLists
 
@@ -74,12 +66,6 @@ module Blacklight
       helpers.blacklight_config
     end
 
-    def render_hash_as_hidden_fields(*args)
-      Deprecation.silence(Blacklight::HashAsHiddenFieldsHelperBehavior) do
-        helpers.render_hash_as_hidden_fields(*args)
-      end
-    end
-
     def scoped_t(key, **args)
       t(key, default: t(key, scope: 'blacklight.search.form'), **@i18n, **args)
     end

data/app/components/blacklight/search_button_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Blacklight
-  class SearchButtonComponent < ::ViewComponent::Base
+  class SearchButtonComponent < Blacklight::Component
     def initialize(text:, id:)
       @text = text
       @id = id
@@ -9,8 +9,8 @@ module Blacklight
 
     def call
       tag.button(class: 'btn btn-primary search-btn', type: 'submit', id: @id) do
-        tag.span(@text, class: "submit-search-text") +
-          blacklight_icon(:search, aria_hidden: true)
+        tag.span(@text, class: "visually-hidden-sm me-sm-1 submit-search-text") +
+          render(Blacklight::Icons::SearchComponent.new)
       end
     end
   end

data/app/components/blacklight/search_context/server_applied_params_component.html.erb

@@ -0,0 +1,4 @@
+<div id="appliedParams" class="clearfix constraints-container">
+  <%= render 'start_over' %>
+  <%= link_back_to_catalog class: 'btn btn-outline-secondary' %>
+</div>

data/app/components/blacklight/search_context/server_applied_params_component.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module SearchContext
+    class ServerAppliedParamsComponent < Blacklight::Component
+      delegate :current_search_session, :link_back_to_catalog, to: :helpers
+
+      def render?
+        current_search_session
+      end
+    end
+  end
+end

data/app/components/blacklight/search_context/server_item_pagination_component.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module SearchContext
+    class ServerItemPaginationComponent < Blacklight::Component
+      with_collection_parameter :search_context
+
+      def initialize(search_context:, search_session:, current_document:)
+        @search_context = search_context
+        @search_session = search_session
+        @current_document_id = current_document.id
+      end
+
+      def render?
+        @search_context.present? && (@search_context[:prev] || @search_context[:next]) && (@search_session['document_id'] == @current_document_id)
+      end
+
+      ##
+      # Displays "showing X of Y items" message.
+      #
+      # @return [String]
+      def item_page_entry_info
+        t('blacklight.search.entry_pagination_info.other', current: number_with_delimiter(count),
+                                                           total: number_with_delimiter(total),
+                                                           count: total).html_safe
+      end
+
+      def link_to_previous_document(previous_document = nil, classes: 'previous', **link_opts)
+        previous_document ||= @search_context[:prev]
+        link_opts = session_tracking_params(previous_document, count - 1, per_page: per_page, search_id: search_id).merge(class: classes, rel: 'prev').merge(link_opts)
+        link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), url_for_document(previous_document), link_opts do
+          tag.span raw(t('views.pagination.previous')), class: 'previous'
+        end
+      end
+
+      def link_to_next_document(next_document = nil, classes: 'next', **link_opts)
+        next_document ||= @search_context[:next]
+        link_opts = session_tracking_params(next_document, count + 1, per_page: per_page, search_id: search_id).merge(class: classes, rel: 'next').merge(link_opts)
+        link_to_unless next_document.nil?, raw(t('views.pagination.next')), url_for_document(next_document), link_opts do
+          tag.span raw(t('views.pagination.next')), class: 'next'
+        end
+      end
+
+      private
+
+      def count
+        @search_session['counter'].to_i
+      end
+
+      def per_page
+        @search_session['per_page']
+      end
+
+      def total
+        @search_session['total'].to_i
+      end
+
+      def search_id
+        @search_session['id'] || helpers.current_search_session&.id
+      end
+
+      def session_tracking_params(...)
+        helpers.session_tracking_params(...)
+      end
+
+      def url_for_document(...)
+        helpers.search_state.url_for_document(...)
+      end
+    end
+  end
+end

data/app/components/blacklight/search_header_component.html.erb

@@ -0,0 +1,2 @@
+<%= render 'did_you_mean' %>
+<%= render 'sort_and_per_page' %>

data/app/components/blacklight/search_header_component.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class SearchHeaderComponent < Blacklight::Component
+  end
+end

data/app/components/blacklight/search_navbar_component.html.erb

@@ -0,0 +1,5 @@
+<%= tag.div class: 'navbar-search navbar navbar-light bg-light', role: 'navigation', aria: { label: t('blacklight.search.header') } do %>
+  <div class="<%= container_classes %>">
+    <%= search_bar %>
+  </div>
+<% end %>

data/app/components/blacklight/search_navbar_component.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class SearchNavbarComponent < Blacklight::Component
+    def initialize(blacklight_config:)
+      @blacklight_config = blacklight_config
+    end
+
+    attr_reader :blacklight_config
+
+    delegate :container_classes, to: :helpers
+
+    def search_bar
+      render search_bar_component
+    end
+
+    def search_bar_component
+      search_bar_component_class.new(
+        url: helpers.search_action_url,
+        advanced_search_url: helpers.search_action_url(action: 'advanced_search'),
+        params: helpers.search_state.params_for_search.except(:qt),
+        autocomplete_path: suggest_index_catalog_path
+      )
+    end
+
+    def search_bar_component_class
+      view_config&.search_bar_component || Blacklight::SearchBarComponent
+    end
+
+    def view_config
+      blacklight_config&.view_config(helpers.document_index_view_type)
+    end
+  end
+end

data/app/components/blacklight/start_over_button_component.rb

@@ -12,9 +12,11 @@ module Blacklight
     # Get the path to the search action with any parameters (e.g. view type)
     # that should be persisted across search sessions.
     def start_over_path query_params = params
-      Deprecation.silence(Blacklight::UrlHelperBehavior) do
-        helpers.start_over_path(query_params)
-      end
+      h = {}
+      current_index_view_type = helpers.document_index_view_type(query_params)
+      h[:view] = current_index_view_type unless current_index_view_type == helpers.default_document_index_view_type
+
+      helpers.search_action_path(h)
     end
   end
 end

data/app/components/blacklight/system/dropdown_component.rb

@@ -2,7 +2,7 @@
 
 module Blacklight
   module System
-    class DropdownComponent < ViewComponent::Base
+    class DropdownComponent < Blacklight::Component
       renders_one :button, (lambda do |classes:, label:|
         button_tag class: classes, aria: { expanded: false }, data: { toggle: 'dropdown', 'bs-toggle': 'dropdown' } do
           safe_join([label, content_tag(:span, '', class: 'caret')])
@@ -29,11 +29,11 @@ module Blacklight
       end
 
       def before_render
-        button(classes: 'btn btn-outline-secondary dropdown-toggle', label: button_label) unless button
+        with_button(classes: 'btn btn-outline-secondary dropdown-toggle', label: button_label) unless button
 
         return if options.any?
 
-        options(@choices.map do |option|
+        with_options(@choices.map do |option|
           text, value = option_text_and_value(option)
           { text: text, url: helpers.url_for(@search_state.params_for_search(@param => value)), selected: @selected == value }
         end)

data/app/components/blacklight/system/flash_message_component.html.erb

@@ -1,4 +1,6 @@
 <div class="alert <%= @classes %>">
   <%= message %>
-  <a class="btn-close close" data-dismiss="alert" data-bs-dismiss="alert" href="#">&times;</a>
+  <%= tag.button_tag button_contents, type: "button", class: "btn-close",
+                     data: { dismiss: "alert", bs_dismiss: "alert" },
+                     aria: { label: "Close" } %>
 </div>

data/app/components/blacklight/system/flash_message_component.rb

@@ -2,18 +2,27 @@
 
 module Blacklight
   module System
-    class FlashMessageComponent < ViewComponent::Base
+    class FlashMessageComponent < Blacklight::Component
       renders_one :message
 
       with_collection_parameter :message
 
-      def initialize(message: nil, type:)
+      def initialize(type:, message: nil)
         @message = message
         @classes = alert_class(type)
       end
 
       def before_render
-        message { @message } if @message
+        with_message { @message } if @message
+      end
+
+      # Bootstrap 4 requires the span, but Bootstrap 5 should not have it.
+      # See https://getbootstrap.com/docs/4.6/components/alerts/#dismissing
+      #     https://getbootstrap.com/docs/5.1/components/alerts/#dismissing
+      def button_contents
+        return if helpers.controller.blacklight_config.bootstrap_version == 5
+
+        tag.span '&times;'.html_safe, aria: { hidden: true }
       end
 
       def alert_class(type)

data/app/components/blacklight/system/modal_component.html.erb

@@ -6,7 +6,7 @@
       <h1 class="modal-title"><%= title %></h1>
     <% end) %>
 
-    <button type="button" class="blacklight-modal-close btn-close close" data-bs-dismiss="modal" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
+    <button type="button" class="blacklight-modal-close btn-close close" data-bl-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
       <span aria-hidden="true" class="visually-hidden">&times;</span>
     </button>
   </div>

data/app/components/blacklight/system/modal_component.rb

@@ -2,9 +2,7 @@
 
 module Blacklight
   module System
-    class ModalComponent < ViewComponent::Base
-      include Blacklight::ContentAreasShim
-
+    class ModalComponent < Blacklight::Component
       renders_one :prefix
       renders_one :header
       renders_one :title

data/app/components/blacklight/top_navbar_component.html.erb

@@ -0,0 +1,12 @@
+<nav class="navbar navbar-expand-md navbar-dark bg-dark topbar" role="navigation">
+  <div class="<%= container_classes %>">
+    <%= logo_link %>
+    <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>
+
+    <div class="collapse navbar-collapse justify-content-md-end" id="user-util-collapse">
+      <%= render 'shared/user_util_links' %>
+    </div>
+  </div>
+</nav>

data/app/components/blacklight/top_navbar_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class TopNavbarComponent < Blacklight::Component
+    def initialize(blacklight_config:)
+      @blacklight_config = blacklight_config
+    end
+
+    attr_reader :blacklight_config
+
+    delegate :application_name, :container_classes, to: :helpers
+
+    def logo_link(title: application_name)
+      link_to title, blacklight_config.logo_link, class: 'mb-0 navbar-brand navbar-logo'
+    end
+  end
+end

data/app/controllers/bookmarks_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class BookmarksController < CatalogController
   include Blacklight::Bookmarks
 end

data/app/controllers/catalog_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CatalogController < ApplicationController
   include Blacklight::Catalog
 end

data/app/controllers/concerns/blacklight/bookmarks.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-# note that while this is mostly restful routing, the #update and #destroy actions
+
+# NOTE: that while this is mostly restful routing, the #update and #destroy actions
 # take the Solr document ID as the :id, NOT the id of the actual Bookmark action.
 module Blacklight::Bookmarks
   extend ActiveSupport::Concern
@@ -14,12 +15,13 @@ module Blacklight::Bookmarks
 
     before_action :verify_user
 
-    blacklight_config.track_search_session = false
+    blacklight_config.track_search_session.storage = false
     blacklight_config.http_method = Blacklight::Engine.config.blacklight.bookmarks_http_method
     blacklight_config.add_results_collection_tool(:clear_bookmarks_widget)
 
     blacklight_config.show.document_actions[:bookmark].if = false if blacklight_config.show.document_actions[:bookmark]
     blacklight_config.show.document_actions[:sms].if = false if blacklight_config.show.document_actions[:sms]
+    blacklight_config.search_builder_class = Blacklight::BookmarksSearchBuilder
   end
 
   def action_documents
@@ -38,11 +40,14 @@ module Blacklight::Bookmarks
     search_catalog_url(*args)
   end
 
+  # @return [Hash] a hash of context information to pass through to the search service
+  def search_service_context
+    { bookmarks: @bookmarks }
+  end
+
   def index
     @bookmarks = token_or_current_or_guest_user.bookmarks
-    bookmark_ids = @bookmarks.collect { |b| b.document_id.to_s }
-    @response, deprecated_document_list = search_service.fetch(bookmark_ids)
-    @document_list = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_document_list, "The @document_list instance variable is now deprecated and will be removed in Blacklight 8.0")
+    @response = search_service.search_results
 
     respond_to do |format|
       format.html {}
@@ -115,7 +120,7 @@ module Blacklight::Bookmarks
         redirect_back fallback_location: bookmarks_path, notice: I18n.t('blacklight.bookmarks.remove.success')
       end
     elsif request.xhr?
-      head 500 # ajaxy request needs no redirect and should not have flash set
+      head :internal_server_error # ajaxy request needs no redirect and should not have flash set
     else
       redirect_back fallback_location: bookmarks_path, flash: { error: I18n.t('blacklight.bookmarks.remove.failure') }
     end