blacklight 4.4.2 → 4.5.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20820db95c02b75fc8e604045248607f45d085bc
-  data.tar.gz: 6992b7d81e5792a425cd8018d63a50b03c38dae0
+  metadata.gz: 8939b4f8da0fd45881552613dba681ddcec93083
+  data.tar.gz: 6207de54f96ee4794e2c051f0086691575d4fea4
 SHA512:
-  metadata.gz: 78fc07fc10e18251ac027e93034e78c85449cda541953fd9a041bc0e7977139f8da349efe311da67b5032931a875e8dba74a972f1603f5bc11a1e04cd4e4423d
-  data.tar.gz: edb93872a34964b0381753e4c2ba25d0feb7ec5cd1bccdb24515a1fb71729b15edab4d673a3af1ee693ba7081efee1602535b1173f711dcfd7c4046cf78bf230
+  metadata.gz: 146016cf9d6b18fd08741e700a1be242d25adc78d83a8a299dbad03443a7b0f8c83d852e1f88b447442e24bd2dfd8cf92abdf47e323c7d26dfbae7d6950c70b4
+  data.tar.gz: 10b7fe255b81f6e4effdb5d2199478c4c8c2b8f702f0e21661ea2130fb3eea7714cacee66dc9ab4a58c808d934dadd307c2fcc521b1f038087372e0bcdbd1681

data/Gemfile

@@ -11,6 +11,7 @@ group :test do
   gem 'devise-guests'
   gem "bootstrap-sass"
   gem 'turbolinks'
+  gem 'poltergeist'
   gem "unicode", :platforms => [:mri_18, :mri_19]
 end
 

data/VERSION

@@ -1 +1 @@
-4.4.2
+4.5.0.rc1

data/app/assets/javascripts/blacklight/search_context.js

@@ -9,6 +9,8 @@
       if(event.metaKey || event.ctrlKey){f.target = '_blank';};
       var d = document.createElement('input'); d.setAttribute('type', 'hidden'); 
       d.setAttribute('name', 'counter'); d.setAttribute('value', $(this).data('counter')); f.appendChild(d);
+      var id = document.createElement('input'); id.setAttribute('type', 'hidden');
+      id.setAttribute('name', 'search_id'); id.setAttribute('value', $(this).data('search_id')); f.appendChild(id);
       var m = document.createElement('input'); m.setAttribute('type', 'hidden'); 
       m.setAttribute('name', '_method'); m.setAttribute('value', 'put'); f.appendChild(m);
       var m = document.createElement('input'); m.setAttribute('type', 'hidden'); 

data/app/controllers/saved_searches_controller.rb

@@ -11,7 +11,7 @@ class SavedSearchesController < ApplicationController
   end
   
   def save    
-    current_user.searches << Search.find(params[:id])
+    current_user.searches << searches_from_history.find(params[:id])
     if current_user.save
       flash[:notice] = I18n.t('blacklight.saved_searches.add.success')
     else
@@ -23,8 +23,7 @@ class SavedSearchesController < ApplicationController
   # Only dereferences the user rather than removing the item in case it
   # is in the session[:history]
   def forget
-    if current_user.search_ids.include?(params[:id].to_i) 
-      search = Search.find(params[:id])
+    if search = current_user.searches.find(params[:id])
       search.user_id = nil
       search.save
 

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -74,10 +74,6 @@ module Blacklight::BlacklightHelperBehavior
     render :partial=>'catalog/search_form'
   end
 
-  def search_action_url *args
-    catalog_index_url *args
-  end
-
   def extra_body_classes
     @extra_body_classes ||= ['blacklight-' + controller.controller_name, 'blacklight-' + [controller.controller_name, controller.action_name].join('-')]
   end
@@ -480,15 +476,17 @@ module Blacklight::BlacklightHelperBehavior
   def link_to_document(doc, opts={:label=>nil, :counter => nil})
     opts[:label] ||= blacklight_config.index.show_link.to_sym
     label = render_document_index_label doc, opts
-    link_to label, doc, { :'data-counter' => opts[:counter] }.merge(opts.reject { |k,v| [:label, :counter].include? k  })
+    link_to label, doc, search_session_params(opts[:counter]).merge(opts.reject { |k,v| [:label, :counter].include? k  })
+  end
+
+  def search_session_params counter
+    { :'data-counter' => counter, :'data-search_id' => current_search_session.try(:id) }
   end
 
   # link_back_to_catalog(:label=>'Back to Search')
   # Create a link back to the index screen, keeping the user's facet, query and paging choices intact by using session.
   def link_back_to_catalog(opts={:label=>nil})
-    query_params = session[:search] ? session[:search].dup : {}
-    query_params.delete :counter
-    query_params.delete :total
+    query_params = current_search_session.try(:query_params) || {}
     link_url = url_for(query_params)
     if link_url =~ /bookmarks/
       opts[:label] ||= t('blacklight.back_to_bookmarks')
@@ -563,16 +561,14 @@ module Blacklight::BlacklightHelperBehavior
     return hash_as_hidden_fields(my_params)
   end
 
-
-
   def link_to_previous_document(previous_document)
-    link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), previous_document, :class => "previous", :rel => 'prev', :'data-counter' => session[:search][:counter].to_i - 1 do
+    link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), previous_document, search_session_params(search_session[:counter].to_i - 1).merge(:class => "previous", :rel => 'prev')  do
       content_tag :span, raw(t('views.pagination.previous')), :class => 'previous'
     end
   end
 
   def link_to_next_document(next_document)
-    link_to_unless next_document.nil?, raw(t('views.pagination.next')), next_document, :class => "next", :rel => 'next', :'data-counter' => session[:search][:counter].to_i + 1 do
+    link_to_unless next_document.nil?, raw(t('views.pagination.next')), next_document, search_session_params(search_session[:counter].to_i + 1).merge(:class => "next", :rel => 'next') do
       content_tag :span, raw(t('views.pagination.next')), :class => 'next'
     end
   end

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -56,7 +56,7 @@ module Blacklight::CatalogHelperBehavior
   # Code should call this method rather than interrogating session directly,
   # because implementation of where this data is stored/retrieved may change.
   def item_page_entry_info
