blacklight 8.0.0.beta4 → 8.0.0.beta5

data/spec/components/blacklight/document_component_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::DocumentComponent, type: :component do
-  subject(:component) { described_class.new(document: document, presenter: view_context.document_presenter(document), **attr) }
+  subject(:component) { described_class.new(document: document, **attr) }
 
   let(:attr) { {} }
   let(:view_context) { controller.view_context }
@@ -15,7 +15,9 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     Capybara::Node::Simple.new(render)
   end
 
-  let(:document) do
+  let(:document) { view_context.document_presenter(presented_document) }
+
+  let(:presented_document) do
     SolrDocument.new(
       id: 'x',
       thumbnail_path_ss: 'http://example.com/image.jpg',
@@ -26,7 +28,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
 
   let(:blacklight_config) do
     CatalogController.blacklight_config.deep_copy.tap do |config|
-      config.track_search_session = false
+      config.track_search_session.storage = false
       config.index.thumbnail_field = 'thumbnail_path_ss'
       config.index.document_actions[:bookmark].partial = '/catalog/bookmark_control'
     end
@@ -92,9 +94,12 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     end
 
     context 'with a document rendered as part of a collection' do
-      let(:attr) { { document_counter: 10, counter_offset: 100 } }
+      # ViewComponent 3 changes iteration counters to begin at 0 rather than 1
+      let(:document_counter) { ViewComponent::VERSION::MAJOR < 3 ? 11 : 10 }
+      let(:attr) { { document_counter: document_counter, counter_offset: 100 } }
 
       it 'renders a counter with the title' do
+        # after ViewComponent 2.5, collection counter params are 1-indexed
         expect(rendered).to have_selector 'header', text: '111. Title'
       end
     end

data/spec/components/blacklight/search_context/server_applied_params_component_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::SearchContext::ServerAppliedParamsComponent, type: :component do
+  subject(:render) { instance.render_in(view_context) }
+
+  let(:instance) { described_class.new }
+  let(:current_search_session) { nil }
+  let(:view_context) { controller.view_context }
+
+  before do
+    view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for('application/_start_over.html.erb' => 'start over'))
+    allow(view_context).to receive(:current_search_session).and_return current_search_session
+    allow(view_context).to receive(:link_back_to_catalog).with(any_args)
+  end
+
+  it 'is blank without current session' do
+    expect(render).to be_blank
+  end
+
+  context 'with current session' do
+    let(:current_search_session) { double(query_params: { q: 'abc' }) }
+
+    it 'is not blank' do
+      expect(render).not_to be_blank
+    end
+  end
+end

data/spec/components/blacklight/{search_context_component_spec.rb → search_context/server_item_pagination_component_spec.rb}

@@ -2,14 +2,17 @@
 
 require 'spec_helper'
 
-RSpec.describe Blacklight::SearchContextComponent, type: :component do
+RSpec.describe Blacklight::SearchContext::ServerItemPaginationComponent, type: :component do
   subject(:render) { render_inline(instance) }
 
-  let(:search_session) { {} }
-  let(:instance) { described_class.new(search_context: search_context, search_session: search_session) }
+  let(:current_document_id) { 9 }
+  let(:current_document) { SolrDocument.new(id: current_document_id) }
+  let(:search_session) { { 'document_id' => current_document_id } }
+  let(:instance) { described_class.new(search_context: search_context, search_session: search_session, current_document: current_document) }
 
   before do
-    allow(controller).to receive(:current_search_session).and_return(double(id: 9))
+    allow(controller).to receive(:current_search_session).and_return(double(id: current_document_id))
+    controller.class.helper_method :current_search_session
   end
 
   context 'when there is no next or previous' do
@@ -36,5 +39,13 @@ RSpec.describe Blacklight::SearchContextComponent, type: :component do
     it "renders content" do
       expect(render.css('.pagination-search-widgets').to_html).not_to be_blank
     end
+
+    context "session and document are out of sync" do
+      let(:current_document) { SolrDocument.new(id: current_document_id + 1) }
+
+      it "does not render content" do
+        expect(render.to_html).to be_blank
+      end
+    end
   end
 end

data/spec/controllers/bookmarks_controller_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe BookmarksController do
     end
 
     it 'opts out of search session tracking' do
-      expect(@controller.blacklight_config.track_search_session).to be false
+      expect(@controller.blacklight_config.track_search_session.storage).to be false
     end
   end
 

