blacklight 6.14.0 → 7.0.0

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

@@ -3,34 +3,39 @@
 # as this module is mixed-in to the application controller in the hosting app on installation.
 module Blacklight::Controller
   extend ActiveSupport::Concern
-  extend Deprecation
-  self.deprecation_horizon = 'blacklight 7.x'
 
   included do
     include Blacklight::SearchFields
-    helper Blacklight::SearchFields
+    helper Blacklight::SearchFields if respond_to? :helper
 
     include ActiveSupport::Callbacks
 
     # now in application.rb file under config.filter_parameters
     # filter_parameter_logging :password, :password_confirmation
-    helper_method :current_user_session, :current_user, :current_or_guest_user
-    after_action :discard_flash_if_xhr
 
     # handle basic authorization exception with #access_denied
-    rescue_from Blacklight::Exceptions::AccessDenied, :with => :access_denied
+    rescue_from Blacklight::Exceptions::AccessDenied, with: :access_denied
 
-    # extra head content
-    helper_method :has_user_authentication_provider?
-    helper_method :blacklight_config, :blacklight_configuration_context
-    helper_method :search_action_url, :search_action_path, :search_facet_url, :search_facet_path
-    helper_method :search_state
+    if respond_to? :helper_method
+      helper_method :current_user_session, :current_user, :current_or_guest_user
 
-    # Specify which class to use for the search state. You can subclass SearchState if you
+      # extra head content
+      helper_method :has_user_authentication_provider?
+      helper_method :blacklight_config, :blacklight_configuration_context
+      helper_method :search_action_url, :search_action_path, :search_facet_path
+      helper_method :search_state
+    end
+
+    # Which class to use for the search state. You can subclass SearchState if you
     # want to override any of the methods (e.g. SearchState#url_for_document)
     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)
+    class_attribute :search_service_class
+    self.search_service_class = Blacklight::SearchService
+
     # This callback runs when a user first logs in
 
     define_callbacks :logging_in_user
@@ -43,140 +48,120 @@ module Blacklight::Controller
 
   delegate :blacklight_config, to: :default_catalog_controller
 
-    protected
+  private
 
-    ##
-    # Context in which to evaluate blacklight configuration conditionals
-    def blacklight_configuration_context
-      @blacklight_configuration_context ||= Blacklight::Configuration::Context.new(self)
-    end
+  ##
+  # Context in which to evaluate blacklight configuration conditionals
+  def blacklight_configuration_context
+    @blacklight_configuration_context ||= Blacklight::Configuration::Context.new(self)
+  end
 
-    ##
-    # Determine whether to render the bookmarks control
-    # (Needs to be available globally, as it is used in the navbar)
-    def render_bookmarks_control?
-      has_user_authentication_provider? and current_or_guest_user.present?
-    end
+  ##
+  # Determine whether to render the bookmarks control
+  # (Needs to be available globally, as it is used in the navbar)
+  def render_bookmarks_control?
+    has_user_authentication_provider? && current_or_guest_user.present?
+  end
 
-    ##
-    # Determine whether to render the saved searches link
-    # (Needs to be available globally, as it is used in the navbar)
-    def render_saved_searches?
-      has_user_authentication_provider? and current_user
-    end
+  # @return [Blacklight::SearchState] a memoized instance of the parameter state.
+  def search_state
+    @search_state ||= search_state_class.new(params, blacklight_config, self)
+  end
 
-    # @return [Blacklight::SearchState] a memoized instance of the parameter state.
-    def search_state
-      @search_state ||= begin
-        if search_state_class.instance_method(:initialize).arity == -3
-          search_state_class.new(params, blacklight_config, self)
-        else
-          Deprecation.warn(search_state_class, "The constructor for #{search_state_class} now requires a third argument. " \
-            "Invoking it will 2 arguments is deprecated and will be removed in Blacklight 7.")
-          search_state_class.new(params, blacklight_config)
-        end
-      end
-    end
+  # Default route to the search action (used e.g. in global partials). Override this method
+  # in a controller or in your ApplicationController to introduce custom logic for choosing
+  # 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))
+  end
 
