blacklight 5.19.2 → 6.0.0.pre1

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

@@ -11,7 +11,7 @@
 # [:label]
 #   "Title",  # user-displayable label, optional, if not supplied :key.titlecase will be used
 # [:qt]
-#   "search", # Solr qt param, request handler, usually can be left blank; defaults to blacklight_config[:default_solr_params][:qt] if not specified. 
+#   "search", # Solr qt param, request handler, usually can be left blank; defaults to nil if not explicitly specified
 # [:solr_parameters]
 #   {:qf => "something"} # optional hash of additional parameters to pass to solr for searches on this field.
 # [:solr_local_parameters]

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

@@ -46,59 +46,14 @@
 
 module Blacklight::SearchHelper
   extend ActiveSupport::Concern
-  extend Deprecation
-  self.deprecation_horizon = 'blacklight 6.0'
-
   include Blacklight::RequestBuilders
 
-  ##
-  # Execute a solr query
-  # @see [Blacklight::SolrRepository#send_and_receive]
-  # @return [Blacklight::Solr::Response] the solr response object
-  def find *args
-    request_params = args.extract_options!
-    path = args.first || blacklight_config.solr_path
-
-    request_params[:qt] ||= blacklight_config.qt
-
-    repository.send_and_receive path, request_params
-  end
-  deprecation_deprecate :find
-
-  # returns a params hash for finding a single solr document (CatalogController #show action)
-  def solr_doc_params(id=nil)
-    default_solr_doc_params(id)
-  end
-  deprecation_deprecate :solr_doc_params
-
-  # a solr query method
-  # given a user query, return a solr response containing both result docs and facets
-  # - mixes in the Blacklight::Solr::SpellingSuggestions module
-  #   - the response will have a spelling_suggestions method
-  # Returns a two-element array (aka duple) with first the solr response object,
-  # and second an array of SolrDocuments representing the response.docs
-  def get_search_results(user_params = params || {}, extra_controller_params = {})
-    query = search_builder.with(user_params).merge(extra_controller_params)
-    response = repository.search(query)
-
-    case
-    when (response.grouped? && grouped_key_for_results)
-      [response.group(grouped_key_for_results), []]
-    when (response.grouped? && response.grouped.length == 1)
-      [response.grouped.first, []]
-    else
-      [response, response.documents]
-    end
-  end
-  deprecation_deprecate get_search_results: :search_results
-
   # a solr query method
   # @param [Hash,HashWithIndifferentAccess] user_params ({}) the user provided parameters (e.g. query, facets, sort, etc)
-  # @param [List<Symbol] processor_chain a list of filter methods to run
   # @yield [search_builder] optional block yields configured SearchBuilder, caller can modify or create new SearchBuilder to be used. Block should return SearchBuilder to be used. 
   # @return [Blacklight::Solr::Response] the solr response object
-  def search_results(user_params, search_params_logic)
-    builder = search_builder(search_params_logic).with(user_params)
+  def search_results(user_params)
+    builder = search_builder.with(user_params)
     builder.page(user_params[:page]) if user_params[:page]
     builder.rows(user_params[:per_page] || user_params[:rows]) if user_params[:per_page] or user_params[:rows]
 
@@ -118,16 +73,6 @@ module Blacklight::SearchHelper
     end
   end
 
-  # a solr query method
-  # @param [Hash,HashWithIndifferentAccess] user_params ({}) the user provided parameters (e.g. query, facets, sort, etc)
-  # @param [Hash,HashWithIndifferentAccess] extra_controller_params ({}) extra parameters to add to the search
-  # @return [Blacklight::Solr::Response] the solr response object
-  def query_solr(user_params = params || {}, extra_controller_params = {})
-    query = search_builder.with(user_params).merge(extra_controller_params)
-    repository.search(query)
-  end
-  deprecation_deprecate :query_solr
-
   # retrieve a document, given the doc id
   # @return [Blacklight::Solr::Response, Blacklight::SolrDocument] the solr response object and the first document
   def fetch(id=nil, extra_controller_params={})
@@ -142,23 +87,6 @@ module Blacklight::SearchHelper
     end
   end
 
-  alias_method :get_solr_response_for_doc_id, :fetch
-  deprecation_deprecate get_solr_response_for_doc_id: "use fetch(id) instead"
-
-  # given a field name and array of values, get the matching SOLR documents
-  # @return [Blacklight::Solr::Response, Array<Blacklight::SolrDocument>] the solr response object and a list of solr documents
-  def get_solr_response_for_field_values(field, values, extra_controller_params = {})
-    query = Deprecation.silence(Blacklight::RequestBuilders) do
-      search_builder.with(params).merge(extra_controller_params).merge(solr_documents_by_field_values_params(field, values))
-    end
-
-    solr_response = repository.search(query)
-
-
-    [solr_response, solr_response.documents]
-  end
-  deprecation_deprecate :get_solr_response_for_field_values
-
   ##
   # Get the solr response when retrieving only a single facet field
   # @return [Blacklight::Solr::Response] the solr response
