blacklight 6.4.2 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fea8f394ca9653526946ca4e4bfcf50cc4f78ef
-  data.tar.gz: 59305f0d30b38edbb7bc622cc48de9f5b6fd2004
+  metadata.gz: a6689bf20317b8fb6bee88d3064ce8528fbfe2ec
+  data.tar.gz: 2a83b261f71d22b9959014af71f0cc64736bd228
 SHA512:
-  metadata.gz: df80eb8cbd5f23b4752194861992190bfec55ec8400eb5509f0143233c2533117b2a042a5552859997620d8879d71b6e70917bdf3cec4797efa96a4ce9ad10d6
-  data.tar.gz: 39069bcc1804d9199a7e3d3dbecf01343643a910bbb327a9c12680e8701c2599a623c26514b8f36b4365717117cfd26c2ec66fdf469ac89507690dc3c3ed012e
+  metadata.gz: 0e83db02e3fa34951449c29fcc84ea4e92395d90a914b0432f6a2494c52f12b0032f482fbd5fbd0f309c03457038546f4eee4273f9a26ca39869ccc09af92160
+  data.tar.gz: 6273e3a816b869b90ed3f4eb5e1dffcf2d15786687b806fd45c9b0c61e76894158d4b0a3a741e10fd06c94b865342edcfdb589ba959dfa3cf3857a85e3d53a00

data/.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 *.sw[pon]
 .bundle
+.byebug_history
 .rvmrc
 *.log
 Gemfile.lock

data/Gemfile

@@ -11,10 +11,10 @@ group :test do
 end
 
 # BEGIN ENGINE_CART BLOCK
-# engine_cart: 0.8.0
-# engine_cart stanza: 0.8.0
+# engine_cart: 0.10.0
+# engine_cart stanza: 0.10.0
 # the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
-file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path(".internal_test_app", File.dirname(__FILE__)))
+file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app', File.dirname(__FILE__)))
 if File.exist?(file)
   begin
     eval_gemfile file
@@ -28,20 +28,19 @@ else
   if ENV['RAILS_VERSION']
     if ENV['RAILS_VERSION'] == 'edge'
       gem 'rails', github: 'rails/rails'
-      ENV['ENGINE_CART_RAILS_OPTIONS']= "--edge --skip-turbolinks"
+      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
     else
       gem 'rails', ENV['RAILS_VERSION']
     end
   end
 
-  if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^5\.0/ || ENV['RAILS_VERSION'] == 'edge'
-    # noop
-  elsif ENV['RAILS_VERSION'] =~ /^4\.2/
-    gem 'responders', "~> 2.0"
-    gem 'sass-rails', ">= 5.0"
-  else
-    gem 'bootstrap-sass', '< 3.3.5' # 3.3.5 requires sass 3.3, incompatible with sass-rails 4.x
-    gem 'sass-rails', "< 5.0"
+  case ENV['RAILS_VERSION']
+  when /^4.2/
+    gem 'responders', '~> 2.0'
+    gem 'sass-rails', '>= 5.0'
+    gem 'coffee-rails', '~> 4.1.0'
+  when /^4.[01]/
+    gem 'sass-rails', '< 5.0'
   end
 end
 # END ENGINE_CART BLOCK

data/VERSION

@@ -1 +1 @@
-6.4.2
+6.5.0

data/app/assets/stylesheets/blacklight/_twitter_typeahead.scss

@@ -1,7 +1,7 @@
 .twitter-typeahead {
   float: left;
   width: 100%;
-  z-index: 500;
+  z-index: $zindex-typeahead;
 
   input.tt-input.form-control {
     width: 100%;

data/app/assets/stylesheets/blacklight/blacklight_defaults.scss

@@ -4,3 +4,4 @@ $logo_image: 'blacklight/logo.png' !default;
 
 /* label (field names) */
 $field_name_color: $text-muted !default;
+$zindex-typeahead: $zindex-dropdown;

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

@@ -15,6 +15,7 @@ module Blacklight::Bookmarks
 
     before_action :verify_user
 
+    blacklight_config.http_method = Blacklight::Engine.config.bookmarks_http_method
     blacklight_config.add_results_collection_tool(:clear_bookmarks_widget)
 
     blacklight_config.show.document_actions[:bookmark].if = false if blacklight_config.show.document_actions[:bookmark]
@@ -83,7 +84,7 @@ module Blacklight::Bookmarks
     end
 
     if request.xhr?
-      success ? render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }}) : render(:text => "", :status => "500")
+      success ? render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }}) : render(plain: "", status: "500")
     else
       if @bookmarks.any? && success
         flash[:notice] = I18n.t('blacklight.bookmarks.add.success', :count => @bookmarks.length)
@@ -114,16 +115,13 @@ module Blacklight::Bookmarks
         # Deprecated in Rails 5.0
         redirect_to :back, notice: I18n.t('blacklight.bookmarks.remove.success')
       end
+    elsif request.xhr?
+      head 500 # ajaxy request needs no redirect and should not have flash set
+    elsif respond_to? :redirect_back
+      redirect_back fallback_location: bookmarks_path, flash: { error: I18n.t('blacklight.bookmarks.remove.failure') }
     else
