blacklight 5.5.1 → 5.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f505877f6844d0240c6ceb14695e1addd5a9348c
-  data.tar.gz: 38c117040379ce80b28cf0e09b5de46ac8ab9f74
+  metadata.gz: e6f521c7766d2dd6e7b718a222296f2d0dad680a
+  data.tar.gz: 324a81ef36346eca1526cbe54ccbfc604703a7aa
 SHA512:
-  metadata.gz: a3f530b8c8d637783ee9fb1b049cc0a0f86b0a29160dcb181bbac9bfadb511ce6738d3fae194e89e9ca41c9dc438a3447a1662fe6f242d8652da307f9004742b
-  data.tar.gz: b91b2be73a23c411503d3a8243a409c1a14b7544d93ff7ec69b4fe2ed3abc790821bda6acfaf3724d35f8fd1900723a27f1477022a7cd2e72303fbc6ade10eb6
+  metadata.gz: 9d826574a0c0c6562857e3e846f323bd9e9bcc27d29b4f7efdb394c8c7a9c8372a43be6ea7972cdce406fc57d3f373616be37c54f1aa35edcbaad45c5703e690
+  data.tar.gz: 5aa333a5d25378061b79c61d0c94e07a912b197a6234e6ef9153749b7b8a04ff8eb65fd21d9e68b928ffb510885bcdcebad0bcbc157fb4605e7e5cf0209f2669

data/Gemfile

@@ -9,7 +9,7 @@ gemspec path: File.expand_path('..', __FILE__)
 gem 'simplecov', '~> 0.7.1', require: false
 gem 'coveralls', require: false
 
-gem 'engine_cart', '~> 0.3.0'
+gem 'engine_cart', '~> 0.4'
 
 group :test do
   gem "blacklight-marc", "~> 5.0", github: "projectblacklight/blacklight_marc"

data/VERSION

@@ -1 +1 @@
-5.5.1
+5.5.2

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -410,13 +410,10 @@ module Blacklight::BlacklightHelperBehavior
   # @return [String]
   def render_document_index_with_view view, documents, locals = {}
     document_index_path_templates.each do |str|
-      # XXX rather than handling this logic through exceptions, maybe there's a Rails internals method
-      # for determining if a partial template exists..
-      begin
-        return render(:partial => (str % { :index_view_type => view }), :locals => locals.merge(:documents => documents) )
-      rescue ActionView::MissingTemplate
-        nil
-      end
+      partial = str % { index_view_type: view }
+      logger.debug "Looking for document index partial #{partial}"
+      template = lookup_context.find_all(partial, lookup_context.prefixes, true, locals.keys + [:documents], {}).first
+      return template.render(self, locals.merge(documents: documents)) if template
     end
 
     return ""
@@ -502,15 +499,10 @@ module Blacklight::BlacklightHelperBehavior
     end
 
     document_partial_path_templates.each do |str|
-      # XXX rather than handling this logic through exceptions, maybe there's a Rails internals method
-      # for determining if a partial template exists..
-      begin
-        partial = str % { action_name: base_name, format: format, index_view_type: document_index_view_type }
-        logger.debug "Looking for document partial #{partial}"
-        return render partial: partial, locals: locals.merge(document: doc)
-      rescue ActionView::MissingTemplate
-        nil
-      end
+      partial = str % { action_name: base_name, format: format, index_view_type: document_index_view_type }
+      logger.debug "Looking for document partial #{partial}"
+      template = lookup_context.find_all(partial, lookup_context.prefixes, true, locals.keys + [:document], {}).first
+      return template.render(self, locals.merge(document: doc)) if template
     end
 
     return ''

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -131,7 +131,7 @@ module Blacklight::CatalogHelperBehavior
   # @param [SolrDocument]
   # @return [Boolean]
   def has_thumbnail? document
