blacklight 8.11.0 → 9.0.0.beta2

data/app/components/blacklight/facets/item_component.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    class ItemComponent < Blacklight::Component
+      attr_reader :label, :href, :hits
+
+      with_collection_parameter :facet_item
+
+      def initialize(facet_item:, wrapping_element: 'li', suppress_link: false)
+        @facet_item = facet_item
+        @label = facet_item.label
+        @hits = facet_item.hits
+        @href = facet_item.href
+        @selected = facet_item.selected?
+        @wrapping_element = wrapping_element
+        @suppress_link = suppress_link
+      end
+
+      def call
+        # if the downstream app has overridden the helper methods we'd usually call,
+        # use the helpers to preserve compatibility
+        content = if @selected
+                    render_selected_facet_value
+                  else
+                    render_facet_value
+                  end
+
+        return '' if content.blank?
+        return content unless @wrapping_element
+
+        content_tag @wrapping_element, content
+      end
+
+      ##
+      # Standard display of a facet value in a list. Used in both _facets sidebar
+      # partial and catalog/facet expanded list. Will output facet value name as
+      # a link to add that to your restrictions, with count in parens.
+      #
+      # @return [String]
+      # @private
+      def render_facet_value
+        tag.span(class: "facet-label") do
+          link_to_unless(@suppress_link, label, href, class: "facet-select", rel: "nofollow")
+        end + render_facet_count
+      end
+
+      ##
+      # Standard display of a SELECTED facet value (e.g. without a link and with a remove button)
+      # @see #render_facet_value
+      #
+      # @private
+      def render_selected_facet_value
+        concat render(Blacklight::Facets::SelectedValueComponent.new(label: label, href: href))
+        concat render_facet_count(classes: ["selected"])
+      end
+
+      ##
+      # Renders a count value for facet limits. Can be over-ridden locally
+      # to change style. And can be called by plugins to get consistent display.
+      #
+      # @param [Hash] options
+      # @option options [Array<String>]  an array of classes to add to count span.
+      # @return [String]
+      # @private
+      def render_facet_count(options = {})
+        classes = (options[:classes] || []) << "facet-count"
+
+        render Blacklight::Facets::CountComponent.new(hits: hits, classes: classes)
+      end
+    end
+  end
+end

data/app/components/blacklight/facets/list_component.html.erb

@@ -0,0 +1,11 @@
+<%= render(@layout.new(facet_field: @facet_field)) do |component| %>
+  <% component.with_label do %>
+    <%= @facet_field.label %>
+  <% end %>
+  <% component.with_body do %>
+    <%= render(Blacklight::Facets::InclusiveConstraintComponent.new(facet_field: @facet_field)) %>
+    <ul class="facet-values list-unstyled">
+      <%= render facet_items %>
+    </ul>
+  <% end %>
+<% end %>

data/app/components/blacklight/facets/list_component.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    class ListComponent < Blacklight::Component
+      def initialize(facet_field:, layout: nil)
+        @facet_field = facet_field
+        @layout = layout == false ? Blacklight::Facets::NoLayoutComponent : Blacklight::Facets::FieldComponent
+      end
+
+      def facet_items(wrapping_element: :li, **item_args)
+        facet_item_component_class.with_collection(facet_item_presenters, wrapping_element: wrapping_element, **item_args)
+      end
+
+      def facet_item_presenters
+        @facet_field.paginator.items.map do |item|
+          facet_item_presenter(item)
+        end
+      end
+
+      def render?
+        @facet_field.paginator&.items&.any?
+      end
+
+      def facet_item_presenter(facet_item)
+        facet_config.item_presenter.new(facet_item, facet_config, helpers, @facet_field.key)
+      end
+
+      def facet_item_component_class
+        facet_config.item_component
+      end
+
+      def facet_config
+        @facet_field.facet_field
+      end
+    end
+  end
+end

data/app/components/blacklight/facets/no_layout_component.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    class NoLayoutComponent < Blacklight::Component
+      renders_one :label
+      renders_one :body
+
+      def initialize(**); end
+
+      def call
+        body.to_s
+      end
+    end
+  end
+end

data/app/components/blacklight/facets/selected_value_component.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    # Standard display of a selected facet value (e.g. without a link and with a remove button)
+    class SelectedValueComponent < Blacklight::Component
+      def initialize(label:, href:)
+        @label = label
+        @href = href
+        super
+      end
+
+      attr_reader :label, :href
+
+      def call
+        tag.span(class: "facet-label") do
+          tag.span(label, class: "selected") + remove_link
+        end
+      end
+
+      def remove_link
+        link_to(href, class: "remove ps-2", rel: "nofollow") do
+          render(Blacklight::Icons::RemoveComponent.new(aria_hidden: true)) +
+            tag.span(t(:'blacklight.search.facets.selected.remove'), class: 'visually-hidden')
+        end
+      end
+    end
+  end
+end

