blacklight 8.11.0 → 9.0.0.beta2

data/spec/components/blacklight/constraints_component_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 RSpec.describe Blacklight::ConstraintsComponent, type: :component do
   subject(:component) { described_class.new(**params) }
 
-  let(:rendered) { render_inline_to_capybara_node(component) }
+  before { render_inline(component) }
 
   let(:params) do
     { search_state: search_state }
@@ -32,19 +32,19 @@ RSpec.describe Blacklight::ConstraintsComponent, type: :component do
     let(:query_params) { { q: 'some query' } }
 
     it 'renders a start-over link' do
-      expect(rendered).to have_link 'Start Over', href: '/catalog'
+      expect(page).to have_link 'Start Over', href: '/catalog'
     end
 
     it 'has a header' do
-      expect(rendered).to have_css('h2', text: 'Search Constraints')
+      expect(page).to have_css('h2', text: 'Search Constraints')
     end
 
     it 'wraps the output in a div' do
-      expect(rendered).to have_css('div#appliedParams')
+      expect(page).to have_css('div#appliedParams')
     end
 
     it 'renders the query' do
-      expect(rendered).to have_css('.applied-filter.constraint', text: 'some query')
+      expect(page).to have_css('.applied-filter.constraint', text: 'some query')
     end
   end
 
@@ -52,15 +52,15 @@ RSpec.describe Blacklight::ConstraintsComponent, type: :component do
     let(:query_params) { { f: { some_facet: ['some value'] } } }
 
     it 'renders the query' do
-      expect(rendered).to have_css('.constraint-value > .filter-name', text: 'Some Facet').and(have_css('.constraint-value > .filter-value', text: 'some value'))
+      expect(page).to have_css('.constraint-value > .filter-name', text: 'Some Facet').and(have_css('.constraint-value > .filter-value', text: 'some value'))
     end
 
     context 'that is not configured' do
       let(:query_params) { { f: { some_facet: ['some value'], missing: ['another value'] } } }
 
       it 'renders only the configured constraints' do
-        expect(rendered).to have_css('.constraint-value > .filter-name', text: 'Some Facet').and(have_css('.constraint-value > .filter-value', text: 'some value'))
-        expect(rendered).to have_no_css('.constraint-value > .filter-name', text: 'Missing')
+        expect(page).to have_css('.constraint-value > .filter-name', text: 'Some Facet').and(have_css('.constraint-value > .filter-value', text: 'some value'))
+        expect(page).to have_no_css('.constraint-value > .filter-name', text: 'Missing')
       end
     end
   end
@@ -71,15 +71,15 @@ RSpec.describe Blacklight::ConstraintsComponent, type: :component do
     let(:query_params) { { q: 'some query', f: { some_facet: ['some value'] } } }
 
     it 'wraps the output in a span' do
-      expect(rendered).to have_css('span .constraint')
+      expect(page).to have_css('span .constraint')
     end
 
     it 'renders the search state as lightly-decorated text' do
-      expect(rendered).to have_css('.constraint > .filter-values', text: 'some query').and(have_css('.constraint', text: 'Some Facet:some value'))
+      expect(page).to have_css('.constraint > .filter-values', text: 'some query').and(have_css('.constraint', text: 'Some Facet:some value'))
     end
 
     it 'omits the headers' do
-      expect(rendered).to have_no_css('h2', text: 'Search Constraints')
+      expect(page).to have_no_css('h2', text: 'Search Constraints')
     end
   end
 end

data/spec/components/blacklight/document/action_component_spec.rb

@@ -6,39 +6,43 @@ RSpec.describe Blacklight::Document::ActionComponent, type: :component do
   subject(:component) { described_class.new(document: document, action: action, **attr) }
 
   let(:action) { Blacklight::Configuration::ToolConfig.new(key: 'some_tool', name: 'some_tool', component: true) }
-  let(:attr) { {} }
-  let(:view_context) { controller.view_context }
-  let(:render) do
-    component.render_in(view_context)
-  end
-
-  let(:rendered) do
-    Capybara::Node::Simple.new(render)
-  end
-
   let(:document) do
     SolrDocument.new(
       id: 'x'
     )
   end
