blacklight 7.37.0 → 8.0.0.beta1

data/spec/presenters/blacklight/facet_item_presenter_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Blacklight::FacetItemPresenter, type: :presenter do
@@ -7,22 +8,22 @@ RSpec.describe Blacklight::FacetItemPresenter, type: :presenter do
   end
 
   let(:facet_item) { instance_double(Blacklight::Solr::Response::Facets::FacetItem) }
+  let(:filter_field) { instance_double(Blacklight::SearchState::FilterField, include?: true) }
   let(:facet_config) { Blacklight::Configuration::FacetField.new(key: 'key') }
   let(:facet_field) { instance_double(Blacklight::Solr::Response::Facets::FacetField) }
   let(:view_context) { controller.view_context }
-  let(:search_state) { instance_double(Blacklight::SearchState) }
+  let(:search_state) { instance_double(Blacklight::SearchState, filter: filter_field) }
 
   describe '#selected?' do
-    it 'works' do
-      allow(search_state).to receive(:has_facet?).and_return(true)
-      expect(presenter.selected?).to be true
-    end
+    subject { presenter.selected? }
+
+    it { is_expected.to be true }
   end
 
   describe '#label' do
-    it "is the facet value for an ordinary facet" do
+    it "is the stringified facet value for an ordinary facet" do
       allow(facet_config).to receive_messages(query: nil, date: nil, helper_method: nil, url_method: nil)
-      expect(presenter.label).to eq facet_item
+      expect(presenter.label).to eq facet_item.to_s
     end
 
     it "allows you to pass in a :helper_method argument to the configuration" do
@@ -63,9 +64,7 @@ RSpec.describe Blacklight::FacetItemPresenter, type: :presenter do
   end
 
   describe '#href' do
-    before do
-      allow(search_state).to receive(:has_facet?).and_return(false)
-    end
+    let(:filter_field) { instance_double(Blacklight::SearchState::FilterField, include?: false) }
 
     it 'is the url to apply the facet' do
       allow(search_state).to receive(:add_facet_params_and_redirect).with('key', facet_item).and_return(f: 'x')
@@ -87,11 +86,13 @@ RSpec.describe Blacklight::FacetItemPresenter, type: :presenter do
     end
 
     context 'with a selected facet' do
-      it 'is the url to remove the facet' do
-        allow(search_state).to receive(:has_facet?).and_return(true)
-        allow(search_state).to receive(:remove_facet_params).with('key', facet_item).and_return({})
+      let(:filter_field) { instance_double(Blacklight::SearchState::FilterField, include?: true, remove: {}) }
+
+      before do
         allow(view_context).to receive(:search_action_path).with({}).and_return('/catalog')
+      end
 
+      it 'is the url to remove the facet' do
         expect(presenter.href).to eq '/catalog'
       end
     end

data/spec/presenters/blacklight/field_presenter_spec.rb

@@ -36,7 +36,6 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
       config.add_index_field 'solr_doc_accessor', accessor: true
       config.add_index_field 'explicit_accessor', accessor: :solr_doc_accessor
       config.add_index_field 'explicit_array_accessor', accessor: [:solr_doc_accessor, :some_method]
-      config.add_index_field 'explicit_values', values: ->(_config, _doc) { ['some-value'] }
       config.add_index_field 'explicit_values_with_context', values: ->(_config, _doc, view_context) { [view_context.params[:x]] }
       config.add_index_field 'alias', field: 'qwer'
       config.add_index_field 'with_default', default: 'value'
@@ -162,15 +161,6 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
       end
     end
 
-    context 'when the values lambda is provided' do
-      let(:field_name) { 'explicit_values' }
-
-      it 'calls the accessors on the return of the preceeding' do
-        allow(Deprecation).to receive(:warn)
-        expect(subject).to eq 'some-value'
-      end
-    end
-
     context 'when the values lambda is provided and accepts the view contexts' do
       let(:field_name) { 'explicit_values_with_context' }
 
