blacklight 7.37.0 → 7.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a363d5e420f14ec8b9bc11825cfa98fd31e0be3b7e45da9fb1a60895d8d7e491
-  data.tar.gz: 928f51bf66d44b4dbb2243e845f978176a78720e50f386340c1f247c542fc7f2
+  metadata.gz: 92827fbcd7473cda5ed226586db52428b4f24b1298c50d1d67ef408ccfd94baa
+  data.tar.gz: 37513bedbec7cd84dc92e87cae3686f6e3c3e87f7e56bc13e07e34e84714410b
 SHA512:
-  metadata.gz: ec45d9d2d4e513eecc80ed7de3c47d083bb0b0a43f52863f1cdf28504be9688d0568a61ba1ab739da100a85b503b9f185346ea7fdd8519d35d9a736023e5a879
-  data.tar.gz: d73ec607a44211851883e93a49d40a2eebb31f55e4967a9347866b891499f8ea49444cd2faa1352124e8482a38abc84ad0891485e2c4dfd6cb4a685ea726b30a
+  metadata.gz: 560541c83c6adfa1f0aa9c3f9bc5a12ba4415d3a152393ae422da91f46b138dee10335d195c2edd2d9e9f7905885dbce6deed95b8bdad4728e861e04f5186ce7
+  data.tar.gz: '039d446972e1c7270bb487bc9ee0a19ff44a553b9c5cd5bac1947ec1e819406104ebded74edfd6cf9522fa2920334f972353c1e9be6e584257ed67420b59cb76'

data/.github/workflows/ruby.yml

@@ -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:
@@ -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.37.0
+7.38.0

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/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/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/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/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.37.0
+  version: 7.38.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-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)