blacklight 7.33.0 → 8.0.0

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -1,38 +1,7 @@
 # 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 = {}
-      if action_opts.path
-        send(action_opts.path, url_opts)
-      elsif url_opts[:id].class.respond_to?(:model_name)
-        url_for([action_opts.key.to_sym, url_opts[:id]])
-      else
-        send("#{action_opts.key}_#{controller_name}_path", url_opts)
-      end
-    end
-    deprecation_deprecate :document_action_path
-
-    ##
-    # Render "document actions" area for navigation header
-    # (normally renders "Saved Searches", "History", "Bookmarks")
-    # These things are added by add_nav_action and the default config is
-    # provided by DefaultComponentConfiguration
-    #
-    # @param [Hash] options
-    # @return [String]
-    def render_nav_actions(options = {}, &block)
-      render_filtered_partials(blacklight_config.navbar.partials, options, &block)
-    end
-
     ##
     # Render "document actions" area for search results view
     # (normally renders next to title in the list view)
@@ -60,37 +29,6 @@ module Blacklight
       render(component.new(actions: actions, classes: wrapping_class))
     end
 
-    ##
-    # Render "document actions" for the item detail 'show' view.
-    # (this normally renders next to title)
-    #
-    # By default includes 'Bookmarks'
-    #
-    # @param [SolrDocument] document
-    # @param [Hash] options
-    # @return [String]
-    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.view_config(:show).document_actions, { document: document }.merge(options)).any?
     end

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -1,17 +1,6 @@
 # frozen_string_literal: true
-module Blacklight::ConfigurationHelperBehavior
-  extend Deprecation
-
-  ##
-  # Index fields to display for a type of 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
 
+module Blacklight::ConfigurationHelperBehavior
   ##
   # Return the available sort fields
   # @return [Array<Blacklight::Configuration::Field>]
@@ -19,75 +8,13 @@ module Blacklight::ConfigurationHelperBehavior
     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
-  end
-
-  ##
-  # Return a label for the currently selected search field.
-  # If no "search_field" or the default (e.g. "all_fields") is selected, then return nil
-  # Otherwise grab the label of the selected search field.
-  # @param [Hash] localized_params query parameters
-  # @return [String]
-  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)
-    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(document_presenter(document).display_type)[field]
-    field_config ||= Blacklight::Configuration::NullField.new(key: field)
-
-    field_config.display_label('index')
-  end
-  deprecation_deprecate :index_field_label
-
-  ##
-  # 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(document_presenter(document).display_type)[field]
-    field_config ||= Blacklight::Configuration::NullField.new(key: field)
-
-    field_config.display_label('show')
+    selected_search_field.blank? || (blacklight_config.default_search_field && selected_search_field == blacklight_config.default_search_field[:key])
   end
-  deprecation_deprecate :document_show_field_label
 
   ##
   # Look up the label for the facet field
@@ -99,14 +26,6 @@ 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]
-    view_config.display_label
-  end
-  deprecation_deprecate view_label: 'Moving to ViewConfig#display_label and Blacklight::Response::ViewTypeComponent'
-
   # Shortcut for commonly needed operation, look up display
   # label for the key specified.
   # @return [String]
@@ -166,46 +85,12 @@ module Blacklight::ConfigurationHelperBehavior
     document_index_views.select { |_k, config| config.respond_to?(:default) && config.default }.keys.first || document_index_views.keys.first
   end
 
-  ##
-  # 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)
-
-    field = fields.first if document.nil?
-    field ||= fields.find { |f| document.has? f }
-    field &&= field&.to_sym
-
-    field
-  end
-  deprecation_deprecate document_show_link_field: 'Deprecated without replacement'
-
   ##
   # Default sort field
   def default_sort_field
     (active_sort_fields.find { |_k, config| config.respond_to?(:default) && config.default } || active_sort_fields.first)&.last
   end
 
-  ##
-  # The default value for search results per page
-  delegate :default_per_page, to: :blacklight_config
-  deprecation_deprecate default_per_page: "Use blacklight_config.default_per_page instead"
-
   ##
   # The available options for results per page, in the style of #options_for_select
   def per_page_options_for_select

