blacklight 8.11.0 → 9.0.0.beta2

data/app/javascript/blacklight/modalForm.js

@@ -1,60 +0,0 @@
-// The email and sms forms are displayed inside a modal.  When the form is submitted,
-// this script closes the modal and puts the output on the main part of the page.
-// By default it is rendering catalog/sms_success and catalog/email_succcess.
-// These templates deliver a payload of the format used by turbo-streams.
-// See https://turbo.hotwired.dev/handbook/streams
-// That format allows a downstream application to override the template to define
-// multiple customizable areas of the page to get updated.
-export default class {
-    constructor(errorHandler, badRequestHandler, hideModal) {
-      this.errorHandler = errorHandler
-      this.badRequestHandler = badRequestHandler
-      this.hideModal = hideModal
-    }
-
-    get triggerFormSelector() {
-      return 'form[data-blacklight-modal~=trigger]'
-    }
-
-    bind() {
-      document.addEventListener('submit', (e) => {
-         if (e.target.matches(this.triggerFormSelector))
-          this.onSubmit(e)
-      })
-    }
-
-    // This is like a light-weight version of turbo that only supports append presently.
-    updateTurboStream(data) {
-        this.hideModal()
-        const domparser = new DOMParser();
-        const dom = domparser.parseFromString(data, "text/html")
-        dom.querySelectorAll("turbo-stream[action='append']").forEach((node) => {
-          const target = node.getAttribute('target')
-          const element = document.getElementById(target)
-          if (element)
-            element.append(node.querySelector('template').content.cloneNode(true))
-          else
-            console.error(`Unable to find an element on the page with and ID of "${target}""`)
-        })
-    }
-
-    onSubmit(e) {
-        e.preventDefault();
-        const form = e.target
-        fetch(form.action, {
-            body: new FormData(form),
-            headers: { "X-Requested-With": "XMLHttpRequest" }, // Ensures rails will return true when checking request.xhr?
-            method: form.method,
-          })
-          .then(response => {
-             if (response.status === 422) {
-               return response.text().then(content => this.badRequestHandler(content) )
-             }
-             if (!response.ok) {
-               throw new TypeError("Request failed");
-             }
-             response.text().then(content => this.updateTurboStream(content))
-           })
-          .catch(error => this.errorHandler(error))
-    }
-}

data/app/views/catalog/_constraints.html.erb

@@ -1 +0,0 @@
-<%= render blacklight_config&.view_config(document_index_view_type)&.constraints_component.new(search_state: search_state) %>

data/app/views/catalog/_facet_index_navigation.html.erb

@@ -1 +0,0 @@
-<%= render(Blacklight::FacetFieldFilterComponent.new(facet_field: facet_field_presenter(@facet, @display_facet))) %>

data/app/views/catalog/_facet_layout.html.erb

@@ -1,8 +0,0 @@
-<%= render(Blacklight::FacetFieldComponent.new(facet_field: facet_field_presenter(facet_field, nil))) do |component| %>
-  <% component.with_label do %>
-    <%= facet_field_label(facet_field.key) %>
-  <% end %>
-  <% component.with_body do %>
-    <%= yield %>
-  <% end %>
-<% end %>

data/app/views/catalog/_facet_pagination.html.erb

@@ -1 +0,0 @@
-<%= render(Blacklight::FacetFieldPaginationComponent.new(facet_field: facet_field_presenter(@facet, @display_facet))) %>

data/app/views/catalog/_facets.html.erb

@@ -1,5 +0,0 @@
-<% # this partial is deprecated.  catalog/index now renders the component %>
-<% conf = blacklight_config.view_config(document_index_view_type) %>
-<%= render conf.sidebar_component.new(blacklight_config: blacklight_config,
-                                      response: @response,
-                                      view_config: conf) %>

data/app/views/catalog/_search_form.html.erb

@@ -1,7 +0,0 @@
-<%= warn "#{__file__} is a deprecated partial." %>
-<%= render((blacklight_config&.view_config(document_index_view_type)&.search_bar_component || Blacklight::SearchBarComponent).new(
-      url: search_action_url,
-      advanced_search_url: search_action_url(action: 'advanced_search'),
-      params: search_state.params_for_search.except(:qt),
-      presenter: presenter,
-      autocomplete_path: suggest_index_catalog_path)) %>

