blacklight 7.11.1 → 7.12.0

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 module Blacklight
   module ComponentHelperBehavior
+    extend Deprecation
+
+    # @deprecated
     def document_action_label action, opts
       t("blacklight.tools.#{action}", default: opts.label || action.to_s.humanize)
     end
+    deprecation_deprecate :document_action_label
 
+    # @deprecated
     def document_action_path action_opts, url_opts = nil
       if action_opts.path
         send(action_opts.path, url_opts)
@@ -14,6 +19,7 @@ module Blacklight
         send("#{action_opts.key}_#{controller_name}_path", url_opts)
       end
     end
+    deprecation_deprecate :document_action_path
 
     ##
     # Render "document actions" area for navigation header
@@ -36,9 +42,10 @@ module Blacklight
     # @option options [String] :wrapping_class
     # @return [String]
     def render_index_doc_actions(document, options = {})
+      actions = filter_partials(blacklight_config.view_config(document_index_view_type).document_actions, { document: document }.merge(options)).map { |_k, v| v }
       wrapping_class = options.delete(:wrapping_class) || "index-document-functions"
-      rendered = render_filtered_partials(blacklight_config.view_config(document_index_view_type).document_actions, { document: document }.merge(options))
-      tag.div(rendered, class: wrapping_class) if rendered.present?
+
+      render(Blacklight::Document::ActionsComponent.new(document: document, actions: actions, options: options, classes: wrapping_class))
     end
 
     ##
@@ -49,9 +56,10 @@ module Blacklight
     # @option options [String] :wrapping_class
     # @return [String]
     def render_results_collection_tools(options = {})
+      actions = filter_partials(blacklight_config.view_config(document_index_view_type).collection_actions, options).map { |_k, v| v }
       wrapping_class = options.delete(:wrapping_class) || "search-widgets"
-      rendered = render_filtered_partials(blacklight_config.view_config(document_index_view_type).collection_actions, options)
-      tag.div(rendered, class: wrapping_class) if rendered.present?
+
+      render(Blacklight::Document::ActionsComponent.new(actions: actions, options: options, classes: wrapping_class))
     end
 
     ##
@@ -63,14 +71,36 @@ module Blacklight
     # @param [SolrDocument] document
     # @param [Hash] options
     # @return [String]
-    def render_show_doc_actions(document = @document, options = {}, &block)
-      render_filtered_partials(blacklight_config.show.document_actions, { document: document }.merge(options), &block)
+    def render_show_doc_actions(document = @document, url_opts: {}, **options)
+      document = options[:document] if options.key? :document
+
+      actions = document_actions(document, options: options)
+
+      if block_given?
+        # TODO: Deprecate this behavior and replace it with a separate component?
+        # Deprecation.warn(Blacklight::ComponentHelperBehavior, 'Pass a block to #render_show_doc_actions is deprecated')
+        actions.each do |action|
+          yield action, render((action.component || Blacklight::Document::ActionComponent).new(action: action, document: document, options: options, url_opts: url_opts))
+        end
+
+        nil
+      else
+        render(Blacklight::Document::ActionsComponent.new(document: document, actions: actions, options: options, url_opts: url_opts))
+      end
+    end
+
+    def render_show_doc_actions_method_from_blacklight?
+      method(:render_show_doc_actions).owner == Blacklight::ComponentHelperBehavior
     end
 
     def show_doc_actions?(document = @document, options = {})
       filter_partials(blacklight_config.show.document_actions, { document: document }.merge(options)).any?
     end
 
+    def document_actions(document, options: {})
+      filter_partials(blacklight_config.show.document_actions, { document: document }.merge(options)).map { |_k, v| v }
+    end
+
     private
 
     def render_filtered_partials(partials, options = {})

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -5,32 +5,40 @@ module Blacklight::ConfigurationHelperBehavior
   ##
   # Index fields to display for a type of document
   #
-  # @param [SolrDocument] document
+  # @param [SolrDocument] _document
   # @return [Array<Blacklight::Configuration::Field>]
   def index_fields _document = nil
     Deprecation.warn(self, "index_fields is deprecated and will be removed in Blacklight 8. Use IndexPresenter#fields instead")
     blacklight_config.index_fields
   end
 