data/spec/controllers/catalog_controller_spec.rb

@@ -468,17 +468,14 @@ RSpec.describe CatalogController, api: true do
   end
 
   describe "email/sms" do
+    let(:mock_document) { SolrDocument.new }
+
     before do
-      mock_document.extend(Blacklight::Document::Sms)
-      mock_document.extend(Blacklight::Document::Email)
-      allow(mock_document).to receive(:to_semantic_values).and_return({})
       allow(mock_document).to receive(:to_model).and_return(SolrDocument.new(id: 'my_fake_doc'))
 
       allow(controller).to receive(:search_service).and_return(search_service)
       expect(search_service).to receive(:fetch).and_return([mock_document])
       request.env["HTTP_REFERER"] = "/catalog/#{doc_id}"
-      SolrDocument.use_extension(Blacklight::Document::Email)
-      SolrDocument.use_extension(Blacklight::Document::Sms)
     end
 
     describe "email", api: false do
@@ -797,6 +794,21 @@ RSpec.describe CatalogController, api: true do
       expect(controller.send(:search_facet_path, id: "some_facet", page: 5)).to eq facet_catalog_path(id: "some_facet")
     end
   end
+
+  describe "page_links" do
+    it "has prev/next docs and result set data for non-empty result sets", integration: true 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')
+      expect(assigns(:page_link_data).fetch(:next, nil)).to end_with('counter=3')
+      expect(assigns(:page_link_data).fetch(:totalRaw, nil)).to be 30
+    end
+
+    it "is empty for empty result sets", integration: true do
+      get :page_links, params: { f: { "format" => 'empty-result-set' }, counter: 1 }
+      expect(assigns(:page_link_data)).to be_empty
+    end
+  end
 end
 
 # there must be at least one facet, and each facet must have at least one value

data/spec/features/component_template_override_spec.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+RSpec.describe 'Generated test application template at default path' do
+  it 'unobtrusively overrides default top navbar component template' do
+    visit root_path
+    expect(page).to have_css 'nav[data-template-override="top_navbar_component"]'
+  end
+end

data/spec/features/modal_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+RSpec.describe 'Modal' do
+  it 'can open and dismiss the email modal', js: true do
+    visit solr_document_path('2007020969')
+    expect(page).to have_no_selector 'dialog#blacklight-modal'
+    click_link 'Email'
+    expect(page).to have_selector 'dialog#blacklight-modal'
+    click_button '×'
+    expect(page).to have_no_selector 'dialog#blacklight-modal'
+  end
+end

data/spec/helpers/blacklight/url_helper_behavior_spec.rb

@@ -187,7 +187,7 @@ RSpec.describe Blacklight::UrlHelperBehavior do
     end
 
     it "uses the track_search_session configuration to determine whether to track the search session" do
-      blacklight_config.track_search_session = false
+      blacklight_config.track_search_session.storage = false
       expect(helper.session_tracking_path(document, x: 1)).to be_nil
     end
   end

data/spec/helpers/blacklight_helper_spec.rb

@@ -134,18 +134,6 @@ RSpec.describe BlacklightHelper do
     end
   end
 
-  describe "render_grouped_response?" do
-    it "checks if the response ivar contains grouped data" do
-      assign(:response, instance_double(Blacklight::Solr::Response, grouped?: true))
-      expect(helper.render_grouped_response?).to be true
-    end
-
-    it "checks if the response param contains grouped data" do
-      response = instance_double(Blacklight::Solr::Response, grouped?: true)
-      expect(helper.render_grouped_response?(response)).to be true
-    end
-  end
-
   describe "#opensearch_description_tag" do
     subject { helper.opensearch_description_tag 'title', 'href' }
 
@@ -210,48 +198,4 @@ RSpec.describe BlacklightHelper do
       end
     end
   end
