blacklight 8.0.0.beta1 → 8.0.0

data/lib/generators/blacklight/install_generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'shellwords'
+
 module Blacklight
   class Install < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
@@ -35,7 +37,7 @@ module Blacklight
     # Call external generator in AssetsGenerator, so we can
     # leave that callable seperately too.
     def copy_public_assets
-      generated_options = "--bootstrap-version='#{options[:'bootstrap-version']}'" if options[:'bootstrap-version']
+      generated_options = "--bootstrap-version='#{Shellwords.escape(options[:'bootstrap-version'])}'" if options[:'bootstrap-version']
 
       generate "blacklight:assets", generated_options unless options[:'skip-assets']
     end

data/lib/generators/blacklight/templates/solr_document.rb

@@ -6,12 +6,6 @@ class <%= model_name.classify %>
 
   # self.unique_key = 'id'
 
-  # Email uses the semantic field mappings below to generate the body of an email.
-  SolrDocument.use_extension(Blacklight::Document::Email)
-
-  # SMS uses the semantic field mappings below to generate the body of an SMS email.
-  SolrDocument.use_extension(Blacklight::Document::Sms)
-
   # DublinCore uses the semantic field mappings below to assemble an OAI-compliant Dublin Core document
   # Semantic mappings of solr stored fields. Fields may be multi or
   # single valued. See Blacklight::Document::SemanticFields#field_semantics

data/package.json

@@ -1,17 +1,19 @@
 {
   "name": "blacklight-frontend",
-  "version": "8.0.0-beta.1",
+  "version": "8.0.0",
   "description": "[![Build Status](https://travis-ci.com/projectblacklight/blacklight.png?branch=main)](https://travis-ci.com/projectblacklight/blacklight) [![Gem Version](https://badge.fury.io/rb/blacklight.png)](http://badge.fury.io/rb/blacklight) [![Coverage Status](https://coveralls.io/repos/github/projectblacklight/blacklight/badge.svg?branch=main)](https://coveralls.io/github/projectblacklight/blacklight?branch=main)",
   "main": "app/assets/javascripts/blacklight",
+  "module": "app/assets/javascripts/blacklight/blacklight.esm.js",
   "scripts": {
-    "js-compile-bundle": "rollup --config rollup.config.js --sourcemap && ESM=true rollup --config rollup.config.js --sourcemap"
+    "prepare": "rollup --config rollup.config.js --sourcemap && ESM=true rollup --config rollup.config.js --sourcemap"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/projectblacklight/blacklight.git"
   },
   "files": [
-    "app/assets"
+    "app/assets",
+    "app/javascript"
   ],
   "author": "",
   "license": "Apache-2.0",
@@ -20,7 +22,8 @@
   },
   "homepage": "https://github.com/projectblacklight/blacklight#readme",
   "devDependencies": {
-    "rollup": "^2.60.0"
+    "rollup": "^2.60.0",
+    "rollup-plugin-includepaths": "^0.2.4"
   },
   "browserslist": [
     "defaults",

data/rollup.config.js

@@ -1,5 +1,7 @@
 'use strict'
 
+import includePaths from 'rollup-plugin-includepaths';
+
 const path = require('path')
 
 const BUNDLE = process.env.BUNDLE === 'true'
@@ -9,6 +11,13 @@ const fileDest = `blacklight${ESM ? '.esm' : ''}`
 const external = []
 const globals = {}
 
+let includePathOptions = {
+  include: {},
+  paths: ['app/javascript'],
+  external: [],
+  extensions: ['.js']
+};
+
 const rollupConfig = {
   input: path.resolve(__dirname, `app/javascript/blacklight/index.js`),
   output: {
@@ -17,7 +26,8 @@ const rollupConfig = {
     globals,
     generatedCode: 'es2015'
   },
-  external
+  external,
+  plugins: [includePaths(includePathOptions)]
 }
 
 if (!ESM) {

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
@@ -74,6 +76,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
@@ -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,13 +115,22 @@ 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
@@ -143,25 +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:'
+    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
 
   it 'renders partials' do
-    component.partial { 'Partials' }
+    component.with_partial { 'Partials' }
     expect(rendered).to have_content 'Partials'
   end
 
-  context 'with before_title' do
+  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/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

@@ -11,7 +11,24 @@ RSpec.describe Blacklight::Response::ViewTypeComponent, type: :component do
   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,

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_component_spec.rb → search_context/server_item_pagination_component_spec.rb}

@@ -2,14 +2,17 @@
 
 require 'spec_helper'
 
-RSpec.describe Blacklight::SearchContextComponent, type: :component do
+RSpec.describe Blacklight::SearchContext::ServerItemPaginationComponent, type: :component do
   subject(:render) { render_inline(instance) }
 
-  let(:search_session) { {} }
-  let(:instance) { described_class.new(search_context: search_context, search_session: search_session) }
+  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: 9))
+    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
@@ -36,5 +39,13 @@ RSpec.describe Blacklight::SearchContextComponent, type: :component do
     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/bookmarks_controller_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe BookmarksController do
     end
 
     it 'opts out of search session tracking' do