+  let(:attr) { {} }
+  let(:view_context) { vc_test_controller.view_context }
+
+  before do
+    # Every call to view_context returns a different object. This ensures it stays stable.
+    allow(vc_test_controller).to receive_messages(view_context: view_context)
+  end
 
-  it 'renders an action link' do
-    if Rails.version >= '6'
+  context 'with a configured path' do
+    before do
       allow(view_context).to receive(:some_tool_solr_document_path).with(document, { only_path: true }).and_return('/asdf')
-    else
-      allow(view_context).to receive(:some_tool_solr_document_path).with(document).and_return('/asdf')
+
+      render_inline component
     end
 
-    expect(rendered).to have_link 'Some tool', href: '/asdf'
+    it 'renders an action link' do
+      expect(page).to have_link 'Some tool', href: '/asdf'
+    end
   end
 
   context 'with a partial configured' do
     let(:action) { Blacklight::Configuration::ToolConfig.new(name: '', partial: '/some/tool') }
 
-    it 'render the partial' do
+    before do
+      allow(view_context).to receive(:render).and_call_original
       allow(view_context).to receive(:render).with(hash_including(partial: '/some/tool'), {}).and_return('tool')
 
-      expect(rendered).to have_content 'tool'
+      render_inline component
+    end
+
+    it 'render the partial' do
+      expect(page).to have_content 'tool'
     end
   end
 end

data/spec/components/blacklight/document/group_component_spec.rb

@@ -6,40 +6,35 @@ RSpec.describe Blacklight::Document::GroupComponent, type: :component do
   subject(:component) { described_class.new(group: group, **attr) }
 
   let(:attr) { {} }
-  let(:view_context) { controller.view_context }
-  let(:render) do
-    component.render_in(view_context)
-  end
-
-  let(:rendered) do
-    Capybara::Node::Simple.new(render)
-  end
-
-  let(:docs) { 10.times.map { double } }
+  let(:view_context) { vc_test_controller.view_context }
+  let(:docs) { 10.times.map { SolrDocument.new } }
 
   let(:group) do
     instance_double(Blacklight::Solr::Response::Group, key: 'group1', field: 'group_field', total: 15, docs: docs)
   end
 
   before do
+    # Every call to view_context returns a different object. This ensures it stays stable.
+    allow(vc_test_controller).to receive_messages(view_context: view_context)
     allow(view_context).to receive(:render_document_index).with(docs).and_return('results')
+    render_inline component
   end
 
   it 'renders the group with a header' do
-    expect(rendered).to have_css 'div.group'
-    expect(rendered).to have_css 'h2', text: 'group1'
-    expect(rendered).to have_no_link 'more'
+    expect(page).to have_css 'div.group'
+    expect(page).to have_css 'h2', text: 'group1'
+    expect(page).to have_no_link 'more'
   end
 
   it 'renders the group documents' do
-    expect(rendered).to have_content 'results'
+    expect(page).to have_content 'results'
   end
 
   context 'with a limit applied' do
     let(:attr) { { group_limit: 5 } }
 
     it 'renders a control to see more results' do
-      expect(rendered).to have_link 'more'
+      expect(page).to have_link 'more'
     end
   end
 end

data/spec/components/blacklight/document/page_header_component_spec.rb

@@ -7,14 +7,7 @@ RSpec.describe Blacklight::Document::PageHeaderComponent, type: :component do
 
   let(:show_header_tools_component) { Class.new(Blacklight::Document::ShowToolsComponent) }
 
-  let(:view_context) { controller.view_context }
-  let(:render) do
-    component.render_in(view_context)
-  end
-
-  let(:rendered) do
-    Capybara::Node::Simple.new(render)
-  end
+  let(:view_context) { vc_test_controller.view_context }
 
   let(:document) { SolrDocument.new(id: 'x', title_tsim: 'Title') }
 
