blacklight 7.15.1 → 7.17.2

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

@@ -3,7 +3,13 @@
 module Blacklight
   module System
     class ModalComponent < ViewComponent::Base
-      with_content_areas :prefix, :header, :title, :body, :footer
+      include Blacklight::ContentAreasShim
+
+      renders_one :prefix
+      renders_one :header
+      renders_one :title
+      renders_one :body
+      renders_one :footer
     end
   end
 end

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

@@ -198,7 +198,7 @@ module Blacklight::Catalog
   # @example
   #   config.index.respond_to.txt = Proc.new { render plain: "A list of docs." }
   def additional_response_formats(format)
-    blacklight_config.index.respond_to.each do |key, config|
+    blacklight_config.view_config(action_name: :index).respond_to.each do |key, config|
       format.send key do
         case config
         when false

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -380,7 +380,7 @@ module Blacklight::BlacklightHelperBehavior
   def show_presenter_class(_document)
     Deprecation.warn(Blacklight::BlacklightHelperBehavior, '#show_presenter_class is deprecated; use #document_presenter_class instead')
 
-    blacklight_config.show.document_presenter_class
+    blacklight_config.view_config(:show, action_name: action_name).document_presenter_class
   end
 
   # @deprecated
@@ -388,13 +388,12 @@ module Blacklight::BlacklightHelperBehavior
   def index_presenter_class(_document)
     Deprecation.warn(Blacklight::BlacklightHelperBehavior, '#index_presenter_class is deprecated; use #document_presenter_class instead')
 
-    (blacklight_config.view.key?(document_index_view_type) && blacklight_config.dig(:view, document_index_view_type, :document_presenter_class)) ||
-      blacklight_config.index.document_presenter_class
+    blacklight_config.view_config(document_index_view_type, action_name: action_name).document_presenter_class
   end
 
   # @return [Class]
   def search_bar_presenter_class
-    blacklight_config.index.search_bar_presenter_class
+    blacklight_config.view_config(action_name: :index).search_bar_presenter_class
   end
 
   # @!group Layout helpers

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -253,11 +253,13 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Render the view type icon for the results view picker
   #
+  # @deprecated
   # @param [String] view
   # @return [String]
   def render_view_type_group_icon view
     blacklight_icon(view)
   end
+  deprecation_deprecate render_view_type_group_icon: 'call blacklight_icon instead'
 
   ##
   # Get the default view type classes for a view in the results view picker

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -94,11 +94,11 @@ module Blacklight
     end
 
     def show_doc_actions?(document = @document, options = {})
-      filter_partials(blacklight_config.show.document_actions, { document: document }.merge(options)).any?
+      filter_partials(blacklight_config.view_config(:show).document_actions, { document: document }.merge(options)).any?
     end
 
     def document_actions(document, options: {})
-      filter_partials(blacklight_config.show.document_actions, { document: document }.merge(options)).map { |_k, v| v }
+      filter_partials(blacklight_config.view_config(:show).document_actions, { document: document }.merge(options)).map { |_k, v| v }
     end
 
     private

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -101,9 +101,9 @@ module Blacklight::ConfigurationHelperBehavior
 
   # Return the label for a search view
   # @return [String]
-  def view_label view
+  def view_label(view)
     view_config = blacklight_config.view[view]
-    view_config.display_label(view)
+    view_config.display_label
   end
   deprecation_deprecate view_label: 'Moving to ViewConfig#display_label and Blacklight::Response::ViewTypeComponent'
 

data/app/presenters/blacklight/document_presenter.rb

@@ -72,9 +72,9 @@ module Blacklight
       fields += Array.wrap(view_config[:"#{base_name}_display_type_field"]) if base_name && view_config.key?(:"#{base_name}_display_type_field")
       fields += Array.wrap(view_config.display_type_field)
 
-      if fields.empty?
-        fields += Array.wrap(configuration.show[:"#{base_name}_display_type_field"]) if base_name && configuration.show.key?(:"#{base_name}_display_type_field")
-        fields += Array.wrap(configuration.show.display_type_field)
+      if fields.empty? && show_view_config != view_config
+        fields += Array.wrap(show_view_config[:"#{base_name}_display_type_field"]) if base_name && show_view_config.key?(:"#{base_name}_display_type_field")
+        fields += Array.wrap(show_view_config.display_type_field)
       end
 
       fields += ['format'] if fields.empty? # backwards compatibility with the old default value for display_type_field
@@ -118,7 +118,11 @@ module Blacklight
     end
 
     def view_config
-      @view_config ||= configuration.view_config(:show)
+      @view_config ||= show_view_config
+    end
+
+    def show_view_config
+      configuration.view_config(:show)
     end
 
     private

data/app/services/blacklight/search_service.rb