-
-  describe "#document_index_view_type" do
-    it "defaults to the default view" do
-      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
-      allow(helper).to receive(:default_document_index_view_type).and_return(:xyz)
-      expect(helper.document_index_view_type).to eq :xyz
-    end
-
-    it "uses the query parameter" do
-      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
-      expect(helper.document_index_view_type(view: :a)).to eq :a
-    end
-
-    it "uses the default view if the requested view is not available" do
-      allow(helper).to receive(:default_document_index_view_type).and_return(:xyz)
-      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
-      expect(helper.document_index_view_type(view: :c)).to eq :xyz
-    end
-
-    context "when they have a preferred view" do
-      before do
-        session[:preferred_view] = :b
-      end
-
-      context "and no view is specified" do
-        it "uses the saved preference" do
-          allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2, c: 3)
-          expect(helper.document_index_view_type).to eq :b
-        end
-
-        it "uses the default view if the preference is not available" do
-          allow(helper).to receive(:document_index_views).and_return(a: 1)
-          expect(helper.document_index_view_type).to eq :a
-        end
-      end
-
-      context "and a view is specified" do
-        it "uses the query parameter" do
-          allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2, c: 3)
-          expect(helper.document_index_view_type(view: :c)).to eq :c
-        end
-      end
-    end
-  end
 end

data/spec/helpers/catalog_helper_spec.rb

@@ -284,4 +284,60 @@ RSpec.describe CatalogHelper do
       it { is_expected.to eq "foobar / Format: Book" }
     end
   end
+
+  describe "render_grouped_response?" do
+    it "checks if the response ivar contains grouped data" do
+      assign(:response, instance_double(Blacklight::Solr::Response, grouped?: true))
+      expect(helper.render_grouped_response?).to be true
+    end
+
+    it "checks if the response param contains grouped data" do
+      response = instance_double(Blacklight::Solr::Response, grouped?: true)
+      expect(helper.render_grouped_response?(response)).to be true
+    end
+  end
+
+  describe "#document_index_view_type" do
+    it "defaults to the default view" do
+      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
+      allow(helper).to receive(:default_document_index_view_type).and_return(:xyz)
+      expect(helper.document_index_view_type).to eq :xyz
+    end
+
+    it "uses the query parameter" do
+      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
+      expect(helper.document_index_view_type(view: :a)).to eq :a
+    end
+
+    it "uses the default view if the requested view is not available" do
+      allow(helper).to receive(:default_document_index_view_type).and_return(:xyz)
+      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
+      expect(helper.document_index_view_type(view: :c)).to eq :xyz
+    end
+
+    context "when they have a preferred view" do
+      before do
+        session[:preferred_view] = :b
+      end
+
+      context "and no view is specified" do
+        it "uses the saved preference" do
+          allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2, c: 3)
+          expect(helper.document_index_view_type).to eq :b
+        end
+
+        it "uses the default view if the preference is not available" do
+          allow(helper).to receive(:document_index_views).and_return(a: 1)
+          expect(helper.document_index_view_type).to eq :a
+        end
+      end
+
+      context "and a view is specified" do
+        it "uses the query parameter" do
+          allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2, c: 3)
+          expect(helper.document_index_view_type(view: :c)).to eq :c
+        end
+      end
+    end
+  end
 end

data/spec/lib/blacklight/configuration/session_tracking_config_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::Configuration::SessionTrackingConfig do
+  subject(:config) { described_class.new }
+
+  it "defaults @storage to 'server'" do
+    expect(config.storage).to eq 'server'
+  end
+
+  context "@storage is set to 'server'" do
+    before do
+      config.storage = 'server'
+    end
+
+    it "defaults components values" do
+      expect(config.applied_params_component).to eq Blacklight::SearchContext::ServerAppliedParamsComponent
+      expect(config.item_pagination_component).to eq Blacklight::SearchContext::ServerItemPaginationComponent
+    end
+
+    it "defaults tracking url helper" do
+      expect(config.url_helper).to be_nil
+    end
+  end
+
+  context "@storage is set to false" do
+    before do
+      config.storage = false
+    end
+
+    it "defaults components values" do
+      expect(config.applied_params_component).to be_nil
+    end
+
+    it "defaults tracking url helper" do
+      expect(config.url_helper).to be_nil
+    end
+  end
+end

data/spec/models/record_mailer_spec.rb

@@ -2,7 +2,16 @@
 
 RSpec.describe RecordMailer do
   let(:config) do
-    Blacklight::Configuration.new
+    Blacklight::Configuration.new do |config|
+      config.email.title_field = 'title_tsim'
+      config.add_email_field 'title_tsim', label: 'Title'
+      config.add_email_field "author_tsim", label: 'Author'
+      config.add_email_field "language_ssim", label: 'Language'
+      config.add_email_field "format", label: 'Format'
+
+      config.add_sms_field 'title_tsim', label: 'Title'
+      config.add_sms_field "author_tsim", label: 'Author'
+    end
   end
 
   let(:document) do
