blacklight 9.0.0 → 9.1.0

data/spec/models/blacklight/search_builder_spec.rb

@@ -137,15 +137,23 @@ RSpec.describe Blacklight::SearchBuilder, :api do
 
   describe "#page" do
     it "is the current user parameter page number" do
-      expect(subject.with(page: 2).send(:page)).to eq 2
+      expect(subject.with(page: 2).page).to eq 2
     end
 
     it "is page 1 if not page number given" do
-      expect(subject.send(:page)).to eq 1
+      expect(subject.page).to eq 1
     end
 
     it "coerces parameters to integers" do
-      expect(subject.with(page: '2b').send(:page)).to eq 2
+      expect(subject.with(page: '2b').page).to eq 2
+    end
+
+    it 'sets the page number' do
+      expect(subject.page(3).page).to eq 3
+    end
+
+    it 'gracefully handles setting the page number with a nil value' do
+      expect(subject.page(nil).page).to eq 1
     end
   end
 
@@ -160,6 +168,10 @@ RSpec.describe Blacklight::SearchBuilder, :api do
       expect(subject.rows(17).rows).to eq 17
     end
 
+    it "gracefully hnadles setting the number of rows to a nil value" do
+      expect(subject.rows(nil).rows).to eq 10
+    end
+
     it "is the per_page parameter" do
       expect(subject.with(per_page: 5).rows).to eq 5
     end

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

@@ -160,7 +160,11 @@ RSpec.describe Blacklight::Solr::Repository, :api do
       end
 
       describe "setting to post" do
-        let (:blacklight_config) { config = Blacklight::Configuration.new; config.http_method = :post; config }
+        let(:blacklight_config) do
+          config = Blacklight::Configuration.new
+          config.http_method = :post
+          config
+        end
 
         it "keep value set to post" do
           expect(blacklight_config.http_method).to eq :post
@@ -210,7 +214,11 @@ RSpec.describe Blacklight::Solr::Repository, :api do
   end
 
   describe "http_method configuration", :integration do
-    let (:blacklight_config) { config = Blacklight::Configuration.new; config.http_method = :post; config }
+    let(:blacklight_config) do
+      config = Blacklight::Configuration.new
+      config.http_method = :post
+      config
+    end
 
     it "sends a post request to solr and get a response back" do
       response = subject.search(params: { q: all_docs_query })

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

@@ -524,13 +524,11 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, :api do
   end
 
   describe "#add_facets_for_advanced_search_form" do
+    let(:user_params) do
+      Blacklight::SearchState.new({}, blacklight_config, mock_controller)
+    end
     let(:solr_parameters) { Blacklight::Solr::Request.new }
     let(:mock_controller) { instance_double(CatalogController, action_name: 'advanced_search') }
-    let(:mock_search_state) { instance_double(Blacklight::SearchState, controller: mock_controller) }
-
-    before do
-      allow(search_builder).to receive(:search_state).and_return(mock_search_state)
-    end
 
     context "when action is advanced_search and form_solr_parameters are configured" do
       before do

data/spec/models/blacklight/user_spec.rb

@@ -1,12 +1,36 @@
 # frozen_string_literal: true
 
 RSpec.describe "Blacklight::User", :api do
-  subject { User.create! email: 'xyz@example.com', password: 'xyz12345' }
+  subject { create_user email: 'xyz@example.com', password: 'xyz12345' }
 
   def mock_bookmark document_id
     Bookmark.new document_id: document_id, document_type: SolrDocument.to_s
   end
 
+  describe ".blacklight_email_column" do
+    it "returns the email column the model actually has" do
+      expected = User.column_names.include?("email_address") ? :email_address : :email
+      expect(User.blacklight_email_column).to eq expected
+    end
+  end
+
+  describe ".create_guest_user!" do
+    it "creates a persisted user with a generated, unique identifier" do
+      guest = User.create_guest_user!
+
+      expect(guest).to be_persisted
+      expect(guest.public_send(User.blacklight_email_column)).to match(/^guest_.*@example\.com$/)
+    end
+
+    it "generates a distinct identifier each time" do
+      one = User.create_guest_user!
+      two = User.create_guest_user!
+
+      expect(one.public_send(User.blacklight_email_column))
+        .not_to eq(two.public_send(User.blacklight_email_column))
+    end
+  end
+
   describe "#bookmarks_for_documents" do
     before do
       subject.bookmarks << mock_bookmark(1)
