blacklight 7.36.2 → 8.0.0.beta1

data/spec/support/features.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
+
 # spec/support/features.rb
 
+require File.expand_path('features/search_helpers.rb', __dir__)
 require File.expand_path('features/session_helpers.rb', __dir__)
 
 RSpec.configure do |config|
+  config.include Features::SearchHelpers, type: :feature
   config.include Features::SessionHelpers, type: :feature
 end

data/spec/support/view_component_capybara_test_helpers.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ViewComponentCapybaraTestHelpers
+  # 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
+end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rails/generators'
 
 class TestAppGenerator < Rails::Generators::Base
@@ -11,11 +12,11 @@ class TestAppGenerator < Rails::Generators::Base
   def run_blacklight_generator
     say_status("warning", "GENERATING BL", :yellow)
 
-    Bundler.with_clean_env do
+    Bundler.with_unbundled_env do
       run "bundle install"
     end
     options = '--devise'
-    if ENV['BLACKLIGHT_API_TEST']
+    if ENV['BLACKLIGHT_API_TEST'].present?
       options += ' --skip-assets'
     end
 
@@ -27,4 +28,10 @@ class TestAppGenerator < Rails::Generators::Base
 
     generate 'blacklight:test_support'
   end
+
+  def add_local_assets_for_propshaft
+    return unless defined?(Propshaft)
+
+    run "yarn add #{Blacklight::Engine.root}"
+  end
 end

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

@@ -8,20 +8,12 @@ RSpec.describe "catalog/_document" do
     allow(controller).to receive(:controller_name).and_return('test')
     allow(view).to receive(:render_grouped_response?).and_return(false)
     allow(view).to receive(:blacklight_config).and_return(blacklight_config)
+    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')
     assign(:response, instance_double(Blacklight::Solr::Response, start: 20))
   end
 
-  it "renders the header, thumbnail and index by default" do
-    stub_template "catalog/_index_header.html.erb" => "document_header"
-    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/
-  end
-
   it "uses the index.partials parameter to determine the partials to render" do
     blacklight_config.index.partials = %w[a b c]
     stub_template "catalog/_a_default.html.erb" => "a_partial"
@@ -32,27 +24,4 @@ RSpec.describe "catalog/_document" 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.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 }
-
-    expect(rendered).to have_selector 'article.document header', text: '22. xyz'
-    expect(rendered).not_to match(/partial/)
-  end
-
-  it 'renders the partial using a provided view config' do
-    view_config = Blacklight::Configuration::ViewConfig.new partials: %w[a]
-    stub_template "catalog/_a_default.html.erb" => "partial"
-
-    render partial: "catalog/document", locals: { document: document, document_counter: 1, view_config: view_config }
-
-    expect(rendered).to match(/partial/)
-  end
 end

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

@@ -2,7 +2,7 @@
 
 RSpec.describe 'catalog/_facet_index_navigation.html.erb', type: :view do
   let(:pagination) { Blacklight::Solr::FacetPaginator.new([]) }
-  let(:facet) { Blacklight::Configuration::FacetField.new(index_range: '0'..'9') }
+  let(:facet) { Blacklight::Configuration::FacetField.new(index_range: '0'..'9', presenter: Blacklight::FacetFieldPresenter) }
   let(:display_facet) { double(items: [], offset: 0, prefix: '', sort: 'index') }
   let(:blacklight_config) { Blacklight::Configuration.new }
 

data/spec/views/catalog/_search_header.erb_spec.rb

@@ -6,6 +6,7 @@ RSpec.describe "/catalog/_search_header.html.erb" do
   it "renders the default search header partials" do
     stub_template "_did_you_mean.html.erb" => "did_you_mean"
     stub_template "_sort_and_per_page.html.erb" => "sort_and_per_page"
+    allow(view).to receive(:blacklight_config).and_return(CatalogController.blacklight_config)
     render
     expect(rendered).to match /did_you_mean/
     expect(rendered).to match /sort_and_per_page/

data/spec/views/catalog/_show_sidebar.erb_spec.rb

