blacklight 6.14.0 → 7.0.0

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -1,28 +1,24 @@
 # frozen_string_literal: true
 # Methods added to this helper will be available to all templates in the hosting application
 module Blacklight::BlacklightHelperBehavior
-  include BlacklightUrlHelper
-  include BlacklightConfigurationHelper
-  include HashAsHiddenFieldsHelper
-  include RenderConstraintsHelper
-  include RenderPartialsHelper
-  include FacetsHelper
-  extend Deprecation
-  self.deprecation_horizon = 'Blacklight version 7.0.0'
+  include UrlHelperBehavior
+  include HashAsHiddenFieldsHelperBehavior
+  include LayoutHelperBehavior
+  include IconHelperBehavior
 
   ##
-  # Get the name of this application, from either:
-  #  - the Rails configuration
-  #  - an i18n string (key: blacklight.application_name; preferred)
+  # Get the name of this application from an i18n string
+  # key: blacklight.application_name
+  # Try first in the current locale, then the default locale
   #
   # @return [String] the application name
   def application_name
-    if Rails.application.config.respond_to? :application_name
-      Deprecation.warn(self, "BlacklightHelper#application_name will no longer delegate to config.application_name in version 7.0. Set the i18n for blacklight.application_name instead")
-      return Rails.application.config.application_name
+    # It's important that we don't use ActionView::Helpers::CacheHelper#cache here
+    # because it returns nil.
+    Rails.cache.fetch 'blacklight/application_name' do
+      t('blacklight.application_name',
+        default: t('blacklight.application_name', locale: I18n.default_locale))
     end
-
-    t('blacklight.application_name')
   end
 
   ##
@@ -44,8 +40,9 @@ module Blacklight::BlacklightHelperBehavior
   # @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 render_link_rel_alternates(document=@document, options = {})
+  def render_link_rel_alternates(document = @document, options = {})
     return if document.nil?
+
     presenter(document).link_rel_alternates(options)
   end
 
@@ -53,7 +50,7 @@ module Blacklight::BlacklightHelperBehavior
   # Render OpenSearch headers for this search
   # @return [String]
   def render_opensearch_response_metadata
-    render :partial => 'catalog/opensearch_response_metadata'
+    render partial: 'catalog/opensearch_response_metadata'
   end
 
   ##
@@ -75,7 +72,11 @@ module Blacklight::BlacklightHelperBehavior
   # Render the search navbar
   # @return [String]
   def render_search_bar
-    render :partial=>'catalog/search_form'
+    search_bar_presenter.render
+  end
+
+  def search_bar_presenter
+    @search_bar ||= search_bar_presenter_class.new(controller, blacklight_config)
   end
 
   ##
@@ -85,6 +86,7 @@ module Blacklight::BlacklightHelperBehavior
   # @param [Blacklight::Configuration::Field] field_config
   # @return [Boolean]
   def should_render_index_field? document, field_config
+    Deprecation.warn self, "should_render_index_field? is deprecated and will be removed in Blacklight 8. Use IndexPresenter#render_field? instead."
     should_render_field?(field_config, document) && document_has_value?(document, field_config)
   end
 
@@ -95,6 +97,7 @@ module Blacklight::BlacklightHelperBehavior
   # @param [Blacklight::Configuration::Field] field_config
   # @return [Boolean]
   def should_render_show_field? document, field_config
+    Deprecation.warn self, "should_render_show_field? is deprecated and will be removed in Blacklight 8. Use ShowPresenter#render_field? instead."
     should_render_field?(field_config, document) && document_has_value?(document, field_config)
   end
 
@@ -105,6 +108,7 @@ module Blacklight::BlacklightHelperBehavior
   # @param [Blacklight::Configuration::Field] field_config
   # @return [Boolean]
   def document_has_value? document, field_config
+    Deprecation.warn self, "document_has_value? is deprecated and will be removed in Blacklight 8. Use DocumentPresenter#has_value? instead."
     document.has?(field_config.field) ||
       (document.has_highlight_field? field_config.field if field_config.highlight) ||
       field_config.accessor