@@ -167,40 +95,6 @@ module Blacklight::SearchHelper
     repository.search(query.merge(extra_controller_params))
   end
 
-  # a solr query method
-  # used to paginate through a single facet field's values
-  # /catalog/facet/language_facet
-  def get_facet_pagination(facet_field, user_params=params || {}, extra_controller_params={})
-    # Make the solr call
-    response = get_facet_field_response(facet_field, user_params, extra_controller_params)
-
-    limit = response.params[:"f.#{facet_field}.facet.limit"].to_s.to_i - 1
-
-    # Actually create the paginator!
-    # NOTE: The sniffing of the proper sort from the solr response is not
-    # currently tested for, tricky to figure out how to test, since the
-    # default setup we test against doesn't use this feature.
-    Blacklight::Solr::FacetPaginator.new(response.aggregations[facet_field].items,
-      :offset => response.params[:"f.#{facet_field}.facet.offset"],
-      :limit => limit,
-      :sort => response.params[:"f.#{facet_field}.facet.sort"] || response.params["facet.sort"]
-    )
-  end
-  deprecation_deprecate :get_facet_pagination
-
-  # a solr query method
-  # this is used when selecting a search result: we have a query and a
-  # position in the search results and possibly some facets
-  # Pass in an index where 1 is the first document in the list, and
-  # the Blacklight app-level request params that define the search.
-  # @return [Blacklight::SolrDocument, nil] the found document or nil if not found
-  def get_single_doc_via_search(index, request_params)
-    query = search_builder.with(request_params).start(index - 1).rows(1).merge(fl: "*")
-    response = repository.search(query)
-    response.documents.first
-  end
-  deprecation_deprecate :get_single_doc_via_search
-
   # Get the previous and next document from a search result
   # @return [Blacklight::Solr::Response, Array<Blacklight::SolrDocument>] the solr response and a list of the first and last document
   def get_previous_and_next_documents_for_search(index, request_params, extra_controller_params={})
@@ -247,32 +141,16 @@ module Blacklight::SearchHelper
     @repository ||= repository_class.new(blacklight_config)
   end
 
-  def solr_repository
-    repository
-  end
-  deprecation_deprecate solr_repository: :repository
-
-  def blacklight_solr
-    repository.connection
-  end
-  deprecation_deprecate blacklight_solr: "use repository.connection instead"
-
   private
 
     ##
     # Retrieve a set of documents by id
-    # @overload fetch_many(ids, extra_controller_params)
-    # @overload fetch_many(ids, user_params, extra_controller_params)
-    def fetch_many(ids=[], *args)
-      if args.length == 1
-        Deprecation.warn(Blacklight::SearchHelper, "fetch_many with 2 arguments is deprecated")
-        user_params = params
-        extra_controller_params = args.first || {}
-      else
-        user_params, extra_controller_params = args
-        user_params ||= params
-        extra_controller_params ||= {}
-      end
+    # @param [Array] ids
+    # @param [HashWithIndifferentAccess] user_params
+    # @param [HashWithIndifferentAccess] extra_controller_params
+    def fetch_many(ids, user_params, extra_controller_params)
+      user_params ||= params
+      extra_controller_params ||= {}
 
       query = search_builder.
                 with(user_params).
@@ -284,38 +162,8 @@ module Blacklight::SearchHelper
       [solr_response, solr_response.documents]
     end
 
-    alias_method :get_solr_response_for_document_ids, :fetch_many
-    deprecation_deprecate get_solr_response_for_document_ids: "use fetch(ids) instead"
-
     def fetch_one(id, extra_controller_params)
-      old_solr_doc_params = Deprecation.silence(Blacklight::SearchHelper) do
-        solr_doc_params(id)
-      end
-
-      if default_solr_doc_params(id) != old_solr_doc_params
-        Deprecation.warn Blacklight::SearchHelper, "The #solr_doc_params method is deprecated. Instead, you should provide a custom SolrRepository implementation for the additional behavior you're offering. The current behavior will be removed in Blacklight 6.0"
-        extra_controller_params = extra_controller_params.merge(old_solr_doc_params)
-      end
-
       solr_response = repository.find id, extra_controller_params
       [solr_response, solr_response.documents.first]
     end
