blacklight 7.40.0 → 8.0.0.beta1

data/app/controllers/concerns/blacklight/controller.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
+
 # Filters added to this controller apply to all controllers in the hosting application
 # as this module is mixed-in to the application controller in the hosting app on installation.
 module Blacklight::Controller
   extend ActiveSupport::Concern
-  extend Deprecation
 
   included do
-    include Blacklight::SearchFields
-    helper Blacklight::SearchFields if respond_to? :helper
-
     include ActiveSupport::Callbacks
 
     # now in application.rb file under config.filter_parameters
@@ -16,6 +13,7 @@ module Blacklight::Controller
 
     # handle basic authorization exception with #access_denied
     rescue_from Blacklight::Exceptions::AccessDenied, with: :access_denied
+    helper BlacklightHelper
 
     if respond_to? :helper_method
       helper_method :current_user_session, :current_user, :current_or_guest_user
@@ -24,7 +22,6 @@ module Blacklight::Controller
       helper_method :has_user_authentication_provider?
       helper_method :blacklight_config, :blacklight_configuration_context # move to Catalog
       helper_method :search_action_url, :search_action_path
-      helper_method :search_facet_path # move to catalog? deprecate?
       helper_method :search_state
     end
 
@@ -33,12 +30,6 @@ module Blacklight::Controller
     # TODO: move to Searchable
     class_attribute :search_state_class
     self.search_state_class = Blacklight::SearchState
-
-    # Which class to use for the search service. You can subclass SearchService if you
-    # want to override any of the methods (e.g. SearchService#fetch)
-    # TODO: move to Searchable
-    class_attribute :search_service_class
-    self.search_service_class = Blacklight::SearchService
   end
 
   # @private
@@ -76,7 +67,7 @@ module Blacklight::Controller
   # which action the search form should use
   def search_action_url options = {}
     # Rails 4.2 deprecated url helpers accepting string keys for 'controller' or 'action'
-    search_catalog_url(options.except(:controller, :action))
+    search_catalog_url(options.to_h.except(:controller, :action))
   end
 
   def search_action_path *args
@@ -87,22 +78,6 @@ module Blacklight::Controller
     search_action_url(*args)
   end
 
-  # TODO: move to catalog? deprecate?
-  def search_facet_path(options = {})
-    opts = search_state
-           .to_h
-           .merge(action: "facet", only_path: true)
-           .merge(options)
-           .except(:page)
-    url_for opts
-  end
-
-  # Returns a list of Searches from the ids in the user's history.
-  # TODO: move to catalog? SearchHistory?
-  def searches_from_history
-    session[:history].blank? ? ::Search.none : ::Search.where(id: session[:history]).order("updated_at desc")
-  end
-
   # Should be provided by authentication provider
   # def current_user
   # end
@@ -126,21 +101,9 @@ module Blacklight::Controller
     respond_to? :current_user
   end
 
-  def require_user_authentication_provider
-    raise ActionController::RoutingError, 'Not Found' unless has_user_authentication_provider?
-  end
-  deprecation_deprecate require_user_authentication_provider: 'removed without replacement'
-
   ##
   # When a user logs in, transfer any saved searches or bookmarks to the current_user
   def transfer_guest_to_user
-    Deprecation.silence(Blacklight::Controller) do
-      transfer_guest_user_actions_to_current_user
-    end
-  end
-
-  # @deprecated use canonical `transfer_guest_to_user` method instead
-  def transfer_guest_user_actions_to_current_user
     return unless respond_to?(:current_user) && respond_to?(:guest_user) && current_user && guest_user
 
     current_user_searches = current_user.searches.pluck(:query_params)
@@ -159,7 +122,6 @@ module Blacklight::Controller
     # let guest_user know we've moved some bookmarks from under it
     guest_user.reload if guest_user.persisted?
   end
-  deprecation_deprecate :transfer_guest_user_actions_to_current_user
 
   ##
   # To handle failed authorization attempts, redirect the user to the

data/app/controllers/concerns/blacklight/search_context.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight::SearchContext
   extend ActiveSupport::Concern
 
@@ -17,6 +18,16 @@ module Blacklight::SearchContext
     end
   end
 