-    t('blacklight.search.entry_pagination_info.other', :current => format_num(session[:search][:counter]), :total => format_num(session[:search][:total]), :count => session[:search][:total].to_i).html_safe
+    t('blacklight.search.entry_pagination_info.other', :current => format_num(search_session[:counter]), :total => format_num(search_session[:total]), :count => search_session[:total].to_i).html_safe
   end
 
   # Look up search field user-displayable label
@@ -129,4 +129,7 @@ module Blacklight::CatalogHelperBehavior
     add_facet_params_and_redirect(group.field, group.key)
   end
 
+  def response_has_no_search_results?
+    @response.total == 0 
+  end
 end

data/app/models/search.rb

@@ -1,11 +1,16 @@
 # -*- encoding : utf-8 -*-
 class Search < ActiveRecord::Base
-  
+
   belongs_to :user
-  
+
   serialize :query_params
-  attr_accessible :query_params if Rails::VERSION::MAJOR < 4
+
+  if Rails::VERSION::MAJOR < 4
+    attr_accessible :query_params 
   
+    scope :none, where(:id => nil).where("id IS NOT ?", nil)
+  end
+
   # A Search instance is considered a saved search if it has a user_id.
   def saved?
     self.user_id?

data/app/views/catalog/_facets.html.erb

@@ -16,4 +16,4 @@
   <%= render_facet_partials %>
 </div>
 </div>
-<% end %>&nbsp;
+<% end %>

data/app/views/catalog/_search_sidebar.html.erb

@@ -0,0 +1 @@
+<%= render 'facets' %>

data/app/views/catalog/_zero_results.html.erb

@@ -0,0 +1,14 @@
+<h2><%= t 'blacklight.search.zero_results.title' %></h2>
+<div id="documents" class="noresults">
+  <h3><%= t 'blacklight.search.zero_results.modify_search' %></h3>
+  <ul>
+    <li><%= t 'blacklight.search.zero_results.use_fewer_keywords' %></li>
+
+    <%- if params[:q] and params[:search_field] and params[:search_field] != blacklight_config.default_search_field -%>
+      <li><%= t 'blacklight.search.zero_results.search_fields', :search_fields => search_field_label(params) %> - 
+      <%= link_to t('blacklight.search.zero_results.search_everything'), url_for(params_for_search(:search_field=>blacklight_config.default_search_field.key)) %>
+      </li>
+    <%- end %>
+
+  </ul>
+</div>

data/app/views/catalog/index.atom.builder

