blacklight 9.0.0 → 9.1.0

data/lib/generators/blacklight/templates/solr/conf/solrconfig.xml

@@ -4,11 +4,9 @@
      from this file.  Please refer to http://wiki.apache.org/solr/SolrConfigXml,
      as well as the default solrconfig file included with Solr -->
 
-  <abortOnConfigurationError>${solr.abortOnConfigurationError:true}</abortOnConfigurationError>
+  <luceneMatchVersion>9.0.0</luceneMatchVersion>
 
-  <luceneMatchVersion>6.1.0</luceneMatchVersion>
-
-  <directoryFactory name="DirectoryFactory" class="${solr.directoryFactory:solr.StandardDirectoryFactory}"/>
+  <directoryFactory name="DirectoryFactory" class="${solr.directoryFactory:solr.StandardDirectoryFactory}" />
 
   <updateHandler class="solr.DirectUpdateHandler2">
     <updateLog>
@@ -16,17 +14,11 @@
     </updateLog>
   </updateHandler>
 
-  <!-- solr lib dirs, which are needed for Solr 8 compatibility but ignored in solr 9.8 and above -->
   <lib dir="${solr.install.dir:../../../..}/modules/analysis-extras/lib" />
-  <lib dir="${solr.install.dir:../../../..}/contrib/analysis-extras/lib" />
-  <lib dir="${solr.install.dir:../../../..}/contrib/analysis-extras/lucene-libs" />
 
   <dataDir>${solr.data.dir:}</dataDir>
 
-  <requestHandler name="search" class="solr.SearchHandler" default="true">
-    <!-- default values for query parameters can be specified, these
-         will be overridden by parameters in the request
-      -->
+  <requestHandler name="/select" class="solr.SearchHandler">
      <lst name="defaults">
        <str name="defType">edismax</str>
        <str name="echoParams">explicit</str>
@@ -98,7 +90,7 @@
     </arr>
   </requestHandler>
 
-  <requestHandler name="permissions" class="solr.SearchHandler" >
+  <requestHandler name="permissions" class="solr.SearchHandler">
     <lst name="defaults">
       <str name="facet">off</str>
       <str name="echoParams">all</str>
@@ -186,8 +178,8 @@
 
   <requestHandler name="/replication" class="solr.ReplicationHandler" startup="lazy" />
 
-  <requestDispatcher handleSelect="true" >
-    <requestParsers enableRemoteStreaming="true" multipartUploadLimitInKB="2048" />
+  <requestDispatcher handleSelect="true">
+    <requestParsers multipartUploadLimitInKB="2048" />
   </requestDispatcher>
 
   <requestHandler name="/analysis/field" startup="lazy" class="solr.FieldAnalysisRequestHandler" />

data/lib/generators/blacklight/test_support_generator.rb

@@ -8,7 +8,7 @@ require 'rails/generators'
 require 'rails/generators/base'
 module Blacklight
   class TestSupport < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     desc <<-EOS
       Generate blacklight testing configurations for blacklight's own tests, or for blacklight plugins to use for testing

data/lib/generators/blacklight/user_generator.rb

@@ -7,16 +7,22 @@ module Blacklight
   class UserGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
 
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     argument     :model_name, type: :string, default: "user"
-    class_option :devise, type: :boolean, default: false, aliases: "-d", desc: "Use Devise as authentication logic (this is default)."
+    class_option :devise, type: :boolean, default: false, aliases: "-d", desc: "Use Devise as authentication logic."
+    class_option :authentication, type: :boolean, default: false, desc: "Use Rails' built-in authentication generator."
 
     desc <<-EOS
       This generator makes the following changes to your application:
-       1. Creates a devise-based user model
+       1. Optionally creates an authenticated user model
        2. Injects blacklight-specific behavior into your user model
     EOS
+
+    def validate_authentication_options
+      raise Thor::Error, "Choose either --devise or --authentication, not both." if options[:devise] && options[:authentication]
+    end
+
     # Install Devise?
     def generate_devise_assets
       return unless options[:devise]
@@ -39,6 +45,18 @@ module Blacklight
       gsub_file("config/initializers/devise.rb", "# config.reload_routes = true", "config.reload_routes = false")
     end
 
+    # Install Rails' built-in authentication generator?
+    def generate_rails_authentication_assets
+      return unless options[:authentication]
+
+      raise Thor::Error, "Rails' authentication generator is only available in Rails 8.0 and newer." unless rails_authentication_generator_available?
+      raise Thor::Error, "Rails' authentication generator creates a User model; omit the model name when using --authentication." unless model_name.underscore == "user"
+
+      generate "authentication", rails_authentication_generator_args
+      inject_rails_authentication_blacklight_behavior
+      inject_rails_authentication_guest_transfer
+    end
+
     # Add Blacklight to the user model
     def inject_blacklight_user_behavior
       file_path = "app/models/#{model_name.underscore}.rb"
