blacklight 7.33.0 → 8.0.0

data/spec/components/blacklight/document_component_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::DocumentComponent, type: :component do
-  subject(:component) { described_class.new(document: document, presenter: view_context.document_presenter(document), **attr) }
+  subject(:component) { described_class.new(document: document, **attr) }
 
   let(:attr) { {} }
   let(:view_context) { controller.view_context }
@@ -15,7 +15,9 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     Capybara::Node::Simple.new(render)
   end
 
-  let(:document) do
+  let(:document) { view_context.document_presenter(presented_document) }
+
+  let(:presented_document) do
     SolrDocument.new(
       id: 'x',
       thumbnail_path_ss: 'http://example.com/image.jpg',
@@ -26,7 +28,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
 
   let(:blacklight_config) do
     CatalogController.blacklight_config.deep_copy.tap do |config|
-      config.track_search_session = false
+      config.track_search_session.storage = false
       config.index.thumbnail_field = 'thumbnail_path_ss'
       config.index.document_actions[:bookmark].partial = '/catalog/bookmark_control'
     end
@@ -43,11 +45,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 +59,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 +67,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,10 +76,14 @@ 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"]'
@@ -92,9 +98,12 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     end
 
     context 'with a document rendered as part of a collection' do
-      let(:attr) { { document_counter: 10, counter_offset: 100 } }
+      # 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 } }
 
       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
@@ -106,17 +115,26 @@ 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
-      allow(view_context).to receive(:action_name).and_return('show')
+      controller.action_name = "show"
     end
 
     it 'renders with an id' do
-      component.with(:body, '-')
+      component.set_slot(:body) { '-' }
 
       expect(rendered).to have_selector 'article#document'
     end
@@ -143,35 +161,58 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       blacklight_config.show.embed_component = StubComponent
       expect(rendered).to have_content 'embed'
     end
-  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 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!' }
+    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
 
-    it 'uses the provided thumbnail component' do
-      expect(rendered).to have_content 'Thumb!'
+    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 before_title' do
+  it 'renders partials' do
+    component.with_partial { 'Partials' }
+    expect(rendered).to have_content 'Partials'
+  end
+
+  context 'with before_titles' do
     let(:render) do
       component.render_in(view_context) do
-        component.title do |c|
-          c.before_title { 'Prefix!' }
+        component.with_title do |c|
+          c.with_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'
@@ -75,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,18 +19,20 @@ 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: '/catalog?f%5Bz%5D=x'
@@ -39,21 +41,21 @@ RSpec.describe Blacklight::FacetItemPivotComponent, type: :component do
 
   it 'has the facet hierarchy' do
     expect(rendered).to have_selector 'li ul.pivot-facet'
-    expect(rendered).to have_link 'x:1', href: /f%5Bz%5D%5B%5D=x%3A1/
+    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/header_component_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::HeaderComponent, type: :component do
+  before do
+    with_controller_class(CatalogController) do
+      allow(controller).to receive(:current_user).and_return(nil)
+      allow(controller).to receive(:search_action_url).and_return('/search')
+      render
+    end
+  end
+
+  context 'with no slots' do
+    let(:render) { render_inline(described_class.new(blacklight_config: CatalogController.blacklight_config)) }
+
+    it 'draws the topbar' do
+      expect(page).to have_css 'nav.topbar'
+      expect(page).to have_link 'Blacklight', href: '/'
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# 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 }
+
+  let(:custom_component_class) do
+    Class.new(Blacklight::Icons::IconComponent) do
+      # Override component rendering with our own value
+      def call
+        'blah'
+      end
+    end
+  end
+
+  before do
+    stub_const('Blacklight::Icons::DefComponent', custom_component_class)
+  end
+
+  describe "when some views exist" do
+    before do
+      stub_const('Blacklight::Icons::AbcComponent', custom_component_class)
+    end
+
+    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.search_button do
+        c.with_search_button do
           controller.view_context.tag.button "hello", id: 'custom_search'
         end
       end

data/spec/components/blacklight/search_context/server_applied_params_component_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::SearchContext::ServerAppliedParamsComponent, type: :component do
+  subject(:render) { instance.render_in(view_context) }
+
+  let(:instance) { described_class.new }
+  let(:current_search_session) { nil }
+  let(:view_context) { controller.view_context }
+
+  before do
+    view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for('application/_start_over.html.erb' => 'start over'))
+    allow(view_context).to receive(:current_search_session).and_return current_search_session
+    allow(view_context).to receive(:link_back_to_catalog).with(any_args)
+  end
+
+  it 'is blank without current session' do
+    expect(render).to be_blank
+  end
+
+  context 'with current session' do
+    let(:current_search_session) { double(query_params: { q: 'abc' }) }
+
+    it 'is not blank' do
+      expect(render).not_to be_blank
+    end
+  end
+end

data/spec/components/blacklight/search_context/server_item_pagination_component_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::SearchContext::ServerItemPaginationComponent, type: :component do
+  subject(:render) { render_inline(instance) }
+
+  let(:current_document_id) { 9 }
+  let(:current_document) { SolrDocument.new(id: current_document_id) }
+  let(:search_session) { { 'document_id' => current_document_id } }
+  let(:instance) { described_class.new(search_context: search_context, search_session: search_session, current_document: current_document) }
+
+  before do
+    allow(controller).to receive(:current_search_session).and_return(double(id: current_document_id))
+    controller.class.helper_method :current_search_session
+  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
+
+    context "session and document are out of sync" do
+      let(:current_document) { SolrDocument.new(id: current_document_id + 1) }
+
+      it "does not render content" do
+        expect(render.to_html).to be_blank
+      end
+    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) { (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) }

data/spec/controllers/bookmarks_controller_spec.rb

@@ -7,11 +7,10 @@ RSpec.describe BookmarksController do
     end
 
     it 'opts out of search session tracking' do
-      expect(@controller.blacklight_config.track_search_session).to eq false
+      expect(@controller.blacklight_config.track_search_session.storage).to be false
     end
   end
 
-  # jquery 1.9 ajax does error callback if 200 returns empty body. so use 204 instead.
   describe "update" do
     it "has a 200 status code when creating a new one" do
       put :update, xhr: true, params: { id: '2007020969', format: :js }
@@ -105,7 +104,7 @@ RSpec.describe BookmarksController do
     end
 
     context 'created over an hour ago' do
-      let(:current_time) { Time.zone.now - 2.hours }
+      let(:current_time) { 2.hours.ago }
 
       it 'is expired' do
         get :index, params: { encrypted_user_id: token }