blacklight 9.0.0.beta1 → 9.0.0

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,88 +29,102 @@ 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
 
   it 'has some defined content areas' do
-    component.set_slot(:title) { 'Title' }
-    component.set_slot(:embed, nil, 'Embed')
-    component.set_slot(:metadata, nil, 'Metadata')
-    component.set_slot(:thumbnail, nil, 'Thumbnail')
-    component.set_slot(:actions) { 'Actions' }
-
-    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'
+    component.with_title { 'Title' }
+    component.with_embed('Embed')
+    component.with_metadata('Metadata')
+    component.with_thumbnail('Thumbnail')
+    component.with_actions { 'Actions' }
+    render_inline component
+
+    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) { '-' }
+    component.with_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' }
+      component.with_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) { '-' }
+      component.with_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,51 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     let(:attr) { { title_component: :h1, show: true } }
 
     before do
-      controller.action_name = "show"
-    end
-
-    it 'renders with an id' do
-      component.set_slot(:body) { '-' }
-
-      expect(rendered).to have_css 'article#document'
+      vc_test_controller.action_name = "show"
     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"
+
+        stub_const('StubComponent', Class.new(ViewComponent::Base) do
+          def initialize(**); end
 
-        def call
-          'embed'.html_safe
-        end
-      end)
+          def call
+            'embed'.html_safe
+          end
+        end)
 
-      blacklight_config.show.embed_component = StubComponent
-      expect(rendered).to have_content 'embed'
+        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 +186,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 +205,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 +226,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

data/spec/components/blacklight/facet_component_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 RSpec.describe Blacklight::FacetComponent, type: :component do
   subject(:rendered) do
-    render_inline_to_capybara_node(component)
+    render_inline(component)
   end
 
   let(:component) { described_class.new(**component_kwargs) }
@@ -18,13 +18,14 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
   let(:facet_config) { Blacklight::Configuration::FacetField.new(key: 'field').normalize! }
 
   it 'delegates to the configured component to render something' do
-    expect(rendered).to have_css 'ul.facet-values'
+    rendered
+    expect(page).to have_css 'ul.facet-values'
   end
 
   context 'with a provided component' do
     let(:component_kwargs) { { field_config: facet_config, display_facet: display_facet, component: component_class } }
     let(:component_class) do
-      Class.new(Blacklight::FacetFieldListComponent) do
+      Class.new(Blacklight::Facets::ListComponent) do
         def self.name
           'CustomFacetComponent'
         end
@@ -35,8 +36,10 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
       end
     end
 
+    before { rendered }
+
     it 'renders the provided component' do
-      expect(rendered).to have_content 'Custom facet rendering'
+      expect(page).to have_content 'Custom facet rendering'
     end
   end
 
@@ -53,14 +56,15 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
       replace_hash = { 'catalog/_facet_partial.html.erb' => 'facet partial' }
 
       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
-        controller.view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
+        vc_test_controller.view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
       end
+      rendered
     end
 
     it 'renders the partial' do
-      expect(rendered).to have_content 'facet partial'
+      expect(page).to have_content 'facet partial'
     end
   end
 
@@ -113,7 +117,7 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
       { display_facet_or_field_config: presenter }
     end
 
-    let(:presenter) { Blacklight::FacetFieldPresenter.new(facet_config, display_facet, controller.view_context) }
+    let(:presenter) { Blacklight::FacetFieldPresenter.new(facet_config, display_facet, vc_test_controller.view_context) }
 
     it 'renders the component with the provided presenter' do
       allow(facet_config.component).to receive(:new).and_call_original

data/spec/components/blacklight/facet_item_pivot_component_spec.rb

@@ -3,8 +3,8 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::FacetItemPivotComponent, type: :component do
-  subject(:rendered) do
-    render_inline_to_capybara_node(described_class.new(facet_item: facet_item))
+  before do
+    render_inline(described_class.new(facet_item: facet_item))
   end
 
   let(:blacklight_config) do
@@ -31,17 +31,17 @@ RSpec.describe Blacklight::FacetItemPivotComponent, type: :component do
     )
   end
 
-  let(:facet_config) { Blacklight::Configuration::NullField.new(key: 'z', item_component: Blacklight::FacetItemComponent, item_presenter: Blacklight::FacetItemPivotPresenter) }
+  let(:facet_config) { Blacklight::Configuration::NullField.new(key: 'z', item_component: Blacklight::Facets::ItemComponent, item_presenter: Blacklight::FacetItemPivotPresenter) }
 
   it 'links to the facet and shows the number of hits' do
