blacklight 7.36.2 → 7.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64b909f4876374f80a0a66d5fbccb800928b0e855b0a42ebe210807e05063017
-  data.tar.gz: 466d99ce6a9abf447cbe8473b6249d8a77d59a62bf70543be72062af37466084
+  metadata.gz: 92827fbcd7473cda5ed226586db52428b4f24b1298c50d1d67ef408ccfd94baa
+  data.tar.gz: 37513bedbec7cd84dc92e87cae3686f6e3c3e87f7e56bc13e07e34e84714410b
 SHA512:
-  metadata.gz: 6882bcf01ab98b2f7769e31993ee6b4ace72962eb41e815e8f1327e708da2693f73e8e351139e47987d5418848909591a9e178a3ee0652b597bd7c7a2ecfae92
-  data.tar.gz: 957d559917e4a40da705f4a5ba262a55377b0c04a8fb49e1fa9b958a848c8af1c20f5ffb541037f4dd7caecc94f5ee51a7e014a69f6d277a08adcd7307ab3e88
+  metadata.gz: 560541c83c6adfa1f0aa9c3f9bc5a12ba4415d3a152393ae422da91f46b138dee10335d195c2edd2d9e9f7905885dbce6deed95b8bdad4728e861e04f5186ce7
+  data.tar.gz: '039d446972e1c7270bb487bc9ee0a19ff44a553b9c5cd5bac1947ec1e819406104ebded74edfd6cf9522fa2920334f972353c1e9be6e584257ed67420b59cb76'

data/.github/workflows/ruby.yml

@@ -47,7 +47,7 @@ jobs:
     - name: Run tests
       run: bundle exec rake ci
       env:
-        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-coffee --skip-test'
   test_bootstrap5:
     runs-on: ubuntu-latest
     strategy:
@@ -68,7 +68,7 @@ jobs:
       run: bundle exec rake ci
       env:
         BOOTSTRAP_VERSION: '~> 5.0'
-        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-coffee --skip-test'
   test_rails6_0:
     runs-on: ubuntu-latest
     strategy:
@@ -131,6 +131,26 @@ jobs:
       run: bundle exec rake ci
       env:
         ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-keeps --skip-action-cable --skip-test'
+  test_rails7_2:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [3.1, 3.2]
+    env:
+      RAILS_VERSION: 7.2.0
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler: 'default'
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake ci
+      env:
+        ENGINE_CART_RAILS_OPTIONS: '--skip-keeps --skip-test'
   test_vc3:
     runs-on: ubuntu-latest
     strategy:
@@ -151,7 +171,7 @@ jobs:
     - name: Run tests
       run: bundle exec rake ci
       env:
-        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-coffee --skip-test'
   api_test:
     runs-on: ubuntu-latest
     strategy:
@@ -176,6 +196,6 @@ jobs:
   docker_build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Build docker image
-      run: docker-compose build app
+      - uses: actions/checkout@v3
+      - name: Build docker image
+        run: docker compose build app

data/VERSION

@@ -1 +1 @@
-7.36.2
+7.38.0

data/app/assets/javascripts/blacklight/blacklight.js

@@ -1,17 +1,17 @@
 "use strict";
 