@@ -47,12 +71,15 @@ RSpec.describe "Blacklight::User", :api do
   end
 
   describe '#to_s' do
-    it 'is the email by default' do
-      expect(subject.to_s).to eq subject.email
+    it 'is the configured display key by default' do
+      display_key = User.column_names.include?("email_address") ? :email_address : :email
+
+      expect(subject.to_s).to eq subject.public_send(display_key)
     end
 
-    context 'when no email method is provided' do
-      let(:old_method) { subject.class.instance_method(:email) }
+    context 'when no configured display key method is provided' do
+      let(:display_key) { User.column_names.include?("email_address") ? :email_address : :email }
+      let(:old_method) { subject.class.instance_method(display_key) }
 
       before do
         subject.class.send(:undef_method, old_method.name)

data/spec/models/bookmark_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe Bookmark do
     b
   end
 
-  let(:user) { User.create! email: 'xyz@example.com', password: 'xyz12345' }
+  let(:user) { create_user email: 'xyz@example.com', password: 'xyz12345' }
 
   it "is valid" do
     expect(subject).to be_valid

data/spec/models/record_mailer_spec.rb

@@ -37,11 +37,11 @@ RSpec.describe RecordMailer do
     end
 
     it "starts the subject w/ Item Record:" do
-      expect(email.subject).to match /^Item Record:/
+      expect(email.subject).to match(/^Item Record:/)
     end
 
     it "puts the title of the item in the subject" do
-      expect(email.subject).to match /The horn/
+      expect(email.subject).to include('The horn')
     end
 
     it "has the correct from address (w/o the port number)" do
@@ -49,9 +49,9 @@ RSpec.describe RecordMailer do
     end
 
     it "prints out the correct body" do
-      expect(email.body).to match /Title: The horn/
-      expect(email.body).to match /Author: Janetzky, Kurt/
-      expect(email.body).to match /projectblacklight.org/
+      expect(email.body).to include('Title: The horn')
+      expect(email.body).to include('Author: Janetzky, Kurt')
+      expect(email.body).to match(/projectblacklight.org/)
     end
 
     it "uses https URLs when protocol is set" do
@@ -104,9 +104,9 @@ RSpec.describe RecordMailer do
     end
 
     it "prints out the correct body" do
-      expect(@sms.body).to match /Title: The horn/
-      expect(@sms.body).to match /Author: Janetzky, Kurt/
-      expect(@sms.body).to match /projectblacklight.org:3000/
+      expect(@sms.body).to include('Title: The horn')
+      expect(@sms.body).to include('Author: Janetzky, Kurt')
+      expect(@sms.body).to match(/projectblacklight.org:3000/)
     end
 
     it "uses https URL when protocol is set" do

data/spec/models/search_spec.rb

@@ -2,7 +2,7 @@
 
 RSpec.describe Search do
   let(:search) { described_class.new(user: user) }
-  let(:user) { User.create! email: 'xyz@example.com', password: 'xyz12345' }
+  let(:user) { create_user email: 'xyz@example.com', password: 'xyz12345' }
   let(:hash_params) { { q: "query", f: { facet: "filter" } } }
   let(:query_params) { hash_params }
 

data/spec/models/solr_document_spec.rb

@@ -54,6 +54,7 @@ RSpec.describe SolrDocument, :api do
         attribute :first_author, :select, 'author_tesim', by: :min
         attribute :date, :date, field: 'date_dtsi'
         attribute :time, :time, field: 'date_dtsi'
+        attribute :details, :json, 'details_ssi'
         attribute :whatever, :string, default: ->(*) { 'default_value' }
       end
     end
@@ -61,6 +62,7 @@ RSpec.describe SolrDocument, :api do
       doc_class.new(id: '123',
                     title_tesim: ['Good Omens'],
                     author_tesim: ['Neil Gaiman', 'Terry Pratchett'],
+                    details_ssi: '{"pages":288}',
                     date_dtsi: '1990-01-01T17:23:13Z')
     end
 