-    # Default route to the search action (used e.g. in global partials). Override this method
-    # in a controller or in your ApplicationController to introduce custom logic for choosing
-    # 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))
+  def search_action_path *args
+    if args.first.is_a? Hash
+      args.first[:only_path] = true if args.first[:only_path].nil?
     end
 
-    def search_action_path *args
-      if args.first.is_a? Hash
-        args.first[:only_path] = true
-      end
+    search_action_url(*args)
+  end
 
-      search_action_url(*args)
-    end
+  def search_facet_path(options = {})
+    opts = search_state
+           .to_h
+           .merge(action: "facet", only_path: true)
+           .merge(options)
+           .except(:page)
+    url_for opts
+  end
 
-    def search_facet_url options = {}
-      opts = search_state.to_h.merge(action: "facet").merge(options).except(:page)
-      url_for opts
-    end
-    deprecation_deprecate search_facet_url: 'Use search_facet_path instead.'
+  # 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
 
-    def search_facet_path(options = {})
-      Deprecation.silence(Blacklight::Controller) do
-        search_facet_url(options.merge(only_path: true))
-      end
+  # Should be provided by authentication provider
+  # def current_user
+  # end
+  # def current_or_guest_user
+  # end
+
+  # Here's a stub implementation we'll add if it isn't provided for us
+  def current_or_guest_user
+    if defined? super
+      super
+    elsif has_user_authentication_provider?
+      current_user
     end
+  end
+  alias blacklight_current_or_guest_user current_or_guest_user
 
-    # 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
+  ##
+  #
+  #
+  def has_user_authentication_provider?
+    respond_to? :current_user
+  end
 
-    # Should be provided by authentication provider
-    # def current_user
-    # end
-    # def current_or_guest_user
-    # end
-
-    # Here's a stub implementation we'll add if it isn't provided for us
-    def current_or_guest_user
-      if defined? super
-        super
-      elsif has_user_authentication_provider?
-        current_user
-      end
-    end
-    alias blacklight_current_or_guest_user current_or_guest_user
+  def require_user_authentication_provider
+    raise ActionController::RoutingError, 'Not Found' unless has_user_authentication_provider?
+  end
 
-    ##
-    # We discard flash messages generated by the xhr requests to avoid
-    # confusing UX.
-    def discard_flash_if_xhr
-      flash.discard if request.xhr?
-    end
+  ##
+  # When a user logs in, transfer any saved searches or bookmarks to the current_user
+  def transfer_guest_user_actions_to_current_user
+    return unless respond_to?(:current_user) && respond_to?(:guest_user) && current_user && guest_user
 
-    ##
-    #
-    #
-    def has_user_authentication_provider?
-      respond_to? :current_user
-    end
+    current_user_searches = current_user.searches.pluck(:query_params)
+    current_user_bookmarks = current_user.bookmarks.pluck(:document_id)
 
-    def require_user_authentication_provider
-      raise ActionController::RoutingError, 'Not Found' unless has_user_authentication_provider?
+    guest_user.searches.reject { |s| current_user_searches.include?(s.query_params) }.each do |s|
+      current_user.searches << s
+      s.save!
     end
 
-    ##
-    # When a user logs in, transfer any saved searches or bookmarks to the current_user
-    def transfer_guest_user_actions_to_current_user
-      return unless respond_to? :current_user and respond_to? :guest_user and current_user and guest_user
-      current_user_searches = current_user.searches.pluck(:query_params)
-      current_user_bookmarks = current_user.bookmarks.pluck(:document_id)
-
-      guest_user.searches.reject { |s| current_user_searches.include?(s.query_params)}.each do |s|
-        current_user.searches << s
-        s.save!
-      end
-
-      guest_user.bookmarks.reject { |b| current_user_bookmarks.include?(b.document_id)}.each do |b|
-        current_user.bookmarks << b
-        b.save!
-      end
-
-      # let guest_user know we've moved some bookmarks from under it
-      guest_user.reload if guest_user.persisted?
+    guest_user.bookmarks.reject { |b| current_user_bookmarks.include?(b.document_id) }.each do |b|
+      current_user.bookmarks << b
+      b.save!
     end
 
