blacklight 7.10.0 → 7.11.1

data/spec/models/blacklight/solr/response/facets_spec.rb

@@ -194,7 +194,7 @@ RSpec.describe Blacklight::Solr::Response::Facets, api: true do
       }
     end
 
-    it"converts the query facets into a double RSolr FacetField" do
+    it "converts the query facets into a double RSolr FacetField" do
       field = subject.aggregations['my_query_facet_field']
 
       expect(field).to be_a_kind_of Blacklight::Solr::Response::Facets::FacetField

data/spec/models/blacklight/solr/response/group_response_spec.rb

@@ -19,6 +19,7 @@ RSpec.describe Blacklight::Solr::Response::GroupResponse, api: true do
         expect(group).to be_a Blacklight::Solr::Response::Group
       end
     end
+
     it "includes a list of SolrDocuments" do
       group.groups.each do |group|
         group.docs.each do |doc|
@@ -72,6 +73,7 @@ RSpec.describe Blacklight::Solr::Response::GroupResponse, api: true do
       ).and_return('cool group')
       expect(group.entry_name(count: 2)).to eq 'cool groups'
     end
+
     it "falls back to default group key" do
       expect(group.entry_name(count: 2)).to eq 'grouped results'
     end

data/spec/models/blacklight/solr/search_builder_spec.rb

@@ -54,6 +54,7 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       expect(subject[:qf]).to eq "fieldOne^2.3 fieldTwo fieldThree^0.4"
       expect(subject[:spellcheck]).to eq 'false'
     end
+
     it "merges empty string parameters from search_field definition" do
       expect(subject[:pf]).to eq ""
     end
@@ -156,9 +157,11 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
         expect(subject[:q]).to be_nil
         expect(subject["spellcheck.q"]).to be_nil
       end
+
       it 'has default rows' do
         expect(subject[:rows]).to eq 10
       end
+
       it 'has default facet fields' do
         # remove local params from the facet.field
         expect(subject[:"facet.field"].map { |x| x.gsub(/\{![^}]+\}/, '') }).to match_array %w[format subject_ssim pub_date_ssim language_ssim lc_1letter_ssim subject_geo_ssim subject_era_ssim]
@@ -167,6 +170,7 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       it "does not have a default qt" do
         expect(subject[:qt]).to be_nil
       end
+
       it "has no fq" do
         expect(subject[:phrase_filters]).to be_blank
         expect(subject[:fq]).to be_blank
@@ -266,11 +270,13 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       it "includes proper 'q', possibly with LocalParams" do
         expect(subject[:q]).to match(/(\{[^}]+\})?wome/)
       end
+
       it "includes proper 'q' when LocalParams are used" do
         if /\{[^}]+\}/.match?(subject[:q])
           expect(subject[:q]).to match(/\{[^}]+\}wome/)
         end
       end
+
       it "includes spellcheck.q, without LocalParams" do
         expect(subject["spellcheck.q"]).to eq "wome"
       end
@@ -278,6 +284,7 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       it "includes spellcheck.dictionary from field def solr_parameters" do
         expect(subject[:"spellcheck.dictionary"]).to eq "subject"
       end
+
       it "adds on :solr_local_parameters using Solr LocalParams style" do
         # q == "{!pf=$subject_pf $qf=subject_qf} wome", make sure
         # the LocalParams are really there
@@ -598,12 +605,15 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
     it 'sets rows to 0' do
       expect(solr_parameters[:rows]).to eq 0
     end
+
     it 'sets facets requested to facet_field argument' do
       expect(solr_parameters["facet.field".to_sym]).to eq facet_field
     end
+
     it 'defaults offset to 0' do
       expect(solr_parameters[:"f.#{facet_field}.facet.offset"]).to eq 0
     end
+
     context 'when offset is manually set' do
       let(:user_params) { { page_key => 2 } }
 

data/spec/models/record_mailer_spec.rb

@@ -18,20 +18,25 @@ RSpec.describe RecordMailer do
     it "receives the TO paramater and send the email to that address" do
       expect(@email.to).to include 'test@test.com'
     end
+
     it "starts the subject w/ Item Record:" do
       expect(@email.subject).to match /^Item Record:/
     end
+
     it "puts the title of the item in the subject" do
       expect(@email.subject).to match /The horn/
     end
+
     it "has the correct from address (w/o the port number)" do
       expect(@email.from).to include "no-reply@projectblacklight.org"
     end
+
     it "prints out the correct body" do
       expect(@email.body).to match /Title: The horn/
       expect(@email.body).to match /Author: Janetzky, Kurt/
       expect(@email.body).to match /projectblacklight.org/
     end
+
     it "uses https URLs when protocol is set" do
       details = { to: 'test@test.com', message: "This is my message" }
       @https_email = described_class.email_record(@documents, details, host: 'projectblacklight.org', protocol: 'https')
