blacklight 7.11.1 → 7.12.0

data/app/helpers/blacklight/render_partials_helper_behavior.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 module Blacklight::RenderPartialsHelperBehavior
+  extend Deprecation
+
   ##
   # Render the document index view
   #
@@ -16,6 +18,7 @@ module Blacklight::RenderPartialsHelperBehavior
   def render_grouped_document_index
     render 'catalog/group'
   end
+  deprecation_deprecate render_grouped_document_index: 'Removed without replacement'
 
   ##
   # Return the list of partials for a given solr document
@@ -54,7 +57,7 @@ module Blacklight::RenderPartialsHelperBehavior
   # @param [String] base_name base name for the partial
   # @param [Hash] locals local variables to pass through to the partials
   def render_document_partial(doc, base_name, locals = {})
-    format = document_partial_name(doc, base_name)
+    format = Deprecation.silence(Blacklight::RenderPartialsHelperBehavior) { document_partial_name(doc, base_name) }
 
     view_type = document_index_view_type
     template = cached_view ['show', view_type, base_name, format].join('_') do
@@ -111,14 +114,16 @@ module Blacklight::RenderPartialsHelperBehavior
   ##
   # Return a normalized partial name for rendering a single document
   #
+  # @private
   # @param [SolrDocument] document
   # @param [Symbol] base_name base name for the partial
   # @return [String]
   def document_partial_name(document, base_name = nil)
-    display_type = show_presenter(document).display_type(base_name, default: 'default')
+    display_type = document_presenter(document).display_type(base_name, default: 'default')
 
     type_field_to_partial_name(document, display_type)
   end
+  deprecation_deprecate document_partial_name: 'Moving to a private method'
 
   private
 
@@ -127,7 +132,7 @@ module Blacklight::RenderPartialsHelperBehavior
   # this method can be overridden in order to transform the value
   #   (e.g. 'PdfBook' => 'pdf_book')
   #
-  # @param [SolrDocument] document
+  # @param [SolrDocument] _document
   # @param [String, Array] display_type a value suggestive of a partial
   # @return [String] the name of the partial to render
   # @example

data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb

@@ -20,7 +20,7 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
   def render_search_to_s_q(params)
     return "".html_safe if params['q'].blank?
 
-    label = label_for_search_field(params[:search_field]) unless default_search_field && params[:search_field] == default_search_field[:key]
+    label = label_for_search_field(params[:search_field]) unless default_search_field?(params[:search_field])
 
     render_search_to_s_element(label, render_filter_value(params['q']))
   end
@@ -60,7 +60,9 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
   # Render the value of the facet
   def render_filter_value value, key = nil
     display_value = value
-    display_value = facet_display_value(key, value) if key
+    Deprecation.silence(Blacklight::FacetsHelperBehavior) do
+      display_value = facet_display_value(key, value) if key
+    end
     tag.span(h(display_value),
              class: 'filter-value')
   end

data/app/helpers/blacklight/suggest_helper_behavior.rb

@@ -2,6 +2,7 @@
 module Blacklight
   module SuggestHelperBehavior
     ##
+    # @deprecated
     # @return [Boolean] should autocomplete be enabled in the UI
     def autocomplete_enabled?
       blacklight_config.autocomplete_enabled.present? &&

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -2,9 +2,13 @@
 ##
 # URL helper methods
 module Blacklight::UrlHelperBehavior
+  extend Deprecation
+
+  # @deprecated
   def url_for_document(doc, options = {})
     search_state.url_for_document(doc, options)
   end
+  deprecation_deprecate url_for_document: 'Use SearchState#url_for_document directly'
 
   # Uses the catalog_path route to create a link to the show page for an item.
   # catalog_path accepts a hash. The solr query params are stored in the session,
@@ -21,10 +25,10 @@ module Blacklight::UrlHelperBehavior
   def link_to_document(doc, field_or_opts = nil, opts = { counter: nil })
     label = case field_or_opts
             when NilClass
-              index_presenter(doc).heading
+              document_presenter(doc).heading
             when Hash
               opts = field_or_opts
-              index_presenter(doc).heading
+              document_presenter(doc).heading
             when Proc, Symbol
               Deprecation.warn(self, "passing a #{field_or_opts.class} to link_to_document is deprecated and will be removed in Blacklight 8")
               Deprecation.silence(Blacklight::IndexPresenter) do