+  # The current search session
+  def current_search_session
+    @current_search_session ||= find_search_session
+  end
+
+  # Returns a list of Searches from the ids in the user's history.
+  def searches_from_history
+    session[:history].blank? ? ::Search.none : ::Search.where(id: session[:history]).order("updated_at desc")
+  end
+
   private
 
   # sets up the session[:search] hash if it doesn't already exist
@@ -27,11 +38,6 @@ module Blacklight::SearchContext
     session[:search]
   end
 
-  # The current search session
-  def current_search_session
-    @current_search_session ||= find_search_session
-  end
-
   # Persist the current search session id to the user's session
   def set_current_search_session
     search_session['id'] = current_search_session.id if current_search_session
@@ -79,7 +85,7 @@ module Blacklight::SearchContext
   end
 
   def find_or_initialize_search_session_from_params params
-    params_copy = params.reject { |k, v| blacklisted_search_session_params.include?(k.to_sym) || v.blank? }
+    params_copy = params.reject { |k, v| nonpersisted_search_session_params.include?(k.to_sym) || v.blank? }
 
     return if params_copy.reject { |k, _v| [:action, :controller].include? k.to_sym }.blank?
 
@@ -102,10 +108,22 @@ module Blacklight::SearchContext
   end
 
   # A list of query parameters that should not be persisted for a search
-  def blacklisted_search_session_params
+  def nonpersisted_search_session_params
+    unless method(:blacklisted_search_session_params).source_location.first.end_with?('deprecation/method_wrappers.rb')
+      # The blacklisted_search_session_params was overridden, so call it.
+      Blacklight.deprecation.warn(self, "blacklisted_search_session_params was overriden in your app, " \
+                                        "but that method should be renamed to `nonpersisted_search_session_params'. " \
+                                        "The original behavior will be removed in the next major release.")
+      return blacklisted_search_session_params
+    end
     [:commit, :counter, :total, :search_id, :page, :per_page]
   end
 
+  def blacklisted_search_session_params
+    nonpersisted_search_session_params
+  end
+  Blacklight.deprecation.deprecate_methods(self, blacklisted_search_session_params: 'use nonpersisted_search_session_params instead')
+
   # calls setup_previous_document then setup_next_document.
   # used in the show action for single view pagination.
   def setup_next_and_previous_documents

data/app/controllers/concerns/blacklight/search_history.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
+
 module Blacklight
   module SearchHistory
     extend ActiveSupport::Concern
     include Blacklight::Configurable
+    include Blacklight::SearchContext
 
     included do
       copy_blacklight_config_from(CatalogController)

data/app/controllers/concerns/blacklight/searchable.rb

@@ -5,17 +5,28 @@
 # would be provided by Blacklight::Controller
 #  1. search_state
 #  2. blacklight_config
-#  3. search_service_class
 #
 # Additionally, the including class may override the search_service_context method to provide
 # further context to the SearchService. For example you could override this to provide the
 # currently signed in user.
 module Blacklight::Searchable
+  extend ActiveSupport::Concern
+
+  included do
+    # Which class to use for the search service. You can subclass SearchService if you
+    # want to override any of the methods (e.g. SearchService#fetch)
+    class_attribute :search_service_class
+    self.search_service_class = Blacklight::SearchService
+  end
+
   # @return [Blacklight::SearchService]
   def search_service
     search_service_class.new(config: blacklight_config, search_state: search_state, user_params: search_state.to_h, **search_service_context)
   end
 
+  # Override this method on the class that includes Blacklight::Searchable to provide more context to the search service if necessary.
+  # For example, if your search builder needs to be aware of the current user, override this method to return a hash including the current user.
+  # Then the search builder could use some property about the current user to construct a constraint on the search.
   # @return [Hash] a hash of context information to pass through to the search service
   def search_service_context
     {}

data/app/controllers/concerns/blacklight/token_based_user.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight::TokenBasedUser
   extend ActiveSupport::Concern
 
@@ -48,7 +49,18 @@ module Blacklight::TokenBasedUser
   end
 
   def secret_key_generator