@@ -241,10 +231,6 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
 
     let(:field_config) { double('field config', if: true, unless: false, except_operations: nil) }
 
-    before do
-      allow(presenter).to receive_messages(document_has_value?: true)
-    end
-
     it { is_expected.to be true }
 
     context 'when the view context says not to render the field' do

data/spec/presenters/blacklight/index_presenter_spec.rb

@@ -25,14 +25,12 @@ RSpec.describe Blacklight::IndexPresenter, api: true do
   end
 
   describe '#fields' do
-    let(:field) { instance_double(Blacklight::Configuration::Field) }
-
     before do
-      allow(config).to receive(:index_fields_for).and_return(title: field)
+      config.add_index_field 'title'
     end
 
     it 'returns the list from the configs' do
-      expect(subject.send(:fields)).to eq(title: field)
+      expect(subject.send(:fields).keys).to eq ['title']
     end
   end
 

data/spec/presenters/blacklight/json_presenter_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Blacklight::JsonPresenter, api: true do

data/spec/presenters/blacklight/link_alternate_presenter_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Blacklight::LinkAlternatePresenter do
@@ -25,8 +26,8 @@ RSpec.describe Blacklight::LinkAlternatePresenter do
 
     let(:expected_html) do
       '<link rel="alternate" title="xml" type="application/xml" href="http://test.host/catalog/9999.xml" />' \
-      '<link rel="alternate" title="dc_xml" type="text/xml" href="http://test.host/catalog/9999.dc_xml" />' \
-      '<link rel="alternate" title="oai_dc_xml" type="text/xml" href="http://test.host/catalog/9999.oai_dc_xml" />'
+        '<link rel="alternate" title="dc_xml" type="text/xml" href="http://test.host/catalog/9999.dc_xml" />' \
+        '<link rel="alternate" title="oai_dc_xml" type="text/xml" href="http://test.host/catalog/9999.oai_dc_xml" />'
     end
 
     it { is_expected.to be_equivalent_to expected_html }

data/spec/presenters/blacklight/show_presenter_spec.rb

@@ -14,10 +14,7 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
   let(:search_state) { Blacklight::SearchState.new(params, config, controller) }
 
   let(:document) do
-    SolrDocument.new(id: 1,
-                     'link_to_facet_true' => 'x',
-                     'link_to_facet_named' => 'x',
-                     'qwer' => 'document qwer value')
+    SolrDocument.new(id: 'xyz', some_field: 'value')
   end
 
   before do
@@ -52,6 +49,10 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
 
       MockDocument.use_extension(MockExtension)
 
+      def mock_document_app_helper_url *args
+        solr_document_url(*args)
+      end
+
       allow(request_context).to receive(:polymorphic_url) do |_, opts|
         "url.#{opts[:format]}"
       end
@@ -66,10 +67,12 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
         tmp_value = Capybara.ignore_hidden_elements
         Capybara.ignore_hidden_elements = false
         document.export_formats.each_pair do |format, _spec|
-          expect(subject).to have_selector("link[href$='.#{format}']", count: 1) do |tag|
-            expect(tag["rel"]).to eq "alternate"
-            expect(tag["title"]).to eq format.to_s
-            expect(tag["href"]).to eq "url.#{format}"
+          expect(subject).to have_selector("link[href$='.#{format}']") do |matches|
+            expect(matches).to have(1).match
+            tag = matches[0]
+            expect(tag.attributes["rel"].value).to eq "alternate"
+            expect(tag.attributes["title"].value).to eq format.to_s
+            expect(tag.attributes["href"].value).to eq mock_document_app_helper_url(document, format: format)
           end
         end
         Capybara.ignore_hidden_elements = tmp_value
@@ -102,43 +105,36 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
   end
 
   describe '#fields' do
-    let(:field) { instance_double(Blacklight::Configuration::Field) }
-
     before do
-      allow(config).to receive(:show_fields_for).and_return(title: field)
+      config.add_show_field 'title'
     end
 
     it 'returns the list from the configs' do
