blacklight 7.40.0 → 8.0.0.beta1

data/rollup.config.js

@@ -0,0 +1,27 @@
+'use strict'
+
+const path = require('path')
+
+const BUNDLE = process.env.BUNDLE === 'true'
+const ESM = process.env.ESM === 'true'
+
+const fileDest = `blacklight${ESM ? '.esm' : ''}`
+const external = []
+const globals = {}
+
+const rollupConfig = {
+  input: path.resolve(__dirname, `app/javascript/blacklight/index.js`),
+  output: {
+    file: path.resolve(__dirname, `app/assets/javascripts/blacklight/${fileDest}.js`),
+    format: ESM ? 'esm' : 'umd',
+    globals,
+    generatedCode: 'es2015'
+  },
+  external
+}
+
+if (!ESM) {
+  rollupConfig.output.name = 'Blacklight'
+}
+
+module.exports = rollupConfig

data/spec/components/blacklight/constraints_component_spec.rb

@@ -13,13 +13,21 @@ RSpec.describe Blacklight::ConstraintsComponent, type: :component do
 
   let(:blacklight_config) do
     Blacklight::Configuration.new.configure do |config|
-      config.add_facet_field 'some_facet'
+      config.add_facet_field :some_facet
     end
   end
 
   let(:search_state) { Blacklight::SearchState.new(query_params.with_indifferent_access, blacklight_config) }
   let(:query_params) { {} }
 
+  context 'with no constraints' do
+    describe '#render?' do
+      it 'is false' do
+        expect(component.render?).to be false
+      end
+    end
+  end
+
   context 'with a query' do
     let(:query_params) { { q: 'some query' } }
 
@@ -43,21 +51,17 @@ RSpec.describe Blacklight::ConstraintsComponent, type: :component do
   context 'with a facet' do
     let(:query_params) { { f: { some_facet: ['some value'] } } }
 
-    before do
-      controller.blacklight_config.configure do |config|
-        config.add_facet_field :some_facet
-      end
+    it 'renders the query' do
+      expect(rendered).to have_selector('.constraint-value > .filter-name', text: 'Some Facet').and(have_selector('.constraint-value > .filter-value', text: 'some value'))
     end
 
-    # this has to be cleaned up to prevent leaking class configuration
-    after do
-      controller.blacklight_config.configure do |config|
-        config['facet_fields'].delete('some_facet')
-      end
-    end
+    context 'that is not configured' do
+      let(:query_params) { { f: { some_facet: ['some value'], missing: ['another value'] } } }
 
-    it 'renders the query' do
-      expect(rendered).to have_selector('.constraint-value > .filter-name', text: 'Some Facet').and(have_selector('.constraint-value > .filter-value', text: 'some value'))
+      it 'renders only the configured constraints' do
+        expect(rendered).to have_selector('.constraint-value > .filter-name', text: 'Some Facet').and(have_selector('.constraint-value > .filter-value', text: 'some value'))
+        expect(rendered).not_to have_selector('.constraint-value > .filter-name', text: 'Missing')
+      end
     end
   end
 

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

@@ -23,7 +23,12 @@ RSpec.describe Blacklight::Document::ActionComponent, type: :component do
   end
 
   it 'renders an action link' do
-    allow(view_context).to receive(:some_tool_solr_document_path).with(document, { only_path: true }).and_return('/asdf')
+    if Rails.version >= '6'
+      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')
+    end
+
     expect(rendered).to have_link 'Some tool', href: '/asdf'
   end
 

data/spec/components/blacklight/document_component_spec.rb

@@ -43,11 +43,11 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
   end
 
   it 'has some defined content areas' do
-    component.with(:title, 'Title')
-    component.with(:embed, 'Embed')
-    component.with(:metadata, 'Metadata')
-    component.with(:thumbnail, 'Thumbnail')
-    component.with(:actions) { 'Actions' }
+    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'
@@ -57,7 +57,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
   end
 
   it 'has schema.org properties' do
-    component.with(:body, '-')
+    component.set_slot(:body) { '-' }
 
     expect(rendered).to have_selector 'article[@itemtype="http://schema.org/Thing"]'
     expect(rendered).to have_selector 'article[@itemscope]'
@@ -65,7 +65,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
 
   context 'with a provided body' do
     it 'opts-out of normal component content' do