@@ -11,37 +20,38 @@ RSpec.describe RecordMailer do
 
   before do
     allow(described_class).to receive(:default).and_return(from: 'no-reply@projectblacklight.org')
-    SolrDocument.use_extension(Blacklight::Document::Email)
-    SolrDocument.use_extension(Blacklight::Document::Sms)
     @documents = [document]
   end
 
   describe "email" do
-    before do
-      details = { to: 'test@test.com', message: "This is my message", config: config }
-      @email = described_class.email_record(@documents, details, host: 'projectblacklight.org', protocol: 'https')
+    subject(:email) do
+      described_class.email_record(@documents, details, host: 'projectblacklight.org', protocol: 'https')
+    end
+
+    let(:details) do
+      { to: 'test@test.com', message: "This is my message", config: config }
     end
 
     it "receives the TO paramater and send the email to that address" do
-      expect(@email.to).to include 'test@test.com'
+      expect(email.to).to include 'test@test.com'
     end
 
     it "starts the subject w/ Item Record:" do
-      expect(@email.subject).to match /^Item Record:/
+      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/
+      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"
+      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/
+      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
@@ -53,28 +63,31 @@ RSpec.describe RecordMailer do
     context "email title_field is configured and multi valued" do
       let(:document) { SolrDocument.new(id: "123456", foo: ["Fizz Fizz", "Fuzz Fuzz"], format: ["book"], title_tsim: "The horn", language_ssim: "English", author_tsim: "Janetzky, Kurt") }
 
-      it "uses configured email title_field" do
+      before do
         config.email.title_field = "foo"
-        expect(@email.subject).to match("Fizz Fizz")
-        expect(@email.subject).not_to match("Fuzz Fuzz")
-        expect(@email.subject).not_to match("The horn")
+      end
+
+      it "uses configured email title_field" do
+        expect(email.subject).to eq 'Item Record: Fizz Fizz and Fuzz Fuzz'
       end
     end
 
     context "email title_field is configured and single valued" do
       let(:document) { SolrDocument.new(id: "123456", foo: "Fizz Fizz", format: ["book"], title_tsim: "The horn", language_ssim: "English", author_tsim: "Janetzky, Kurt") }
 
-      it "uses configured email title_field" do
+      before do
         config.email.title_field = "foo"
-        expect(@email.subject).to match("Fizz Fizz")
-        expect(@email.subject).not_to match("The horn")
+      end
+
+      it "uses configured email title_field" do
+        expect(email.subject).to eq 'Item Record: Fizz Fizz'
       end
     end
   end
 
   describe "SMS" do
     before do
-      details = { to: '5555555555@txt.att.net' }
+      details = { to: '5555555555@txt.att.net', config: config }
       @sms = described_class.sms_record(@documents, details, host: 'projectblacklight.org:3000')
     end
 
@@ -91,8 +104,8 @@ RSpec.describe RecordMailer do
     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 /Title: The horn/
+      expect(@sms.body).to match /Author: Janetzky, Kurt/
       expect(@sms.body).to match /projectblacklight.org:3000/
     end
 

data/spec/presenters/blacklight/document_presenter_spec.rb

@@ -12,6 +12,7 @@ RSpec.describe Blacklight::DocumentPresenter do
 
   before do
     allow(request_context).to receive(:search_state).and_return(search_state)
+    allow(request_context).to receive(:action_name).and_return(:show)
   end
 
   describe '#fields_to_render' do

data/spec/presenters/blacklight/field_presenter_spec.rb

@@ -51,13 +51,13 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
     context 'when an explicit html value is provided' do
       let(:options) { { value: '<b>val1</b>' } }
 
-      it { is_expected.to eq '&lt;b&gt;val1&lt;/b&gt;' }
+      it { is_expected.not_to be_html_safe }
     end
 
     context 'when an explicit array value with unsafe characters is provided' do
       let(:options) { { value: ['<a', 'b'] } }
 
-      it { is_expected.to eq '&lt;a and b' }
+      it { is_expected.to eq('&lt;a and b').and be_html_safe }
     end
 
     context 'when an explicit array value is provided' do

data/spec/presenters/blacklight/index_presenter_spec.rb

