blacklight 7.16.0 → 7.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ceacfa202c3acda3cb375ea3f76dd2e854f786aaba9e5a83a40cce15a1a77f5
-  data.tar.gz: b09a2d694145f7b8da82ecb99314632c1e521d63748ea0854a8d7dd131710633
+  metadata.gz: 1e26542ca54e79594290b86c0506e4bc3a26a225d84e17537893381b4ad2c421
+  data.tar.gz: c812f19a30e663a1350888600307e7ba1b089b8794570eeadb38f89a6de57d27
 SHA512:
-  metadata.gz: 9fd109f991c7cf33507b73fa8e40bd67c90601751abca9374da323d0e907f8117ab676406f2edba878e1aba39f2bfd477fe4892e1dd015b11a30ef9311d95d6f
-  data.tar.gz: a10adadf6affff113b5ee41dd10c469ace59eda64afb560052fb8cdd94a1188ee11b1dc7c7cafe92ff229a43504a8590c8508c407f64c6fdfadb9dfbc70a7ccd
+  metadata.gz: 8f167c42362e5372a681777ce1cd1a72bf6ca9f5762098686bc6bb8872f59afd3f110312d15c1436320b511df272281ddb04be6cf9c10620535389aa87c91169
+  data.tar.gz: 9ae4c4178d7eff8eb4656d03353fe4fb2cd4f66e32fffdebd8645275f213b26aadd9c8204c2feba9f6479160ad925ba220ce6e1ec59bff42f9ca298dfd7cbb5c

data/.rubocop.yml

@@ -57,6 +57,7 @@ Naming/MethodParameterName:
   AllowedNames:
     - id
     - q
+    - as
 
 Naming/PredicateName:
   ForbiddenPrefixes:
@@ -122,3 +123,6 @@ Style/RedundantRegexpEscape:
 
 Style/SlicingWithRange:
   Enabled: true
+
+Rails/ContentTag:
+  Enabled: false

data/VERSION

@@ -1 +1 @@
-7.16.0
+7.17.0

data/app/components/blacklight/advanced_search_form_component.html.erb

@@ -1,7 +1,9 @@
 <% if constraints.present? %>
   <div class="constraints well search_history">
     <h4><%= t 'blacklight.advanced_search.form.search_context' %></h4>
-    <%= constraints %>
+    <% constraints.each do |constraint| %>
+      <%= constraint %>
+    <% end %>
   </div>
 <% end %>
 
@@ -15,7 +17,9 @@
       </h2>
 
       <div id="advanced_search">
-        <%= search_field_controls %>
+        <% search_field_controls.each do |control| %>
+          <%= control %>
+        <% end %>
       </div>
     </div>
 
@@ -24,7 +28,9 @@
 
       <div id="advanced_search_facets" class="limit_input">
         <div class="advanced-facet-limits panel-group">
-          <%= search_filter_controls %>
+          <% search_filter_controls.each do |control| %>
+            <%= control %>
+          <% end %>
         </div>
       </div>
     </div>

data/app/components/blacklight/advanced_search_form_component.rb

@@ -2,66 +2,79 @@
 
 module Blacklight
   class AdvancedSearchFormComponent < SearchBarComponent
-    with_content_areas :constraints, :search_field_controls, :search_filter_controls
+    include Blacklight::ContentAreasShim
+
+    renders_many :constraints
+    renders_many :search_field_controls
+    renders_many :search_filter_controls, (lambda do |config:, display_facet:, presenter: nil, component: nil, **kwargs|
+      presenter ||= (config.presenter || Blacklight::FacetFieldPresenter).new(config, display_facet, @view_context)
+      component = component || config.advanced_search_component || Blacklight::FacetFieldCheckboxesComponent
+
+      component.new(facet_field: presenter, **kwargs)
+    end)
 
     def initialize(response:, **options)
       super(**options)
       @response = response
     end
 