data/app/components/blacklight/facets/suggest_component.html.erb

@@ -0,0 +1,12 @@
+<label for="facet_suggest_<%= key %>">
+  <%= I18n.t('blacklight.search.facets.suggest.label', field_label: label) %>
+</label>
+<%= text_field_tag "facet_suggest_#{key}",
+  nil,
+  class: "facet-suggest form-control mb-3",
+  data: {
+    facet_field: key,
+    facet_search_context: helpers.search_facet_path(id: key)
+  },
+  placeholder: I18n.t('blacklight.search.form.search.placeholder')
+%>

data/app/components/blacklight/facets/suggest_component.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    class SuggestComponent < Blacklight::Component
+      def initialize(presenter:)
+        @presenter = presenter
+      end
+
+      private
+
+      attr_accessor :presenter
+
+      delegate :suggest, :key, :label, to: :presenter
+
+      def render?
+        # Draw if suggest is true or not present
+        suggest != false
+      end
+    end
+  end
+end

data/app/components/blacklight/metadata_field_plain_text_layout_component.rb

@@ -4,8 +4,8 @@ module Blacklight
   class MetadataFieldPlainTextLayoutComponent < Blacklight::MetadataFieldLayoutComponent
     with_collection_parameter :field
 
-    def initialize(field:, **kwargs)
-      super(field: field, **kwargs, value_tag: nil)
+    def initialize(field:, **)
+      super(field: field, **, value_tag: nil)
     end
 
     # rubocop:disable Rails/OutputSafety

data/app/components/blacklight/response/facet_group_component.html.erb

@@ -1,27 +1,12 @@
 <% # main container for facets/limits menu -%>
 <%= content_tag :div, id: @id,  class: 'facets sidenav facets-toggleable-md' do %>
   <div class="facets-header">
-    <%= content_tag :h2, @title, class: 'facets-heading' if @title %>
+    <%= content_tag :h2, @title, class: 'facets-heading h4' if @title %>
 
-    <%= content_tag :button,
-      class: 'btn btn-outline-secondary facet-toggle-button d-block d-lg-none',
-      type: 'button',
-      data: {
-        toggle: 'collapse',
-        target: "##{@panel_id}",
-        'bs-toggle': 'collapse',
-        'bs-target': "##{@panel_id}"
-      },
-      aria: {
-        controls: @panel_id,
-        expanded: 'false',
-      } do %>
-      <span data-show-label><%= t('blacklight.search.facets.group.open') %></span>
-      <span data-hide-label><%= t('blacklight.search.facets.group.close') %></span>
-    <% end %>
+    <%= collapse_toggle_button(@panel_id) %>
   </div>
 
-  <div id="<%= @panel_id %>" class="facets-collapse collapse">
+  <div id="<%= @panel_id %>" class="<%= body_classes %>">
     <%= body %>
   </div>
 <% end %>

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

@@ -6,41 +6,29 @@ module Blacklight
     class FacetGroupComponent < Blacklight::Component
       renders_one :body
 
-      # @param [Blacklight::Response] response
-      # @param [Array<Blacklight::Configuration::FacetField>] fields facet fields to render
-      # @param [String] title the title of the facet group section
       # @param [String] id a unique identifier for the group
-      def initialize(id:, title: nil, fields: [], response: nil)
+      # @param [String] title the title of the facet group section
+      def initialize(id:, title: nil, body_classes: 'facets-collapse d-lg-block collapse accordion')
         @groupname = id
         @id = id ? "facets-#{id}" : 'facets'
         @title = title || I18n.t("blacklight.search.#{@id}.title")
         @panel_id = id ? "facet-panel-#{id}-collapse" : 'facet-panel-collapse'
-
-        # deprecated variables
-        @fields = fields
-        @response = response
+        @body_classes = body_classes
       end
 
-      # Provide fallback behavior for rendering this object without a body slot
-      def before_render
-        set_slot(:body, nil) { default_body } unless body?
-      end
+      attr_accessor :body_classes
 
-      def render?
-        body.present?
+      def collapse_toggle_button(panel_id)
+        render button_component.new(panel_id: panel_id)
       end
 