-    @secret_key_generator ||= ActiveSupport::KeyGenerator.new(Rails.application.secret_key_base)
+    @secret_key_generator ||= begin
+      app = Rails.application
+
+      secret_key_base = if app.respond_to?(:credentials)
+                          # Rails 5.2+
+                          app.credentials.secret_key_base
+                        else
+                          # Rails <= 5.1
+                          app.secrets.secret_key_base
+                        end
+      ActiveSupport::KeyGenerator.new(secret_key_base)
+    end
   end
 
   def message_encryptor

data/app/controllers/search_history_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class SearchHistoryController < ApplicationController
   include Blacklight::SearchHistory
 end

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
+
 # Methods added to this helper will be available to all templates in the hosting application
 module Blacklight::BlacklightHelperBehavior
-  extend Deprecation
-
   include Blacklight::UrlHelperBehavior
-  include Blacklight::HashAsHiddenFieldsHelperBehavior
   include Blacklight::LayoutHelperBehavior
   include Blacklight::IconHelperBehavior
 
@@ -51,15 +49,6 @@ module Blacklight::BlacklightHelperBehavior
     document_presenter(document).link_rel_alternates(options)
   end
 
-  ##
-  # Render OpenSearch headers for this search
-  # @deprecated
-  # @return [String]
-  def render_opensearch_response_metadata
-    render partial: 'catalog/opensearch_response_metadata', locals: { response: @response }
-  end
-  deprecation_deprecate render_opensearch_response_metadata: 'Use `render "catalog/opensearch_response_metadata"\' instead'
-
   ##
   # Render classes for the <body> element
   # @return [String]
@@ -72,207 +61,17 @@ module Blacklight::BlacklightHelperBehavior
   # @see render_body_class
   # @return [Array<String>]
   def extra_body_classes
-    @extra_body_classes ||= ['blacklight-' + controller.controller_name, 'blacklight-' + [controller.controller_name, controller.action_name].join('-')]
-  end
-
-  ##
-  # Render the search navbar
-  # @return [String]
-  def render_search_bar
-    if search_bar_presenter_class == Blacklight::SearchBarPresenter && partial_from_blacklight?(Blacklight::SearchBarPresenter.partial)
-      component_class = blacklight_config&.view_config(document_index_view_type)&.search_bar_component || Blacklight::SearchBarComponent
-      render component_class.new(
-        url: search_action_url,
-        advanced_search_url: search_action_url(action: 'advanced_search'),
-        params: search_state.params_for_search.except(:qt),
-        search_fields: Deprecation.silence(Blacklight::ConfigurationHelperBehavior) { search_fields },
-        autocomplete_path: search_action_path(action: :suggest)
-      )
-    else
-      search_bar_presenter.render
-    end
-  end
-  deprecation_deprecate render_search_bar: "Call `render Blacklight::SearchBarComponent.new' instead"
-
-  # @!group Presenter extension helpers
-  ##
-  # @return [Blacklight::SearchBarPresenter]
-  def search_bar_presenter
-    @search_bar ||= search_bar_presenter_class.new(controller, blacklight_config)
-  end
-  deprecation_deprecate :search_bar_presenter
-
-  # @!group Document helpers
-  ##
-  # Determine whether to render a given field in the index view.
-  #
-  # @deprecated
-  # @param [SolrDocument] document
-  # @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
-
-  ##
-  # Determine whether to render a given field in the show view
-  #
-  # @deprecated
-  # @param [SolrDocument] document
-  # @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
-
-  ##
-  # Check if a document has (or, might have, in the case of accessor methods) a value for
-  # the given solr
-  # @deprecated
-  # @param [SolrDocument] document
-  # @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
-  end
-
-  # @!group Search result helpers
-  ##
-  # Determine whether to display spellcheck suggestions
-  #
-  # @deprecated
-  # @param [Blacklight::Solr::Response] response
-  # @return [Boolean]
-  def should_show_spellcheck_suggestions? response
-    Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
-      # The spelling response field may be missing from non solr repositories.
-      response.total <= spell_check_max &&
-        (response.spelling&.words&.any? || response.spelling&.collation&.present? || false)
-    end
-  end
-  deprecation_deprecate should_show_spellcheck_suggestions?: 'moving into a private method of Blacklight::Response::SpellcheckComponent'
-
-  # @!group Document helpers
-  ##
-  # 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
-  #
-  # @deprecated
-  # @overload render_index_field_label(options)
-  #   Use the default, document-agnostic configuration
-  #   @param [Hash] opts
-  #   @option opts [String] :field
-  # @overload render_index_field_label(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
-  # @return [String]
-  def render_index_field_label *args
-    options = args.extract_options!
-    document = args.first
-
-    field = options[:field]
-    label = Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
-      options[:label] || index_field_label(document, field)
-    end
-    html_escape t(:"blacklight.search.index.#{document_index_view_type}.label", default: :'blacklight.search.index.label', label: label)
-  end
-  deprecation_deprecate render_index_field_label: 'Use Blacklight::MetadataFieldComponent instead'
-
-  ##
-  # Render the show field label for a document
-  #
-  # @deprecated
-  # @overload render_document_show_field_label(options)
-  #   Use the default, document-agnostic configuration
-  #   @param [Hash] opts
-  #   @option opts [String] :field
-  # @overload render_document_show_field_label(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
-  # @return [String]
-  def render_document_show_field_label *args
-    options = args.extract_options!
-    document = args.first
-
-    field = options[:field]
-    label = Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
-      options[:label] || document_show_field_label(document, field)
-    end
-
-    t(:'blacklight.search.show.label', label: label)
+    @extra_body_classes ||= ["blacklight-#{controller.controller_name}", "blacklight-#{[controller.controller_name, controller.action_name].join('-')}"]
   end
