blacklight 5.0.0.pre1 → 5.0.0.pre2

data/lib/blacklight/solr_response.rb

@@ -85,6 +85,10 @@ class Blacklight::SolrResponse < HashWithIndifferentAccess
     def start
       response[:start].to_s.to_i
     end
+
+    def empty?
+      total == 0
+    end
     
   end
 end

data/lib/blacklight/user.rb

@@ -12,12 +12,6 @@ module Blacklight::User
     end
   end
 
-  # This is left for backwards-compatibility
-  # Remove this in Blacklight 5.x
-  module InstanceMethods
-    include Blacklight::User
-  end
-
   def has_bookmarks?
     bookmarks.any?
   end

data/spec/controllers/application_controller_spec.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 require 'spec_helper'
 
 describe ApplicationController do
@@ -7,7 +6,7 @@ describe ApplicationController do
   describe "#blacklight_config" do
 
     it "should provide a default blacklight_config everywhere" do
-      controller.blacklight_config.should == CatalogController.blacklight_config
+      expect(controller.blacklight_config).to eq CatalogController.blacklight_config
     end
   end
 

data/spec/controllers/bookmarks_controller_spec.rb

@@ -1,5 +1,4 @@
-# -*- encoding : utf-8 -*-
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe BookmarksController do
   include Devise::TestHelpers
@@ -8,8 +7,8 @@ describe BookmarksController do
   describe "update" do
     it "has a 204 status code when creating a new one" do
       xhr :put, :update, :id => '2007020969', :format => :js
-      response.should be_success
-      response.code.should == "204"
+      expect(response).to be_success
+      expect(response.code).to eq "204"
     end
     
     it "has a 500 status code when fails is success" do
@@ -17,15 +16,15 @@ describe BookmarksController do
       @controller.stub_chain(:current_or_guest_user, :persisted?).and_return(true)
       @controller.stub_chain(:current_or_guest_user, :bookmarks, :create).and_return(false)  
       xhr :put, :update, :id => 'iamabooboo', :format => :js
-      response.code.should == "500"
+      expect(response.code).to eq "500"
     end
   end
   
   describe "delete" do
     it "has a 204 status code when delete is success" do
       xhr :delete, :destroy, :id => '2007020969', :format => :js
-      response.should be_success
-      response.code.should == "204"
+      expect(response).to be_success
+      expect(response.code).to eq "204"
     end
 
    it "has a 500 status code when delete is not success" do
@@ -34,8 +33,8 @@ describe BookmarksController do
       @controller.stub_chain(:current_or_guest_user, :bookmarks, :delete).and_return(false)
      
       xhr :delete, :destroy, :id => 'pleasekillme', :format => :js
-     #
-      response.code.should == "500"
+
+      expect(response.code).to eq "500"
     end
   end
   

data/spec/controllers/catalog_controller_spec.rb

@@ -1,5 +1,4 @@
-# -*- encoding : utf-8 -*-
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe CatalogController do
   include Devise::TestHelpers
@@ -24,47 +23,47 @@ describe CatalogController do
         controller.should_receive(:get_search_results) 
         session[:history] = []
         get :index
-        session[:history].length.should == 0
+        expect(session[:history]).to be_empty
       end
 
       # check each user manipulated parameter
       it "should have docs and facets for query with results", :integration => true do
         get :index, :q => @user_query
-        assigns_response.docs.size.should > 1
+        expect(assigns_response.docs).to_not be_empty
         assert_facets_have_values(assigns_response.facets)
       end
       it "should have docs and facets for existing facet value", :integration => true do
         get :index, :f => @facet_query
-        assigns_response.docs.size.should > 1
+        expect(assigns_response.docs).to_not be_empty
         assert_facets_have_values(assigns_response.facets)
       end
       it "should have docs and facets for non-default results per page", :integration => true do
         num_per_page = 7
         get :index, :per_page => num_per_page
-        assigns_response.docs.size.should == num_per_page
+        expect(assigns_response.docs).to have(num_per_page).items
         assert_facets_have_values(assigns_response.facets)
       end
 
       it "should have docs and facets for second page", :integration => true do
         page = 2
         get :index, :page => page
-        assigns_response.docs.size.should > 1
-        assigns_response.params[:start].to_i.should == (page-1) * @controller.blacklight_config[:default_solr_params][:rows]
+        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]
         assert_facets_have_values(assigns_response.facets)
       end
 
       it "should have no docs or facet values for query without results", :integration => true do
         get :index, :q => @no_docs_query
 