-var Blacklight = function () {
+const Blacklight = function () {
   var buffer = new Array();
   return {
-    onLoad: function onLoad(func) {
+    onLoad: function (func) {
       buffer.push(func);
     },
-    activate: function activate() {
+    activate: function () {
       for (var i = 0; i < buffer.length; i++) {
         buffer[i].call();
       }
     },
-    listeners: function listeners() {
+    listeners: function () {
       var listeners = [];
       if (typeof Turbo !== 'undefined') {
         listeners.push('turbo:load');
@@ -39,7 +39,7 @@ Blacklight.listeners().forEach(function (listener) {
   });
 });
 Blacklight.onLoad(function () {
-  var elem = document.querySelector('.no-js');
+  const elem = document.querySelector('.no-js');
 
   // The "no-js" class may already have been removed because this function is
   // run on every turbo:load event, in that case, it won't find an element.
@@ -47,6 +47,14 @@ Blacklight.onLoad(function () {
   elem.classList.remove('no-js');
   elem.classList.add('js');
 });
+Blacklight.csrfToken = () => {
+  var _document$querySelect;
+  return (_document$querySelect = document.querySelector('meta[name=csrf-token]')) === null || _document$querySelect === void 0 ? void 0 : _document$querySelect.content;
+};
+Blacklight.csrfParam = () => {
+  var _document$querySelect2;
+  return (_document$querySelect2 = document.querySelector('meta[name=csrf-param]')) === null || _document$querySelect2 === void 0 ? void 0 : _document$querySelect2.content;
+};
 window.Blacklight = Blacklight;
 /*global Bloodhound */
 
@@ -89,7 +97,7 @@ Blacklight.onLoad(function () {
     $(Blacklight.doBookmarkToggleBehavior.selector).blCheckboxSubmit({
       // cssClass is added to elements added, plus used for id base
       cssClass: 'toggle-bookmark',
-      success: function success(checked, response) {
+      success: function (checked, response) {
         if (response.bookmarks) {
           $('[data-role=bookmark-counter]').text(response.bookmarks.count);
         }
@@ -105,8 +113,8 @@ Blacklight.onLoad(function () {
   // Button clicks should change focus. As of 10/3/19, Firefox for Mac and
   // Safari both do not set focus to a button on button click.
   // See https://zellwk.com/blog/inconsistent-button-behavior/ for background information
-  document.querySelectorAll('button.collapse-toggle').forEach(function (button) {
-    button.addEventListener('click', function () {
+  document.querySelectorAll('button.collapse-toggle').forEach(button => {
+    button.addEventListener('click', () => {
       event.target.focus();
     });
   });
@@ -187,15 +195,18 @@ Blacklight.onLoad(function () {
         checkbox.attr('disabled', 'disabled');
         $.ajax({
           url: form.attr('action'),
+          beforeSend: function (xhr) {
+            xhr.setRequestHeader('X-CSRF-Token', Blacklight.csrfToken());
+          },
           dataType: 'json',
           type: form.attr('method').toUpperCase(),
           data: form.serialize(),
-          error: function error() {
+          error: function () {
             label.removeAttr('disabled');
             checkbox.removeAttr('disabled');
             options.error.call();
           },
-          success: function success(data, status, xhr) {
+          success: function (data, status, xhr) {
             //if app isn't running at all, xhr annoyingly
             //reports success with status 0.
             if (xhr.status != 0) {
@@ -219,10 +230,10 @@ Blacklight.onLoad(function () {
   $.fn.blCheckboxSubmit.defaults = {
     //cssClass is added to elements added, plus used for id base
     cssClass: 'blCheckboxSubmit',
-    error: function error() {
+    error: function () {
       alert("Error");
     },
-    success: function success() {} //callback
+    success: function () {} //callback
   };
 })(jQuery);
 /*global Blacklight */
@@ -234,11 +245,11 @@ Blacklight.doResizeFacetLabelsAndCounts = function () {
     return b.textContent.length - a.textContent.length;
   }
   document.querySelectorAll('.facet-values, .pivot-facet').forEach(function (elem) {
-    var nodes = elem.querySelectorAll('.facet-count');
+    const nodes = elem.querySelectorAll('.facet-count');
     // TODO: when we drop ie11 support, this can become the spread operator:
-    var longest = Array.from(nodes).sort(longer)[0];
+    const longest = Array.from(nodes).sort(longer)[0];
     if (longest && longest.textContent) {
-      var width = longest.textContent.length + 1 + 'ch';
+      const width = longest.textContent.length + 1 + 'ch';
       elem.querySelector('.facet-count').style.width = width;
     }
   });
@@ -443,23 +454,15 @@ Blacklight.doSearchContextBehavior = function () {
     console.warn("do_search_context_behavior is deprecated. Use doSearchContextBehavior instead.");
     return Blacklight.do_search_context_behavior();
   }
-  var elements = document.querySelectorAll('a[data-context-href]');
+  const elements = document.querySelectorAll('a[data-context-href]');
   // Equivalent to Array.from(), but supports ie11
-  var nodes = Array.prototype.slice.call(elements);
+  const nodes = Array.prototype.slice.call(elements);
   nodes.forEach(function (element) {
     element.addEventListener('click', function (e) {
       Blacklight.handleSearchContextMethod.call(e.currentTarget, e);
     });
   });
 };
-Blacklight.csrfToken = function () {
-  var _document$querySelect;
-  return (_document$querySelect = document.querySelector('meta[name=csrf-token]')) === null || _document$querySelect === void 0 ? void 0 : _document$querySelect.content;
-};
-Blacklight.csrfParam = function () {
-  var _document$querySelect2;
-  return (_document$querySelect2 = document.querySelector('meta[name=csrf-param]')) === null || _document$querySelect2 === void 0 ? void 0 : _document$querySelect2.content;
-};
 
 // this is the Rails.handleMethod with a couple adjustments, described inline:
 // first, we're attaching this directly to the event handler, so we can check for meta-keys
@@ -471,17 +474,18 @@ Blacklight.handleSearchContextMethod = function (event) {
   var link = this;
 
   // instead of using the normal href, we need to use the context href instead
-  var href = link.getAttribute('data-context-href');
-  var target = link.getAttribute('target');
-  var csrfToken = Blacklight.csrfToken();
-  var csrfParam = Blacklight.csrfParam();
-  var form = document.createElement('form');
+  let href = link.getAttribute('data-context-href');
+  let target = link.getAttribute('target');
+  let csrfToken = Blacklight.csrfToken();
+  let csrfParam = Blacklight.csrfParam();
+  let form = document.createElement('form');
   form.method = 'post';
   form.action = href;
-  var formContent = "<input name=\"_method\" value=\"post\" type=\"hidden\" />\n    <input name=\"redirect\" value=\"".concat(link.getAttribute('href'), "\" type=\"hidden\" />");
+  let formContent = "<input name=\"_method\" value=\"post\" type=\"hidden\" />\n    <input name=\"redirect\" value=\"".concat(link.getAttribute('href'), "\" type=\"hidden\" />");
 
   // check for meta keys.. if set, we should open in a new tab
   if (event.metaKey || event.ctrlKey) {
+    form.dataset.turbo = "false";
     target = '_blank';
   }
   if (csrfParam !== undefined && csrfToken !== undefined) {

data/app/components/blacklight/facet_field_component.html.erb

@@ -8,11 +8,12 @@
       data-target="#<%= @facet_field.html_id %>"
       data-bs-target="#<%= @facet_field.html_id %>"
       aria-expanded="<%= @facet_field.collapsed? ? 'false' : 'true' %>"
+      arial-controls="<%= @facet_field.html_id %>"
     >
       <%= label %>
     </button>
   </h3>
-  <div id="<%= @facet_field.html_id %>" aria-labelledby="<%= @facet_field.html_id %>-header" class="panel-collapse facet-content collapse <%= "show" unless @facet_field.collapsed? %>">
+  <div id="<%= @facet_field.html_id %>" role="region" aria-labelledby="<%= @facet_field.html_id %>-header" class="panel-collapse facet-content collapse <%= "show" unless @facet_field.collapsed? %>">
     <div class="card-body">
       <%= body %>
 

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -73,12 +73,13 @@ module Blacklight::UrlHelperBehavior
 
   ##
   # Attributes for a link that gives a URL we can use to track clicks for the current search session
+  # We disable turbo prefetch (InstantClick), because since we replace the link with a form, it's just wasted.
   # @private
   # @param [SolrDocument] document
   # @param [Integer] counter
   # @example
   #   session_tracking_params(SolrDocument.new(id: 123), 7)
-  #   => { data: { :'context-href' => '/catalog/123/track?counter=7&search_id=999' } }
+  #   => { data: { context_href: '/catalog/123/track?counter=7&search_id=999' } }
   def session_tracking_params document, counter
     path = session_tracking_path(document, per_page: params.fetch(:per_page, search_session['per_page']), counter: counter, search_id: current_search_session.try(:id), document_id: document&.id)
 
@@ -86,7 +87,7 @@ module Blacklight::UrlHelperBehavior
       return {}
     end
 
-    { data: { 'context-href': path } }
+    { data: { context_href: path, turbo_prefetch: false } }
   end
   private :session_tracking_params
 

data/app/javascript/blacklight/checkbox_submit.js

@@ -90,6 +90,7 @@
 
             $.ajax({
                 url: form.attr('action'),
+                beforeSend: function(xhr) { xhr.setRequestHeader('X-CSRF-Token', Blacklight.csrfToken()) },
                 dataType: 'json',
                 type: form.attr('method').toUpperCase(),
                 data: form.serialize(),

data/app/javascript/blacklight/core.js

@@ -51,4 +51,7 @@ Blacklight.onLoad(function () {
   elem.classList.add('js')
 })
 
+Blacklight.csrfToken = () => document.querySelector('meta[name=csrf-token]')?.content
+Blacklight.csrfParam = () => document.querySelector('meta[name=csrf-param]')?.content
+
 window.Blacklight = Blacklight

data/app/javascript/blacklight/search_context.js

@@ -15,9 +15,6 @@ Blacklight.doSearchContextBehavior = function() {
   })
 };
 
-Blacklight.csrfToken = () => document.querySelector('meta[name=csrf-token]')?.content
-Blacklight.csrfParam = () => document.querySelector('meta[name=csrf-param]')?.content
-
 // this is the Rails.handleMethod with a couple adjustments, described inline:
 // first, we're attaching this directly to the event handler, so we can check for meta-keys
 Blacklight.handleSearchContextMethod = function(event) {
@@ -42,6 +39,7 @@ Blacklight.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/services/blacklight/search_service.rb

@@ -146,7 +146,15 @@ module Blacklight
               .merge(blacklight_config.fetch_many_document_params)
               .merge(extra_controller_params)
 
-      solr_response = repository.search(query)
+      # find_many was introduced in Blacklight 8.4. Before that, we used the
+      # regular search method (possibly with a find-many specific `qt` parameter).
+      # In order to support Repository implementations that may not have a find_many,
+      # we'll fall back to search if find_many isn't available.
+      solr_response = if repository.respond_to?(:find_many)
+                        repository.find_many(query)
+                      else
+                        repository.search(query)
+                      end
 
       [solr_response, solr_response.documents]
     end

data/app/values/blacklight/types.rb

@@ -69,6 +69,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)
@@ -110,6 +123,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/blacklight.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.5'
 
-  s.add_dependency "rails", '>= 5.1', '< 7.2'
+  s.add_dependency "rails", '>= 5.1', '< 7.3'
   s.add_dependency "globalid"
   s.add_dependency "jbuilder", '~> 2.7'
   s.add_dependency "kaminari", ">= 0.15" # the pagination (page 1,2,3, etc..) of our search results

data/docker-compose.yml

@@ -9,7 +9,7 @@ services:
         - ALPINE_RUBY_VERSION
     # mounting . is causing seg-fault on macosx
     #volumes:
-      #- .:/app
+    #- .:/app
     depends_on:
       - solr
     ports:

data/lib/blacklight/abstract_repository.rb

@@ -34,6 +34,12 @@ module Blacklight
       raise NotImplementedError
     end
 
+    # Find multiple documents by their ids
+    # @param [Hash] _params query parameters
+    def find_many(params, **kwargs)
+      search(params, **kwargs)
+    end
+
     ##
     # Execute a search query against a search index
     # @param [Hash] _params query parameters

data/lib/blacklight/configuration.rb

@@ -89,6 +89,10 @@ module Blacklight
     # @!attribute default_document_solr_params
     # @return [Hash] Default values of parameters to send with every single-document request
     property :default_document_solr_params, default: {}
+    # @!attribute fetch_many_documents_path
+    # @since v8.4.0
+    # @return [String] The url path (relative to the solr base url) to use when requesting multiple documents by id
+    property :fetch_many_documents_path, default: nil
     # @!attribute fetch_many_document_params
     # @since v7.0.0
     # @return [Hash] Default values of parameters to send with every multi-document request

data/lib/blacklight/solr/repository.rb

@@ -16,11 +16,20 @@ module Blacklight::Solr
       solr_response
     end
 
+    # Find multiple documents by their ids
+    # @param [Hash] _params query parameters
+    def find_many(params)
+      search(params: params, path: blacklight_config.fetch_many_documents_path)
+    end
+
     ##
     # Execute a search query against solr
     # @param [Hash] params solr query parameters
-    def search params = {}
-      send_and_receive search_path(params), params.reverse_merge(qt: blacklight_config.qt)
+    # @param [String] path solr request handler path
+    def search pos_params = {}, path: nil, params: nil, **kwargs
+      request_params = (params || pos_params).reverse_merge(kwargs).reverse_merge({ qt: blacklight_config.qt })
+
+      send_and_receive(path || default_search_path(request_params), request_params)
     end
 
     # @param [Hash] request_params
@@ -123,7 +132,7 @@ module Blacklight::Solr
     end
 
     # @return [String]
-    def search_path(solr_params)
+    def default_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

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "7.33.1",
+  "version": "7.37.0",
   "description": "The frontend code and styles for Blacklight",
   "main": "app/assets/javascripts/blacklight",
   "scripts": {

data/spec/models/blacklight/solr/repository_spec.rb

@@ -73,6 +73,24 @@ RSpec.describe Blacklight::Solr::Repository, api: true do
     end
   end
 
+  describe '#find_many' do
+    context 'with a configured fetch_many_documents_path' do
+      it 'uses the path' do
+        blacklight_config.fetch_many_documents_path = 'documents'
+        allow(subject.connection).to receive(:send_and_receive).with('documents', anything).and_return(mock_response)
+        expect(subject.find_many({})).to be_a Blacklight::Solr::Response
+      end
+    end
+
+    context 'without a configured fetch_many_documents_path' do
+      it 'falls back to the search path' do
+        blacklight_config.solr_path = 'xyz'
+        allow(subject.connection).to receive(:send_and_receive).with('xyz', anything).and_return(mock_response)
+        expect(subject.find_many({})).to be_a Blacklight::Solr::Response
+      end
+    end
+  end
+
   describe "#search" do
     it "uses the search-specific solr path" do
       blacklight_config.solr_path = 'xyz'

data/spec/models/solr_document_spec.rb

@@ -49,6 +49,7 @@ RSpec.describe SolrDocument, api: true do
         attribute :author, :array, 'author_tesim', of: :string
         attribute :first_author, :select, 'author_tesim', by: :min
         attribute :date, :date, field: 'date_dtsi'
+        attribute :time, :time, field: 'date_dtsi'
         attribute :whatever, :string, default: ->(*) { 'default_value' }
       end
     end
@@ -56,14 +57,17 @@ RSpec.describe SolrDocument, api: true do
       doc_class.new(id: '123',
                     title_tesim: ['Good Omens'],
                     author_tesim: ['Neil Gaiman', 'Terry Pratchett'],
-                    date_dtsi: '1990-01-01T00:00:00Z')
+                    date_dtsi: '1990-01-01T17:23:13Z')
     end
 
     it "casts the attributes" do
       expect(document.title).to eq 'Good Omens'
       expect(document.author).to eq ['Neil Gaiman', 'Terry Pratchett']
       expect(document.first_author).to eq 'Neil Gaiman'
-      expect(document.date).to eq Date.new(1990)
+      expect(document.date).to be_a Date
+      expect(document.date.to_s).to eq '1990-01-01'
+      expect(document.time).to be_a Time
+      expect(document.time.to_s).to eq '1990-01-01 17:23:13 UTC'
       expect(document.whatever).to eq 'default_value'
     end
 

data/tasks/blacklight.rake

@@ -21,18 +21,18 @@ def system_with_error_handling(*args)
 end
 
 def with_solr
-  # We're being invoked by the app entrypoint script and solr is already up via docker-compose
+  # We're being invoked by the app entrypoint script and solr is already up via docker compose
   if ENV['SOLR_ENV'] == 'docker-compose'
     yield
-  elsif system('docker-compose -v')
-    # We're not running docker-compose up but still want to use a docker instance of solr.
+  elsif system('docker compose -v')
+    # We're not running `docker compose up' but still want to use a docker instance of solr.
     begin
       puts "Starting Solr"
-      system_with_error_handling "docker-compose up -d solr"
+      system_with_error_handling "docker compose up -d solr"
       yield
     ensure
       puts "Stopping Solr"
-      system_with_error_handling "docker-compose stop solr"
+      system_with_error_handling "docker compose stop solr"
     end
   else
     SolrWrapper.wrap do |solr|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.36.2
+  version: 7.38.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-22 00:00:00.000000000 Z
+date: 2024-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,7 +28,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '7.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,7 +38,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '7.3'
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -957,7 +957,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)