-
-    ##
-    # @deprecated
-    def default_solr_doc_params(id=nil)
-      id ||= params[:id]
-
-      # add our document id to the document_unique_id_param query parameter
-      p = blacklight_config.default_document_solr_params.merge({
-        # this assumes the request handler will map the unique id param
-        # to the unique key field using either solr local params, the
-        # real-time get handler, etc.
-        blacklight_config.document_unique_id_param => id
-      })
-
-      p[:qt] ||= blacklight_config.document_solr_request_handler
-
-      p
-    end
 end

data/app/controllers/saved_searches_controller.rb

@@ -42,7 +42,7 @@ class SavedSearchesController < ApplicationController
     else
       flash[:error] = I18n.t('blacklight.saved_searches.clear.failure') 
     end
-    redirect_to :action => "index"
+    redirect_to blacklight.saved_searches_url
   end
 
 

data/app/controllers/search_history_controller.rb

@@ -1,4 +1,21 @@
 # -*- encoding : utf-8 -*-
 class SearchHistoryController < ApplicationController
-  include Blacklight::SearchHistory
+  include Blacklight::Configurable
+
+  copy_blacklight_config_from(CatalogController)
+
+  def index
+    @searches = searches_from_history
+  end
+  
+  
+  #TODO we may want to remove unsaved (those without user_id) items from the database when removed from history
+  def clear
+    if session[:history].clear
+      flash[:notice] = I18n.t('blacklight.search_history.clear.success')
+    else
+      flash[:error] = I18n.t('blacklight.search_history.clear.failure') 
+    end
+    redirect_to :back
+  end
 end

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -10,13 +10,12 @@ module Blacklight::BlacklightHelperBehavior
   include RenderConstraintsHelper
   include RenderPartialsHelper
   include FacetsHelper
-  extend Deprecation
 
   ##
   # Get the name of this application, from either:
   #  - the Rails configuration
   #  - an i18n string (key: blacklight.application_name; preferred)
-  # 
+  #
   # @return [String] the application name
   def application_name
     return Rails.application.config.application_name if Rails.application.config.respond_to? :application_name
@@ -42,14 +41,14 @@ module Blacklight::BlacklightHelperBehavior
   # @params [Hash] options
   # @option options [Boolean] :unique ensures only one link is output for every
   #     content type, e.g. as required by atom
-  # @option options [Array<String>] :exclude array of format shortnames to not include in the output 
+  # @option options [Array<String>] :exclude array of format shortnames to not include in the output
   def render_link_rel_alternates(document=@document, options = {})
     return if document.nil?
     presenter(document).link_rel_alternates(options)
   end
 
   ##
-  # Render OpenSearch headers for this search 
+  # Render OpenSearch headers for this search
   # @return [String]
   def render_opensearch_response_metadata
     render :partial => 'catalog/opensearch_response_metadata'
@@ -79,7 +78,7 @@ module Blacklight::BlacklightHelperBehavior
 
   ##
   # Determine whether to render a given field in the index view.
-  #  
+  #
   # @param [SolrDocument] document
   # @param [Blacklight::Solr::Configuration::Field] field_config
   # @return [Boolean]
@@ -96,7 +95,7 @@ module Blacklight::BlacklightHelperBehavior
   def should_render_show_field? document, field_config
     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 field
@@ -130,7 +129,7 @@ module Blacklight::BlacklightHelperBehavior
   #   may drive the value of the field
   #   @param [SolrDocument] doc
   #   @param [Hash] opts
-  #   @options opts [String] :field    
+  #   @options opts [String] :field
   def render_index_field_label *args
     options = args.extract_options!
     document = args.first
@@ -153,7 +152,7 @@ module Blacklight::BlacklightHelperBehavior
   #   may drive the value of the field
   #   @param [SolrDocument] doc
   #   @param [Hash] opts
-  #   @options opts [String] :field 
+  #   @options opts [String] :field
   #   @options opts [String] :value
   # @overload render_index_field_value(document, field, options)
   #   Allow an extention point where information in the document
@@ -182,7 +181,7 @@ module Blacklight::BlacklightHelperBehavior
   #   may drive the value of the field
   #   @param [SolrDocument] doc
   #   @param [Hash] opts
-  #   @options opts [String] :field   
+  #   @options opts [String] :field
   def render_document_show_field_label *args
     options = args.extract_options!
     document = args.first
@@ -206,7 +205,7 @@ module Blacklight::BlacklightHelperBehavior
   #   may drive the value of the field
   #   @param [SolrDocument] doc
   #   @param [Hash] opts
-  #   @options opts [String] :field 
+  #   @options opts [String] :field
   #   @options opts [String] :value
   # @overload render_document_show_field_value(document, field, options)
   #   Allow an extention point where information in the document
@@ -249,8 +248,6 @@ module Blacklight::BlacklightHelperBehavior
 
   ##
   # Render the document "heading" (title) in a content tag