-    blacklight_config.view_config(document_index_view_type).thumbnail_method or
+    blacklight_config.view_config(document_index_view_type).thumbnail_method.present? or
       blacklight_config.view_config(document_index_view_type).thumbnail_field && document.has?(blacklight_config.view_config(document_index_view_type).thumbnail_field)
   end
 

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -188,7 +188,7 @@ module Blacklight::FacetsHelperBehavior
     facet_config = facet_configuration_for_field(field)
     
     value = if item.respond_to? :label
-      value = item.label
+      item.label
     else
       facet_value_for_facet_item(item)
     end

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -33,12 +33,13 @@ module Blacklight::RenderConstraintsHelperBehavior
   # @return [String]
   def render_constraints_query(localized_params = params)
     # So simple don't need a view template, we can just do it here.
+    scope = localized_params.delete(:route_set) || self
     return "".html_safe if localized_params[:q].blank?
 
     render_constraint_element(constraint_query_label(localized_params),
           localized_params[:q],
           :classes => ["query"],
-          :remove => url_for(localized_params.merge(:q=>nil, :action=>'index')))
+          :remove => scope.url_for(localized_params.merge(:q=>nil, :action=>'index')))
   end
 
   ##

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -115,7 +115,11 @@ module Blacklight::UrlHelperBehavior
       query_params[:page] = ((counter - 1)/ per_page) + 1
     end
 
-    link_url = scope.url_for(query_params)
+    link_url = if query_params.empty?
+      search_action_path(only_path: true)
+    else
+      scope.url_for(query_params)
+    end
     label = opts.delete(:label)
 
     if link_url =~ /bookmarks/

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

@@ -1,4 +1,4 @@
-<% if has_alternative_views? -%>
+<% if show_sort_and_per_page? and has_alternative_views? -%>
 <div class="view-type">
   <span class="sr-only"><%= t('blacklight.search.view_title') %></span>
   <div class="view-type-group btn-group">

data/blacklight.gemspec

@@ -26,8 +26,9 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "jettywrapper", ">= 1.7.0"
   s.add_development_dependency "blacklight-marc", "~> 5.0"
-  s.add_development_dependency "rspec-rails", "~> 2.99"
+  s.add_development_dependency "rspec-rails", "~> 3.0"
   s.add_development_dependency "rspec-its"
+  s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
   s.add_development_dependency "capybara"
   s.add_development_dependency "poltergeist"
   s.add_development_dependency 'engine_cart', ">= 0.1.0"

data/gemfiles/rails3.gemfile

@@ -6,4 +6,4 @@ if File.exists?(file)
   instance_eval File.read(file)
 end
 
-gem 'rails', "3.2.17"
+gem 'rails', "3.2.19"

data/gemfiles/rails4.1.gemfile

@@ -9,4 +9,4 @@ end
 gem 'sass', '~> 3.2.15'
 gem 'sprockets', '~> 2.11.0'
 
-gem 'rails', '4.1.0'
+gem 'rails', '4.1.4'

data/gemfiles/rails4.gemfile

@@ -10,4 +10,4 @@ end
 gem 'sass', '~> 3.2.15'
 gem 'sprockets', '~> 2.11.0'
 
-gem 'rails', '4.0.3'
+gem 'rails', '4.0.8'

data/lib/blacklight/catalog.rb

@@ -75,7 +75,6 @@ module Blacklight::Catalog
       @response = get_facet_field_response(@facet.field, params)
       @display_facet = @response.facets.first
 
-      # @pagination was deprecated in Blacklight 5.1
       @pagination = facet_paginator(@facet, @display_facet)
 
 

data/lib/blacklight/solr/facet_paginator.rb

@@ -25,7 +25,7 @@ module Blacklight::Solr
     class << self; attr_accessor :request_keys end # create a class method
     def request_keys ; self.class.request_keys ; end # shortcut
     