@@ -45,7 +45,7 @@ xml.feed("xmlns" => "http://www.w3.org/2005/Atom",
   # updated is required, for now we'll just set it to now, sorry
   xml.updated Time.now.strftime("%Y-%m-%dT%H:%M:%SZ")
   
-  @document_list.each do |doc|
+  @document_list.each_with_index do |doc, document_counter|
     xml.entry do
       xml.title   doc.to_semantic_values[:title][0] || doc.id
 
@@ -66,7 +66,9 @@ xml.feed("xmlns" => "http://www.w3.org/2005/Atom",
       
       with_format("html") do
         xml.summary "type" => "html" do
-	            xml.text! render_document_partial(doc, :index)           
+          xml.text! render_document_partial(doc,
+                                            :index,
+                                            :document_counter => document_counter)
         end
       end
       

data/app/views/catalog/index.html.erb

@@ -1,6 +1,6 @@
 <div id="sidebar" class="span3">
- <%= render :partial=>'facets' %>
-</div><!--/well -->
+ <%= render 'search_sidebar' %>
+</div>
 
 <div id="content" class="span9">
 
@@ -16,14 +16,17 @@
 
       <% extra_head_content << render_opensearch_response_metadata.html_safe %>
 
-	    <%= render :partial => 'did_you_mean' %>
+	    <%= render 'did_you_mean' %>
+
+      <%= render 'constraints' %>
 
-      <%= render :partial => 'constraints' %>
+      <%= render 'sort_and_per_page' %>
 
-      <%= render :partial => 'sort_and_per_page' %>
       <h2 class="hide-text"><%= t('blacklight.search.search_results') %></h2>
 
-      <%- if render_grouped_response? %>
+      <%- if response_has_no_search_results? %>
+        <%= render "zero_results" %>
+      <%- elsif render_grouped_response? %>
         <%= render_grouped_document_index %>
       <%- else %>
         <%= render_document_index %>

data/config/locales/blacklight.en.yml

@@ -227,6 +227,12 @@ en:
         present: "In Bookmarks"
         absent: "Bookmark"
         inprogress: "Saving..."
+      zero_results:
+        title: "No results found for your search"
+        modify_search: "Try modifying your search"
+        use_fewer_keywords: "Use fewer keywords to start, then refine your search using the links on the left."
+        search_fields: "you searched by %{search_fields}"
+        search_everything: "try searching everything"
 
     entry_name:
       default: 'entry'

data/config/locales/blacklight.fr.yml

@@ -243,6 +243,12 @@ fr:
         present: "Dans panier"
         absent: "Ajouter au panier"
         inprogress: "En cours"
+      zero_results:
+        title: "Votre recherche ne correspond à aucune ressource."
+        modify_search: "Essayez de modifier votre requête de recherche"
+        use_fewer_keywords: "Utilisez moins de mots-clés pour commencer, puis affiner votre recherche."
+        search_fields: "vous avez cherché par %{search_fields}"
+        search_everything: "essayez de rechercher tout"
 
     entry_name:
       default: 'résultat'

data/lib/blacklight.rb

@@ -19,6 +19,7 @@ module Blacklight
 
   autoload :Controller, 'blacklight/controller'
   autoload :LegacyControllerMethods, 'blacklight/legacy_controller_methods'
+  autoload :Base, 'blacklight/base'
   autoload :Catalog,    'blacklight/catalog'
 
   autoload :Routes, 'blacklight/routes'

data/lib/blacklight/base.rb

@@ -0,0 +1,48 @@
+# -*- encoding : utf-8 -*-
+module Blacklight::Base   
+  extend ActiveSupport::Concern
+
+  include Blacklight::Configurable
+  include Blacklight::SolrHelper
+
+
+  included do  
+    # When RSolr::RequestError is raised, the rsolr_request_error method is executed.
+    # The index action will more than likely throw this one.
+    # Example, when the standard query parser is used, and a user submits a "bad" query.
+    rescue_from RSolr::Error::Http, :with => :rsolr_request_error if respond_to? :rescue_from
+  end
+
+  protected
+
+  # when solr (RSolr) throws an error (RSolr::RequestError), this method is executed.
+  def rsolr_request_error(exception)
+
+    if Rails.env.development?
+      raise exception # Rails own code will catch and give usual Rails error page with stack trace
+    else
+
+      flash_notice = I18n.t('blacklight.search.errors.request_error')
+
+      # If there are errors coming from the index page, we want to trap those sensibly
+
+      if flash[:notice] == flash_notice
+        logger.error "Cowardly aborting rsolr_request_error exception handling, because we redirected to a page that raises another exception"
+        raise exception
+      end
+
+      logger.error exception
+
+      flash[:notice] = flash_notice 
+      redirect_to root_path
+    end
+  end
+
+  def blacklight_solr
+    @solr ||=  RSolr.connect(blacklight_solr_config)
+  end
+
+  def blacklight_solr_config
+    Blacklight.solr_config
+  end
+end

data/lib/blacklight/catalog.rb

@@ -2,28 +2,22 @@
 module Blacklight::Catalog   
   extend ActiveSupport::Concern
   
-  include Blacklight::Configurable
-  include Blacklight::SolrHelper
+  include Blacklight::Base
   
-  SearchHistoryWindow = 12 # how many searches to save in session history
+  require 'blacklight/catalog/search_context'
+  include Blacklight::Catalog::SearchContext
+
+  SearchHistoryWindow = 100 # how many searches to save in session history
 
   # The following code is executed when someone includes blacklight::catalog in their
   # own controller.
-  included do  
-    helper_method :search_action_url
+  included do
     helper_method :sms_mappings
-    before_filter :search_session, :history_session
-    before_filter :delete_or_assign_search_session_params, :only => :index
-    after_filter :set_additional_search_session_values, :only=>:index
 
     # Whenever an action raises SolrHelper::InvalidSolrID, this block gets executed.
     # Hint: the SolrHelper #get_solr_response_for_doc_id method raises this error,
     # which is used in the #show action here.
     rescue_from Blacklight::Exceptions::InvalidSolrID, :with => :invalid_solr_id_error
-    # When RSolr::RequestError is raised, the rsolr_request_error method is executed.
-    # The index action will more than likely throw this one.
-    # Example, when the standard query parser is used, and a user submits a "bad" query.
-    rescue_from RSolr::Error::Http, :with => :rsolr_request_error
   end
   
     # get search results from the solr index
@@ -36,21 +30,13 @@ module Blacklight::Catalog
         format.html { 
           extra_head_content << view_context.auto_discovery_link_tag(:rss, url_for(params.merge(:format => 'rss')), :title => t('blacklight.search.rss_feed') )
           extra_head_content << view_context.auto_discovery_link_tag(:atom, url_for(params.merge(:format => 'atom')), :title => t('blacklight.search.atom_feed') )
-          save_current_search_params
         }
         format.rss  { render :layout => false }
         format.atom { render :layout => false }
 
         
         format.json do
-          facet = facets_from_request.as_json.each do |f|
-            f["label"] = facet_configuration_for_field(f["name"]).label
-            f["items"] = f["items"].as_json.each do |i|
-              i['label'] ||= i['value']
-            end
-          end 
-
-          render json: {response: {docs: @document_list, facets: facet, pages: pagination_info(@response)}}
+          render json: render_search_results_as_json
         end
       end
     end
@@ -77,7 +63,7 @@ module Blacklight::Catalog
 
     # updates the search counter (allows the show view to paginate)
     def update
-      session[:search][:counter] = params[:counter]
+      search_session[:counter] = params[:counter]
       redirect_to :action => "show"
     end
     
@@ -88,7 +74,7 @@ module Blacklight::Catalog
       respond_to do |format|
         # Draw the facet selector for users who have javascript disabled:
         format.html 
-        format.json { render json: {response: {facets: @pagination }}}
+        format.json { render json: render_facet_list_as_json }
 
         # Draw the partial for the "more" facet modal window:
         format.js { render :layout => false }
@@ -185,112 +171,38 @@ module Blacklight::Catalog
     # non-routable methods ->
     #
 
-    def search_action_url options = {}
-      url_for(options.merge(:action => 'index', :only_path => true))
+    # override this method to change the JSON response from #index 
+    def render_search_results_as_json
+      {response: {docs: @document_list, facets: search_facets_as_json, pages: pagination_info(@response)}}
     end
 
-
-    # calls setup_previous_document then setup_next_document.
-    # used in the show action for single view pagination.
-    def setup_next_and_previous_documents
-      setup_previous_document
-      setup_next_document
-    end
-    
-    # gets a document based on its position within a resultset  
-    def setup_document_by_counter(counter)
-      return if counter < 1 || session[:search].blank?
-      search = session[:search] || {}
-      get_single_doc_via_search(counter, search)
-    end
-    
-    def setup_previous_document
-      @previous_document = session[:search][:counter] ? setup_document_by_counter(session[:search][:counter].to_i - 1) : nil
-    end
-    
-    def setup_next_document
-      @next_document = session[:search][:counter] ? setup_document_by_counter(session[:search][:counter].to_i + 1) : nil
-    end
-    
-    # sets up the session[:search] hash if it doesn't already exist
-    def search_session
-      session[:search] ||= {}
-    end
-    
-    # sets up the session[:history] hash if it doesn't already exist.
-    # assigns all Search objects (that match the searches in session[:history]) to a variable @searches.
-    def history_session
-      session[:history] ||= []
-      @searches = searches_from_history # <- in BlacklightController
-    end
-    
-    # This method copies request params to session[:search], omitting certain
-    # known blacklisted params not part of search, omitting keys with blank
-    # values. All keys in session[:search] are as symbols rather than strings. 
-    def delete_or_assign_search_session_params
-      session[:search] = {}
-      params.each_pair do |key, value|
-        session[:search][key.to_sym] = value unless ["commit", "counter"].include?(key.to_s) ||
-          value.blank?
-      end
+    def search_facets_as_json
+      facets_from_request.as_json.each do |f|
+        f["label"] = facet_configuration_for_field(f["name"]).label
+        f["items"] = f["items"].as_json.each do |i|
+          i['label'] ||= i['value']
+        end
+      end 
     end
-    
-    # Saves the current search (if it does not already exist) as a models/search object
-    # then adds the id of the serach object to session[:history]
-    def save_current_search_params    
-      # If it's got anything other than controller, action, total, we
-      # consider it an actual search to be saved. Can't predict exactly
-      # what the keys for a search will be, due to possible extra plugins.
-      return if (search_session.keys - [:controller, :action, :total, :counter, :commit ]) == [] 
-      params_copy = search_session.clone # don't think we need a deep copy for this
-      params_copy.delete(:page)
-      
-      unless @searches.collect { |search| search.query_params }.include?(params_copy)
-        
-        new_search = Search.create(:query_params => params_copy)
-        session[:history].unshift(new_search.id)
-        # Only keep most recent X searches in history, for performance. 
-        # both database (fetching em all), and cookies (session is in cookie)
-        session[:history] = session[:history].slice(0, Blacklight::Catalog::SearchHistoryWindow )
-      end
+
+    # override this method to change the JSON response from #facet 
+    def render_facet_list_as_json
+      {response: {facets: @pagination }}
     end
-          
-    # sets some additional search metadata so that the show view can display it.
-    def set_additional_search_session_values
-      unless @response.nil?
-        search_session[:total] = @response.total
-      end
+
+    # Overrides the Blacklight::Controller provided #search_action_url.
+    # By default, any search action from a Blacklight::Catalog controller
+    # should use the current controller when constructing the route.
+    def search_action_url options = {}
+      url_for(options.merge(:action => 'index', :only_path => true))
     end
-    
+
     # we need to know if we are viewing the item as part of search results so we know whether to
     # include certain partials or not
     def adjust_for_results_view
       # deprecated in blacklight 4.x
       ActiveSupport::Deprecation.warn("#adjust_for_results_view helper was deprecated in Blacklight 4.x")
     end
-       
-    # when solr (RSolr) throws an error (RSolr::RequestError), this method is executed.
-    def rsolr_request_error(exception)
-      
-      if Rails.env.development?
-        raise exception # Rails own code will catch and give usual Rails error page with stack trace
-      else
-
-        flash_notice = I18n.t('blacklight.search.errors.request_error')
-
-        # If there are errors coming from the index page, we want to trap those sensibly
-
-        if flash[:notice] == flash_notice
-          logger.error "Cowardly aborting rsolr_request_error exception handling, because we redirected to a page that raises another exception"
-          raise exception
-        end
-
-        logger.error exception
-
-        flash[:notice] = flash_notice 
-        redirect_to root_path
-      end
-    end
 
     # extract the pagination info from the response object
     def pagination_info response

data/lib/blacklight/catalog/search_context.rb

@@ -0,0 +1,124 @@
+module Blacklight::Catalog::SearchContext
+  extend ActiveSupport::Concern
+
+
+  # The following code is executed when someone includes blacklight::catalog::search_session in their
+  # own controller.
+  included do  
+    helper_method :current_search_session, :search_session
+    before_filter :search_session, :history_session, :current_search_session
+  end
+  
+  protected
+
+  # sets up the session[:history] hash if it doesn't already exist.
+  # assigns all Search objects (that match the searches in session[:history]) to a variable @searches.
+  def history_session
+    session[:history] ||= []
+    @searches = searches_from_history # <- in BlacklightController
+  end
+
+  # sets up the session[:search] hash if it doesn't already exist
+  def search_session
+    session[:search] ||= {}
+  end
+  
+  # The current search session 
+  def current_search_session
+
+    @current_search_session ||= if action_name == "index"
+      find_or_initialize_search_session_from_params params
+    elsif params[:search_context] and !params[:search_context].blank?
+      find_or_initialize_search_session_from_params JSON.load(params[:search_context])
+    elsif params[:search_id] and !params[:search_id].blank?
+      # TODO : check the search id signature.
+      searches_from_history.find(params[:search_id]) rescue nil
+    elsif search_session[:id]
+      searches_from_history.find(search_session[:id]) rescue nil
+    end
+
+    if @current_search_session
+      search_session[:id] = @current_search_session.id
+    end
+
+    @current_search_session
+  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? }
+
+    return if params_copy.reject { |k,v| [:action, :controller].include? k.to_sym }.blank?
+
+    saved_search = searches_from_history.select { |x| x.query_params == params_copy }.first
+
+    saved_search ||= begin
+      s = Search.create(:query_params => params_copy)
+      add_to_search_history(s)
+      s
+    end
+  end
+
+  # Add a search to the in-session search history list
+  def add_to_search_history search
+    session[:history] ||= []
+
+    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 )
+      
+    end
+  end
+
+  # A list of query parameters that should not be persisted for a search      
+  def blacklisted_search_session_params
+    [:commit, :counter, :total, :search_id, :page, :per_page]
+  end
+
+  # 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
+      index = search_session[:counter].to_i - 1
+      response, documents = get_previous_and_next_documents_for_search index, current_search_session.query_params
+
+      search_session[:total] = response.total
+      @search_context_response = response
+      @previous_document = documents.first
+      @next_document = documents.last
+    end
+  end
+
+  # gets a document based on its position within a resultset  
+  def setup_document_by_counter(counter)
+    ActiveSupport::Deprecation.warn("#setup_document_by_counter helper is deprecated in Blacklight 4.x and will be removed")
+
+    return if counter < 1 or current_search_session.nil?
+    get_single_doc_via_search(counter, current_search_session.query_params)
+  end
+
+  def setup_previous_document
+    ActiveSupport::Deprecation.warn("#setup_previous_document helper was deprecated in Blacklight 4.x; now happens automatically as part of #setup_next_and_previous_documents")
+  end
+  
+  def setup_next_document
+    ActiveSupport::Deprecation.warn("#setup_next_document helper was deprecated in Blacklight 4.x; now happens automatically as part of #setup_next_and_previous_documents")
+  end
+
+  def delete_or_assign_search_session_params
+   # deprecated in blacklight 4.x
+    ActiveSupport::Deprecation.warn("#delete_or_assign_search_session_params helper was deprecated in Blacklight 4.x; now happens automatically as part of #current_search_session")
+  end
+  
+  def save_current_search_params    
+   # deprecated in blacklight 4.x
+    ActiveSupport::Deprecation.warn("#save_current_search_params helper was deprecated in Blacklight 4.x; now happens automatically as part of #current_search_session")
+  end
+
+  # sets some additional search metadata so that the show view can display it.
+  def set_additional_search_session_values
+    ActiveSupport::Deprecation.warn("#set_additional_search_session_values helper was deprecated in Blacklight 4.x")
+  end
+
+end