-  deprecation_deprecate render_document_show_field_label: 'Use Blacklight::MetadataFieldComponent instead'
-
-  ##
-  # Get the value of the document's "title" field, or a placeholder
-  # value (if empty)
-  #
-  # @deprecated
-  # @param [SolrDocument] document
-  # @return [String]
-  def document_heading document = nil
-    document ||= @document
-    document_presenter(document).heading
-  end
-  deprecation_deprecate document_heading: 'Use Blacklight::DocumentPresenter#heading instead'
-
-  ##
-  # Get the document's "title" to display in the <title> element.
-  # (by default, use the #document_heading)
-  #
-  # @deprecated
-  # @see #document_heading
-  # @param [SolrDocument] document
-  # @return [String]
-  def document_show_html_title document = nil
-    document ||= @document
-
-    document_presenter(document).html_title
-  end
-  deprecation_deprecate document_show_html_title: 'Use Blacklight::DocumentPresenter#html_title instead'
-
-  ##
-  # Render the document "heading" (title) in a content tag
-  # @deprecated
-  # @overload render_document_heading(document, options)
-  #   @param [SolrDocument] document
-  #   @param [Hash] options
-  #   @option options [Symbol] :tag
-  # @overload render_document_heading(options)
-  #   @param [Hash] options
-  #   @option options [Symbol] :tag
-  # @return [String]
-  def render_document_heading(*args)
-    options = args.extract_options!
-    document = args.first
-    tag = options.fetch(:tag, :h4)
-    document ||= @document
-
-    content_tag(tag, document_presenter(document).heading, itemprop: "name")
-  end
-  deprecation_deprecate render_document_heading: 'Removed without replacement'
 
   ##
   # 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 respond_to?(:session)
+    view_param ||= session[:preferred_view]
     if view_param && document_index_views.key?(view_param.to_sym)
       view_param.to_sym
     else
@@ -309,101 +108,24 @@ module Blacklight::BlacklightHelperBehavior
     response&.grouped?
   end
 
-  # @!group Presenter extension helpers
-  ##
-  # Returns a document presenter for the given document
-  # TODO: Move this to the controller. It can just pass a presenter or set of presenters.
-  # @deprecated
-  # @return [Blacklight::DocumentPresenter]
-  def presenter(document)
-    Deprecation.warn(Blacklight::BlacklightHelperBehavior, '#presenter is deprecated; use #document_presenter instead')
-
-    # As long as the presenter methods haven't been overridden, we can use the new behavior
-    if method(:show_presenter).owner == Blacklight::BlacklightHelperBehavior &&
-       method(:index_presenter).owner == Blacklight::BlacklightHelperBehavior
-      return document_presenter_class(document).new(document, self)
-    end
-
-    Deprecation.warn(Blacklight::BlacklightHelperBehavior, '#show_presenter and/or #index_presenter have been overridden; please override #document_presenter instead')
-
-    Deprecation.silence(Blacklight::BlacklightHelperBehavior) do
-      case action_name
-      when 'show', 'citation'
-        show_presenter(document)
-      else
-        index_presenter(document)
-      end
-    end
-  end
-
   ##
   # Returns a document presenter for the given document
   def document_presenter(document)