-    attr_reader :total_count, :items, :offset, :limit, :sort
+    attr_reader :offset, :limit, :sort
     
     # all_facet_values is a list of facet value objects returned by solr,
     # asking solr for n+1 facet values.
@@ -40,8 +40,17 @@ module Blacklight::Solr
       @limit =  arguments[:limit].to_s.to_i
       # count is solr's default
       @sort = arguments[:sort] || "count" 
-      @total_count = all_facet_values.size
-      @items = items_for_limit(all_facet_values)
+
+      @all = all_facet_values
+    end
+
+    # The number of records solr gave us when we asked for limit + 1 records at the current offset
+    def total_count
+      @all.size
+    end
+
+    def items
+      items_for_limit(@all)
     end
 
     def prev_page
@@ -73,20 +82,19 @@ module Blacklight::Solr
     deprecation_deprecate :has_next?
 
     def last_page?
-      current_page >= total_pages
+      total_count <= limit
     end
 
     def first_page?
       current_page == 1
     end
 
+    # We're implementing total_pages so that this matches the API from kaminari, even though we can't
+    # know the total number of pages.
+    # https://github.com/amatsuda/kaminari/blob/v0.16.1/lib/kaminari/models/page_scope_methods.rb#L21
     def total_pages
-      if limit == 0 #check for divide by zero
-        1
-      else
-        (total_count.to_f / limit).ceil
-      end
-    end      
+      -1
+    end
 
     # Pass in a desired solr facet solr key ('count' or 'index', see
     # http://wiki.apache.org/solr/SimpleFacetParameters#facet.limit
@@ -99,6 +107,10 @@ module Blacklight::Solr
       params.merge(request_keys[:sort] => sort_method, request_keys[:page] => nil)
     end
 
+    def as_json(_ = nil)
+      { 'items' => items.as_json, 'limit' => limit, 'offset' => offset, 'sort' => sort }
+    end
+
     private
       # setting limit to 0 implies no limit
       # @return an array of facets on the page

data/lib/generators/blacklight/install_generator.rb

@@ -27,7 +27,7 @@ module Blacklight
       copy_file "config/jetty.yml"
 
       append_to_file "Rakefile",
-        "\nZIP_URL = \"https://github.com/projectblacklight/blacklight-jetty/archive/v4.6.0.zip\"\n" +
+        "\nZIP_URL = \"https://github.com/projectblacklight/blacklight-jetty/archive/v4.9.0.zip\"\n" +
         "require 'jettywrapper'\n"
     end
 

data/spec/controllers/bookmarks_controller_spec.rb

@@ -10,10 +10,10 @@ describe BookmarksController do
     end
     
     it "has a 500 status code when fails is success" do
-      @controller.stub_chain(:current_or_guest_user, :existing_bookmark_for).and_return(false)
-      @controller.stub_chain(:current_or_guest_user, :persisted?).and_return(true)
-      @controller.stub_chain(:current_or_guest_user, :bookmarks, :where, :exists?).and_return(false)  
-      @controller.stub_chain(:current_or_guest_user, :bookmarks, :create).and_return(false)  
+      allow(@controller).to receive_message_chain(:current_or_guest_user, :existing_bookmark_for).and_return(false)
+      allow(@controller).to receive_message_chain(:current_or_guest_user, :persisted?).and_return(true)
+      allow(@controller).to receive_message_chain(:current_or_guest_user, :bookmarks, :where, :exists?).and_return(false)  
+      allow(@controller).to receive_message_chain(:current_or_guest_user, :bookmarks, :create).and_return(false)  
       xhr :put, :update, :id => 'iamabooboo', :format => :js
       expect(response.code).to eq "500"
     end
@@ -33,8 +33,8 @@ describe BookmarksController do
 
    it "has a 500 status code when delete is not success" do
       bm = double(Bookmark)