@@ -34,9 +38,12 @@ module Blacklight::UrlHelperBehavior
               field_or_opts
             end
 
-    link_to label, url_for_document(doc), document_link_params(doc, opts)
+    Deprecation.silence(Blacklight::UrlHelperBehavior) do
+      link_to label, url_for_document(doc), document_link_params(doc, opts)
+    end
   end
 
+  # @private
   def document_link_params(doc, opts)
     session_tracking_params(doc, opts[:counter]).deep_merge(opts.except(:label, :counter))
   end
@@ -44,24 +51,29 @@ module Blacklight::UrlHelperBehavior
 
   ##
   # Link to the previous document in the current search context
+  # @deprecated
   def link_to_previous_document(previous_document)
     link_opts = session_tracking_params(previous_document, search_session['counter'].to_i - 1).merge(class: "previous", rel: 'prev')
     link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), url_for_document(previous_document), link_opts do
       tag.span raw(t('views.pagination.previous')), class: 'previous'
     end
   end
+  deprecation_deprecate link_to_previous_document: 'Moving to Blacklight::SearchContextComponent'
 
   ##
   # Link to the next document in the current search context
+  # @deprecated
   def link_to_next_document(next_document)
     link_opts = session_tracking_params(next_document, search_session['counter'].to_i + 1).merge(class: "next", rel: 'next')
     link_to_unless next_document.nil?, raw(t('views.pagination.next')), url_for_document(next_document), link_opts do
       tag.span raw(t('views.pagination.next')), class: 'next'
     end
   end
+  deprecation_deprecate link_to_previous_document: 'Moving to Blacklight::SearchContextComponent'
 
   ##
   # Attributes for a link that gives a URL we can use to track clicks for the current search session
+  # @private
   # @param [SolrDocument] document
   # @param [Integer] counter
   # @example
@@ -100,15 +112,18 @@ module Blacklight::UrlHelperBehavior
   #
 
   # create link to query (e.g. spelling suggestion)
+  # @deprecated
   def link_to_query(query)
     p = search_state.to_h.except(:page, :action)
     p[:q] = query
     link_to(query, search_action_path(p))
   end
+  deprecation_deprecate link_to_query: 'Removed without replacement'
 
   ##
   # Get the path to the search action with any parameters (e.g. view type)
   # that should be persisted across search sessions.
+  # @deprecated
   def start_over_path query_params = params
     h = {}
     current_index_view_type = document_index_view_type(query_params)
@@ -116,6 +131,7 @@ module Blacklight::UrlHelperBehavior
 
     search_action_path(h)
   end
+  deprecation_deprecate start_over_path: 'Removed without replacement'
 
   # Create a link back to the index screen, keeping the user's facet, query and paging choices intact by using session.
   # @example
@@ -156,17 +172,21 @@ module Blacklight::UrlHelperBehavior
 
   # Get url parameters to a search within a grouped result set
   #
+  # @deprecated
   # @param [Blacklight::Solr::Response::Group] group
   # @return [Hash]
   def add_group_facet_params_and_redirect group
     search_state.add_facet_params_and_redirect(group.field, group.key)
   end
+  deprecation_deprecate add_group_facet_params_and_redirect: 'Removed without replacement'
 
   # A URL to refworks export, with an embedded callback URL to this app.
   # the callback URL is to bookmarks#export, which delivers a list of
   # user's bookmarks in 'refworks marc txt' format -- we tell refworks
   # to expect that format.
+  # @deprecated
   def bookmarks_export_url(format, params = {})
     bookmarks_url(params.merge(format: format, encrypted_user_id: encrypt_user_id(current_or_guest_user.id)))
   end
+  deprecation_deprecate bookmarks_export_url: 'Removed without replacement'
 end

data/app/models/blacklight/icon.rb

@@ -6,7 +6,6 @@ module Blacklight
 
     ##
     # @param [String, Symbol] icon_name
-    # @param [Hash] options
     # @param [String] classes additional classes separated by a string
     # @param [Boolean] aria_hidden include aria_hidden attribute
     # @param [Boolean] label include <title> and aria-label as part of svg

data/app/models/concerns/blacklight/document.rb

@@ -111,7 +111,7 @@ module Blacklight::Document
     end
 
     # Define an attribute reader on a document model
-    # @Example
+    # @example
     #   class SolrDocument
     #     include Blacklight::Solr::Document
     #     attribute :title, Blacklight::Types::String, 'title_tesim'

data/app/models/concerns/blacklight/suggest/response.rb

@@ -18,7 +18,7 @@ module Blacklight
       end
 
       ##
-      # Trys the suggestor response to return suggestions if they are
+      # Trys the suggester response to return suggestions if they are
       # present
       # @return [Array]
       def suggestions

data/app/models/record_mailer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 # Only works for documents with a #to_marc right now.
-class RecordMailer < ApplicationMailer
+class RecordMailer < ActionMailer::Base
   def email_record(documents, details, url_gen_params)
     title = begin
               documents.first.to_semantic_values[:title]

data/app/presenters/blacklight/document_presenter.rb

@@ -49,11 +49,36 @@ module Blacklight
       f ? field_value(f, except_operations: [Rendering::HelperMethod]) : ""
     end
 
+    ##
+    # Get the document's "title" to display in the <title> element.
+    # (by default, use the #document_heading)
+    #
+    # @see #document_heading
+    # @return [String]
+    def html_title
+      return field_value(view_config.html_title_field) if view_config.html_title_field.is_a? Blacklight::Configuration::Field
+
+      if view_config.html_title_field
+        fields = Array.wrap(view_config.html_title_field) + [configuration.document_model.unique_key]
+        f = fields.lazy.map { |field| field_config(field) }.detect { |field_config| field_presenter(field_config).any? }
+        field_value(f)
+      else
+        heading
+      end
+    end
+
     def display_type(base_name = nil, default: nil)
       fields = []
       fields += Array.wrap(view_config[:"#{base_name}_display_type_field"]) if base_name && view_config.key?(:"#{base_name}_display_type_field")
       fields += Array.wrap(view_config.display_type_field)
 
+      if fields.empty?
+        fields += Array.wrap(configuration.show[:"#{base_name}_display_type_field"]) if base_name && configuration.show.key?(:"#{base_name}_display_type_field")
+        fields += Array.wrap(configuration.show.display_type_field)
+      end
+
+      fields += ['format'] if fields.empty? # backwards compatibility with the old default value for display_type_field
+
       display_type = fields.lazy.map { |field| field_presenter(field_config(field)) }.detect(&:any?)&.values
       display_type ||= Array(default) if default
 
@@ -76,6 +101,18 @@ module Blacklight
       @thumbnail ||= thumbnail_presenter.new(document, view_context, view_config)
     end
 
+    ##
+    # Create <link rel="alternate"> links from a documents dynamically
+    # provided export formats. Returns empty string if no links available.
+    #
+    # @param [Hash] options
+    # @option options [Boolean] :unique ensures only one link is output for every
+    #     content type, e.g. as required by atom
+    # @option options [Array<String>] :exclude array of format shortnames to not include in the output
+    def link_rel_alternates(options = {})
+      LinkAlternatePresenter.new(view_context, document, options).render
+    end
+
     private
 
     def render_field?(field_config)
@@ -100,7 +137,11 @@ module Blacklight
 
     def field_presenter(field_config, options = {})
       presenter_class = field_config.presenter || Blacklight::FieldPresenter
-      presenter_class.new(view_context, document, field_config, options)
+      presenter_class.new(view_context, document, field_config, options.merge(field_presenter_options))
+    end
+
+    def field_presenter_options
+      {}
     end
   end
 end

data/app/presenters/blacklight/facet_field_presenter.rb

@@ -51,7 +51,9 @@ module Blacklight
     def paginator
       return unless display_facet
 
-      @paginator ||= view_context.facet_paginator(facet_field, display_facet)
+      Deprecation.silence(Blacklight::Facet) do
+        @paginator ||= view_context.facet_paginator(facet_field, display_facet)
+      end
     end
   end
 end

data/app/presenters/blacklight/facet_item_presenter.rb

@@ -21,6 +21,10 @@ module Blacklight
       search_state.has_facet? facet_config, value: facet_value
     end
 
+    def field_label
+      facet_field_presenter.label
+    end
+
     ##
     # Get the displayable version of a facet's value
     #
@@ -77,5 +81,9 @@ module Blacklight
         facet_item
       end
     end
+
+    def facet_field_presenter
+      @facet_field_presenter ||= view_context.facet_field_presenter(facet_config, {})
+    end
   end
 end

data/app/presenters/blacklight/field_presenter.rb

@@ -24,6 +24,7 @@ module Blacklight
                 end
 
       @except_operations = options[:except_operations] || []
+      @except_operations += field_config.except_operations || []
       # Implicitly prevent helper methods from drawing when drawing the label for the document
       @except_operations += [Rendering::HelperMethod] if options.key? :value
     end
@@ -31,21 +32,24 @@ module Blacklight
     attr_reader :view_context, :document, :field_config, :except_operations, :options
     delegate :key, to: :field_config
 
+    # @return [String]
     def render
       Rendering::Pipeline.new(values, field_config, document, view_context, pipeline_steps, options).render
     end
 
+    # @return [Enumerable]
     def values
       @values ||= retrieve_values
     end
 
-    def label(context = 'index', **options)
-      field_config.display_label(context, count: retrieve_values.count, **options)
+    # @param [String] context
+    # @return [String]
+    def label(context = nil, **options)
+      field_config.display_label(context || options.fetch(:context, 'index'), count: retrieve_values.count, **options)
     end
 
     ##
     # Check to see if the given field should be rendered in this context
-    # @param [Blacklight::Configuration::Field] field_config
     # @return [Boolean]
     def render_field?
       view_context.should_render_field?(field_config, document)
@@ -54,7 +58,6 @@ module Blacklight
     ##
     # Check if a document has (or, might have, in the case of accessor methods) a value for
     # the given solr field
-    # @param [Blacklight::Configuration::Field] field_config
     # @return [Boolean]
     def any?
       values.present?
@@ -63,11 +66,11 @@ module Blacklight
     private
 
     def pipeline_steps
-      (options[:steps] || Rendering::Pipeline.operations) - except_operations
+      (options[:steps] || field_config[:steps] || Rendering::Pipeline.operations) - except_operations
     end
 
     def retrieve_values
-      FieldRetriever.new(document, field_config).fetch
+      FieldRetriever.new(document, field_config, view_context).fetch
     end
   end
 end

data/app/presenters/blacklight/json_presenter.rb

@@ -18,7 +18,9 @@ module Blacklight
 
     # @return [Array<Blacklight::Solr::Response::Facets::FacetField>]
     def search_facets
-      facets_from_request(facet_field_names, @response).select { |display_facet| display_facet.items.present? }
+      Deprecation.silence(Blacklight::Facet) do
+        facets_from_request(facet_field_names, @response).select { |display_facet| display_facet.items.present? }
+      end
     end
 
     # extract the pagination info from the response object

data/app/presenters/blacklight/show_presenter.rb

@@ -1,36 +1,6 @@
 # frozen_string_literal: true
 module Blacklight
   class ShowPresenter < DocumentPresenter
-    ##
-    # Create <link rel="alternate"> links from a documents dynamically
-    # provided export formats. Returns empty string if no links available.
-    #
-    # @param [Hash] options
-    # @option options [Boolean] :unique ensures only one link is output for every
-    #     content type, e.g. as required by atom
-    # @option options [Array<String>] :exclude array of format shortnames to not include in the output
-    def link_rel_alternates(options = {})
-      LinkAlternatePresenter.new(view_context, document, options).render
-    end
-
-    ##
-    # Get the document's "title" to display in the <title> element.
-    # (by default, use the #document_heading)
-    #
-    # @see #document_heading
-    # @return [String]
-    def html_title
-      return field_value(view_config.html_title_field) if view_config.html_title_field.is_a? Blacklight::Configuration::Field
-
-      if view_config.html_title_field
-        fields = Array.wrap(view_config.html_title_field) + [configuration.document_model.unique_key]
-        f = fields.lazy.map { |field| field_config(field) }.detect { |field_config| field_presenter(field_config).any? }
-        field_value(f)
-      else
-        heading
-      end
-    end
-
     private
 
     # @return [Hash<String,Configuration::Field>]
@@ -45,5 +15,9 @@ module Blacklight
     def field_config(field)
       configuration.show_fields.fetch(field) { Configuration::NullField.new(field) }
     end
+
+    def field_presenter_options
+      { context: 'show' }
+    end
   end
 end