blacklight 8.0.1 → 8.2.0

data/app/javascript/blacklight/bookmark_toggle.js

@@ -1,4 +1,4 @@
-import CheckboxSubmit from 'blacklight/checkbox_submit'
+import CheckboxSubmit from './checkbox_submit.js'
 
 const BookmarkToggle = (e) => {
   if (e.target.matches('[data-checkboxsubmit-target="checkbox"]')) {

data/app/javascript/blacklight/checkbox_submit.js

@@ -18,11 +18,11 @@ export default class CheckboxSubmit {
     this.form = form
   }
 
-  async clicked(evt) {
+  clicked(evt) {
     this.spanTarget.innerHTML = this.form.getAttribute('data-inprogress')
     this.labelTarget.setAttribute('disabled', 'disabled');
     this.checkboxTarget.setAttribute('disabled', 'disabled');
-    const response = await fetch(this.formTarget.getAttribute('action'), {
+    fetch(this.formTarget.getAttribute('action'), {
       body: new FormData(this.formTarget),
       method: this.formTarget.getAttribute('method').toUpperCase(),
       headers: {
@@ -30,16 +30,17 @@ export default class CheckboxSubmit {
         'X-Requested-With': 'XMLHttpRequest',
         'X-CSRF-Token': document.querySelector('meta[name=csrf-token]')?.content
       }
-    })
-    this.labelTarget.removeAttribute('disabled')
-    this.checkboxTarget.removeAttribute('disabled')
-    if (response.ok) {
-      const json = await response.json()
+    }).then((response) => {
+      if (response.ok) return response.json();
+      return Promise.reject('response was not ok')
+    }).then((json) => {
+      this.labelTarget.removeAttribute('disabled')
+      this.checkboxTarget.removeAttribute('disabled')
       this.updateStateFor(!this.checked)
       document.querySelector('[data-role=bookmark-counter]').innerHTML = json.bookmarks.count
-    } else {
-      alert('Error')
-    }
+    }).catch((error) => {
+      this.handleError(error)
+    })
   }
 
   get checked() {
@@ -62,6 +63,10 @@ export default class CheckboxSubmit {
     return this.form.querySelector('[data-checkboxsubmit-target="span"]')
   }
 
+  handleError() {
+    alert("Unable to save the bookmark at this time.")
+  }
+
   updateStateFor(state) {
     this.checkboxTarget.checked = state
 

data/app/javascript/blacklight/index.js

@@ -1,8 +1,13 @@
-import BookmarkToggle from 'blacklight/bookmark_toggle'
-import ButtonFocus from 'blacklight/button_focus'
-import Modal from 'blacklight/modal'
-import SearchContext from 'blacklight/search_context'
-import Core from 'blacklight/core'
+// ALL imports in this dir, including in files imported, should be RELATIVE
+// paths to keep things working in the various ways these files get used, at
+// both compile time and npm package run time.
+
+import BookmarkToggle from './bookmark_toggle.js'
+import ButtonFocus from './button_focus.js'
+import Modal from './modal.js'
+import SearchContext from './search_context.js'
+import Core from './core.js'
+
 
 export default {
   BookmarkToggle,

data/app/javascript/blacklight/modal.js

@@ -52,7 +52,7 @@
   can be a turbo-stream that defines some HTML fragementsand where on the page to put them:
   https://turbo.hotwired.dev/handbook/streams
 */
-import ModalForm from 'blacklight/modalForm'
+import ModalForm from './modalForm.js'
 
 const Modal = (() => {
   const modal = {}
@@ -97,21 +97,35 @@ const Modal = (() => {
   }
 
   // Add the passed in contents to the modal and display it.
+  // We have specific handling so that scripts returned from the ajax call are executed.
+  // This enables adding a script like recaptcha to prevent bots from sending emails.
   modal.receiveAjax = function (contents) {
-      const domparser = new DOMParser();
-      const dom = domparser.parseFromString(contents, "text/html")
-      // If there is a containerSelector on the document, use its children.
-      let elements = dom.querySelectorAll(`${modal.containerSelector} > *`)
-      if (elements.length == 0) {
-        // If the containerSelector wasn't found, use the whole document
-        elements = dom.body.childNodes
-      }
-
-      document.querySelector(`${modal.modalSelector} .modal-content`).replaceChildren(...elements)
-
-      modal.show();
+    const domparser = new DOMParser();
+    const dom = domparser.parseFromString(contents, "text/html")
+    // If there is a containerSelector on the document, use its children.
+    let elements = dom.querySelectorAll(`${modal.containerSelector} > *`)
+    const frag = document.createDocumentFragment()
+    if (elements.length == 0) {
+      // If the containerSelector wasn't found, use the whole document
+      elements = dom.body.childNodes
+    }
+    elements.forEach((el) => frag.appendChild(el))
+    modal.activateScripts(frag)
+    
+    document.querySelector(`${modal.modalSelector} .modal-content`).replaceChildren(frag)
+
+    modal.show();
   };
 
+  // DOMParser doesn't allow scripts to be executed.  This fixes that.
+  modal.activateScripts = function (frag) {
+    frag.querySelectorAll('script').forEach((script) => {
+      const fixedScript = document.createElement('script')
+      fixedScript.src = script.src
+      fixedScript.async = false
+      script.parentNode.replaceChild(fixedScript, script)
+    })
+  }
 
   modal.modalAjaxLinkClick = function(e) {
     e.preventDefault();

data/app/javascript/blacklight/search_context.js

@@ -27,6 +27,7 @@ SearchContext.handleSearchContextMethod = function(event) {
 
   // check for meta keys.. if set, we should open in a new tab
   if(event.metaKey || event.ctrlKey) {
+    form.dataset.turbo = "false";
     target = '_blank';
   }
 

data/app/models/concerns/blacklight/document/active_model_shim.rb

@@ -29,6 +29,16 @@ module Blacklight::Document
       def find id
         repository.find(id).documents.first
       end
+
+      # In Rails 7.1+, needs this method
+      def composite_primary_key?
+        false
+      end
+
+      # In Rails 7.1+, needs this method
+      def has_query_constraints?
+        false
+      end
     end
 
     ##

data/app/models/search.rb

@@ -3,7 +3,12 @@
 class Search < ApplicationRecord
   belongs_to :user, optional: true
 
-  serialize :query_params, Blacklight::SearchParamsYamlCoder
+  if ::Rails.version.to_f >= 7.1
+    # non-deprecated coder: keyword arg for Rails 7.1+
+    serialize :query_params, coder: Blacklight::SearchParamsYamlCoder
+  else
+    serialize :query_params, Blacklight::SearchParamsYamlCoder
+  end
 
   # A Search instance is considered a saved search if it has a user_id.
   def saved?

data/app/services/blacklight/field_retriever.rb

@@ -22,17 +22,19 @@ module Blacklight
 
     # @return [Array]
     def fetch
-      Array.wrap(
-        if field_config.highlight
-          retrieve_highlight
-        elsif field_config.accessor
-          retieve_using_accessor
-        elsif field_config.values
-          retrieve_values
-        else
-          retrieve_simple
-        end
-      )
+      if field_config.highlight
+        value = retrieve_highlight
+      end
+      if value.blank?
+        value = if field_config.accessor
+                  retieve_using_accessor
+                elsif field_config.values
+                  retrieve_values
+                else
+                  retrieve_simple
+                end
+      end
+      Array.wrap(value)
     end
 
     private

data/app/values/blacklight/types.rb

@@ -65,6 +65,19 @@ module Blacklight
       end
     end
 
+    class Time < Value
+      def cast(input)
+        value = super
+        return if value.blank?
+
+        begin
+          ::Time.parse(value.to_s) # rubocop:disable Rails/TimeZone
+        rescue ArgumentError
+          Rails.logger&.info "Unable to parse time: #{value.inspect}"
+        end
+      end
+    end
+
     class Boolean < Value
       def cast(input)
         ActiveModel::Type::Boolean.new.cast(super)
@@ -106,6 +119,7 @@ module Blacklight
     register :boolean, Boolean
     register :string, String
     register :date, Date
+    register :time, Time
     register :array, Array
     register :json, JsonValue
     register :html, Html

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

@@ -1,6 +1,6 @@
 <%= render(Blacklight::AdvancedSearchFormComponent.new(
       url: search_action_url,
-      classes: ['advanced', 'form-horizontal'],
+      classes: ['advanced'],
       params: search_state.params_for_search.except(:qt),
       response: @response
     )) %>

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

@@ -1,5 +1,5 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.title { t('blacklight.tools.citation') } %>
+  <% component.with_title { t('blacklight.tools.citation') } %>
 
   <%= render Blacklight::Document::CitationComponent.with_collection(@documents) if @documents.present? %>
 <% end %>

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

@@ -1,2 +1,2 @@
-<% Blacklight.deprecation.warn('The partial _show_tools.html.erb will be removed in 9.0. Configure blacklight_config.show.show_tools_component instead (default Blacklight::Document::ShowToolsComponent).') unless local_assigns[:silence_deprecation] %>
+<% 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/email.html.erb

@@ -1,7 +1,7 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.title { t('blacklight.email.form.title') } %>
+  <% component.with_title { t('blacklight.email.form.title') } %>
 
-  <% component.body do %>
+  <% component.with_body do %>
     <%= render 'email_form' %>
   <% end %>
 <% end %>

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

@@ -1,7 +1,7 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.title { t('blacklight.sms.form.title') } %>
+  <% component.with_title { t('blacklight.sms.form.title') } %>
 
-  <% component.body do %>
+  <% component.with_body do %>
     <%= render 'sms_form' %>
   <% end %>
 <% end %>

data/app/views/kaminari/blacklight/_page.html.erb

@@ -11,7 +11,7 @@
 
 <li class="page-item <%= 'active' if page.current? %>">
   <% if page.current? %>
-    <span class="page-link" aria-label="<%= t('views.pagination.aria.current_page', page: page_display) %>" aria-current="true"><%= page_display %></span>
+    <span class="page-link" aria-current="true"><%= page_display %><span class="sr-only visually-hidden"> <%= t('views.pagination.aria.current_page', page: page_display) %></span></span>
   <% else %>
     <%= link_to page_display, url, :remote => remote, :rel => page.next? ? 'next' : page.prev? ? 'prev' : nil, class: 'page-link', aria: { label: t('views.pagination.aria.go_to_page', page: page_display) } %>
   <% end %>

data/blacklight.gemspec

@@ -31,14 +31,13 @@ Gem::Specification.new do |s|
   s.add_dependency "kaminari", ">= 0.15" # the pagination (page 1,2,3, etc..) of our search results
   s.add_dependency "i18n", '>= 1.7.0' # added named parameters
   s.add_dependency "ostruct", '>= 0.3.2'
-  s.add_dependency "view_component", '>= 2.66', '< 3.1'
+  s.add_dependency "view_component", '>= 2.66', '< 4'
 
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.
-  s.add_development_dependency "rspec-rails", "~> 6.0"
+  s.add_development_dependency "rspec-rails", "~> 6.1"
   s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
   s.add_development_dependency 'axe-core-rspec'
   s.add_development_dependency "capybara", '~> 3'
-  s.add_development_dependency 'webdrivers'
   s.add_development_dependency 'selenium-webdriver'
   s.add_development_dependency 'engine_cart', '~> 2.1'
   s.add_development_dependency "equivalent-xml"

data/config/locales/blacklight.ar.yml

@@ -101,7 +101,6 @@ ar:
         group:
           close: إخفاء الأوجه
           open: عرض الأوجه
-          toggle: المزيد »
         missing: "[غير موجود]"
         more_html: المزيد <span class="sr-only visually-hidden">%{field_name}</span> »
         pivot:

data/config/locales/blacklight.ca.yml

@@ -190,8 +190,6 @@ ca:
         pivot:
           show: Mostrar
           hide: Amagar
-        group:
-          toggle: 'altres »'
       group:
         more: 'més »'
       filters:

data/config/locales/blacklight.de.yml

@@ -91,7 +91,6 @@ de:
         group:
           close: Facetten ausblenden
           open: Facetten zeigen
-          toggle: mehr »
         missing:
         - fehlt
         more_html: mehr <span class="sr-only visually-hidden">%{field_name}</span> »

data/config/locales/blacklight.en.yml

@@ -191,7 +191,6 @@ en:
           show: Show
           hide: Hide
         group:
-          toggle: Toggle facets
           open: Show facets
           close: Hide facets
       group:
@@ -244,6 +243,7 @@ en:
       more_options: More options
       any_of: 'Any of:'
       op:
+        label: search operator
         must: all
         should: any
       page_title: Advanced search - %{application_name}

data/config/locales/blacklight.es.yml

@@ -91,7 +91,6 @@ es:
         group:
           close: Ocultar facetas
           open: Mostrar facetas
-          toggle: más »
         missing: "[Falta]"
         more_html: más <span class="sr-only visually-hidden">%{field_name}</span> »
         pivot:

data/config/locales/blacklight.fr.yml

@@ -91,7 +91,6 @@ fr:
         group:
           close: Masquer les facettes
           open: Afficher les facettes
-          toggle: plus »
         missing: "[manquante]"
         more_html: plus <span class="sr-only visually-hidden">%{field_name}</span> »
         pivot:

data/config/locales/blacklight.hu.yml

@@ -89,7 +89,6 @@ hu:
         group:
           close: Fazetek elrejtése
           open: Szempontok megjelenítése
-          toggle: több »
         missing: "[Hiányzó]"
         more_html: több <span class="sr-only visually-hidden">%{field_name}</span> »
         pivot:

data/config/locales/blacklight.it.yml

@@ -91,7 +91,6 @@ it:
         group:
           close: Nascondi sfaccettature
           open: Mostra sfaccettature
-          toggle: altri »
         missing:
         - Mancante
         more_html: altri <span class="sr-only visually-hidden">%{field_name}</span> »

data/config/locales/blacklight.nl.yml

@@ -89,7 +89,6 @@ nl:
         group:
           close: Verberg facetten
           open: Toon facetten
-          toggle: meer »
         missing: "[Ontbrekend]"
         more_html: Meer <span class="sr-only visually-hidden">%{field_name}</span> »
         pivot:

data/config/locales/blacklight.pt-BR.yml

@@ -89,7 +89,6 @@ pt-BR:
         group:
           close: Ocultar facetas
           open: Mostrar facetas
-          toggle: mais »
         missing:
         - Ausência
         more_html: mais <span class="sr-only visually-hidden">%{field_name}</span> »

data/config/locales/blacklight.sq.yml

@@ -89,7 +89,6 @@ sq:
         group:
           close: Fshih aspektet
           open: Trego aspektet
-          toggle: më shumë »
         missing: "[Mungon]"
         more_html: Më shumë <span class="sr-only visually-hidden">%{field_name}</span> »
         pivot:

data/config/locales/blacklight.zh.yml

@@ -89,7 +89,6 @@ zh:
         group:
           close: 隐藏方面
           open: 显示方面
-          toggle: 更多 »
         missing: "[未找到]"
         more_html: 更多 <span class="sr-only visually-hidden">%{field_name}</span> »
         pivot:

data/docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.7"
-
 services:
   app:
     build:

data/lib/blacklight/component.rb

@@ -47,7 +47,7 @@ module Blacklight
 
           component_class.sidecar_files(extensions).each_with_object([]) do |path, memo|
             pieces = File.basename(path).split(".")
-            app_path = "#{Rails.root}/#{path.slice(path.index(component_class.view_component_path)..-1)}"
+            app_path = Rails.root.join(path.slice(path.index(component_class.view_component_path)..-1).to_s).to_s
 
             memo << {
               path: File.exist?(app_path) ? app_path : path,

data/lib/blacklight/configuration.rb

@@ -87,6 +87,10 @@ module Blacklight
       # @since v5.2.0
       # @return [String] The url path (relative to the solr base url) to use when requesting only a single document
       property :document_solr_path, default: 'get'
+      # @!attribute json_solr_path
+      # @since v7.34.0
+      # @return [String] The url path (relative to the solr base url) to use when using Solr's JSON Query DSL (as with the advanced search)
+      property :json_solr_path, default: 'advanced'
       # @!attribute document_unique_id_param
       # @since v5.2.0
       # @return [Symbol] The solr query parameter used for sending the unique identifiers for one or more documents
@@ -171,7 +175,9 @@ module Blacklight
         # component class used to render the search bar
         search_bar_component: nil,
         # component class used to render the header above the documents
-        search_header_component: Blacklight::SearchHeaderComponent
+        search_header_component: Blacklight::SearchHeaderComponent,
+        # pagination parameters to pass to kaminari
+        pagination_options: Blacklight::Engine.config.blacklight.default_pagination_options.dup
       )
 
       # @!attribute show

data/lib/blacklight/engine.rb

@@ -6,6 +6,18 @@ module Blacklight
   class Engine < Rails::Engine
     engine_name "blacklight"
 
+    config.before_configuration do
+      # see https://github.com/fxn/zeitwerk#for_gem
+      # Blacklight puts a generator into LOCAL APP lib/generators, so tell
+      # zeitwerk to ignore the whole directory? If we're using a recent
+      # enough version of Rails to have zeitwerk config
+      #
+      # See: https://github.com/cbeer/engine_cart/issues/117
+      if Rails.try(:autoloaders).try(:main).respond_to?(:ignore)
+        Rails.autoloaders.main.ignore(Rails.root.join('lib/generators'))
+      end
+    end
+
     config.after_initialize do
       Blacklight::Configuration.initialize_default_configuration
     end

data/lib/blacklight/solr/repository.rb

@@ -21,7 +21,9 @@ module Blacklight::Solr
     # Execute a search query against solr
     # @param [Hash] params solr query parameters
     def search params = {}
-      send_and_receive blacklight_config.solr_path, params.reverse_merge(qt: blacklight_config.qt)
+      request_params = params.reverse_merge({ qt: blacklight_config.qt })
+
+      send_and_receive search_path(request_params), request_params
     end
 
     # @param [Hash] request_params
@@ -78,7 +80,7 @@ module Blacklight::Solr
     # @return [Hash]
     # @!visibility private
     def build_solr_request(solr_params)
-      if solr_params[:json].present?
+      if uses_json_query_dsl?(solr_params)
         {
           data: { params: solr_params.to_hash.except(:json) }.merge(solr_params[:json]).to_json,
           method: :post,
@@ -122,5 +124,17 @@ module Blacklight::Solr
         []
       end
     end
+
+    # @return [String]
+    def search_path(solr_params)
+      return blacklight_config.json_solr_path if blacklight_config.json_solr_path && uses_json_query_dsl?(solr_params)
+
+      blacklight_config.solr_path
+    end
+
+    # @return [Boolean]
+    def uses_json_query_dsl?(solr_params)
+      solr_params[:json].present?
+    end
   end
 end

data/lib/blacklight/solr/response/params.rb

@@ -31,7 +31,7 @@ module Blacklight::Solr::Response::Params
     defaults = {
       sort: single_valued_param(:'facet.sort'),
       limit: single_valued_param(:'facet.limit')&.to_i || 100,
-      offset: single_valued_param(:'facet.offset')&.to_i || 0,
+      offset: single_valued_param(:'facet.offset').to_i,
       prefix: single_valued_param(:'facet.prefix')
     }
 

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -83,7 +83,10 @@ module Blacklight::Solr
     end
 
     def add_search_field_with_json_query_parameters(solr_parameters)
+      return unless search_state.query_param
+
       bool_query = search_field.clause_params.transform_values { |v| v.merge(query: search_state.query_param) }
+      solr_parameters["spellcheck.q"] ||= search_state.query_param
 
       solr_parameters.append_boolean_query(:must, bool_query)
     end

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

@@ -3,7 +3,7 @@
 module Blacklight
   module Assets
     class ImportmapGenerator < Rails::Generators::Base
-      class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 5.1'), desc: "Set the generated app's bootstrap version"
+      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
@@ -16,7 +16,7 @@ module Blacklight
           <<~CONTENT
             pin "@github/auto-complete-element", to: "https://cdn.skypack.dev/@github/auto-complete-element"
             pin "@popperjs/core", to: "https://ga.jspm.io/npm:@popperjs/core@2.11.6/dist/umd/popper.min.js"
-            pin "bootstrap", to: "https://ga.jspm.io/npm:bootstrap@#{(defined?(Bootstrap) && Bootstrap::VERSION) || '5.2.2'}/dist/js/bootstrap.js"
+            pin "bootstrap", to: "https://ga.jspm.io/npm:bootstrap@#{(defined?(Bootstrap) && Bootstrap::VERSION) || '5.3.2'}/dist/js/bootstrap.js"
           CONTENT
         end
 

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

@@ -3,7 +3,7 @@
 module Blacklight
   module Assets
     class SprocketsGenerator < Rails::Generators::Base
-      class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 5.1'), desc: "Set the generated app's bootstrap version"
+      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

data/lib/generators/blacklight/assets_generator.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
-require 'shellwords'
-
 module Blacklight
   class AssetsGenerator < Rails::Generators::Base
-    class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 5.1'), desc: "Set the generated app's bootstrap version"
+    class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 5.3'), desc: "Set the generated app's bootstrap version"
 
     def run_asset_pipeline_specific_generator
-      generated_options = "--bootstrap-version='#{Shellwords.escape(options[:'bootstrap-version'])}'" if options[:'bootstrap-version']
+      generated_options = "--bootstrap-version='#{options[:'bootstrap-version']}'" if options[:'bootstrap-version']
 
       generator = if defined?(Propshaft)
                     'blacklight:assets:propshaft'

data/lib/generators/blacklight/install_generator.rb

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

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

@@ -38,6 +38,7 @@ class <%= controller_name.classify %>Controller < ApplicationController
     # solr path which will be added to solr base url before the other solr params.
     #config.solr_path = 'select'
     #config.document_solr_path = 'get'
+    #config.json_solr_path = 'advanced'
 
     # items to show per page, each number in the array represent another option to choose from.
     #config.per_page = [10,20,50,100]