-        assigns_response.docs.size.should == 0
+        expect(assigns_response.docs).to be_empty
         assigns_response.facets.each do |facet|
-          facet.items.size.should == 0
+          expect(facet.items).to be_empty
         end
       end
 
       it "should have a spelling suggestion for an appropriately poor query", :integration => true do
         get :index, :q => 'boo'
-        assigns_response.spelling.words.should_not be_nil
+        expect(assigns_response.spelling.words).to_not be_nil
       end
 
       describe "session" do
@@ -73,13 +72,13 @@ describe CatalogController do
         end
         it "should include :search key with hash" do
           get :index
-          session[:search].should_not be_nil
-          session[:search].should be_kind_of(Hash)
+          expect(session[:search]).to_not be_nil
+          expect(session[:search]).to be_kind_of(Hash)
         end
         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(:id)
+          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
@@ -90,7 +89,7 @@ describe CatalogController do
       describe "for default query" do
         it "should get documents when no query", :integration => true do
           get :index
-          assigns_response.docs.size.should > 1
+          expect(assigns_response.docs).to_not be_empty
         end
         it "should get facets when no query", :integration => true do
           get :index
@@ -101,27 +100,27 @@ describe CatalogController do
       it "should render index.html.erb" do
         controller.stub(:get_search_results)
         get :index
-        response.should render_template(:index)
+        expect(response).to render_template(:index)
       end
 
       # NOTE: status code is always 200 in isolation mode ...
       it "HTTP status code for GET should be 200", :integration => true do
         get :index
-        response.should be_success
+        expect(response).to be_success
       end
     end
 
     describe "with format :rss" do
       it "should get the feed", :integration => true do
         get :index, :format => 'rss'
-        response.should be_success
+        expect(response).to be_success
       end
     end
 
     describe "with format :json" do
       before do
         get :index, :format => 'json'
-        response.should be_success
+        expect(response).to be_success
       end
       let(:json) { JSON.parse(response.body)['response'] }
       let(:pages) { json["pages"] }
@@ -129,29 +128,29 @@ describe CatalogController do
       let(:facets) { json["facets"] }
 
       it "should get the pages" do
-        pages["total_count"].should == 30 
-        pages["current_page"].should == 1
-        pages["total_pages"].should == 3
+        expect(pages["total_count"]).to eq 30 
+        expect(pages["current_page"]).to eq 1
+        expect(pages["total_pages"]).to eq 3
       end
 
       it "should get the documents" do
-        docs.size.should == 10
+        expect(docs).to have(10).documents
         expect(docs.first.keys).to match_array(["published_display", "author_display", "lc_callnum_display", "pub_date", "subtitle_display", "format", "material_type_display", "title_display", "id", "subject_topic_facet", "language_facet", "score"])
       end
 
       it "should get the facets" do
-        facets.length.should == 9
-        facets.first.should == {"name"=>"format", "label" => "Format", "items"=>[{"value"=>"Book", "hits"=>30, "label"=>"Book"}]}
+        expect(facets).to have(9).facets
+        expect(facets.first).to eq({"name"=>"format", "label" => "Format", "items"=>[{"value"=>"Book", "hits"=>30, "label"=>"Book"}]})
       end
 
       describe "facets" do
         let(:query_facet_items) { facets.last['items'] }
         let(:regular_facet_items) { facets.first['items'] }
         it "should have items with labels and values" do
-          query_facet_items.first['label'].should == 'within 10 Years'
-          query_facet_items.first['value'].should == 'years_10'
-          regular_facet_items.first['label'].should == "Book"
-          regular_facet_items.first['value'].should == "Book"
+          expect(query_facet_items.first['label']).to eq 'within 10 Years'
+          expect(query_facet_items.first['value']).to eq 'years_10'
+          expect(regular_facet_items.first['label']).to eq "Book"
+          expect(regular_facet_items.first['value']).to eq "Book"
         end
       end
     end
@@ -163,7 +162,7 @@ describe CatalogController do
 
     it "should set counter value into session[:search]" do
       put :update, :id => doc_id, :counter => 3
-      session[:search][:counter].should == "3"
+      expect(session[:search][:counter]).to eq "3"
     end
 
     it "should redirect to show action for doc id" do
@@ -173,7 +172,7 @@ describe CatalogController do
 
     it "HTTP status code for redirect should be 303" do
       put :update, :id => doc_id, :counter => 3