@@ -6,6 +6,7 @@ RSpec.describe "catalog/_show_sidebar.html.erb" do
   let(:blacklight_config) do
     Blacklight::Configuration.new do |config|
       config.index.title_field = 'title_tsim'
+      config.index.sidebar_component = Blacklight::Document::SidebarComponent
     end
   end
 

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

@@ -3,28 +3,16 @@
 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) }
 
   before do
-    assign :response, instance_double(Blacklight::Solr::Response, params: {})
+    allow(Blacklight::Document::ActionsComponent).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
     allow(view).to receive(:has_user_authentication_provider?).and_return false
   end
 
-  context 'without passing in a document local explicitly' do
-    before do
-      assign :document, document
-    end
-
-    let(:document_actions) { blacklight_config.show.document_actions }
-
-    it 'defaults to the @document and renders the action' do
-      allow(view).to receive(:some_action_solr_document_path).with(document, any_args).and_return 'x'
-      document_actions[:some_action] = Blacklight::Configuration::ToolConfig.new key: :some_action, name: :some_action, partial: 'document_action'
-      render 'catalog/show_tools'
-      expect(rendered).to have_link "Some action", href: "x"
-    end
-  end
-
   describe "document actions" do
     let(:document_actions) { blacklight_config.show.document_actions }
 
@@ -32,56 +20,7 @@ RSpec.describe "catalog/_show_tools.html.erb" do
       allow(view).to receive(:some_action_solr_document_path).with(document, any_args).and_return 'x'
       document_actions[:some_action] = Blacklight::Configuration::ToolConfig.new key: :some_action, name: :some_action, partial: 'document_action'
       render 'catalog/show_tools', document: document
-      expect(rendered).to have_link "Some action", href: "x"
-    end
-
-    it "uses the provided label" do
-      allow(view).to receive(:some_action_solr_document_path).and_return "x"
-      document_actions[:some_action] = Blacklight::Configuration::ToolConfig.new key: :some_action, name: :some_action, label: "Some label", partial: 'document_action'
-      render 'catalog/show_tools', document: document
-      expect(rendered).to have_selector '.some_action', text: "Some label"
-    end
-
-    it "evaluates a document action's if configurations" do
-      allow(view).to receive(:some_action_solr_document_path).and_return "x"
-      document_actions[:some_action] = Blacklight::Configuration::ToolConfig.new key: :some_action, name: :some_action, if: false, partial: 'document_action'
-      render 'catalog/show_tools', document: document
-      expect(rendered).not_to have_selector '.some_action', text: "Some action"
-    end
-
-    it "evaluates a document action's if configuration with a proc" do
-      allow(view).to receive(:some_action_solr_document_path).and_return "x"
-      document_actions[:some_action] = Blacklight::Configuration::ToolConfig.new key: :some_action, name: :some_action, partial: 'document_action', if: proc { |_config, doc| doc.id == "xyz" }
-      render 'catalog/show_tools', document: document
-      expect(rendered).not_to have_selector '.some_action', text: "Some action"
-    end
-
-    it "evaluates a document action's unless configurations" do
-      allow(view).to receive(:some_action_solr_document_path).and_return "x"
-      document_actions[:some_action] = Blacklight::Configuration::ToolConfig.new key: :some_action, name: :some_action, partial: 'document_action', unless: true
-      render 'catalog/show_tools', document: document
-      expect(rendered).not_to have_selector '.some_action', text: "Some action"
-    end
-
-    it "allows the tool to have a custom id" do
-      allow(view).to receive(:some_action_solr_document_path).and_return "x"
-      document_actions[:some_action] = Blacklight::Configuration::ToolConfig.new key: :some_action, name: :some_action, partial: 'document_action', id: "some_action"
-      render 'catalog/show_tools', document: document
-      expect(rendered).to have_selector '#some_action', text: "Some action"
-    end
-
-    it "defaults to modal behavior" do
-      allow(view).to receive(:some_action_solr_document_path).and_return "x"
-      document_actions[:some_action] = Blacklight::Configuration::ToolConfig.new key: :some_action, name: :some_action, partial: 'document_action'
-      render 'catalog/show_tools', document: document
-      expect(rendered).to have_selector '.some_action > a[data-blacklight-modal="trigger"]', text: "Some action"
-    end
-
-    it "allows configuration to opt out of modal behavior" do
-      allow(view).to receive(:some_action_solr_document_path).and_return "x"
-      document_actions[:some_action] = Blacklight::Configuration::ToolConfig.new key: :some_action, name: :some_action, partial: 'document_action', modal: false
-      render 'catalog/show_tools', document: document
-      expect(rendered).not_to have_selector '.some_action > a[data-blacklight-modal="trigger"]', text: "Some action"
+      expect(view).to have_received(:render).with(component)
     end
 
     context 'without any document actions defined' do

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