-      expect(@controller.blacklight_config.track_search_session).to be false
+      expect(@controller.blacklight_config.track_search_session.storage).to be false
     end
   end
 

data/spec/controllers/catalog_controller_spec.rb

@@ -158,7 +158,7 @@ RSpec.describe CatalogController, api: true do
 
         format = facets.find { |x| x['id'] == 'format' }
 
-        expect(format['attributes']['items'].pluck('attributes')).to match_array([{ "value" => "Book", "hits" => 30, "label" => "Book" }])
+        expect(format['attributes']['items'].pluck('attributes')).to contain_exactly({ "value" => "Book", "hits" => 30, "label" => "Book" })
         expect(format['links']['self']).to eq facet_catalog_url(format: :json, id: 'format')
         expect(format['attributes']['items'].first['links']['self']).to eq search_catalog_url(format: :json, f: { format: ['Book'] })
       end
@@ -468,17 +468,14 @@ RSpec.describe CatalogController, api: true do
   end
 
   describe "email/sms" do
+    let(:mock_document) { SolrDocument.new }
+
     before do
-      mock_document.extend(Blacklight::Document::Sms)
-      mock_document.extend(Blacklight::Document::Email)
-      allow(mock_document).to receive(:to_semantic_values).and_return({})
       allow(mock_document).to receive(:to_model).and_return(SolrDocument.new(id: 'my_fake_doc'))
 
       allow(controller).to receive(:search_service).and_return(search_service)
       expect(search_service).to receive(:fetch).and_return([mock_document])
       request.env["HTTP_REFERER"] = "/catalog/#{doc_id}"
-      SolrDocument.use_extension(Blacklight::Document::Email)
-      SolrDocument.use_extension(Blacklight::Document::Sms)
     end
 
     describe "email", api: false do
@@ -797,6 +794,21 @@ RSpec.describe CatalogController, api: true do
       expect(controller.send(:search_facet_path, id: "some_facet", page: 5)).to eq facet_catalog_path(id: "some_facet")
     end
   end
+
+  describe "page_links" do
+    it "has prev/next docs and result set data for non-empty result sets", integration: true do
+      get :page_links, params: { f: { "format" => 'Book' }, counter: 2 }
+      expect(assigns(:page_link_data)).not_to be_empty
+      expect(assigns(:page_link_data).fetch(:prev, nil)).to end_with('counter=1')
+      expect(assigns(:page_link_data).fetch(:next, nil)).to end_with('counter=3')
+      expect(assigns(:page_link_data).fetch(:totalRaw, nil)).to be 30
+    end
+
+    it "is empty for empty result sets", integration: true do
+      get :page_links, params: { f: { "format" => 'empty-result-set' }, counter: 1 }
+      expect(assigns(:page_link_data)).to be_empty
+    end
+  end
 end
 
 # there must be at least one facet, and each facet must have at least one value