-      response.status.should == 303
+      expect(response.status).to eq 303
     end
   end
 
@@ -185,14 +184,14 @@ describe CatalogController do
     describe "with format :html" do
       it "should get document", :integration => true do
         get :show, :id => doc_id
-        assigns[:document].should_not be_nil
+        expect(assigns[:document]).to_not be_nil
       end
     end
 
     describe "with format :json" do
       it "should get the feed" do
         get :show, id: doc_id, format: 'json'
-        response.should be_success
+        expect(response).to be_success
         json = JSON.parse response.body
         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
@@ -214,30 +213,30 @@ describe CatalogController do
     it "should set previous document if counter present in session" do
       session[:search] = @search_session.merge(:counter => 2)
       get :show, :id => doc_id
-      assigns[:previous_document].should_not be_nil
+      expect(assigns[:previous_document]).to_not 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
+      expect(assigns[:previous_document]).to be_nil
+      expect(assigns[:next_document]).to be_nil
     end
     it "should not set previous or next document if session[:search][:counter] is nil" do
       session[:search] = {}
       get :show, :id => doc_id
-      assigns[:previous_document].should be_nil
-      assigns[:next_document].should be_nil
+      expect(assigns[:previous_document]).to be_nil
+      expect(assigns[:next_document]).to be_nil
     end
     it "should set next document if counter present in session" do
       session[:search] = @search_session.merge(:counter => 2)
       get :show, :id => doc_id
-      assigns[:next_document].should_not be_nil
+      expect(assigns[:next_document]).to_not be_nil
     end
     end
 
     # NOTE: status code is always 200 in isolation mode ...
     it "HTTP status code for GET should be 200", :integration => true do
       get :show, :id => doc_id
-      response.should be_success
+      expect(response).to be_success
     end
     it "should render show.html.erb" do
       @mock_response = double()
@@ -262,7 +261,7 @@ describe CatalogController do
         @document = assigns[:document]
       end
       it "should be a SolrDocument" do
-        @document.should be_instance_of(SolrDocument)
+        expect(@document).to be_instance_of(SolrDocument)
       end
     end
     
@@ -302,8 +301,8 @@ describe CatalogController do
       
       it "should respond to an extension-registered format properly" do
         get :show, :id => doc_id, :format => "mock" # This no longer works: :format => "mock"
-        response.should be_success
-        response.body.should =~ /mock_export/
+        expect(response).to be_success
+        expect(response.body).to match /mock_export/
       end
       
 
@@ -326,14 +325,14 @@ describe CatalogController do
     end
     it "should return an opensearch description" do
       get :opensearch, :format => 'xml'
-      response.should be_success
+      expect(response).to be_success
     end
     it "should return valid JSON" do
       get :opensearch,:format => 'json', :q => "a"
-      response.should be_success
+      expect(response).to be_success
     end
   end
-#=end
+
   describe "email/sms" do
     doc_id = '2007020969'
       before do
@@ -352,15 +351,15 @@ describe CatalogController do
     describe "email" do
       it "should give error if no TO paramater" do
         post :email, :id => doc_id
-        request.flash[:error].should == "You must enter a recipient in order to send this message"
+        expect(request.flash[:error]).to eq "You must enter a recipient in order to send this message"
       end
       it "should give an error if the email address is not valid" do
         post :email, :id => doc_id, :to => 'test_bad_email'
-        request.flash[:error].should == "You must enter a valid email address"
+        expect(request.flash[:error]).to eq "You must enter a valid email address"
       end
       it "should not give error if no Message paramater is set" do
         post :email, :id => doc_id, :to => 'test_email@projectblacklight.org'
-        request.flash[:error].should be_nil
+        expect(request.flash[:error]).to be_nil
       end
       it "should redirect back to the record upon success" do
         mock_mailer = double
@@ -368,8 +367,8 @@ describe CatalogController do
         RecordMailer.should_receive(:email_record).with(anything, { :to => 'test_email@projectblacklight.org', :message => 'xyz' }, hash_including(:host => 'test.host')).and_return mock_mailer
 
         post :email, :id => doc_id, :to => 'test_email@projectblacklight.org', :message => 'xyz'
-        request.flash[:error].should be_nil
-        request.should redirect_to(catalog_path(doc_id))
+        expect(request.flash[:error]).to be_nil
+        expect(request).to redirect_to(catalog_path(doc_id))
       end
 
       it "should render email_sent for XHR requests" do