-      if request.xhr?
-        # ajaxy request needs no redirect and should not have flash set
-        render(:text => "", :status => "500")
-      elsif respond_to? :redirect_back
-        redirect_back fallback_location: bookmarks_path, flash: { error: I18n.t('blacklight.bookmarks.remove.failure') }
-      else
-        # Deprecated in Rails 5.0
-        redirect_to :back, flash: { error: I18n.t('blacklight.bookmarks.remove.failure') }
-      end
+      # Deprecated in Rails 5.0
+      redirect_to :back, flash: { error: I18n.t('blacklight.bookmarks.remove.failure') }
     end
   end
 

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

@@ -43,11 +43,9 @@ module Blacklight::Catalog
     # to add responses for formats other than html or json see _Blacklight::Document::Export_
     def show
       @response, @document = fetch params[:id]
-
       respond_to do |format|
         format.html { setup_next_and_previous_documents }
         format.json { render json: { response: { document: @document } } }
-
         additional_export_formats(@document, format)
       end
     end
@@ -71,15 +69,11 @@ module Blacklight::Catalog
       @facet = blacklight_config.facet_fields[params[:id]]
       @response = get_facet_field_response(@facet.key, params)
       @display_facet = @response.aggregations[@facet.key]
-
       @pagination = facet_paginator(@facet, @display_facet)
-
-
       respond_to do |format|
         # Draw the facet selector for users who have javascript disabled:
         format.html
         format.json
-
         # Draw the partial for the "more" facet modal window:
         format.js { render :layout => false }
       end
@@ -88,12 +82,8 @@ module Blacklight::Catalog
     # method to serve up XML OpenSearch description and JSON autocomplete response
     def opensearch
       respond_to do |format|
-        format.xml do
-          render :layout => false
-        end
-        format.json do
-          render :json => get_opensearch_response
-        end
+        format.xml { render layout: false }
+        format.json { render json: get_opensearch_response }
       end
     end
 
@@ -107,7 +97,7 @@ module Blacklight::Catalog
 
     ##
     # Check if any search parameters have been set
-    # @return [Boolean] 
+    # @return [Boolean]
     def has_search_parameters?
       !params[:q].blank? or !params[:f].blank? or !params[:search_field].blank?
     end
@@ -129,13 +119,10 @@ module Blacklight::Catalog
     ##
     # Render additional response formats for the index action, as provided by the
     # blacklight configuration
-    #
-    # example:
-    #
-    #   config.index.respond_to.txt = Proc.new { render text: "A list of docs." }
-    #
-    # Make sure your format has a well known mime-type or is registered in
-    # config/initializers/mime_types.rb
+    # @param [Hash] format
+    # @note Make sure your format has a well known mime-type or is registered in config/initializers/mime_types.rb
+    # @example
+    #   config.index.respond_to.txt = Proc.new { render plain: "A list of docs." }
     def additional_response_formats format
       blacklight_config.index.respond_to.each do |key, config|
         format.send key do
@@ -160,7 +147,7 @@ module Blacklight::Catalog
     # the document extension framework. See _Blacklight::Document::Export_
     def additional_export_formats(document, format)
       document.export_formats.each_key do | format_name |
-        format.send(format_name.to_sym) { render text: document.export_as(format_name), layout: false }
+        format.send(format_name.to_sym) { render body: document.export_as(format_name), layout: false }
       end
     end
 
@@ -169,7 +156,6 @@ module Blacklight::Catalog
     def document_export_formats format
       format.any do
         format_name = params.fetch(:format, '').to_sym
-
         if @response.export_formats.include? format_name
           render_document_export_format format_name
         else
@@ -181,11 +167,11 @@ module Blacklight::Catalog
     ##
     # Render the document export formats for a response
     # First, try to render an appropriate template (e.g. index.endnote.erb)
-    # If that fails, just concatenate the document export responses with a newline. 
+    # If that fails, just concatenate the document export responses with a newline.
     def render_document_export_format format_name
       render
     rescue ActionView::MissingTemplate
-      render text: @response.documents.map { |x| x.export_as(format_name) if x.exports_as? format_name }.compact.join("\n"), layout: false
+      render plain: @response.documents.map { |x| x.export_as(format_name) if x.exports_as? format_name }.compact.join("\n"), layout: false
     end
 
     # Overrides the Blacklight::Controller provided #search_action_url.

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 module Blacklight::CatalogHelperBehavior
 
-  def rss_feed_link_tag
-    auto_discovery_link_tag(:rss, feed_link_url('rss'), title: t('blacklight.search.rss_feed'))
+  # @param [Hash] options 
+  # @option options :route_set the route scope to use when constructing the link
+  def rss_feed_link_tag(options = {})
+    auto_discovery_link_tag(:rss, feed_link_url('rss', options), title: t('blacklight.search.rss_feed'))
   end
 