@@ -95,7 +95,7 @@ module Blacklight
     ##
     # The key to use to retrieve the grouped field to display
     def grouped_key_for_results
-      blacklight_config.index.group
+      blacklight_config.view_config(action_name: :index).group
     end
 
     ##

data/app/views/bookmarks/_tools.html.erb

@@ -1,5 +1,5 @@
 <% if render_show_doc_actions_method_from_blacklight? %>
-  <%= render(Blacklight::Document::ActionsComponent.new(document: nil, tag: 'ul', classes: "#{controller_name}Tools nav nav-pills", wrapping_tag: 'li', wrapping_classes: 'nav-item', actions: document_actions(document_list, options: { document: nil }), options: { document_list: @response.documents }, url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h))) %>
+  <%= render(Blacklight::Document::ActionsComponent.new(document: nil, tag: 'div', classes: "#{controller_name}Tools", wrapping_tag: 'span', wrapping_classes: 'btn btn-outline-primary', link_classes: '', actions: document_actions(document_list, options: { document: nil }), options: { document_list: @response.documents }, url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h))) %>
 <% else %>
   <% Deprecation.warn(self, '#render_show_doc_actions is deprecated; use ActionComponents instead') %>
   <ul class="<%= controller_name %>Tools nav nav-pills">

data/app/views/catalog/_citation.html.erb

@@ -1,5 +1,5 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.with(:title, t('blacklight.tools.citation')) %>
+  <% component.title { t('blacklight.tools.citation') } %>
 
   <%= render Blacklight::Document::CitationComponent.with_collection(@documents) if @documents.present? %>
 <% end %>

data/app/views/catalog/_document.html.erb

@@ -1,6 +1,6 @@
 <% # container for a single doc -%>
-<%= render (blacklight_config.view_config(document_index_view_type).document_component || Blacklight::DocumentComponent).new(document: document, counter: document_counter_with_offset(document_counter)) do |component| %>
-  <% component.with(blacklight_config.view_config(document_index_view_type).document_component.blank? && blacklight_config.view_config(document_index_view_type).partials.any? ? :body : :partials) do %>
+<%= render (blacklight_config.view_config(document_index_view_type).document_component || Blacklight::DocumentComponent).new(presenter: document_presenter(document), counter: document_counter_with_offset(document_counter)) do |component| %>
+  <% component.public_send(blacklight_config.view_config(document_index_view_type).document_component.blank? && blacklight_config.view_config(document_index_view_type).partials.any? ? :body : :partial) do %>
     <%= render_document_partials document, blacklight_config.view_config(document_index_view_type).partials, component: component, document_counter: document_counter %>
   <% end %>
 <% end %>

data/app/views/catalog/_facet_layout.html.erb

@@ -1,8 +1,8 @@
 <%= render(Blacklight::FacetFieldComponent.new(facet_field: facet_field_presenter(facet_field, nil))) do |component| %>
-  <% component.with(:label) do %>
+  <% component.label do %>
     <%= facet_field_label(facet_field.key) %>
   <% end %>
-  <% component.with(:body) do %>
+  <% component.body do %>
     <%= yield %>
   <% end %>
 <% end %>

data/app/views/catalog/_show_main_content.html.erb

@@ -3,8 +3,8 @@
 <% @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 } %>
 
-<%= render (blacklight_config.show.document_component || Blacklight::DocumentComponent).new(document: @document, component: :div, title_component: :h1, show: true) do |component| %>
-  <% component.with(:footer) do %>
+<%= render (blacklight_config.view_config(:show).document_component || Blacklight::DocumentComponent).new(presenter: document_presenter(@document), component: :div, title_component: :h1, show: true) do |component| %>
+  <% component.footer do %>
     <% if @document.respond_to?(:export_as_openurl_ctx_kev) %>
       <!--
            // COinS, for Zotero among others.
@@ -17,7 +17,7 @@
 
   <%# Use :body for complete backwards compatibility (overriding the component body markup),
         but if the app explicitly  opted-in to components, make the partials data available as :partials to ease migrations pain %>
-  <% component.with(blacklight_config.show.document_component.blank? && blacklight_config.view_config(:show).partials.any? ? :body : :partials) do %>
+  <% component.public_send(blacklight_config.view_config(:show).document_component.blank? && blacklight_config.view_config(:show).partials.any? ? :body : :partial) do %>
     <div id="doc_<%= @document.id.to_s.parameterize %>">
       <%= render_document_partials @document, blacklight_config.view_config(:show).partials, component: component %>
     </div>

data/app/views/catalog/email.html.erb

@@ -1,7 +1,7 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.with(:title, t('blacklight.email.form.title')) %>
+  <% component.title { t('blacklight.email.form.title') } %>
 