+    def before_render
+      initialize_search_field_controls if search_field_controls.blank?
+      initialize_search_filter_controls if search_filter_controls.blank?
+      initialize_constraints if constraints.blank?
+    end
+
     def default_operator_menu
       options_with_labels = [:must, :should].index_by { |op| t(op, scope: 'blacklight.advanced_search.op') }
       select_tag(:op, options_for_select(options_with_labels, params[:op]), class: 'input-small')
     end
 
-    # Rubocop is just wrong here, so...:
-    # rubocop:disable Rails/ContentTag
-    def search_field_controls
-      @search_field_controls || safe_join(search_fields.values.map.with_index do |field, i|
-        fields_for('clause[]', i, include_id: false) do |f|
-          content_tag(:div, class: 'form-group advanced-search-field row') do
-            f.label(:query, field.display_label('search'), class: "col-sm-3 col-form-label") +
-            content_tag(:div, class: 'col-sm-9') do
-              f.hidden_field(:field, value: field.key) +
-              f.text_field(:query, value: query_for_search_clause(field.key), class: 'form-control')
+    def sort_fields_select
+      options = sort_fields.values.map { |field_config| [@view_context.sort_field_label(field_config.key), field_config.key] }
+      select_tag(:sort, options_for_select(options, params[:sort]), class: "form-control sort-select")
+    end
+
+    private
+
+    def initialize_search_field_controls
+      search_fields.values.each.with_index do |field, i|
+        search_field_control do
+          fields_for('clause[]', i, include_id: false) do |f|
+            content_tag(:div, class: 'form-group advanced-search-field row') do
+              f.label(:query, field.display_label('search'), class: "col-sm-3 col-form-label") +
+                content_tag(:div, class: 'col-sm-9') do
+                  f.hidden_field(:field, value: field.key) +
+                    f.text_field(:query, value: query_for_search_clause(field.key), class: 'form-control')
+                end
             end
           end
         end
-      end, "\n")
-    end
-    # rubocop:enable Rails/ContentTag
-
-    def query_for_search_clause(key)
-      field = (@params[:clause] || {}).values.find { |value| value['field'].to_s == key.to_s }
-
-      field&.dig('query')
+      end
     end
 
-    def search_filter_controls
-      return @search_filter_controls if @search_filter_controls
-
+    def initialize_search_filter_controls
       fields = blacklight_config.facet_fields.select { |_k, v| v.include_in_advanced_search || v.include_in_advanced_search.nil? }
 
-      safe_join(fields.map do |_k, config|
+      fields.each do |_k, config|
         display_facet = @response.aggregations[config.field]
-
-        presenter = (config.presenter || Blacklight::FacetFieldPresenter).new(config, display_facet, @view_context)
-        component = config.advanced_search_component || Blacklight::FacetFieldCheckboxesComponent
-        @view_context.render(component.new(facet_field: presenter))
-      end, "\n")
+        search_filter_control(config: config, display_facet: display_facet)
+      end
     end
 
-    def constraints
-      params = @view_context.search_state.params_for_search.except :page, :f_inclusive, :q, :search_field, :op, :index, :sort
+    def initialize_constraints
+      constraint do
+        params = @view_context.search_state.params_for_search.except :page, :f_inclusive, :q, :search_field, :op, :index, :sort
 
-      params.except!(*search_fields.map { |_key, field_def| field_def[:key] })
+        params.except!(*search_fields.map { |_key, field_def| field_def[:key] })
 
-      @view_context.render_search_to_s(params)
+        @view_context.render_search_to_s(params)
+      end
     end
 
-    def sort_fields_select
-      options = sort_fields.values.map { |field_config| [@view_context.sort_field_label(field_config.key), field_config.key] }
-      select_tag(:sort, options_for_select(options, params[:sort]), class: "form-control sort-select")
+    def query_for_search_clause(key)
+      field = (@params[:clause] || {}).values.find { |value| value['field'].to_s == key.to_s }
+
+      field&.dig('query')
     end
 
     def search_fields