@@ -5,18 +5,27 @@ RSpec.describe "catalog/_view_type_group" do
   let(:response) { instance_double(Blacklight::Solr::Response, empty?: false) }
 
   before do
-    allow(view).to receive(:view_label), &:to_s
-    allow(view).to receive_messages(how_sort_and_per_page?: true, blacklight_config: blacklight_config)
+    allow(view).to receive_messages(blacklight_config: blacklight_config)
     controller.request.path_parameters[:action] = 'index'
     assign(:response, response)
   end
 
-  it "does not display the group when there's only one option" do
+  it "does not display the group when there's no documents to view" do
+    blacklight_config.configure do |config|
+      config.view.a(icon: :list)
+      config.view.b(icon: :list)
+    end
+
     allow(response).to receive_messages(empty?: true)
     render partial: 'catalog/view_type_group'
     expect(rendered).to be_empty
   end
 
+  it "does not display the group when there's only one option" do
+    render partial: 'catalog/view_type_group'
+    expect(rendered).to be_empty
+  end
+
   it "displays the group" do
     blacklight_config.configure do |config|
       config.view.delete(:list)
@@ -26,12 +35,12 @@ RSpec.describe "catalog/_view_type_group" do
     end
     render partial: 'catalog/view_type_group'
     expect(rendered).to have_selector('.btn-group.view-type-group')
-    expect(rendered).to have_selector('.view-type-a', text: 'a')
+    expect(rendered).to have_selector('.view-type-a', text: 'A')
     within '.view-type-a' do
       expect(rendered).to have_selector 'svg'
     end
-    expect(rendered).to have_selector('.view-type-b', text: 'b')
-    expect(rendered).to have_selector('.view-type-c', text: 'c')
+    expect(rendered).to have_selector('.view-type-b', text: 'B')
+    expect(rendered).to have_selector('.view-type-c', text: 'C')
   end
 
   it "sets the current view to 'active'" do
@@ -41,8 +50,7 @@ RSpec.describe "catalog/_view_type_group" do
       config.view.b(icon: :list)
     end
     render partial: 'catalog/view_type_group'
-    expect(rendered).to have_selector('.active', text: 'a')
-    expect(rendered).not_to have_selector('.active', text: 'b')
-    expect(rendered).to have_selector('.btn', text: 'b')
+    expect(rendered).to have_selector('.active', text: 'A')
+    expect(rendered).not_to have_selector('.active', text: 'B')
   end
 end

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 RSpec.describe "catalog/email_success.html.erb" do
-  it "includes the data-blacklight-modal properties" do
+  it "includes updates to the main flash messages" do
     render
-    expect(rendered).to have_selector "div[data-blacklight-modal=container]"
+    expect(rendered).to have_selector 'turbo-stream[action="append"][target="main-flashes"]'
   end
 end

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

@@ -3,8 +3,13 @@
 RSpec.describe 'catalog/facet.html.erb' do
   let(:display_facet) { double }
   let(:blacklight_config) { Blacklight::Configuration.new }
+  let(:component) { instance_double(Blacklight::FacetComponent) }
 
   before do
+    allow(Blacklight::FacetComponent).to receive(:new).and_return(component)
+    allow(view).to receive(:render).and_call_original
+    allow(view).to receive(:render).with(component)
+
     blacklight_config.add_facet_field 'xyz', label: "Facet title"
     allow(view).to receive(:blacklight_config).and_return(blacklight_config)
     stub_template 'catalog/_facet_pagination.html.erb' => 'pagination'