-      @controller.stub_chain(:current_or_guest_user, :existing_bookmark_for).and_return(bm)
-      @controller.stub_chain(:current_or_guest_user, :bookmarks, :where, :first).and_return(double('bookmark', delete: nil, destroyed?: false)) 
+      allow(@controller).to receive_message_chain(:current_or_guest_user, :existing_bookmark_for).and_return(bm)
+      allow(@controller).to receive_message_chain(:current_or_guest_user, :bookmarks, :where, :first).and_return(double('bookmark', delete: nil, destroyed?: false)) 
      
       xhr :delete, :destroy, :id => 'pleasekillme', :format => :js
 

data/spec/controllers/catalog_controller_spec.rb

@@ -22,7 +22,7 @@ describe CatalogController do
       let(:user_query) { 'history' } # query that will get results
 
       it "should have no search history if no search criteria" do
-        controller.should_receive(:get_search_results) 
+        allow(controller).to receive(:get_search_results) 
         session[:history] = []
         get :index
         expect(session[:history]).to be_empty
@@ -70,7 +70,7 @@ describe CatalogController do
 
       describe "session" do
         before do
-          controller.stub(:get_search_results) 
+          allow(controller).to receive(:get_search_results) 
         end
         it "should include search hash with key :q" do
           get :index, q: user_query
@@ -95,7 +95,7 @@ describe CatalogController do
       end
 
       it "should render index.html.erb" do
-        controller.stub(:get_search_results)
+        allow(controller).to receive(:get_search_results)
         get :index
         expect(response).to render_template(:index)
       end
@@ -156,8 +156,8 @@ describe CatalogController do
       let(:blacklight_config) { Blacklight::Configuration.new }
 
       before :each do
-        @controller.stub blacklight_config: blacklight_config
-        @controller.stub get_search_results: [double, double]
+        allow(@controller).to receive_messages blacklight_config: blacklight_config
+        allow(@controller).to receive_messages get_search_results: [double, double]
       end
 
       it "should not render when the config is false" do
@@ -185,7 +185,7 @@ describe CatalogController do
       end
 
       it "with a symbol, it should call a controller method" do
-        subject.should_receive(:render_some_yaml) do
+        expect(subject).to receive(:render_some_yaml) do
           subject.render nothing: true, layout: false
         end
 
@@ -256,12 +256,12 @@ describe CatalogController do
       before do
         @mock_response = double()
         @mock_document = double()
