blacklight 7.6.0 → 7.10.0

data/app/components/blacklight/facet_item_pivot_component.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Blacklight
+  # Render facet items and any subtree
+  class FacetItemPivotComponent < ::ViewComponent::Base
+    # 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
+
+    # Mint a (sufficiently) unique identifier, so we can associate
+    # the expand/collapse control with labels
+    def self.mint_id
+      @id_counter = ((@id_counter || 0) + 1) % ID_COUNTER_MAX
+
+      # We convert the ID to hex for markup compactness
+      @id_counter.to_s(16)
+    end
+
+    with_collection_parameter :facet_item
+
+    def initialize(facet_item:, wrapping_element: 'li', suppress_link: false, collapsing: nil)
+      @facet_item = facet_item
+      @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 || {})
+    end
+
+    def call
+      facet = Blacklight::FacetItemComponent.new(facet_item: @facet_item, wrapping_element: nil, suppress_link: @suppress_link)
+
+      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")
+
+        if has_items?
+          concat(content_tag('ul', class: "pivot-facet list-unstyled #{'collapse' if @collapsing}", id: id, role: 'group') do
+            render_component(
+              self.class.with_collection(
+                @facet_item.items.map { |i| facet_item_presenter(i) }
+              )
+            )
+          end)
+        end
+      end
+    end
+
+    private
+
+    def has_items?
+      @facet_item.items.present?
+    end
+
+    def facet_toggle_button(id)
+      content_tag 'button', class: 'btn facet-toggle-handle collapsed',
+                            data: { toggle: 'collapse', target: "##{id}" },
+                            aria: { expanded: false, controls: id, describedby: "#{id}_label" } do
+        concat toggle_icon(:show)
+        concat toggle_icon(:hide)
+      end
+    end
+
+    def toggle_icon(type)
+      content_tag 'span', class: type do
+        concat @icons[type]
+        concat content_tag('span', t(type, scope: 'blacklight.search.facets.pivot'), class: 'sr-only')
+      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)
+      @view_context.render(component)
+    end
+
+    def facet_item_presenter(facet_item)
+      Blacklight::FacetItemPresenter.new(facet_item, @facet_item.facet_config, @view_context, @facet_item.facet_field, @facet_item.search_state)
+    end
+  end
+end

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -151,7 +151,7 @@ module Blacklight::CatalogHelperBehavior
   # @return [String]
   def render_document_sidebar_partial(document = nil)
     unless document
-      Deprecation.warn(self, 'render_document_sidebar_partial expects one argument ' /
+      Deprecation.warn(self, 'render_document_sidebar_partial expects one argument ' \
         '(@document) and you passed none. This behavior will be removed in version 8')
       document = @document
     end
@@ -277,7 +277,7 @@ module Blacklight::CatalogHelperBehavior
     facet_config = facet_configuration_for_field(facet)
     filter_label = facet_field_label(facet_config.key)
     filter_value = if values.size < 3
-                     values.map { |value| facet_display_value(facet, value) }.to_sentence
+                     values.map { |value| facet_item_presenter(facet_config, value, facet).label }.to_sentence
                    else
                      t('blacklight.search.page_title.many_constraint_values', values: values.size)
                    end

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -91,10 +91,11 @@ module Blacklight::ConfigurationHelperBehavior
   end
 
   # Shortcut for commonly needed operation, look up display
-  # label for the key specified. Returns "Keyword" if a label
-  # can't be found.
+  # label for the key specified.
   def label_for_search_field(key)
     field_config = blacklight_config.search_fields[key]
+    return if key.nil? && field_config.nil?
+
     field_config ||= Blacklight::Configuration::NullField.new(key: key)
 
     field_config.display_label('search')

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 module Blacklight::FacetsHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = 'blacklight 8.0'
+
   include Blacklight::Facet
 
   ##
@@ -14,7 +17,9 @@ module Blacklight::FacetsHelperBehavior
         '8.0.0')
       response = @response
     end