@@ -25,16 +18,16 @@ RSpec.describe Blacklight::Document::PageHeaderComponent, type: :component do
   # rubocop:disable RSpec/SubjectStub
   before do
     # Every call to view_context returns a different object. This ensures it stays stable.
-    allow(controller).to receive_messages(blacklight_config: blacklight_config)
-    allow(controller).to receive(:current_search_session).and_return(double(id: document.id))
-    controller.class.helper_method :current_search_session
-    allow(controller).to receive_messages(controller_name: 'catalog', link_to_previous_document: '', link_to_next_document: '')
+    allow(vc_test_controller).to receive_messages(view_context: view_context, blacklight_config: blacklight_config)
+    allow(vc_test_controller).to receive(:current_search_session).and_return(double(id: document.id))
+    vc_test_controller.class.helper_method :current_search_session
+    allow(vc_test_controller).to receive_messages(controller_name: 'catalog', link_to_previous_document: '', link_to_next_document: '')
     allow(view_context).to receive_messages(search_context: search_context, search_session: current_search_session, current_search_session: current_search_session)
     allow(component).to receive(:render).and_call_original
     allow(component).to receive(:render).with(an_instance_of(show_header_tools_component)).and_return('tool component content')
     replace_hash = { 'application/_start_over.html.erb' => 'Start Over' }
     if Rails.version.to_f >= 7.1