-    expect(rendered).to have_css 'li'
-    expect(rendered).to have_link 'x', href: nokogiri_mediated_href(facet_item.href)
-    expect(rendered).to have_css '.facet-count', text: '10'
+    expect(page).to have_css 'li'
+    expect(page).to have_link 'x', href: nokogiri_mediated_href(facet_item.href)
+    expect(page).to have_css '.facet-count', text: '10'
   end
 
   it 'has the facet hierarchy' do
-    expect(rendered).to have_css 'li ul.pivot-facet'
-    expect(rendered).to have_link 'x:1', href: nokogiri_mediated_href(facet_item.facet_item_presenters.first.href)
+    expect(page).to have_css 'li.treeitem ul li.treeitem'
+    expect(page).to have_link 'x:1', href: nokogiri_mediated_href(facet_item.facet_item_presenters.first.href)
   end
 
   context 'with a selected facet' do
@@ -60,10 +60,10 @@ RSpec.describe Blacklight::FacetItemPivotComponent, type: :component do
     end
 
     it 'links to the facet and shows the number of hits' do
-      expect(rendered).to have_css 'li'
-      expect(rendered).to have_css '.selected', text: 'x'
-      expect(rendered).to have_link '[remove]', href: '/catalog'
-      expect(rendered).to have_css '.selected.facet-count', text: '10'
+      expect(page).to have_css 'li'
+      expect(page).to have_css '.selected', text: 'x'
+      expect(page).to have_link '[remove]', href: '/catalog'
+      expect(page).to have_css '.selected.facet-count', text: '10'
     end
   end
 end

data/spec/components/blacklight/{facet_field_checkboxes_component_spec.rb → facets/checkboxes_component_spec.rb}

@@ -2,15 +2,15 @@
 
 require 'spec_helper'
 
