blacklight 8.2.2 → 8.4.0

data/spec/controllers/catalog_controller_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe CatalogController, api: true do
+RSpec.describe CatalogController, :api do
   let(:doc_id) { '2007020969' }
   let(:mock_document) { instance_double(SolrDocument, export_formats: {}) }
   let(:search_service) { instance_double(Blacklight::SearchService) }
@@ -24,26 +24,26 @@ RSpec.describe CatalogController, api: true do
       end
 
       # check each user manipulated parameter
-      it "has docs and facets for query with results", integration: true do
+      it "has docs and facets for query with results", :integration do
         get :index, params: { q: user_query }
         expect(assigns(:response).docs).not_to be_empty
         assert_facets_have_values(assigns(:response).aggregations)
       end
 
-      it "has docs and facets for existing facet value", integration: true do
+      it "has docs and facets for existing facet value", :integration do
         get :index, params: { f: { "format" => 'Book' } }
         expect(assigns(:response).docs).not_to be_empty
         assert_facets_have_values(assigns(:response).aggregations)
       end
 
-      it "has docs and facets for non-default results per page", integration: true do
+      it "has docs and facets for non-default results per page", :integration do
         num_per_page = 7
         get :index, params: { per_page: num_per_page }
         expect(assigns(:response).docs).to have(num_per_page).items
         assert_facets_have_values(assigns(:response).aggregations)
       end
 
-      it "has docs and facets for second page", integration: true do
+      it "has docs and facets for second page", :integration do
         page = 2
         get :index, params: { page: page }
         expect(assigns(:response).docs).not_to be_empty
@@ -51,7 +51,7 @@ RSpec.describe CatalogController, api: true do
         assert_facets_have_values(assigns(:response).aggregations)
       end
 
-      it "has no docs or facet values for query without results", integration: true do
+      it "has no docs or facet values for query without results", :integration do
         get :index, params: { q: 'sadfdsafasdfsadfsadfsadf' } # query for no results
         expect(assigns(:response).docs).to be_empty
         assigns(:response).aggregations.each_value do |facet|
@@ -59,12 +59,12 @@ RSpec.describe CatalogController, api: true do
         end
       end
 
-      it "shows 0 results when the user asks for an invalid value to a custom facet query", integration: true do
+      it "shows 0 results when the user asks for an invalid value to a custom facet query", :integration do
         get :index, params: { f: { example_query_facet_field: ['bogus'] } } # bogus custom facet value
         expect(assigns(:response).docs).to be_empty
       end
 
-      it "returns results (possibly 0) when the user asks for a valid value to a custom facet query", integration: true do
+      it "returns results (possibly 0) when the user asks for a valid value to a custom facet query", :integration do
         get :index, params: { f: { example_query_facet_field: ['years_25'] } } # valid custom facet value with some results
         expect(assigns(:response).docs).not_to be_empty
       end
@@ -74,7 +74,7 @@ RSpec.describe CatalogController, api: true do
         expect(assigns(:response).docs).to be_empty
       end
 
-      it "has a spelling suggestion for an appropriately poor query", integration: true do
+      it "has a spelling suggestion for an appropriately poor query", :integration do
         get :index, params: { q: 'boo' }
         expect(assigns(:response).spelling.words).not_to be_nil
       end
@@ -95,12 +95,12 @@ RSpec.describe CatalogController, api: true do
 
       # check with no user manipulation
       describe "for default query" do
-        it "gets documents when no query", integration: true do
+        it "gets documents when no query", :integration do
           get :index
           expect(assigns(:response).docs).not_to be_empty
         end
 
-        it "gets facets when no query", integration: true do
+        it "gets facets when no query", :integration do
           get :index
           assert_facets_have_values(assigns(:response).aggregations)
         end
@@ -113,14 +113,14 @@ RSpec.describe CatalogController, api: true do
       end
 
       # NOTE: status code is always 200 in isolation mode ...
-      it "HTTP status code for GET should be 200", integration: true do
+      it "HTTP status code for GET should be 200", :integration do
         get :index
         expect(response).to be_successful
       end
     end
 
     describe "with format :rss" do
-      it "gets the feed", integration: true do
+      it "gets the feed", :integration do
         get :index, params: { format: 'rss' }
         expect(response).to be_successful
       end
@@ -133,7 +133,7 @@ RSpec.describe CatalogController, api: true do
         expect(response).to be_successful
       end
 
-      let(:json) { JSON.parse(response.body) }
+      let(:json) { response.parsed_body }
       let(:pages)  { json['meta']['pages'] }
       let(:docs)   { json['data'] }
       let(:facets) { json['included'].select { |x| x['type'] == 'facet' } }
