blacklight 8.0.0.beta1 → 8.0.0

data/spec/models/blacklight/configuration_spec.rb

@@ -172,8 +172,8 @@ RSpec.describe "Blacklight::Configuration", api: true do
 
       expect(config.a[:value]).to eq 1
       expect(config_copy.a[:value]).to eq 2
-      expect(config.b).to match_array [1, 2, 3]
-      expect(config_copy.b).to match_array [1, 2, 3, 5]
+      expect(config.b).to contain_exactly(1, 2, 3)
+      expect(config_copy.b).to contain_exactly(1, 2, 3, 5)
       expect(config.c.value).to match_array %w[a b]
       expect(config_copy.c.value).to match_array %w[a b c]
     end

data/spec/models/blacklight/icon_spec.rb

@@ -12,8 +12,6 @@ RSpec.describe Blacklight::Icon do
     elsif defined?(Propshaft)
       allow(Rails.application.assets.load_path).to receive(:find).and_return(asset)
     end
-    # FileUtils.mkdir_p '.internal_test_app/app/assets/images/blacklight'
-    # File.write '.internal_test_app/app/assets/images/blacklight/test.svg', Blacklight::Icons::SearchComponent.new.svg
   end
 
   describe '#svg' do

data/spec/models/blacklight/search_builder_spec.rb

@@ -45,7 +45,7 @@ RSpec.describe Blacklight::SearchBuilder, api: true do
 
     it "is mutable" do
       subject.processor_chain.insert(-1, :d)
-      expect(subject.processor_chain).to match_array [:a, :b, :c, :d]
+      expect(subject.processor_chain).to contain_exactly(:a, :b, :c, :d)
     end
   end
 
@@ -56,7 +56,7 @@ RSpec.describe Blacklight::SearchBuilder, api: true do
       builder = subject.append(:d, :e)
       expect(subject.processor_chain).to eq processor_chain
       expect(builder.processor_chain).not_to eq subject.processor_chain
-      expect(builder.processor_chain).to match_array [:a, :b, :c, :d, :e]
+      expect(builder.processor_chain).to contain_exactly(:a, :b, :c, :d, :e)
     end
   end
 
@@ -68,7 +68,7 @@ RSpec.describe Blacklight::SearchBuilder, api: true do
       expect(builder).not_to equal(subject)
       expect(subject.processor_chain).to eq processor_chain
       expect(builder.processor_chain).not_to eq subject.processor_chain
-      expect(builder.processor_chain).to match_array [:a, :c, :e]
+      expect(builder.processor_chain).to contain_exactly(:a, :c, :e)
     end
   end
 

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

@@ -45,7 +45,7 @@ RSpec.describe Blacklight::Solr::Request, api: true do
       subject.append_query 'this is my query'
       subject.append_query 'another:query'
       expect(subject).not_to have_key 'q'
-      expect(subject.dig('json', 'query', 'bool', 'must')).to match_array ['this is my query', 'another:query']
+      expect(subject.dig('json', 'query', 'bool', 'must')).to contain_exactly('this is my query', 'another:query')
     end
   end
 
@@ -62,7 +62,7 @@ RSpec.describe Blacklight::Solr::Request, api: true do
       subject['q'] = 'some query'
       subject.append_boolean_query :must, 'also required'
 
-      expect(subject.dig('json', 'query', 'bool', 'must')).to match_array ['some query', 'also required']
+      expect(subject.dig('json', 'query', 'bool', 'must')).to contain_exactly('some query', 'also required')
     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/spec_helper.rb

@@ -68,7 +68,7 @@ RSpec.configure do |config|
   config.infer_spec_type_from_file_location!
   config.include PresenterTestHelpers, type: :presenter
   config.include ViewComponent::TestHelpers, type: :component
-  config.include ViewComponentCapybaraTestHelpers, type: :component
+  config.include ViewComponentTestHelpers, type: :component
 
   config.include(ControllerLevelHelpers, type: :helper)
   config.before(:each, type: :helper) { initialize_controller_helpers(helper) }

data/spec/support/view_component_test_helpers.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ViewComponentTestHelpers
+  # Work around for https://github.com/teamcapybara/capybara/issues/2466
+  def render_inline_to_capybara_node(component)
+    Capybara::Node::Simple.new(render_inline(component).to_s)
+  end
+
+  # Work-around for https://github.com/ViewComponent/view_component/pull/1661
+  # which made the component test's controller method (more) private. This makes
+  # it available so we can set up controller-level state for our tests.
+  def controller
+    # ViewComponent 2.x
+    return super if defined?(super)
+
+    # ViewComponent 3.x
+    return vc_test_controller if defined?(vc_test_controller)
+
+    ApplicationController.new.extend(Rails.application.routes.url_helpers)
+  end
+end

data/spec/test_app_templates/Gemfile.extra

@@ -1,2 +1,6 @@
 gem 'rails-controller-testing'
 gem 'thor', '~> 0.20' if /^5.[12]/.match?(ENV['RAILS_VERSION'])
+
+unless ENV['VIEW_COMPONENT_VERSION'].to_s == ""
+  gem 'view_component', ENV.fetch('VIEW_COMPONENT_VERSION')
+end

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,9 +19,30 @@ 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/
   end
+
+  context 'with a configured document component' do
+    let(:custom_component_class) do
+      Class.new(Blacklight::DocumentComponent) do
+        # Override component rendering with our own value
+        def call
+          'blah'
+        end
+      end
+    end
+
+    before do
+      stub_const('MyDocumentComponent', custom_component_class)
+      blacklight_config.index.document_component = MyDocumentComponent
+    end
+
+    it 'renders the document component' do
+      render partial: "catalog/document", locals: { document: document, document_counter: 1, view_config: blacklight_config.index }
+      expect(rendered).to match /blah/
+    end
+  end
 end

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

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

@@ -3,10 +3,10 @@
 RSpec.describe "catalog/_show_tools.html.erb" do
   let(:document) { SolrDocument.new id: 'xyz', format: 'a' }
   let(:blacklight_config) { Blacklight::Configuration.new }
-  let(:component) { instance_double(Blacklight::Document::ActionsComponent) }
+  let(:component) { instance_double(Blacklight::Document::ShowToolsComponent) }
 
   before do
-    allow(Blacklight::Document::ActionsComponent).to receive(:new).and_return(component)
+    allow(Blacklight::Document::ShowToolsComponent).to receive(:new).and_return(component)
     allow(view).to receive(:render).with(component)
     allow(view).to receive(:render).with('catalog/show_tools', { document: document }).and_call_original
     allow(view).to receive(:blacklight_config).and_return blacklight_config

data/spec/views/catalog/index.json.jbuilder_spec.rb

@@ -93,7 +93,7 @@ RSpec.describe "catalog/index.json", api: true do
         expect(facets.pluck('id')).to include 'format'
         expect(format['links']).to include self: 'http://test.host/some/facet/url'
         expect(format['attributes']['label']).to eq 'Format'
-        expect(format_item_attributes).to match_array [{ value: 'Book', hits: 30, label: 'Book' }]
+        expect(format_item_attributes).to contain_exactly({ value: 'Book', hits: 30, label: 'Book' })
       end
     end
 

data/tasks/blacklight.rake

@@ -43,7 +43,7 @@ end
 
 # rubocop:disable Rails/RakeEnvironment
 desc "Run test suite"
-task :ci do
+task ci: ['build:npm'] do
   with_solr do
     Rake::Task['blacklight:internal:seed'].invoke
     within_test_app do