-    ##
-    # To handle failed authorization attempts, redirect the user to the
-    # login form and persist the current request uri as a parameter
-    def access_denied
-      # send the user home if the access was previously denied by the same
-      # request to avoid sending the user back to the login page
-      #   (e.g. protected page -> logout -> returned to protected page -> home)
-      redirect_to root_url and flash.discard and return if request.referer and request.referer.ends_with? request.fullpath
+    # let guest_user know we've moved some bookmarks from under it
+    guest_user.reload if guest_user.persisted?
+  end
+
+  ##
+  # To handle failed authorization attempts, redirect the user to the
+  # login form and persist the current request uri as a parameter
+  def access_denied
+    # send the user home if the access was previously denied by the same
+    # request to avoid sending the user back to the login page
+    #   (e.g. protected page -> logout -> returned to protected page -> home)
+    redirect_to(root_url) && flash.discard && return if request.referer && request.referer.ends_with?(request.fullpath)
 
-      redirect_to root_url and return unless has_user_authentication_provider?
+    redirect_to(root_url) && return unless has_user_authentication_provider?
 
-      redirect_to new_user_session_url(:referer => request.fullpath)
-    end
+    redirect_to new_user_session_url(referer: request.fullpath)
+  end
+
+  def determine_layout
+    'blacklight'
+  end
 end

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

@@ -4,6 +4,9 @@ module Blacklight
     extend ActiveSupport::Concern
 
     included do
+      Deprecation.warn(self, "Blacklight::DefaultComponentConfiguration is deprecated and will be removed in the next release." \
+                             "this means you must call add_results_document_tool, add_results_collection_tool, " \
+                             "add_show_tools_partial and add_nav_action manually in your config")
       add_results_document_tool(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
 
       add_results_collection_tool(:sort_widget)
@@ -16,14 +19,9 @@ module Blacklight
       add_show_tools_partial(:citation)
 
       add_nav_action(:bookmark, partial: 'blacklight/nav/bookmark', if: :render_bookmarks_control?)
-      add_nav_action(:saved_searches, partial: 'blacklight/nav/saved_searches', if: :render_saved_searches?)
       add_nav_action(:search_history, partial: 'blacklight/nav/search_history')
     end
 
-    def render_sms_action?(_config, _options)
-      sms_mappings.present?
-    end
-
     module ClassMethods
       # YARD will include inline disabling as docs, cannot do multiline inside @!macro.  AND this must be separate from doc block.
       # rubocop:disable Metrics/LineLength
@@ -41,55 +39,26 @@ module Blacklight
       # @option opts [Symbol]  :callback method for further processing of documents, receives Array of documents
       def add_show_tools_partial(name, opts = {})
         blacklight_config.add_show_tools_partial(name, opts)
-
-        return if method_defined?(name) || opts[:define_method] == false
-
-        # Define a simple action handler for the tool
-        define_method name do
-          @response, @documents = action_documents
-
-          if request.post? && opts[:callback] &&
-            (opts[:validator].blank? || self.send(opts[:validator]))
-
-            self.send(opts[:callback], @documents)
-
-            flash[:success] ||= I18n.t("blacklight.#{name}.success", default: nil)
-
-            respond_to do |format|
-              format.html do
-                return render "#{name}_success", layout: false if request.xhr?
-                redirect_to action_success_redirect_path
-              end
-            end
-          else
-            respond_to do |format|
-              format.html do
-                return render layout: false if request.xhr?
-                # Otherwise draw the full page
-              end
-            end
-          end
-        end
+        ActionBuilder.new(self, name, opts).build
       end
       # rubocop:enable Metrics/LineLength
 
+      deprecation_deprecate add_show_tools_partial: 'use blacklight_config.add_show_tools_partial instead'
+
       # Add a tool to be displayed for each document in the search results.
       # @!macro partial_if_unless
-      def add_results_document_tool(name, opts = {})
-        blacklight_config.add_results_document_tool(name, opts)
-      end
+      delegate :add_results_document_tool, to: :blacklight_config
+      deprecation_deprecate add_results_document_tool: 'use blacklight_config.add_results_document_tool instead'
 
       # Add a tool to be displayed for the list of search results themselves.
       # @!macro partial_if_unless
-      def add_results_collection_tool(name, opts = {})
-        blacklight_config.add_results_collection_tool(name, opts)
-      end
+      delegate :add_results_collection_tool, to: :blacklight_config
+      deprecation_deprecate add_results_collection_tool: 'use blacklight_config.add_results_collection_tool instead'
 
       # Add a partial to the header navbar.
       # @!macro partial_if_unless
-      def add_nav_action(name, opts = {})
-        blacklight_config.add_nav_action(name, opts)
-      end
+      delegate :add_nav_action, to: :blacklight_config
+      deprecation_deprecate add_nav_action: 'use blacklight_config.add_nav_action instead'
     end
   end
 end

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

@@ -16,10 +16,13 @@ module Blacklight
       )
     end
 