@@ -48,17 +53,21 @@ RSpec.describe RecordMailer do
     it "creates the correct TO address for the SMS email" do
       expect(@sms.to).to include '5555555555@txt.att.net'
     end
+
     it "does not have a subject" do
       expect(@sms.subject).to be_blank
     end
+
     it "has the correct from address (w/o the port number)" do
       expect(@sms.from).to include "no-reply@projectblacklight.org"
     end
+
     it "prints out the correct body" do
       expect(@sms.body).to match /The horn/
       expect(@sms.body).to match /by Janetzky, Kurt/
       expect(@sms.body).to match /projectblacklight.org:3000/
     end
+
     it "uses https URL when protocol is set" do
       details = { to: '5555555555@txt.att.net' }
       @https_sms = described_class.sms_record(@documents, details, host: 'projectblacklight.org', protocol: 'https')

data/spec/models/search_spec.rb

@@ -23,6 +23,7 @@ RSpec.describe Search do
 
       expect(@search).to be_saved
     end
+
     it "is false when user_id is NULL or less than 1" do
       @search = described_class.create
       expect(@search).not_to be_saved

data/spec/presenters/blacklight/show_presenter_spec.rb

@@ -143,6 +143,14 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
       config.show.title_field = Blacklight::Configuration::Field.new(field: 'x', values: ->(*_) { 'hardcoded' })
       expect(subject.heading).to eq 'hardcoded'
     end
+
+    context "when empty document" do
+      let(:document) { SolrDocument.new({}) }
+
+      it "returns an empty string as the heading" do
+        expect(subject.heading).to eq("")
+      end
+    end
   end
 
   describe "#html_title" do

data/spec/routing/catalog_routing_spec.rb

@@ -7,15 +7,19 @@ RSpec.describe "Routing" do
     it "has a path for showing the email form" do
       expect(get: "/catalog/email").to route_to(controller: 'catalog', action: 'email')
     end
+
     it "has a path for sending the email" do
       expect(post: "/catalog/email").to route_to(controller: 'catalog', action: 'email')
     end
+
     it "maps GET {:controller => 'catalog', :action => 'sms'} to /catalog/sms" do
       expect(get: "/catalog/sms").to route_to(controller: 'catalog', action: 'sms')
     end
+
     it "maps POST {:controller => 'catalog', :action => 'sms'} to /catalog/sms" do
       expect(post: "/catalog/sms").to route_to(controller: 'catalog', action: 'sms')
     end
+
     it "maps { :controller => 'catalog', :action => 'show', :id => 666 } to /catalog/666" do
       expect(get: "/catalog/666").to route_to(controller: 'catalog', action: 'show', id: "666")
     end

data/spec/services/blacklight/search_service_spec.rb

@@ -179,6 +179,7 @@ RSpec.describe Blacklight::SearchService, api: true do
     it 'has more than one facet' do
       expect(@facets).to have_at_least(1).facet
     end
+
     it 'has all facets specified in initializer' do
       expect(@facets.keys).to include *blacklight_config.facet_fields.keys
       expect(@facets.none? { |_k, v| v.nil? }).to eq true
@@ -189,6 +190,7 @@ RSpec.describe Blacklight::SearchService, api: true do
         expect(facet.items).to have_at_least(1).hit
       end
     end
+
     it 'has multiple values for at least one facet' do
       has_mult_values = false
       @facets.each do |_key, facet|
@@ -199,6 +201,7 @@ RSpec.describe Blacklight::SearchService, api: true do
       end
       expect(has_mult_values).to eq true
     end
+
     it 'has all value counts > 0' do
       @facets.each do |_key, facet|
         facet.items.each do |facet_vals|
@@ -217,6 +220,7 @@ RSpec.describe Blacklight::SearchService, api: true do
       (solr_response,) = service.search_results
       expect(solr_response.params[:start].to_i).to eq 0
     end
+
     it 'has number of results (per page) set in initializer, by default' do
       (solr_response, document_list) = service.search_results
       expect(solr_response.docs).to have(blacklight_config[:default_solr_params][:rows]).items
@@ -322,12 +326,15 @@ RSpec.describe Blacklight::SearchService, api: true do
     it "has a non-nil result for a known id" do
       expect(@document).not_to be_nil
     end
+
     it "has a single document in the response for a known id" do
       expect(@response2.docs.size).to eq 1
     end
+
     it 'has the expected value in the id field' do
       expect(@document.id).to eq doc_id
     end
+
     it 'has non-nil values for required fields set in initializer' do
       expect(@document.fetch(blacklight_config.view_config(:show).display_type_field)).not_to be_nil
     end

data/spec/spec_helper.rb