-      component.with(:body) { 'Body content' }
+      component.set_slot(:body) { 'Body content' }
 
       expect(rendered).to have_content 'Body content'
       expect(rendered).not_to have_selector 'header'
@@ -74,14 +74,10 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
   end
 
   context 'index view' do
-    before do
-      controller.action_name = "index"
-    end
-
     let(:attr) { { counter: 5 } }
 
     it 'has data properties' do
-      component.with(:body, '-')
+      component.set_slot(:body) { '-' }
 
       expect(rendered).to have_selector 'article[@data-document-id="x"]'
       expect(rendered).to have_selector 'article[@data-document-counter="5"]'
@@ -96,12 +92,9 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     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(:attr) { { document_counter: document_counter, counter_offset: 100 } }
+      let(:attr) { { document_counter: 10, 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
@@ -113,26 +106,17 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     it 'renders a thumbnail' do
       expect(rendered).to have_selector '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_selector 'dl.document-metadata'
-        expect(rendered).to have_selector 'dt', text: 'Title:'
-        expect(rendered).to have_selector 'dd', text: 'Title'
-        expect(rendered).not_to have_selector 'dt', text: 'ISBN:'
-      end
-    end
   end
 
   context 'show view' do
     let(:attr) { { title_component: :h1, show: true } }
 
     before do
-      controller.action_name = "show"
+      allow(view_context).to receive(:action_name).and_return('show')
     end
 
     it 'renders with an id' do
-      component.with(:body, '-')
+      component.set_slot(:body) { '-' }
 
       expect(rendered).to have_selector 'article#document'
     end
@@ -159,118 +143,25 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       blacklight_config.show.embed_component = StubComponent
       expect(rendered).to have_content 'embed'
     end
-
-    context 'show view with custom translation' do
-      let!(:original_translations) { I18n.backend.send(:translations).deep_dup }
-
-      before do
-        controller.action_name = "show"
-        I18n.backend.store_translations(:en, blacklight: { search: { show: { label: "testing:%{label}" } } })
-      end
-
-      after do
-        I18n.backend.reload!
-        I18n.backend.store_translations(:en, original_translations[:en])
-      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'
-      end
-    end
-
-    context 'with configured metadata component' do
-      let(:custom_component_class) do
-        Class.new(Blacklight::DocumentMetadataComponent) do
-          # Override component rendering with our own value
-          def call
-            'blah'
-          end
-        end
-      end
-
-      before do
-        stub_const('MyMetadataComponent', custom_component_class)
-        blacklight_config.show.metadata_component = MyMetadataComponent
-      end
-
-      it 'renders custom component' do
-        expect(rendered).to have_text 'blah'
-      end
-    end
-
-    context 'with configured title component' do
-      let(:custom_component_class) do
-        Class.new(Blacklight::DocumentTitleComponent) do
-          # Override component rendering with our own value
-          def call
-            'Titleriffic'
-          end
-        end
-      end
-
-      before do
-        stub_const('MyTitleComponent', custom_component_class)
-        blacklight_config.show.title_component = MyTitleComponent
-      end
-
-      it 'renders custom component' do
-        expect(rendered).to have_text 'Titleriffic'
-      end
-    end
-  end
-
-  context 'with a thumbnail component' do
-    let(:attr) { { thumbnail_component: thumbnail_component_class } }
-    let(:thumbnail_component_class) do
-      Class.new(ViewComponent::Base) do
-        def render_in(view_context)
-          view_context.capture { 'Thumb!' }
-        end
-      end
-    end
-
-    it 'uses the provided thumbnail component' do
-      expect(rendered).to have_content 'Thumb!'
-    end
   end
 
-  context 'with partials rendered into a component slot' do
-    it 'does not automatically renders partials' do
-      component.with_partial { 'Partials' }
-      expect(rendered).not_to have_content 'Partials'
-    end
-  end
-
-  context 'with render_partials_in_component set to true' do
-    before do
-      blacklight_config.index.render_partials_in_component = true
-    end
-
-    it 'renders partials' do
-      component.with_partial { 'Partials' }
-      expect(rendered).to have_content 'Partials'
-    end
+  it 'renders metadata' do
+    expect(rendered).to have_selector 'dl.document-metadata'
+    expect(rendered).to have_selector 'dt', text: 'Title:'
+    expect(rendered).to have_selector 'dd', text: 'Title'
+    expect(rendered).not_to have_selector 'dt', text: 'ISBN:'
   end
 
-  context 'with partials passed into the component constructor' do
-    let(:attr) { { partials: ['a'] } }
-
-    before do
-      allow(view_context).to receive(:render_document_partial).and_return('Partials')
-    end
-
-    it 'renders partials' do
-      expect(rendered).to have_content 'Partials'
-    end
+  it 'renders partials' do
+    component.partial { 'Partials' }
+    expect(rendered).to have_content 'Partials'
   end
 
-  context 'with before_titles' do
+  context 'with before_title' do
     let(:render) do
       component.render_in(view_context) do
-        component.with_title do |c|
-          c.with_before_title { 'Prefix!' }
+        component.title do |c|
+          c.before_title { 'Prefix!' }
         end
       end
     end

data/spec/components/blacklight/facet_component_spec.rb

@@ -15,12 +15,7 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
     instance_double(Blacklight::Solr::Response::Facets::FacetField, name: 'field', items: items, limit: nil, sort: :index, offset: 0, prefix: nil)
   end
 
-  let(:facet_config) { Blacklight::Configuration::FacetField.new(key: 'field', component: Blacklight::FacetFieldListComponent).normalize! }
-
-  before do
-    allow(controller).to receive(:view_context).and_return(controller.view_context)
-    allow(controller.view_context).to receive(:facet_limit_for).and_return(20)
-  end
+  let(:facet_config) { Blacklight::Configuration::FacetField.new(key: 'field').normalize! }
 
   it 'delegates to the configured component to render something' do
     expect(rendered).to have_selector 'ul.facet-values'
@@ -51,17 +46,7 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
     end
 
     before do
-      # Not sure why we need to re-implement rspec's stub_template, but
-      # we already were, and need a Rails 7.1+ safe alternate too
-      # https://github.com/rspec/rspec-rails/commit/4d65bea0619955acb15023b9c3f57a3a53183da8
-      # https://github.com/rspec/rspec-rails/issues/2696
-
-      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))
-      else
-        controller.view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
-      end
+      controller.view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for('catalog/_facet_partial.html.erb' => 'facet partial'))
     end
 
     it 'renders the partial' do