@@ -49,8 +67,8 @@ module Blacklight
             include Blacklight::User
 
             # Blacklight::User uses a method on your User class to get a user-displayable
-            # label (e.g. login or identifier) for the account. Blacklight uses `email' by default.
-            # self.string_display_key = :email
+            # label (e.g. login or identifier) for the account.
+            #{blacklight_user_display_key_configuration}
           EOS
         end
       else
@@ -63,5 +81,48 @@ module Blacklight
         EOS
       end
     end
+
+    private
+
+    def rails_authentication_generator_available?
+      Rails.gem_version >= Gem::Version.new("8.0.0")
+    end
+
+    def rails_authentication_generator_args
+      Rails.application.config.api_only ? "--api" : ""
+    end
+
+    def inject_rails_authentication_blacklight_behavior
+      inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
+        [
+          "  # Makes Rails' generated authentication available through Blacklight's auth hooks.",
+          "  helper_method :current_user",
+          "",
+          "  def current_user",
+          "    resume_session&.user",
+          "  end",
+          ""
+        ].join("\n")
+      end
+    end
+
+    # Move bookmarks/searches accumulated by the anonymous guest user over to the
+    # real account when they sign in.
+    def inject_rails_authentication_guest_transfer
+      sessions_path = "app/controllers/sessions_controller.rb"
+      return unless File.exist?(File.expand_path(sessions_path, destination_root))
+
+      inject_into_file sessions_path, after: "      start_new_session_for user\n" do
+        "      transfer_guest_to_user\n"
+      end
+    end
+
+    def blacklight_user_display_key_configuration
+      if options[:authentication]
+        "self.string_display_key = :email_address"
+      else
+        "# self.string_display_key = :email"
+      end
+    end
   end
 end

data/lib/railties/blacklight.rake

@@ -39,7 +39,7 @@ namespace :blacklight do
         puts "Unable to reach: #{conn.uri}"
         exit 1
       end
-    rescue => e
+    rescue StandardError => e
       puts e
       exit 1
     end
@@ -68,7 +68,7 @@ namespace :blacklight do
           puts "\tdoc count: #{response.docs.length}"
           puts "\tfacet fields: #{response.facets.length}"
         end
-      rescue => e
+      rescue StandardError => e
         errors += 1
         puts e
       end
@@ -90,7 +90,7 @@ namespace :blacklight do
           puts "\tdoc count: #{docs.length}"
           puts "\tfacet fields: #{response.facets.length}"
         end
-      rescue => e
+      rescue StandardError => e
         errors += 1
         puts e
       end
@@ -110,7 +110,7 @@ namespace :blacklight do
         if verbose
           puts "\tstatus: #{response.header['status']}"
         end
-      rescue => e
+      rescue StandardError => e
         errors += 1
         puts e
       end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "9.0.0",
