blacklight 7.11.1 → 7.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74d6e5485343fa8fc02b71d94e374d2f2d0a49f05e9bbf2e2226fe02088213f4
-  data.tar.gz: d1894865278720fc03af712e6cb424eaa1f3c30aa0f71666be7a301052663562
+  metadata.gz: 795afb3fdb4a13aa033d1b37180537e51ebfd53ab8f0ef894d05b6370b1c1238
+  data.tar.gz: 003ccd0c42c44636d463df31c141a7b9b6ab1276bab6d771d1637d2eb7ff17fc
 SHA512:
-  metadata.gz: 9d40718c50283de79a47a70e77c3cdd5e13a92edf1eb657d749c96f25fd473523a09f4d68e594adf3d2f5cb3a6e249d6ebd61bf7ec349a4bc97ffad8b213fc5e
-  data.tar.gz: d3732c39e9672c23943b01aef361d29fc7cfb3f1f9d6e243770b72cc6ac61677cee2f478ae8cf50120d51d3978eda85492d4f386a15820b04d6350bfac53219c
+  metadata.gz: 1e9cdd317ae4535217bc98930c09095ca8aaebe01124863b6a507a2c9bfbd4851a18d72f139bbb6c2f152094e1cb3cf3462eea26747f3212dc484c24603f6ec4
+  data.tar.gz: a7f142dbaaabff9a9477d116ccd283ab67b2e72fb6d5f0c0482b495ed57f69486aa73f3ef6f67b31f0d00316d1dfb0b61fffaae08ebd1208aebae18a495c9746

data/.rubocop.yml

@@ -29,6 +29,7 @@ Layout/IndentationConsistency:
 Metrics/BlockLength:
   Exclude:
     - "app/views/catalog/index.json.jbuilder"
+    - "app/views/catalog/_document.atom.builder"
     - "lib/railties/blacklight.rake"
     - "tasks/blacklight.rake"
     - "spec/**/*"
@@ -42,6 +43,10 @@ Layout/LineLength:
   Exclude:
     - 'spec/**/*'
 
+Metrics/ModuleLength:
+  Exclude:
+    - 'app/controllers/concerns/blacklight/catalog.rb'
+
 Naming/HeredocDelimiterNaming:
   Enabled: false
 
@@ -57,6 +62,9 @@ Naming/PredicateName:
 Rails:
   Enabled: true
 
+Rails/ApplicationMailer:
+  Enabled: false
+
 # https://github.com/rubocop-hq/rubocop/issues/6439
 Style/AccessModifierDeclarations:
   Enabled: false

data/.solr_wrapper.yml

@@ -0,0 +1,5 @@
+# Place any default configuration for solr_wrapper here
+# port: 8983
+collection:
+  dir: lib/generators/blacklight/templates/solr/conf
+  name: blacklight-core

data/VERSION

@@ -1 +1 @@
-7.11.1
+7.12.0

data/app/builders/blacklight/action_builder.rb

@@ -4,6 +4,12 @@ module Blacklight
   # Dynamically creates methods on the given controller (typically CatalogController)
   # for handling configured show tools
   class ActionBuilder
+    # @param [Object] klass
+    # @param [String] name
+    # @param [Hash] opts
+    # @option opts [Symbol] callback
+    # @option opts [Symbol] validator
+    # @option opts [Boolean] define_method
     def initialize(klass, name, opts)
       @klass = klass
       @name = name

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

@@ -0,0 +1,5 @@
+<%= render(@layout.new(
+      classes: (Array(@classes) + ["filter-#{@facet_item_presenter.facet_config.key.parameterize}"]).join(' '),
+      label: @facet_item_presenter.field_label,
+      value: @facet_item_presenter.label,
+      remove_path: @facet_item_presenter.remove_href)) %>

data/app/components/blacklight/constraint_component.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class ConstraintComponent < ::ViewComponent::Base
+    with_collection_parameter :facet_item_presenter
+
+    def initialize(facet_item_presenter:, classes: 'filter', layout: Blacklight::ConstraintLayoutComponent)
+      @facet_item_presenter = facet_item_presenter
+      @classes = classes
+      @layout = layout
+    end
+  end
+end

data/app/components/blacklight/constraint_layout_component.rb