-      expect(subject.send(:fields)).to eq(title: field)
+      expect(subject.send(:fields).keys).to eq ['title']
     end
   end
 
   describe "#heading" do
     it "falls back to an id" do
-      allow(document).to receive(:[]).with('id').and_return "xyz"
       expect(subject.heading).to eq document.id
     end
 
     it "returns the value of the field" do
-      config.show.title_field = :x
-      allow(document).to receive(:has?).with(:x).and_return(true)
-      allow(document).to receive(:fetch).with(:x, nil).and_return("value")
+      config.show.title_field = 'some_field'
       expect(subject.heading).to eq "value"
     end
 
     it "returns the first present value" do
-      config.show.title_field = [:x, :y]
-      allow(document).to receive(:fetch).with(:x, nil).and_return(nil)
-      allow(document).to receive(:fetch).with(:y, nil).and_return("value")
+      config.show.title_field = %w[a_field_that_doesnt_exist some_field]
       expect(subject.heading).to eq "value"
     end
 
     it "can use explicit field configuration" do
-      config.show.title_field = Blacklight::Configuration::Field.new(field: 'x', values: ->(*_) { 'hardcoded' })
+      config.show.title_field = Blacklight::Configuration::DisplayField.new(field: 'x', values: ->(*_) { 'hardcoded' })
       expect(subject.heading).to eq 'hardcoded'
     end
 
-    context "when empty document" do
+    context "with an empty document" do
       let(:document) { SolrDocument.new({}) }
 
       it "returns an empty string as the heading" do
@@ -149,26 +145,21 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
 
   describe "#html_title" do
     it "falls back to an id" do
-      allow(document).to receive(:[]).with('id').and_return "xyz"
       expect(subject.html_title).to eq document.id
     end
 
     it "returns the value of the field" do
-      config.show.html_title_field = :x
-      allow(document).to receive(:has?).with(:x).and_return(true)
-      allow(document).to receive(:fetch).with(:x, nil).and_return("value")
+      config.show.html_title_field = 'some_field'
       expect(subject.html_title).to eq "value"
     end
 
     it "returns the first present value" do
-      config.show.html_title_field = [:x, :y]
-      allow(document).to receive(:fetch).with(:x, nil).and_return(nil)
-      allow(document).to receive(:fetch).with(:y, nil).and_return("value")
+      config.show.html_title_field = %w[a_field_that_doesnt_exist some_field]
       expect(subject.html_title).to eq "value"
     end
 
     it "can use explicit field configuration" do
-      config.show.html_title_field = Blacklight::Configuration::Field.new(field: 'x', values: ->(*_) { 'hardcoded' })
+      config.show.html_title_field = Blacklight::Configuration::DisplayField.new(field: 'x', values: ->(*_) { 'hardcoded' })
       expect(subject.html_title).to eq 'hardcoded'
     end
   end

data/spec/presenters/thumbnail_presenter_spec.rb

@@ -95,7 +95,7 @@ RSpec.describe Blacklight::ThumbnailPresenter do
           allow(view_context).to receive_messages(xyz: nil)
         end
 
-        it { is_expected.to be nil }
+        it { is_expected.to be_nil }
       end
     end
 

data/spec/requests/load_suggestions_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'GET /catalog/suggest' do
+  it 'returns suggestions' do
+    get '/catalog/suggest?q=new'
+    expect(response.body).to eq <<-RESULT
+  <li role="option"><span>new jersey</span></li>
+  <li role="option"><span>new jersey bridgeton biography</span></li>
+  <li role="option"><span>new jersey bridgeton history</span></li>
+  <li role="option"><span>new york</span></li>
+  <li role="option"><span>nuwākshūṭ</span></li>
+    RESULT
+  end
+end

data/spec/routing/catalog_routing_spec.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
 
 RSpec.describe "Routing" do
   describe "Paths Generated by Custom Routes:" do

data/spec/services/blacklight/search_service_spec.rb