-  def atom_feed_link_tag
-    auto_discovery_link_tag(:atom, feed_link_url('atom'), title: t('blacklight.search.atom_feed'))
+  # @param [Hash] options 
+  # @option options :route_set the route scope to use when constructing the link
+  def atom_feed_link_tag(options = {})
+    auto_discovery_link_tag(:atom, feed_link_url('atom', options), title: t('blacklight.search.atom_feed'))
   end
 
   ##
@@ -285,7 +289,11 @@ module Blacklight::CatalogHelperBehavior
 
   private
 
-    def feed_link_url(format)
-      url_for search_state.to_h.merge(format: format)
+    # @param [String] format 
+    # @param [Hash] options 
+    # @option options :route_set the route scope to use when constructing the link
+    def feed_link_url(format, options = {})
+      scope = options.delete(:route_set) || self
+      scope.url_for search_state.to_h.merge(format: format)
     end
 end

data/app/models/concerns/blacklight/document/export.rb

@@ -2,7 +2,7 @@
 # == Transformation conventions
 # The main use case for extensions is for transforming a Document to another
 # format. Either to another type of Ruby object, or to an exportable string in
-# a certain format. 
+# a certain format.
 #
 # The convention for methods contained in extensions that transform to a ruby
 # object is "to_*".  For instance, "to_marc" would return a Ruby Marc object.
@@ -20,7 +20,7 @@
 # If an extension advertises what export formats it can provide, than those
 # formats will automatically be delivered by the Blacklight catalog/show
 # controller, and potentially automatically advertised in various places
-# that advertise available formats. (HTML link rel=alternate; Atom 
+# that advertise available formats. (HTML link rel=alternate; Atom
 # link rel=alterate; etc).
 #
 # Export formats are 'registered' by calling the #will_export_as method
@@ -40,21 +40,21 @@
 #
 module Blacklight::Document::Export
 
-  ##  
+  ##
   # Register exportable formats supported by the individual document.
   # Usually called by an extension in it's self.extended method, to
-  # register the formats that extension can export. 
-  # 
+  # register the formats that extension can export.
+  #
   # some_document.will_export_as(:some_format, "application/type") means
   # that the document (usually via an extension) has a method
   # "export_as_some_format" which returns a String of content that
-  # is described by the mime content_type given. 
-  # 
+  # is described by the mime content_type given.
+  #
   # The format name should ideally _already_ be registered with
   # Rails Mime::Type, in your application initializer, representing
   # the content type given.  However, this method will attempt to
   # register it using Mime::Type.register_alias if it's not previously
-  # registered. This is a bit sketchy though. 
+  # registered. This is a bit sketchy though.
   def will_export_as(short_name, content_type = nil)
     #Lookup in Rails Mime::Type, register if needed, otherwise take
     # content-type from registration if needed.
@@ -62,34 +62,32 @@ module Blacklight::Document::Export
       content_type ||= Mime[short_name.to_sym]
     else
       # not registered, we need to register. Use register_alias to be least
-      # likely to interfere with host app. 
+      # likely to interfere with host app.
       Mime::Type.register_alias(content_type, short_name)
     end
 
     export_formats[short_name] =  { content_type: content_type }
   end
-  
+
   # Collects formats that this doc can export as.
-  # Returns a hash, keys are format short-names that can
-  # be exported. Hash includes:
-  #  :content-type => mime-content-type
-  #  maybe more later
   # To see if a given export format is supported by this document,
   # simply call document.export_formats.keys.include?(:my_format)
-  # Then call #export_as! to do the export. 
+  # Then call #export_as! to do the export.
+  # @return [Hash{Symbol=>Hash{Symbol=>String}}] keys are format short-names that can be exported, values are Hashes
+  # @example { :marc => { content_type: 'application/marc' } }
   def export_formats
     @export_formats ||= {}
   end
-  
+
   # Call with a format shortname, export_as(:marc), simply returns
   # #export_as_marc . Later we may expand the design to allow you
   # to register an arbitrary method name instead of insisting
   # on the convention, so clients should call this method so
-  # they'll still keep working if we do that. 
+  # they'll still keep working if we do that.
   def export_as(short_name)
     send("export_as_#{short_name}")
   end
-  
+
   def exports_as? short_name
     respond_to? "export_as_#{short_name}"
   end

data/app/models/search.rb

@@ -1,26 +1,22 @@
 # frozen_string_literal: true
 class Search < ActiveRecord::Base
-
   belongs_to_arguments = { optional: true } if Rails.version >= '5.0.0'
 
   belongs_to :user, belongs_to_arguments
 
   serialize :query_params
 
-  if Blacklight::Utils.needs_attr_accessible?
-    attr_accessible :query_params 
-  end
+  attr_accessible :query_params if Blacklight::Utils.needs_attr_accessible?
 
   # A Search instance is considered a saved search if it has a user_id.
   def saved?
     self.user_id?
   end
-  
+
   # delete old, unsaved searches
   def self.delete_old_searches(days_old)
     raise ArgumentError, 'days_old is expected to be a number' unless days_old.is_a?(Numeric)
     raise ArgumentError, 'days_old is expected to be greater than 0' if days_old <= 0