+  ##
+  # Return the available sort fields
+  # @return [Array<Blacklight::Configuration::Field>]
   def active_sort_fields
     blacklight_config.sort_fields.select { |_sort_key, field_config| should_render_field?(field_config) }
   end
 
   # Used in the search form partial for building a select tag
+  # @see #search_field_options_for_select
   def search_fields
     search_field_options_for_select
   end
+  deprecation_deprecate search_fields: 'removed without replacement'
 
   # Returns suitable argument to options_for_select method, to create
   # an html select based on #search_field_list. Skips search_fields
   # marked :include_in_simple_select => false
+  # @return [Array<Array>] the first element of the array is the label, the second is the sort field key
   def search_field_options_for_select
     blacklight_config.search_fields.collect do |_key, field_def|
       [label_for_search_field(field_def.key), field_def.key] if should_render_field?(field_def)
     end.compact
   end
+  deprecation_deprecate search_field_options_for_select: 'removed without replacement'
 
   # used in the catalog/_show partial
+  # @return [Array<Blacklight::Configuration::Field>]
   def document_show_fields _document = nil
     Deprecation.warn(self, "document_show_fields is deprecated and will be removed in Blacklight 8. Use ShowPresenter#fields instead")
     blacklight_config.show_fields
@@ -45,19 +53,24 @@ module Blacklight::ConfigurationHelperBehavior
   def constraint_query_label(localized_params = params)
     label_for_search_field(localized_params[:search_field]) unless default_search_field?(localized_params[:search_field])
   end
+  deprecation_deprecate constraint_query_label: 'Moving to Blacklight::ConstraintsComponent'
 
   ##
   # Is the search form using the default search field ("all_fields" by default)?
   # @param [String] selected_search_field the currently selected search_field
   # @return [Boolean]
   def default_search_field?(selected_search_field)
-    selected_search_field.blank? || (default_search_field && selected_search_field == default_search_field[:key])
+    Deprecation.silence(Blacklight::SearchFields) do
+      selected_search_field.blank? || (default_search_field && selected_search_field == default_search_field[:key])
+    end
   end
 
   ##
   # Look up the label for the index field
+  # @deprecated
+  # @return [String]
   def index_field_label document, field
-    field_config = blacklight_config.index_fields_for(index_presenter(document).display_type)[field]
+    field_config = blacklight_config.index_fields_for(document_presenter(document).display_type)[field]
     field_config ||= Blacklight::Configuration::NullField.new(key: field)
 
     field_config.display_label('index')
@@ -66,8 +79,10 @@ module Blacklight::ConfigurationHelperBehavior
 
   ##
   # Look up the label for the show field
+  # @deprecated
+  # @return [String]
   def document_show_field_label document, field
-    field_config = blacklight_config.show_fields_for(show_presenter(document).display_type)[field]
+    field_config = blacklight_config.show_fields_for(document_presenter(document).display_type)[field]
     field_config ||= Blacklight::Configuration::NullField.new(key: field)
 
     field_config.display_label('show')
@@ -76,6 +91,7 @@ module Blacklight::ConfigurationHelperBehavior
 
   ##
   # Look up the label for the facet field
+  # @return [String]
   def facet_field_label field
     field_config = blacklight_config.facet_fields[field]
     field_config ||= Blacklight::Configuration::NullField.new(key: field)
@@ -83,6 +99,8 @@ module Blacklight::ConfigurationHelperBehavior
     field_config.display_label('facet')
   end
 
+  # Return the label for a search view
+  # @return [String]
   def view_label view
     view_config = blacklight_config.view[view]
     field_label(
@@ -93,9 +111,11 @@ module Blacklight::ConfigurationHelperBehavior
       view.to_s.humanize
     )
   end
+  deprecation_deprecate view_label: 'Moving to Blacklight::Response::ViewTypeComponent'
 
   # Shortcut for commonly needed operation, look up display
   # label for the key specified.
+  # @return [String]
   def label_for_search_field(key)
     field_config = blacklight_config.search_fields[key]
     return if key.nil? && field_config.nil?
@@ -105,6 +125,7 @@ module Blacklight::ConfigurationHelperBehavior
     field_config.display_label('search')
   end
 
+  # @return [String]
   def sort_field_label(key)
     field_config = blacklight_config.sort_fields[key]
     field_config ||= Blacklight::Configuration::NullField.new(key: key)