@@ -55,10 +55,6 @@ RSpec.describe Blacklight::SearchService, api: true do
     describe 'for a sample query returning results' do
       let(:user_params) { { q: all_docs_query } }
 
-      before do
-        (@solr_response, @document_list) = service.search_results
-      end
-
       it "uses the configured request handler" do
         allow(blacklight_config).to receive(:default_solr_params).and_return(qt: 'custom_request_handler')
         allow(blacklight_solr).to receive(:send_and_receive) do |path, params|
@@ -69,23 +65,6 @@ RSpec.describe Blacklight::SearchService, api: true do
         end.and_return('response' => { 'docs' => [] })
         service.search_results
       end
-
-      it 'has a @response.docs list of the same size as @document_list' do
-        expect(@solr_response.docs).to have(@document_list.length).docs
-      end
-
-      it 'has @response.docs list representing same documents as SolrDocuments in @document_list' do
-        @solr_response.docs.each_index do |index|
-          mash = @solr_response.docs[index]
-          solr_document = @document_list[index]
-
-          expect(Set.new(mash.keys)).to eq Set.new(solr_document.keys)
-
-          mash.keys.each do |key|
-            expect(mash[key]).to eq solr_document[key]
-          end
-        end
-      end
     end
 
     describe "for a query returning a grouped response" do
@@ -95,12 +74,10 @@ RSpec.describe Blacklight::SearchService, api: true do
       before do
         blacklight_config.default_solr_params[:group] = true
         blacklight_config.default_solr_params[:'group.field'] = 'pub_date_si'
-        (@solr_response, @document_list) = service.search_results
       end
 
       it "returns a grouped response" do
-        expect(@document_list).to be_empty
-        expect(@solr_response).to be_a_kind_of Blacklight::Solr::Response::GroupResponse
+        expect(service.search_results).to be_a_kind_of Blacklight::Solr::Response::GroupResponse
       end
     end
 
@@ -112,13 +89,12 @@ RSpec.describe Blacklight::SearchService, api: true do
         allow(subject).to receive_messages grouped_key_for_results: 'title_si'
         blacklight_config.default_solr_params[:group] = true
         blacklight_config.default_solr_params[:'group.field'] = %w[pub_date_si title_si]
-        (@solr_response, @document_list) = service.search_results
       end
 
       it "returns a grouped response" do
-        expect(@document_list).to be_empty
-        expect(@solr_response).to be_a_kind_of Blacklight::Solr::Response::GroupResponse
-        expect(@solr_response.group_field).to eq "title_si"
+        solr_response = service.search_results
+        expect(solr_response).to be_a_kind_of Blacklight::Solr::Response::GroupResponse
+        expect(solr_response.group_field).to eq "title_si"
       end
     end
 
@@ -126,8 +102,7 @@ RSpec.describe Blacklight::SearchService, api: true do
       let(:user_params) { { q: all_docs_query, f: single_facet } }
 
       it 'has results' do
-        (solr_response, document_list) = service.search_results
-        expect(solr_response.docs).to have(document_list.size).results
+        solr_response = service.search_results
         expect(solr_response.docs).to have_at_least(1).result
       end
       # TODO: check that number of these results < number of results for all docs query
@@ -138,8 +113,7 @@ RSpec.describe Blacklight::SearchService, api: true do
       let(:user_params) { { q: no_docs_query } }
 
       it 'has no results and not raise error' do
-        (solr_response, document_list) = service.search_results
-        expect(document_list).to have(0).results
+        solr_response = service.search_results
         expect(solr_response.docs).to have(0).results
       end
     end
@@ -148,19 +122,17 @@ RSpec.describe Blacklight::SearchService, api: true do
       let(:user_params) { { q: no_docs_query, f: single_facet } }
 
       it 'has no results and not raise error' do
-        (solr_response, document_list) = service.search_results
-        expect(document_list).to have(0).results
+        solr_response = service.search_results
         expect(solr_response.docs).to have(0).results
       end
     end
 
     describe "for All Docs Query and Bad Facet" do