-    facets_from_request(fields, response).any? { |display_facet| should_render_facet?(display_facet) }
+    Deprecation.silence(Blacklight::FacetsHelperBehavior) do
+      facets_from_request(fields, response).any? { |display_facet| should_render_facet?(display_facet) }
+    end
   end
 
   ##
@@ -58,10 +63,32 @@ module Blacklight::FacetsHelperBehavior
   # @return [String]
   def render_facet_limit(display_facet, options = {})
     field_config = facet_configuration_for_field(display_facet.name)
-    return unless should_render_facet?(display_facet, field_config)
 
+    if field_config.component
+      return unless should_render_field?(field_config, display_facet)
+
+      component = field_config.component == true ? Blacklight::FacetFieldListComponent : field_config.component
+
+      return render(
+        component.new(
+          facet_field: facet_field_presenter(field_config, display_facet),
+          layout: (params[:action] == 'facet' ? false : options[:layout])
+        )
+      )
+    end
+
+    Deprecation.warn(Blacklight::FacetsHelperBehavior, 'Calling #render_facet_limit on a non-componentized'\
+      ' facet is deprecated and will be removed in Blacklight 8')
+
+    Deprecation.silence(Blacklight::FacetsHelperBehavior) do
+      return unless should_render_facet?(display_facet, field_config)
+    end
     options = options.dup
-    options[:partial] ||= facet_partial_name(display_facet)
+
+    Deprecation.silence(Blacklight::FacetsHelperBehavior) do
+      options[:partial] ||= facet_partial_name(display_facet)
+    end
+
     options[:layout] ||= "facet_layout" unless options.key?(:layout)
     options[:locals] ||= {}
     options[:locals][:field_name] ||= display_facet.name
@@ -76,12 +103,20 @@ module Blacklight::FacetsHelperBehavior
   # 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
   def render_facet_limit_list(paginator, facet_field, wrapping_element = :li)
-    safe_join(paginator.items.map { |item| render_facet_item(facet_field, item) }.compact.map { |item| content_tag(wrapping_element, item) })
+    facet_config ||= facet_configuration_for_field(facet_field)
+
+    collection = paginator.items.map do |item|
+      facet_item_presenter(facet_config, item, facet_field)
+    end
+
+    render(facet_item_component_class(facet_config).with_collection(collection, wrapping_element: wrapping_element))
   end
+  deprecation_deprecate :render_facet_limit_list
 
   ##
   # Renders a single facet item
   def render_facet_item(facet_field, item)
+    deprecated_method(:render_facet_item)
     if facet_in_params?(facet_field, item.value)
       render_selected_facet_value(facet_field, item)
     else
@@ -104,6 +139,7 @@ module Blacklight::FacetsHelperBehavior
     facet_config ||= facet_configuration_for_field(display_facet.name)
     should_render_field?(facet_config, display_facet)
   end
+  deprecation_deprecate :should_render_facet?
 
   ##
   # Determine whether a facet should be rendered as collapsed or not.
@@ -114,8 +150,11 @@ module Blacklight::FacetsHelperBehavior
   # @param [Blacklight::Configuration::FacetField] facet_field
   # @return [Boolean]
   def should_collapse_facet? facet_field
-    !facet_field_in_params?(facet_field.key) && facet_field.collapse
+    Deprecation.silence(Blacklight::FacetsHelperBehavior) do
+      !facet_field_in_params?(facet_field.key) && facet_field.collapse
+    end
   end
+  deprecation_deprecate :should_collapse_facet?
 
   ##
   # The name of the partial to use to render a facet field.
@@ -130,6 +169,11 @@ module Blacklight::FacetsHelperBehavior
     name ||= "facet_pivot" if config.pivot
     name || "facet_limit"
   end
+  deprecation_deprecate :facet_partial_name
+
+  def facet_field_presenter(facet_config, display_facet)
+    facet_config.presenter.new(facet_config, display_facet, self)
+  end
 
   ##
   # Standard display of a facet value in a list. Used in both _facets sidebar