data/lib/blacklight/configuration.rb

@@ -22,6 +22,7 @@ module Blacklight
           :spell_max => 5,
           :max_per_page => 100,
           :per_page => [10,20,50,100],
+          :search_history_window => Blacklight::Catalog::SearchHistoryWindow,
           :document_index_view_types => ['list'],
           :add_facet_fields_to_solr_request => false,
           :add_field_configuration_to_solr_request => false

data/lib/blacklight/controller.rb

@@ -24,6 +24,7 @@ module Blacklight::Controller
     # extra head content
     helper_method :has_user_authentication_provider?
     helper_method :blacklight_config
+    helper_method :search_action_url
 
 
     # This callback runs when a user first logs in
@@ -43,9 +44,16 @@ module Blacklight::Controller
    
     protected
 
+    # 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 *args
+      catalog_index_url *args
+    end
+
     # Returns a list of Searches from the ids in the user's history.
     def searches_from_history
-      session[:history].blank? ? [] : Search.where(:id => session[:history]).order("updated_at desc")
+      session[:history].blank? ? Search.none : Search.where(:id => session[:history]).order("updated_at desc")
     end
     
     #

data/lib/blacklight/solr_helper.rb

@@ -552,6 +552,32 @@ module Blacklight::SolrHelper
     solr_response = find(blacklight_config.qt, solr_params)
     SolrDocument.new(solr_response.docs.first, solr_response) unless solr_response.docs.empty?
   end