data/spec/features/component_template_override_spec.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+RSpec.describe 'Generated test application template at default path' do
+  it 'unobtrusively overrides default top navbar component template' do
+    visit root_path
+    expect(page).to have_css 'nav[data-template-override="top_navbar_component"]'
+  end
+end

data/spec/features/modal_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+RSpec.describe 'Modal' do
+  it 'can open and dismiss the email modal', js: true do
+    visit solr_document_path('2007020969')
+    expect(page).to have_no_selector 'dialog#blacklight-modal'
+    click_link 'Email'
+    expect(page).to have_selector 'dialog#blacklight-modal'
+    click_button '×'
+    expect(page).to have_no_selector 'dialog#blacklight-modal'
+  end
+end

data/spec/features/sitelinks_search_box_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.describe 'Sitelinks search box' do
+  it 'is home page' do
+    visit root_path
+    expect(page).to have_selector 'script[type="application/ld+json"]', visible: :hidden
+  end
+
+  it 'on search page' do
+    visit search_catalog_path q: 'book'
+    expect(page).not_to have_selector 'script[type="application/ld+json"]', visible: :hidden
+  end
+end

data/spec/helpers/blacklight/url_helper_behavior_spec.rb

@@ -187,7 +187,7 @@ RSpec.describe Blacklight::UrlHelperBehavior do
     end
 
     it "uses the track_search_session configuration to determine whether to track the search session" do
-      blacklight_config.track_search_session = false
+      blacklight_config.track_search_session.storage = false
       expect(helper.session_tracking_path(document, x: 1)).to be_nil
     end
   end

data/spec/helpers/blacklight_helper_spec.rb

@@ -134,18 +134,6 @@ RSpec.describe BlacklightHelper do
     end
   end
 
-  describe "render_grouped_response?" do
-    it "checks if the response ivar contains grouped data" do
-      assign(:response, instance_double(Blacklight::Solr::Response, grouped?: true))
-      expect(helper.render_grouped_response?).to be true
-    end
-
-    it "checks if the response param contains grouped data" do
-      response = instance_double(Blacklight::Solr::Response, grouped?: true)
-      expect(helper.render_grouped_response?(response)).to be true
-    end
-  end
-
   describe "#opensearch_description_tag" do
     subject { helper.opensearch_description_tag 'title', 'href' }
 
@@ -210,48 +198,4 @@ RSpec.describe BlacklightHelper do
       end
     end
   end
-
-  describe "#document_index_view_type" do
-    it "defaults to the default view" do
-      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
-      allow(helper).to receive(:default_document_index_view_type).and_return(:xyz)
-      expect(helper.document_index_view_type).to eq :xyz
-    end
-
-    it "uses the query parameter" do
-      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
-      expect(helper.document_index_view_type(view: :a)).to eq :a
-    end
-
-    it "uses the default view if the requested view is not available" do
-      allow(helper).to receive(:default_document_index_view_type).and_return(:xyz)
-      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
-      expect(helper.document_index_view_type(view: :c)).to eq :xyz
-    end
-
-    context "when they have a preferred view" do
-      before do
-        session[:preferred_view] = :b
-      end
-
-      context "and no view is specified" do
-        it "uses the saved preference" do
-          allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2, c: 3)
-          expect(helper.document_index_view_type).to eq :b
-        end
-
-        it "uses the default view if the preference is not available" do
-          allow(helper).to receive(:document_index_views).and_return(a: 1)
-          expect(helper.document_index_view_type).to eq :a
-        end
-      end
-
-      context "and a view is specified" do
-        it "uses the query parameter" do
-          allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2, c: 3)
-          expect(helper.document_index_view_type(view: :c)).to eq :c
-        end
-      end
-    end
-  end
 end