-    self.destroy_all(['created_at < ? AND user_id IS NULL', Time.zone.today - days_old])
+    self.where(['created_at < ? AND user_id IS NULL', Time.zone.today - days_old]).destroy_all
   end
-  
 end

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

@@ -22,7 +22,7 @@
   <%- @searches.each do |search| -%>
     <tr>
       <td><%= link_to_previous_search(search.query_params) %></td>
-      <td><%= button_to t('blacklight.saved_searches.delete'), blacklight.forget_search_path(search.id) %></td>
+      <td><%= button_to t('blacklight.saved_searches.delete'), blacklight.forget_search_path(search.id), :class => 'btn btn-danger' %></td>
     </tr>
   <%- end -%>
   </table>

data/blacklight.gemspec

@@ -40,6 +40,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
   s.add_development_dependency "capybara", '~> 2.6.0'
   s.add_development_dependency "poltergeist"
-  s.add_development_dependency 'engine_cart', '~> 0.8.0'
+  s.add_development_dependency 'engine_cart', '~> 0.10'
   s.add_development_dependency "equivalent-xml"
 end

data/lib/blacklight/engine.rb

@@ -42,5 +42,6 @@ module Blacklight
       'Cricket' => 'mms.mycricket.com'
     }
 
+    config.bookmarks_http_method = :post
   end
 end

data/spec/controllers/bookmarks_controller_spec.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
 describe BookmarksController do
+  describe '#blacklight_config' do
+    it 'uses POST requests for querying solr' do
+      expect(@controller.blacklight_config.http_method).to eq :post
+    end
+  end
+
   # jquery 1.9 ajax does error callback if 200 returns empty body. so use 204 instead. 
   describe "update" do
     it "has a 200 status code when creating a new one" do

data/spec/controllers/catalog_controller_spec.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
-
 describe CatalogController do
+  let(:doc_id) { '2007020969' }
+  let(:mock_response) { double() }
+  let(:mock_document) { double() }
 
   describe "index action" do
-    describe "with format :html" do
+    context "with format :html" do
       let(:user_query) { 'history' } # query that will get results
 
       it "has no search history if no search criteria" do
@@ -42,19 +44,18 @@ describe CatalogController do
         page = 2
         get :index, params: { page: page }
         expect(assigns(:response).docs).to_not be_empty
-        expect(assigns(:response).params[:start].to_i).to eq (page-1) * @controller.blacklight_config[:default_solr_params][:rows]
+        expect(assigns(:response).params[:start].to_i).to eq (page-1) * controller.blacklight_config[:default_solr_params][:rows]
         assert_facets_have_values(assigns(:response).aggregations)
       end
 
       it "has no docs or facet values for query without results", :integration => true do
         get :index, params: { q: 'sadfdsafasdfsadfsadfsadf' } # query for no results
-
         expect(assigns(:response).docs).to be_empty
         assigns(:response).aggregations.each do |key, facet|
           expect(facet.items).to be_empty
         end
       end
-      
+
       it "shows 0 results when the user asks for an invalid value to a custom facet query", :integration => true do
         get :index, params: { f: { example_query_facet_field: 'bogus' } } # bogus custom facet value
         expect(assigns(:response).docs).to be_empty
@@ -66,7 +67,7 @@ describe CatalogController do
         get :index, params: { f: {example_query_facet_field: 'years_5' } } # valid custom facet value with NO results
         expect(assigns(:response).docs).to be_empty
       end
-      
+
       it "has a spelling suggestion for an appropriately poor query", :integration => true do
         get :index, params: { q: 'boo' }
         expect(assigns(:response).spelling.words).to_not be_nil
@@ -80,7 +81,6 @@ describe CatalogController do
           get :index, params: { q: user_query }
           expect(session[:search]).to_not be_nil
           expect(session[:search].keys).to include 'id'
-
           search = Search.find(session[:search]['id'])
           expect(search.query_params['q']).to eq user_query
         end
@@ -125,8 +125,8 @@ describe CatalogController do
         expect(response).to be_success
       end
       let(:json) { JSON.parse(response.body)['response'] }
-      let(:pages) { json["pages"] }
-      let(:docs) { json["docs"] }
+      let(:pages)  { json["pages"]  }
+      let(:docs)   { json["docs"]   }
       let(:facets) { json["facets"] }
 
       it "gets the pages" do
@@ -161,8 +161,8 @@ describe CatalogController do
       let(:blacklight_config) { Blacklight::Configuration.new }
 
       before :each do
-        allow(@controller).to receive_messages blacklight_config: blacklight_config
-        allow(@controller).to receive_messages search_results: [double, double]
+        allow(controller).to receive_messages blacklight_config: blacklight_config
+        allow(controller).to receive_messages search_results: [double, double]
       end
 
       it "does not render when the config is false" do
@@ -178,33 +178,29 @@ describe CatalogController do
       end
 
       it "passes a hash to the render call" do
-        blacklight_config.index.respond_to.yaml = { nothing: true, layout: false }
+        blacklight_config.index.respond_to.yaml = { inline: '', layout: false }
         get :index, params: { format: 'yaml' }
         expect(response.body).to be_blank
       end
 
       it "evaluates a proc" do