@@ -142,13 +186,9 @@ module Blacklight::FacetsHelperBehavior
   # @option options [Boolean] :suppress_link display the facet, but don't link to it
   # @return [String]
   def render_facet_value(facet_field, item, options = {})
-    path = path_for_facet(facet_field, item)
-    content_tag(:span, class: "facet-label") do
-      link_to_unless(options[:suppress_link],
-                     facet_display_value(facet_field, item),
-                     path,
-                     class: "facet-select")
-    end + render_facet_count(item.hits)
+    deprecated_method(:render_facet_value)
+    facet_config = facet_configuration_for_field(facet_field)
+    facet_item_component(facet_config, item, facet_field, **options).render_facet_value
   end
 
   ##
@@ -158,12 +198,9 @@ module Blacklight::FacetsHelperBehavior
   # @return [String]
   def path_for_facet(facet_field, item, path_options = {})
     facet_config = facet_configuration_for_field(facet_field)
-    if facet_config.url_method
-      send(facet_config.url_method, facet_field, item)
-    else
-      search_action_path(search_state.add_facet_params_and_redirect(facet_field, item).merge(path_options))
-    end
+    facet_item_presenter(facet_config, item, facet_field).href(path_options)
   end
+  deprecation_deprecate :path_for_facet
 
   ##
   # Standard display of a SELECTED facet value (e.g. without a link and with a remove button)
@@ -171,15 +208,9 @@ module Blacklight::FacetsHelperBehavior
   # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
   # @param [String] item
   def render_selected_facet_value(facet_field, item)
-    remove_href = search_action_path(search_state.remove_facet_params(facet_field, item))
-    content_tag(:span, class: "facet-label") do
-      content_tag(:span, facet_display_value(facet_field, item), class: "selected") +
-      # remove link
-      link_to(remove_href, class: "remove") do
-        content_tag(:span, '✖', class: "remove-icon") +
-        content_tag(:span, '[remove]', class: 'sr-only')
-      end
-    end + render_facet_count(item.hits, classes: ["selected"])
+    deprecated_method(:render_selected_facet_value)
+    facet_config = facet_configuration_for_field(facet_field)
+    facet_item_component(facet_config, item, facet_field).render_selected_facet_value
   end
 
   ##
@@ -191,18 +222,22 @@ module Blacklight::FacetsHelperBehavior
   # @option options [Array<String>]  an array of classes to add to count span.
   # @return [String]
   def render_facet_count(num, options = {})
+    deprecated_method(:render_facet_count)
     classes = (options[:classes] || []) << "facet-count"
     content_tag("span", t('blacklight.search.facets.count', number: number_with_delimiter(num)), class: classes)
   end
 
   ##
   # Are any facet restrictions for a field in the query parameters?
-  #
+  # @private
   # @param [String] field
   # @return [Boolean]
   def facet_field_in_params? field
-    facet_params(field).present?
+    config = facet_configuration_for_field(field)
+    search_state.has_facet? config
   end
+  # Left undeprecated for the sake of temporary backwards compatibility
+  # deprecation_deprecate :facet_field_in_params?
 
   ##
   # Check if the query parameters have the given facet field with the
@@ -212,18 +247,19 @@ module Blacklight::FacetsHelperBehavior
   # @param [String] item facet value
   # @return [Boolean]
   def facet_in_params?(field, item)
-    value = facet_value_for_facet_item(item)
-
-    (facet_params(field) || []).include? value
+    config = facet_configuration_for_field(field)
+    search_state.has_facet? config, value: facet_value_for_facet_item(item)
   end
+  deprecation_deprecate :facet_in_params?
 
   ##
   # Get the values of the facet set in the blacklight query string
   def facet_params field
     config = facet_configuration_for_field(field)
 
-    params[:f][config.key] if params[:f]
+    search_state.params.dig(:f, config.key)
   end
+  deprecation_deprecate :facet_params
 
   ##
   # Get the displayable version of a facet's value
@@ -231,30 +267,17 @@ module Blacklight::FacetsHelperBehavior
   # @param [Object] field
   # @param [String] item value
   # @return [String]