data/app/views/catalog/_search_header.html.erb

@@ -1 +0,0 @@
-<%= render blacklight_config.view_config(document_index_view_type).search_header_component.new %>

data/app/views/catalog/_show_sidebar.html.erb

@@ -1,3 +0,0 @@
-<% Blacklight.deprecation.warn('The partial catalog/_show_sidebar.html.erb will be removed in Blacklight 9.0. Configure blacklight_config.show.sidebar_component instead (default Blacklight::Search::SidebarComponent).') unless local_assigns[:silence_deprecation] %>
-<% presenter = document_presenter(document) %>
-<%= render presenter.view_config.sidebar_component.new(presenter: presenter) %>

data/app/views/catalog/_show_tools.html.erb

@@ -1,2 +0,0 @@
-<% Blacklight.deprecation.warn('The partial _show_tools.html.erb will be removed in Blacklight 9.0. Configure blacklight_config.show.show_tools_component instead (default Blacklight::Document::ShowToolsComponent).') unless local_assigns[:silence_deprecation] %>
-<%= render Blacklight::Document::ShowToolsComponent.new(document: document) %>

data/app/views/catalog/_start_over.html.erb

@@ -1 +0,0 @@
-<%= render Blacklight::StartOverButtonComponent.new %>

data/app/views/shared/_header_navbar.html.erb

@@ -1 +0,0 @@
-<%= render blacklight_config.header_component.new(blacklight_config: blacklight_config) %>

data/lib/generators/blacklight/assets/sprockets_generator.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module Blacklight
-  module Assets
-    class SprocketsGenerator < Rails::Generators::Base
-      class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 5.3'), desc: "Set the generated app's bootstrap version"
-
-      # This could be skipped if you want to use webpacker
-      def add_javascript_dependencies
-        gem 'bootstrap', options[:'bootstrap-version'].presence
-        gem 'jquery-rails' if bootstrap_4? # Bootstrap 4 has a dependency on jquery
-      end
-
-      ##
-      # Remove the empty generated app/assets/images directory. Without doing this,
-      # the default Sprockets 4 manifest will raise an exception.
-      def appease_sprockets4
-        return if Rails.version > '7' || Sprockets::VERSION < '4'
-
-        append_to_file 'app/assets/config/manifest.js', "\n//= link application.js"
-        append_to_file 'app/assets/config/manifest.js', "\n//= link blacklight/manifest.js"
-        empty_directory 'app/assets/images'
-      end
-
-      def assets
-        create_file 'app/assets/stylesheets/blacklight.scss' do
-          <<~CONTENT
-            @import 'bootstrap';
-            @import 'blacklight/blacklight';
-          CONTENT
-        end
-
-        gem "sassc-rails", "~> 2.1" if Rails.version > '7'
-
-        # Ensure this method is idempotent
-        return if has_blacklight_assets?
-
-        create_file 'app/assets/javascripts/application.js' do
-          <<~CONTENT
-            //= require rails-ujs
-            #{'//= require jquery3' if bootstrap_4?}
-
-            // Required by Blacklight
-            //= require popper
-            //= require bootstrap
-            //= require blacklight/blacklight
-          CONTENT
-        end
-      end
-
-      private
-
-      def bootstrap_4?
-        options[:'bootstrap-version'].match?(/\A[^0-9]*4\./)
-      end
-
-      def has_blacklight_assets?
-        application_js.include?('blacklight/blacklight')
-      end
-
-      def application_js
-        path = File.expand_path("app/assets/javascripts/application.js", destination_root)
-
-        File.exist?(path) ? File.read(path) : ''
-      end
-    end
-  end
-end