-      private
-
-      # @deprecated
-      def default_body
-        Blacklight.deprecation.warn('Rendering the Blacklight::FacetGroupComponent without a body slot is deprecated.')
-        render(Blacklight::FacetComponent.with_collection(@fields, response: @response))
+      def button_component
+        Blacklight::Response::FacetToggleButtonComponent
       end
 
-      # @deprecated
-      def blacklight_config
-        helpers.blacklight_config
+      def render?
+        # debugger
+        body.present?
       end
     end
   end

data/app/components/blacklight/response/facet_toggle_button_component.html.erb

@@ -0,0 +1,16 @@
+<%= content_tag :button,
+  class: @classes,
+  type: 'button',
+  data: {
+    toggle: 'collapse',
+    target: "##{@panel_id}",
+    'bs-toggle': 'collapse',
+    'bs-target': "##{@panel_id}"
+  },
+  aria: {
+    controls: @panel_id,
+    expanded: 'false',
+  } do %>
+  <span data-show-label><%= t('blacklight.search.facets.group.open') %></span>
+  <span data-hide-label><%= t('blacklight.search.facets.group.close') %></span>
+<% end %>

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Response
+    # Render the button that shows or collapses the facets on a narrow viewport
+    class FacetToggleButtonComponent < Blacklight::Component
+      # @param [String] panel_id
+      def initialize(panel_id:, classes: 'btn btn-outline-secondary facet-toggle-button d-block d-lg-none')
+        @panel_id = panel_id
+        @classes = classes
+      end
+    end
+  end
+end

data/app/components/blacklight/response/pagination_component.html.erb

@@ -1,3 +1,3 @@
-<%= tag.nav class: 'paginate-section', **html_attr do %>
+<%= tag.nav class: @classes, **html_attr do %>
   <%= pagination %>
 <% end %>

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

@@ -6,9 +6,10 @@ module Blacklight
     class PaginationComponent < Blacklight::Component
       # @param [Blacklight::Response] response
       # @param [Hash] html html options for the pagination container
-      def initialize(response:, html: {}, **pagination_args)
+      def initialize(response:, html: {}, classes: 'paginate-section', **pagination_args)
         @response = response
         @html = html
+        @classes = classes
         @pagination_args = pagination_args
       end
 

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

@@ -22,6 +22,7 @@ module Blacklight
                  param: @param,
                  choices: @choices,
                  id: @id,
+                 classes: @classes,
                  search_state: @search_state,
                  selected: @selected
                ))

data/app/components/blacklight/response/view_type_button_component.html.erb

@@ -1,4 +1,4 @@
 <%= link_to url, title: label, aria: aria_attributes, class: "#{Array(@classes).join(' ')} view-type-#{ @key.to_s.parameterize } #{"active" if selected?}" do %>
   <%= icon %>
-  <span class="caption"><%= label %></span>
+  <span class="caption visually-hidden"><%= label %></span>
 <% end %>

data/app/components/blacklight/response/view_type_component.html.erb

@@ -1,5 +1,5 @@
 <div class="view-type">
-  <span class="sr-only visually-hidden"><%= t('blacklight.search.view_title') %></span>
+  <span class="visually-hidden"><%= t('blacklight.search.view_title') %></span>
   <div class="view-type-group btn-group">
     <% views.each do |view| %>
       <%= view %>

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

@@ -1,2 +1,2 @@
-<span class="sr-only visually-hidden"><%= t('blacklight.search.per_page.title') %></span>
+<span class="visually-hidden"><%= t('blacklight.search.per_page.title') %></span>
 <%= dropdown %>

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

@@ -23,6 +23,7 @@ module Blacklight
                  param: :per_page,
                  choices: per_page_options_for_select,
                  id: 'per_page-dropdown',
+                 classes: ['mx-1'],
                  search_state: @search_state,
                  selected: current_per_page,
                  interpolation: :count

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

@@ -1,7 +1,7 @@
 <search>
   <% 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| %>
+    <%= render group_component_class.new(id: groupname) do |component| %>
       <% component.with_body do %>
         <%= render Blacklight::FacetComponent.with_collection(fields, response: response) %>
       <% end %>

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

@@ -6,7 +6,7 @@ module Blacklight
       def initialize(blacklight_config:, response:, view_config:)
         @blacklight_config = blacklight_config
         @response = response
-        @group_component_class = view_config.facet_group_component || Blacklight::Response::FacetGroupComponent
+        @group_component_class = view_config.facet_group_component
       end
 
       attr_reader :group_component_class, :response

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