+    # @param fields [Array<String>] a list of facet field names
+    # @return [Array<Solr::Response::Facets::FacetField>]
     def facets_from_request(fields = facet_field_names)
       fields.map { |field| facet_by_field_name(field) }.compact
     end
 
+    # @return [Array<String>] a list of the facet field names from the configuration
     def facet_field_names
       blacklight_config.facet_fields.values.map(&:field)
     end

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

@@ -2,20 +2,22 @@
 module Blacklight::SearchContext
   extend ActiveSupport::Concern
 
-  # The following code is executed when someone includes blacklight::catalog::search_session in their
+  # The following code is executed when someone includes Blacklight::Catalog::SearchSession in their
   # own controller.
-  included do  
-    helper_method :current_search_session, :search_session
+  included do
+    if respond_to? :helper_method
+      helper_method :current_search_session, :search_session
+    end
   end
 
   module ClassMethods
     # Save the submitted search parameters in the search session
-    def record_search_parameters opts = { only: :index}
+    def record_search_parameters opts = { only: :index }
       before_action :set_current_search_session, opts
     end
   end
 
-  protected
+  private
 
   # sets up the session[:search] hash if it doesn't already exist
   def search_session
@@ -72,17 +74,18 @@ module Blacklight::SearchContext
   def agent_is_crawler?
     crawler_proc = blacklight_config.crawler_detector
     return false if crawler_proc.nil? || current_user.present?
+
     crawler_proc.call(request)
   end
 
   def find_or_initialize_search_session_from_params params
-    params_copy = params.reject { |k,v| blacklisted_search_session_params.include?(k.to_sym) or v.blank? }
+    params_copy = params.reject { |k, v| blacklisted_search_session_params.include?(k.to_sym) || v.blank? }
 
-    return if params_copy.reject { |k,v| [:action, :controller].include? k.to_sym }.blank?
+    return if params_copy.reject { |k, _v| [:action, :controller].include? k.to_sym }.blank?
 
     saved_search = searches_from_history.find { |x| x.query_params == params_copy }
 
-    saved_search ||= Search.create(query_params: params_copy).tap do |s|
+    saved_search || Search.create(query_params: params_copy).tap do |s|
       add_to_search_history(s)
     end
   end
@@ -94,7 +97,7 @@ module Blacklight::SearchContext
     session[:history].unshift(search.id)
 
     if session[:history].length > blacklight_config.search_history_window
-      session[:history] = session[:history].slice(0, blacklight_config.search_history_window )
+      session[:history] = session[:history].slice(0, blacklight_config.search_history_window)
     end
   end
 
@@ -106,16 +109,15 @@ module Blacklight::SearchContext
   # calls setup_previous_document then setup_next_document.
   # used in the show action for single view pagination.
   def setup_next_and_previous_documents
-    if search_session['counter'] and current_search_session
+    if search_session['counter'] && current_search_session
       index = search_session['counter'].to_i - 1
-      response, documents = get_previous_and_next_documents_for_search index, search_state.reset(current_search_session.query_params).to_hash
+      response, documents = search_service.previous_and_next_documents_for_search index, search_state.reset(current_search_session.query_params).to_hash
 
       search_session['total'] = response.total
-      @search_context_response = response
-      @previous_document = documents.first
-      @next_document = documents.last
+      { prev: documents.first, next: documents.last }
     end
   rescue Blacklight::Exceptions::InvalidRequest => e
     logger.warn "Unable to setup next and previous documents: #{e}"