data/spec/components/blacklight/search/facet_suggest_input_spec.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe Blacklight::Search::FacetSuggestInput, type: :component do
-  let(:facet) { Blacklight::Configuration::FacetField.new key: 'language_facet', suggest: true }
-  let(:presenter) { instance_double(Blacklight::FacetFieldPresenter) }
-  let(:view_context) { double(ActionView::Base) }
-
-  before do
-    allow(presenter).to receive_messages(label: 'Language', view_context: view_context)
-    allow(view_context).to receive(:search_facet_path).and_return('/catalog/facet/language_facet')
-  end
-
-  it 'has an input with the facet-suggest class, which the javascript needs to find it' do
-    rendered = render_inline(described_class.new(facet: facet, presenter: presenter))
-    expect(rendered.css("input.facet-suggest").count).to eq 1
-  end
-
-  it 'has an input with the data-facet-field attribute, which the javascript needs to determine the correct query' do
-    rendered = render_inline(described_class.new(facet: facet, presenter: presenter))
-    expect(rendered.css('input[data-facet-field="language_facet"]').count).to eq 1
-  end
-
-  it 'has an input with the data-facet-search-context attribute, which the javascript needs to determine the current search context' do
-    allow(view_context).to receive(:search_facet_path).and_return('/catalog/facet/language_facet?f%5Bformat%5D%5B%5D=Book&facet.prefix=R&facet.sort=index&q=tibet&search_field=all_fields')
-    rendered = render_inline(described_class.new(facet: facet, presenter: presenter))
-    expect(rendered.css('input[data-facet-search-context="/catalog/facet/language_facet?f%5Bformat%5D%5B%5D=Book&facet.prefix=R&facet.sort=index&q=tibet&search_field=all_fields"]').count).to eq 1
-  end
-
-  it 'has a visible label that is associated with the input' do
-    rendered = render_inline(described_class.new(facet: facet, presenter: presenter))
-    label = rendered.css('label').first
-    expect(label.text.strip).to eq 'Filter Language'
-
-    id_in_label_for = label.attribute('for').text
-    expect(id_in_label_for).to eq('facet_suggest_language_facet')
-
-    expect(rendered.css('input').first.attribute('id').text).to eq id_in_label_for
-  end
-
-  context 'when the facet is explicitly configured to suggest: false' do
-    let(:facet) { Blacklight::Configuration::FacetField.new key: 'language_facet', suggest: false }
-
-    it 'does not display' do
-      expect(render_inline(described_class.new(facet: facet, presenter: presenter)).to_s).to eq ''
-    end
-  end
-
-  context 'when the facet is not explicitly configured with a suggest key' do
-    let(:facet) { Blacklight::Configuration::FacetField.new key: 'language_facet' }
-
-    it 'does not display' do
-      expect(render_inline(described_class.new(facet: facet, presenter: presenter)).to_s).to eq ''
-    end
-  end
-end

data/spec/views/catalog/_facet_index_navigation.html.erb_spec.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe 'catalog/_facet_index_navigation.html.erb' do
-  let(:pagination) { Blacklight::Solr::FacetPaginator.new([]) }
-  let(:facet) { Blacklight::Configuration::FacetField.new(index_range: '0'..'9', presenter: Blacklight::FacetFieldPresenter) }
-  let(:display_facet) { double(items: [], offset: 0, prefix: '', sort: 'index') }
-  let(:blacklight_config) { Blacklight::Configuration.new }
-
-  before do
-    assign(:display_facet, display_facet)
-    assign(:facet, facet)
-    allow(view).to receive_messages(blacklight_config: blacklight_config, facet_limit_for: 10)
-    controller.request.path_parameters[:action] = 'index'
-  end
-
-  it 'renders the facet index navigation range' do
-    render
-    expect(rendered).to have_css '.pagination'
-    expect(rendered).to have_link '0', href: '/?facet.prefix=0&facet.sort=index'
-    expect(rendered).to have_link '1'
-    expect(rendered).to have_link '8'
-    expect(rendered).to have_link '9'
-  end
-
-  it 'renders an "all" button' do
-    render
-    expect(rendered).to have_css '.page-link', text: 'All'
-  end
-
-  context 'with a selected index' do
-    let(:display_facet) { double(items: [], offset: 0, prefix: '5', sort: 'index') }
-
-    it 'highlights the selected index' do
-      render
-      expect(rendered).to have_css '.active', text: '5'
-    end
-
-    it 'enables the clear facets button' do
-      render
-      expect(rendered).to have_link 'All'
-    end
-  end
-end