@@ -2,7 +2,7 @@
   <%= form_with url: @url, local: true, method: @method, class: @classes.join(' '), scope: @prefix, role: 'search', **@form_options do |f| %>
     <%= render Blacklight::HiddenSearchStateComponent.new(params: @params) %>
     <% if search_fields.length > 1 %>
-      <%= f.label :search_field, scoped_t('search_field.label'), class: 'sr-only visually-hidden' %>
+      <%= f.label :search_field, scoped_t('search_field.label'), class: 'visually-hidden' %>
     <% end %>
     <% before_input_groups.each do |input_group| %>
       <%= input_group %>
@@ -20,9 +20,9 @@
         <%= f.hidden_field :search_field, value: search_fields.first.last %>
       <% end %>
 
-      <%= f.label @query_param, scoped_t('search.label'), class: 'sr-only visually-hidden' %>
+      <%= f.label @query_param, scoped_t('search.label'), class: 'visually-hidden' %>
       <% if autocomplete_path.present? %>
-        <auto-complete src="<%= autocomplete_path %>" for="autocomplete-popup" class="search-autocomplete-wrapper <%= rounded_border_class %>">
+        <auto-complete src="<%= autocomplete_path %>" for="autocomplete-popup" class="search-autocomplete-wrapper form-control <%= rounded_border_class %>">
           <%= f.search_field @query_param, value: @q, placeholder: scoped_t('search.placeholder'), class: "search-q q form-control #{rounded_border_class}", autofocus: @autofocus, aria: { label: scoped_t('search.label'), autocomplete: 'list', controls: 'autocomplete-popup' }  %>
           <ul id="autocomplete-popup" class="dropdown-menu" role="listbox" aria-label="<%= scoped_t('search.label') %>" hidden></ul>
         </auto-complete>

data/app/components/blacklight/search_bar_component.rb

