blacklight 7.37.0 → 8.0.0.beta1

data/app/components/blacklight/facet_field_list_component.rb

@@ -7,16 +7,48 @@ module Blacklight
       @layout = layout == false ? FacetFieldNoLayoutComponent : Blacklight::FacetFieldComponent
     end
 
-    # Here for backwards compatibility only.
-    # @private
-    def render_facet_limit_list(*args)
-      Deprecation.silence(Blacklight::FacetsHelperBehavior) do
-        helpers.render_facet_limit_list(*args)
+    ##
+    # Renders the list of values
+    # removes any elements where render_facet_item returns a nil value. This enables an application
+    # to filter undesireable facet items so they don't appear in the UI
+    # @deprecated
+    def render_facet_limit_list(paginator, facet_field, wrapping_element = :li)
+      return render(facet_items(wrapping_element: wrapping_element)) if paginator == @facet_field.paginator && facet_field == @facet_field.key
+
+      facet_config ||= helpers.facet_configuration_for_field(facet_field)
+
+      collection = paginator.items.map do |item|
+        facet_item_presenter(item, facet_config, facet_field)
+      end
+
+      render(facet_item_component_class(facet_config).with_collection(collection, wrapping_element: wrapping_element))
+    end
+    Blacklight.deprecation.deprecate_methods(self, render_facet_limit_list: 'Call e.g. `render facet_items` instead')
+
+    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, deprecated_facet_config = nil, facet_field = nil)
+      (deprecated_facet_config || facet_config).item_presenter.new(facet_item, deprecated_facet_config || facet_config, helpers, facet_field || @facet_field.key)
+    end
+
+    def facet_item_component_class(deprecated_facet_config = nil)
+      (deprecated_facet_config || facet_config).item_component
+    end
+
+    def facet_config
+      @facet_field.facet_field
+    end
   end
 end

data/app/components/blacklight/facet_field_no_layout_component.rb

@@ -2,8 +2,6 @@
 
 module Blacklight
   class FacetFieldNoLayoutComponent < Blacklight::Component
-    include Blacklight::ContentAreasShim
-
     renders_one :label
     renders_one :body
 

data/app/components/blacklight/facet_item_component.rb

@@ -2,8 +2,6 @@
 
 module Blacklight
   class FacetItemComponent < Blacklight::Component
-    extend Deprecation
-
     attr_reader :label, :href, :hits
 
     with_collection_parameter :facet_item
@@ -21,9 +19,7 @@ module Blacklight
     def call
       # if the downstream app has overridden the helper methods we'd usually call,
       # use the helpers to preserve compatibility
-      content = if overridden_helper_methods?
-                  content_from_legacy_view_helper
-                elsif @selected
+      content = if @selected
                   render_selected_facet_value
                 else
                   render_facet_value
@@ -35,36 +31,6 @@ module Blacklight
       content_tag @wrapping_element, content
     end
 
-    # This is a little shim to let us call the render methods below outside the
-    # usual component rendering cycle (for backward compatibility)
-    # @private
-    # @deprecated
-    def with_view_context(view_context)
-      @view_context = view_context
-      self
-    end
-
-    # Check if the downstream application has overridden these methods
-    # @deprecated
-    # @private
-    def overridden_helper_methods?
-      return false if explicit_component_configuration?
-
-      helpers.method(:render_facet_item).owner != Blacklight::FacetsHelperBehavior ||
-        helpers.method(:render_facet_value).owner != Blacklight::FacetsHelperBehavior ||
-        helpers.method(:render_selected_facet_value).owner != Blacklight::FacetsHelperBehavior
-    end
-
-    # Call out to the helper method equivalent of this component
-    # @deprecated
-    # @private
-    def content_from_legacy_view_helper
-      Deprecation.warn(self.class, 'Calling out to the #render_facet_item helper for backwards compatibility.')
-      Deprecation.silence(Blacklight::FacetsHelperBehavior) do
-        @view_context.render_facet_item(@facet_item.facet_field, @facet_item.facet_item)
-      end
-    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
@@ -103,18 +69,10 @@ module Blacklight
     # @return [String]
     # @private
     def render_facet_count(options = {})
-      return helpers.render_facet_count(hits, options) unless helpers.method(:render_facet_count).owner == Blacklight::FacetsHelperBehavior || explicit_component_configuration?
-
       return '' if hits.blank?
 
       classes = (options[:classes] || []) << "facet-count"
       tag.span(t('blacklight.search.facets.count', number: number_with_delimiter(hits)), class: classes)
     end
-
-    private
-
-    def explicit_component_configuration?
-      @facet_item.facet_config.item_component.present?
-    end
   end
 end

data/app/components/blacklight/facet_item_pivot_component.rb