+
+  # Get the previous and next document from a search result
+  def get_previous_and_next_documents_for_search(index, request_params, extra_controller_params={})
+
+    solr_params = solr_search_params(request_params).merge(extra_controller_params)
+
+    if index > 0
+      solr_params[:start] = index - 1 # get one before
+      solr_params[:rows] = 3 # and one after
+    else
+      solr_params[:start] = 0 # there is no previous doc
+      solr_params[:rows] = 2 # but there should be one after
+    end
+
+    solr_params[:fl] = '*'
+    solr_params[:facet] = false
+    solr_response = find(blacklight_config.qt, solr_params)
+
+    document_list = solr_response.docs.collect{|doc| SolrDocument.new(doc, solr_response) }
+
+    # only get the previous doc if there is one
+    prev_doc = document_list.first if index > 0
+    next_doc = document_list.last if (index + 1) < solr_response.total
+
+    [solr_response, [prev_doc, next_doc]]
+  end
     
   # returns a solr params hash
   # if field is nil, the value is fetched from blacklight_config[:index][:show_link]

data/spec/controllers/catalog_controller_spec.rb

@@ -81,33 +81,10 @@ describe CatalogController do
         it "should include search hash with key :q" do
           get :index, :q => @user_query
           session[:search].should_not be_nil
-          session[:search].keys.should include(:q)
-          session[:search][:q].should == @user_query
-        end
-        it "should include search hash with key :f" do
-          get :index, :f => @facet_query
-          session[:search].should_not be_nil
-          session[:search].keys.should include(:f)
-          session[:search][:f].should == @facet_query
-        end
-        it "should include search hash with key :per_page" do
-          get :index, :per_page => 10
-          session[:search].should_not be_nil
-          session[:search].keys.should include(:per_page)
-          session[:search][:per_page].should == "10"
-        end
-        it "should include search hash with key :page" do
-          get :index, :page => 2
-          session[:search].should_not be_nil
-          session[:search].keys.should include(:page)
-          session[:search][:page].should == "2"
-        end
-        it "should include search hash with random key" do
-          # cause a plugin might add an unpredictable one, we want to preserve it.
-          get :index, :some_weird_key => "value"
-          session[:search].should_not be_nil
-          session[:search].keys.should include(:some_weird_key)
-          session[:search][:some_weird_key].should == "value"
+          session[:search].keys.should include(:id)
+          
+          search = Search.find(session[:search][:id])
+          expect(search.query_params[:q]).to eq @user_query
         end
       end
 