-      controller.prepend_view_path(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
+      vc_test_controller.prepend_view_path(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
     else
       view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
     end
@@ -45,18 +38,25 @@ RSpec.describe Blacklight::Document::PageHeaderComponent, type: :component do
     let(:search_context) { nil }
     let(:current_search_session) { {} }
 
-    it 'does not render' do
-      expect(rendered.native.inner_html).to be_blank
+    context 'with no header tools' do
+      before do
+        render_inline component
+      end
+
+      it 'does not render' do
+        expect(page.native.inner_html).to be_blank
+      end
     end
 
     context 'has header tools' do
       before do
         blacklight_config.show.show_header_tools_component = show_header_tools_component
+        render_inline component
       end
 
       it 'renders the tools' do
-        expect(rendered).to have_text 'tool component content'
-        expect(rendered).to have_css '.row'
+        expect(page).to have_text 'tool component content'
+        expect(page).to have_css '.row'
       end
     end
   end
@@ -67,25 +67,32 @@ RSpec.describe Blacklight::Document::PageHeaderComponent, type: :component do
     let(:next_doc) { SolrDocument.new(id: '888') }
     let(:current_search_session) { { query_params: { q: 'abc' }, 'id' => '123', 'document_id' => document.id } }
 
-    it 'renders pagination' do
-      expect(rendered).to have_text 'Previous'
-      expect(rendered).to have_text 'Next'
-      expect(rendered).to have_text 'Start Over'
-      expect(rendered).to have_text 'Back to Search'
+    context 'with no header tools' do
+      before do
+        render_inline component
+      end
+
+      it 'renders pagination' do
+        expect(page).to have_text 'Previous'
+        expect(page).to have_text 'Next'
+        expect(page).to have_text 'Start Over'
+        expect(page).to have_text 'Back to Search'
+      end
     end
 
     context 'has header tools' do
       before do
         blacklight_config.show.show_header_tools_component = show_header_tools_component
+        render_inline component
       end
 
       it 'renders the tools and pagination' do
-        expect(rendered).to have_text 'Previous'
-        expect(rendered).to have_text 'Next'
-        expect(rendered).to have_text 'Start Over'
-        expect(rendered).to have_text 'Back to Search'
-        expect(rendered).to have_text 'tool component content'
-        expect(rendered).to have_css '.row'
+        expect(page).to have_text 'Previous'
+        expect(page).to have_text 'Next'
+        expect(page).to have_text 'Start Over'
+        expect(page).to have_text 'Back to Search'
+        expect(page).to have_text 'tool component content'
+        expect(page).to have_css '.row'
       end
     end
   end

data/spec/components/blacklight/document/sidebar_component_spec.rb

@@ -5,14 +5,7 @@ require 'spec_helper'
 RSpec.describe Blacklight::Document::SidebarComponent, type: :component do
   subject(:component) { described_class.new(presenter: document) }
 
-  let(:view_context) { controller.view_context }
-  let(:render) do
-    component.render_in(view_context)
-  end
-
-  let(:rendered) do
-    Capybara::Node::Simple.new(render)
-  end
+  let(:view_context) { vc_test_controller.view_context }
 
   let(:document) { view_context.document_presenter(presented_document) }
 
@@ -26,37 +19,23 @@ RSpec.describe Blacklight::Document::SidebarComponent, type: :component do
 
   before do
     # Every call to view_context returns a different object. This ensures it stays stable.
-    allow(controller).to receive_messages(view_context: view_context, blacklight_config: blacklight_config)
+    allow(vc_test_controller).to receive_messages(view_context: view_context, blacklight_config: blacklight_config)
   end
 
   describe '#render_show_tools' do
     # rubocop:disable RSpec/SubjectStub
     before do
       allow(component).to receive(:render).with(an_instance_of(Blacklight::Document::MoreLikeThisComponent)).and_return("")
+      blacklight_config.show.show_tools_component = show_tools_component
+      allow(component).to receive(:render).with(an_instance_of(show_tools_component)).and_return(expected_html)
+      render_inline component
     end
+    # rubocop:enable RSpec/SubjectStub
 
-    context "without a configured ShowTools component" do
-      before do
-        allow(component).to receive(:render).with('show_tools', document: presented_document, silence_deprecation: false).and_return(expected_html)
-      end
-
-      it 'renders show_tools partial' do
-        expect(rendered).to have_css 'div[@class="expected-show_tools"]'
-      end
-    end
-
-    context "with a configured ShowTools component" do
-      let(:show_tools_component) { Class.new(Blacklight::Document::ShowToolsComponent) }
-
-      before do
-        blacklight_config.show.show_tools_component = show_tools_component
-        allow(component).to receive(:render).with(an_instance_of(show_tools_component)).and_return(expected_html)
-      end
+    let(:show_tools_component) { Class.new(Blacklight::Document::ShowToolsComponent) }
 
-      it 'renders configured show_tools component' do
-        expect(rendered).to have_css 'div[@class="expected-show_tools"]'
-      end
+    it 'renders configured show_tools component' do
+      expect(page).to have_css 'div[@class="expected-show_tools"]'
     end
-    # rubocop:enable RSpec/SubjectStub
   end
 end

data/spec/components/blacklight/document_component_spec.rb

@@ -6,14 +6,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
   subject(:component) { described_class.new(document: document, **attr) }
 
   let(:attr) { {} }
-  let(:view_context) { controller.view_context }
-  let(:render) do
-    component.render_in(view_context)
-  end
-
-  let(:rendered) do
-    Capybara::Node::Simple.new(render)
-  end
+  let(:view_context) { vc_test_controller.view_context }
 
   let(:document) { view_context.document_presenter(presented_document) }
 
@@ -36,7 +29,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
 
   before do
     # Every call to view_context returns a different object. This ensures it stays stable.
-    allow(controller).to receive_messages(view_context: view_context, current_or_guest_user: User.new, blacklight_config: blacklight_config)
+    allow(vc_test_controller).to receive_messages(view_context: view_context, current_or_guest_user: User.new, blacklight_config: blacklight_config)
     allow(view_context).to receive_messages(search_session: {}, current_search_session: nil, current_bookmarks: [])
   end
 
@@ -46,78 +39,92 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     component.set_slot(:metadata, nil, 'Metadata')
     component.set_slot(:thumbnail, nil, 'Thumbnail')
     component.set_slot(:actions) { 'Actions' }
+    render_inline component
 
-    expect(rendered).to have_content 'Title'
-    expect(rendered).to have_content 'Embed'
-    expect(rendered).to have_content 'Metadata'
-    expect(rendered).to have_content 'Thumbnail'
-    expect(rendered).to have_content 'Actions'
+    expect(page).to have_content 'Title'
+    expect(page).to have_content 'Embed'
+    expect(page).to have_content 'Metadata'
+    expect(page).to have_content 'Thumbnail'
+    expect(page).to have_content 'Actions'
   end
 
   it 'has schema.org properties' do
     component.set_slot(:body) { '-' }
+    render_inline component
 
-    expect(rendered).to have_css 'article[@itemtype="http://schema.org/Thing"]'
-    expect(rendered).to have_css 'article[@itemscope]'
+    expect(page).to have_css 'article[@itemtype="http://schema.org/Thing"]'
+    expect(page).to have_css 'article[@itemscope]'
   end
 
   context 'with a provided body' do
     it 'opts-out of normal component content' do
       component.set_slot(:body) { 'Body content' }
+      render_inline component
 
-      expect(rendered).to have_content 'Body content'
-      expect(rendered).to have_no_css 'header'
-      expect(rendered).to have_no_css 'dl'
+      expect(page).to have_content 'Body content'
+      expect(page).to have_no_css 'header'
+      expect(page).to have_no_css 'dl'
     end
   end
 
   context 'index view' do
     before do
-      controller.action_name = "index"
+      vc_test_controller.action_name = "index"
     end
 
     let(:attr) { { counter: 5 } }
 
     it 'has data properties' do
       component.set_slot(:body) { '-' }
+      render_inline component
 
-      expect(rendered).to have_css 'article[@data-document-id="x"]'
-      expect(rendered).to have_css 'article[@data-document-counter="5"]'
+      expect(page).to have_css 'article[@data-document-id="x"]'
+      expect(page).to have_css 'article[@data-document-counter="5"]'
     end
 
     it 'renders a linked title' do
-      expect(rendered).to have_link 'Title', href: '/catalog/x'
+      render_inline component
+
+      expect(page).to have_link 'Title', href: '/catalog/x'
     end
 
     it 'renders a counter with the title' do
-      expect(rendered).to have_css 'header', text: '5. Title'
+      render_inline component
+
+      expect(page).to have_css 'header', text: '5. Title'
     end
 
     context 'with a document rendered as part of a collection' do
-      # ViewComponent 3 changes iteration counters to begin at 0 rather than 1
-      let(:document_counter) { ViewComponent::VERSION::MAJOR < 3 ? 11 : 10 }
+      let(:document_counter) { 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_css 'header', text: '111. Title'
+        render_inline component
+
+        expect(page).to have_css 'header', text: '111. Title'
       end
     end
 
     it 'renders actions' do
-      expect(rendered).to have_css '.index-document-functions'
+      render_inline component
+
+      expect(page).to have_css '.index-document-functions'
     end
 
     it 'renders a thumbnail' do
-      expect(rendered).to have_css 'a[href="/catalog/x"] img[src="http://example.com/image.jpg"]'
+      render_inline component
+
+      expect(page).to have_css 'a[href="/catalog/x"] img[src="http://example.com/image.jpg"]'
     end
 
     context 'with default metadata component' do
       it 'renders metadata' do
-        expect(rendered).to have_css 'dl.document-metadata'
-        expect(rendered).to have_css 'dt', text: 'Title:'
-        expect(rendered).to have_css 'dd', text: 'Title'
-        expect(rendered).to have_no_css 'dt', text: 'ISBN:'
+        render_inline component
+
+        expect(page).to have_css 'dl.document-metadata'
+        expect(page).to have_css 'dt', text: 'Title:'
+        expect(page).to have_css 'dd', text: 'Title'
+        expect(page).to have_no_css 'dt', text: 'ISBN:'
       end
     end
   end
@@ -126,44 +133,58 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     let(:attr) { { title_component: :h1, show: true } }
 
     before do
-      controller.action_name = "show"
+      vc_test_controller.action_name = "show"
     end
 
     it 'renders with an id' do
       component.set_slot(:body) { '-' }
+      render_inline component
 
-      expect(rendered).to have_css 'article#document'
+      expect(page).to have_css 'article#document'
     end
 
     it 'renders a title' do
-      expect(rendered).to have_css 'h1', text: 'Title'
+      render_inline component
+
+      expect(page).to have_css 'h1', text: 'Title'
     end
 
     it 'renders with show-specific metadata' do
-      expect(rendered).to have_css 'dl.document-metadata'
-      expect(rendered).to have_css 'dt', text: 'ISBN:'
-      expect(rendered).to have_css 'dd', text: 'Value'
+      render_inline component
+
+      expect(page).to have_css 'dl.document-metadata'
+      expect(page).to have_css 'dt', text: 'ISBN:'
+      expect(page).to have_css 'dd', text: 'Value'
     end
 
-    it 'renders an embed' do
-      stub_const('StubComponent', Class.new(ViewComponent::Base) do
-        def initialize(**); end
+    context 'with an embed component' do
+      before do
+        vc_test_controller.action_name = "show"
 
-        def call
-          'embed'.html_safe
-        end
-      end)
+        stub_const('StubComponent', Class.new(ViewComponent::Base) do
+          def initialize(**); end
 
-      blacklight_config.show.embed_component = StubComponent
-      expect(rendered).to have_content 'embed'
+          def call
+            'embed'.html_safe
+          end
+        end)
+
+        blacklight_config.show.embed_component = StubComponent
+        render_inline component
+      end
+
+      it 'renders an embed' do
+        expect(page).to have_content 'embed'
+      end
     end
 
     context 'show view with custom translation' do
       let!(:original_translations) { I18n.backend.send(:translations).deep_dup }
 
       before do
-        controller.action_name = "show"
+        vc_test_controller.action_name = "show"
         I18n.backend.store_translations(:en, blacklight: { search: { show: { label: "testing:%{label}" } } })
+        render_inline component
       end
 
       after do
@@ -172,9 +193,9 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       end
 
       it 'renders with show-specific metadata with correct translation' do
-        expect(rendered).to have_css 'dl.document-metadata'
-        expect(rendered).to have_css 'dt', text: 'testing:ISBN'
-        expect(rendered).to have_css 'dd', text: 'Value'
+        expect(page).to have_css 'dl.document-metadata'
+        expect(page).to have_css 'dt', text: 'testing:ISBN'
+        expect(page).to have_css 'dd', text: 'Value'
       end
     end
 
@@ -191,10 +212,11 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       before do
         stub_const('MyMetadataComponent', custom_component_class)
         blacklight_config.show.metadata_component = MyMetadataComponent
+        render_inline component
       end
 
       it 'renders custom component' do
-        expect(rendered).to have_text 'blah'
+        expect(page).to have_text 'blah'
       end
     end
 
@@ -211,36 +233,47 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       before do
         stub_const('MyTitleComponent', custom_component_class)
         blacklight_config.show.title_component = MyTitleComponent
+        render_inline component
       end
 
       it 'renders custom component' do
-        expect(rendered).to have_text 'Titleriffic'
+        expect(page).to have_text 'Titleriffic'
       end
     end
   end
 
-  it 'renders partials' do
-    component.with_partial { 'Partials' }
-    expect(rendered).to have_content 'Partials'
+  context 'with partials' do
+    before do
+      component.with_partial { 'Partials' }
+      render_inline component
+    end
+
+    it 'renders partials' do
+      expect(page).to have_content 'Partials'
+    end
   end
 
-  it 'has no partials by default' do
-    component.render_in(view_context)
+  context 'with no partials (default behavior)' do
+    before do
+      render_inline component
+    end
 
-    expect(component.partials?).to be false
+    it 'has no partials by default' do
+      expect(component.partials?).to be false
+    end
   end
 
   context 'with before_titles' do
-    let(:render) do
-      component.render_in(view_context) do
-        component.with_title do |c|
+    before do
+      render_inline(component) do |inner_c|
+        inner_c.with_title do |c|
           c.with_before_title { 'Prefix!' }
         end
       end
     end
 
     it 'shows the prefix' do
-      expect(rendered).to have_content "Prefix!"
+      expect(page).to have_content "Prefix!"
     end
   end
 end