-        @mock_document.stub(:export_formats => {})
-        controller.stub(:get_solr_response_for_doc_id => [@mock_response, @mock_document], 
+        allow(@mock_document).to receive_messages(:export_formats => {})
+        allow(controller).to receive_messages(:get_solr_response_for_doc_id => [@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 => ""})
-        controller.stub(:current_search_session => current_search)
+        allow(controller).to receive_messages(:current_search_session => current_search)
 
         @search_session = { :id => current_search.id }
       end
@@ -296,18 +296,18 @@ describe CatalogController do
     it "should render show.html.erb" do
       @mock_response = double()
       @mock_document = double()
-      @mock_document.stub(:export_formats => {})
-      controller.stub(:get_solr_response_for_doc_id => [@mock_response, @mock_document])
+      allow(@mock_document).to receive_messages(:export_formats => {})
+      allow(controller).to receive_messages(:get_solr_response_for_doc_id => [@mock_response, @mock_document])
       get :show, :id => doc_id
-      response.should render_template(:show)
+      expect(response).to render_template(:show)
     end
 
     describe "@document" do
       before do
         @mock_response = double()
-        @mock_response.stub(documents: [SolrDocument.new(id: 'my_fake_doc')])
+        allow(@mock_response).to receive_messages(documents: [SolrDocument.new(id: 'my_fake_doc')])
         @mock_document = double()
-        controller.stub(:find => @mock_response )
+        allow(controller).to receive_messages(:find => @mock_response )
       end
       before(:each) do
         get :show, :id => doc_id
@@ -332,9 +332,9 @@ describe CatalogController do
       
       before do
         @mock_response = double()
-        @mock_response.stub(:docs => [{ :id => 'my_fake_doc' }])
+        allow(@mock_response).to receive_messages(:docs => [{ :id => 'my_fake_doc' }])
         @mock_document = double()
-        controller.stub(find: @mock_response)
+        allow(controller).to receive_messages(find: @mock_response)
       end
 
       before(:each) do
@@ -351,12 +351,12 @@ describe CatalogController do
       
       before do
         @mock_response = double()
-        @mock_response.stub(:documents => [SolrDocument.new(id: 'my_fake_doc')])
+        allow(@mock_response).to receive_messages(:documents => [SolrDocument.new(id: 'my_fake_doc')])
         @mock_document = double()
-        controller.stub(:find => @mock_response, 
+        allow(controller).to receive_messages(:find => @mock_response, 
                         :get_single_doc_via_search => @mock_document)
 
-        controller.stub(:find => @mock_response, 
+        allow(controller).to receive_messages(:find => @mock_response, 
                         :get_single_doc_via_search => @mock_document)
       end
 
@@ -379,9 +379,9 @@ describe CatalogController do
     before do
       @mock_response = double()
       @mock_document = double()
-      @mock_response.stub(documents:  [SolrDocument.new(id: 'my_fake_doc'), SolrDocument.new(id: 'my_other_doc')])
+      allow(@mock_response).to receive_messages(documents:  [SolrDocument.new(id: 'my_fake_doc'), SolrDocument.new(id: 'my_other_doc')])
       @mock_document = double()
-      controller.stub(find: @mock_response)
+      allow(controller).to receive_messages(find: @mock_response)
                       
     end
     it "should return an opensearch description" do
@@ -398,7 +398,7 @@ describe CatalogController do
     doc_id = '2007020969'
     let(:mock_response) { double(documents: [SolrDocument.new(id: 'my_fake_doc'), SolrDocument.new(id: 'my_other_doc')]) }
     before do
-      controller.stub(find: mock_response)
+      allow(controller).to receive_messages(find: mock_response)
       request.env["HTTP_REFERER"] = "/catalog/#{doc_id}"
       SolrDocument.use_extension( Blacklight::Solr::Document::Email )
       SolrDocument.use_extension( Blacklight::Solr::Document::Sms )
@@ -418,8 +418,8 @@ describe CatalogController do
       end
       it "should redirect back to the record upon success" do
         mock_mailer = double
-        mock_mailer.should_receive(:deliver)
-        RecordMailer.should_receive(:email_record).with(anything, { :to => 'test_email@projectblacklight.org', :message => 'xyz' }, hash_including(:host => 'test.host')).and_return mock_mailer
+        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
 
         post :email, :id => doc_id, :to => 'test_email@projectblacklight.org', :message => 'xyz'
         expect(request.flash[:error]).to be_nil
@@ -456,8 +456,8 @@ describe CatalogController do
       end
       it "should redirect back to the record upon success" do
         post :sms, :id => doc_id, :to => '5555555555', :carrier => 'txt.att.net'
-        request.flash[:error].should be_nil
-        request.should redirect_to(catalog_path(doc_id))
+        expect(request.flash[:error]).to eq nil
+        expect(request).to redirect_to(catalog_path(doc_id))
       end
 
       it "should render sms_sent template for XHR requests" do
@@ -471,14 +471,14 @@ describe CatalogController do
   describe "errors" do
     it "should return status 404 for a record that doesn't exist" do
       @mock_response = double(documents: [])
-      controller.stub(:find => @mock_response)
+      allow(controller).to receive_messages(:find => @mock_response)
       get :show, :id=>"987654321"
       expect(response.status).to eq 404
       expect(response.content_type).to eq Mime::HTML
     end
     it "should return status 404 for a record that doesn't exist even for non-html format" do
       @mock_response = double(documents: [])
-      controller.stub(:find => @mock_response)
+      allow(controller).to receive_messages(:find => @mock_response)
 
       get :show, :id=>"987654321", :format => "xml"
       expect(response.status).to eq 404
@@ -489,9 +489,9 @@ describe CatalogController do
       req = {}
       res = {}
       fake_error = RSolr::Error::Http.new(req, res) 
-      Rails.env.stub(:test? => false)
-      controller.stub(:get_search_results) { |*args| raise fake_error }
-      controller.logger.should_receive(:error).with(fake_error)
+      allow(Rails.env).to receive_messages(:test? => false)
+      allow(controller).to receive(:get_search_results) { |*args| raise fake_error }
+      expect(controller.logger).to receive(:error).with(fake_error)
       get :index, :q=>"+"
 
       expect(response.redirect_url).to eq root_url
@@ -504,9 +504,9 @@ describe CatalogController do
       req = {}
       res = {}
       fake_error = RSolr::Error::Http.new(req, res) 
-      controller.stub(:get_search_results) { |*args| raise fake_error }
-      controller.flash.stub(:sweep)
-      controller.stub(:flash).and_return(:notice => I18n.t('blacklight.search.errors.request_error'))
+      allow(controller).to receive(:get_search_results) { |*args| raise fake_error }
+      allow(controller.flash).to receive(:sweep)
+      allow(controller).to receive(:flash).and_return(:notice => I18n.t('blacklight.search.errors.request_error'))
       expect {
       get :index, :q=>"+"
       }.to raise_error 
@@ -518,7 +518,7 @@ describe CatalogController do
     render_views
 
     before do
-      controller.stub(:has_user_authentication_provider?) { false }
+      allow(controller).to receive(:has_user_authentication_provider?) { false }
     end
 
     it "should not show user util links" do
@@ -557,8 +557,8 @@ describe CatalogController do
   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(
+      allow(controller).to receive(:pagination_info).and_return({current_page: 1, next_page: 2, prev_page: nil})
+      allow(controller).to receive(:search_facets_as_json).and_return(
           [{name: "format", label: "Format", items: [{value: 'Book', hits: 30, label: 'Book'}]}])
     end
 
@@ -595,7 +595,7 @@ describe CatalogController do
     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))
+      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
@@ -609,15 +609,15 @@ describe CatalogController do
 
   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})