@@ -31,7 +31,7 @@ Capybara.disable_animation = true
 # in spec/support/ and its subdirectories.
 # Blacklight, again, make sure we're looking in the right place for em.
 # Relative to HERE, NOT to Rails.root, which is off somewhere else.
-Dir[Pathname.new(File.expand_path('support/**/*.rb', __dir__))].each { |f| require f }
+Dir[Pathname.new(File.expand_path('support/**/*.rb', __dir__))].sort.each { |f| require f }
 
 RSpec.configure do |config|
   config.disable_monkey_patching!

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

@@ -7,6 +7,7 @@ RSpec.describe "catalog/_document" do
   before do
     allow(view).to receive(:render_grouped_response?).and_return(false)
     allow(view).to receive(:blacklight_config).and_return(blacklight_config)
+    assign(:response, instance_double(Blacklight::Solr::Response, start: 20))
   end
 
   it "renders the header, thumbnail and index by default" do
@@ -14,11 +15,10 @@ RSpec.describe "catalog/_document" do
     stub_template "catalog/_thumbnail.html.erb" => "thumbnail_default"
     stub_template "catalog/_index_default.html.erb" => "index_default"
     render partial: "catalog/document", locals: { document: document, document_counter: 1 }
+    expect(rendered).to have_selector 'article.document[@data-document-counter="22"]'
     expect(rendered).to match /document_header/
     expect(rendered).to match /thumbnail_default/
     expect(rendered).to match /index_default/
-    expect(rendered).to have_selector('.document[@itemscope]')
-    expect(rendered).to have_selector('.document[@itemtype="http://schema.org/Thing"]')
   end
 
   it "uses the index.partials parameter to determine the partials to render" do
@@ -32,15 +32,17 @@ RSpec.describe "catalog/_document" do
     expect(rendered).to match /c_partial/
   end
 
-  it 'has a css class with the document position' do
-    allow(view).to receive(:render_document_partials)
-    render partial: 'catalog/document', locals: { document: document, document_counter: 5 }
-    expect(rendered).to have_selector '.document-position-5'
-  end
+  it 'provides the rendered partials to an explicitly configured component but does not render them by default' do
+    blacklight_config.index.partials = %w[a]
+    stub_template "catalog/_a_default.html.erb" => "partial"
+    blacklight_config.index.document_component = Blacklight::DocumentComponent
+    allow(view).to receive(:search_session).and_return({})
+    allow(view).to receive(:current_search_session).and_return(nil)
+    allow(view.main_app).to receive(:track_test_path).and_return('/track')
+
+    render partial: "catalog/document", locals: { document: document, document_counter: 1 }
 
-  it 'has a data attribute with the document position' do
-    allow(view).to receive(:render_document_partials)
-    render partial: 'catalog/document', locals: { document: document, document_counter: 5 }
-    expect(rendered).to have_selector '.document[@data-document-counter="5"]'
+    expect(rendered).to have_selector 'article.document header', text: '22. xyz'
+    expect(rendered).not_to match(/partial/)
   end
 end

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

@@ -70,6 +70,7 @@ RSpec.describe "catalog/_facet_group" do
         render
         expect(rendered).to have_selector('.facet-field-heading')
       end
+
       it "lists values" do
         render
         # The .facet-content class is used by blacklight_range_limit js, and

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

@@ -33,6 +33,7 @@ RSpec.describe 'catalog/_facet_index_navigation.html.erb', type: :view do
       render
       expect(rendered).to have_selector '.active', text: '5'
     end
+
     it 'enables the clear facets button' do
       render
       expect(rendered).to have_link 'All'

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

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 RSpec.describe "catalog/_previous_next_doc.html.erb" do
+  before do
+    allow(view).to receive(:search_session).and_return({})
+  end
+
   it "without next or previous does not render content" do
     assign(:search_context, {})
     render

data/spec/views/catalog/index.atom.builder_spec.rb

@@ -12,20 +12,23 @@ RSpec.describe "catalog/index" do
     end
   end
 
+  let(:blacklight_config) { CatalogController.blacklight_config }
+
   before do
     @response = Blacklight::Solr::Response.new({ response: { numFound: 30 } }, start: 10, rows: 10)
     allow(@response).to receive(:documents).and_return(document_list)
     params['content_format'] = 'some_format'
     allow(view).to receive(:action_name).and_return('index')
-    allow(view).to receive(:blacklight_config).and_return(CatalogController.blacklight_config)
+    allow(view).to receive(:blacklight_config).and_return(blacklight_config)
     allow(view).to receive(:search_field_options_for_select).and_return([])
-    render template: 'catalog/index', formats: [:atom]
   end
 
   # We need to use rexml to test certain things that have_tag wont' test
   let(:response_xml) { REXML::Document.new(rendered) }
 
   it "has contextual information" do