@@ -224,40 +201,34 @@ describe CatalogController do
         @mock_document = double()
         @mock_document.stub(:export_formats => {})
         controller.stub(:get_solr_response_for_doc_id => [@mock_response, @mock_document], 
-                        :get_single_doc_via_search => @mock_document)
+                        :get_previous_and_next_documents_for_search => [double(:total => 5), [double("a"), @mock_document, double("b")]])
+
+        current_search = Search.create(:query_params => { :q => ""})
+        controller.stub(:current_search_session => current_search)
+
+        @search_session = { :id => current_search.id }
       end
     it "should set previous document if counter present in session" do
-      session[:search] = {:q => "", :counter => 2}
+      session[:search] = @search_session.merge(:counter => 2)
       get :show, :id => doc_id
       assigns[:previous_document].should_not be_nil
     end
-    it "should not set previous document if counter is 1" do
-      session[:search] = {:counter => 1}
-      get :show, :id => doc_id
-      assigns[:previous_document].should be_nil
-    end
     it "should not set previous or next document if session is blank" do
       get :show, :id => doc_id
       assigns[:previous_document].should be_nil
       assigns[:next_document].should be_nil
     end
     it "should not set previous or next document if session[:search][:counter] is nil" do
-      session[:search] = {:q => ""}
+      session[:search] = {}
       get :show, :id => doc_id
       assigns[:previous_document].should be_nil
       assigns[:next_document].should be_nil
     end
     it "should set next document if counter present in session" do
-      session[:search] = {:q => "", :counter => 2}
+      session[:search] = @search_session.merge(:counter => 2)
       get :show, :id => doc_id
       assigns[:next_document].should_not be_nil
     end
-    it "should not set next document if counter is >= number of docs" do
-      controller.stub(:get_single_doc_via_search => nil)
-      session[:search] = {:counter => 66666666}
-      get :show, :id => doc_id
-      assigns[:next_document].should be_nil
-    end
     end
 
     # NOTE: status code is always 200 in isolation mode ...
@@ -522,6 +493,96 @@ describe CatalogController do
       end
     end
   end
+
+  describe 'render_search_results_as_json' do
+    before do
+      controller.instance_variable_set :@document_list, [{id: '123', title_t: 'Book1'}, {id: '456', title_t: 'Book2'}]
+      controller.stub(:pagination_info).and_return({current_page: 1, next_page: 2, prev_page: nil})
+      controller.stub(:search_facets_as_json).and_return(
+          [{name: "format", label: "Format", items: [{value: 'Book', hits: 30, label: 'Book'}]}])
+    end
+
+    it "should be a hash" do
+       expect(controller.send(:render_search_results_as_json)).to eq (
+         {response: {docs: [{id: '123', title_t: 'Book1'}, {id: '456', title_t: 'Book2'}],
+                     facets: [{name: "format", label: "Format", items: [{value: 'Book', hits: 30, label: 'Book'}]}],
+                     pages: {current_page: 1, next_page: 2, prev_page: nil}}}
+       )
+    end
+  end
+
+  describe 'render_facet_list_as_json' do
+    before do
+      controller.instance_variable_set :@pagination, {items: [{value: 'Book'}]}
+    end
+
+    it "should be a hash" do
+       expect(controller.send(:render_facet_list_as_json)).to eq (
+         {response: {facets: {items: [{value: 'Book'}]}}}
+       )
+    end
+  end
+
+  describe "#add_to_search_history" do
+    it "should prepend the current search to the list" do
+      session[:history] = []
+      controller.send(:add_to_search_history, double(:id => 1))
+      expect(session[:history]).to have(1).item
+
+      controller.send(:add_to_search_history, double(:id => 2))
+      expect(session[:history]).to have(2).items
+      expect(session[:history].first).to eq 2
+    end
+
+    it "should remove searches from the list when the list gets too big" do
+      controller.stub(:blacklight_config).and_return(double(:search_history_window => 5))
+      session[:history] = (0..4).to_a.reverse
+
+      expect(session[:history]).to have(5).items
+      controller.send(:add_to_search_history, double(:id => 5))
+      controller.send(:add_to_search_history, double(:id => 6))
+      controller.send(:add_to_search_history, double(:id => 7))
+      expect(session[:history]).to include(*(3..7).to_a)
+
+    end
+  end
+
+  describe "current_search_session" do
+    it "should create a session if we're on an search action" do
+      controller.stub(:action_name => "index")
+      controller.stub(:params => { :q => "x", :page => 5})
+      session = controller.send(:current_search_session)
+      expect(session.query_params).to include(:q => "x")
+      expect(session.query_params).to_not include(:page => 5)
+    end
+
+    it "should create a session if a search context was provided" do
+      controller.stub(:params => { :search_context => JSON.dump(:q => "x")})
+      session = controller.send(:current_search_session)
+      expect(session.query_params).to include("q" => "x")
+    end
+
+    it "should use an existing session if a search id was provided" do
+      s = Search.create(:query_params => { :q => "x" })
+      session[:history] ||= []
+      session[:history] << s.id
+      controller.stub(:params => { :search_id => s.id})
+      session = controller.send(:current_search_session)
+      expect(session.query_params).to include(:q => "x")
+      expect(session).to eq(s)
+    end
+
+    it "should use an existing search session if the search is in the uri" do
+      s = Search.create(:query_params => { :q => "x" })
+      session[:search] ||= {}
+      session[:search][:id] = s.id
+      session[:history] ||= []
+      session[:history] << s.id
+      session = controller.send(:current_search_session)
+      expect(session.query_params).to include(:q => "x")
+      expect(session).to eq(s)
+    end
+  end
 end
 
 

data/spec/controllers/saved_searches_controller_spec.rb

@@ -0,0 +1,40 @@
+# -*- encoding : utf-8 -*-
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SavedSearchesController do
+  include Devise::TestHelpers
+
+  before(:all) do
+    @one = Search.create
+    @two = Search.create
+    @three = Search.create
+
+
+  end
+
+  before(:each) do
+    @user = User.create! :email => 'test@example.com', :password => 'abcd12345', :password_confirmation => 'abcd12345'
+    sign_in @user  
+  end
+
+  describe "save" do
+    it "should let you save a search" do
+
+      request.env["HTTP_REFERER"] = "where_i_came_from"
+      session[:history] = [@one.id]
+      post :save, :id => @one.id
+      expect(response).to redirect_to "where_i_came_from"
+    end
+
+    it "should not let you save a search that isn't in your search history" do
+      session[:history] = [@one.id]
+      expect {
+        post :save, :id => @two.id
+      }.to raise_exception
+    end
+
+  end
+
+
+
+end