@@ -6,7 +6,7 @@ module Blacklight
     # Somewhat arbitrary number; the only important thing is that
     # it is bigger than the number of leaf nodes in any collapsing
     # pivot facet on the page.
-    ID_COUNTER_MAX = 2**20 - 1
+    ID_COUNTER_MAX = (2**20) - 1
 
     # Mint a (sufficiently) unique identifier, so we can associate
     # the expand/collapse control with labels
@@ -24,7 +24,7 @@ module Blacklight
       @wrapping_element = wrapping_element
       @suppress_link = suppress_link
       @collapsing = collapsing.nil? ? facet_item.facet_config.collapsing : collapsing
-      @icons = { show: '⊞', hide: '⊟' }.merge(facet_item.facet_config.icons || {})
+      @icons = { show: tag.span(class: 'icon'), hide: tag.span(class: 'icon') }.merge(facet_item.facet_config.icons || {})
     end
 
     def call
@@ -32,15 +32,16 @@ module Blacklight
 
       id = "h-#{self.class.mint_id}" if @collapsing && has_items?
 
-      content_tag @wrapping_element, role: 'treeitem' do
-        concat facet_toggle_button(id) if has_items? && @collapsing
-        concat content_tag('span', render_component(facet), class: "facet-values #{'facet-leaf-node' if has_items? && @collapsing}", id: id && "#{id}_label")
-
+      content_tag @wrapping_element, role: 'treeitem', class: 'treeitem' do
+        concat(content_tag('span', class: "d-flex flex-row align-items-center") do
+          concat facet_toggle_button(id) if has_items? && @collapsing
+          concat content_tag('span', render(facet), class: "facet-values d-flex flex-row flex-grow-1 #{'facet-leaf-node' if has_items? && @collapsing}", id: id && "#{id}_label")
+        end)
         if has_items?