@@ -13,19 +18,17 @@ RSpec.describe 'catalog/facet.html.erb' do
   end
 
   it "has the facet title" do
-    allow(view).to receive(:render_facet_limit)
     render
     expect(rendered).to have_selector 'h1', text: "Facet title"
   end
 
   it "renders facet pagination" do
-    allow(view).to receive(:render_facet_limit)
     render
     expect(rendered).to have_content 'pagination'
   end
 
   it "renders the facet limit" do
-    allow(view).to receive(:render_facet_limit).with(display_facet, layout: false)
     render
+    expect(view).to have_received(:render).with(component)
   end
 end

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

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
+
 require 'rexml/document'
 
 RSpec.describe "catalog/index" do
   let(:document_list) do
     10.times.map do |i|
-      doc = SolrDocument.new(id: i)
-      allow(doc).to receive(:export_as_some_format).and_return("")
-      allow(doc).to receive(:to_semantic_values).and_return(author: ['xyz']) if i == 0
-      doc.will_export_as(:some_format, "application/some-format") if i == 1
-      doc
+      SolrDocument.new(id: i, title_tsim: "Title #{i}").tap do |doc|
+        allow(doc).to receive(:export_as_some_format).and_return("")
+        allow(doc).to receive(:to_semantic_values).and_return(author: ['xyz']) if i.zero?
+        doc.will_export_as(:some_format, "application/some-format") if i == 1
+      end
     end
   end
 
@@ -21,7 +22,6 @@ RSpec.describe "catalog/index" do
     params['content_format'] = 'some_format'
     allow(view).to receive(:action_name).and_return('index')
     allow(view).to receive(:blacklight_config).and_return(blacklight_config)
-    allow(view).to receive(:search_field_options_for_select).and_return([])
   end
 
   # We need to use rexml to test certain things that have_tag wont' test
@@ -87,15 +87,22 @@ RSpec.describe "catalog/index" do
     end
 
     it "has a summary" do
-      stub_template "catalog/_index.html.erb" => "partial content"
       render template: 'catalog/index', formats: [:atom]
-      expect(rendered).to have_selector("entry > summary", text: 'partial content')
+      expect(rendered).to have_selector("entry > summary", text: 'Title 0')
     end
 
-    context 'with a custom HTML partial' do
+    context 'with a custom template' do
       before do
-        blacklight_config.view.atom.summary_partials = ['whatever']
-        stub_template 'catalog/_whatever_default.html.erb' => 'whatever content'
+        my_template = Class.new(ViewComponent::Base) do
+          def call
+            'whatever content'
+          end
+
+          def self.name
+            'TestComponent'
+          end
+        end
+        blacklight_config.view.atom.summary_component = my_template
       end
 
       it "has the customized summary" do

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

@@ -4,26 +4,25 @@ RSpec.describe "catalog/index.html.erb" do
   describe "with no search parameters" do
     before do
       allow(view).to receive(:has_search_parameters?).and_return(false)
-      allow(view).to receive(:blacklight_config).and_return(Blacklight::Configuration.new)
+      allow(view).to receive(:blacklight_config).and_return(CatalogController.blacklight_config)
+      @response = instance_double(Blacklight::Solr::Response, empty?: true, total: 11, start: 1, limit_value: 10, aggregations: {})
     end
 
     let(:sidebar) { view.content_for(:sidebar) }
 
-    it "renders the search_sidebar partial" do
-      stub_template "catalog/_search_sidebar.html.erb" => "sidebar_content"
+    it "renders the Search::SidebarComponent component" do
       render
-      expect(sidebar).to match /sidebar_content/
+
+      expect(sidebar).to match /Limit your search/
     end
   end
 
   describe "with search parameters" do
     before do
-      allow(controller).to receive(:search_state_class).and_return(Blacklight::SearchState)
       allow(view).to receive(:has_search_parameters?).and_return(true)
       stub_template "catalog/_results_pagination.html.erb" => ""
       stub_template "catalog/_search_header.html.erb" => "header_content"
       allow(view).to receive(:blacklight_config).and_return(Blacklight::Configuration.new)