@@ -11,7 +11,7 @@ module Blacklight
     def initialize(
       url:, params:,
       advanced_search_url: nil,
-      classes: ['search-query-form'], prefix: nil,
+      classes: %w[search-query-form col-md-12 col-lg-8], prefix: nil,
       method: 'GET', q: nil, query_param: :q,
       search_field: nil, autocomplete_path: nil,
       autofocus: nil, i18n: { scope: 'blacklight.search.form' },
@@ -63,7 +63,7 @@ module Blacklight
     def rounded_border_class
       return 'rounded-0' if search_fields.length > 1
 
-      'rounded-left rounded-start'
+      'rounded-start'
     end
 
     private

data/app/components/blacklight/search_button_component.rb

@@ -8,8 +8,8 @@ module Blacklight
     end
 
     def call
-      tag.button(class: 'btn btn-primary search-btn', type: 'submit', id: @id) do
-        tag.span(@text, class: "visually-hidden-sm me-sm-1 submit-search-text") +
+      tag.button(class: 'btn btn-primary search-btn', type: 'submit', id: @id, aria: { label: @text }) do
+        tag.span(@text, class: "d-none d-md-inline me-sm-1 submit-search-text", aria: { hidden: true }) +
           render(Blacklight::Icons::SearchComponent.new)
       end
     end

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

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

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

@@ -2,12 +2,21 @@
 
 module Blacklight
   module SearchContext
+    # This is displayed on the show page when the user has a search session.
     class ServerAppliedParamsComponent < Blacklight::Component
       delegate :current_search_session, :link_back_to_catalog, to: :helpers
 
       def render?
         current_search_session
       end
+
+      def start_over
+        render start_over_component.new
+      end
+
+      def start_over_component
+        Blacklight::StartOverButtonComponent
+      end
     end
   end
 end

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

@@ -1,4 +1,4 @@
-<nav id="skip-link" class="visually-hidden-focusable sr-only sr-only-focusable" aria-label="<%= t('blacklight.skip_links.label') %>">
+<nav id="skip-link" class="visually-hidden-focusable" aria-label="<%= t('blacklight.skip_links.label') %>">
   <div class="container-xl">
     <%= link_to_main %>
     <%= link_to_search %>

data/app/components/blacklight/skip_link_component.rb

@@ -20,7 +20,8 @@ module Blacklight
     delegate :skip_link_item_component, to: :blacklight_config
 
     def link_classes
-      'd-inline-flex p-2 m-1'
+      Blacklight.deprecation.warn("Use SkipLinkItemComponent instead")
+      'visually-hidden-focusable rounded-bottom py-2 px-3'
     end
   end
 end

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

@@ -1,7 +1,7 @@
-<nav class="navbar navbar-expand-md navbar-dark bg-dark topbar" aria-label="<%= aria_label %>">
+<nav class="navbar navbar-expand-md bg-dark topbar" aria-label="<%= aria_label %>">
   <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">
+    <button class="navbar-toggler" 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>
 

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

@@ -36,8 +36,8 @@ module Blacklight::Bookmarks
 
   # Blacklight uses #search_action_url to figure out the right URL for
   # the global search box
-  def search_action_url *args
-    search_catalog_url(*args)
+  def search_action_url(*)
+    search_catalog_url(*)
   end
 
   # @return [Hash] a hash of context information to pass through to the search service
@@ -110,7 +110,7 @@ module Blacklight::Bookmarks
 
     success = @bookmarks.all? do |bookmark|
       bookmark = current_or_guest_user.bookmarks.find_by(bookmark)
-      bookmark && bookmark.delete && bookmark.destroyed?
+      bookmark&.delete && bookmark.destroyed?
     end
 
     if success

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

@@ -9,13 +9,13 @@ module Blacklight::Catalog
   include Blacklight::Configurable
   include Blacklight::SearchContext
   include Blacklight::Searchable
+  include Blacklight::Facetable
 
   # The following code is executed when someone includes blacklight::catalog in their
   # own controller.
   included do
     if respond_to? :helper_method
       helper_method :sms_mappings, :has_search_parameters?
-      helper_method :search_facet_path
     end
 
     record_search_parameters
@@ -80,16 +80,19 @@ module Blacklight::Catalog
 
   # displays values and pagination links for a single facet field
   def facet
+    # @facet is a Blacklight::Configuration::FacetField
     @facet = blacklight_config.facet_fields[params[:id]]
     raise ActionController::RoutingError, 'Not Found' unless @facet
 
     @response = if params[:query_fragment].present?
-                  search_service.facet_suggest_response(@facet.key, params[:query_fragment])
+                  facet_search_service.facet_suggest_response(@facet.key, params[:query_fragment])
                 else
-                  search_service.facet_field_response(@facet.key)
+                  facet_search_service.facet_field_response(@facet.key)
                 end
+
     @display_facet = @response.aggregations[@facet.field]
 
+    # @presenter is a Blacklight::FacetFieldPresenter
     @presenter = @facet.presenter.new(@facet, @display_facet, view_context)
     @pagination = @presenter.paginator
     respond_to do |format|
@@ -138,15 +141,6 @@ module Blacklight::Catalog
     params[:search_field].present? || search_state.has_constraints?
   end
 
-  def search_facet_path(options = {})
-    opts = search_state
-           .to_h
-           .merge(action: "facet", only_path: true)
-           .merge(options)
-           .except(:page)
-    url_for opts
-  end
-
   private
 
   #
@@ -235,22 +229,14 @@ module Blacklight::Catalog
   # Email Action (this will render the appropriate view on GET requests and process the form and send the email on POST requests)
   def email_action documents
     mail = RecordMailer.email_record(documents, { to: params[:to], message: params[:message], config: blacklight_config }, url_options)
-    if mail.respond_to? :deliver_now
-      mail.deliver_now
-    else
-      mail.deliver
-    end
+    mail.deliver_now
   end
 
   # SMS action (this will render the appropriate view on GET requests and process the form and send the email on POST requests)
   def sms_action documents
     to = "#{params[:to].gsub(/[^\d]/, '')}@#{params[:carrier]}"
     mail = RecordMailer.sms_record(documents, { to: to, config: blacklight_config }, url_options)
-    if mail.respond_to? :deliver_now
-      mail.deliver_now
-    else
-      mail.deliver
-    end
+    mail.deliver_now
   end
 
   def validate_sms_params
@@ -292,7 +278,7 @@ module Blacklight::Catalog
   def blacklight_advanced_search_form_search_service
     form_search_state = search_state_class.new(blacklight_advanced_search_form_params, blacklight_config, self)
 
-    search_service_class.new(config: blacklight_config, search_state: form_search_state, user_params: form_search_state.to_h, **search_service_context)
+    search_service_class.new(config: blacklight_config, search_state: form_search_state, **search_service_context)
   end
 
   def blacklight_advanced_search_form_params

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

@@ -130,7 +130,7 @@ module Blacklight::Controller
     # send the user home if the access was previously denied by the same
     # request to avoid sending the user back to the login page
     #   (e.g. protected page -> logout -> returned to protected page -> home)
-    redirect_to(root_url) && flash.discard && return if request.referer && request.referer.ends_with?(request.fullpath)
+    redirect_to(root_url) && flash.discard && return if request.referer&.ends_with?(request.fullpath)
 
     redirect_to(root_url) && return unless has_user_authentication_provider?