-      let(:bad_facet) { { format: '666' } }
+      let(:bad_facet) { { format: ['666'] } }
       let(:user_params) { { q: all_docs_query, f: bad_facet } }
 
       it 'has no results and not raise error' do
-        (solr_response, document_list) = service.search_results
-        expect(document_list).to have(0).results
+        solr_response = service.search_results
         expect(solr_response.docs).to have(0).results
       end
     end
@@ -182,7 +154,7 @@ RSpec.describe Blacklight::SearchService, api: true do
 
     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
+      expect(@facets.none? { |_k, v| v.nil? }).to be true
     end
 
     it 'has at least one value for each facet' do
@@ -199,13 +171,13 @@ RSpec.describe Blacklight::SearchService, api: true do
           break
         end
       end
-      expect(has_mult_values).to eq true
+      expect(has_mult_values).to be true
     end
 
     it 'has all value counts > 0' do
       @facets.each do |_key, facet|
         facet.items.each do |facet_vals|
-          expect(facet_vals.hits).to be > 0
+          expect(facet_vals.hits).to be_positive
         end
       end
     end
@@ -222,9 +194,8 @@ RSpec.describe Blacklight::SearchService, api: true do
     end
 
     it 'has number of results (per page) set in initializer, by default' do
-      (solr_response, document_list) = service.search_results
+      solr_response = service.search_results
       expect(solr_response.docs).to have(blacklight_config[:default_solr_params][:rows]).items
-      expect(document_list).to have(blacklight_config[:default_solr_params][:rows]).items
     end
 
     context "with per page requested" do
@@ -232,8 +203,7 @@ RSpec.describe Blacklight::SearchService, api: true do
       let(:num_results) { 3 }  # non-default value
 
       it 'gets number of results per page requested' do
-        (solr_response1, document_list1) = service.search_results
-        expect(document_list1).to have(num_results).docs
+        solr_response1 = service.search_results
         expect(solr_response1.docs).to have(num_results).docs
       end
     end
@@ -243,8 +213,7 @@ RSpec.describe Blacklight::SearchService, api: true do
       let(:num_results) { 4 }  # non-default value
 
       it 'gets number of rows requested' do
-        (solr_response1, document_list1) = service.search_results
-        expect(document_list1).to have(num_results).docs
+        solr_response1 = service.search_results
         expect(solr_response1.docs).to have(num_results).docs
       end
     end
@@ -277,8 +246,7 @@ RSpec.describe Blacklight::SearchService, api: true do
       let(:user_params) { { q: all_docs_query, page: page, rows: rows } }
 
       it 'has no results when prompted for page after last result' do
-        (solr_response3, document_list3) = service.search_results
-        expect(document_list3).to have(0).docs
+        solr_response3 = service.search_results
         expect(solr_response3.docs).to have(0).docs
       end
     end
@@ -301,8 +269,7 @@ RSpec.describe Blacklight::SearchService, api: true do
       let(:user_params) { { q: all_docs_query, page: page, rows: rows } }
 
       it 'has results available when asked for more than are in response' do
-        (solr_response5, document_list5) = service.search_results
-        expect(solr_response5.docs).to have(document_list5.length).docs
+        solr_response5 = service.search_results
         expect(solr_response5.docs).to have_at_least(1).doc
       end
     end
@@ -314,7 +281,7 @@ RSpec.describe Blacklight::SearchService, api: true do
     let(:bad_id) { 'redrum' }
 
     before do
-      @response2, @document = service.fetch(doc_id)
+      @document = service.fetch(doc_id)
     end
 
     it "raises Blacklight::RecordNotFound for an unknown id" do
@@ -327,10 +294,6 @@ RSpec.describe Blacklight::SearchService, api: true 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
@@ -339,18 +302,18 @@ RSpec.describe Blacklight::SearchService, api: true do
   describe 'Get multiple documents By Id', integration: true do
     let(:doc_id) { '2007020969' }
     let(:bad_id) { 'redrum' }