data/spec/features/search_results_spec.rb

@@ -3,42 +3,32 @@ require 'spec_helper'
 
 describe "Search Results" do
   it "should have for an empty query" do
-    visit root_path
-    click_button 'search'
+    search_for ''
     number_of_results_from_page(page).should == 30
     page.should have_xpath("//a[contains(@href, #{2007020969})]")
-    fill_in "q", with: 'korea'
-    click_button 'search'
+    search_for 'korea'
     number_of_results_from_page(page).should == 4
   end
 
   it "should find same result set with or without diacritcs" do
-    visit root_path
-    fill_in "q", with: 'inmul'
-    click_button 'search'
+    search_for 'inmul'
     number_of_results_from_page(page).should == 1
     page.should have_xpath("//a[contains(@href, #{77826928})]")
 
-    fill_in "q", with: 'inmül'
-    click_button 'search'
+    search_for 'inmül'
     number_of_results_from_page(page).should == 1
   end
   it "should find same result set for a case-insensitive query " do
-    visit root_path
-    fill_in "q", with: 'inmul'
-    click_button 'search'
+    search_for 'inmul'
     number_of_results_from_page(page).should == 1
     page.should have_xpath("//a[contains(@href, #{77826928})]")
 
-    fill_in "q", with: 'INMUL'
-    click_button 'search'
+    search_for 'INMUL'
     number_of_results_from_page(page).should == 1
   end
 
   it "should order by relevancy" do
-    visit root_path
-    fill_in "q", with: 'Korea'
-    click_button 'search'
+    search_for "Korea"
     position_in_result_page(page, '77826928').should == 1
     position_in_result_page(page, '94120425').should == 2
     
@@ -50,9 +40,37 @@ describe "Search Results" do
     expect(page.find(:xpath, "//link[contains(@rel, 'search')]")[:href]).to eq "http://www.example.com/catalog/opensearch.xml"
   end
 
+  it "should provide search hints if there are no results" do
+    search_for 'asdfghj'
+    expect(page).to have_content "No results found for your search"
+  end
+
+  it "should pass the current search id through", :js => true do
+    visit root_path
+    fill_in "q", with: ''
+    click_button 'search'
+    search_id =  Search.last.id.to_s
+    click_on 'Pluvial nectar of blessings'
+    expect(page).to have_content "« Previous | 10 of 30 | Next »"
+    prev = page.find("#previousNextDocument .previous")
+    expect(prev['data-counter']).to eq "9"
+    expect(prev['data-search_id']).to eq search_id
+
+    click_on "« Previous"
+
+    prev = page.find("#previousNextDocument .previous")
+    expect(prev['data-counter']).to eq "8"
+    expect(prev['data-search_id']).to eq search_id
+  end
+
 end
 
 
+def search_for q
+  visit root_path
+  fill_in "q", with: q
+  click_button 'search'
+end
 
 def position_in_result_page(page, id)
   i = -1

data/spec/helpers/blacklight_helper_spec.rb

@@ -81,6 +81,16 @@ describe BlacklightHelper do
     #@config ||= {:show => {:html_title => 'title_display', :heading => 'title_display', :display_type => 'format'}, :index => { :show_link => 'title_display', :record_display_type => 'format' } }
   end
 
+  before(:each) do
+    helper.stub(:search_action_url) do |*args|
+      catalog_index_url *args
+    end
+  end
+
+  def current_search_session
+
+  end
+
   describe "#application_name", :test => true do
     it "should use the Rails application config application_name if available" do
       Rails.application.config.stub(:application_name => 'asdf')
@@ -99,8 +109,8 @@ describe BlacklightHelper do
     end
 
     it "should build a link tag to catalog using session[:search] for query params" do
-      session[:search] = @query_params
-      tag = link_back_to_catalog
+      helper.stub(:current_search_session).and_return double(:query_params => @query_params)
+      tag = helper.link_back_to_catalog
       tag.should =~ /q=query/
       tag.should =~ /f=facets/
       tag.should =~ /per_page=10/
@@ -108,8 +118,8 @@ describe BlacklightHelper do
     end
 
     it "should build a link tag to bookmarks using session[:search] for query params" do
-      session[:search] = @bookmarks_query_params
-      tag = link_back_to_catalog
+      helper.stub(:current_search_session).and_return double(:query_params => @bookmarks_query_params)
+      tag = helper.link_back_to_catalog
       tag.should =~ /Back to Bookmarks/
       tag.should =~ /\/bookmarks/
       tag.should =~ /page=2/

data/spec/lib/solr_helper_spec.rb

@@ -1118,5 +1118,37 @@ describe 'Blacklight::SolrHelper' do
 
   end
 
+  describe "#get_previous_and_next_documents_for_search" do
+    before(:all) do
+      @full_response, @all_docs = get_search_results({:q => ''}, :rows => 1000)
+    end
+
+    it "should return the previous and next documents for a search" do
+      response, docs = get_previous_and_next_documents_for_search(4, :q => '')
+
+      expect(docs.first.id).to eq @all_docs[3].id
+      expect(docs.last.id).to eq @all_docs[5].id
+    end
+
+    it "should return only the next document if the counter is 0" do
+      response, docs = get_previous_and_next_documents_for_search(0, :q => '')
+
+      expect(docs.first).to eq nil
+      expect(docs.last.id).to eq @all_docs[1].id
+    end
+
+    it "should return only the previous document if the counter is the total number of documents" do
+      response, docs = get_previous_and_next_documents_for_search(@full_response.total - 1, :q => '')
+      expect(docs.first.id).to eq @all_docs.slice(-2).id
+      expect(docs.last).to eq nil
+    end
+
+    it "should return an array of nil values if there is only one result" do
+      response, docs = get_previous_and_next_documents_for_search(0, :q => 'id:2007020969')
+      expect(docs.last).to be_nil
+      expect(docs.first).to be_nil
+    end
+  end
+
 end
 