+    nil
   end
 end

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

@@ -7,7 +7,7 @@
 #
 # = Search Field blacklight_configuration Hash =
 # [:key]
-#   "title", required, unique key used in search URLs to specify search_field 
+#   "title", required, unique key used in search URLs to specify search_field
 # [:label]
 #   "Title",  # user-displayable label, optional, if not supplied :key.titlecase will be used
 # [:qt]
@@ -18,30 +18,20 @@
 #   { :qf => "$something" } # optional hash of additional parameters that will be passed using Solr LocalParams syntax, that can use dollar sign to reference other solr variables.
 # [:include_in_simple_select]
 #   false.  Defaults to true, but you can set to false to have a search field defined for deep-links or BL extensions, but not actually included in the HTML select for simple search choice.
-# 
+#
 # Optionally you can supply a :key, which is what Blacklight will use
 # to identify this search field in HTTP query params. If no :key is
 # supplied, one will be computed from the :label. If that will
-# result in a collision of keys, you should supply one explicitly. 
+# result in a collision of keys, you should supply one explicitly.
 #
 ##
 module Blacklight::SearchFields
-  extend Deprecation
-  self.deprecation_horizon = 'blacklight 7.x'
-
   # Looks up search field config list from blacklight_config[:search_fields], and
-  # 'normalizes' all field config hashes using normalize_config method. 
+  # 'normalizes' all field config hashes using normalize_config method.
   def search_field_list
     blacklight_config.search_fields.values
   end
 
-  # Looks up a search field blacklight_config hash from search_field_list having
-  # a certain supplied :key. 
-  def search_field_def_for_key(key)
-    blacklight_config.search_fields[key]
-  end
-  deprecation_deprecate search_field_def_for_key: "Use blacklight_config.search_fields[key]"
-
   # Returns default search field, used for simpler display in history, etc.
   # if not set in blacklight_config, defaults to first field listed in #search_field_list
   def default_search_field

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

@@ -21,12 +21,7 @@ module Blacklight
         flash[:error] = I18n.t('blacklight.search_history.clear.failure')
       end
 
-      if respond_to? :redirect_back
-        redirect_back fallback_location: blacklight.search_history_path
-      else
-        # Deprecated in Rails 5.0
-        redirect_to :back
-      end
+      redirect_back fallback_location: blacklight.search_history_path
     end
   end
 end

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

@@ -3,14 +3,16 @@ module Blacklight::TokenBasedUser
   extend ActiveSupport::Concern
 
   included do
-    helper_method :encrypt_user_id
+    if respond_to? :helper_method
+      helper_method :encrypt_user_id
+    end
 
     rescue_from Blacklight::Exceptions::ExpiredSessionToken do
       head :unauthorized
     end
   end
 
-  protected
+  private
 
   def token_or_current_or_guest_user
     token_user || current_or_guest_user
@@ -18,9 +20,9 @@ module Blacklight::TokenBasedUser
 
   def token_user
     @token_user ||= if params[:encrypted_user_id]
-      user_id = decrypt_user_id params[:encrypted_user_id]
-      User.find(user_id)
-    end
+                      user_id = decrypt_user_id params[:encrypted_user_id]
+                      User.find(user_id)
+                    end
   end
 
   # Used for #export action, with encrypted user_id.
@@ -42,21 +44,34 @@ module Blacklight::TokenBasedUser
   end
 
   def export_secret_token
-    ActiveSupport::KeyGenerator.new(Rails.application.secrets.secret_key_base).generate_key('encrypted user session key')[0..(key_len - 1)]
+    secret_key_generator.generate_key('encrypted user session key')[0..(key_len - 1)]
+  end
+
+  def secret_key_generator
+    @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
     ActiveSupport::MessageEncryptor.new(export_secret_token)
   end
 
-  private
-
   # Ruby 2.4 requires keys of very particular lengths
   def key_len
     if ActiveSupport::MessageEncryptor.respond_to? :key_len
       ActiveSupport::MessageEncryptor.key_len
     else
-     0
+      0
     end
   end
 end