@@ -124,12 +145,14 @@ module Blacklight::ConfigurationHelperBehavior
   #     before falling  back to the label
   #   @param [Symbol] any number of additional keys
   #   @param [Symbol] ...
+  # @return [String]
   def field_label *i18n_keys
     first, *rest = i18n_keys.compact
 
     t(first, default: rest)
   end
 
+  # @return [Hash<Symbol => Blacklight::Configuration::ViewConfig>]
   def document_index_views
     blacklight_config.view.select do |_k, config|
       should_render_field? config
@@ -151,17 +174,22 @@ module Blacklight::ConfigurationHelperBehavior
 
   ##
   # Check if there are alternative views configuration
+  # @return [Boolean]
   def has_alternative_views?
     document_index_views.keys.length > 1
   end
+  deprecation_deprecate has_alternative_views?: 'Moving to Blacklight::Response::ViewTypeComponent'
 
   ##
   #  Maximum number of results for spell checking
+  # @return [Number]
   def spell_check_max
     blacklight_config.spell_max
   end
+  deprecation_deprecate spell_check_max: 'Use blacklight_config.spell_max directly'
 
   # Used in the document list partial (search view) for creating a link to the document show action
+  # @deprecated
   def document_show_link_field document = nil
     fields = Array(blacklight_config.view_config(document_index_view_type).title_field)
 

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -8,9 +8,11 @@ module Blacklight::FacetsHelperBehavior
   ##
   # Check if any of the given fields have values
   #
+  # @deprecated
   # @param [Array<String>] fields
   # @return [Boolean]
   def has_facet_values? fields = facet_field_names, response = nil