data/app/components/blacklight/constraints_component.html.erb

@@ -4,7 +4,23 @@
   <%= link_to t('blacklight.search.start_over'), start_over_path, class: "catalog_startOverLink btn btn-primary" %>
 
   <span class="constraints-label sr-only"><%= t('blacklight.search.filters.title') %></span>
-  <%= query_constraints_area || query_constraints %>
-  <%= facet_constraints_area || facet_constraints %>
-  <%= additional_constraints %>
+  <% if query_constraints_area.present? %>
+    <% query_constraints_area.each do |constraint| %>
+      <%= constraint %>
+    <% end %>
+  <% else %>
+    <%= query_constraints %>
+  <% end %>
+
+  <% if facet_constraints_area.present? %>
+    <% facet_constraints_area.each do |constraint| %>
+      <%= constraint %>
+    <% end %>
+  <% else %>
+    <%= facet_constraints %>
+  <% end %>
+
+  <% additional_constraints.each do |constraints| %>
+    <%= constraints %>
+  <% end %>
 <% end %>

data/app/components/blacklight/constraints_component.rb

@@ -2,7 +2,11 @@
 
 module Blacklight
   class ConstraintsComponent < ::ViewComponent::Base
-    with_content_areas :query_constraints_area, :facet_constraints_area, :additional_constraints
+    include Blacklight::ContentAreasShim
+
+    renders_many :query_constraints_area
+    renders_many :facet_constraints_area
+    renders_many :additional_constraints
 
     def initialize(search_state:,
                    id: 'appliedParams', classes: 'clearfix constraints-container',

data/app/components/blacklight/content_areas_shim.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Blacklight
+  # Shim to support ViewComponent v2 slots using the content_areas API for backwards compatibility
+  module ContentAreasShim
+    # Shim the `with` helper to write content into slots instead
+    def with(slot_name, *args, **kwargs, &block)
+      Deprecation.warn('ViewComponents deprecated `with` and it will be removed in ViewComponents 3.0. content_areas. Use slots (https://viewcomponent.org/guide/slots.html) instead.')
+      public_send(slot_name, *args, **kwargs, &block)
+    end
+  end
+end

data/app/components/blacklight/document/action_component.rb

@@ -34,6 +34,10 @@ module Blacklight
           @view_context.document_action_path(@action, @url_opts.merge(({ id: @document } if @document) || {}))
         end
       end
+
+      def key
+        @action.key
+      end
     end
   end
 end

data/app/components/blacklight/document/actions_component.html.erb

@@ -1,13 +1,11 @@
 <%= content_tag @tag, class: @classes do %>
-  <% @actions.each do |action| %>
-    <% result = capture { @view_context.render((action.component || Blacklight::Document::ActionComponent).new(action: action, document: @document, options: @options, url_opts: @url_opts, link_classes: @link_classes)) } %>
-
+  <% actions.each do |action| %>
     <% if @wrapping_tag %>
       <%= content_tag(@wrapping_tag, class: Array(@wrapping_classes) + [action.key]) do %>
-        <%= result %>
+        <%= action %>
       <% end %>
     <% else %>
-      <%= result %>
+      <%= action %>
     <% end %>
   <% end %>
 <% end %>

data/app/components/blacklight/document/actions_component.rb

@@ -4,6 +4,11 @@ module Blacklight
   module Document
     # Render a bookmark widget to bookmark / unbookmark a document
     class ActionsComponent < ::ViewComponent::Base
+      renders_many :actions, (lambda do |action:, component: nil, **kwargs|
+        component ||= action.component || Blacklight::Document::ActionComponent
+        component.new(action: action, document: @document, options: @options, url_opts: @url_opts, link_classes: @link_classes, **kwargs)
+      end)
+
       # @param [Blacklight::Document] document
       # rubocop:disable Metrics/ParameterLists
       def initialize(document: nil, actions: [], options: {}, url_opts: nil, tag: :div, classes: 'index-document-functions', wrapping_tag: nil, wrapping_classes: nil, link_classes: 'nav-link')
@@ -19,8 +24,16 @@ module Blacklight
       end
       # rubocop:enable Metrics/ParameterLists
 
+      def before_render
+        return if actions.present?
+
+        @actions.each do |a|
+          action(component: a.component, action: a)
+        end
+      end
+
       def render?
-        @actions.any?
+        actions.present?
       end
     end
   end

data/app/components/blacklight/document_component.html.erb

@@ -12,16 +12,13 @@
     <%= body %>
   <% else %>
     <div class="document-main-section">
-      <header class="documentHeader row">
-        <%= content_tag @title_component, class: 'index_title document-title-heading' do %>
-          <%= before_title %><%= title %><%= after_title %>
-        <% end %>
-        <%= actions %>
-      </header>
-
+      <%= title %>
       <%= embed %>
       <%= content %>
       <%= metadata %>
+      <% metadata_sections.each do |section| %>
+        <%= section %>
+      <% end %>
     </div>
 
     <%= thumbnail %>

data/app/components/blacklight/document_component.rb

@@ -2,12 +2,64 @@
 
 module Blacklight
   class DocumentComponent < ::ViewComponent::Base
-    # Available content areas; some have defaults provided by
-    # the accessors below.
-    with_content_areas :header, :body, :footer,
-                       :before_title, :title, :after_title,
-                       :actions, :embed, :metadata, :thumbnail,
-                       :partials
+    include Blacklight::ContentAreasShim
+
+    # Content appearing before the document
+    renders_one :header
+
+    # Content appearing after the document
+    renders_one :footer
+
+    # Content appearing instead of the regularly rendered document; its use is discouraged, but is a stop-gap until
+    # the ecosystem fully adopts view components.
+    renders_one :body
+
+    # The document title with some reasonable default behavior
+    renders_one :title, (lambda do |*args, component: nil, **kwargs|
+      component ||= Blacklight::DocumentTitleComponent
+
+      component.new(*args, counter: @counter, document: @document, presenter: @presenter, as: @title_component, link_to_document: !@show, document_component: self, **kwargs)
+    end)
+
+    renders_one :embed, (lambda do |static_content = nil, *args, component: nil, **kwargs|
+      next static_content if static_content.present?
+      next unless component
+
+      Deprecation.warn('Pass the presenter to the DocumentComponent') if @presenter.nil?
+
+      component.new(*args, document: @document, presenter: @presenter, document_counter: @document_counter, **kwargs)
+    end)
+
+    # The primary metadata section
+    renders_one :metadata, (lambda do |static_content = nil, *args, component: nil, fields: nil, **kwargs|
+      next static_content if static_content.present?
+
+      Deprecation.warn('Pass the presenter to the DocumentComponent') if !fields && @presenter.nil?
+
+      component ||= Blacklight::DocumentMetadataComponent
+
+      component.new(*args, fields: fields || @presenter&.field_presenters || [], **kwargs)
+    end)
+
+    # Additional metadata sections
+    renders_many :metadata_sections
+
+    renders_one :thumbnail, (lambda do |image_options_or_static_content = {}, *args, component: nil, **kwargs|
+      next image_options_or_static_content if image_options_or_static_content.is_a? String
+
+      component ||= @presenter&.view_config&.thumbnail_component || Blacklight::Document::ThumbnailComponent
+      Deprecation.warn('Pass the presenter to the DocumentComponent') if !component && @presenter.nil?
+
+      component.new(*args, presenter: @presenter, counter: @counter, image_options: image_options_or_static_content, **kwargs)
+    end)
+
+    # A container for partials rendered using the view config partials configuration. Its use is discouraged, but necessary until
+    # the ecosystem fully adopts view components.
+    renders_many :partials
+
+    # Backwards compatibility
+    renders_one :actions
+
     with_collection_parameter :document
 
     # rubocop:disable Metrics/ParameterLists
@@ -23,10 +75,10 @@ module Blacklight
     # @param counter_offset [Number] with `document_counter`, the offset of the start of that collection counter to the overall result set
     # @param show [Boolean] are we showing only a single document (vs a list of search results); used for backwards-compatibility
     def initialize(document: nil, presenter: nil,
-                   id: nil, classes: [], component: :article, title_component: :h4,
-                   metadata_component: Blacklight::DocumentMetadataComponent,
+                   id: nil, classes: [], component: :article, title_component: nil,
+                   metadata_component: nil,
                    embed_component: nil,
-                   thumbnail_component: Blacklight::Document::ThumbnailComponent,
+                   thumbnail_component: nil,
                    counter: nil, document_counter: nil, counter_offset: 0,
                    show: false)
       if presenter.nil? && document.nil?
@@ -41,9 +93,14 @@ module Blacklight
       @id = id || ('document' if show)
       @classes = classes
 
+      Deprecation.warn('Passing embed_component is deprecated') if @embed_component.present?
       @embed_component = embed_component
-      @metadata_component = metadata_component
-      @thumbnail_component = thumbnail_component
+
+      Deprecation.warn('Passing metadata_component is deprecated') if @metadata_component.present?
+      @metadata_component = metadata_component || Blacklight::DocumentMetadataComponent
+
+      Deprecation.warn('Passing thumbnail_component is deprecated') if @thumbnail_component.present?
+      @thumbnail_component = thumbnail_component || Blacklight::Document::ThumbnailComponent
 
       @document_counter = document_counter
       @counter = counter
@@ -63,72 +120,15 @@ module Blacklight
       ].compact.flatten
     end
 
