blacklight 7.40.0 → 8.0.0.beta1

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -1,16 +1,11 @@
 # frozen_string_literal: true
+
 # Helper methods for catalog-like controllers
 module Blacklight::CatalogHelperBehavior
-  extend Deprecation
-  self.deprecation_horizon = 'blacklight 8.0'
-
   include Blacklight::ConfigurationHelperBehavior
   include Blacklight::ComponentHelperBehavior
   include Blacklight::FacetsHelperBehavior
-  include Blacklight::RenderConstraintsHelperBehavior
   include Blacklight::RenderPartialsHelperBehavior
-  include Blacklight::SearchHistoryConstraintsHelperBehavior
-  include Blacklight::SuggestHelperBehavior
 
   # @param [Hash] options
   # @option options :route_set the route scope to use when constructing the link
@@ -64,18 +59,18 @@ module Blacklight::CatalogHelperBehavior
               end
 
     case collection.total_count
-      when 0
-        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
-      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
+    when 0
+      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
+    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
     end
   end
 
@@ -94,20 +89,6 @@ module Blacklight::CatalogHelperBehavior
     end
   end
 
-  ##
-  # Like #page_entries_info above, but for an individual
-  # item show page. Displays "showing X of Y items" message.
-  #
-  # @deprecated
-  # @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
-  end
-  deprecation_deprecate item_page_entry_info: 'Use Blacklight::SearchContextComponent methods instead'
-
   ##
   # Look up search field user-displayable label
   # based on params[:qt] and blacklight_configuration.
@@ -127,12 +108,10 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Look up the current per page value, or the default if none if set
   #
-  # @deprecated
   # @return [Integer]
   def current_per_page
     (@response.rows if @response && @response.rows > 0) || params.fetch(:per_page, blacklight_config.default_per_page).to_i
   end
-  deprecation_deprecate current_per_page: 'has moved to Blacklight::Search::PerPageComponent'
 
   ##
   # Get the classes to add to a document's div
@@ -164,27 +143,10 @@ module Blacklight::CatalogHelperBehavior
   #
   # @param [SolrDocument] document
   # @return [String]
-  def render_document_sidebar_partial(document = nil)
-    unless document
-      Deprecation.warn(self, 'render_document_sidebar_partial expects one argument ' \
-        '(@document) and you passed none. This behavior will be removed in version 8')
-      document = @document
-    end
+  def render_document_sidebar_partial(document)
     render 'show_sidebar', document: document
   end
 
-  ##
-  # Render the main content partial for a document
-  # This is widely used as by downstream apps when they override their show view.
-  # See https://github.com/search?q=render_document_main_content_partial&type=Code
-  #
-  # @param [SolrDocument] _document
-  # @return [String]
-  def render_document_main_content_partial(_document = @document)
-    render partial: 'show_main_content'
-  end
-  deprecation_deprecate render_document_main_content_partial: "Use \"render 'show_main_content'\" instead"
-
   ##
   # Should we display the sort and per page widget?
   #
@@ -206,95 +168,16 @@ module Blacklight::CatalogHelperBehavior
   end
 
   ##
-  # If no search parameters have been given, we should
-  # auto-focus the user's cursor into the searchbox
-  #
-  # @deprecated
-  # @return [Boolean]
-  def should_autofocus_on_search_box?
-    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?
-  #
-  # @deprecated
-  # @param [SolrDocument] document
-  # @return [Boolean]
-  def has_thumbnail? document
-    document_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.
-  #
-  # @deprecated
-  # @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 = {}
-    document_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
-  #
-  # @deprecated
-  # @param [SolrDocument] document
-  # @return [String]
-  def thumbnail_url document
-    if document.has? blacklight_config.view_config(document_index_view_type).thumbnail_field
-      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
-  #
-  # @deprecated
-  # @param [String] view
-  # @return [String]
-  def render_view_type_group_icon view
-    blacklight_icon(view)
-  end
-  deprecation_deprecate render_view_type_group_icon: 'call blacklight_icon instead'
-
-  ##
-  # Get the default view type classes for a view in the results view picker
-  #
-  # @deprecated
-  # @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
-
-  ##
-  # return the Bookmarks on a set of documents
-  # @param [Enumerable<Blacklight::Document>] documents_or_response
+  # return the Bookmarks on a set of documents (all bookmarks on the page)
+  # @private
   # @return [Enumerable<Bookmark>]
-  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
+  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

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -1,31 +1,11 @@
 # 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
+    # These things are added by add_nav_action
     #
     # @param [Hash] options
     # @return [String]
@@ -60,37 +40,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,35 +85,6 @@ 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
@@ -202,12 +92,6 @@ module Blacklight::ConfigurationHelperBehavior
   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"
-
-  ##
-  # @deprecated
   # The available options for results per page, in the style of #options_for_select
   def per_page_options_for_select
     return [] if blacklight_config.per_page.blank?
@@ -216,7 +100,6 @@ module Blacklight::ConfigurationHelperBehavior
       [t(:'blacklight.search.per_page.label', count: count).html_safe, count]
     end
   end
-  deprecation_deprecate per_page_options_for_select: 'has moved to Blacklight::Search::PerPageComponent'
 
   ##
   # Determine whether to render a field by evaluating :if and :unless conditions