Copy SearchContextComponent to ServerItemPaginationComponent to ease …

…BL8 upgrade path

Closes projectblacklight#3313

app/components/blacklight/search_context/server_item_pagination_component.html.erb

@@ -0,0 +1,10 @@
+<div class='pagination-search-widgets'>
+
+  <div class="page-links">
+    <%= link_to_previous_document %> |
+
+    <%= item_page_entry_info %> |
+
+    <%= link_to_next_document %>
+  </div>
+</div>

app/components/blacklight/search_context/server_item_pagination_component.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module SearchContext
+    class ServerItemPaginationComponent < Blacklight::Component
+      with_collection_parameter :search_context
+
+      def initialize(search_context:, search_session:, current_document:)
+        @search_context = search_context
+        @search_session = search_session
+        @current_document_id = current_document.id
+      end
+
+      def render?
+        @search_context.present? && (@search_context[:prev] || @search_context[:next])
+      end
+
+      def item_page_entry_info
+        Deprecation.silence(Blacklight::CatalogHelperBehavior) do
+          helpers.item_page_entry_info
+        end
+      end
+
+      def link_to_previous_document(document = nil, *args, **kwargs)
+        Deprecation.silence(Blacklight::UrlHelperBehavior) do
+          helpers.link_to_previous_document(document || @search_context[:prev], *args, **kwargs)
+        end
+      end
+
+      def link_to_next_document(document = nil, *args, **kwargs)
+        Deprecation.silence(Blacklight::UrlHelperBehavior) do
+          helpers.link_to_next_document(document || @search_context[:next], *args, **kwargs)
+        end
+      end
+    end
+  end
+end

app/components/blacklight/search_context_component.rb

@@ -5,6 +5,7 @@ class SearchContextComponent < Blacklight::Component
     with_collection_parameter :search_context
 
     def initialize(search_context:, search_session:)
+      Blacklight.deprecation.warn("Blacklight::SearchContextComponent is deprecated and will be moved to Blacklight::SearchContext::ServerItemPaginationComponent in Blacklight 8.0.0")
       @search_context = search_context
       @search_session = search_session
     end

app/helpers/blacklight/catalog_helper_behavior.rb

@@ -106,7 +106,7 @@ def item_page_entry_info
                                                        total: number_with_delimiter(search_session['total']),
                                                        count: search_session['total'].to_i).html_safe
   end
-  deprecation_deprecate item_page_entry_info: 'Use Blacklight::SearchContextComponent methods instead'
+  deprecation_deprecate item_page_entry_info: 'Use Blacklight::SearchContext::ServerItemPaginationComponent methods instead'
 
   ##
   # Look up search field user-displayable label

app/helpers/blacklight/url_helper_behavior.rb

@@ -58,7 +58,7 @@ def link_to_previous_document(previous_document, classes: 'previous', **addl_lin
       tag.span raw(t('views.pagination.previous')), class: 'previous'
     end
   end
-  deprecation_deprecate link_to_previous_document: 'Moving to Blacklight::SearchContextComponent'
+  deprecation_deprecate link_to_previous_document: 'Moving to Blacklight::SearchContext::ServerItemPaginationComponent'
 
   ##
   # Link to the next document in the current search context
@@ -69,7 +69,7 @@ def link_to_next_document(next_document, classes: 'next', **addl_link_opts)
       tag.span raw(t('views.pagination.next')), class: 'next'
     end
   end
-  deprecation_deprecate link_to_previous_document: 'Moving to Blacklight::SearchContextComponent'
+  deprecation_deprecate link_to_previous_document: 'Moving to Blacklight::SearchContext::ServerItemPaginationComponent'
 
   ##
   # Attributes for a link that gives a URL we can use to track clicks for the current search session

app/views/catalog/_previous_next_doc.html.erb

@@ -1,2 +1,2 @@
-<% Deprecation.warn(self, 'The partial _previous_next_doc.html.erb will be removed in 8.0. Render Blacklight::SearchContextComponent instead.') %>
-<%= render(Blacklight::SearchContextComponent.new(search_context: @search_context, search_session: search_session)) %>
+<% Deprecation.warn(self, 'The partial _previous_next_doc.html.erb will be removed in 8.0. Render Blacklight::SearchContext::ServerItemPaginationComponent instead.') %>
+<%= render(Blacklight::SearchContext::ServerItemPaginationComponent.new(search_context: @search_context, search_session: search_session, current_document: @current_document)) %>

app/views/catalog/_show_main_content.html.erb

@@ -1,4 +1,4 @@
-<%= render(Blacklight::SearchContextComponent.new(search_context: @search_context, search_session: search_session)) if search_session['document_id'] == @document.id %>
+<%= render(Blacklight::SearchContext::ServerItemPaginationComponent.new(search_context: @search_context, search_session: search_session, current_document: @document)) if search_session['document_id'] == @document.id %>
 
 <% @page_title = t('blacklight.search.show.title', document_title: Deprecation.silence(Blacklight::BlacklightHelperBehavior) { document_show_html_title }, application_name: application_name).html_safe %>
 <% content_for(:head) { render_link_rel_alternates } %>