-          concat(content_tag('ul', class: "pivot-facet list-unstyled #{'collapse' if @collapsing}", id: id, role: 'group') do
-            render_component(
+          concat(content_tag('ul', class: "pivot-facet flex-column list-unstyled ps-4 #{'collapse' if @collapsing} #{'show' if expanded?}", id: id, role: 'group') do
+            render(
               self.class.with_collection(
-                @facet_item.items.map { |i| facet_item_presenter(i) }
+                @facet_item.facet_item_presenters.to_a
               )
             )
           end)
@@ -51,13 +52,21 @@ module Blacklight
     private
 
     def has_items?
-      @facet_item.items.present?
+      return unless @facet_item.respond_to? :facet_item_presenters
+
+      @facet_item.facet_item_presenters.any?
+    end
+
+    def expanded?
+      return unless @collapsing
+
+      @facet_item.shown?
     end
 
     def facet_toggle_button(id)
-      content_tag 'button', class: 'btn facet-toggle-handle collapsed',
+      content_tag 'button', class: %w[btn facet-toggle-handle] + [('collapsed' unless expanded?)],
                             data: { toggle: 'collapse', 'bs-toggle': 'collapse', target: "##{id}", 'bs-target': "##{id}" },
-                            aria: { expanded: false, controls: id, describedby: "#{id}_label" } do
+                            aria: { expanded: expanded?, controls: id, describedby: "#{id}_label" } do
         concat toggle_icon(:show)
         concat toggle_icon(:hide)
       end
@@ -69,16 +78,5 @@ module Blacklight
         concat content_tag('span', t(type, scope: 'blacklight.search.facets.pivot'), class: 'sr-only visually-hidden')
       end
     end
-
-    # This is a little convoluted in Blacklight 7 in order to maintain backwards-compat
-    # with overrides of deprecated helpers. In 8.x, we can just call Component#render_in
-    # and call it a day
-    def render_component(component)
-      helpers.render(component)
-    end
-
-    def facet_item_presenter(facet_item)
-      (@facet_item.facet_config.item_presenter || Blacklight::FacetItemPresenter).new(facet_item, @facet_item.facet_config, helpers, @facet_item.facet_field, @facet_item.search_state)
-    end
   end
 end

data/app/components/blacklight/header_component.rb

@@ -17,7 +17,7 @@ module Blacklight
     attr_reader :blacklight_config
 
     # Hack so that the default lambdas are triggered
-    # so that we don't have to do c.top_bar() in the call.
+    # so that we don't have to do c.with_top_bar() in the call.
     def before_render
       set_slot(:top_bar, nil) unless top_bar
       set_slot(:search_bar, nil) unless search_bar

data/app/components/blacklight/hidden_search_state_component.rb

@@ -7,8 +7,7 @@ module Blacklight
   class HiddenSearchStateComponent < Blacklight::Component
     # @param [Hash] params
     def initialize(params:)
-      Deprecation.warn(self, "Passing page as a parameter to HiddenSearchStateComponent is deprecated and will not be supported in Blacklight 8") if params.key?(:page)
-      @params = params.except(:utf8)
+      @params = params.except(:page, :utf8)
     end
 
     def call

data/app/components/blacklight/icons/legacy_icon_component.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    class LegacyIconComponent < ::ViewComponent::Base
+      def initialize(name:, classes: '', aria_hidden: false, label: true, role: 'img', additional_options: {})
+        @name = name
+        @classes = classes
+        @aria_hidden = aria_hidden
+        @icon = Blacklight::Icon.new(name, classes: classes, label: label, role: role, additional_options: additional_options)
+      end
+
+      def call
+        tag.span(svg&.html_safe || default_icon,  # rubocop:disable Rails/OutputSafety
+                 class: "blacklight-icons blacklight-icon-#{@name} #{@classes}".strip,
+                 'aria-hidden': (true if @aria_hidden))
+      end
+
+      def svg
+        Rails.cache.fetch([:blacklight_icon_svg, @name]) do
+          @icon.svg if @icon.present?
+        end
+      end
+
+      def default_icon
+        @icon.icon_label
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # This is the list icon for the search button.
+    # You can override the default svg by setting:
+    #   Blacklight::Icons::ListComponent.svg = '<svg>your SVG here</svg>'
+    class ListComponent < Blacklight::Icons::IconComponent
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" aria-hidden="true" width="24" height="24" viewBox="0 0 24 24">
+          <path d="M3 13h2v-2H3v2zm0 4h2v-2H3v2zm0-8h2V7H3v2zm4 4h14v-2H7v2zm0 4h14v-2H7v2zM7 7v2h14V7H7z"/><path d="M0 0h24v24H0z" fill="none"/>
+        </svg>
+      SVG
+    end
+  end
+end

data/app/components/blacklight/icons/search_component.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # This is the magnifing glass icon for the search button.
+    # You can override the default svg by setting:
+    #   Blacklight::Icons::SearchComponent.svg = '<svg>your SVG here</svg>'
+    class SearchComponent < Blacklight::Icons::IconComponent
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" aria-hidden="true" width="24" height="24" viewBox="0 0 24 24">
+          <path fill="none" d="M0 0h24v24H0V0z"/><path d="M15.5 14h-.79l-.28-.27C15.41 12.59 16 11.11 16 9.5 16 5.91 13.09 3 9.5 3S3 5.91 3 9.5 5.91 16 9.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19l-4.99-5zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"/>
+        </svg>
+      SVG
+    end
+  end
+end

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

@@ -1,8 +1,8 @@
 <%= render(@layout.new(field: @field)) do |component| %>
-  <% component.with_label do %>
+  <% component.label do %>
     <%= label %>
   <% end %>
-  <% component.with_value do %>
+  <% component.value do %>
     <%= @field.render %>
   <% end %>
 <% end %>

data/app/components/blacklight/metadata_field_component.rb

@@ -7,25 +7,41 @@ module Blacklight
     # @param field [Blacklight::FieldPresenter]
     # @param layout [Blacklight::MetadataFieldLayoutComponent] alternate layout component to use
     # @param show [Boolean] are we showing only a single document (vs a list of search results); used for backwards-compatibility
-    def initialize(field:, layout: nil, show: false)
+    def initialize(field:, layout: nil, show: false, view_type: nil)
       @field = field
       @layout = layout || Blacklight::MetadataFieldLayoutComponent
+      @view_type = view_type
       @show = show
     end
 
-    # @private
     def label
-      Deprecation.silence(Blacklight::BlacklightHelperBehavior) do
-        if @show
-          helpers.render_document_show_field_label @field.document, label: @field.label('show'), field: @field.key
-        else
-          helpers.render_index_field_label @field.document, label: @field.label, field: @field.key
-        end
+      if @show
+        show_field_label @field.label('show')
+      else
+        index_field_label @field.label
       end
     end
 
     def render?
       @field.render_field?
     end
+
+    ##
+    # Render the index field label for a document
+    #
+    # Translations for index field labels should go under blacklight.search.fields
+    # They are picked up from there by a value "%{label}" in blacklight.search.index.label
+    # @return [String]
+    def index_field_label label
+      html_escape t(:"blacklight.search.index.#{@view_type}.label", default: :'blacklight.search.index.label', label: label)
+    end
+
+    ##
+    # Render the show field label for a document
+    #
+    # @return [String]
+    def show_field_label label
+      t(:'blacklight.search.show.label', label: label)
+    end
   end
 end

data/app/components/blacklight/metadata_field_layout_component.rb

@@ -2,43 +2,22 @@
 
 module Blacklight
   class MetadataFieldLayoutComponent < Blacklight::Component
-    include Blacklight::ContentAreasShim
-
     with_collection_parameter :field
     renders_one :label
     renders_many :values, (lambda do |value: nil, &block|
-      if @value_tag.nil?
-        block&.call || value
-      elsif block
-        content_tag @value_tag, class: "#{@value_class} blacklight-#{@key}", &block
+      if block
+        content_tag :dd, class: "#{@value_class} blacklight-#{@key}", &block
       else
-        content_tag @value_tag, value, class: "#{@value_class} blacklight-#{@key}"
+        content_tag :dd, value, class: "#{@value_class} blacklight-#{@key}"
       end
     end)
 
     # @param field [Blacklight::FieldPresenter]
-    def initialize(field:, value_tag: 'dd', label_class: 'col-md-3', value_class: 'col-md-9')
+    def initialize(field:, label_class: 'col-md-3', value_class: 'col-md-9')
       @field = field
       @key = @field.key.parameterize
       @label_class = label_class
-      @value_tag = value_tag
       @value_class = value_class
     end
-
-    def value(*args, **kwargs, &block)
-      return set_slot(:values, nil, *args, **kwargs, &block) if block_given?
-
-      Deprecation.warn(Blacklight::MetadataFieldLayoutComponent, 'The `value` content area is deprecated; render from the values slot instead')
-
-      values.first
-    end
-
-    def with(slot_name, *args, **kwargs, &block)
-      if slot_name == :value
-        super(:values, *args, **kwargs, &block)
-      else
-        super
-      end
-    end
   end
 end

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

@@ -21,9 +21,7 @@
     <% end %>
   </div>
 
-  <%= content_tag :div, id: @panel_id, class: 'facets-collapse collapse' do %>
-    <% ::Deprecation.silence(Blacklight::FacetsHelperBehavior) do %>
-      <%= helpers.render_facet_partials @fields, response: @response %>
-    <% end %>
-  <% end %>
+  <div id="<%= @panel_id %>" class="facets-collapse collapse">
+    <%= body %>
+  </div>
 <% end %>

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

@@ -4,22 +4,43 @@ module Blacklight
   module Response
     # Render a group of facet fields
     class FacetGroupComponent < Blacklight::Component
+      renders_one :body
+
       # @param [Blacklight::Response] response
-      # @param [Array<String>] fields facet fields to render
+      # @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(response:, fields: [], title: nil, id: nil)
-        @response = response
-        @fields = fields
-        @title = title
+      def initialize(id:, title: nil, fields: [], response: nil)
+        @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
+      end
+
+      # Provide fallback behavior for rendering this object without a body slot
+      def before_render
+        set_slot(:body, nil) { default_body } unless body
       end
 
       def render?
-        Deprecation.silence(Blacklight::FacetsHelperBehavior) do
-          helpers.has_facet_values?(@fields, @response)
-        end
+        body.present?
+      end
+
+      private
+
+      # @deprecated
+      def default_body
+        Blacklight.deprecation.warn('Rendering the Blacklight::FacetGroupComponent without a body slot is deprecated.')
+        helpers.render(Blacklight::FacetComponent.with_collection(@fields, response: @response))
+      end
+
+      # @deprecated
+      def blacklight_config
+        helpers.blacklight_config
       end
     end
   end

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

@@ -1,3 +1,3 @@
-<%= content_tag :section, class: 'pagination',  **html_attr do %>
+<%= content_tag :section, class: 'pagination',  **@html_attr do %>
   <%= pagination %>
 <% end %>

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

@@ -8,14 +8,10 @@ module Blacklight
       # @param [Hash] html html options for the pagination container
       def initialize(response:, html: {}, **pagination_args)
         @response = response
-        @html = html
+        @html_attr = { aria: { label: t('views.pagination.aria.container_label') } }.merge(html)
         @pagination_args = pagination_args
       end
 
-      def html_attr
-        { aria: { label: t('views.pagination.aria.container_label') } }.merge(@html)
-      end
-
       def pagination
         helpers.paginate @response, **Blacklight::Engine.config.blacklight.default_pagination_options, **@pagination_args
       end

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

@@ -3,7 +3,7 @@
 module Blacklight
   module Response
     class SortComponent < ViewComponent::Base
-      def initialize(param: 'sort', choices: {}, search_state:, id: 'sort-dropdown', classes: [], selected: nil)
+      def initialize(search_state:, param: 'sort', choices: {}, id: 'sort-dropdown', classes: [], selected: nil)
         @param = param
         @choices = choices
         @search_state = search_state

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

@@ -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

@@ -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

@@ -7,7 +7,7 @@ module Blacklight
       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|
-          with_view(key: key, view: config, selected: @selected == key, search_state: @search_state)
+          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.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