-    let(:response) { service.fetch([doc_id]).first }
+    let(:response) { service.fetch([doc_id]) }
 
     before do
       blacklight_config.fetch_many_document_params[:fl] = 'id,format'
     end
 
     it 'has the expected value in the id field' do
-      expect(response.documents.first.id).to eq doc_id
+      expect(response.first.id).to eq doc_id
     end
 
     it 'returns all the requested fields' do
-      expect(response.documents.first['format']).to eq ['Book']
+      expect(response.first['format']).to eq ['Book']
     end
   end
 
@@ -382,7 +345,7 @@ RSpec.describe Blacklight::SearchService, api: true do
     end
 
     context "for title search" do
-      let(:user_params) { { q: 'yehudiyam', qt: 'search', "spellcheck.dictionary": "title" } }
+      let(:user_params) { { q: 'yehudiyam', 'spellcheck.dictionary': "title" } }
 
       it 'has spelling suggestions' do
         (solr_response,) = service.search_results
@@ -391,7 +354,7 @@ RSpec.describe Blacklight::SearchService, api: true do
     end
 
     context "for author search" do
-      let(:user_params) { { q: 'shirma', qt: 'search', "spellcheck.dictionary": "author" } }
+      let(:user_params) { { q: 'shirma', 'spellcheck.dictionary': "author" } }
 
       it 'has spelling suggestions' do
         (solr_response,) = service.search_results
@@ -400,7 +363,7 @@ RSpec.describe Blacklight::SearchService, api: true do
     end
 
     context "for subject search" do
-      let(:user_params) { { q: 'wome', qt: 'search', "spellcheck.dictionary": "subject" } }
+      let(:user_params) { { q: 'wome', 'spellcheck.dictionary': "subject" } }
 
       it 'has spelling suggestions' do
         (solr_response,) = service.search_results
@@ -433,26 +396,26 @@ RSpec.describe Blacklight::SearchService, api: true do
     let(:user_params) { { q: '', per_page: 100 } }
 
     before do
-      @full_response, @all_docs = service.search_results
+      @full_response = service.search_results
     end
 
     it "returns the previous and next documents for a search" do
       _response, docs = service.previous_and_next_documents_for_search(4, q: '')
 
-      expect(docs.first.id).to eq @all_docs[3].id
-      expect(docs.last.id).to eq @all_docs[5].id
+      expect(docs.first.id).to eq @full_response.documents[3].id
+      expect(docs.last.id).to eq @full_response.documents[5].id
     end
 
     it "returns only the next document if the counter is 0" do
       _response, docs = service.previous_and_next_documents_for_search(0, q: '')
 
       expect(docs.first).to be_nil
-      expect(docs.last.id).to eq @all_docs[1].id
+      expect(docs.last.id).to eq @full_response.documents[1].id
     end
 
     it "returns only the previous document if the counter is the total number of documents" do
       _response, docs = service.previous_and_next_documents_for_search(@full_response.total - 1, q: '')
-      expect(docs.first.id).to eq @all_docs.slice(-2).id
+      expect(docs.first.id).to eq @full_response.documents.slice(-2).id
       expect(docs.last).to be_nil
     end
 
@@ -464,7 +427,7 @@ RSpec.describe Blacklight::SearchService, api: true do
 
     it 'returns only the unique key by default' do
       _response, docs = service.previous_and_next_documents_for_search(0, q: '')
-      expect(docs.last.to_h).to eq 'id' => @all_docs[1].id
+      expect(docs.last.to_h).to eq 'id' => @full_response.documents[1].id
     end
 
     it 'allows the query parameters to be customized using configuration' do
@@ -472,7 +435,7 @@ RSpec.describe Blacklight::SearchService, api: true do
 
       _response, docs = service.previous_and_next_documents_for_search(0, q: '')
 
-      expect(docs.last.to_h).to eq @all_docs[1].to_h.slice('id', 'format')
+      expect(docs.last.to_h).to eq @full_response.documents[1].to_h.slice('id', 'format')
     end
   end