@@ -251,7 +251,7 @@ RSpec.describe CatalogController, api: true do
 
     it "HTTP status code for redirect should be 303" do
       put :track, params: { id: doc_id, counter: 3 }
-      expect(response.status).to eq 303
+      expect(response).to have_http_status :see_other
     end
 
     it "redirects to the path given in the redirect param" do
@@ -285,7 +285,7 @@ RSpec.describe CatalogController, api: true do
       it "gets the raw solr document" do
         get :raw, params: { id: doc_id, format: 'json' }
         expect(response).to be_successful
-        json = JSON.parse response.body
+        json = response.parsed_body
         expect(json.keys).to match_array(
           %w[id _version_ author_addl_tsim author_tsim format isbn_ssim
              language_ssim lc_1letter_ssim lc_alpha_ssim lc_b4cutter_ssim
@@ -310,7 +310,7 @@ RSpec.describe CatalogController, api: true do
   # SHOW ACTION
   describe "show action" do
     describe "with format :html" do
-      it "gets document", integration: true do
+      it "gets document", :integration do
         get :show, params: { id: doc_id }
         expect(assigns[:document]).not_to be_nil
       end
@@ -321,7 +321,7 @@ RSpec.describe CatalogController, api: true do
       it "gets the feed" do
         get :show, params: { id: doc_id, format: 'json' }
         expect(response).to be_successful
-        json = JSON.parse response.body
+        json = response.parsed_body
         expect(json["data"]["attributes"].keys).to match_array(
           %w[author_tsim format isbn_ssim language_ssim lc_callnum_ssim
              published_ssim subtitle_tsim title title_tsim url_suppl_ssim]
@@ -335,9 +335,8 @@ RSpec.describe CatalogController, api: true do
 
       before do
         allow(mock_document).to receive_messages(export_formats: {})
-        allow(controller).to receive(:search_service).and_return(search_service)
         expect(search_service).to receive(:fetch).and_return(mock_document)
-        allow(controller).to receive(:current_search_session).and_return(current_search)
+        allow(controller).to receive_messages(search_service: search_service, current_search_session: current_search)
       end
 
       context 'if counter is present in session' do
@@ -389,7 +388,7 @@ RSpec.describe CatalogController, api: true do
     end
 
     # NOTE: status code is always 200 in isolation mode ...
-    it "HTTP status code for GET should be 200", integration: true do
+    it "HTTP status code for GET should be 200", :integration do
       get :show, params: { id: doc_id }
       expect(response).to be_successful
     end
@@ -612,10 +611,10 @@ RSpec.describe CatalogController, api: true do
       it "is successful" do
         get :facet, params: { id: 'format' }
         expect(response).to be_successful
-        expect(assigns[:response]).to be_kind_of Blacklight::Solr::Response
-        expect(assigns[:facet]).to be_kind_of Blacklight::Configuration::FacetField
-        expect(assigns[:display_facet]).to be_kind_of Blacklight::Solr::Response::Facets::FacetField
-        expect(assigns[:pagination]).to be_kind_of Blacklight::Solr::FacetPaginator
+        expect(assigns[:response]).to be_a Blacklight::Solr::Response
+        expect(assigns[:facet]).to be_a Blacklight::Configuration::FacetField
+        expect(assigns[:display_facet]).to be_a Blacklight::Solr::Response::Facets::FacetField
+        expect(assigns[:pagination]).to be_a Blacklight::Solr::FacetPaginator
       end
     end
 
@@ -624,7 +623,7 @@ RSpec.describe CatalogController, api: true do
       it "is successful" do
         get :facet, params: { id: 'format', format: 'json' }
         expect(response).to be_successful
-        json = JSON.parse(response.body)
+        json = response.parsed_body
         expect(json["response"]["facets"]["items"].first["value"]).to eq 'Book'
       end
     end
@@ -639,7 +638,7 @@ RSpec.describe CatalogController, api: true do
 
         expect(response).to be_successful
 
-        expect(assigns[:facet]).to be_kind_of Blacklight::Configuration::FacetField
+        expect(assigns[:facet]).to be_a Blacklight::Configuration::FacetField
         expect(assigns[:facet].key).to eq 'params_key'
         expect(assigns[:facet].field).to eq 'format'
 
@@ -741,8 +740,7 @@ RSpec.describe CatalogController, api: true do
   describe "#add_show_tools_partial", api: false do
     before do
       described_class.blacklight_config.add_show_tools_partial(:like, callback: :perform_like, validator: :validate_like_params)
-      allow(controller).to receive(:solr_document_url).and_return('http://test.host/catalog/1')
-      allow(controller).to receive(:action_documents).and_return(1)
+      allow(controller).to receive_messages(solr_document_url: 'http://test.host/catalog/1', action_documents: 1)
       Rails.application.routes.draw do
         get 'catalog/like', as: :catalog_like
       end
@@ -796,7 +794,7 @@ RSpec.describe CatalogController, api: true do
   end
 
   describe "page_links" do
-    it "has prev/next docs and result set data for non-empty result sets", integration: true do
+    it "has prev/next docs and result set data for non-empty result sets", :integration do
       get :page_links, params: { f: { "format" => 'Book' }, counter: 2 }
       expect(assigns(:page_link_data)).not_to be_empty
       expect(assigns(:page_link_data).fetch(:prev, nil)).to end_with('counter=1')
@@ -804,7 +802,7 @@ RSpec.describe CatalogController, api: true do
       expect(assigns(:page_link_data).fetch(:totalRaw, nil)).to be 30
     end
 
-    it "is empty for empty result sets", integration: true do
+    it "is empty for empty result sets", :integration do
       get :page_links, params: { f: { "format" => 'empty-result-set' }, counter: 1 }
       expect(assigns(:page_link_data)).to be_empty
     end

data/spec/features/advanced_search_spec.rb

@@ -27,16 +27,16 @@ RSpec.describe "Blacklight Advanced Search Form" do
     end
 
     it "has field and facet blocks" do
-      expect(page).to have_selector('.query-criteria')
-      expect(page).to have_selector('.limit-criteria')
+      expect(page).to have_css('.query-criteria')
+      expect(page).to have_css('.limit-criteria')
     end
 
     describe "query column" do
       it "gives the user a choice between and/or queries" do
-        expect(page).to have_selector('#op')
+        expect(page).to have_css('#op')
         within('#op') do
-          expect(page).to have_selector('option[value="must"]')
-          expect(page).to have_selector('option[value="should"]')
+          expect(page).to have_css('option[value="must"]')
+          expect(page).to have_css('option[value="should"]')
         end
       end
 
@@ -50,7 +50,7 @@ RSpec.describe "Blacklight Advanced Search Form" do
 
     describe "facet column" do
       it "lists facets" do
-        expect(page).to have_selector('.blacklight-language_ssim')
+        expect(page).to have_css('.blacklight-language_ssim')
 
         within('.blacklight-language_ssim') do
           expect(page).to have_content 'Language'
@@ -63,7 +63,7 @@ RSpec.describe "Blacklight Advanced Search Form" do
       click_on 'advanced-search-submit'
       expect(page).to have_content 'Remove constraint Title: Medicine'
       expect(page).to have_content 'Strong Medicine speaks'
-      expect(page).to have_selector('article.document', count: 1)
+      expect(page).to have_css('article.document', count: 1)
     end
 
     it 'can limit to facets' do
@@ -72,16 +72,16 @@ RSpec.describe "Blacklight Advanced Search Form" do
       check 'Urdu 3'
       click_on 'advanced-search-submit'
       expect(page).to have_content 'Pākistānī ʻaurat dorāhe par'
-      expect(page).not_to have_content 'Ajikto kŭrŏk chŏrŏk sasimnikka : and 아직도　그럭　저럭　사십니까'
-      expect(page).to have_selector('article.document', count: 1)
+      expect(page).to have_no_content 'Ajikto kŭrŏk chŏrŏk sasimnikka : and 아직도　그럭　저럭　사십니까'
+      expect(page).to have_css('article.document', count: 1)
     end
 
     it 'handles boolean queries' do
       fill_in 'All Fields', with: 'history NOT strong'
       click_on 'advanced-search-submit'
       expect(page).to have_content('Ci an zhou bian')
-      expect(page).not_to have_content('Strong Medicine speaks')
-      expect(page).to have_selector('article.document', count: 10)
+      expect(page).to have_no_content('Strong Medicine speaks')
+      expect(page).to have_css('article.document', count: 10)
     end
 
     it 'handles queries in multiple fields with the ALL operator' do
@@ -89,7 +89,7 @@ RSpec.describe "Blacklight Advanced Search Form" do
       fill_in 'Author', with: 'hearth'
       click_on 'advanced-search-submit'
       expect(page).to have_content('Strong Medicine speaks')
-      expect(page).to have_selector('article.document', count: 1)
+      expect(page).to have_css('article.document', count: 1)
     end
 
     it 'handles queries in multiple fields with the ANY operator' do
@@ -99,17 +99,29 @@ RSpec.describe "Blacklight Advanced Search Form" do
       click_on 'advanced-search-submit'
       expect(page).to have_content('Ci an zhou bian')
       expect(page).to have_content('Pākistānī ʻaurat dorāhe par')
-      expect(page).to have_selector('article.document', count: 10)
+      expect(page).to have_css('article.document', count: 10)
     end
   end
 
   describe "prepopulated advanced search form" do
     before do
-      visit '/catalog/advanced?op=must&clause[0][field]=title&clause[0]query=medicine'
+      visit '/catalog/advanced?op=must&clause[1][field]=title&clause[1]query=medicine&f_inclusive[language_ssim][]=Tibetan&sort=author'
     end
 
-    it "does not create hidden inputs for search fields" do
+    it 'prepopulates the expected fields' do
       expect(page).to have_field 'Title', with: 'medicine'
+      expect(page).to have_field 'Tibetan', checked: true
+      expect(page).to have_select 'op', selected: 'all'
+      expect(page).to have_select 'sort', selected: 'author'
+    end
+
+    it "does not create hidden inputs for fields included in adv search form" do
+      within('form.advanced') do
+        expect(page).to have_no_field('clause[1][query]', type: :hidden, with: 'medicine')
+        expect(page).to have_no_field('f_inclusive[language_ssim][]', type: :hidden, with: 'Tibetan')
+        expect(page).to have_no_field('op', type: :hidden, with: 'must')
+        expect(page).to have_no_field('sort', type: :hidden, with: 'author')
+      end
     end
 
     it "does not have multiple parameters for a search field" do
@@ -121,8 +133,10 @@ RSpec.describe "Blacklight Advanced Search Form" do
 
     it "clears the prepopulated fields when the Start Over button is pressed" do
       expect(page).to have_field 'Title', with: 'medicine'
+      expect(page).to have_field 'Tibetan', checked: true
       click_on 'Start over'
-      expect(page).not_to have_field 'Title', with: 'medicine'
+      expect(page).to have_no_field 'Title', with: 'medicine'
+      expect(page).to have_no_field 'Tibetan', checked: true
     end
   end
 end

data/spec/features/alternate_controller_spec.rb

@@ -3,9 +3,9 @@
 RSpec.describe "Alternate Controller Behaviors" do
   it "has the correct per-page form" do
     visit search_alternate_path
-    expect(page).to have_selector("form[action='#{search_alternate_url}']")
+    expect(page).to have_css("form[action='#{search_alternate_url}']")
     fill_in "q", with: "history"
-    click_button 'search'
+    click_on 'search'
     expect(current_path).to match /#{search_alternate_path}/
     within "#per_page-dropdown .dropdown-menu" do
       click_on '10 per page'
@@ -15,9 +15,9 @@ RSpec.describe "Alternate Controller Behaviors" do
 
   it "has the correct search field form" do
     visit search_alternate_path
-    expect(page).to have_selector("form[action='#{search_alternate_url}']")
+    expect(page).to have_css("form[action='#{search_alternate_url}']")
     fill_in "q", with: "history"
-    click_button 'search'
+    click_on 'search'
     expect(current_path).to match /#{search_alternate_path}/
     click_on 'relevance'
     expect(current_path).to match /#{search_alternate_path}/
@@ -25,11 +25,11 @@ RSpec.describe "Alternate Controller Behaviors" do
 
   it "displays document thumbnails" do
     visit search_alternate_path
-    expect(page).to have_selector("form[action='#{search_alternate_url}']")
+    expect(page).to have_css("form[action='#{search_alternate_url}']")
     fill_in "q", with: "history"
-    click_button 'search'
-    expect(page).to have_selector ".document-thumbnail"
-    expect(page).to have_selector ".document-thumbnail a[data-context-href]"
-    expect(page).to have_selector ".document-thumbnail a img"
+    click_on 'search'
+    expect(page).to have_css ".document-thumbnail"
+    expect(page).to have_css ".document-thumbnail a[data-context-href]"
+    expect(page).to have_css ".document-thumbnail a img"
   end
 end

data/spec/features/axe_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe 'Accessibility testing', api: false, js: true do
+RSpec.describe 'Accessibility testing', :js, api: false do
   it 'validates the home page' do
     visit root_path
     expect(page).to be_accessible
@@ -9,13 +9,13 @@ RSpec.describe 'Accessibility testing', api: false, js: true do
   it 'validates the catalog page' do
     visit root_path
     fill_in "q", with: 'history'
-    click_button 'search'
+    click_on 'search'
 
     expect(page).to be_accessible
 
     within '.card.blacklight-language_ssim' do
-      click_button 'Language'
-      click_link "Tibetan"
+      click_on 'Language'
+      click_on "Tibetan"
     end
 
     expect(page).to be_accessible

data/spec/features/bookmarks_spec.rb

@@ -5,16 +5,16 @@ RSpec.describe "Bookmarks" do
     it "has a link to the history page" do
       sign_in 'user1'
       visit root_path
-      click_link 'Bookmarks'
+      click_on 'Bookmarks'
       expect(page).to have_content 'You have no bookmarks'
     end
   end
 
   it "clears bookmarks" do
     visit solr_document_path('2007020969')
-    click_button 'Bookmark'
-    click_link 'Bookmarks'
-    click_link 'Clear Bookmarks'
+    click_on 'Bookmark'
+    click_on 'Bookmarks'
+    click_on 'Clear Bookmarks'
     expect(page).to have_content 'Cleared your bookmarks.'
     expect(page).to have_content 'You have no bookmarks'
   end
@@ -23,24 +23,24 @@ RSpec.describe "Bookmarks" do
     sign_in 'user1'
     visit root_path
     fill_in "q", with: 'Sumadhvavijayaḥ'
-    click_button 'search'
-    click_button 'Bookmark'
+    click_on 'search'
+    click_on 'Bookmark'
     expect(page).to have_content 'Successfully added bookmark.'
     fill_in "q", with: 'Sumadhvavijayaḥ'
-    click_button 'search'
-    click_button 'Remove bookmark'
+    click_on 'search'
+    click_on 'Remove bookmark'
     expect(page).to have_content 'Successfully removed bookmark.'
   end
 
   it "adds and delete bookmarks from the show page" do
     sign_in 'user1'
     visit solr_document_path('2007020969')
-    click_button 'Bookmark'
-    click_button 'Remove bookmark'
+    click_on 'Bookmark'
+    click_on 'Remove bookmark'
     expect(page).to have_content 'Successfully removed bookmark.'
   end
 
-  it 'shows bookmarks as checkboxes', js: true do
+  it 'shows bookmarks as checkboxes', :js do
     visit solr_document_path('2007020969')
     check 'Bookmark'
 
@@ -51,7 +51,7 @@ RSpec.describe "Bookmarks" do
 
   it "adds bookmarks after a user logs in" do
     visit solr_document_path('2007020969')
-    click_button 'Bookmark'
+    click_on 'Bookmark'
     sign_in 'user1'
     visit bookmarks_path
     expect(page).to have_button("Remove bookmark")
@@ -60,25 +60,40 @@ RSpec.describe "Bookmarks" do
 
   it "cites items in bookmarks" do
     visit solr_document_path('2007020969')
-    click_button 'Bookmark'
-    click_link 'Bookmarks'
-    click_link 'Cite'
+    click_on 'Bookmark'
+    click_on 'Bookmarks'
+    click_on 'Cite'
     expect(page).to have_content 'Strong Medicine speaks'
   end
 
   it "cites all items in current bookmarks" do
     visit solr_document_path('2009373513') # Ci an zhou bian
-    click_button 'Bookmark'
+    click_on 'Bookmark'
 
     visit solr_document_path('2007020969') # Strong Medicine speaks
-    click_button 'Bookmark'
+    click_on 'Bookmark'
 
     visit "/bookmarks?per_page=1"
     expect(page).to have_content 'Strong Medicine speaks'
-    expect(page).not_to have_content 'Ci an zhou bian'
+    expect(page).to have_no_content 'Ci an zhou bian'
 
-    click_link 'Cite'
+    click_on 'Cite'
     expect(page).to have_content 'Strong Medicine speaks'
     expect(page).to have_content 'Ci an zhou bian'
   end
+
+  context "has bookmark icon" do
+    before do
+      CatalogController.blacklight_config.bookmark_icon_component = Blacklight::Icons::BookmarkIconComponent
+    end
+
+    it 'shows bookmark icon instead of checkbox', :js do
+      visit solr_document_path('2007020969')
+      expect(page).to have_css('.blacklight-icons-bookmark')
+      find('.blacklight-icons-bookmark').click
+
+      expect(find('.toggle-bookmark[type="checkbox"]', visible: false)).to be_checked
+      find('.blacklight-icons-bookmark').click
+    end
+  end
 end

data/spec/features/citation_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe 'Citation functionality' do
   before { visit solr_document_path('2007020969') }
 
   it 'displays the Cite modal with expected header' do
-    click_link 'Cite'
+    click_on 'Cite'
     expect(find('div.modal-header')).to have_text 'Cite'
   end
 end