data/spec/helpers/catalog_helper_spec.rb

@@ -284,4 +284,60 @@ RSpec.describe CatalogHelper do
       it { is_expected.to eq "foobar / Format: Book" }
     end
   end
+
+  describe "render_grouped_response?" do
+    it "checks if the response ivar contains grouped data" do
+      assign(:response, instance_double(Blacklight::Solr::Response, grouped?: true))
+      expect(helper.render_grouped_response?).to be true
+    end
+
+    it "checks if the response param contains grouped data" do
+      response = instance_double(Blacklight::Solr::Response, grouped?: true)
+      expect(helper.render_grouped_response?(response)).to be true
+    end
+  end
+
+  describe "#document_index_view_type" do
+    it "defaults to the default view" do
+      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
+      allow(helper).to receive(:default_document_index_view_type).and_return(:xyz)
+      expect(helper.document_index_view_type).to eq :xyz
+    end
+
+    it "uses the query parameter" do
+      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
+      expect(helper.document_index_view_type(view: :a)).to eq :a
+    end
+
+    it "uses the default view if the requested view is not available" do
+      allow(helper).to receive(:default_document_index_view_type).and_return(:xyz)
+      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
+      expect(helper.document_index_view_type(view: :c)).to eq :xyz
+    end
+
+    context "when they have a preferred view" do
+      before do
+        session[:preferred_view] = :b
+      end
+
+      context "and no view is specified" do
+        it "uses the saved preference" do
+          allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2, c: 3)
+          expect(helper.document_index_view_type).to eq :b
+        end
+
+        it "uses the default view if the preference is not available" do
+          allow(helper).to receive(:document_index_views).and_return(a: 1)
+          expect(helper.document_index_view_type).to eq :a
+        end
+      end
+
+      context "and a view is specified" do
+        it "uses the query parameter" do
+          allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2, c: 3)
+          expect(helper.document_index_view_type(view: :c)).to eq :c
+        end
+      end
+    end
+  end
 end

data/spec/lib/blacklight/configuration/session_tracking_config_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::Configuration::SessionTrackingConfig do
+  subject(:config) { described_class.new }
+
+  it "defaults @storage to 'server'" do
+    expect(config.storage).to eq 'server'
+  end
+
+  context "@storage is set to 'server'" do
+    before do
+      config.storage = 'server'
+    end
+
+    it "defaults components values" do
+      expect(config.applied_params_component).to eq Blacklight::SearchContext::ServerAppliedParamsComponent
+      expect(config.item_pagination_component).to eq Blacklight::SearchContext::ServerItemPaginationComponent
+    end
+
+    it "defaults tracking url helper" do
+      expect(config.url_helper).to be_nil
+    end
+  end
+
+  context "@storage is set to false" do
+    before do
+      config.storage = false
+    end
+
+    it "defaults components values" do
+      expect(config.applied_params_component).to be_nil
+    end
+
+    it "defaults tracking url helper" do
+      expect(config.url_helper).to be_nil
+    end
+  end
+end

data/spec/lib/blacklight/open_struct_with_hash_access_spec.rb

@@ -76,7 +76,7 @@ RSpec.describe Blacklight::OpenStructWithHashAccess do
 
     it "sorts the underlying hash" do
       sorted = subject.sort_by { |_k, v| v }
-      expect(sorted.keys).to match_array [:b, :a, :c]
+      expect(sorted.keys).to contain_exactly(:b, :a, :c)
     end
   end
 
@@ -85,7 +85,7 @@ RSpec.describe Blacklight::OpenStructWithHashAccess do
 
     it "sorts the underlying hash" do
       subject.sort_by! { |_k, v| v }
-      expect(subject.keys).to match_array [:b, :a, :c]
+      expect(subject.keys).to contain_exactly(:b, :a, :c)
     end
   end