data/app/helpers/blacklight/document_helper_behavior.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# Helper methods for catalog-like controllers that work with documents
+module Blacklight::DocumentHelperBehavior
+  ##
+  # Get the classes to add to a document's div
+  #
+  # @param [Blacklight::Document] document
+  # @return [String]
+  def render_document_class(document = @document)
+    types = document_presenter(document).display_type
+    return if types.blank?
+
+    Array(types).compact.map do |t|
+      "#{document_class_prefix}#{t.try(:parameterize) || t}"
+    end.join(' ')
+  end
+
+  ##
+  # Return a prefix for the document classes infered from the document
+  # @see #render_document_class
+  # @return [String]
+  def document_class_prefix
+    'blacklight-'
+  end
+
+  ##
+  # Render the sidebar partial for a document
+  # This is used as an integration point by downstream apps to add to the
+  # default sidebar.
+  # See: https://github.com/geoblacklight/geoblacklight/blob/7d3c31c7af3362879b97e2c1351a2496c728c59c/app/helpers/blacklight_helper.rb#L7
+  #
+  # @param [SolrDocument] document
+  # @return [String]
+  def render_document_sidebar_partial(document)
+    render 'show_sidebar', document: document
+  end
+
+  ##
+  # return the Bookmarks on a set of documents (all bookmarks on the page)
+  # @private
+  # @return [Enumerable<Bookmark>]
+  def current_bookmarks
+    @current_bookmarks ||= begin
+      documents = @document.presence || @response.documents
+      current_or_guest_user.bookmarks_for_documents(Array(documents)).to_a
+    end
+  end
+  private :current_bookmarks
+
+  ##
+  # Check if the document is in the user's bookmarks
+  # @param [Blacklight::Document] document
+  # @return [Boolean]
+  def bookmarked? document
+    current_bookmarks.any? { |x| x.document_id == document.id && x.document_type == document.class }
+  end
+
+  ##
+  # Returns a document presenter for the given document
+  def document_presenter(document)
+    document_presenter_class(document).new(document, self)
+  end
+
+  ##
+  # Override this method if you want to use a differnet presenter for your documents
+  # @param [Blacklight::Document] _document optional, here for extension + backwards compatibility only
+  def document_presenter_class(_document = nil)
+    case action_name
+    when 'show', 'citation'
+      blacklight_config.view_config(:show, action_name: action_name).document_presenter_class
+    else
+      blacklight_config.view_config(document_index_view_type, action_name: action_name).document_presenter_class
+    end
+  end
+end

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -1,309 +1,11 @@
 # frozen_string_literal: true