+  # @deprecated
   def facet_display_value field, item
+    deprecated_method(:facet_display_value)
     facet_config = facet_configuration_for_field(field)
-
-    value = if item.respond_to? :label
-              item.label
-            else
-              facet_value_for_facet_item(item)
-            end
-
-    if facet_config.helper_method
-      send facet_config.helper_method, value
-    elsif facet_config.query && facet_config.query[value]
-      facet_config.query[value][:label]
-    elsif facet_config.date
-      localization_options = facet_config.date == true ? {} : facet_config.date
-      l(Time.zone.parse(value), localization_options)
-    else
-      value
-    end
+    facet_item_presenter(facet_config, item, field).label
   end
 
   def facet_field_id facet_field
     "facet-#{facet_field.key.parameterize}"
   end
+  deprecation_deprecate :facet_field_id
 
   private
 
@@ -265,4 +288,27 @@ module Blacklight::FacetsHelperBehavior
       item
     end
   end
+
+  def facet_item_presenter(facet_config, facet_item, facet_field)
+    Blacklight::FacetItemPresenter.new(facet_item, facet_config, self, facet_field)
+  end
+
+  def facet_item_component(facet_config, facet_item, facet_field, **args)
+    facet_item_component_class(facet_config).new(facet_item: facet_item_presenter(facet_config, facet_item, facet_field), **args).with_view_context(self)
+  end
+
+  def facet_item_component_class(facet_config)
+    default_component = facet_config.pivot ? Blacklight::FacetItemPivotComponent : Blacklight::FacetItemComponent
+    facet_config.fetch(:item_component, default_component)
+  end
+
+  # We can't use .deprecation_deprecate here, because the new components need to
+  # see the originally defined location for these methods in order to properly
+  # call back into the helpers for backwards compatibility
+  def deprecated_method(method_name)
+    Deprecation.warn(Blacklight::FacetsHelperBehavior,
+                     Deprecation.deprecated_method_warning(Blacklight::FacetsHelperBehavior,
+                                                           method_name, {}),
+                     caller)
+  end
 end

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -6,14 +6,19 @@
 # Includes methods for rendering contraints graphically on the
 # search results page (render_constraints(_*))
 module Blacklight::RenderConstraintsHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = 'blacklight 8.0'
+
   ##
   # Check if the query has any constraints defined (a query, facet, etc)
   #
   # @param [Hash] localized_params query parameters
   # @return [Boolean]
-  def query_has_constraints?(localized_params = params)
-    !(localized_params[:q].blank? && localized_params[:f].blank?)
+  def query_has_constraints?(params_or_search_state = search_state)
+    search_state = convert_to_search_state(params_or_search_state)
+    search_state.has_constraints?
   end
+  deprecation_deprecate query_has_constraints?: 'use search_state#has_constraints?'
 
   ##
   # Render the actual constraints, not including header or footer
@@ -21,8 +26,16 @@ module Blacklight::RenderConstraintsHelperBehavior
   #
   # @param [Hash] localized_params query parameters
   # @return [String]
-  def render_constraints(localized_params = params)
-    render_constraints_query(localized_params) + render_constraints_filters(localized_params)
+  def render_constraints(localized_params = params, local_search_state = search_state)
+    params_or_search_state = if localized_params != params
+                               localized_params
+                             else
+                               local_search_state
+                             end
+
+    Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
+      render_constraints_query(params_or_search_state) + render_constraints_filters(params_or_search_state)
+    end
   end
 
   ##
@@ -30,15 +43,20 @@ module Blacklight::RenderConstraintsHelperBehavior
   #
   # @param [ActionController::Parameters] localized_params query parameters
   # @return [String]
-  def render_constraints_query(localized_params = params)
+  def render_constraints_query(params_or_search_state = search_state)
+    search_state = convert_to_search_state(params_or_search_state)
+
     # So simple don't need a view template, we can just do it here.
-    return "".html_safe if localized_params[:q].blank?
+    return "".html_safe if search_state.query_param.blank?
 