-RSpec.describe Blacklight::FacetFieldCheckboxesComponent, type: :component do
-  subject(:rendered) do
-    render_inline_to_capybara_node(described_class.new(facet_field: facet_field))
+RSpec.describe Blacklight::Facets::CheckboxesComponent, type: :component do
+  before do
+    render_inline(described_class.new(facet_field: facet_field))
   end
 
   let(:facet_field) do
     instance_double(
       Blacklight::FacetFieldPresenter,
-      facet_field: Blacklight::Configuration::NullField.new(key: 'field', item_component: Blacklight::FacetItemComponent, item_presenter: Blacklight::FacetItemPresenter),
+      facet_field: Blacklight::Configuration::NullField.new(key: 'field', item_component: Blacklight::Facets::ItemComponent, item_presenter: Blacklight::FacetItemPresenter),
       paginator: paginator,
       key: 'field',
       label: 'Field',
@@ -33,18 +33,18 @@ RSpec.describe Blacklight::FacetFieldCheckboxesComponent, type: :component do
   let(:params) { { f: { field: ['a'] } } }
 
   it 'renders an accordion item' do
-    expect(rendered).to have_css '.accordion-item'
-    expect(rendered).to have_button 'Field'
-    expect(rendered).to have_css 'button[data-bs-target="#facet-field"]'
-    expect(rendered).to have_css '#facet-field.collapse.show'
+    expect(page).to have_css '.accordion-item'
+    expect(page).to have_button 'Field'
+    expect(page).to have_css 'button[data-bs-target="#facet-field"]'
+    expect(page).to have_css '#facet-field.collapse.show'
   end
 
   it 'renders the facet items' do
-    expect(rendered).to have_css 'ul.facet-values'
-    expect(rendered).to have_css 'li', count: 3
+    expect(page).to have_css 'ul.facet-values'
+    expect(page).to have_css 'li', count: 3
 
-    expect(rendered).to have_field 'f_inclusive[field][]', with: 'a'
-    expect(rendered).to have_field 'f_inclusive[field][]', with: 'b'
-    expect(rendered).to have_field 'f_inclusive[field][]', with: 'c'
+    expect(page).to have_field 'f_inclusive[field][]', with: 'a'
+    expect(page).to have_field 'f_inclusive[field][]', with: 'b'
+    expect(page).to have_field 'f_inclusive[field][]', with: 'c'
   end
 end

data/spec/components/blacklight/facets/filters_component_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::Facets::FiltersComponent, type: :component do
+  let(:facet_field) { Blacklight::Configuration::FacetField.new key: 'language_facet', suggest?: true }
+  let(:presenter) do
+    instance_double(Blacklight::FacetFieldPresenter, facet_field: facet_field, label: 'Lang',
+                                                     view_context: view_context, suggest?: true, key: 'lang')
+  end
+  let(:view_context) { vc_test_controller.view_context }
+
+  before do
+    allow(view_context).to receive(:search_facet_path).and_return('/catalog/facet/language_facet')
+
+    with_request_url '/catalog?q=foo' do
+      render_inline(component)
+    end
+  end
+
+  context 'with default classes' do
+    let(:component) { described_class.new(presenter: presenter) }
+
+    it 'draws default classes' do
+      expect(page).to have_css(".facet-filters.mt-1.mb-3")
+    end
+  end
+
+  context 'with custom classes' do
+    let(:component) { described_class.new(presenter: presenter, classes: 'foo') }
+
+    it 'draws default classes' do
+      expect(page).to have_css(".foo")
+    end
+  end
+end

data/spec/components/blacklight/facets/index_navigation_component_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::Facets::IndexNavigationComponent, type: :component do
+  let(:pagination) { Blacklight::Solr::FacetPaginator.new([]) }
+  let(:facet) { Blacklight::Configuration::FacetField.new(index_range: '0'..'9', presenter: Blacklight::FacetFieldPresenter) }
+  let(:display_facet) { instance_double(Blacklight::Solr::Response::Facets::FacetField, items: [], offset: 0, prefix: '', sort: 'index', index?: true) }
+  let(:blacklight_config) { Blacklight::Configuration.new }
+
+  let(:presenter) { facet.presenter.new(facet, display_facet, vc_test_controller.view_context) }
+
+  before do
+    with_request_url "/catalog/facet/language" do
+      render_inline(described_class.new(presenter: presenter))
+    end
+  end
+
+  it 'renders the facet index navigation range' do
+    expect(page).to have_css '.pagination'
+    facet_path = ViewComponent::VERSION::MAJOR == 3 ? '/catalog/facet/language.html' : '/catalog/facet/language'
+    expect(page).to have_link '0', href: "#{facet_path}?facet.prefix=0&facet.sort=index"
+    expect(page).to have_link '1'
+    expect(page).to have_link '8'
+    expect(page).to have_link '9'
+  end
+
+  it 'renders an "all" button' do
+    expect(page).to have_css '.page-link', text: 'All'
+  end
+
+  context 'with a selected index' do
+    let(:display_facet) { instance_double(Blacklight::Solr::Response::Facets::FacetField, items: [], offset: 0, prefix: '5', sort: 'index', index?: true) }
+
+    it 'highlights the selected index' do
+      expect(page).to have_css '.active', text: '5'
+    end
+
+    it 'enables the clear facets button' do
+      expect(page).to have_link 'All'
+    end
+  end
+end

data/spec/components/blacklight/{facet_item_component_spec.rb → facets/item_component_spec.rb}

@@ -2,9 +2,9 @@
 
 require 'spec_helper'
 
-RSpec.describe Blacklight::FacetItemComponent, type: :component do
-  subject(:rendered) do
-    render_inline_to_capybara_node(described_class.new(facet_item: facet_item))
+RSpec.describe Blacklight::Facets::ItemComponent, type: :component do
+  before do
+    render_inline(described_class.new(facet_item: facet_item))
   end
 
   let(:facet_item) do
@@ -19,11 +19,11 @@ RSpec.describe Blacklight::FacetItemComponent, type: :component do
   end
 
   it 'links to the facet and shows the number of hits' do
-    expect(rendered).to have_css 'li'
-    expect(rendered).to have_link 'x', href: '/catalog?f=x' do |link|
+    expect(page).to have_css 'li'
+    expect(page).to have_link 'x', href: '/catalog?f=x' do |link|
       link['rel'] == 'nofollow'
     end
-    expect(rendered).to have_css '.facet-count', text: '10'
+    expect(page).to have_css '.facet-count', text: '10'
   end
 
   context 'with a selected facet' do
@@ -39,12 +39,12 @@ RSpec.describe Blacklight::FacetItemComponent, type: :component do
     end
 
     it 'links to the facet and shows the number of hits' do
-      expect(rendered).to have_css 'li'
-      expect(rendered).to have_css '.selected', text: 'x'
-      expect(rendered).to have_link '[remove]', href: '/catalog' do |link|
+      expect(page).to have_css 'li'
+      expect(page).to have_css '.selected', text: 'x'
+      expect(page).to have_link '[remove]', href: '/catalog' do |link|
         link['rel'] == 'nofollow'
       end
-      expect(rendered).to have_css '.selected.facet-count', text: '10'
+      expect(page).to have_css '.selected.facet-count', text: '10'
     end
   end
 end