-      allow(view).to receive(:render_opensearch_response_metadata).and_return("")
       @response = instance_double(Blacklight::Solr::Response, empty?: true, total: 11, start: 1, limit_value: 10)
     end
 

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

@@ -85,12 +85,12 @@ RSpec.describe "catalog/index.json", api: true do
     let(:facets) { hash[:included].select { |x| x['type'] == 'facet' } }
     let(:format) { facets.find { |x| x['id'] == 'format' } }
     let(:format_items) { format['attributes']['items'] }
-    let(:format_item_attributes) { format_items.map { |x| x['attributes'] } }
+    let(:format_item_attributes) { format_items.pluck('attributes') }
 
     context 'when no facets have been selected' do
       it 'has facet information and links' do
         expect(facets).to be_present
-        expect(facets.map { |x| x['id'] }).to include 'format'
+        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' }]

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

@@ -3,8 +3,11 @@
 RSpec.describe "catalog/show.html.erb" do
   let(:document) { SolrDocument.new id: 'xyz', format: 'a' }
   let(:blacklight_config) { Blacklight::Configuration.new }
+  let(:presenter) { Blacklight::ShowPresenter.new(document, view, blacklight_config) }
 
   before do
+    allow(presenter).to receive(:html_title).and_return('Heading')
+    allow(view).to receive(:document_presenter).and_return(presenter)
     allow(view).to receive(:action_name).and_return('show')
     allow(view).to receive_messages(has_user_authentication_provider?: false)
     allow(view).to receive_messages(render_document_sidebar_partial: "Sidebar")
@@ -14,7 +17,6 @@ RSpec.describe "catalog/show.html.erb" do
   end
 
   it "sets the @page_title" do
-    allow(view).to receive(:document_show_html_title).and_return("Heading")
     render
     page_title = view.instance_variable_get(:@page_title)
     expect(page_title).to eq "Heading - Blacklight"
@@ -22,22 +24,12 @@ RSpec.describe "catalog/show.html.erb" do
   end
 
   it "includes schema.org itemscope/type properties" do
-    allow(view).to receive(:document_show_html_title).and_return("Heading")
     allow(document).to receive_messages(itemtype: 'some-item-type-uri')
     render
     expect(rendered).to have_selector('div#document[@itemscope]')
     expect(rendered).to have_selector('div#document[@itemtype="some-item-type-uri"]')
   end
 
-  it "renders the show_header and show partials by default" do
-    allow(view).to receive(:render_grouped_response?).and_return(false)
-    stub_template "catalog/_show_header_default.html.erb" => "document_header"
-    stub_template "catalog/_show_default.html.erb" => "show_default"
-    render
-    expect(rendered).to match /document_header/
-    expect(rendered).to match /show_default/
-  end
-
   it "uses the show.partials parameter to determine the partials to render" do
     allow(view).to receive(:render_grouped_response?).and_return(false)
     blacklight_config.show.partials = %w[a b c]
@@ -49,18 +41,4 @@ 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

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 RSpec.describe "catalog/sms_success.html.erb" do
-  it "includes the data-blacklight-modal properties" do
+  it "includes updates to the main flash messages" do
     render
-    expect(rendered).to have_selector "div[data-blacklight-modal=container]"
+    expect(rendered).to have_selector 'turbo-stream[action="append"][target="main-flashes"]'
   end
 end

data/tasks/blacklight.rake

@@ -20,7 +20,7 @@ def system_with_error_handling(*args)
   end
 end
 
-def with_solr
+def with_solr(&block)
   # We're being invoked by the app entrypoint script and solr is already up via docker-compose
   if ENV['SOLR_ENV'] == 'docker-compose'
     yield
@@ -36,9 +36,7 @@ def with_solr
     end
   else
     SolrWrapper.wrap do |solr|
-      solr.with_collection do
-        yield
-      end
+      solr.with_collection(&block)
     end
   end
 end
@@ -48,6 +46,10 @@ desc "Run test suite"
 task :ci do
   with_solr do
     Rake::Task['blacklight:internal:seed'].invoke
+    within_test_app do
+      # Precompiles the javascript
+      system "bin/rake spec:prepare"
+    end
     Rake::Task['blacklight:coverage'].invoke
   end
 end