@@ -381,24 +380,24 @@ describe CatalogController do
     describe "sms" do
       it "should give error if no phone number is given" do
         post :sms, :id => doc_id, :carrier => 'att'
-        request.flash[:error].should == "You must enter a recipient's phone number in order to send this message"
+        expect(request.flash[:error]).to eq "You must enter a recipient's phone number in order to send this message"
       end
       it "should give an error when a carrier is not provided" do
         post :sms, :id => doc_id, :to => '5555555555', :carrier => ''
-        request.flash[:error].should == "You must select a carrier"
+        expect(request.flash[:error]).to eq "You must select a carrier"
       end
       it "should give an error when the phone number is not 10 digits" do
         post :sms, :id => doc_id, :to => '555555555', :carrier => 'txt.att.net'
-        request.flash[:error].should == "You must enter a valid 10 digit phone number"
+        expect(request.flash[:error]).to eq "You must enter a valid 10 digit phone number"
       end
       it "should give an error when the carrier is not in our list of carriers" do
         post :sms, :id => doc_id, :to => '5555555555', :carrier => 'no-such-carrier'
-        request.flash[:error].should == "You must enter a valid carrier"
+        expect(request.flash[:error]).to eq "You must enter a valid carrier"
       end
       it "should allow punctuation in phone number" do
         post :sms, :id => doc_id, :to => '(555) 555-5555', :carrier => 'txt.att.net'
-        request.flash[:error].should be_nil
-        request.should redirect_to(catalog_path(doc_id))
+        expect(request.flash[:error]).to be_nil
+        expect(request).to redirect_to(catalog_path(doc_id))
       end
       it "should redirect back to the record upon success" do
         post :sms, :id => doc_id, :to => '5555555555', :carrier => 'txt.att.net'
@@ -422,9 +421,9 @@ describe CatalogController do
         controller.stub(:find => @mock_response, 
                         :get_single_doc_via_search => @mock_document)
       get :show, :id=>"987654321"
-      request.flash[:notice].should == "Sorry, you have requested a record that doesn't exist."
-      response.should render_template('index')
-      response.status.should == 404
+      expect(request.flash[:notice]).to eq "Sorry, you have requested a record that doesn't exist."
+      expect(response).to render_template('index')
+      expect(response.status).to eq 404
     end
     it "should redirect the user to the root url for a bad search" do
       req = {}
@@ -434,10 +433,10 @@ describe CatalogController do
       controller.logger.should_receive(:error).with(fake_error)
       get :index, :q=>"+"
 
-      response.redirect_url.should == root_url
-      request.flash[:notice].should == "Sorry, I don't understand your search."
-      response.should_not be_success
-      response.status.should == 302
+      expect(response.redirect_url).to eq root_url
+      expect(request.flash[:notice]).to eq "Sorry, I don't understand your search."
+      expect(response).to_not be_success
+      expect(response.status).to eq 302
     end
     it "should return status 500 if the catalog path is raising an exception" do
 
@@ -469,7 +468,7 @@ describe CatalogController do
 
     it "should not show user util links" do
       get :index
-      response.body.should_not =~ /Login/
+      expect(response.body).to_not match /Login/
     end
   end
 
@@ -477,22 +476,22 @@ describe CatalogController do
     describe "requesting js" do
       it "should be successful" do
         xhr :get, :facet, id: 'format'
-        response.should be_successful
+        expect(response).to be_successful
       end
     end
     describe "requesting html" do
       it "should be successful" do
         get :facet, id: 'format'
-        response.should be_successful
-        assigns[:pagination].should be_kind_of Blacklight::Solr::FacetPaginator
+        expect(response).to be_successful
+        expect(assigns[:pagination]).to be_kind_of Blacklight::Solr::FacetPaginator
       end
     end
     describe "requesting json" do
       it "should be successful" do
         get :facet, id: 'format', format: 'json'
-        response.should be_successful
+        expect(response).to be_successful
         json = JSON.parse(response.body)
-        json["response"]["facets"]["items"].first["value"].should == 'Book'
+        expect(json["response"]["facets"]["items"].first["value"]).to eq 'Book'
       end
     end
   end
@@ -591,10 +590,10 @@ end
 
 # there must be at least one facet, and each facet must have at least one value
 def assert_facets_have_values(facets)
-  facets.size.should > 1
+  expect(facets).to_not be_empty
   # should have at least one value for each facet
   facets.each do |facet|
-    facet.items.size.should >= 1
+    expect(facet.items).to have_at_least(1).item
   end
 end