@@ -72,6 +74,8 @@ RSpec.describe SolrDocument, :api do
       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.details).to be_a Hash
+      expect(document.details).to eq({ 'pages' => 288 })
       expect(document.whatever).to eq 'default_value'
     end
 

data/spec/presenters/blacklight/index_presenter_spec.rb

@@ -2,6 +2,7 @@
 
 RSpec.describe Blacklight::IndexPresenter, :api do
   include Capybara::RSpecMatchers
+
   subject { presenter }
 
   let(:request_context) { double(document_index_view_type: 'list') }

data/spec/presenters/blacklight/rendering/pipeline_spec.rb

@@ -2,6 +2,7 @@
 
 RSpec.describe Blacklight::Rendering::Pipeline do
   include Capybara::RSpecMatchers
+
   let(:document) { instance_double(SolrDocument) }
   let(:context) { double }
   let(:options) { {} }

data/spec/presenters/blacklight/show_presenter_spec.rb

@@ -2,6 +2,7 @@
 
 RSpec.describe Blacklight::ShowPresenter, :api do
   include Capybara::RSpecMatchers
+
   subject { presenter }
 
   let(:request_context) { double }

data/spec/presenters/blacklight/thumbnail_presenter_spec.rb

@@ -2,6 +2,7 @@
 
 RSpec.describe Blacklight::ThumbnailPresenter do
   include Capybara::RSpecMatchers
+
   let(:view_context) { double "View context" }
   let(:config) { Blacklight::Configuration.new.view_config(:index) }
   let(:presenter) { described_class.new(document, view_context, config) }

data/spec/services/blacklight/search_service_spec.rb

@@ -145,7 +145,7 @@ RSpec.describe Blacklight::SearchService, :api do
     end
 
     it 'has all facets specified in initializer' do
-      expect(@facets.keys).to include *blacklight_config.facet_fields.keys
+      expect(@facets.keys).to include(*blacklight_config.facet_fields.keys)
       expect(@facets.none? { |_k, v| v.nil? }).to be true
     end
 
@@ -379,40 +379,40 @@ RSpec.describe Blacklight::SearchService, :api do
     end
 
     it "returns the previous and next documents for a search" do
-      _response, docs = service.previous_and_next_documents_for_search(4, q: '')
+      _response, docs = service.previous_and_next_documents_for_search(4, { q: '' })
 
       expect(docs.first.id).to eq @full_response.documents[3].id
       expect(docs.last.id).to eq @full_response.documents[5].id
     end
 
     it "returns only the next document if the counter is 0" do
-      _response, docs = service.previous_and_next_documents_for_search(0, q: '')
+      _response, docs = service.previous_and_next_documents_for_search(0, { q: '' })
 
       expect(docs.first).to be_nil
       expect(docs.last.id).to eq @full_response.documents[1].id
     end
 
     it "returns only the previous document if the counter is the total number of documents" do
-      _response, docs = service.previous_and_next_documents_for_search(@full_response.total - 1, q: '')
+      _response, docs = service.previous_and_next_documents_for_search(@full_response.total - 1, { q: '' })
       expect(docs.first.id).to eq @full_response.documents.slice(-2).id
       expect(docs.last).to be_nil
     end
 
     it "returns an array of nil values if there is only one result" do
-      _response, docs = service.previous_and_next_documents_for_search(0, q: 'id:2007020969')
+      _response, docs = service.previous_and_next_documents_for_search(0, { q: 'id:2007020969' })
       expect(docs.last).to be_nil
       expect(docs.first).to be_nil
     end
 
     it 'returns only the unique key by default' do
-      _response, docs = service.previous_and_next_documents_for_search(0, q: '')
+      _response, docs = service.previous_and_next_documents_for_search(0, { q: '' })
       expect(docs.last.to_h).to eq 'id' => @full_response.documents[1].id
     end
 
     it 'allows the query parameters to be customized using configuration' do
       blacklight_config.document_pagination_params[:fl] = 'id,format'
 
-      _response, docs = service.previous_and_next_documents_for_search(0, q: '')
+      _response, docs = service.previous_and_next_documents_for_search(0, { q: '' })
 
       expect(docs.last.to_h).to eq @full_response.documents[1].to_h.slice('id', 'format')
     end

data/spec/spec_helper.rb

@@ -48,25 +48,16 @@ RSpec.configure do |config|
   # When we're testing the API, only run the api tests
   config.filter_run api: true if ENV['BLACKLIGHT_API_TEST'].present?
 
-  if Rails.version.to_f >= 7.1
-    config.fixture_paths = [Rails.root.join("spec/fixtures")]
-  else
-    config.fixture_path = Rails.root.join("spec/fixtures")
-  end
+  config.fixture_paths = [Rails.root.join("spec/fixtures")]
 
   # If you're not using ActiveRecord, or you'd prefer not to run each of your
   # examples within a transaction, remove the following line or assign false
   # instead of true.
   config.use_transactional_fixtures = true
 
-  if defined? Devise::Test::ControllerHelpers
-    config.include Devise::Test::ControllerHelpers, type: :controller
-  else
-    config.include Devise::TestHelpers, type: :controller
-    config.include Devise::TestHelpers, type: :i18n
-  end
-
   config.infer_spec_type_from_file_location!
+  config.include UserHelpers
+  config.include Devise::Test::ControllerHelpers, type: :controller if defined?(Devise)
   config.include PresenterTestHelpers, type: :presenter
   config.include ViewComponent::TestHelpers, type: :component
   config.include ViewComponentTestHelpers, type: :component

data/spec/support/features/session_helpers.rb

@@ -4,6 +4,8 @@
 module Features
   module SessionHelpers
     def sign_up_with(email, password)
+      return create_user(email: email, password: password) if respond_to?(:new_session_path)
+
       Capybara.exact = true
       visit new_user_registration_path
       fill_in 'Email', with: email
@@ -14,10 +16,17 @@ module Features
 
     def sign_in(login = 'user1')
       email = "#{login}@#{login}.com"
-      User.create(email: email, password: "password", password_confirmation: "password")
-      visit new_user_session_path
-      fill_in("user_email", with: email)
-      fill_in("user_password", with: "password")
+      create_user(email: email, password: "password")
+
+      if respond_to?(:new_session_path)
+        visit new_session_path
+        fill_in("email_address", with: email)
+        fill_in("password", with: "password")
+      else
+        visit new_user_session_path
+        fill_in("user_email", with: email)
+        fill_in("user_password", with: "password")
+      end
 
       if has_button? "Sign in"
         click_on("Sign in")

data/spec/support/features/turbo_helpers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# spec/support/features/turbo_helpers.rb
+module Features
+  module TurboHelpers
+    # Turbo Drive marks the document as busy for the duration of a visit. Capybara
+    # clicks return before the visit completes, so wait for the busy state to clear
+    # before making assertions that don't wait on their own (e.g. be_axe_clean).
+    def wait_for_turbo
+      expect(page).to have_no_css('html[aria-busy]', visible: :all)
+    end
+  end
+end

data/spec/support/features.rb

@@ -4,8 +4,10 @@
 
 require File.expand_path('features/search_helpers.rb', __dir__)
 require File.expand_path('features/session_helpers.rb', __dir__)
+require File.expand_path('features/turbo_helpers.rb', __dir__)
 
 RSpec.configure do |config|
   config.include Features::SearchHelpers, type: :feature
   config.include Features::SessionHelpers, type: :feature
+  config.include Features::TurboHelpers, type: :feature
 end

data/spec/support/user_helpers.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module UserHelpers
+  def build_user(attributes = {})
+    User.new(user_attributes(attributes))
+  end
+
+  def create_user(attributes = {})
+    User.create!(user_attributes(attributes))
+  end
+
+  def user_attributes(attributes = {})
+    attributes = attributes.dup
+    password = attributes.delete(:password) || "password"
+    email = attributes.delete(:email) || attributes.delete(:email_address) || "user@example.com"
+    email_attribute = User.column_names.include?("email_address") ? :email_address : :email
+
+    {
+      email_attribute => email,
+      password: password,
+      password_confirmation: attributes.delete(:password_confirmation) || password
+    }.merge(attributes)
+  end
+end

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -15,7 +15,7 @@ class TestAppGenerator < Rails::Generators::Base
     Bundler.with_unbundled_env do
       run "bundle install"
     end
-    options = '--devise'
+    options = Rails.gem_version >= Gem::Version.new('8.0.0') ? '--authentication' : '--devise'
     if ENV['BLACKLIGHT_API_TEST'].present?
       options += ' --skip-assets'
     end

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

@@ -17,9 +17,9 @@ RSpec.describe "catalog/_document" do
     stub_template "catalog/_b_default.html.erb" => "b_partial"
     stub_template "catalog/_c_default.html.erb" => "c_partial"
     render partial: "catalog/document", locals: { document: document, document_counter: 1, view_config: blacklight_config.index }
-    expect(rendered).to match /a_partial/
-    expect(rendered).to match /b_partial/
-    expect(rendered).to match /c_partial/
+    expect(rendered).to include('a_partial')
+    expect(rendered).to include('b_partial')
+    expect(rendered).to include('c_partial')
   end
 
   context 'with a configured document component' do
@@ -39,7 +39,7 @@ RSpec.describe "catalog/_document" do
 
     it 'renders the document component' do
       render partial: "catalog/document", locals: { document: document, document_counter: 1, view_config: blacklight_config.index }
-      expect(rendered).to match /blah/
+      expect(rendered).to include('blah')
     end
   end
 end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 RSpec.describe "catalog/_paginate_compact.html.erb" do
-  let(:user) { User.new { |u| u.save(validate: false) } }
+  let(:user) { create_user }
   let(:blacklight_config) { Blacklight::Configuration.new }
 
   before do
@@ -16,7 +16,7 @@ RSpec.describe "catalog/_paginate_compact.html.erb" do
   end
 
   it "renders ActiveRecord collections" do
-    50.times { b = Bookmark.new; b.user = user; b.save! }
+    50.times { Bookmark.create!(user: user) }
     render partial: 'catalog/paginate_compact', object: Bookmark.page(1).per(25)
     expect(rendered).to have_css ".page-entries"
     expect(rendered).to have_css "a[@rel=next]"

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

@@ -17,10 +17,10 @@ RSpec.describe "catalog/_sort_and_per_page" do
     stub_template "catalog/_per_page_widget.html.erb" => "per_page_widget"
     stub_template "catalog/_view_type_group.html.erb" => "view_type_group"
     render
-    expect(rendered).to match /paginate_compact/
-    expect(rendered).to match /sort_widget/
-    expect(rendered).to match /per_page_widget/
-    expect(rendered).to match /view_type_group/
+    expect(rendered).to include('paginate_compact')
+    expect(rendered).to include('sort_widget')
+    expect(rendered).to include('per_page_widget')
+    expect(rendered).to include('view_type_group')
   end
 
   it "does not render the pagination controls with bad limit values" do
@@ -30,6 +30,6 @@ RSpec.describe "catalog/_sort_and_per_page" do
     stub_template "catalog/_per_page_widget.html.erb" => "per_page_widget"
     stub_template "catalog/_view_type_group.html.erb" => "view_type_group"
     render
-    expect(rendered).not_to match /paginate_compact/
+    expect(rendered).not_to include('paginate_compact')
   end
 end

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

@@ -12,7 +12,7 @@ RSpec.describe "catalog/index.html.erb" do
     it "renders the Search::SidebarComponent component" do
       render
 
-      expect(sidebar).to match /Limit your search/
+      expect(sidebar).to include('Limit your search')
     end
   end
 
@@ -31,7 +31,7 @@ RSpec.describe "catalog/index.html.erb" do
 
     it "renders the search_header partial" do
       render
-      expect(rendered).to match /sortAndPerPage/
+      expect(rendered).to include('sortAndPerPage')
     end
   end
 end

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

@@ -9,7 +9,6 @@ RSpec.describe "catalog/show.html.erb" do
     allow(presenter).to receive(:html_title).and_return('Heading')
     allow(document).to receive(:more_like_this).and_return([])
     allow(view).to receive_messages(has_user_authentication_provider?: false)
-    allow(view).to receive_messages(render_document_sidebar_partial: "Sidebar")
     allow(view).to receive_messages(current_search_session: nil, search_session: {})
     assign :document, document
     allow(view).to receive_messages(document_presenter: presenter, action_name: 'show', blacklight_config: blacklight_config)
@@ -36,8 +35,8 @@ RSpec.describe "catalog/show.html.erb" do
     stub_template "catalog/_b_default.html.erb" => "b_partial"
     stub_template "catalog/_c_default.html.erb" => "c_partial"
     render
-    expect(rendered).to match /a_partial/
-    expect(rendered).to match /b_partial/
-    expect(rendered).to match /c_partial/
+    expect(rendered).to include('a_partial')
+    expect(rendered).to include('b_partial')
+    expect(rendered).to include('c_partial')
   end
 end

data/spec/views/shared/_user_util_links.html.erb_spec.rb

@@ -7,6 +7,10 @@ RSpec.describe "shared/_user_util_links" do
     end
   end
 
+  before do
+    allow(controller).to receive(:render_bookmarks_control?).and_return false
+  end
+
   it "renders the correct bookmark count" do
     count = rand(99)
     allow(controller).to receive(:render_bookmarks_control?).and_return true
@@ -15,4 +19,56 @@ RSpec.describe "shared/_user_util_links" do
     render "shared/user_util_links"
     expect(rendered).to have_css('#bookmarks_nav span.badge[data-role=bookmark-counter]', text: count.to_s)
   end
+
+  it "renders Rails authentication session links" do
+    user = instance_double(User, to_s: "xyz@example.com")
+
+    allow(view).to receive_messages(
+      blacklight_account_path: nil,
+      blacklight_config: blacklight_config,
+      blacklight_login_path: "/session/new",
+      blacklight_logout_link_options: { data: { turbo_method: :delete } },
+      blacklight_logout_path: "/session",
+      current_user: user,
+      has_user_authentication_provider?: true
+    )
+
+    render "shared/user_util_links"
+
+    expect(rendered).to have_link("Log Out", href: "/session")
+    expect(rendered).to have_css('a[data-turbo-method="delete"]', text: "Log Out")
+    expect(rendered).to have_no_link("xyz@example.com")
+  end
+
+  it "renders Devise-compatible session and registration links" do
+    user = instance_double(User, to_s: "xyz@example.com")
+
+    allow(view).to receive_messages(
+      blacklight_account_path: "/users/edit",
+      blacklight_config: blacklight_config,
+      blacklight_login_path: "/users/sign_in",
+      blacklight_logout_link_options: {},
+      blacklight_logout_path: "/users/sign_out",
+      current_user: user,
+      has_user_authentication_provider?: true
+    )
+
+    render "shared/user_util_links"
+
+    expect(rendered).to have_link("Log Out", href: "/users/sign_out")
+    expect(rendered).to have_link("xyz@example.com", href: "/users/edit")
+  end
+
+  it "renders a provider-neutral login link" do
+    allow(view).to receive_messages(
+      blacklight_config: blacklight_config,
+      blacklight_login_path: "/session/new",
+      current_user: nil,
+      has_user_authentication_provider?: true
+    )
+
+    render "shared/user_util_links"
+
+    expect(rendered).to have_link("Login", href: "/session/new")
+  end
 end

data/template.demo.rb

@@ -4,7 +4,8 @@ gem 'blacklight', '>= 7.0'
 
 after_bundle do
   # run the blacklight install generator
-  options = ENV.fetch("BLACKLIGHT_INSTALL_OPTIONS", '--devise --marc')
+  default_authentication_option = Rails.gem_version >= Gem::Version.new('8.0.0') ? '--authentication' : '--devise'
+  options = ENV.fetch("BLACKLIGHT_INSTALL_OPTIONS", "#{default_authentication_option} --marc")
 
   generate 'blacklight:install', options