-    Deprecation.silence(Blacklight::BlacklightHelperBehavior) do
-      presenter(document)
-    end
-  end
-
-  # @deprecated
-  # @return [Blacklight::ShowPresenter]
-  def show_presenter(document)
-    Deprecation.warn(Blacklight::BlacklightHelperBehavior, '#show_presenter is deprecated; use #document_presenter instead')
-
-    if method(:show_presenter_class).owner != Blacklight::BlacklightHelperBehavior
-      Deprecation.warn(Blacklight::BlacklightHelperBehavior, '#show_presenter_class has been overridden; please override #document_presenter_class instead')
-    end
-
-    Deprecation.silence(Blacklight::BlacklightHelperBehavior) do
-      show_presenter_class(document).new(document, self)
-    end
-  end
-
-  # @deprecated
-  # @return [Blacklight::IndexPresenter]
-  def index_presenter(document)
-    Deprecation.warn(Blacklight::BlacklightHelperBehavior, '#index_presenter is deprecated; use #document_presenter instead')
-
-    if method(:index_presenter_class).owner != Blacklight::BlacklightHelperBehavior
-      Deprecation.warn(Blacklight::BlacklightHelperBehavior, '#index_presenter_class has been overridden; please override #document_presenter_class instead')
-    end
-
-    Deprecation.silence(Blacklight::BlacklightHelperBehavior) do
-      index_presenter_class(document).new(document, self)
-    end
+    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)
-    Deprecation.silence(Blacklight::BlacklightHelperBehavior) do
-      case action_name
-      when 'show', 'citation'
-        show_presenter_class(document)
-      else
-        index_presenter_class(document)
-      end
+  # @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
 
-  ##
-  # Override this method if you want to use a different presenter class
-  # @deprecated
-  # @return [Class]
-  def show_presenter_class(_document)
-    Deprecation.warn(Blacklight::BlacklightHelperBehavior, '#show_presenter_class is deprecated; use #document_presenter_class instead')
-
-    blacklight_config.view_config(:show, action_name: action_name).document_presenter_class
-  end
-
-  # @deprecated
-  # @return [Class]
-  def index_presenter_class(_document)
-    Deprecation.warn(Blacklight::BlacklightHelperBehavior, '#index_presenter_class is deprecated; use #document_presenter_class instead')
-
-    blacklight_config.view_config(document_index_view_type, action_name: action_name).document_presenter_class
-  end
-
   # @return [Class]
   def search_bar_presenter_class
     blacklight_config.view_config(action_name: :index).search_bar_presenter_class
@@ -416,24 +138,4 @@ module Blacklight::BlacklightHelperBehavior
   def opensearch_description_tag title, href
     tag :link, href: href, title: title, type: "application/opensearchdescription+xml", rel: "search"
   end
-
-  # @private
-
-  def self.blacklight_path
-    @blacklight_path ||= Gem.loaded_specs["blacklight"].full_gem_path
-  end
-
-  def partial_from_blacklight?(partial)
-    path = if Rails::VERSION::MAJOR >= 6
-             name = partial.split('/').last
-             prefix = partial.split('/').first if partial.include?('/')
-             logger&.debug "Looking for document index partial #{partial}"
-             prefixes = lookup_context.prefixes + [prefix, ""].compact
-             lookup_context.find_all(name, prefixes, true).first&.identifier
-           else
-             lookup_context.find_all(partial, lookup_context.prefixes + [""], true).first&.identifier
-           end
-
-    path&.starts_with?(Blacklight::BlacklightHelperBehavior.blacklight_path)
-  end
 end