@@ -2,11 +2,12 @@
 
 module Blacklight
   class ConstraintLayoutComponent < ::ViewComponent::Base
-    def initialize(value:, label: nil, remove_path: nil, classes: nil)
+    def initialize(value:, label: nil, remove_path: nil, classes: nil, search_state: nil)
       @value = value
       @label = label
       @remove_path = remove_path
       @classes = Array(classes).join(' ')
+      @search_state = search_state
     end
 
     def render?

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

@@ -0,0 +1,10 @@
+<%= content_tag :div, id: @id, class: @classes do %>
+  <h2 class="sr-only"><%= t('blacklight.search.search_constraints_header') %></h2>
+
+  <%= 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 %>
+<% end %>

data/app/components/blacklight/constraints_component.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class ConstraintsComponent < ::ViewComponent::Base
+    with_content_areas :query_constraints_area, :facet_constraints_area, :additional_constraints
+
+    def initialize(search_state:,
+                   id: 'appliedParams', classes: 'clearfix constraints-container',
+                   query_constraint_component: Blacklight::ConstraintLayoutComponent, facet_constraint_component: Blacklight::ConstraintComponent)
+      @search_state = search_state
+      @query_constraint_component = query_constraint_component
+      @facet_constraint_component = facet_constraint_component
+      @id = id
+      @classes = classes
+    end
+
+    def query_constraints
+      return if @search_state.query_param.blank?
+
+      Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
+        @view_context.render(
+          @query_constraint_component.new(
+            search_state: @search_state,
+            value: @search_state.query_param,
+            label: @view_context.constraint_query_label(@search_state.params),
+            remove_path: @view_context.remove_constraint_url(@search_state),
+            classes: 'query'
+          )
+        )
+      end
+    end
+
+    def facet_constraints
+      @view_context.render(@facet_constraint_component.with_collection(facet_item_presenters))
+    end
+
+    def start_over_path
+      Deprecation.silence(Blacklight::UrlHelperBehavior) do
+        @view_context.start_over_path
+      end
+    end
+
+    def render?
+      Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) { @view_context.query_has_constraints? }
+    end
+
+    private
+
+    def facet_item_presenters
+      @search_state.filter_params.each_pair.flat_map do |facet, values|
+        facet_config = @view_context.facet_configuration_for_field(facet)
+
+        Array(values).map do |val|
+          next if val.blank? # skip empty string
+
+          facet_item_presenter(facet_config, val, facet)
+        end
+      end
+    end
+
+    def facet_item_presenter(facet_config, facet_item, facet_field)
+      Blacklight::FacetItemPresenter.new(facet_item, facet_config, @view_context, facet_field)
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+<% if using_default_document_action? %>
+  <%= link_to label,
+              url,
+              id: @id,
+              class: 'nav-link',
+              data: {}.merge(({ blacklight_modal: "trigger" } if @action.modal != false) || {}) %>
+<% else %>
+  <%= @view_context.render(partial: @action.partial || @action.name.to_s, locals: { document: @document, document_action_config: @action }.merge(@options)) %>
+<% end %>

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Document
+    # Render a bookmark widget to bookmark / unbookmark a document
+    class ActionComponent < ::ViewComponent::Base
+      with_collection_parameter :action
+
+      # @param [Blacklight::Document] document
+      def initialize(document:, action:, options: {}, url_opts: {}, id: nil)
+        @document = document
+        @action = action
+        @options = options
+        @url_opts = url_opts
+        @id = id || @action.fetch(:id, "#{@action.name}Link")
+      end
+
+      def using_default_document_action?
+        return true if @action.component
+        return false unless @action.partial == 'document_action'
+
+        @view_context.partial_from_blacklight?(@action.partial)
+      end
+
+      def label
+        Deprecation.silence(Blacklight::ComponentHelperBehavior) do
+          @view_context.document_action_label(@action.name, @action)
+        end
+      end
+
+      def url
+        Deprecation.silence(Blacklight::ComponentHelperBehavior) do
+          @view_context.document_action_path(@action, @url_opts.merge(({ id: @document } if @document) || {}))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+<%= 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)) } %>
+
+    <% if @wrapping_tag %>
+      <%= content_tag(@wrapping_tag, class: Array(@wrapping_classes) + [action.key]) do %>
+        <%= result %>
+      <% end %>
+    <% else %>
+      <%= result %>
+    <% end %>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Document
+    # Render a bookmark widget to bookmark / unbookmark a document
+    class ActionsComponent < ::ViewComponent::Base
+      # @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)
+        @document = document
+        @actions = actions
+        @tag = tag
+        @classes = classes
+        @options = options
+        @url_opts = url_opts
+        @wrapping_tag = wrapping_tag
+        @wrapping_classes = wrapping_classes
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def render?
+        @actions.any?
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 <%-
 # the data-doc-id attribute is used by our JS that converts to a checkbox/label.
 -%>