+    deprecated_method(:has_facet_values?)
     unless response
       Deprecation.warn(self, 'Calling has_facet_values? without passing the ' \
         'second argument (response) is deprecated and will be removed in Blacklight ' \
@@ -18,7 +20,9 @@ module Blacklight::FacetsHelperBehavior
       response = @response
     end
     Deprecation.silence(Blacklight::FacetsHelperBehavior) do
-      facets_from_request(fields, response).any? { |display_facet| should_render_facet?(display_facet) }
+      Deprecation.silence(Blacklight::Facet) do
+        facets_from_request(fields, response).any? { |display_facet| should_render_facet?(display_facet) }
+      end
     end
   end
 
@@ -26,13 +30,16 @@ module Blacklight::FacetsHelperBehavior
   # Render a collection of facet fields.
   # @see #render_facet_limit
   #
+  # @deprecated
   # @param [Array<String>] fields
   # @param [Hash] options
-  # @options options [Blacklight::Solr::Response] :response the Solr response object
+  # @option options [Blacklight::Solr::Response] :response the Solr response object
   # @return String
   def render_facet_partials fields = nil, options = {}
+    deprecated_method(:render_facet_partials)
+
     unless fields
-      Deprecation.warn(self, 'Calling render_facet_partials without passing the ' \
+      Deprecation.warn(self.class, 'Calling render_facet_partials without passing the ' \
         'first argument (fields) is deprecated and will be removed in Blacklight ' \
         '8.0.0')
       fields = facet_field_names
@@ -40,14 +47,18 @@ module Blacklight::FacetsHelperBehavior
 
     response = options.delete(:response)
     unless response
-      Deprecation.warn(self, 'Calling render_facet_partials without passing the ' \
+      Deprecation.warn(self.class, 'Calling render_facet_partials without passing the ' \
         'response keyword is deprecated and will be removed in Blacklight ' \
         '8.0.0')
       response = @response
     end
-    safe_join(facets_from_request(fields, response).map do |display_facet|
-      render_facet_limit(display_facet, options)
-    end.compact, "\n")
+    Deprecation.silence(Blacklight::FacetsHelperBehavior) do
+      Deprecation.silence(Blacklight::Facet) do
+        safe_join(facets_from_request(fields, response).map do |display_facet|
+          render_facet_limit(display_facet, options)
+        end.compact, "\n")
+      end
+    end
   end
 
   ##
@@ -102,6 +113,7 @@ module Blacklight::FacetsHelperBehavior
   # 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)
     facet_config ||= facet_configuration_for_field(facet_field)
 
@@ -115,6 +127,7 @@ module Blacklight::FacetsHelperBehavior
 
   ##
   # Renders a single facet item
+  # @deprecated
   def render_facet_item(facet_field, item)
     deprecated_method(:render_facet_item)
     if facet_in_params?(facet_field, item.value)
@@ -129,6 +142,7 @@ module Blacklight::FacetsHelperBehavior
   #
   # By default, only render facets with items.
   #
+  # @deprecated
   # @param [Blacklight::Solr::Response::Facets::FacetField] display_facet
   # @param [Blacklight::Configuration::FacetField] facet_config
   # @return [Boolean]
@@ -147,6 +161,7 @@ module Blacklight::FacetsHelperBehavior
   #   - if the facet is configured to collapse (the default), collapse
   #   - if the facet is configured not to collapse, don't collapse
   #
+  # @deprecated
   # @param [Blacklight::Configuration::FacetField] facet_field
   # @return [Boolean]
   def should_collapse_facet? facet_field
@@ -172,7 +187,7 @@ module Blacklight::FacetsHelperBehavior
   deprecation_deprecate :facet_partial_name
 
   def facet_field_presenter(facet_config, display_facet)
-    facet_config.presenter.new(facet_config, display_facet, self)
+    (facet_config.presenter || Blacklight::FacetFieldPresenter).new(facet_config, display_facet, self)
   end
 
   ##
@@ -193,6 +208,8 @@ module Blacklight::FacetsHelperBehavior
 
   ##
   # Where should this facet link to?
+  #
+  # @deprecated
   # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
   # @param [String] item
   # @return [String]
@@ -204,6 +221,8 @@ module Blacklight::FacetsHelperBehavior
 
   ##
   # Standard display of a SELECTED facet value (e.g. without a link and with a remove button)
+  #
+  # @deprecated
   # @see #render_facet_value
   # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
   # @param [String] item
@@ -217,6 +236,7 @@ module Blacklight::FacetsHelperBehavior
   # 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.
   #
+  # @deprecated
   # @param [Integer] num number of facet results
   # @param [Hash] options
   # @option options [Array<String>]  an array of classes to add to count span.
@@ -243,6 +263,7 @@ module Blacklight::FacetsHelperBehavior
   # Check if the query parameters have the given facet field with the
   # given value.
   #
+  # @deprecated
   # @param [String] field
   # @param [String] item facet value
   # @return [Boolean]
@@ -254,6 +275,7 @@ module Blacklight::FacetsHelperBehavior
 
   ##
   # Get the values of the facet set in the blacklight query string
+  # @deprecated
   def facet_params field
     config = facet_configuration_for_field(field)
 
@@ -274,6 +296,7 @@ module Blacklight::FacetsHelperBehavior
     facet_item_presenter(facet_config, item, field).label
   end
 
+  # @deprecated
   def facet_field_id facet_field
     "facet-#{facet_field.key.parameterize}"
   end

data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb

@@ -10,10 +10,14 @@
 # This is used to serialize a complete current query from current params
 # to form fields used for sort and change per-page
 module Blacklight::HashAsHiddenFieldsHelperBehavior
+  extend Deprecation
+
   ##
   # Writes out zero or more <input type="hidden"> elements, completely
   # representing a hash passed in using Rails-style request parameters
   # for hashes nested with arrays and other hashes.
+  #
+  # @deprecated
   # @param [Hash] hash
   # @return [String]
   def render_hash_as_hidden_fields(hash)
@@ -27,6 +31,7 @@ module Blacklight::HashAsHiddenFieldsHelperBehavior
 
     safe_join(hidden_fields, "\n")
   end
+  deprecation_deprecate render_hash_as_hidden_fields: 'Moving to a private method of Blacklight::SearchBarComponent'
 
   private
 

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -12,7 +12,8 @@ module Blacklight::RenderConstraintsHelperBehavior
   ##
   # Check if the query has any constraints defined (a query, facet, etc)
   #
-  # @param [Hash] localized_params query parameters
+  # @deprecated
+  # @param [Blacklight::SearchState,Hash] params_or_search_state query parameters
   # @return [Boolean]
   def query_has_constraints?(params_or_search_state = search_state)
     search_state = convert_to_search_state(params_or_search_state)
@@ -41,9 +42,11 @@ module Blacklight::RenderConstraintsHelperBehavior
   ##
   # Render the query constraints
   #
-  # @param [ActionController::Parameters] localized_params query parameters
+  # @deprecated
+  # @param [Blacklight::SearchState,ActionController::Parameters] params_or_search_state query parameters
   # @return [String]
   def render_constraints_query(params_or_search_state = search_state)
+    Deprecation.warn(Blacklight::RenderConstraintsHelperBehavior, 'render_constraints_query is deprecated')
     search_state = convert_to_search_state(params_or_search_state)
 
     # So simple don't need a view template, we can just do it here.
@@ -56,27 +59,29 @@ module Blacklight::RenderConstraintsHelperBehavior
                                 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
   # in the case that you want parameters other than the defaults to be removed
   # (e.g. :search_field)
   #
-  # @param [ActionController::Parameters] localized_params query parameters
+  # @deprecated
+  # @param [Blacklight::SearchState,ActionController::Parameters] params_or_search_state query parameters
   # @return [String]
   def remove_constraint_url(params_or_search_state = search_state)
+    Deprecation.warn(Blacklight::RenderConstraintsHelperBehavior, 'remove_constraint_url is deprecated')
     search_state = convert_to_search_state(params_or_search_state)
 
     search_action_path(search_state.remove_query_params)
   end
-  deprecation_deprecate :remove_constraint_url
 
   ##
   # Render the facet constraints
-  # @param [Hash] localized_params query parameters
+  # @deprecated
+  # @param [Blacklight::SearchState,Hash] params_or_search_state query parameters
   # @return [String]
   def render_constraints_filters(params_or_search_state = search_state)
+    Deprecation.warn(Blacklight::RenderConstraintsHelperBehavior, 'render_constraints_filters is deprecated')
     search_state = convert_to_search_state(params_or_search_state)
 
     return "".html_safe if search_state.filter_params.blank?
@@ -87,15 +92,16 @@ module Blacklight::RenderConstraintsHelperBehavior
       end, "\n")
     end
   end
-  deprecation_deprecate :render_constraints_filters
 
   ##
   # Render a single facet's constraint
+  # @deprecated
   # @param [String] facet field
   # @param [Array<String>] values selected facet values
-  # @param [Blacklight::SearchState] path query parameters (unused)
+  # @param [Blacklight::SearchState] search_state path query parameters
   # @return [String]
   def render_filter_element(facet, values, search_state)
+    Deprecation.warn(Blacklight::RenderConstraintsHelperBehavior, 'render_filter_element is deprecated')
     facet_config = facet_configuration_for_field(facet)
 
     safe_join(Array(values).map do |val|
@@ -104,14 +110,13 @@ module Blacklight::RenderConstraintsHelperBehavior
       presenter = facet_item_presenter(facet_config, val, facet)
 
       Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
-        render_constraint_element(facet_field_label(facet_config.key),
+        render_constraint_element(presenter.field_label,
                                   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.
@@ -121,6 +126,7 @@ module Blacklight::RenderConstraintsHelperBehavior
   #
   # Can pass in nil label if desired.
   #
+  # @deprecated
   # @param [String] label to display
   # @param [String] value to display
   # @param [Hash] options
@@ -128,9 +134,20 @@ module Blacklight::RenderConstraintsHelperBehavior
   # @option options [Array<String>] :classes an array of classes to add to container span for constraint.
   # @return [String]
   def render_constraint_element(label, value, options = {})
+    Deprecation.warn(Blacklight::RenderConstraintsHelperBehavior, 'render_constraints_element is deprecated')
     render(partial: "catalog/constraints_element", locals: { label: label, value: value, options: options })
   end
-  deprecation_deprecate :render_constraint_element
+
+  # @private
+  def constraints_helpers_and_partials_from_blacklight?
+    method(:render_constraints).owner == Blacklight::RenderConstraintsHelperBehavior &&
+      method(:render_constraints_query).owner == Blacklight::RenderConstraintsHelperBehavior &&
+      method(:remove_constraint_url).owner == Blacklight::RenderConstraintsHelperBehavior &&
+      method(:render_constraints_filters).owner == Blacklight::RenderConstraintsHelperBehavior &&
+      method(:render_filter_element).owner == Blacklight::RenderConstraintsHelperBehavior &&
+      method(:render_constraint_element).owner == Blacklight::RenderConstraintsHelperBehavior &&
+      partial_from_blacklight?('catalog/constraints_element')
+  end
 
   private