-    render_constraint_element(constraint_query_label(localized_params),
-                              localized_params[:q],
-                              classes: ["query"],
-                              remove: remove_constraint_url(localized_params))
+    Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
+      render_constraint_element(constraint_query_label(search_state.params),
+                                search_state.query_param,
+                                classes: ["query"],
+                                remove: remove_constraint_url(search_state))
+    end
   end
+  deprecation_deprecate :render_constraints_query
 
   ##
   # Provide a url for removing a particular constraint. This can be overriden
@@ -47,52 +65,53 @@ module Blacklight::RenderConstraintsHelperBehavior
   #
   # @param [ActionController::Parameters] localized_params query parameters
   # @return [String]
-  def remove_constraint_url(localized_params)
-    scope = localized_params.delete(:route_set) || self
-
-    unless localized_params.is_a? ActionController::Parameters
-      localized_params = ActionController::Parameters.new(localized_params)
-    end
+  def remove_constraint_url(params_or_search_state = search_state)
+    search_state = convert_to_search_state(params_or_search_state)
 
-    options = localized_params.merge(q: nil, action: 'index')
-    options.permit!
-    scope.url_for(options)
+    search_action_path(search_state.remove_query_params)
   end
+  deprecation_deprecate :remove_constraint_url
 
   ##
   # Render the facet constraints
   # @param [Hash] localized_params query parameters
   # @return [String]
-  def render_constraints_filters(localized_params = params)
-    return "".html_safe unless localized_params[:f]
+  def render_constraints_filters(params_or_search_state = search_state)
+    search_state = convert_to_search_state(params_or_search_state)
 
-    path = controller.search_state_class.new(localized_params, blacklight_config, controller)
-    content = []
-    localized_params[:f].each_pair do |facet, values|
-      content << render_filter_element(facet, values, path)
-    end
+    return "".html_safe if search_state.filter_params.blank?
 
-    safe_join(content.flatten, "\n")
+    Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
+      safe_join(search_state.filter_params.each_pair.map do |facet, values|
+        render_filter_element(facet, values, search_state)
+      end, "\n")
+    end
   end
+  deprecation_deprecate :render_constraints_filters
 
   ##
   # Render a single facet's constraint
   # @param [String] facet field
   # @param [Array<String>] values selected facet values
-  # @param [Blacklight::SearchState] path query parameters
+  # @param [Blacklight::SearchState] path query parameters (unused)
   # @return [String]
-  def render_filter_element(facet, values, path)
+  def render_filter_element(facet, values, search_state)
     facet_config = facet_configuration_for_field(facet)
 
     safe_join(Array(values).map do |val|
       next if val.blank? # skip empty string
 
-      render_constraint_element(facet_field_label(facet_config.key),
-                                facet_display_value(facet, val),
-                                remove: search_action_path(path.remove_facet_params(facet, val)),
-                                classes: ["filter", "filter-" + facet.parameterize])
+      presenter = facet_item_presenter(facet_config, val, facet)
+
+      Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
+        render_constraint_element(facet_field_label(facet_config.key),
+                                  presenter.label,
+                                  remove: presenter.remove_href(search_state),
+                                  classes: ["filter", "filter-" + facet.parameterize])
+      end
     end, "\n")
   end
+  deprecation_deprecate :render_filter_element
 
   # Render a label/value constraint on the screen. Can be called
   # by plugins and such to get application-defined rendering.
@@ -111,4 +130,16 @@ module Blacklight::RenderConstraintsHelperBehavior
   def render_constraint_element(label, value, options = {})
     render(partial: "catalog/constraints_element", locals: { label: label, value: value, options: options })
   end
+  deprecation_deprecate :render_constraint_element
+
+  private
+
+  def convert_to_search_state(params_or_search_state)
+    if params_or_search_state.is_a? Blacklight::SearchState
+      params_or_search_state
+    else
+      # deprecated
+      controller.search_state_class.new(params_or_search_state, blacklight_config, controller)
+    end
+  end
 end