-    # Content for the document title area; should be an inline element
-    def title
-      return super if block_given?
-
-      @title || if show?
-                  content_tag('span', presenter.heading, itemprop: "name")
-                else
-                  @view_context.link_to_document @document, counter: @counter, itemprop: 'name'
-                end
-    end
-
-    # Content for the document actions area
-    def actions
-      return super if block_given?
-
-      return if @show
-
-      @actions ||
-        @view_context.render_index_doc_actions(@document, wrapping_class: "index-document-functions col-sm-3 col-lg-2")
-    end
-
-    # Content for the document thumbnail area
-    def thumbnail(image_options = {})
-      return super if block_given?
-      return @thumbnail if @thumbnail
-
-      return if @show
-
-      component = @thumbnail_component || presenter.view_config.thumbnail_component
-      render(component.new(presenter: presenter, counter: @counter, image_options: image_options))
-    end
-
-    # Content for the document metadata area
-    def metadata
-      return super if block_given?
-
-      @metadata || @view_context.render(@metadata_component.new(fields: presenter.field_presenters, show: show?))
-    end
-
-    # Content that goes before the document title (e.g. the counter)
-    def before_title
-      return super if block_given?
-
-      @before_title || counter
-    end
-
-    def embed
-      return @embed if @embed
-
-      component = @embed_component || presenter.view_config.embed_component
-
-      return unless component
-
-      @view_context.render(component.new(document: @document, presenter: presenter, document_counter: @document_counter))
+    def before_render
+      set_slot(:title) unless title
+      set_slot(:thumbnail, component: @thumbnail_component || presenter.view_config&.thumbnail_component) unless thumbnail || show?
+      set_slot(:metadata, component: @metadata_component, fields: presenter.field_presenters) unless metadata
+      set_slot(:embed, component: @embed_component || presenter.view_config&.embed_component) unless embed
     end
 
     private
 
-    def counter
-      return unless @counter
-
-      content_tag :span, class: 'document-counter' do
-        t('blacklight.search.documents.counter', counter: @counter)
-      end
-    end
-
     def presenter
       @presenter ||= @view_context.document_presenter(@document)
     end