@@ -116,12 +120,18 @@ module Blacklight::BlacklightHelperBehavior
   # @param [Blacklight::Solr::Response] response
   # @return [Boolean]
   def should_show_spellcheck_suggestions? response
-    response.total <= spell_check_max and response.spelling.words.any?
+    # The spelling response field may be missing from non solr repositories.
+    response.total <= spell_check_max &&
+      !response.spelling.nil? &&
+      response.spelling.words.any?
   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
+  #
   # @overload render_index_field_label(options)
   #   Use the default, document-agnostic configuration
   #   @param [Hash] opts
@@ -140,45 +150,6 @@ module Blacklight::BlacklightHelperBehavior
     html_escape t(:"blacklight.search.index.#{document_index_view_type}.label", default: :'blacklight.search.index.label', label: index_field_label(document, field))
   end
 
-  ##
-  # Render the index field label for a document
-  #
-  # @overload render_index_field_value(options)
-  #   Use the default, document-agnostic configuration
-  #   @param [Hash] opts
-  #   @option opts [String] :field
-  #   @option opts [String] :value
-  #   @option opts [String] :document
-  # @overload render_index_field_value(document, options)
-  #   Allow an extention point where information in the document
-  #   may drive the value of the field
-  #   @param [SolrDocument] doc
-  #   @param [Hash] opts
-  #   @option opts [String] :field
-  #   @option opts [String] :value
-  # @overload render_index_field_value(document, field, options)
-  #   Allow an extention point where information in the document
-  #   may drive the value of the field
-  #   @param [SolrDocument] doc
-  #   @param [String] field
-  #   @param [Hash] opts
-  #   @option opts [String] :value
-  # @deprecated use IndexPresenter#field_value
-  def render_index_field_value *args
-    render_field_value(*args)
-  end
-  deprecation_deprecate render_index_field_value: 'replaced by IndexPresenter#field_value'
-
-  # @deprecated use IndexPresenter#field_value
-  def render_field_value(*args)
-    options = args.extract_options!
-    document = args.shift || options[:document]
-
-    field = args.shift || options[:field]
-    presenter(document).field_value field, options.except(:document, :field)
-  end
-  deprecation_deprecate render_field_value: 'replaced by IndexPresenter#field_value'
-
   ##
   # Render the show field label for a document
   #
@@ -201,42 +172,13 @@ module Blacklight::BlacklightHelperBehavior
     t(:'blacklight.search.show.label', label: document_show_field_label(document, field))
   end
 
-  ##
-  # Render the index field label for a document
-  #
-  # @overload render_document_show_field_value(options)
-  #   Use the default, document-agnostic configuration
-  #   @param [Hash] opts
-  #   @option opts [String] :field
-  #   @option opts [String] :value
-  #   @option opts [String] :document
-  # @overload render_document_show_field_value(document, options)
-  #   Allow an extention point where information in the document
-  #   may drive the value of the field
-  #   @param [SolrDocument] doc
-  #   @param [Hash] opts
-  #   @option opts [String] :field
-  #   @option opts [String] :value
-  # @overload render_document_show_field_value(document, field, options)
-  #   Allow an extention point where information in the document
-  #   may drive the value of the field
-  #   @param [SolrDocument] doc
-  #   @param [String] field
-  #   @param [Hash] opts
-  #   @option opts [String] :value
-  # @deprecated use ShowPresenter#field_value
-  def render_document_show_field_value *args
-    render_field_value(*args)
-  end
-  deprecation_deprecate render_document_show_field_value: 'replaced by ShowPresenter#field_value'
-
   ##
   # Get the value of the document's "title" field, or a placeholder
   # value (if empty)
   #
   # @param [SolrDocument] document
   # @return [String]
-  def document_heading document=nil
+  def document_heading document = nil
     document ||= @document
     presenter(document).heading
   end