+    render template: 'catalog/index', formats: [:atom]
+
     expect(rendered).to have_selector("link[rel=self]")
     expect(rendered).to have_selector("link[rel=next]")
     expect(rendered).to have_selector("link[rel=previous]")
@@ -36,6 +39,8 @@ RSpec.describe "catalog/index" do
   end
 
   it "gets paging data correctly from response" do
+    render template: 'catalog/index', formats: [:atom]
+
     # Can't use have_tag for namespaced elements, sorry.
     expect(response_xml.elements["/feed/opensearch:totalResults"].text).to eq "30"
     expect(response_xml.elements["/feed/opensearch:startIndex"].text).to eq "10"
@@ -43,6 +48,8 @@ RSpec.describe "catalog/index" do
   end
 
   it "includes an opensearch Query role=request" do
+    render template: 'catalog/index', formats: [:atom]
+
     expect(response_xml.elements.to_a("/feed/opensearch:itemsPerPage")).to have(1).item
     query_el = response_xml.elements["/feed/opensearch:Query"]
     expect(query_el).not_to be_nil
@@ -52,30 +59,55 @@ RSpec.describe "catalog/index" do
   end
 
   it "has ten entries" do
+    render template: 'catalog/index', formats: [:atom]
+
     expect(rendered).to have_selector("entry", count: 10)
   end
 
   describe "entries" do
     it "has a title" do
+      render template: 'catalog/index', formats: [:atom]
       expect(rendered).to have_selector("entry > title")
     end
+
     it "has an updated" do
+      render template: 'catalog/index', formats: [:atom]
       expect(rendered).to have_selector("entry > updated")
     end
+
     it "has html link" do
+      render template: 'catalog/index', formats: [:atom]
       expect(rendered).to have_selector("entry > link[rel=alternate][type='text/html']")
     end
+
     it "has an id" do
+      render template: 'catalog/index', formats: [:atom]
       expect(rendered).to have_selector("entry > id")
     end
+
     it "has a summary" do
-      expect(rendered).to have_selector("entry > summary")
+      stub_template "catalog/_index.html.erb" => "partial content"
+      render template: 'catalog/index', formats: [:atom]
+      expect(rendered).to have_selector("entry > summary", text: 'partial content')
+    end
+
+    context 'with a custom HTML partial' do
+      before do
+        blacklight_config.view.atom.summary_partials = ['whatever']
+        stub_template 'catalog/_whatever_default.html.erb' => 'whatever content'
+      end
+
+      it "has the customized summary" do
+        render template: 'catalog/index', formats: [:atom]
+        expect(rendered).to have_selector("entry > summary", text: 'whatever content')
+      end
     end
 
     describe "with an author" do
       let(:entry) { response_xml.elements.to_a("/feed/entry")[0] }
 
       it "has author tag" do
+        render template: 'catalog/index', formats: [:atom]
         expect(entry.elements["author/name"].text).to eq 'xyz'
       end
     end
@@ -84,6 +116,7 @@ RSpec.describe "catalog/index" do
       let(:entry) { response_xml.elements.to_a("/feed/entry")[1] }
 
       it "does not have an author tag" do
+        render template: 'catalog/index', formats: [:atom]
         expect(entry.elements["author/name"]).to be_nil
       end
     end
@@ -94,9 +127,12 @@ RSpec.describe "catalog/index" do
       let(:entry) { response_xml.elements.to_a("/feed/entry")[1].to_s }
 
       it "includes a link rel tag" do
+        render template: 'catalog/index', formats: [:atom]
         expect(entry).to have_selector("link[rel=alternate][type='application/some-format']")
       end
+
       it "has content embedded" do
+        render template: 'catalog/index', formats: [:atom]
         expect(entry).to have_selector("content")
       end
     end
@@ -105,6 +141,7 @@ RSpec.describe "catalog/index" do
       let(:entry) { response_xml.elements.to_a("/feed/entry")[5].to_s }
 
       it "does not have content embedded" do
+        render template: 'catalog/index', formats: [:atom]
         expect(entry).not_to have_selector("content[type='application/some-format']")
       end
     end

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

@@ -49,4 +49,18 @@ RSpec.describe "catalog/show.html.erb" do
     expect(rendered).to match /b_partial/
     expect(rendered).to match /c_partial/
   end
+
+  it 'provides the rendered partials to an explicitly configured component but does not render them by default' do
+    blacklight_config.show.partials = %w[a]
+    stub_template "catalog/_a_default.html.erb" => "partial"
+    blacklight_config.show.document_component = Blacklight::DocumentComponent
+    allow(view).to receive(:search_session).and_return({})
+    allow(view).to receive(:current_search_session).and_return(nil)
+    allow(view.main_app).to receive(:track_test_path).and_return('/track')
+
+    render
+
+    expect(rendered).to have_selector 'div.document header h1', text: 'xyz'
+    expect(rendered).not_to match(/partial/)
+  end
 end