@@ -22,6 +22,7 @@ RSpec.describe Blacklight::IndexPresenter, api: true do
 
   before do
     allow(request_context).to receive(:search_state).and_return(search_state)
+    allow(request_context).to receive(:action_name).and_return(:index)
   end
 
   describe '#fields' do

data/spec/presenters/blacklight/show_presenter_spec.rb

@@ -19,6 +19,7 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
 
   before do
     allow(request_context).to receive(:search_state).and_return(search_state)
+    allow(request_context).to receive(:action_name).and_return(:show)
   end
 
   describe "link_rel_alternates" do

data/spec/presenters/pipeline_spec.rb

@@ -4,10 +4,10 @@ RSpec.describe Blacklight::Rendering::Pipeline do
   include Capybara::RSpecMatchers
   let(:document) { instance_double(SolrDocument) }
   let(:context) { double }
-  let(:options) { double('options') }
+  let(:options) { {} }
 
   describe '.render' do
-    subject { described_class.render(values, field_config, document, context, options) }
+    subject(:rendered) { described_class.render(values, field_config, document, context, options) }
 
     let(:values) { %w[a b] }
     let(:field_config) { Blacklight::Configuration::NullField.new }
@@ -35,6 +35,17 @@ RSpec.describe Blacklight::Rendering::Pipeline do
       expect(described_class).to have_received(:new)
         .with(values, field_config, document, context, described_class.operations, options)
     end
+
+    context 'outside of an HTML context' do
+      let(:options) { { format: 'text' } }
+
+      let(:values) { ['"blah"', "<notatag>"] }
+      let(:field_config) { Blacklight::Configuration::NullField.new itemprop: 'some-prop' }
+
+      it 'does not HTML escape values or inject HTML tags' do
+        expect(rendered).to eq '"blah" and <notatag>'
+      end
+    end
   end
 
   describe '.operations' do

data/spec/routing/catalog_routing_spec.rb

@@ -24,6 +24,10 @@ RSpec.describe "Routing" do
     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
+
+    it "maps GET {:controller => 'catalog', :action => 'prev_next_documents'} to /catalog/page_links" do
+      expect(get: "/catalog/page_links").to route_to(controller: 'catalog', action: 'page_links')
+    end
   end
 
   describe "solr_document_path for SolrDocument", test: true do

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -34,4 +34,12 @@ class TestAppGenerator < Rails::Generators::Base
 
     run "yarn add #{Blacklight::Engine.root}"
   end
+
+  def add_component_template_override
+    src_template = File.join(Blacklight::Engine.root, 'app', 'components', 'blacklight', 'top_navbar_component.html.erb')
+    target_template = File.join('app', 'components', 'blacklight', 'top_navbar_component.html.erb')
+    create_file(target_template) do
+      File.read(src_template).gsub('role="navigation"', 'role="navigation" data-template-override="top_navbar_component"')
+    end
+  end
 end

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

@@ -19,7 +19,7 @@ RSpec.describe "catalog/_document" do
     stub_template "catalog/_a_default.html.erb" => "a_partial"
     stub_template "catalog/_b_default.html.erb" => "b_partial"
     stub_template "catalog/_c_default.html.erb" => "c_partial"
-    render partial: "catalog/document", locals: { document: document, document_counter: 1 }
+    render partial: "catalog/document", locals: { document: document, document_counter: 1, view_config: blacklight_config.index }
     expect(rendered).to match /a_partial/
     expect(rendered).to match /b_partial/
     expect(rendered).to match /c_partial/

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

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
 RSpec.describe "catalog/_document_list", type: :view do
+  let(:view_type) { 'some-view' }
+  let(:view_config) { double(Blacklight::Configuration::ViewConfig) }
+
   before do
-    allow(view).to receive_messages(document_index_view_type: "some-view", documents: [], blacklight_config: nil)
+    allow(view_config).to receive_messages(key: view_type, document_component: Blacklight::DocumentComponent, partials: [])
+    allow(view).to receive_messages(document_index_view_type: view_type, documents: [], blacklight_config: nil)
+    assign(:response, instance_double(Blacklight::Solr::Response, start: 0))
   end
 
   it "includes a class for the current view" do
-    render
+    render(partial: "catalog/document_list", locals: { view_config: view_config })
     expect(rendered).to have_selector(".documents-some-view")
   end
 end