-  # @overload render_document_heading(tag)
-  #   @params [Symbol] tag
   # @overload render_document_heading(document, options)
   #   @params [SolrDocument] document
   #   @params [Hash] options
@@ -260,17 +257,9 @@ module Blacklight::BlacklightHelperBehavior
   #   @options options [Symbol] :tag
   def render_document_heading(*args)
     options = args.extract_options!
-
-    tag_or_document = args.first
-
-    if tag_or_document.is_a? String or tag_or_document.is_a? Symbol
-      Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#render_document_heading with a tag argument is deprecated; pass e.g. `tag: :h4` instead")
-      tag = tag_or_document
-      document = @document
-    else
-      tag = options.fetch(:tag, :h4)
-      document = tag_or_document || @document
-    end
+    document = args.first
+    tag = options.fetch(:tag, :h4)
+    document = document || @document
 
     content_tag(tag, presenter(document).document_heading, itemprop: "name")
   end
@@ -284,7 +273,7 @@ module Blacklight::BlacklightHelperBehavior
   # Rendering:
   #   - helper_method
   #   - link_to_search
-  # TODO : maybe this should be merged with render_field_value, and the ugly signature 
+  # TODO : maybe this should be merged with render_field_value, and the ugly signature
   # simplified by pushing some of this logic into the "model"
   # @param [SolrDocument] document
   # @param [String] field name
@@ -294,36 +283,9 @@ module Blacklight::BlacklightHelperBehavior
     presenter(document).get_field_values field, field_config, options
   end
 
-  ##
-  # Render a value (or array of values) from a field
-  #
-  # @deprecated Use DocumentPresenter instead
-  # @param [String] value or list of values to display
-  # @param [Blacklight::Solr::Configuration::Field] solr field configuration
-  # @return [String]
-  def render_field_value value=nil, field_config=nil
-    safe_values = Array(value).collect { |x| x.respond_to?(:force_encoding) ? x.force_encoding("UTF-8") : x }
-
-    if field_config and field_config.itemprop
-      safe_values = safe_values.map { |x| content_tag :span, x, :itemprop => field_config.itemprop }
-    end
-
-    safe_join(safe_values, (field_config.separator if field_config) || field_value_separator)
-  end
-  deprecation_deprecate render_field_value: "use DocumentPresenter.render_field_value instead"
-
-  ##
-  # Default separator to use in #render_field_value
-  #
-  # @return [String]
-  def field_value_separator
-    ', '
-  end
-  deprecation_deprecate field_value_separator: "use DocumentPresenter.field_value_separator instead"
-
   ##
   # Get the current "view type" (and ensure it is a valid type)
-  # 
+  #
   # @param [Hash] the query parameters to check
   # @return [Symbol]
   def document_index_view_type query_params=params
@@ -336,24 +298,6 @@ module Blacklight::BlacklightHelperBehavior
     end
   end
 
-  ##
-  # Render the document index heading
-  #
-  # @param [SolrDocument] doc
-  # @param [Hash] opts (deprecated)
-  # @option opts [Symbol] :label Render the given field from the document
-  # @option opts [Proc] :label Evaluate the given proc
-  # @option opts [String] :label Render the given string
-  # @param [Symbol, Proc, String] field Render the given field or evaluate the proc or render the given string
-  def render_document_index_label doc, field, opts = {}
-    if field.is_a? Hash
-      Deprecation.warn self, "Calling render_document_index_label with a hash is deprecated"
-      field = field[:label]
-    end
-    presenter(doc).render_document_index_label field, opts
-  end
-  deprecation_deprecate render_document_index_label: "use presenter(doc).render_document_index_label instead"
-
   ##
   # Render a partial of an arbitrary format inside a
   # template of a different format. (e.g. render an HTML
@@ -372,24 +316,12 @@ module Blacklight::BlacklightHelperBehavior
   end
 
   ##
-  # Should we render a grouped response (because the response 
-  # contains a grouped response instead of the normal response) 
+  # Should we render a grouped response (because the response
+  # contains a grouped response instead of the normal response)
   def render_grouped_response? response = @response
     return response.grouped?
   end
 
-  ##
-  # Determine whether to render the bookmarks control 
-  def render_bookmarks_control?
-    has_user_authentication_provider? and current_or_guest_user.present?
-  end
-
-  ##
-  # Determine whether to render the saved searches link
-  def render_saved_searches?
-    has_user_authentication_provider? and current_user
-  end
-
   ##
   # Returns a document presenter for the given document
   def presenter(document)
@@ -401,7 +333,7 @@ module Blacklight::BlacklightHelperBehavior
   def presenter_class
     blacklight_config.document_presenter_class
   end
-  
+
   ##
   # Open Search discovery tag for HTML <head> links
   def opensearch_description_tag title, href