+      allow(controller).to receive_messages(:action_name => "index")
+      allow(controller).to receive_messages(: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")})
+      allow(controller).to receive_messages(:params => { :search_context => JSON.dump(:q => "x")})
       session = controller.send(:current_search_session)
       expect(session.query_params).to include("q" => "x")
     end
@@ -626,7 +626,7 @@ describe CatalogController do
       s = Search.create(:query_params => { :q => "x" })
       session[:history] ||= []
       session[:history] << s.id
-      controller.stub(:params => { :search_id => s.id})
+      allow(controller).to receive_messages(:params => { :search_id => s.id})
       session = controller.send(:current_search_session)
       expect(session.query_params).to include(:q => "x")
       expect(session).to eq(s)
@@ -647,16 +647,16 @@ describe CatalogController do
   describe "#has_search_parameters?" do
     subject { controller.has_search_parameters? }
     describe "none" do
-      before { controller.stub(params: { }) }
-      it { should be_false }
+      before { allow(controller).to receive_messages(params: { }) }
+      it { should be false }
     end
     describe "with a query" do
-      before { controller.stub(params: { q: 'hello' }) }
-      it { should be_true }
+      before { allow(controller).to receive_messages(params: { q: 'hello' }) }
+      it { should be true }
     end
     describe "with a facet" do
-      before { controller.stub(params: { f: { "field" => ["value"]} }) }
-      it { should be_true }
+      before { allow(controller).to receive_messages(params: { f: { "field" => ["value"]} }) }
+      it { should be true }
     end
   end