-module Blacklight::FacetsHelperBehavior
-  extend Deprecation
-  self.deprecation_horizon = 'blacklight 8.0'
-
-  include Blacklight::Facet
-
-  ##
-  # 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 ' \
-        '8.0.0')
-      response = @response
-    end
-    Deprecation.silence(Blacklight::FacetsHelperBehavior) do
-      Deprecation.silence(Blacklight::Facet) do
-        facets_from_request(fields, response).any? { |display_facet| should_render_facet?(display_facet) }
-      end
-    end
-  end
-
-  ##
-  # Render a collection of facet fields.
-  # @see #render_facet_limit
-  #
-  # @deprecated
-  # @param [Array<String>] fields
-  # @param [Hash] options
-  # @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.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
-    end
-
-    response = options.delete(:response)
-    unless response
-      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
-    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
-
-  ##
-  # Renders a single section for facet limit with a specified
-  # solr field used for faceting. Can be over-ridden for custom
-  # display on a per-facet basis.
-  #
-  # @param [Blacklight::Solr::Response::Facets::FacetField] display_facet
-  # @param [Hash] options parameters to use for rendering the facet limit partial
-  # @option options [String] :partial partial to render
-  # @option options [String] :layout partial layout to render
-  # @option options [Hash] :locals locals to pass to the partial
-  # @return [String]
-  def render_facet_limit(display_facet, options = {})
-    field_config = facet_configuration_for_field(display_facet.name)
-
-    if field_config.component
-      return render(
-        Blacklight::FacetComponent.new(
-          display_facet: display_facet,
-          field_config: field_config,
-          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
-
-    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
-    options[:locals][:facet_field] ||= field_config
-    options[:locals][:display_facet] ||= display_facet
-
-    render(options)
-  end
-
-  ##
-  # 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)
-
-    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
-  # @deprecated
-  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
-      render_facet_value(facet_field, item)
-    end
-  end
-
-  ##
-  # Determine if Blacklight should render the display_facet or not
-  #
-  # By default, only render facets with items.
-  #
-  # @deprecated
-  # @param [Blacklight::Solr::Response::Facets::FacetField] display_facet
-  # @param [Blacklight::Configuration::FacetField] facet_config
-  # @return [Boolean]
-  def should_render_facet? display_facet, facet_config = nil
-    return false if display_facet.items.blank?
-
-    # display when show is nil or true
-    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.
-  #   - if the facet is 'active', don't collapse
-  #   - 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
-    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.
-  # uses the value of the "partial" field if set in the facet configuration
-  # otherwise uses "facet_pivot" if this facet is a pivot facet
-  # defaults to 'facet_limit'
-  #
-  # @return [String]
-  def facet_partial_name(display_facet = nil)
-    config = facet_configuration_for_field(display_facet.name)
-    name = config.partial
-    name ||= "facet_pivot" if config.pivot
-    name || "facet_limit"
-  end
-  deprecation_deprecate :facet_partial_name
+module Blacklight::FacetsHelperBehavior
+  delegate :facet_configuration_for_field, to: :blacklight_config
 
   def facet_field_presenter(facet_config, display_facet)
-    (facet_config.presenter || Blacklight::FacetFieldPresenter).new(facet_config, display_facet, self)
-  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.
-  #
-  # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
-  # @param [Blacklight::Solr::Response::Facets::FacetItem] item
-  # @param [Hash] options
-  # @option options [Boolean] :suppress_link display the facet, but don't link to it
-  # @return [String]
-  def render_facet_value(facet_field, item, options = {})
-    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
-
-  ##
-  # Where should this facet link to?
-  #
-  # @deprecated
-  # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
-  # @param [String] item
-  # @return [String]
-  def path_for_facet(facet_field, item, path_options = {})
-    facet_config = facet_configuration_for_field(facet_field)
-    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)
-  #
-  # @deprecated
-  # @see #render_facet_value
-  # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
-  # @param [String] item
-  def render_selected_facet_value(facet_field, item)
-    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
-
-  ##
-  # 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.
-  # @return [String]
-  def render_facet_count(num, options = {})
-    deprecated_method(:render_facet_count)
-    classes = (options[:classes] || []) << "facet-count"
-    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
-    config = facet_configuration_for_field(field)
-
-    Deprecation.silence(Blacklight::SearchState) do
-      search_state.has_facet? config
-    end
+    facet_config.presenter.new(facet_config, display_facet, self)
   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
-  # given value.
-  #
-  # @deprecated
-  # @param [String] field
-  # @param [String] item facet value
-  # @return [Boolean]
-  def facet_in_params?(field, item)
-    config = facet_configuration_for_field(field)
-
-    Deprecation.silence(Blacklight::SearchState) do
-      search_state.has_facet? config, value: facet_value_for_facet_item(item)
-    end
-  end
-  deprecation_deprecate :facet_in_params?
-
-  ##
-  # Get the values of the facet set in the blacklight query string
-  # @deprecated
-  def facet_params field
-    config = facet_configuration_for_field(field)
-
-    search_state.params.dig(:f, config.key)
-  end
-  deprecation_deprecate :facet_params
-
-  ##
-  # Get the displayable version of a facet's value
-  #
-  # @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)
-    facet_item_presenter(facet_config, item, field).label
-  end
-
-  # @deprecated
-  def facet_field_id facet_field
-    "facet-#{facet_field.key.parameterize}"
-  end
-  deprecation_deprecate :facet_field_id
 
   private
 
@@ -316,25 +18,6 @@ module Blacklight::FacetsHelperBehavior
   end
 
   def facet_item_presenter(facet_config, facet_item, facet_field)
-    (facet_config.item_presenter || 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)
+    facet_config.item_presenter.new(facet_item, facet_config, self, facet_field)
   end
 end

data/app/helpers/blacklight/icon_helper_behavior.rb

@@ -12,9 +12,10 @@ module Blacklight::IconHelperBehavior
   def blacklight_icon(icon_name, **kwargs)
     render "Blacklight::Icons::#{icon_name.to_s.camelize}Component".constantize.new(**kwargs)
   rescue NameError
-    Rails.cache.fetch([:blacklight_icons, icon_name, kwargs]) do
-      icon = Blacklight::Icon.new(icon_name, **kwargs)
-      tag.span(icon.svg.html_safe, **icon.options)
-    end
+    Blacklight.deprecation.warn(
+      "Falling back on the LegacyIconComponent with \"#{icon_name}\" is deprecated. Instead create the component `Blacklight::Icons::#{icon_name.to_s.camelize}Component` for this icon."
+    )
+
+    render Blacklight::Icons::LegacyIconComponent.new(name: icon_name, **kwargs)
   end
 end