Merge pull request #3333 from projectblacklight/deprecate-sidebar-partial

Deprecate render_document_sidebar_partial and catalog/show_sidebar pa…

Author: jcoyne

app/helpers/blacklight/document_helper_behavior.rb

@@ -35,6 +35,9 @@ def document_class_prefix
   def render_document_sidebar_partial(document)
     render 'show_sidebar', document: document
   end
+  Blacklight.deprecation.deprecate_methods(self,
+                                           render_document_sidebar_partial: 'has been replaced by calling the sidebar component (Blacklight::Search::SidebarComponent) directly. ' \
+                                                                            'Set sidebar_component in the view config.')
 
   ##
   # return the Bookmarks on a set of documents (all bookmarks on the page)

app/views/catalog/_show_sidebar.html.erb

@@ -1,2 +1,3 @@
+<% Blacklight.deprecation.warn('The partial catalog/_show_sidebar.html.erb will be removed in Blacklight 9.0. Configure blacklight_config.show.sidebar_component instead (default Blacklight::Search::SidebarComponent).') unless local_assigns[:silence_deprecation] %>
 <% presenter = document_presenter(document) %>
 <%= render presenter.view_config.sidebar_component.new(presenter: presenter) %>

app/views/catalog/show.html.erb

@@ -1,5 +1,6 @@
 <%= render 'show_main_content' %>
 
 <% content_for(:sidebar) do %>
-  <%= render_document_sidebar_partial @document %>
+  <% presenter = document_presenter(@document) %>
+  <%= render presenter.view_config.sidebar_component.new(presenter: presenter) %>
 <% end %>

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

@@ -7,8 +7,8 @@
 
   before 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)