data/spec/spec_helper.rb

@@ -22,6 +22,18 @@ require File.expand_path("config/environment", ENV['RAILS_ROOT'] || File.expand_
 
 require 'rspec/rails'
 require 'capybara/rspec'
+require 'capybara/poltergeist'
+
+
+Capybara.javascript_driver = :poltergeist
+
+Capybara.register_driver :poltergeist do |app|
+  options = {}
+
+  options[:timeout] = 120 if RUBY_PLATFORM == "java"
+
+  Capybara::Poltergeist::Driver.new(app, options)
+end
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.

data/spec/test_app_templates/Gemfile.extra

@@ -13,6 +13,7 @@ gem 'jquery-rails'
 group :test do
   gem 'rspec-rails', '~> 2.13'
   gem 'generator_spec'
+  gem 'poltergeist'
   if defined? :JRUBY_VERSION
     gem 'capybara', '~> 1.0'
   else

data/spec/views/catalog/_show_sidebar.erb_spec.rb

@@ -13,6 +13,7 @@ describe "/catalog/_show_sidebar.html.erb" do
 
     view.stub(:blacklight_config).and_return(CatalogController.blacklight_config)
     view.stub(:has_user_authentication_provider?).and_return(false)
+    view.stub(:current_search_session).and_return nil
   end
 
   it "should show more-like-this titles in the sidebar" do

data/spec/views/catalog/_thumbnail_default.erb_spec.rb

@@ -20,6 +20,7 @@ describe "catalog/_thumbnail_default" do
     assign :response, double(:params => {})
     view.stub(:render_grouped_response?).and_return false
     view.stub(:blacklight_config).and_return(blacklight_config)
+    view.stub(:current_search_session).and_return nil
   end
 
   it "should render the thumbnail if the document has one" do

data/spec/views/catalog/index.html.erb_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe "catalog/index.html.erb" do
+  it "should render the sidebar and content panes" do
+    view.stub(:blacklight_config).and_return(Blacklight::Configuration.new)
+    render
+    expect(rendered).to match /id="sidebar"/
+    expect(rendered).to match /id="content"/
+  end
+
+  it "should render the search_sidebar partial " do
+    stub_template "catalog/_search_sidebar.html.erb" => "sidebar_content"
+
+    view.stub(:blacklight_config).and_return(Blacklight::Configuration.new)
+    render
+    expect(rendered).to match /sidebar_content/
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 4.4.2
+  version: 4.5.0.rc1
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-27 00:00:00.000000000 Z
+date: 2013-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -278,6 +278,7 @@ files:
 - app/views/catalog/_refworks_form.html.erb
 - app/views/catalog/_results_pagination.html.erb
 - app/views/catalog/_search_form.html.erb
+- app/views/catalog/_search_sidebar.html.erb
 - app/views/catalog/_show_default.html.erb
 - app/views/catalog/_show_more_like_this.html.erb
 - app/views/catalog/_show_sidebar.html.erb
@@ -286,6 +287,7 @@ files:
 - app/views/catalog/_sort_and_per_page.html.erb
 - app/views/catalog/_sort_widget.html.erb
 - app/views/catalog/_thumbnail_default.html.erb
+- app/views/catalog/_zero_results.html.erb
 - app/views/catalog/citation.html.erb
 - app/views/catalog/citation.js.erb
 - app/views/catalog/email.html.erb
@@ -332,7 +334,9 @@ files:
 - gemfiles/rails4.gemfile
 - lib/SolrMarc.jar
 - lib/blacklight.rb
+- lib/blacklight/base.rb
 - lib/blacklight/catalog.rb
+- lib/blacklight/catalog/search_context.rb
 - lib/blacklight/configurable.rb
 - lib/blacklight/configuration.rb
 - lib/blacklight/configuration/facet_field.rb
@@ -405,6 +409,7 @@ files:
 - spec/controllers/application_controller_spec.rb
 - spec/controllers/bookmarks_controller_spec.rb
 - spec/controllers/catalog_controller_spec.rb
+- spec/controllers/saved_searches_controller_spec.rb
 - spec/controllers/search_history_controller_spec.rb
 - spec/data/sample_docs.yml
 - spec/data/test_data.utf8.mrc
@@ -472,6 +477,7 @@ files:
 - spec/views/catalog/_show_sidebar.erb_spec.rb
 - spec/views/catalog/_thumbnail_default.erb_spec.rb
 - spec/views/catalog/index.atom.builder_spec.rb
+- spec/views/catalog/index.html.erb_spec.rb
 - tasks/blacklight.rake
 - test_support/data/test_data.utf8.mrc
 homepage: http://projectblacklight.org/
@@ -488,12 +494,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: blacklight
-rubygems_version: 2.0.3
+rubygems_version: 2.1.7
 signing_key: 
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)
@@ -502,6 +508,7 @@ test_files:
 - spec/controllers/application_controller_spec.rb
 - spec/controllers/bookmarks_controller_spec.rb
 - spec/controllers/catalog_controller_spec.rb
+- spec/controllers/saved_searches_controller_spec.rb
 - spec/controllers/search_history_controller_spec.rb
 - spec/data/sample_docs.yml
 - spec/data/test_data.utf8.mrc
@@ -569,3 +576,4 @@ test_files:
 - spec/views/catalog/_show_sidebar.erb_spec.rb
 - spec/views/catalog/_thumbnail_default.erb_spec.rb
 - spec/views/catalog/index.atom.builder_spec.rb
+- spec/views/catalog/index.html.erb_spec.rb