+  "version": "9.1.0",
   "description": "The frontend code and styles for Blacklight",
   "exports": {
     "./blacklight.esm.js": "./app/assets/javascripts/blacklight/blacklight.esm.js",
@@ -34,7 +34,7 @@
     "rollup": "^4.24.0",
     "rollup-plugin-includepaths": "^0.2.4",
     "sass": "^1.80.3",
-    "bootstrap": "^5.3.5"
+    "bootstrap": "^5.3.8"
   },
   "browserslist": [
     "defaults",

data/spec/components/blacklight/document/action_component_spec.rb

@@ -42,7 +42,7 @@ RSpec.describe Blacklight::Document::ActionComponent, type: :component do
     end
 
     it 'render the partial' do
-      expect(page).to have_content 'tool'
+      expect(page).to have_text 'tool'
     end
   end
 end

data/spec/components/blacklight/document/group_component_spec.rb

@@ -27,7 +27,7 @@ RSpec.describe Blacklight::Document::GroupComponent, type: :component do
   end
 
   it 'renders the group documents' do
-    expect(page).to have_content 'results'
+    expect(page).to have_text 'results'
   end
 
   context 'with a limit applied' do

data/spec/components/blacklight/document_component_spec.rb

@@ -41,11 +41,11 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     component.with_actions { 'Actions' }
     render_inline component
 
-    expect(page).to have_content 'Title'
-    expect(page).to have_content 'Embed'
-    expect(page).to have_content 'Metadata'
-    expect(page).to have_content 'Thumbnail'
-    expect(page).to have_content 'Actions'
+    expect(page).to have_text 'Title'
+    expect(page).to have_text 'Embed'
+    expect(page).to have_text 'Metadata'
+    expect(page).to have_text 'Thumbnail'
+    expect(page).to have_text 'Actions'
   end
 
   it 'has schema.org properties' do
@@ -61,7 +61,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       component.with_body { 'Body content' }
       render_inline component
 
-      expect(page).to have_content 'Body content'
+      expect(page).to have_text 'Body content'
       expect(page).to have_no_css 'header'
       expect(page).to have_no_css 'dl'
     end
@@ -167,7 +167,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       end
 
       it 'renders an embed' do
-        expect(page).to have_content 'embed'
+        expect(page).to have_text 'embed'
       end
     end
 
@@ -242,7 +242,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     end
 
     it 'renders partials' do
-      expect(page).to have_content 'Partials'
+      expect(page).to have_text 'Partials'
     end
   end
 
@@ -266,7 +266,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     end
 
     it 'shows the prefix' do
-      expect(page).to have_content "Prefix!"
+      expect(page).to have_text "Prefix!"
     end
   end
 end

data/spec/components/blacklight/facet_component_spec.rb

@@ -39,7 +39,7 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
     before { rendered }
 
     it 'renders the provided component' do
-      expect(page).to have_content 'Custom facet rendering'
+      expect(page).to have_text 'Custom facet rendering'
     end
   end
 
@@ -64,7 +64,7 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
     end
 
     it 'renders the partial' do
-      expect(page).to have_content 'facet partial'
+      expect(page).to have_text 'facet partial'
     end
   end
 

data/spec/components/blacklight/facets/index_navigation_component_spec.rb

@@ -16,8 +16,7 @@ RSpec.describe Blacklight::Facets::IndexNavigationComponent, type: :component do
 
   it 'renders the facet index navigation range' do
     expect(page).to have_css '.pagination'
-    facet_path = ViewComponent::VERSION::MAJOR == 3 ? '/catalog/facet/language.html' : '/catalog/facet/language'
-    expect(page).to have_link '0', href: "#{facet_path}?facet.prefix=0&facet.sort=index"
+    expect(page).to have_link '0', href: "/catalog/facet/language?facet.prefix=0&facet.sort=index"
     expect(page).to have_link '1'
     expect(page).to have_link '8'
     expect(page).to have_link '9'

data/spec/components/blacklight/facets/list_component_spec.rb

@@ -144,7 +144,7 @@ RSpec.describe Blacklight::Facets::ListComponent, type: :component do
     let(:params) { { f_inclusive: { field: %w[a b c] } } }
 
     it 'displays the constraint above the list' do
-      expect(page).to have_content 'Any of:'
+      expect(page).to have_text 'Any of:'
       expect(page).to have_css '.inclusive_or .facet-label', text: 'a'
       expect(page).to have_link '[remove]', href: 'http://test.host/catalog?f_inclusive%5Bfield%5D%5B%5D=b&f_inclusive%5Bfield%5D%5B%5D=c'
       expect(page).to have_css '.inclusive_or .facet-label', text: 'b'

data/spec/components/blacklight/facets/suggest_component_spec.rb

@@ -28,8 +28,7 @@ RSpec.describe Blacklight::Facets::SuggestComponent, type: :component do
   it 'has an input with the data-facet-search-context attribute, which the javascript needs to determine the current search context' do
     with_request_url "/catalog/facet/language_facet?f%5Bformat%5D%5B%5D=Book&facet.prefix=R&facet.sort=index&q=tibet&search_field=all_fields" do
       rendered = render_inline component
-      facet_path = ViewComponent::VERSION::MAJOR == 3 ? '/catalog/facet/language_facet.html' : '/catalog/facet/language_facet'
-      expect(rendered.css("input[data-facet-search-context=\"#{facet_path}?f%5Bformat%5D%5B%5D=Book&facet.prefix=R&facet.sort=index&q=tibet&search_field=all_fields\"]").count).to eq 1
+      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
   end
 

data/spec/components/blacklight/metadata_field_component_spec.rb

@@ -2,6 +2,14 @@
 
 require 'spec_helper'
 
+class CustomLayoutComponent < ViewComponent::Base
+  def initialize(field:); end
+
+  def call
+    'Hello from the custom layout component!'
+  end
+end
+
 RSpec.describe Blacklight::MetadataFieldComponent, type: :component do
   let(:view_context) { vc_test_controller.view_context }
   let(:document) { SolrDocument.new('field' => ['Value']) }
@@ -35,5 +43,23 @@ RSpec.describe Blacklight::MetadataFieldComponent, type: :component do
     it 'renders the right field label' do
       expect(page).to have_css 'dt.blacklight-field', text: 'custom label'
     end
+
+    context 'with a custom layout component specified in the field config' do
+      let(:field_config) { Blacklight::Configuration::Field.new(layout_component: CustomLayoutComponent, key: 'field', field: 'field', label: 'Field label') }
+
+      it 'displays the custom layout component' do
+        expect(page.text).to include 'Hello from the custom layout component!'
+      end
+    end
+  end
+
+  context 'with a custom layout component passed in through args' do
+    before do
+      render_inline(described_class.new(field: field, layout: CustomLayoutComponent))
+    end
+
+    it 'displays the custom layout component' do
+      expect(page.text).to include 'Hello from the custom layout component!'
+    end
   end
 end

data/spec/components/blacklight/skip_link_component_spec.rb

@@ -24,7 +24,7 @@ RSpec.describe Blacklight::SkipLinkComponent, type: :component do
   context 'with one search field' do
     let(:blacklight_config) do
       Blacklight::Configuration.new.configure do |config|
-        config.search_fields =  { "all_fields" => "" }
+        config.search_fields = { "all_fields" => "" }
       end
     end
 
@@ -37,7 +37,7 @@ RSpec.describe Blacklight::SkipLinkComponent, type: :component do
   context 'with two search field' do
     let(:blacklight_config) do
       Blacklight::Configuration.new.configure do |config|
-        config.search_fields =  { "all_fields" => "", "title_field" => "" }
+        config.search_fields = { "all_fields" => "", "title_field" => "" }
       end
     end
 

data/spec/controllers/application_controller_spec.rb

@@ -1,9 +1,80 @@
 # frozen_string_literal: true
 
+# Blacklight manages its own guest users only when no other provider (such as
+# the devise-guests gem) is present. Under Devise, current_or_guest_user defers
+# to devise-guests, so the guest-fallback specs below run on the Rails
+# authentication test app only.
+BLACKLIGHT_MANAGES_GUESTS = !defined?(DeviseGuests)
+
 RSpec.describe ApplicationController do
   describe "#blacklight_config" do
     it "provides a default blacklight_config everywhere" do
       expect(controller.blacklight_config).to eq CatalogController.blacklight_config
     end
   end
+
+  describe "authentication path helpers" do
+    it "prefers Devise routes when available" do
+      allow(controller).to receive(:respond_to?).and_call_original
+      allow(controller).to receive(:respond_to?).with(:new_user_session_path).and_return(true)
+      allow(controller).to receive(:new_user_session_path).and_return("/users/sign_in")
+
+      expect(controller.send(:blacklight_login_path)).to eq "/users/sign_in"
+    end
+
+    it "falls back to Rails authentication routes" do
+      allow(controller).to receive(:respond_to?).and_call_original
+      allow(controller).to receive(:respond_to?).with(:new_user_session_path).and_return(false)
+      allow(controller).to receive(:respond_to?).with(:new_session_path).and_return(true)
+      allow(controller).to receive(:new_session_path).and_return("/session/new")
+
+      expect(controller.send(:blacklight_login_path)).to eq "/session/new"
+    end
+
+    it "uses a DELETE logout link for Rails authentication" do
+      allow(controller).to receive(:respond_to?).and_call_original
+      allow(controller).to receive(:respond_to?).with(:destroy_user_session_path).and_return(false)
+      allow(controller).to receive(:respond_to?).with(:session_path).and_return(true)
+      allow(controller).to receive(:session_path).and_return("/session")
+
+      expect(controller.send(:blacklight_logout_path)).to eq "/session"
+      expect(controller.send(:blacklight_logout_link_options)).to eq(data: { turbo_method: :delete })
+    end
+  end
+
+  describe "#current_or_guest_user and #guest_user" do
+    it "returns the current user when one is signed in" do
+      user = create_user(email: "signed_in@example.com", password: "password12345")
+      allow(controller).to receive(:current_user).and_return(user)
+
+      expect(controller.send(:current_or_guest_user)).to eq user
+      expect { controller.send(:current_or_guest_user) }.not_to(change { User.where("#{User.blacklight_email_column} LIKE 'guest_%'").count })
+    end
+
+    # Blacklight only manages its own guest users when no other provider (such
+    # as the devise-guests gem) is doing so. Under Devise, current_or_guest_user
+    # defers to devise-guests, so these fallback behaviors are exercised on the
+    # Rails authentication test app instead.
+    context "when Blacklight manages guest users", if: BLACKLIGHT_MANAGES_GUESTS do
+      it "creates and memoizes a persisted guest user for anonymous visitors" do
+        session = {}
+        allow(controller).to receive_messages(current_user: nil, session: session)
+
+        guest = controller.send(:current_or_guest_user)
+
+        expect(guest).to be_persisted
+        expect(session[:blacklight_guest_user_id]).to eq guest.id
+        expect(guest.public_send(User.blacklight_email_column)).to match(/^guest_.*@example\.com$/)
+
+        expect(controller.send(:current_or_guest_user)).to eq guest
+      end
+
+      it "reuses an existing guest across requests via the session" do
+        existing = User.create_guest_user!
+        allow(controller).to receive_messages(current_user: nil, session: { blacklight_guest_user_id: existing.id })
+
+        expect(controller.send(:current_or_guest_user)).to eq existing
+      end
+    end
+  end
 end

data/spec/controllers/bookmarks_controller_spec.rb

@@ -12,6 +12,12 @@ RSpec.describe BookmarksController do
   end
 
   describe "update" do
+    let(:user) { create_user }
+
+    before do
+      allow(controller).to receive(:current_or_guest_user).and_return(user)
+    end
+
     it "has a 200 status code when creating a new one" do
       put :update, xhr: true, params: { id: '2007020969', format: :js }
       expect(response).to be_successful
@@ -31,8 +37,13 @@ RSpec.describe BookmarksController do
   end
 
   describe "create" do
+    let(:user) { create_user }
+
+    before do
+      allow(controller).to receive(:current_or_guest_user).and_return(user)
+    end
+
     it "can create bookmarks via params bookmarks attribute" do
-      @controller.send(:current_or_guest_user).save
       put :create, xhr: true, params: {
         id: "notused",
         bookmarks: [
@@ -50,9 +61,11 @@ RSpec.describe BookmarksController do
   end
 
   describe "delete" do
+    let(:user) { create_user }
+
     before do
-      @controller.send(:current_or_guest_user).save
-      @controller.send(:current_or_guest_user).bookmarks.create! document_id: '2007020969', document_type: "SolrDocument"
+      allow(controller).to receive(:current_or_guest_user).and_return(user)
+      user.bookmarks.create! document_id: '2007020969', document_type: "SolrDocument"
     end
 
     it "has a 200 status code when delete is success" do
@@ -90,12 +103,12 @@ RSpec.describe BookmarksController do
   end
 
   describe 'token based users' do
-    let(:user) { User.find_or_create_by(email: 'user1@example.com') { |u| u.password = 'password' } }
+    let(:user) { create_user email: 'user1@example.com', password: 'password' }
     let(:current_time) { nil }
     let(:token) { controller.send(:encrypt_user_id, user.id, current_time) }
 
     before do
-      allow(controller).to receive(:fetch).and_return([])
+      allow(controller).to receive_messages(fetch: [], retrieve_search_results: instance_double(Blacklight::Solr::Response))
     end
 
     it 'finds the user from the encrypted token' do

data/spec/controllers/catalog_controller_spec.rb

@@ -440,7 +440,7 @@ RSpec.describe CatalogController, :api do
       it "responds to an extension-registered format properly" do
         get :show, params: { id: doc_id, format: 'mock' }
         expect(response).to be_successful
-        expect(response.body).to match /mock_export/
+        expect(response.body).to include('mock_export')
       end
     end # dynamic export formats
   end # describe show action
@@ -452,16 +452,18 @@ RSpec.describe CatalogController, :api do
     end
 
     context 'when searching for something' do
+      render_views
       before do
         allow(controller).to receive(:search_service).and_return(search_service)
-        expect(search_service).to receive(:opensearch_response)
-          .and_return(['a', [SolrDocument.new(id: 'my_fake_doc'),
-                             SolrDocument.new(id: 'my_other_doc')]])
+        expect(search_service).to receive(:search_results)
+          .and_return(instance_double(Blacklight::Solr::Response, documents: [SolrDocument.new(id: 'my_fake_doc'),
+                                                                              SolrDocument.new(id: 'my_other_doc')]))
       end
 
       it "returns valid JSON" do
         get :opensearch, params: { format: 'json', q: 'a' }
         expect(response).to be_successful
+        expect(response.parsed_body).to eq %w[a my_fake_doc my_other_doc]
       end
     end
   end
@@ -594,7 +596,7 @@ RSpec.describe CatalogController, :api do
 
     it "does not show user util links" do
       get :index
-      expect(response.body).not_to match /Login/
+      expect(response.body).not_to include('Login')
     end
   end