-<%= form_tag(@bookmark_path,
+<%= form_tag(bookmark_path,
              method:  bookmarked? ? :delete : :put,
              class: "bookmark-toggle",
              data: {

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

@@ -2,7 +2,11 @@
 
 module Blacklight
   module Document
+    # Render a bookmark widget to bookmark / unbookmark a document
     class BookmarkComponent < ::ViewComponent::Base
+      # @param [Blacklight::Document] document
+      # @param [Boolean] checked
+      # @param [Object] bookmark_path the rails route to use for bookmarks
       def initialize(document:, checked: nil, bookmark_path: nil)
         @document = document
         @checked = checked
@@ -14,6 +18,10 @@ module Blacklight
 
         @view_context.bookmarked? @document
       end
+
+      def bookmark_path
+        @bookmark_path || @view_context.bookmark_path(@document)
+      end
     end
   end
 end

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

@@ -1,9 +1,11 @@
 <div>
   <h1 class="modal-title"><%= title %></h1>
 
-  <%= @formats.each do |i18n_key, citation_method| %>
+  <% @formats.each do |i18n_key, citation_method| %>
     <h2><%= t(i18n_key) %></h2>
     <%= @document.send(citation_method).html_safe %>
-    <% unless @formats.keys.last === i18n_key %><br/><br/><% end %>
+    <% unless @formats.keys.last === i18n_key %>
+      <br/><br/>
+    <% end %>
   <% end %>
 </div>

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

@@ -2,6 +2,7 @@
 
 module Blacklight
   module Document
+    # Render citations for the document
     class CitationComponent < ::ViewComponent::Base
       DEFAULT_FORMATS = {
         'blacklight.citation.mla': :export_as_mla_citation_txt,
@@ -11,13 +12,19 @@ module Blacklight
 
       with_collection_parameter :document
 
+      # @param [Blacklight::Document] document
+      # @param [Hash<String => Symbol>] map of citation format names (suspiciously, i18n keys
+      #   for them) to document methods that return the formatted citation.
       def initialize(document:, formats: DEFAULT_FORMATS)
         @document = document
         @formats = formats.select { |_k, v| @document.respond_to?(v) }
       end
 
+      # @return [String]
       def title
-        @view_context.document_heading(@document)
+        Deprecation.silence(Blacklight::BlacklightHelperBehavior) do
+          @view_context.document_heading(@document)
+        end
       end
     end
   end

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

@@ -0,0 +1,9 @@
+<div class="group">
+  <h2 class="group-key"><%= @group.key %></h2>
+  <div class="grouped-documents">
+    <%= grouped_documents %>
+  </div>
+  <%- if @group_limit > 0 && @group.total > @group_limit %>
+    <%= @view_context.link_to t('blacklight.search.group.more'), add_group_facet_params_and_redirect(@group), class: 'more-in-group' %>
+  <%- end %>
+</div>

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Document
+    # Render the 'more like this' results from the response
+    class GroupComponent < ::ViewComponent::Base
+      with_collection_parameter :group
+
+      # @param [Blacklight::Document] document
+      def initialize(group:, group_limit: -1)
+        @group = group
+        @group_limit = group_limit
+      end
+
+      def grouped_documents
+        @view_context.render_document_index @group.docs
+      end
+
+      def add_group_facet_params_and_redirect(group)
+        Deprecation.silence(Blacklight::UrlHelperBehavior) do
+          @view_context.search_action_path(@view_context.add_group_facet_params_and_redirect(group))
+        end
+      end
+    end
+  end
+end

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

@@ -2,9 +2,11 @@
 
 module Blacklight
   module Document
+    # Render the 'more like this' results from the response
     class MoreLikeThisComponent < ::ViewComponent::Base
       with_collection_parameter :document
 
+      # @param [Blacklight::Document] document
       def initialize(document:)
         @document = document
       end

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

@@ -0,0 +1,12 @@
+<% value = @use_thumbnail_tag ? @presenter.thumbnail.thumbnail_tag({ alt: '' }, 'aria-hidden': true, tabindex: -1, counter: @counter) : @presenter.thumbnail.render({ alt: '' }) %>
+
+<% if value %>
+  <div class="document-thumbnail">
+    <% if @use_thumbnail_tag %>
+      <% warn_about_deprecated_behavior %>
+      <%= value %>
+    <% else %>
+      <%= @view_context.link_to_document(@presenter.document, value, 'aria-hidden': true, tabindex: -1, counter: @counter) %>
+    <% end %>
+  </div>
+<% end %>

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Document
+    # Render the thumbnail for the document
+    class ThumbnailComponent < ::ViewComponent::Base
+      with_collection_parameter :presenter
+
+      # @param [Blacklight::DocumentPresenter] presenter
+      def initialize(presenter:, counter:)
+        @presenter = presenter
+        @counter = counter
+        @use_thumbnail_tag = @presenter.thumbnail != Blacklight::ThumbnailPresenter
+      end
+
+      def render?
+        @presenter.thumbnail.exists?
+      end
+
+      def warn_about_deprecated_behavior
+        Deprecation.warn(Blacklight::Document::ThumbnailComponent, 'Detected as custom thumbnail presenter; make sure it has a #render method that returns just the thumbnail image tag')
+      end
+    end
+  end
+end

data/app/components/blacklight/document_component.rb

@@ -18,9 +18,15 @@ module Blacklight
     # @param component [Symbol, String] HTML tag type to use for the root element
     # @param title_component [Symbol, String] HTML tag type to use for the title element
     # @param metadata_component [Blacklight::DocumentMetadataComponent]
-    # @param counter [Number, nil]
+    # @param counter [Number, nil] a pre-computed counter for the position of this document in a search result set
+    # @param document_counter [Number, nil] alternatively, the document's position in a collection and,
+    # @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, counter: nil, show: false)
+    def initialize(document: nil, presenter: nil,
+                   id: nil, classes: [], component: :article, title_component: :h4,
+                   metadata_component: Blacklight::DocumentMetadataComponent,
+                   counter: nil, document_counter: nil, counter_offset: 0,
+                   show: false)
       if presenter.nil? && document.nil?
         raise ArgumentError, 'missing keyword: :document or :presenter'
       end
@@ -36,6 +42,7 @@ module Blacklight
       @metadata_component = metadata_component
 
       @counter = counter
+      @counter ||= document_counter + 1 + counter_offset if document_counter.present?
 
       @show = show
     end
@@ -53,44 +60,44 @@ module Blacklight
 
     # Content for the document title area; should be an inline element
     def title
-      @title || begin
-        if show?
-          content_tag('span', presenter.heading, itemprop: "name")
-        else
-          @view_context.link_to_document @document, counter: @counter, itemprop: 'name'
-        end
-      end
+      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 || begin
-        @view_context.render_index_doc_actions @document, wrapping_class: "index-document-functions col-sm-3 col-lg-2"
-      end
+      @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
+      return super if block_given?
       return if @show
 
-      @thumbnail || begin
-        return unless presenter.thumbnail.exists?
-
-        content_tag :div, class: "document-thumbnail" do
-          presenter.thumbnail.thumbnail_tag({ alt: '' }, 'aria-hidden': true, tabindex: -1, counter: @counter)
-        end
-      end
+      @thumbnail || render(Blacklight::Document::ThumbnailComponent.new(presenter: presenter, counter: @counter))
     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
 
@@ -105,13 +112,7 @@ module Blacklight
     end
 
     def presenter
-      @presenter ||= begin
-        if show?
-          @view_context.presenter(@document)
-        else
-          @view_context.index_presenter(@document)
-        end
-      end
+      @presenter ||= @view_context.document_presenter(@document)
     end
 
     def show?