-  <% component.with(:body) do %>
+  <% component.body do %>
     <%= render 'email_form' %>
   <% end %>
 <% end %>

data/app/views/catalog/email_success.html.erb

@@ -1,5 +1,5 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.with(:title, t('blacklight.email.form.title')) %>
+  <% component.title { t('blacklight.email.form.title') } %>
 
   <%= render partial: '/shared/flash_msg' %>
   <span data-blacklight-modal="close"></span>

data/app/views/catalog/facet.html.erb

@@ -1,11 +1,11 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.with(:prefix) do %>
+  <% component.prefix do %>
     <div class="facet-pagination top row justify-content-between">
       <%= render :partial=>'facet_pagination' %>
     </div>
   <% end %>
 
-  <% component.with(:title, facet_field_label(@facet.key)) %>
+  <% component.title { facet_field_label(@facet.key) } %>
 
   <%= render partial: 'facet_index_navigation' if @facet.index_range && @display_facet.index? %>
 
@@ -13,7 +13,7 @@
     <%= render_facet_limit(@display_facet, layout: false) %>
   </div>
 
-  <% component.with(:footer) do %>
+  <% component.footer do %>
     <div class="facet-pagination bottom row justify-content-between">
       <%= render :partial=>'facet_pagination' %>
     </div>

data/app/views/catalog/sms.html.erb

@@ -1,7 +1,7 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.with(:title, t('blacklight.sms.form.title')) %>
+  <% component.title { t('blacklight.sms.form.title') } %>
 
-  <% component.with(:body) do %>
+  <% component.body do %>
     <%= render 'sms_form' %>
   <% end %>
 <% end %>

data/app/views/catalog/sms_success.html.erb

@@ -1,5 +1,5 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.with(:title, t('blacklight.sms.form.title')) %>
+  <% component.title { t('blacklight.sms.form.title') } %>
 
   <%= render partial: '/shared/flash_msg' %>
   <span data-blacklight-modal="close"></span>

data/blacklight.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.add_dependency "deprecation"
   s.add_dependency "i18n", '>= 1.7.0' # added named parameters
   s.add_dependency "ostruct", '>= 0.3.2'
-  s.add_dependency "view_component", '>= 2.23.0'
+  s.add_dependency "view_component", '>= 2.28.0'
 
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.
   s.add_development_dependency "rspec-rails", "~> 4.0.0.beta2"

data/config/locales/blacklight.de.yml

@@ -3,7 +3,7 @@ de:
     pagination:
       first: '« Erste'
       last: 'Letzte »'
-      previous: '« Voherige'
+      previous: '« Vorherige'
       next: 'Nächste »'
       truncate: '…'
       aria:
@@ -16,7 +16,7 @@ de:
         go_to_previous_page: Zurück zur letzten Seite
 
     pagination_compact:
-      previous: '« Voherige'
+      previous: '« Vorherige'
       next: 'Nächste »'
 
   blacklight:

data/lib/blacklight/configuration.rb

@@ -95,6 +95,12 @@ module Blacklight
             partials: [:show_header, :show],
             document_actions: NestedOpenStructWithHashAccess.new(ToolConfig)
           ),
+          action_mapping: NestedOpenStructWithHashAccess.new(
+            ViewConfig,
+            default: { top_level_config: :index },
+            show: { top_level_config: :show },
+            citation: { parent_config: :show }
+          ),
           # Configurations for specific types of index views
           view: NestedOpenStructWithHashAccess.new(ViewConfig,
                                                    list: {},
@@ -307,13 +313,35 @@ module Blacklight
     end
     alias_method :inheritable_copy, :build
 
-    # Get a view configuration for the given view type
-    # including default values from the index configuration
+    # Get a view configuration for the given view type + action. The effective
+    # view configuration is inherited from:
+    # - the configuration from blacklight_config.view with the key `view_type`
+    # - the configuration from blacklight_config.action_mapping with the key `action_name`
+    # - any parent config for the action map result above
+    # - the action_mapping default configuration
+    # - the top-level index/show view configuration
+    #
     # @param [Symbol,#to_sym] view_type
     # @return [Blacklight::Configuration::ViewConfig]
-    def view_config(view_type)
-      view_type = view_type.to_sym unless view_type.is_a? Symbol
-      index.merge(view_type == :show ? show : view.fetch(view_type, {}))
+    def view_config(view_type = nil, action_name: :index)
+      view_type &&= view_type.to_sym
+      action_name &&= action_name.to_sym
+      action_name ||= :index
+
+      if view_type == :show
+        action_name = view_type
+        view_type = nil
+      end
+
+      @view_config ||= {}
+      @view_config[[view_type, action_name]] ||= begin
+        if view_type.nil?
+          action_config(action_name)
+        else
+          base_config = action_config(action_name)
+          base_config.merge(view.fetch(view_type, {}))
+        end
+      end
     end
 
     # YARD will include inline disabling as docs, cannot do multiline inside @!macro.  AND this must be separate from doc block.
@@ -441,5 +469,22 @@ module Blacklight
         yield(object)
       end
     end
+
+    def action_config(action, default: :index)
+      action_config = action_mapping[action]
+      action_config ||= action_mapping[:default]
+
+      if action_config.parent_config && action_config.parent_config != :default
+        parent_config = action_mapping[action_config.parent_config]
+        raise "View configuration error: the parent configuration of #{action_config.key}, #{parent_config.key}, must not specific its own parent configuration" if parent_config.parent_config
+
+        action_config = action_config.reverse_merge(parent_config)
+      end
+      action_config = action_config.reverse_merge(action_mapping[:default]) if action_config != action_mapping[:default]
+
+      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)
+    end
   end
 end