-        blacklight_config.index.respond_to.yaml = lambda { render text: "" }
+        blacklight_config.index.respond_to.yaml = lambda { render plain: "" }
         get :index, params: { format: 'yaml' }
         expect(response.body).to be_empty
       end
 
       it "with a symbol, it should call a controller method" do
         expect(subject).to receive(:render_some_yaml) do
-          subject.render nothing: true, layout: false
+          subject.head :ok, layout: false
         end
-
         blacklight_config.index.respond_to.yaml = :render_some_yaml
         get :index, params: { format: 'yaml' }
         expect(response.body).to be_blank
       end
     end
-
   end # describe index action
 
   describe "track action" do
-    doc_id = '2007020969'
-    
     it "persists the search session id value into session[:search]" do
       put :track, params: { id: doc_id, counter: 3, search_id: "123" }
       expect(session[:search]['id']).to eq "123"
@@ -214,7 +210,7 @@ describe CatalogController do
       put :track, params: { id: doc_id, counter: 3 }
       expect(session[:search]['counter']).to eq "3"
     end
-    
+
     it "records the current per_page setting" do
       put :track, params: { id: doc_id, counter: 3, per_page: 15 }
       expect(session[:search]['per_page']).to eq "15"
@@ -243,9 +239,6 @@ describe CatalogController do
 
   # SHOW ACTION
   describe "show action" do
-
-    doc_id = '2007020969'
-
     describe "with format :html" do
       it "gets document", :integration => true do
         get :show, params: { id: doc_id }
@@ -261,50 +254,48 @@ describe CatalogController do
         expect(json["response"]["document"].keys).to match_array(["author_t", "opensearch_display", "marc_display", "published_display", "author_display", "lc_callnum_display", "title_t", "pub_date", "pub_date_sort", "subtitle_display", "format", "url_suppl_display", "material_type_display", "title_display", "subject_addl_t", "subject_t", "isbn_t", "id", "title_addl_t", "subject_geo_facet", "subject_topic_facet", "author_addl_t", "language_facet", "subtitle_t", "timestamp"])
       end
     end
-    
+
     describe "previous/next documents" do
+      let(:search_session) { { :id => current_search.id } }
+      let(:current_search) { Search.create(:query_params => { :q => ""}) }
       before do
-        @mock_response = double()
-        @mock_document = double()
-        allow(@mock_document).to receive_messages(:export_formats => {})
-        allow(controller).to receive_messages(fetch: [@mock_response, @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 => ""})
-        allow(controller).to receive_messages(:current_search_session => current_search)
-
-        @search_session = { :id => current_search.id }
+        allow(mock_document).to receive_messages(:export_formats => {})
+        allow(controller).to receive_messages(
+          fetch: [mock_response, mock_document],
+          get_previous_and_next_documents_for_search: [double(:total => 5), [double("a"), mock_document, double("b")]],
+          current_search_session: current_search
+        )
+      end
+      it "sets previous document if counter present in session" do
+        session[:search] = search_session.merge('counter' => 2)
+        get :show, params: { id: doc_id }
+        expect(assigns[:previous_document]).to_not be_nil
+      end
+      it "does not set previous or next document if session is blank" do
+        get :show, params: { id: doc_id }
+        expect(assigns[:previous_document]).to be_nil
+        expect(assigns[:next_document]).to be_nil
+      end
+      it "does not set previous or next document if session[:search]['counter'] is nil" do
+        session[:search] = {}
+        get :show, params: { id: doc_id }
+        expect(assigns[:previous_document]).to be_nil
+        expect(assigns[:next_document]).to be_nil
+      end
+      it "sets next document if counter present in session" do
+        session[:search] = search_session.merge('counter' => 2)
+        get :show, params: { id: doc_id }
+        expect(assigns[:next_document]).to_not be_nil
       end
-    it "sets previous document if counter present in session" do
-      session[:search] = @search_session.merge('counter' => 2)
-      get :show, params: { id: doc_id }
-      expect(assigns[:previous_document]).to_not be_nil
-    end
-    it "does not set previous or next document if session is blank" do
-      get :show, params: { id: doc_id }
-      expect(assigns[:previous_document]).to be_nil
-      expect(assigns[:next_document]).to be_nil
-    end
-    it "does not set previous or next document if session[:search]['counter'] is nil" do
-      session[:search] = {}
-      get :show, params: { id: doc_id }
-      expect(assigns[:previous_document]).to be_nil
-      expect(assigns[:next_document]).to be_nil
-    end
-    it "sets next document if counter present in session" do
-      session[:search] = @search_session.merge('counter' => 2)
-      get :show, params: { id: doc_id }
-      expect(assigns[:next_document]).to_not be_nil
-    end
 