@@ -85,7 +70,7 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
     end
 
     context 'when the field is not in the response' do
-      let(:facet_config) { Blacklight::Configuration::FacetField.new(key: 'some_other_field', component: Blacklight::FacetFieldListComponent).normalize! }
+      let(:facet_config) { Blacklight::Configuration::FacetField.new(key: 'some_other_field').normalize! }
 
       it 'uses a null field to pass through the response information anyway' do
         allow(facet_config.component).to receive(:new).and_call_original

data/spec/components/blacklight/facet_field_checkboxes_component_spec.rb

@@ -10,14 +10,13 @@ RSpec.describe Blacklight::FacetFieldCheckboxesComponent, type: :component do
   let(:facet_field) do
     instance_double(
       Blacklight::FacetFieldPresenter,
-      facet_field: Blacklight::Configuration::NullField.new(key: 'field'),
+      facet_field: Blacklight::Configuration::NullField.new(key: 'field', item_component: Blacklight::FacetItemComponent, item_presenter: Blacklight::FacetItemPresenter),
       paginator: paginator,
       key: 'field',
       label: 'Field',
       active?: false,
       collapsed?: false,
       modal_path: nil,
-      html_id: 'facet-field',
       search_state: search_state
     )
   end

data/spec/components/blacklight/facet_field_list_component_spec.rb

@@ -11,16 +11,18 @@ RSpec.describe Blacklight::FacetFieldListComponent, type: :component do
     instance_double(
       Blacklight::FacetFieldPresenter,
       paginator: paginator,
+      facet_field: facet_config,
       key: 'field',
       label: 'Field',
       active?: false,
       collapsed?: false,
       modal_path: nil,
-      html_id: 'facet-field',
       values: []
     )
   end
 