data/lib/blacklight/configuration/view_config.rb

@@ -11,21 +11,26 @@ class Blacklight::Configuration
     #   @return [String, Symbol] solr field to use to render a document title
     # @!attribute display_type_field
     #   @return [String, Symbol] solr field to use to render format-specific partials
+    # @!attribute icon
+    #   @return [String, Symbol] icon file to use in the view picker
     # @!attribute document_actions
     #   @return [NestedOpenStructWithHashAccess{Symbol => Blacklight::Configuration::ToolConfig}] 'tools' to render for each document
     def search_bar_presenter_class
       super || Blacklight::SearchBarPresenter
     end
 
-    def display_label(key)
+    def display_label(deprecated_key = nil, **options)
+      Deprecation.warn('Passing the key argument to ViewConfig#display_label is deprecated') if deprecated_key.present?
+
       I18n.t(
-        :"blacklight.search.view_title.#{key}",
+        :"blacklight.search.view_title.#{deprecated_key || key}",
         default: [
-          :"blacklight.search.view.#{key}",
+          :"blacklight.search.view.#{deprecated_key || key}",
           label,
           title,
-          key.to_s.humanize
-        ]
+          (deprecated_key || key).to_s.humanize
+        ],
+        **options
       )
     end
 
@@ -38,6 +43,10 @@ class Blacklight::Configuration
       def document_presenter_class
         super || Blacklight::ShowPresenter
       end
+
+      def to_h
+        super.merge(document_presenter_class: document_presenter_class)
+      end
     end
 
     class Index < ViewConfig
@@ -52,6 +61,10 @@ class Blacklight::Configuration
       def document_presenter_class
         super || Blacklight::IndexPresenter
       end
+
+      def to_h
+        super.merge(document_presenter_class: document_presenter_class)
+      end
     end
   end
 end

data/lib/blacklight/engine.rb

@@ -8,7 +8,9 @@ module Blacklight
     # BlacklightHelper is needed by all helpers, so we inject it
     # into action view base here.
     initializer 'blacklight.helpers' do
-      ActionView::Base.include BlacklightHelper
+      config.after_initialize do
+        ActionView::Base.include BlacklightHelper
+      end
     end
 
     # This makes our rake tasks visible.

data/lib/blacklight/open_struct_with_hash_access.rb

@@ -4,7 +4,9 @@ module Blacklight
   ##
   # An OpenStruct that responds to common Hash methods
   class OpenStructWithHashAccess < OpenStruct
-    delegate :keys, :each, :map, :has_key?, :key?, :include?, :empty?, :length, :delete, :delete_if, :keep_if, :clear, :reject!, :select!, :replace, :fetch, :to_json, :as_json, :any?, to: :to_h
+    delegate :keys, :each, :map, :has_key?, :key?, :include?, :empty?,
+             :length, :delete, :delete_if, :keep_if, :clear, :reject!, :select!,
+             :replace, :fetch, :to_json, :as_json, :any?, to: :to_h
 
     ##
     # Expose the internal hash
@@ -42,8 +44,27 @@ module Blacklight
       @table.merge!((other_hash if other_hash.is_a? Hash) || other_hash.to_h)
     end
 
+    def reverse_merge(other_hash)
+      self.class.new to_h.reverse_merge((other_hash if other_hash.is_a? Hash) || other_hash.to_h)
+    end
+
     def deep_dup
       self.class.new @table.deep_dup
     end
+
+    if Rails.version < '6'
+      # Ported from Rails 6 to fix an incompatibility with ostruct
+      def try(method_name = nil, *args, &block)
+        if method_name.nil? && block_given?
+          if b.arity.zero?
+            instance_eval(&block)
+          else
+            yield self
+          end
+        elsif respond_to?(method_name)
+          public_send(method_name, *args, &b)
+        end
+      end
+    end
   end
 end