data/spec/views/catalog/_facet_layout.html.erb_spec.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe "catalog/facet_layout" do
-  let :blacklight_config do
-    Blacklight::Configuration.new do |config|
-      config.facet_fields[facet_field.field] = facet_field
-    end
-  end
-
-  let :facet_field do
-    Blacklight::Configuration::FacetField.new(field: 'some_field').normalize!
-  end
-
-  before do
-    allow(view).to receive_messages(blacklight_config: blacklight_config)
-  end
-
-  it "has a facet-specific class" do
-    render partial: 'catalog/facet_layout', locals: { facet_field: facet_field }
-    expect(rendered).to have_css '.blacklight-some_field'
-  end
-
-  it "has a title with a link for a11y" do
-    render partial: 'catalog/facet_layout', locals: { facet_field: facet_field }
-    expect(rendered).to have_css 'h3', text: 'Some Field'
-  end
-
-  it "is collapsable" do
-    render partial: 'catalog/facet_layout', locals: { facet_field: facet_field }
-    expect(rendered).to have_css 'button.collapsed[data-toggle="collapse"][data-bs-toggle="collapse"][aria-expanded="false"]'
-    expect(rendered).to have_css '.collapse .card-body'
-  end
-
-  it "is configured to be open by default" do
-    allow(facet_field).to receive_messages(collapse: false)
-    render partial: 'catalog/facet_layout', locals: { facet_field: facet_field }
-    expect(rendered).to have_css 'button[data-toggle="collapse"][data-bs-toggle="collapse"][aria-expanded="true"]'
-    expect(rendered).to have_no_css '.card-header.collapsed'
-    expect(rendered).to have_css '.collapse.show .card-body'
-  end
-end

data/spec/views/catalog/_search_header.erb_spec.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-# spec for sidebar partial in catalog show view
-
-RSpec.describe "/catalog/_search_header.html.erb" do
-  it "renders the default search header partials" do
-    stub_template "_did_you_mean.html.erb" => "did_you_mean"
-    stub_template "_sort_and_per_page.html.erb" => "sort_and_per_page"
-    allow(view).to receive(:blacklight_config).and_return(CatalogController.blacklight_config)
-    render
-    expect(rendered).to match /did_you_mean/
-    expect(rendered).to match /sort_and_per_page/
-  end
-end

data/spec/views/catalog/_show_sidebar.erb_spec.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-# spec for sidebar partial in catalog show view
-
-RSpec.describe "catalog/_show_sidebar.html.erb" do
-  let(:blacklight_config) do
-    Blacklight::Configuration.new do |config|
-      config.index.title_field = 'title_tsim'
-      config.index.sidebar_component = Blacklight::Document::SidebarComponent
-    end
-  end
-
-  before do
-    allow(view).to receive_messages(blacklight_config: blacklight_config, has_user_authentication_provider?: false, document_actions: [], session_tracking_params: {})
-  end
-
-  it "shows more-like-this titles in the sidebar" do
-    document = SolrDocument.new id: 1, title_s: 'abc', format: 'default'
-    allow(document).to receive(:more_like_this).and_return([SolrDocument.new('id' => '2', 'title_tsim' => 'Title of MLT Document')])
-    render 'catalog/show_sidebar', document: document
-    expect(rendered).to include("More Like This")
-    expect(rendered).to include("Title of MLT Document")
-  end
-end

data/spec/views/catalog/_show_tools.html.erb_spec.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe "catalog/_show_tools.html.erb" do
-  let(:document) { SolrDocument.new id: 'xyz', format: 'a' }
-  let(:blacklight_config) { Blacklight::Configuration.new }
-  let(:component) { instance_double(Blacklight::Document::ShowToolsComponent) }
-
-  before do
-    allow(Blacklight::Document::ShowToolsComponent).to receive(:new).and_return(component)
-    allow(view).to receive(:render).with(component)
-    allow(view).to receive(:render).with('catalog/show_tools', { document: document }).and_call_original
-    allow(view).to receive_messages(blacklight_config: blacklight_config, has_user_authentication_provider?: false)
-  end
-
-  describe "document actions" do
-    let(:document_actions) { blacklight_config.show.document_actions }
-
-    it "renders a document action" do
-      allow(view).to receive(:some_action_solr_document_path).with(document, any_args).and_return 'x'
-      document_actions[:some_action] = Blacklight::Configuration::ToolConfig.new key: :some_action, name: :some_action, partial: 'document_action'
-      render 'catalog/show_tools', document: document
-      expect(view).to have_received(:render).with(component)
-    end
-
-    context 'without any document actions defined' do
-      before do
-        document_actions.clear
-      end
-
-      it 'does not display the tools' do
-        render 'catalog/show_tools', document: document
-
-        expect(rendered).to be_blank
-      end
-    end
-  end
-end