+  let(:facet_config) { Blacklight::Configuration::NullField.new(key: 'field', item_component: Blacklight::FacetItemComponent, item_presenter: Blacklight::FacetItemPresenter) }
+
   let(:paginator) do
     instance_double(Blacklight::FacetPaginator, items: [
                       double(label: 'x', hits: 10),
@@ -45,12 +47,12 @@ RSpec.describe Blacklight::FacetFieldListComponent, type: :component do
       instance_double(
         Blacklight::FacetFieldPresenter,
         paginator: paginator,
+        facet_field: facet_config,
         key: 'field',
         label: 'Field',
         active?: true,
         collapsed?: false,
         modal_path: nil,
-        html_id: 'facet-field',
         values: []
       )
     end
@@ -65,12 +67,12 @@ RSpec.describe Blacklight::FacetFieldListComponent, type: :component do
       instance_double(
         Blacklight::FacetFieldPresenter,
         paginator: paginator,
+        facet_field: facet_config,
         key: 'field',
         label: 'Field',
         active?: false,
         collapsed?: true,
         modal_path: nil,
-        html_id: 'facet-field',
         values: []
       )
     end
@@ -91,12 +93,12 @@ RSpec.describe Blacklight::FacetFieldListComponent, type: :component do
       instance_double(
         Blacklight::FacetFieldPresenter,
         paginator: paginator,
+        facet_field: facet_config,
         key: 'field',
         label: 'Field',
         active?: false,
         collapsed?: false,
         modal_path: '/catalog/facet/modal',
-        html_id: 'facet-field',
         values: []
       )
     end
@@ -111,13 +113,12 @@ RSpec.describe Blacklight::FacetFieldListComponent, type: :component do
       instance_double(
         Blacklight::FacetFieldPresenter,
         paginator: paginator,
-        facet_field: Blacklight::Configuration::NullField.new(key: 'field'),
+        facet_field: facet_config,
         key: 'field',
         label: 'Field',
         active?: false,
         collapsed?: false,
         modal_path: nil,
-        html_id: 'facet-field',
         values: [%w[a b c]],
         search_state: search_state
       )

data/spec/components/blacklight/facet_item_pivot_component_spec.rb

@@ -19,42 +19,43 @@ RSpec.describe Blacklight::FacetItemPivotComponent, type: :component do
 
   let(:facet_item) do
     instance_double(
-      Blacklight::FacetItemPresenter,
-      facet_config: Blacklight::Configuration::FacetField.new(key: 'z'),
+      Blacklight::FacetItemPivotPresenter,
+      facet_config: facet_config,
       facet_field: 'z',
       label: 'x',
       hits: 10,
       href: '/catalog?f[z]=x',
       selected?: false,
       search_state: search_state,
-      items: [OpenStruct.new(value: 'x:1', hits: 5)]
+      facet_item_presenters: [OpenStruct.new(label: 'x:1', hits: 5, href: '/catalog?f[z][]=x:1', facet_config: facet_config)]
     )
   end
 
+  let(:facet_config) { Blacklight::Configuration::NullField.new(key: 'z', item_component: Blacklight::FacetItemComponent, item_presenter: Blacklight::FacetItemPivotPresenter) }
+
   it 'links to the facet and shows the number of hits' do
     expect(rendered).to have_selector 'li'
-    expect(rendered).to have_link 'x', href: nokogiri_mediated_href(facet_item.href)
+    expect(rendered).to have_link 'x', href: '/catalog?f%5Bz%5D=x'
     expect(rendered).to have_selector '.facet-count', text: '10'
   end
 
   it 'has the facet hierarchy' do
-    pending
     expect(rendered).to have_selector 'li ul.pivot-facet'
-    expect(rendered).to have_link 'x:1', href: nokogiri_mediated_href(facet_item.facet_item_presenters.first.href)
+    expect(rendered).to have_link 'x:1', href: /f%5Bz%5D%5B%5D=x:1/
   end
 
   context 'with a selected facet' do
     let(:facet_item) do
       instance_double(
-        Blacklight::FacetItemPresenter,
-        facet_config: Blacklight::Configuration::FacetField.new,
+        Blacklight::FacetItemPivotPresenter,
+        facet_config: facet_config,
         facet_field: 'z',
         label: 'x',
         hits: 10,
         href: '/catalog',
         selected?: true,
         search_state: search_state,
-        items: []
+        facet_item_presenters: []
       )
     end
 

data/spec/components/blacklight/response/view_type_component_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::Response::ViewTypeComponent, type: :component do
+  subject(:render) do
+    render_inline(described_class.new(response: response, views: views, search_state: search_state))
+  end
+
+  let(:response) { instance_double(Blacklight::Solr::Response, empty?: false) }
+  let(:search_state) { instance_double(Blacklight::SearchState, to_h: { controller: 'catalog', action: 'index' }) }
+  let(:view_config) { Blacklight::Configuration::ViewConfig.new }
+
+  describe "when some views exist" do
+    let(:views) do
+      {
+        abc: view_config,
+        def: view_config
+      }
+    end
+
+    it "draws the group" do
+      expect(render.css('.view-type-group')).to be_present
+    end
+  end
+
+  context 'with a icon component class' do
+    let(:views) do
+      { abc: Blacklight::Configuration::ViewConfig.new(icon: Blacklight::Icons::ListComponent), def: view_config }
+    end
+
+    it 'draws the icon' do
+      expect(render.css('.view-type-abc svg')).to be_present
+    end
+  end
+
+  context 'with a icon component instance' do
+    let(:views) do
+      { abc: Blacklight::Configuration::ViewConfig.new(icon: Blacklight::Icons::ListComponent.new), def: view_config }
+    end
+
+    it 'draws the icon' do
+      expect(render.css('.view-type-abc svg')).to be_present
+    end
+  end
+
+  context 'with a icon with the svg given in-line' do
+    let(:views) do
+      { abc: Blacklight::Configuration::ViewConfig.new(icon: Blacklight::Icons::IconComponent.new(svg: 'blah')), def: view_config }
+    end
+
+    it 'draws the icon' do
+      expect(render.css('.view-type-abc').text).to include 'blah'
+    end
+  end
+
+  describe "when no views exist" do
+    let(:views) do
+      {}
+    end
+
+    it "draws nothing" do
+      expect(render.to_html).to be_blank
+    end
+  end
+end

data/spec/components/blacklight/search_bar_component_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe Blacklight::SearchBarComponent, type: :component do
   context 'when a button is passed in' do
     subject(:render) do
       render_inline(instance) do |c|
-        c.with_search_button do
+        c.search_button do
           controller.view_context.tag.button "hello", id: 'custom_search'
         end
       end

data/spec/components/blacklight/search_context_component_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::SearchContextComponent, type: :component do
+  subject(:render) { render_inline(instance) }
+
+  let(:search_session) { {} }
+  let(:instance) { described_class.new(search_context: search_context, search_session: search_session) }
+
+  before do
+    allow(controller).to receive(:current_search_session).and_return(double(id: 9))
+  end
+
+  context 'when there is no next or previous' do
+    let(:search_context) { {} }
+
+    it "does not render content" do
+      expect(render.to_html).to be_blank
+    end
+  end
+
+  context 'when there is next and previous' do
+    let(:search_context) { { next: next_doc, prev: prev_doc } }
+    let(:prev_doc) { SolrDocument.new(id: '777') }
+    let(:next_doc) { SolrDocument.new(id: '888') }
+
+    before do
+      # allow(controller).to receive(:controller_tracking_method).and_return('track_catalog_path')
+      allow(controller).to receive(:controller_name).and_return('catalog')
+
+      allow(controller).to receive(:link_to_previous_document).and_return('')
+      allow(controller).to receive(:link_to_next_document).and_return('')
+    end
+
+    it "renders content" do
+      expect(render.css('.pagination-search-widgets').to_html).not_to be_blank
+    end
+  end
+end

data/spec/controllers/blacklight/catalog/component_configuration_spec.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-RSpec.describe Blacklight::DefaultComponentConfiguration do
+RSpec.describe CatalogController do
   subject do
     Class.new do
       include Blacklight::Configurable
-      include Blacklight::DefaultComponentConfiguration
 
       def some_existing_action
         1
@@ -12,10 +11,6 @@ RSpec.describe Blacklight::DefaultComponentConfiguration do
     end
   end
 
-  before do
-    allow(Deprecation).to receive(:warn)
-  end
-
   describe ".add_show_tools_partial" do
     it "defines an action method" do
       subject.blacklight_config.add_show_tools_partial :xyz

data/spec/controllers/blacklight/{base_spec.rb → catalog_spec.rb}

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-RSpec.describe Blacklight::Base do
+RSpec.describe Blacklight::Catalog do
   subject { controller }
 
-  let(:controller) { Deprecation.silence(described_class) { (Class.new(ApplicationController) { include Blacklight::Base }).new } }
+  let(:controller) { (Class.new(ApplicationController) { include Blacklight::Catalog }).new }
 
   describe "#search_state" do
     subject { controller.send(:search_state) }