@@ -248,7 +190,7 @@ module Blacklight::BlacklightHelperBehavior
   # @see #document_heading
   # @param [SolrDocument] document
   # @return [String]
-  def document_show_html_title document=nil
+  def document_show_html_title document = nil
     document ||= @document
 
     presenter(document).html_title
@@ -272,33 +214,15 @@ module Blacklight::BlacklightHelperBehavior
     content_tag(tag, presenter(document).heading, itemprop: "name")
   end
 
-  ##
-  # Get the value for a document's field, and prepare to render it.
-  # - highlight_field
-  # - accessor
-  # - solr field
-  #
-  # Rendering:
-  #   - helper_method
-  #   - link_to_search
-  # @param [SolrDocument] document
-  # @param [String] _field name
-  # @param [Blacklight::Configuration::Field] field_config solr field configuration
-  # @param [Hash] options additional options to pass to the rendering helpers
-  def get_field_values document, _field, field_config, options = {}
-    presenter(document).field_values field_config, options
-  end
-  deprecation_deprecate :get_field_values
-
   ##
   # Get the current "view type" (and ensure it is a valid type)
   #
   # @param [Hash] query_params the query parameters to check
   # @return [Symbol]
-  def document_index_view_type query_params=params
+  def document_index_view_type query_params = params
     view_param = query_params[:view]
     view_param ||= session[:preferred_view]
-    if view_param and document_index_views.keys.include? view_param.to_sym
+    if view_param && document_index_views.key?(view_param.to_sym)
       view_param.to_sym
     else
       default_document_index_view_type
@@ -314,7 +238,7 @@ module Blacklight::BlacklightHelperBehavior
   #
   # @param [String] format suffix
   # @yield
-  def with_format(format, &block)
+  def with_format(format)
     old_formats = formats
     self.formats = [format]
     yield
@@ -338,9 +262,6 @@ module Blacklight::BlacklightHelperBehavior
       show_presenter(document)
     when 'index'
       index_presenter(document)
-    else
-      Deprecation.warn(Blacklight::BlacklightHelperBehavior, "Unable to determine presenter type for #{action_name} on #{controller_name}, falling back on deprecated Blacklight::DocumentPresenter")
-      presenter_class.new(document, self)
     end
   end
 
@@ -352,11 +273,6 @@ module Blacklight::BlacklightHelperBehavior
     index_presenter_class(document).new(document, self)
   end
 
-  def presenter_class
-    blacklight_config.document_presenter_class
-  end
-  deprecation_deprecate presenter_class: "replaced by show_presenter_class and index_presenter_class"
-
   ##
   # Override this method if you want to use a different presenter class
   def show_presenter_class(_document)
@@ -367,6 +283,10 @@ module Blacklight::BlacklightHelperBehavior
     blacklight_config.index.document_presenter_class
   end
 
+  def search_bar_presenter_class
+    blacklight_config.index.search_bar_presenter_class
+  end
+
   ##
   # Open Search discovery tag for HTML <head> links
   def opensearch_description_tag title, href

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -1,12 +1,23 @@
 # frozen_string_literal: true
 module Blacklight::CatalogHelperBehavior
-  # @param [Hash] options 
+  extend Deprecation
+  self.deprecation_horizon = 'blacklight 8.0'
+
+  include ConfigurationHelperBehavior
+  include ComponentHelperBehavior
+  include FacetsHelperBehavior
+  include RenderConstraintsHelperBehavior
+  include RenderPartialsHelperBehavior
+  include SearchHistoryConstraintsHelperBehavior
+  include SuggestHelperBehavior
+
+  # @param [Hash] options
   # @option options :route_set the route scope to use when constructing the link
   def rss_feed_link_tag(options = {})
     auto_discovery_link_tag(:rss, feed_link_url('rss', options), title: t('blacklight.search.rss_feed'))
   end
 
-  # @param [Hash] options 
+  # @param [Hash] options
   # @option options :route_set the route scope to use when constructing the link
   def atom_feed_link_tag(options = {})
     auto_discovery_link_tag(:atom, feed_link_url('atom', options), title: t('blacklight.search.atom_feed'))