-    it "does not break if solr returns an exception" do
-      allow(controller).to receive(:get_previous_and_next_documents_for_search) {
-        raise Blacklight::Exceptions::InvalidRequest.new "Error"
-      }
-      get :show, params: { id: doc_id }
-      expect(assigns[:previous_document]).to be_nil
-      expect(assigns[:next_document]).to be_nil
-    end
+      it "does not break if solr returns an exception" do
+        allow(controller).to receive(:get_previous_and_next_documents_for_search) {
+          raise Blacklight::Exceptions::InvalidRequest.new "Error"
+        }
+        get :show, params: { id: doc_id }
+        expect(assigns[:previous_document]).to be_nil
+        expect(assigns[:next_document]).to be_nil
+      end
     end
 
     # NOTE: status code is always 200 in isolation mode ...
@@ -312,96 +303,61 @@ describe CatalogController do
       get :show, params: { id: doc_id }
       expect(response).to be_success
     end
+
     it "renders show.html.erb" do
-      @mock_response = double()
-      @mock_document = double()
-      allow(@mock_document).to receive_messages(:export_formats => {})
-      allow(controller).to receive_messages(fetch: [@mock_response, @mock_document])
+      allow(mock_document).to receive_messages(:export_formats => {})
+      allow(controller).to receive_messages(fetch: [mock_response, mock_document])
       get :show, params: { id: doc_id }
       expect(response).to render_template(:show)
     end
 
     describe "@document" do
       before do
-        @mock_response = double()
-        allow(@mock_response).to receive_messages(documents: [SolrDocument.new(id: 'my_fake_doc')])
-        @mock_document = double()
-        allow(controller).to receive_messages(:find => @mock_response )
-      end
-      before(:each) do
+        allow(mock_response).to receive_messages(documents: [SolrDocument.new(id: 'my_fake_doc')])
+        allow(controller).to receive_messages(:find => mock_response )
         get :show, params: { id: doc_id }
-        @document = assigns[:document]
       end
       it "is a SolrDocument" do
-        expect(@document).to be_instance_of(SolrDocument)
+        expect(assigns[:document]).to be_instance_of(SolrDocument)
       end
     end
-    
+
     describe "with dynamic export formats" do
       render_views
       module FakeExtension
         def self.extended(document)
           document.will_export_as(:mock, "application/mock")
         end
-        
+
         def export_as_mock
           "mock_export"
         end
       end
-      
-      before do
-        @mock_response = double()
-        allow(@mock_response).to receive_messages(:docs => [{ :id => 'my_fake_doc' }])
-        @mock_document = double()
-        allow(controller).to receive_messages(find: @mock_response)
-      end
 
-      before(:each) do
-
-        # Rails3 needs this to propertly setup a new mime type and
-        # render the results. 
-        ActionController.add_renderer :double do |template, options|
-          send_data "mock_export", :type => Mime::MOCK
-        end
+      before do
+        allow(mock_response).to receive_messages(:documents => [SolrDocument.new(id: 'my_fake_doc')])
+        allow(controller).to receive_messages(:find => mock_response,
+                        :get_single_doc_via_search => mock_document)
         Mime::Type.register "application/mock", :mock
-        
         SolrDocument.use_extension(FakeExtension)
       end
-      
-      before do
-        @mock_response = double()
-        allow(@mock_response).to receive_messages(:documents => [SolrDocument.new(id: 'my_fake_doc')])
-        @mock_document = double()
-        allow(controller).to receive_messages(:find => @mock_response, 
-                        :get_single_doc_via_search => @mock_document)
-
-        allow(controller).to receive_messages(:find => @mock_response, 
-                        :get_single_doc_via_search => @mock_document)
-      end
 
       it "responds to an extension-registered format properly" do
         get :show, params: { id: doc_id, format: 'mock' }
         expect(response).to be_success
         expect(response.body).to match /mock_export/
       end
-      
 
-      after(:each) do
-        # remove the fake extension
-        SolrDocument.registered_extensions.pop
+      after do
+        SolrDocument.registered_extensions.pop # remove the fake extension
       end
     end # dynamic export formats
-
   end # describe show action
 
   describe "opensearch" do
     before do
-      @mock_response = double()
-      @mock_document = double()
-      allow(@mock_response).to receive_messages(documents:  [SolrDocument.new(id: 'my_fake_doc'), SolrDocument.new(id: 'my_other_doc')])
-      @mock_document = double()
-      allow(controller).to receive_messages(find: @mock_response)
-                      
+      allow(mock_response).to receive_messages(documents: [SolrDocument.new(id: 'my_fake_doc'), SolrDocument.new(id: 'my_other_doc')])
+      allow(controller).to receive_messages(find: mock_response)
     end
     it "returns an opensearch description" do
       get :opensearch, params: { format: 'xml' }
@@ -414,7 +370,6 @@ describe CatalogController do
   end
 
   describe "email/sms" do
-    doc_id = '2007020969'
     let(:mock_response) { double(documents: [SolrDocument.new(id: 'my_fake_doc'), SolrDocument.new(id: 'my_other_doc')]) }
     before do
       allow(controller).to receive_messages(find: mock_response)
@@ -436,10 +391,9 @@ describe CatalogController do
         expect(request.flash[:error]).to be_nil
       end
       it "redirects back to the record upon success" do
