blacklight 7.33.1 → 7.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd9f780cd93deb22275984f9441e19bbffba7c3b07ba1173bd092786cd68bcef
-  data.tar.gz: 320dc37ac26ba35cbb9d4916babb45187f1a93203561cc1bcb214d6e1ebb181e
+  metadata.gz: 841946108f3216c1dfc66f10787069b43fdcca041e9cc3e114524bf0a5cf6aa1
+  data.tar.gz: 621f2d5648013ab85fa3c3c99a001824e49b24be263cd1eda45a7f5ed9e22daa
 SHA512:
-  metadata.gz: 11ab615553f94bbdb382865dc4cd9dc757b9895de17976a8a8e9294987e25ef54d8b1e5d3f744690984508d5f6375cb823b21b78411f9b87c0ab5fe90dde6bec
-  data.tar.gz: afab5ae2f8e18deaf6935abb4160a326849cc4234bc9ac9cd21f757395493b7d698c908541f960ee8a17a3beb4c5e48b71f675c578426736f6055e57659c9709
+  metadata.gz: 9ae81c46a04f928701d7e16c227bf33ae9ed0ae214e6ef94bbf96bc0b33aa22ff889e286a1235d6c6a225e11597fe3e832db2c5242cc71a533229ee75dc2b407
+  data.tar.gz: 2005c22b35ac7a9f4c3fb065f412a6369bcf903f918bc46770d23999a509bae45d855c83b14a0e167f3acbafd900ae63f6fe4cfe30de98f8d97bb17980a64c49

data/.env

@@ -1,5 +1,6 @@
 ALPINE_RUBY_VERSION=2.7.5
 RAILS_VERSION=5.2.6
+VIEW_COMPONENT_VERSION=2.6.6
 SOLR_PORT=8983
 SOLR_URL=http://solr:8983/solr/blacklight-core
 SOLR_VERSION=latest

data/.github/workflows/ruby.yml

@@ -32,7 +32,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.7, '3.0', 3.1]
+        ruby: [2.7, '3.0', 3.1, 3.2]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
@@ -129,6 +129,26 @@ jobs:
       env:
         RAILS_VERSION: 6.1.6.1
         ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-keeps --skip-action-cable --skip-test'
+  test_vc3:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['3.2']
+    env:
+      VIEW_COMPONENT_VERSION: ${{ matrix.view_component_version }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler: 'latest'
+    - name: Install dependencies
+      run: bundle install
+    - 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'
   api_test:
     runs-on: ubuntu-latest
     strategy:

data/.rubocop.yml

@@ -63,6 +63,8 @@ Naming/MethodParameterName:
     - id
     - q
     - as
+    - of
+    - by
 
 Naming/PredicateName:
   ForbiddenPrefixes:

data/Gemfile

@@ -33,6 +33,10 @@ else
     end
   end
 
+  unless ENV['VIEW_COMPONENT_VERSION'].to_s == ""
+    gem 'view_component', ENV.fetch('VIEW_COMPONENT_VERSION')
+  end
+
   case ENV['RAILS_VERSION']
   when /^6.0/
     gem 'sass-rails', '>= 6'

data/VERSION

@@ -1 +1 @@
-7.33.1
+7.35.0

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

@@ -40,7 +40,7 @@
 
   <% if sort_fields_select %>
     <div class="form-group row mb-4">
-      <%= content_tag :h2, t('blacklight.advanced_search.form.sort_label'), class: 'col-md-3 col-form-label text-md-right' %>
+      <%= content_tag :h2, t('blacklight.advanced_search.form.sort_label'), id: 'advanced-search-sort-label', class: 'col-md-3 col-form-label text-md-right' %>
       <div class="col">
         <%= sort_fields_select %>
       </div>

data/app/components/blacklight/advanced_search_form_component.rb

@@ -26,21 +26,21 @@ module Blacklight
 
     def default_operator_menu
       options_with_labels = [:must, :should].index_by { |op| t(op, scope: 'blacklight.advanced_search.op') }
-      select_tag(:op, options_for_select(options_with_labels, params[:op]), class: 'input-small')
+      label_tag(:op, t('blacklight.advanced_search.op.label'), class: 'sr-only visually-hidden') + select_tag(:op, options_for_select(options_with_labels, params[:op]), class: 'input-small')
     end
 
     def sort_fields_select
       options = sort_fields.values.map { |field_config| [helpers.sort_field_label(field_config.key), field_config.key] }
       return unless options.any?
 
-      select_tag(:sort, options_for_select(options, params[:sort]), class: "form-control sort-select w-auto")
+      select_tag(:sort, options_for_select(options, params[:sort]), class: "form-control sort-select w-auto", aria: { labelledby: 'advanced-search-sort-label' })
     end
 
     private
 
     def initialize_search_field_controls
       search_fields.values.each.with_index do |field, i|
-        search_field_control do
+        with_search_field_control do
           fields_for('clause[]', i, include_id: false) do |f|
             content_tag(:div, class: 'form-group advanced-search-field row') do
               f.label(:query, field.display_label('search'), class: "col-sm-3 col-form-label text-md-right") +
@@ -59,7 +59,7 @@ module Blacklight
 
       fields.each do |_k, config|
         display_facet = @response.aggregations[config.field]
-        search_filter_control(config: config, display_facet: display_facet)
+        with_search_filter_control(config: config, display_facet: display_facet)
       end
     end
 
@@ -72,7 +72,7 @@ module Blacklight
 
       return if constraints_text.blank?
 
-      constraint do
+      with_constraint do
         constraints_text
       end
     end

data/app/components/blacklight/content_areas_shim.rb

@@ -7,7 +7,7 @@ module Blacklight
     def with(slot_name, *args, **kwargs, &block)
       Deprecation.warn(Blacklight::ContentAreasShim,
                        'ViewComponents deprecated `with` and it will be removed in ViewComponents 3.0. content_areas. Use slots (https://viewcomponent.org/guide/slots.html) instead.')
-      public_send(slot_name, *args, **kwargs, &block)
+      public_send("with_#{slot_name}", *args, **kwargs, &block)
     end
   end
 end

data/app/components/blacklight/document/action_component.html.erb

@@ -1,9 +1,2 @@
-<% if using_default_document_action? %>
-  <%= link_to label,
-              url,
-              id: @id,
-              class: @link_classes,
-              data: {}.merge(({ blacklight_modal: "trigger", turbo: false } if @action.modal != false) || {}) %>
-<% else %>
-  <%= helpers.render(partial: @action.partial || @action.name.to_s, locals: { document: @document, document_action_config: @action }.merge(@options)) %>
-<% end %>
+<%# We keep this template around so that downstream applications can override the template if desired %>
+<%= render_control %>

data/app/components/blacklight/document/action_component.rb

@@ -16,6 +16,12 @@ module Blacklight
         @link_classes = link_classes
       end
 
+      def render_control
+        return link_to_modal_control if using_default_document_action?
+
+        render_partial
+      end
+
       def using_default_document_action?
         return true if @action.component
         return false unless @action.partial == 'document_action'
@@ -23,6 +29,18 @@ module Blacklight
         helpers.partial_from_blacklight?(@action.partial)
       end
 
+      def link_to_modal_control
+        link_to label,
+                url,
+                id: @id,
+                class: @link_classes,
+                data: {}.merge(({ blacklight_modal: "trigger", turbo: false } if @action.modal != false) || {})
+      end
+
+      def render_partial
+        helpers.render(partial: @action.partial || @action.name.to_s, locals: { document: @document, document_action_config: @action }.merge(@options))
+      end
+
       def label
         Deprecation.silence(Blacklight::ComponentHelperBehavior) do
           helpers.document_action_label(@action.name, @action)

data/app/components/blacklight/document/actions_component.rb

@@ -28,7 +28,7 @@ module Blacklight
         return if actions.present?
 
         @actions.each do |a|
-          action(component: a.component, action: a)
+          with_action(component: a.component, action: a)
         end
       end
 

data/app/components/blacklight/document_component.rb

@@ -1,9 +1,32 @@
 # frozen_string_literal: true
 
+require 'view_component/version'
+
 module Blacklight
+  ##
+  # A component for rendering a single document
+  #
+  # @note when subclassing this component, if you override the initializer,
+  #    you must explicitly specify the counter variable `document_counter` even if you don't use it.
+  #    Otherwise view_component will not provide the count value when calling the component.
+  #
+  # @see https://viewcomponent.org/guide/collections.html#collection-counter
+  #
+  # @example
+  #  class MyDocumentComponent < Blacklight::DocumentComponent
+  #    def initialize(document_counter: nil, **kwargs)
+  #      super
+  #      ... custom code ...
+  #    end
+  #  end
   class DocumentComponent < Blacklight::Component
     include Blacklight::ContentAreasShim
 
+    with_collection_parameter :document
+
+    # ViewComponent 3 changes iteration counters to begin at 0 rather than 1
+    COLLECTION_INDEX_OFFSET = ViewComponent::VERSION::MAJOR < 3 ? 0 : 1
+
     # Content appearing before the document
     renders_one :header
 
@@ -16,7 +39,7 @@ module Blacklight
 
     # The document title with some reasonable default behavior
     renders_one :title, (lambda do |*args, component: nil, **kwargs|
-      component ||= Blacklight::DocumentTitleComponent
+      component ||= @presenter&.view_config&.title_component || Blacklight::DocumentTitleComponent
 
       component.new(*args, counter: @counter, document: @document, presenter: @presenter, as: @title_component, link_to_document: !@show, document_component: self, **kwargs)
     end)
@@ -36,7 +59,7 @@ module Blacklight
 
       Deprecation.warn(Blacklight::DocumentComponent, 'Pass the presenter to the DocumentComponent') if !fields && @presenter.nil?
 
-      component ||= Blacklight::DocumentMetadataComponent
+      component ||= presenter&.view_config&.metadata_component || Blacklight::DocumentMetadataComponent
 
       component.new(*args, fields: fields || @presenter&.field_presenters || [], **kwargs)
     end)
@@ -47,7 +70,7 @@ module Blacklight
     renders_one :thumbnail, (lambda do |image_options_or_static_content = {}, *args, component: nil, **kwargs|
       next image_options_or_static_content if image_options_or_static_content.is_a? String
 
-      component ||= @presenter&.view_config&.thumbnail_component || Blacklight::Document::ThumbnailComponent
+      component ||= presenter&.view_config&.thumbnail_component || Blacklight::Document::ThumbnailComponent
       Deprecation.warn(Blacklight::DocumentComponent, 'Pass the presenter to the DocumentComponent') if !component && @presenter.nil?
 
       component.new(*args, document: @document, presenter: @presenter, counter: @counter, image_options: image_options_or_static_content, **kwargs)
@@ -79,12 +102,12 @@ module Blacklight
                    embed_component: nil,
                    thumbnail_component: nil,
                    counter: nil, document_counter: nil, counter_offset: 0,
-                   show: false)
+                   show: false, **args)
       if presenter.nil? && document.nil?
         raise ArgumentError, 'missing keyword: :document or :presenter'
       end
 
-      @document = document || presenter&.document
+      @document = document || presenter&.document || args[self.class.collection_parameter]
       @presenter = presenter
 
       @component = component
@@ -96,14 +119,14 @@ module Blacklight
       @embed_component = embed_component
 
       Deprecation.warn(Blacklight::DocumentComponent, 'Passing metadata_component is deprecated') if @metadata_component.present?
-      @metadata_component = metadata_component || Blacklight::DocumentMetadataComponent
+      @metadata_component = metadata_component
 
       Deprecation.warn(Blacklight::DocumentComponent, 'Passing thumbnail_component is deprecated') if @thumbnail_component.present?
-      @thumbnail_component = thumbnail_component || Blacklight::Document::ThumbnailComponent
+      @thumbnail_component = thumbnail_component
 
-      @document_counter = document_counter
       @counter = counter
-      @counter ||= document_counter + 1 + counter_offset if document_counter.present?
+      @document_counter = document_counter || args.fetch(self.class.collection_counter_parameter, nil)
+      @counter ||= @document_counter + COLLECTION_INDEX_OFFSET + counter_offset if @document_counter.present?
 
       @show = show
     end
@@ -122,7 +145,7 @@ module Blacklight
     def before_render
       set_slot(:title, nil) unless title
       set_slot(:thumbnail, nil, component: @thumbnail_component || presenter.view_config&.thumbnail_component) unless thumbnail || show?
-      set_slot(:metadata, nil, component: @metadata_component, fields: presenter.field_presenters) unless metadata
+      set_slot(:metadata, nil, component: @metadata_component || presenter&.view_config&.metadata_component, fields: presenter.field_presenters) unless metadata
       set_slot(:embed, nil, component: @embed_component || presenter.view_config&.embed_component) unless embed
     end
 

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

@@ -1,5 +1,7 @@
-<dl class="document-metadata dl-invert row">
+<% content = capture do %>
   <% fields.each do |field| -%>
     <%= field %>
   <% end -%>
-</dl>
+<% end %>
+
+<%= @tag.nil? ? content : tag.public_send(@tag, content, class: @classes, **@component_args) %>

data/app/components/blacklight/document_metadata_component.rb

@@ -8,16 +8,20 @@ module Blacklight
     with_collection_parameter :fields
 
     # @param fields [Enumerable<Blacklight::FieldPresenter>] Document field presenters
-    def initialize(fields: [], show: false)
+    def initialize(fields: [], tag: 'dl', classes: %w[document-metadata dl-invert row], show: false, field_layout: nil, **component_args)
       @fields = fields
+      @tag = tag
+      @classes = classes
       @show = show
+      @field_layout = field_layout
+      @component_args = component_args
     end
 
     def before_render
       return unless fields
 
       @fields.each do |field|
-        field(component: field_component(field), field: field, show: @show)
+        with_field(component: field_component(field), field: field, show: @show, layout: @field_layout)
       end
     end
 

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

@@ -1,9 +1,9 @@
 <%= render(@layout.new(facet_field: @facet_field)) do |component| %>
-  <% component.label do %>
+  <% component.with_label do %>
     <%= @facet_field.label %>
   <% end %>
 
-  <% component.body do %>
+  <% component.with_body do %>
     <ul class="facet-values list-unstyled blacklight-facet-checkboxes">
       <% presenters.each_with_index do |presenter, idx| -%>
         <li>

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

@@ -1,8 +1,8 @@
 <%= render(@layout.new(facet_field: @facet_field)) do |component| %>
-  <% component.label do %>
+  <% component.with_label do %>
     <%= @facet_field.label %>
   <% end %>
-  <% component.body do %>
+  <% component.with_body do %>
     <%= helpers.render(Blacklight::FacetFieldInclusiveConstraintComponent.new(facet_field: @facet_field)) %>
     <ul class="facet-values list-unstyled">
       <%= render_facet_limit_list @facet_field.paginator, @facet_field.key %>

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

@@ -0,0 +1,2 @@
+<%= top_bar %>
+<%= search_bar %>

data/app/components/blacklight/header_component.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class HeaderComponent < Blacklight::Component
+    renders_one :top_bar, lambda { |component: Blacklight::TopNavbarComponent|
+      component.new(blacklight_config: blacklight_config)
+    }
+
+    renders_one :search_bar, lambda { |component: Blacklight::SearchNavbarComponent|
+      component.new(blacklight_config: blacklight_config)
+    }
+
+    def initialize(blacklight_config:)
+      @blacklight_config = blacklight_config
+    end
+
+    attr_reader :blacklight_config
+
+    # Hack so that the default lambdas are triggered
+    # so that we don't have to do c.top_bar() in the call.
+    def before_render
+      set_slot(:top_bar, nil) unless top_bar
+      set_slot(:search_bar, nil) unless search_bar
+    end
+  end
+end

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

@@ -1,8 +1,8 @@
 <%= render(@layout.new(field: @field)) do |component| %>
-  <% component.label do %>
+  <% component.with_label do %>
     <%= label %>
   <% end %>
-  <% component.value do %>
+  <% component.with_value do %>
     <%= @field.render %>
   <% end %>
 <% end %>

data/app/components/blacklight/metadata_field_layout_component.rb

@@ -7,18 +7,21 @@ module Blacklight
     with_collection_parameter :field
     renders_one :label
     renders_many :values, (lambda do |value: nil, &block|
-      if block
-        content_tag :dd, class: "#{@value_class} blacklight-#{@key}", &block
+      if @value_tag.nil?
+        block&.call || value
+      elsif block
+        content_tag @value_tag, class: "#{@value_class} blacklight-#{@key}", &block
       else
-        content_tag :dd, value, class: "#{@value_class} blacklight-#{@key}"
+        content_tag @value_tag, value, class: "#{@value_class} blacklight-#{@key}"
       end
     end)
 
     # @param field [Blacklight::FieldPresenter]
-    def initialize(field:, label_class: 'col-md-3', value_class: 'col-md-9')
+    def initialize(field:, value_tag: 'dd', label_class: 'col-md-3', value_class: 'col-md-9')
       @field = field
       @key = @field.key.parameterize
       @label_class = label_class
+      @value_tag = value_tag
       @value_class = value_class
     end
 

data/app/components/blacklight/response/pagination_component.html.erb

@@ -1,3 +1,3 @@
-<%= content_tag :section, class: 'pagination',  **@html_attr do %>
+<%= content_tag :section, class: 'pagination',  **html_attr do %>
   <%= pagination %>
 <% end %>

data/app/components/blacklight/response/pagination_component.rb

@@ -8,10 +8,14 @@ module Blacklight
       # @param [Hash] html html options for the pagination container
       def initialize(response:, html: {}, **pagination_args)
         @response = response
-        @html_attr = { aria: { label: t('views.pagination.aria.container_label') } }.merge(html)
+        @html = html
         @pagination_args = pagination_args
       end
 
+      def html_attr
+        { aria: { label: t('views.pagination.aria.container_label') } }.merge(@html)
+      end
+
       def pagination
         helpers.paginate @response, **Blacklight::Engine.config.blacklight.default_pagination_options, **@pagination_args
       end

data/app/components/blacklight/response/view_type_component.rb

@@ -18,7 +18,7 @@ module Blacklight
         return if views.any?
 
         @views.each do |key, config|
-          view(key: key, view: config, selected: @selected == key, search_state: @search_state)
+          with_view(key: key, view: config, selected: @selected == key, search_state: @search_state)
         end
       end
 

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

@@ -0,0 +1,5 @@
+<%= tag.div class: 'navbar-search navbar navbar-light bg-light', role: 'navigation', aria: { label: t('blacklight.search.header') } do %>
+  <div class="<%= container_classes %>">
+    <%= search_bar %>
+  </div>
+<% end %>

data/app/components/blacklight/search_navbar_component.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class SearchNavbarComponent < Blacklight::Component
+    def initialize(blacklight_config:)
+      @blacklight_config = blacklight_config
+    end
+
+    attr_reader :blacklight_config
+
+    delegate :container_classes, to: :helpers
+
+    def search_bar
+      render search_bar_component
+    end
+
+    def search_bar_component
+      search_bar_component_class.new(
+        url: helpers.search_action_url,
+        advanced_search_url: helpers.search_action_url(action: 'advanced_search'),
+        params: helpers.search_state.params_for_search.except(:qt),
+        autocomplete_path: suggest_index_catalog_path
+      )
+    end
+
+    def search_bar_component_class
+      view_config&.search_bar_component || Blacklight::SearchBarComponent
+    end
+
+    def view_config
+      blacklight_config&.view_config(helpers.document_index_view_type)
+    end
+  end
+end

data/app/components/blacklight/system/dropdown_component.rb

@@ -29,11 +29,11 @@ module Blacklight
       end
 
       def before_render
-        button(classes: 'btn btn-outline-secondary dropdown-toggle', label: button_label) unless button
+        with_button(classes: 'btn btn-outline-secondary dropdown-toggle', label: button_label) unless button
 
         return if options.any?
 
-        options(@choices.map do |option|
+        with_options(@choices.map do |option|
           text, value = option_text_and_value(option)
           { text: text, url: helpers.url_for(@search_state.params_for_search(@param => value)), selected: @selected == value }
         end)

data/app/components/blacklight/system/flash_message_component.rb

@@ -13,7 +13,7 @@ module Blacklight
       end
 
       def before_render
-        message { @message } if @message
+        with_message { @message } if @message
       end
 
       def alert_class(type)

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

@@ -0,0 +1,12 @@
+<nav class="navbar navbar-expand-md navbar-dark bg-dark topbar" role="navigation">
+  <div class="<%= container_classes %>">
+    <%= logo_link %>
+    <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-bs-toggle="collapse" data-target="#user-util-collapse" data-bs-target="#user-util-collapse" aria-controls="user-util-collapse" aria-expanded="false" aria-label="Toggle navigation">
+      <span class="navbar-toggler-icon"></span>
+    </button>
+
+    <div class="collapse navbar-collapse justify-content-md-end" id="user-util-collapse">
+      <%= render 'shared/user_util_links' %>
+    </div>
+  </div>
+</nav>

data/app/components/blacklight/top_navbar_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class TopNavbarComponent < Blacklight::Component
+    def initialize(blacklight_config:)
+      @blacklight_config = blacklight_config
+    end
+
+    attr_reader :blacklight_config
+
+    delegate :application_name, :container_classes, to: :helpers
+
+    def logo_link(title: application_name)
+      link_to title, blacklight_config.logo_link, class: 'mb-0 navbar-brand navbar-logo'
+    end
+  end
+end

data/app/controllers/concerns/blacklight/base.rb

@@ -4,4 +4,9 @@ module Blacklight::Base
 
   include Blacklight::Configurable
   include Blacklight::SearchContext
+
+  def self.included(mod)
+    Deprecation.warn(Blacklight::Base, "Blacklight::Base is deprecated and will be removed in Blacklight 8.0.0.
+	Include Blacklight::Configurable and Blacklight::SearchContext as needed (included in #{mod}).")
+  end
 end

data/app/controllers/concerns/blacklight/bookmarks.rb

@@ -42,7 +42,11 @@ module Blacklight::Bookmarks
     @bookmarks = token_or_current_or_guest_user.bookmarks
     bookmark_ids = @bookmarks.collect { |b| b.document_id.to_s }
     @response, deprecated_document_list = search_service.fetch(bookmark_ids)
-    @document_list = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_document_list, "The @document_list instance variable is now deprecated and will be removed in Blacklight 8.0")
+    @document_list = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(
+      deprecated_document_list,
+      "The @document_list instance variable is now deprecated",
+      ActiveSupport::Deprecation.new("8.0", "blacklight")
+    )
 
     respond_to do |format|
       format.html {}

data/app/controllers/concerns/blacklight/catalog.rb

@@ -5,7 +5,10 @@ module Blacklight::Catalog
   # MimeResponds is part of ActionController::Base, but not ActionController::API
   include ActionController::MimeResponds
 
-  include Blacklight::Base
+  Deprecation.silence(Blacklight::Base) do
+    include Blacklight::Base
+  end
+
   include Blacklight::Facet
   include Blacklight::Searchable
 
@@ -31,7 +34,11 @@ module Blacklight::Catalog
   def index
     (@response, deprecated_document_list) = search_service.search_results
 
-    @document_list = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_document_list, 'The @document_list instance variable is deprecated; use @response.documents instead.')
+    @document_list = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(
+      deprecated_document_list,
+      'The @document_list instance variable is deprecated; use @response.documents instead.',
+      ActiveSupport::Deprecation.new("8.0", "blacklight")
+    )
 
     respond_to do |format|
       format.html { store_preferred_view }
@@ -50,7 +57,11 @@ module Blacklight::Catalog
   # to add responses for formats other than html or json see _Blacklight::Document::Export_
   def show
     deprecated_response, @document = search_service.fetch(params[:id])
-    @response = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_response, 'The @response instance variable is deprecated; use @document.response instead.')
+    @response = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(
+      deprecated_response,
+      'The @response instance variable is deprecated; use @document.response instead.',
+      ActiveSupport::Deprecation.new("8.0", "blacklight")
+    )
 
     respond_to do |format|
       format.html { @search_context = setup_next_and_previous_documents }

data/app/controllers/concerns/blacklight/controller.rb

@@ -25,7 +25,7 @@ module Blacklight::Controller
       helper_method :blacklight_config, :blacklight_configuration_context # move to Catalog
       helper_method :search_action_url, :search_action_path
       helper_method :search_facet_path # move to catalog? deprecate?
-      helper_method :search_state # move to catalog?
+      helper_method :search_state
     end
 
     # Which class to use for the search state. You can subclass SearchState if you
@@ -64,8 +64,9 @@ module Blacklight::Controller
     has_user_authentication_provider? && current_or_guest_user.present?
   end
 
+  # This must be on every controller that uses the layout, because it is used in
+  # the header to draw Blacklight::SearchNavbarComponent (via the shared/header_navbar template)
   # @return [Blacklight::SearchState] a memoized instance of the parameter state.
-  # TODO: move to catalog?
   def search_state
     @search_state ||= search_state_class.new(params, blacklight_config, self)
   end