Enable configuration of the index tools partials

app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -104,9 +104,11 @@ def render_index_doc_actions(document, options={})
     wrapping_class = options.delete(:wrapping_class) || "index-document-functions"
 
     content = []
-    content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if render_bookmarks_control?
+    index_tool_partials.select { |config| evaluate_if_unless_configuration config, @document }.each do |config|
+      content << render(config.partial, { document: document }.merge(options))
+    end
 
-    content_tag("div", safe_join(content, "\n"), :class=> wrapping_class)
+    content_tag("div", safe_join(content, "\n"), class: wrapping_class)
   end
 
   ##

lib/blacklight/bookmarks.rb

@@ -10,12 +10,16 @@ module Blacklight::Bookmarks
     include Blacklight::Configurable
     include Blacklight::SolrHelper
     include Blacklight::TokenBasedUser
+    include Blacklight::Catalog::IndexTools
 
     copy_blacklight_config_from(CatalogController)
 
     before_filter :verify_user
 
     self.document_actions[:sms].if = false if self.document_actions[:sms]
+
+    # provided by Blacklight::Catalog::IndexTools
+    add_index_tools_partial('catalog/bookmark_control', if: :render_bookmarks_control?)
   end
 
   def action_documents

lib/blacklight/catalog.rb

@@ -1,13 +1,15 @@
 # -*- encoding : utf-8 -*-
-module Blacklight::Catalog   
+module Blacklight::Catalog
   extend ActiveSupport::Concern
 
   require 'blacklight/catalog/document_actions'
+  require 'blacklight/catalog/index_tools'
   require 'blacklight/catalog/search_context'
 
   include Blacklight::Base
 
   include Blacklight::Catalog::DocumentActions
+  include Blacklight::Catalog::IndexTools
 
   SearchHistoryWindow = 100 # how many searches to save in session history
 
@@ -31,6 +33,9 @@ module Blacklight::Catalog
     add_document_action(:citation)
     add_document_action(:librarian_view, if: Proc.new { |ctx, config, doc| ctx.respond_to? :librarian_view_catalog_path and doc.respond_to?(:to_marc) })
 
+    # provided by Blacklight::Catalog::IndexTools
+    add_index_tools_partial('catalog/bookmark_control', if: :render_bookmarks_control?)
+
   end
 
     # get search results from the solr index

lib/blacklight/catalog/index_tools.rb

@@ -0,0 +1,34 @@
+module Blacklight
+  module Catalog::IndexTools
+    extend ActiveSupport::Concern
+    included do
+      helper_method :index_tool_partials
+    end
+
+    def index_tool_partials
+      self.class.index_tool_partials
+    end
+
+    module ClassMethods
+      def index_tool_partials
+        @index_tool_partials ||= []
+      end
+
+      ##
+      # @param partial [String] the name of the document partial
+      # @param opts [Hash]
+      # @option opts [Symbol,Proc] :if render this action if the method identified by the symbol or the proc evaluates to true.
+      #                             The proc will receive the action configuration and the document or documents for the action.
+      # @option opts [Symbol,Proc] :unless render this action unless the method identified by the symbol or the proc evaluates to true
+      #                             The proc will receive the action configuration and the document or documents for the action.
+      def add_index_tools_partial partial, opts = {}
+        config = Blacklight::Configuration::ToolConfig.new({partial: partial}.merge(opts))
+
+        if block_given?
+          yield config
+        end
+        index_tool_partials << config
+      end
+    end
+  end
+end

spec/helpers/blacklight_helper_spec.rb

@@ -111,6 +111,10 @@ def mock_document_app_helper_url *args
   end
 
   describe "with a config" do
+    let :index_tool_partials do
+      [Blacklight::Configuration::ToolConfig.new(partial: 'catalog/bookmark_control', if: :render_bookmarks_control?)]
+    end
+
     before do
       @config = Blacklight::Configuration.new.configure do |config|
         config.index.title_field = 'title_display'
@@ -122,6 +126,8 @@ def mock_document_app_helper_url *args
       allow(helper).to receive(:has_user_authentication_provider?).and_return(true)
       allow(helper).to receive(:current_or_guest_user).and_return(User.new)
       allow(helper).to receive_messages(current_bookmarks: [])
+
+      allow(helper).to receive(:index_tool_partials).and_return index_tool_partials
     end
     describe "render_index_doc_actions" do
       it "should render partials" do

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

@@ -9,13 +9,18 @@
     Blacklight::Configuration.new
   end
 
+  let :index_tool_partials do
+    [Blacklight::Configuration::ToolConfig.new(partial: 'catalog/bookmark_control', if: :render_bookmarks_control?)]
+  end
+
   it "should render the document header" do
     assign :response, double(:params => {})
     allow(view).to receive(:current_search_session).and_return nil
     allow(view).to receive(:search_session).and_return({})
     allow(view).to receive(:render_grouped_response?).and_return false
     allow(view).to receive(:blacklight_config).and_return(blacklight_config)
     allow(view).to receive(:render_bookmarks_control?).and_return false
+    allow(view).to receive(:index_tool_partials).and_return index_tool_partials
     render :partial => "catalog/index_header_default", :locals => {:document => document, :document_counter => 1}
     expect(rendered).to have_selector('.document-counter', text: "2")
   end