Extract Blacklight::Configuration#defaults to contain truly shared configuration between search + document views.

Author: cbeer

lib/blacklight/configuration.rb

@@ -142,29 +142,35 @@ def initialized_default_configuration?
       # set to nil if a checkbox is prefered to the icon
       property :bookmark_icon_component, default: Blacklight::Icons::BookmarkIconComponent
 
-      # @!attribute index
-      # General configuration for all views
+      # @!attribute defaults
+      # Default configuration for all views
       # @return [Blacklight::Configuration::ViewConfig::Index]
-      property :index, default: ViewConfig::Index.new(
+      property :defaults, default: ViewConfig.new(
         # document presenter class used by helpers and views
         document_presenter_class: nil,
-        # document presenter used for json responses
-        json_presenter_class: Blacklight::JsonPresenter,
         # component class used to render a document
         document_component: Blacklight::DocumentComponent,
         document_embed_component: nil,
         document_metadata_component: Blacklight::DocumentMetadataComponent,
         document_thumbnail_component: Blacklight::Document::ThumbnailComponent,
         document_title_component: Blacklight::DocumentTitleComponent,
-        sidebar_component: Blacklight::Search::SidebarComponent,
-        dropdown_component: Blacklight::System::DropdownComponent,
         # solr field to use to render a document title
         title_field: nil,
         # solr field to use to render format-specific partials
-        display_type_field: nil,
+        display_type_field: nil
+      )
+
+      # @!attribute index
+      # General configuration for search views
+      # @return [Blacklight::Configuration::ViewConfig::Index]
+      property :index, default: ViewConfig::Index.new(
+        document_actions: NestedOpenStructWithHashAccess.new(ToolConfig),
+        # document presenter used for json responses
+        json_presenter_class: Blacklight::JsonPresenter,
+        sidebar_component: Blacklight::Search::SidebarComponent,
+        dropdown_component: Blacklight::System::DropdownComponent,
         # the "field access" key to use to look up the document display fields
         document_fields_key: :index_fields,
-        document_actions: NestedOpenStructWithHashAccess.new(ToolConfig),
         collection_actions: NestedOpenStructWithHashAccess.new(ToolConfig),
         # what field, if any, to use to render grouped results
         group: false,
@@ -190,9 +196,7 @@ def initialized_default_configuration?
       # Additional configuration when displaying a single document
       # @return [Blacklight::Configuration::ViewConfig::Show]
       property :show, default: ViewConfig::Show.new(
-        # document presenter class used by helpers and views
-        document_presenter_class: nil,
-        document_component: Blacklight::DocumentComponent,
+        document_actions: NestedOpenStructWithHashAccess.new(ToolConfig),
         document_thumbnail_component: nil,
         show_tools_component: Blacklight::Document::ShowToolsComponent,
         show_header_tools_component: nil,
@@ -205,7 +209,6 @@ def initialized_default_configuration?
         # Set this to a hash with additional arguments to merge into the route,
         # or set `controller: :current` to route to the current controller.
         route: nil,
-        document_actions: NestedOpenStructWithHashAccess.new(ToolConfig),
         header_actions: NestedOpenStructWithHashAccess.new(ToolConfig)
       )
 
@@ -214,8 +217,8 @@ def initialized_default_configuration?
       # @return [Hash{Symbol => Blacklight::Configuration::ViewConfig}]
       property :action_mapping, default: NestedOpenStructWithHashAccess.new(
         ViewConfig,
-        default: { top_level_config: :index },
-        show: { top_level_config: :show },
+        default: { top_level_config: :index, default_top_level_config: :defaults },
+        show: { top_level_config: :show, default_top_level_config: :index },
         citation: { parent_config: :show },
         email_record: { top_level_config: :email },
         sms_record: { top_level_config: :sms }
@@ -660,7 +663,12 @@ def action_config(action, default: :index)
 
       action_config = action_config.reverse_merge(self[action_config.top_level_config]) if action_config.top_level_config
       action_config = action_config.reverse_merge(show) if default == :show && action_config.top_level_config != :show
-      action_config.reverse_merge(index)
+      action_config = action_config.reverse_merge(self[action_config.default_top_level_config])
+
+      # provide backwards compatibility for e.g. the show action falling back on the index defaults
+      action_config = action_config.reverse_merge(defaults) if action_config.default_top_level_config == :index
+
+      action_config
     end
   end
 end

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

@@ -16,7 +16,7 @@
     stub_template "catalog/_a_default.html.erb" => "a_partial"
     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 }
+    render partial: "catalog/document", locals: { document: document, document_counter: 1, view_config: blacklight_config.view_config(:index) }
     expect(rendered).to match /a_partial/
     expect(rendered).to match /b_partial/
     expect(rendered).to match /c_partial/
@@ -38,7 +38,7 @@ def call
     end
 
     it 'renders the document component' do
-      render partial: "catalog/document", locals: { document: document, document_counter: 1, view_config: blacklight_config.index }
+      render partial: "catalog/document", locals: { document: document, document_counter: 1, view_config: blacklight_config.view_config(:index) }
       expect(rendered).to match /blah/
     end
   end