-        mock_mailer = double
-        allow(mock_mailer).to receive(:deliver)
-        allow(RecordMailer).to receive(:email_record).with(anything, { :to => 'test_email@projectblacklight.org', :message => 'xyz' }, hash_including(:host => 'test.host')).and_return mock_mailer
-
+        allow(RecordMailer).to receive(:email_record)
+          .with(anything, { :to => 'test_email@projectblacklight.org', :message => 'xyz' }, hash_including(:host => 'test.host'))
+          .and_return double(deliver: nil)
         post :email, params: { id: doc_id, to: 'test_email@projectblacklight.org', message: 'xyz' }
         expect(request.flash[:error]).to be_nil
         expect(request).to redirect_to(solr_document_path(doc_id))
@@ -450,6 +404,7 @@ describe CatalogController do
         expect(request.flash[:success]).to eq "Email Sent"
       end
     end
+
     describe "sms" do
       it "gives error if no phone number is given" do
         post :sms, params: { id: doc_id, carrier: 'att' }
@@ -473,9 +428,10 @@ describe CatalogController do
         expect(request).to redirect_to(solr_document_path(doc_id))
       end
       it "sends to the appropriate carrier email address" do
-        mock_mailer = double
-        allow(mock_mailer).to receive(:deliver)
-        expect(RecordMailer).to receive(:sms_record).with(anything, { to: '5555555555@txt.att.net' }, hash_including(:host => 'test.host')).and_return mock_mailer
+        expect(RecordMailer)
+          .to receive(:sms_record)
+          .with(anything, { to: '5555555555@txt.att.net' }, hash_including(:host => 'test.host'))
+          .and_return double(:deliver => nil)
         post :sms, params: { id: doc_id, to: '5555555555', carrier: 'txt.att.net' }
       end
       it "redirects back to the record upon success" do
@@ -483,7 +439,6 @@ describe CatalogController do
         expect(request.flash[:error]).to eq nil
         expect(request).to redirect_to(solr_document_path(doc_id))
       end
-
       it "renders sms_success template for XHR requests" do
         post :sms, xhr: true, params: { id: doc_id, to: '5555555555', carrier: 'txt.att.net' }
         expect(request).to render_template 'sms_success'
@@ -494,19 +449,17 @@ describe CatalogController do
 
   describe "errors" do
     it "returns status 404 for a record that doesn't exist" do
-      @mock_response = double(documents: [])
-      allow(controller).to receive_messages(:find => @mock_response)
+      allow(controller).to receive_messages(:find => double(documents: []))
       get :show, params: { id: "987654321" }
       expect(response.status).to eq 404
-      expect(response.content_type).to eq Mime::HTML
+      expect(response.content_type).to eq Mime[:html]
     end
-    it "returns status 404 for a record that doesn't exist even for non-html format" do
-      @mock_response = double(documents: [])
-      allow(controller).to receive_messages(:find => @mock_response)
 
+    it "returns status 404 for a record that doesn't exist even for non-html format" do
+      allow(controller).to receive_messages(:find => double(documents: []))
       get :show, params: { id: "987654321", format: "xml" }
       expect(response.status).to eq 404
-      expect(response.content_type).to eq Mime::XML
+      expect(response.content_type).to eq Mime[:xml]
     end
 
     it "redirects the user to the root url for a bad search" do
@@ -529,7 +482,6 @@ describe CatalogController do
       allow(controller).to receive(:flash).and_return(:notice => I18n.t('blacklight.search.errors.request_error'))
       expect { get :index, params: { q: '+' } }.to raise_error Blacklight::Exceptions::InvalidRequest
     end
-
   end
 
   context "without a user authentication provider" do