@@ -29,43 +40,43 @@ module Blacklight::CatalogHelperBehavior
     return unless show_pagination? collection
 
     entry_name = if options[:entry_name]
-      options[:entry_name]
-    elsif collection.respond_to? :model  # DataMapper
-      collection.model.model_name.human.downcase
-    elsif collection.respond_to? :model_name and !collection.model_name.nil? # AR, Blacklight::PaginationMethods
-      collection.model_name.human.downcase
-    else
-      t('blacklight.entry_name.default')
-    end
+                   options[:entry_name]
+                 elsif collection.respond_to? :model  # DataMapper
+                   collection.model.model_name.human.downcase
+                 elsif collection.respond_to?(:model_name) && !collection.model_name.nil? # AR, Blacklight::PaginationMethods
+                   collection.model_name.human.downcase
+                 else
+                   t('blacklight.entry_name.default')
+                 end
 
     entry_name = entry_name.pluralize unless collection.total_count == 1
 
     # grouped response objects need special handling
-    end_num = if collection.respond_to? :groups and render_grouped_response? collection
-      collection.groups.length
-    else
-      collection.limit_value
-    end
+    end_num = if collection.respond_to?(:groups) && render_grouped_response?(collection)
+                collection.groups.length
+              else
+                collection.limit_value
+              end
 
     end_num = if collection.offset_value + end_num <= collection.total_count
-      collection.offset_value + end_num
-    else
-      collection.total_count
-    end
-      
+                collection.offset_value + end_num
+              else
+                collection.total_count
+              end
+
     case collection.total_count
       when 0
-        t('blacklight.search.pagination_info.no_items_found', :entry_name => entry_name ).html_safe
+        t('blacklight.search.pagination_info.no_items_found', entry_name: entry_name).html_safe
       when 1
-        t('blacklight.search.pagination_info.single_item_found', :entry_name => entry_name).html_safe
+        t('blacklight.search.pagination_info.single_item_found', entry_name: entry_name).html_safe
       else
-        t('blacklight.search.pagination_info.pages', :entry_name => entry_name,
-                                                     :current_page => collection.current_page,
-                                                     :num_pages => collection.total_pages,
-                                                     :start_num => number_with_delimiter(collection.offset_value + 1),
-                                                     :end_num => number_with_delimiter(end_num),
-                                                     :total_num => number_with_delimiter(collection.total_count),
-                                                     :count => collection.total_pages).html_safe
+        t('blacklight.search.pagination_info.pages', entry_name: entry_name,
+                                                     current_page: collection.current_page,
+                                                     num_pages: collection.total_pages,
+                                                     start_num: number_with_delimiter(collection.offset_value + 1),
+                                                     end_num: number_with_delimiter(end_num),
+                                                     total_num: number_with_delimiter(collection.total_count),
+                                                     count: collection.total_pages).html_safe
     end
   end
 
@@ -79,7 +90,7 @@ module Blacklight::CatalogHelperBehavior
     offset ||= @response.start if @response
     offset ||= 0
 
-    unless render_grouped_response? 
+    unless render_grouped_response?
       idx + 1 + offset
     end
   end
@@ -87,20 +98,20 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Like #page_entries_info above, but for an individual
   # item show page. Displays "showing X of Y items" message.
-  # 
+  #
   # @see #page_entries_info
   # @return [String]
   def item_page_entry_info
-    t('blacklight.search.entry_pagination_info.other', :current => number_with_delimiter(search_session['counter']),
-                                                       :total => number_with_delimiter(search_session['total']),
-                                                       :count => search_session['total'].to_i).html_safe
+    t('blacklight.search.entry_pagination_info.other', current: number_with_delimiter(search_session['counter']),
+                                                       total: number_with_delimiter(search_session['total']),
+                                                       count: search_session['total'].to_i).html_safe
   end
 
   ##
   # Look up search field user-displayable label
   # based on params[:qt] and blacklight_configuration.
   def search_field_label(params)
-    h( label_for_search_field(params[:search_field]) )
+    h(label_for_search_field(params[:search_field]))
   end
 
   ##
@@ -108,20 +119,20 @@ module Blacklight::CatalogHelperBehavior
   #
   # @return [Blacklight::Configuration::SortField]
   def current_sort_field
-    (blacklight_config.sort_fields.values.find {|f| f.sort == @response.sort} if @response and @response.sort.present?) || blacklight_config.sort_fields[params[:sort]] || default_sort_field
+    (blacklight_config.sort_fields.values.find { |f| f.sort == @response.sort } if @response && @response.sort.present?) || blacklight_config.sort_fields[params[:sort]] || default_sort_field
   end
 
   ##
   # Look up the current per page value, or the default if none if set
-  # 
+  #
   # @return [Integer]
   def current_per_page
-    (@response.rows if @response and @response.rows > 0) || params.fetch(:per_page, default_per_page).to_i
+    (@response.rows if @response && @response.rows > 0) || params.fetch(:per_page, blacklight_config.default_per_page).to_i
   end
 
   ##
   # Get the classes to add to a document's div
-  # 
+  #
   # @return [String]
   def render_document_class(document = @document)
     types = document[blacklight_config.view_config(document_index_view_type).display_type_field]
@@ -142,8 +153,8 @@ module Blacklight::CatalogHelperBehavior
   #
   # @param [SolrDocument] document
   # @return [String]
-  def render_document_sidebar_partial(document = @document)
-    render :partial => 'show_sidebar'
+  def render_document_sidebar_partial(_document = @document)
+    render partial: 'show_sidebar'
   end
 
   ##
@@ -151,13 +162,13 @@ module Blacklight::CatalogHelperBehavior
   #
   # @param [SolrDocument] document
   # @return [String]
-  def render_document_main_content_partial(document = @document)
+  def render_document_main_content_partial(_document = @document)
     render partial: 'show_main_content'
   end
 
   ##
   # Should we display the sort and per page widget?
-  # 
+  #
   # @param [Blacklight::Solr::Response] response
   # @return [Boolean]
   def show_sort_and_per_page? response = nil
@@ -178,57 +189,41 @@ module Blacklight::CatalogHelperBehavior
   ##
   # If no search parameters have been given, we should
   # auto-focus the user's cursor into the searchbox
-  # 
+  #
   # @return [Boolean]
   def should_autofocus_on_search_box?
-    controller.is_a? Blacklight::Catalog and
-      action_name == "index" and
+    controller.is_a?(Blacklight::Catalog) &&
+      action_name == "index" &&
       !has_search_parameters?
   end
+  deprecation_deprecate should_autofocus_on_search_box?: "use SearchBarPresenter#autofocus?"
 
   ##
   # Does the document have a thumbnail to render?
-  # 
+  #
   # @param [SolrDocument] document
   # @return [Boolean]
   def has_thumbnail? document
-    blacklight_config.view_config(document_index_view_type).thumbnail_method.present? or
-      blacklight_config.view_config(document_index_view_type).thumbnail_field && document.has?(blacklight_config.view_config(document_index_view_type).thumbnail_field)
+    index_presenter(document).thumbnail.exists?
   end
+  deprecation_deprecate has_thumbnail?: "use IndexPresenter#thumbnail.exists?"
 
   ##
   # Render the thumbnail, if available, for a document and
   # link it to the document record.
-  # 
+  #
   # @param [SolrDocument] document
   # @param [Hash] image_options to pass to the image tag
   # @param [Hash] url_options to pass to #link_to_document
   # @return [String]
   def render_thumbnail_tag document, image_options = {}, url_options = {}
-    value = if blacklight_config.view_config(document_index_view_type).thumbnail_method
-      send(blacklight_config.view_config(document_index_view_type).thumbnail_method, document, image_options)
-    elsif blacklight_config.view_config(document_index_view_type).thumbnail_field
-      url = thumbnail_url(document)
-
-      image_tag url, image_options if url.present?
-    end
-
-    if value
-      if url_options == false
-        Deprecation.warn(self, "passing false as the second argument to render_thumbnail_tag is deprecated. Use suppress_link: true instead. This behavior will be removed in Blacklight 7")
-        url_options = { suppress_link: true }
-      end
-      if url_options[:suppress_link]
-        value
-      else
-        link_to_document document, value, url_options
-      end
-    end
+    index_presenter(document).thumbnail.thumbnail_tag(image_options, url_options)
   end
+  deprecation_deprecate render_thumbnail_tag: "Use IndexPresenter#thumbnail.thumbnail_tag"
 
   ##
   # Get the URL to a document's thumbnail image
-  # 
+  #
   # @param [SolrDocument] document
   # @return [String]
   def thumbnail_url document
@@ -236,14 +231,15 @@ module Blacklight::CatalogHelperBehavior
       document.first(blacklight_config.view_config(document_index_view_type).thumbnail_field)
     end
   end
+  deprecation_deprecate thumbnail_url: "this method will be removed without replacement"
 
   ##
   # Render the view type icon for the results view picker
-  # 
+  #
   # @param [String] view
   # @return [String]
   def render_view_type_group_icon view
-    content_tag :span, '', class: "glyphicon #{blacklight_config.view[view].icon_class || default_view_type_group_icon_classes(view)}"
+    blacklight_icon(view)
   end
 
   ##
@@ -252,28 +248,38 @@ module Blacklight::CatalogHelperBehavior
   # @param [String] view
   # @return [String]
   def default_view_type_group_icon_classes view
+    Deprecation.warn(Blacklight::CatalogHelperBehavior, 'This method has been deprecated, use blacklight_icons helper instead')
     "glyphicon-#{view.to_s.parameterize} view-icon-#{view.to_s.parameterize}"
   end
-  
-  def current_bookmarks response = nil
-    response ||= @response
-    @current_bookmarks ||= current_or_guest_user.bookmarks_for_documents(response.documents).to_a
+
+  def current_bookmarks documents_or_response = nil
+    documents = if documents_or_response.respond_to? :documents
+                  Deprecation.warn(Blacklight::CatalogHelperBehavior, "Passing a response to #current_bookmarks is deprecated; pass response.documents instead")
+                  documents_or_response.documents
+                else
+                  documents_or_response
+                end
+
+    documents ||= [@document] if @document.present?
+    documents ||= @response.documents
+
+    @current_bookmarks ||= current_or_guest_user.bookmarks_for_documents(documents).to_a
   end
 
   ##
   # Check if the document is in the user's bookmarks
   def bookmarked? document
-    current_bookmarks.any? { |x| x.document_id == document.id and x.document_type == document.class }
+    current_bookmarks.any? { |x| x.document_id == document.id && x.document_type == document.class }
   end
 
   def render_search_to_page_title_filter(facet, values)
     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
-    else 
-      t('blacklight.search.page_title.many_constraint_values', values: values.size)
-    end
+                     values.map { |value| facet_display_value(facet, value) }.to_sentence
+                   else
+                     t('blacklight.search.page_title.many_constraint_values', values: values.size)
+                   end
     t('blacklight.search.page_title.constraint', label: filter_label, value: filter_value)
   end
 
@@ -299,11 +305,11 @@ module Blacklight::CatalogHelperBehavior
 
   private
 
-    # @param [String] format 
-    # @param [Hash] options 
-    # @option options :route_set the route scope to use when constructing the link
-    def feed_link_url(format, options = {})
-      scope = options.delete(:route_set) || self
-      scope.url_for search_state.to_h.merge(format: format)
-    end
+  # @param [String] format
+  # @param [Hash] options
+  # @option options :route_set the route scope to use when constructing the link
+  def feed_link_url(format, options = {})
+    scope = options.delete(:route_set) || self
+    scope.url_for search_state.to_h.merge(format: format)
+  end
 end