@@ -578,7 +530,6 @@ describe CatalogController 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
@@ -587,13 +538,11 @@ describe CatalogController do
     it "removes searches from the list when the list gets too big" do
       allow(controller).to receive(: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
 
@@ -654,45 +603,42 @@ describe CatalogController do
 
   describe "#add_show_tools_partial" do
     before do
-      CatalogController.add_show_tools_partial(:like, callback: :perform_like, validator: :validate_like_params)
-      allow(controller).to receive(:perform_like)
+      described_class.add_show_tools_partial(:like, callback: :perform_like, validator: :validate_like_params)
       allow(controller).to receive(:solr_document_url).and_return('catalog/1')
-      allow(controller).to receive(:action_documents).and_return([SolrDocument.new])
+      allow(controller).to receive(:action_documents).and_return(1)
       Rails.application.routes.draw do
         get 'catalog/like', as: :catalog_like
       end
     end
 
     after do
-      CatalogController.blacklight_config.show.document_actions.delete(:like)
+      described_class.blacklight_config.show.document_actions.delete(:like)
       Rails.application.reload_routes!
     end
 
     it "adds the action to a list" do
-      expect(CatalogController.blacklight_config.show.document_actions).to have_key(:like)
+      expect(described_class.blacklight_config.show.document_actions).to have_key(:like)
     end
 
     it "defines the action method" do
-      expect(controller.respond_to?(:like)).to be true
+      expect(controller).to respond_to(:like)
     end
 
     describe "when posting to the action" do
-      describe "with success" do
-        before do
-          allow(controller).to receive(:validate_like_params).and_return(true)
-          post :like
-        end
+      context 'with valid params' do
         it "calls the supplied method on post" do
-          expect(controller).to have_received(:perform_like) 
+          expect(controller).to receive(:validate_like_params).and_return(true)
+          expect(controller).to receive(:perform_like)
+          post :like
         end
       end
 
-      describe "with failure" do
-        describe "with invalid params" do
-          before { allow(controller).to receive(:validate_like_params).and_return(false) }
-          it "does not call the supplied method if validation failed" do
-            expect(controller).not_to have_received(:perform_like)
-          end
+      context "with failure on invalid params" do
+        it "does not call the supplied method" do
+          expect(controller).to receive(:validate_like_params).and_return(false)
+          expect(controller).not_to receive(:perform_like)
+          skip 'Clarify expectations on validator failure: 400? 500? Set a specific error key/msg? Render the same template anyway?'
+          post :like
         end
       end
     end
@@ -713,7 +659,6 @@ describe CatalogController do
   end
 end
 
-
 # there must be at least one facet, and each facet must have at least one value
 def assert_facets_have_values(aggregations)
   expect(aggregations).to_not be_empty

data/spec/helpers/catalog_helper_spec.rb

@@ -129,6 +129,42 @@ describe CatalogHelper do
     end
   end
 
+  describe "rss_feed_link_tag" do
+    context "when an alternate scope is passed in" do
+      let(:my_engine) { double("Engine") }
+      let(:query_params) { { controller: 'catalog', action: 'index' } }
+      let(:config) { Blacklight::Configuration.new }
+      let(:search_state) { Blacklight::SearchState.new(query_params, config) }
+
+      it "calls url_for on the engine scope" do
+        allow(helper).to receive(:search_state).and_return search_state
+        expect(my_engine).to receive(:url_for).and_return(url_for(query_params))
+        tag = helper.rss_feed_link_tag(route_set: my_engine)
+        expect(tag).to match /title="RSS for results"/
+        expect(tag).to match /rel="alternate"/
+        expect(tag).to match %r{type="application/rss\+xml"}
+      end
+    end
+  end
+
+  describe "atom_feed_link_tag" do
+    context "when an alternate scope is passed in" do
+      let(:my_engine) { double("Engine") }
+      let(:query_params) { { controller: 'catalog', action: 'index' } }
+      let(:config) { Blacklight::Configuration.new }
+      let(:search_state) { Blacklight::SearchState.new(query_params, config) }
+
+      it "calls url_for on the engine scope" do
+        allow(helper).to receive(:search_state).and_return search_state
+        expect(my_engine).to receive(:url_for).and_return(url_for(query_params))
+        tag = helper.atom_feed_link_tag(route_set: my_engine)
+        expect(tag).to match /title="Atom for results"/
+        expect(tag).to match /rel="alternate"/
+        expect(tag).to match %r{type="application/atom\+xml"}
+      end
+    end
+  end
+
   describe "should_autofocus_on_search_box?" do
     it "is focused if we're on a catalog-like index page without query or facet parameters" do
       allow(helper).to receive_messages(controller: CatalogController.new, action_name: "index", has_search_parameters?: false)

data/spec/models/blacklight/configuration_spec.rb

@@ -68,7 +68,7 @@ describe "Blacklight::Configuration" do
 
       @config.index.respond_to.csv = { :layout => false }
 
-      @config.index.respond_to.yaml = lambda { render text: "" }
+      @config.index.respond_to.yaml = lambda { render plain: "" }
 
       expect(@config.index.respond_to.keys).to eq [:xml, :csv, :yaml]
     end

data/spec/support/backport_test.rb

@@ -1,38 +1,14 @@
 # Backport the Rails 5 controller test methods to Rails 4
 module BackportTest
-  def delete(*args)
-    (action, rest) = *args
-    rest ||= {}
-    if rest[:xhr]
-      @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
+  [:delete, :get, :post, :put, :patch].each do |http_action|
+    define_method(http_action) do |*args|
+      (action, rest) = *args
+      rest ||= {}
+      if rest[:xhr]
+        @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
+        @request.env['HTTP_ACCEPT'] ||= [Mime::JS, Mime::HTML, Mime::XML, 'text/xml', Mime::ALL].join(', ')
+      end
+      super(action, rest[:params])
     end
-    super(action, rest[:params])
-  end
-
-  def get(*args)
-    (action, rest) = *args
-    rest ||= {}
-    if rest[:xhr]
-      @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
-    end
-    super(action, rest[:params])
-  end
-
-  def post(*args)
-    (action, rest) = *args
-    rest ||= {}
-    if rest[:xhr]
-      @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
-    end
-    super(action, rest[:params])
-  end
-
-  def put(*args)
-    (action, rest) = *args
-    rest ||= {}
-    if rest[:xhr]
-      @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
-    end
-    super(action, rest[:params])
   end
 end

data/template.demo.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 gem "blacklight", ">= 6.1"
 gem "jettywrapper", ">= 2.0"
 gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 6.4.2
+  version: 6.5.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-15 00:00:00.000000000 Z
+date: 2016-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -233,14 +233,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement