blacklight 7.10.0 → 7.11.1

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 module Blacklight::ConfigurationHelperBehavior
+  extend Deprecation
+
   ##
   # Index fields to display for a type of document
   #
@@ -60,6 +62,7 @@ module Blacklight::ConfigurationHelperBehavior
 
     field_config.display_label('index')
   end
+  deprecation_deprecate :index_field_label
 
   ##
   # Look up the label for the show field
@@ -69,6 +72,7 @@ module Blacklight::ConfigurationHelperBehavior
 
     field_config.display_label('show')
   end
+  deprecation_deprecate :document_show_field_label
 
   ##
   # Look up the label for the facet field
@@ -183,6 +187,8 @@ module Blacklight::ConfigurationHelperBehavior
   ##
   # The available options for results per page, in the style of #options_for_select
   def per_page_options_for_select
+    return [] if blacklight_config.per_page.blank?
+
     blacklight_config.per_page.map do |count|
       [t(:'blacklight.search.per_page.label', count: count).html_safe, count]
     end

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -224,7 +224,7 @@ module Blacklight::FacetsHelperBehavior
   def render_facet_count(num, options = {})
     deprecated_method(:render_facet_count)
     classes = (options[:classes] || []) << "facet-count"
-    content_tag("span", t('blacklight.search.facets.count', number: number_with_delimiter(num)), class: classes)
+    tag.span(t('blacklight.search.facets.count', number: number_with_delimiter(num)), class: classes)
   end
 
   ##

data/app/helpers/blacklight/icon_helper_behavior.rb

@@ -11,8 +11,8 @@ module Blacklight::IconHelperBehavior
   # @return [String]
   def blacklight_icon(icon_name, options = {})
     Rails.cache.fetch([:blacklight_icons, icon_name, options]) do
-      icon = Blacklight::Icon.new(icon_name, options)
-      content_tag(:span, icon.svg.html_safe, icon.options)
+      icon = Blacklight::Icon.new(icon_name, **options)
+      tag.span(icon.svg.html_safe, icon.options)
     end
   end
 end

data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb

@@ -35,7 +35,7 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
                                  safe_join(value_list.collect do |value|
                                    render_filter_value(value, facet_field)
                                  end,
-                                           content_tag(:span, " #{t('blacklight.and')} ", class: 'filter-separator')))
+                                           tag.span(" #{t('blacklight.and')} ", class: 'filter-separator')))
     end, " \n ")
   end
 
@@ -43,9 +43,8 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
   # 'and'.   Pass in option :escape_value => false to pass in pre-rendered
   # html for value. key with escape_key if needed.
   def render_search_to_s_element(key, value, _options = {})
-    content_tag(:span,
-                render_filter_name(key) + content_tag(:span, value, class: 'filter-values'),
-                class: 'constraint')
+    tag.span(render_filter_name(key) + tag.span(value, class: 'filter-values'),
+             class: 'constraint')
   end
 
   ##
@@ -53,9 +52,8 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
   def render_filter_name name
     return "".html_safe if name.blank?
 
-    content_tag(:span,
-                t('blacklight.search.filters.label', label: name),
-                class: 'filter-name')
+    tag.span(t('blacklight.search.filters.label', label: name),
+             class: 'filter-name')
   end
 
   ##
@@ -63,8 +61,7 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
   def render_filter_value value, key = nil
     display_value = value
     display_value = facet_display_value(key, value) if key
-    content_tag(:span,
-                h(display_value),
-                class: 'filter-value')
+    tag.span(h(display_value),
+             class: 'filter-value')
   end
 end

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -47,7 +47,7 @@ module Blacklight::UrlHelperBehavior
   def link_to_previous_document(previous_document)
     link_opts = session_tracking_params(previous_document, search_session['counter'].to_i - 1).merge(class: "previous", rel: 'prev')
     link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), url_for_document(previous_document), link_opts do
-      content_tag :span, raw(t('views.pagination.previous')), class: 'previous'
+      tag.span raw(t('views.pagination.previous')), class: 'previous'
     end
   end
 
@@ -56,7 +56,7 @@ module Blacklight::UrlHelperBehavior
   def link_to_next_document(next_document)
     link_opts = session_tracking_params(next_document, search_session['counter'].to_i + 1).merge(class: "next", rel: 'next')
     link_to_unless next_document.nil?, raw(t('views.pagination.next')), url_for_document(next_document), link_opts do
-      content_tag :span, raw(t('views.pagination.next')), class: 'next'
+      tag.span raw(t('views.pagination.next')), class: 'next'
     end
   end
 
@@ -68,7 +68,7 @@ module Blacklight::UrlHelperBehavior
   #   session_tracking_params(SolrDocument.new(id: 123), 7)
   #   => { data: { :'context-href' => '/catalog/123/track?counter=7&search_id=999' } }
   def session_tracking_params document, counter
-    path = session_tracking_path(document, per_page: params.fetch(:per_page, search_session['per_page']), counter: counter, search_id: current_search_session.try(:id))
+    path = session_tracking_path(document, per_page: params.fetch(:per_page, search_session['per_page']), counter: counter, search_id: current_search_session.try(:id), document_id: document&.id)
 
     if path.nil?
       return {}

data/app/javascript/blacklight/search_context.js

@@ -59,7 +59,6 @@ Blacklight.handleSearchContextMethod = function(event) {
 
   event.preventDefault()
   event.stopPropagation()
-  event.stopImmediatePropagation()
 };
 
 Blacklight.onLoad(function() {

data/app/models/blacklight/icon.rb

@@ -3,6 +3,7 @@
 module Blacklight
   class Icon
     attr_reader :icon_name, :aria_hidden, :label, :role, :additional_options
+
     ##
     # @param [String, Symbol] icon_name
     # @param [Hash] options

data/app/models/concerns/blacklight/document.rb

@@ -105,6 +105,7 @@ module Blacklight::Document
   # extendability architecture
   module ClassMethods
     attr_writer :unique_key
+
     def unique_key
       @unique_key ||= 'id'
     end

data/app/models/record_mailer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 # Only works for documents with a #to_marc right now.
-class RecordMailer < ActionMailer::Base
+class RecordMailer < ApplicationMailer
   def email_record(documents, details, url_gen_params)
     title = begin
               documents.first.to_semantic_values[:title]

data/app/presenters/blacklight/document_presenter.rb

@@ -30,6 +30,12 @@ module Blacklight
       end
     end
 
+    def field_presenters
+      return to_enum(:field_presenters) unless block_given?
+
+      fields_to_render.each { |_, _, config| yield config }
+    end
+
     ##
     # Get the value of the document's "title" field, or a placeholder
     # value (if empty)
@@ -40,7 +46,7 @@ module Blacklight
 
       fields = Array.wrap(view_config.title_field) + [configuration.document_model.unique_key]
       f = fields.lazy.map { |field| field_config(field) }.detect { |field_config| field_presenter(field_config).any? }
-      field_value(f, except_operations: [Rendering::HelperMethod])
+      f ? field_value(f, except_operations: [Rendering::HelperMethod]) : ""
     end
 
     def display_type(base_name = nil, default: nil)

data/app/presenters/blacklight/field_presenter.rb

@@ -29,6 +29,7 @@ module Blacklight
     end
 
     attr_reader :view_context, :document, :field_config, :except_operations, :options
+    delegate :key, to: :field_config
 
     def render
       Rendering::Pipeline.new(values, field_config, document, view_context, pipeline_steps, options).render

data/app/presenters/blacklight/rendering/microdata.rb

@@ -13,7 +13,7 @@ module Blacklight
       private
 
       def itemprop(val, itemprop)
-        content_tag :span, val, itemprop: itemprop
+        tag.span val, itemprop: itemprop
       end
     end
   end

data/app/services/blacklight/field_retriever.rb

@@ -10,6 +10,7 @@ module Blacklight
     end
 
     attr_reader :document, :field_config
+
     delegate :field, to: :field_config
 
     # @return [Array]

data/app/services/blacklight/search_service.rb

@@ -88,6 +88,7 @@ module Blacklight
     private
 
     attr_reader :search_builder_class, :user_params
+
     delegate :repository, to: :blacklight_config
 
     ##

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

@@ -1,36 +1 @@
-<% if current_or_guest_user %>
-  <%-
-  # Note these two forms are pretty similar but for different :methods, classes, and labels.
-  # but it was simpler to leave them seperate instead of DRYing them, got confusing trying that.
-  # the data-doc-id attribute is used by our JS that converts to a checkbox/label.
-  -%>
-  <% if bookmarked? document %>
-    <%= form_tag(bookmark_path(document),
-                 method: :delete,
-                 class: "bookmark-toggle",
-                 data: {
-                   'doc-id' => document.id,
-                   present: t('blacklight.search.bookmarks.present'),
-                   absent: t('blacklight.search.bookmarks.absent'),
-                   inprogress: t('blacklight.search.bookmarks.inprogress')
-                }) do %>
-      <%= submit_tag(t('blacklight.bookmarks.remove.button'),
-                     id: "bookmark_toggle_#{document.id.to_s.parameterize}",
-                     class: "bookmark-remove btn btn-outline-secondary") %>
-    <% end %>
-  <% else %>
-    <%= form_tag(bookmark_path(document),
-                 method: :put,
-                 class: 'bookmark-toggle',
-                 data: {
-                   'doc-id' => document.id,
-                   present: t('blacklight.search.bookmarks.present'),
-                   absent: t('blacklight.search.bookmarks.absent'),
-                   inprogress: t('blacklight.search.bookmarks.inprogress')
-                 }) do %>
-       <%= submit_tag(t('blacklight.bookmarks.add.button'),
-                      id: "bookmark_toggle_#{document.id.to_s.parameterize}",
-                      class: "bookmark-add btn btn-outline-secondary") %>
-    <% end %>
-  <% end %>
-<% end %>
+<%= render Blacklight::Document::BookmarkComponent.new(document: document, bookmark_path: bookmark_path(document)) if current_or_guest_user %>

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

@@ -1,26 +1,5 @@
-<div class="modal-header">
-  <h1><%= t('blacklight.tools.citation') %></h1>
-  <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
-    <span aria-hidden="true">&times;</span>
-  </button>
-</div>
-<div class="modal-body">
-  <% @documents&.each do |document| %>
-    <h1 class="modal-title"><%= document_heading(document) %></h1>
+<%= render Blacklight::System::ModalComponent.new do |component| %>
+  <% component.with(:title, t('blacklight.tools.citation')) %>
 
-    <% if document.respond_to?(:export_as_mla_citation_txt) %>
-      <h2><%= t('blacklight.citation.mla') %></h2>
-      <%= document.send(:export_as_mla_citation_txt).html_safe %><br/><br/>
-    <% end %>
-
-    <% if document.respond_to?(:export_as_apa_citation_txt) %>
-      <h2><%= t('blacklight.citation.apa') %></h2>
-      <%= document.send(:export_as_apa_citation_txt).html_safe %><br/><br/>
-    <% end %>
-
-    <% if document.respond_to?(:export_as_chicago_citation_txt) %>
-      <h2><%= t('blacklight.citation.chicago') %></h2>
-      <%= document.send(:export_as_chicago_citation_txt).html_safe %>
-    <% end %>
-  <% end %>
-</div>
+  <%= render Blacklight::Document::CitationComponent.with_collection(@documents) if @documents.present? %>
+<% end %>

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

@@ -1,5 +1 @@
-<% if should_show_spellcheck_suggestions? @response %>
-  <div id="spell">
-    <h3 class="suggest"><em><%= t('blacklight.did_you_mean', :options => safe_join(@response.spelling.words.map { |word| link_to_query(word) }, " #{t('blacklight.or')} ")).html_safe %></em></h3>
-  </div>
-<% end %>
+<%= render(Blacklight::Response::SpellcheckComponent.new(response: @response)) %>

data/app/views/catalog/_document.atom.builder

@@ -19,9 +19,9 @@ xml.entry do
 
   with_format(:html) do
     xml.summary "type" => "html" do
-      xml.text! render_document_partial(document,
-      :index,
-      document_counter: document_counter)
+      xml.text! render_document_partials(document,
+                                         blacklight_config.view_config(:atom).summary_partials,
+                                         document_counter: document_counter)
     end
   end
 

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

@@ -1,6 +1,6 @@
 <% # container for a single doc -%>
-<article class="document <%= render_document_class document %> document-position-<%= document_counter%> " data-document-counter="<%= document_counter %>" itemscope itemtype="<%= document.itemtype %>">
-  <%= render_document_partials document,
-    blacklight_config.view_config(document_index_view_type).partials,
-    document_counter: document_counter %>
-</article>
+<%= 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_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_group.html.erb

@@ -1,19 +1,5 @@
-<% # main container for facets/limits menu -%>
-<% if has_facet_values? facet_field_names(groupname), @response %>
-<div id="facets<%= "-#{groupname}" unless groupname.nil? %>" class="facets sidenav facets-toggleable-md">
-
-  <div class="facets-header">
-    <h2 class="facets-heading">
-      <%= groupname.blank? ? t('blacklight.search.facets.title') : t("blacklight.search.facets-#{groupname}.title") %>
-    </h2>
-
-    <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#facet-panel<%= "-#{groupname}" unless groupname.nil? %>-collapse" aria-controls="facet-panel<%= "-#{groupname}" unless groupname.nil? %>-collapse" aria-expanded="false" aria-label="Toggle facets">
-      <span class="navbar-toggler-icon"></span>
-    </button>
-  </div>
-
-  <div id="facet-panel<%= "-#{groupname}" unless groupname.nil? %>-collapse" class="facets-collapse collapse">
-    <%= render_facet_partials facet_field_names(groupname), response: @response %>
-  </div>
-</div>
-<% end %>
+<%= render Blacklight::Response::FacetGroupComponent.new(
+  response: @response,
+  id: groupname,
+  fields: facet_field_names(groupname),
+  title: groupname.present? ? t("blacklight.search.facets-#{groupname}.title") : t('blacklight.search.facets.title')) %>

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

@@ -1,10 +1 @@
-<% doc_presenter = index_presenter(document) %>
-<%# default partial to display solr document fields in catalog index view -%>
-<dl class="document-metadata dl-invert row">
-
-  <% doc_presenter.fields_to_render.each do |field_name, field, field_presenter| -%>
-    <dt class="blacklight-<%= field_name.parameterize %> col-md-3"><%= render_index_field_label document, label: field_presenter.label, field: field_name %></dt>
-    <dd class="blacklight-<%= field_name.parameterize %> col-md-9"><%= field_presenter.render %></dd>
-  <% end -%>
-
-</dl>
+<%= render(Blacklight::DocumentMetadataComponent.new(fields: index_presenter(document).field_presenters)) %>

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

@@ -1,6 +1,6 @@
-<%# Call with a Blacklight::Solr::Response or any other kaminari-compatible collection
-    to render Blacklight's compact pagination info component:
-
-        <%= render :partial => "paginate_compact", :object => @response
--%>
-<%= paginate paginate_compact, :page_entries_info => page_entries_info(paginate_compact), :theme => :blacklight_compact %>
+<%= render Blacklight::Response::PaginationComponent.new(
+  response: paginate_compact,
+  theme: :blacklight_compact,
+  page_entries_info: page_entries_info(paginate_compact),
+  html: { aria: {} })
+%>

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

@@ -1,13 +1,10 @@
-<% if show_sort_and_per_page? and !blacklight_config.per_page.blank? %>
-<span class="sr-only"><%= t('blacklight.search.per_page.title') %></span>
-<div id="per_page-dropdown" class="per-page-dropdown btn-group">
-  <button type="button" class="btn btn-outline-secondary dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
-    <%= t(:'blacklight.search.per_page.button_label_html', :count => current_per_page) %> <span class="caret"></span>
-  </button>
-  <div class="dropdown-menu dropdown-menu-right" role="menu">
-    <%- per_page_options_for_select.each do |(label, count)| %>
-      <%= link_to(label, url_for(search_state.params_for_search(per_page: count)), class: 'dropdown-item', role: 'menuitem') %>
-    <%- end -%>
-  </div>
-</div>
+<% if show_sort_and_per_page? %>
+  <span class="sr-only"><%= t('blacklight.search.per_page.title') %></span>
+  <%= render(Blacklight::System::DropdownComponent.new(
+    param: :per_page,
+    choices: per_page_options_for_select,
+    id: 'per_page-dropdown',
+    search_state: search_state,
+    selected: current_per_page,
+    interpolation: :count)) %>
 <% end %>

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

@@ -1,12 +1 @@
-<% if @search_context[:prev] || @search_context[:next] %>
-  <div class='pagination-search-widgets'>
-  
-    <div class="page-links">
-      <%= link_to_previous_document @search_context[:prev] %> |
-
-      <%= item_page_entry_info %> |
-
-      <%= link_to_next_document @search_context[:next] %>
-    </div>
-  </div>
-<% end %>
+<%= render(Blacklight::SearchContextComponent.new(search_context: @search_context, search_session: search_session)) %>

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

@@ -1,9 +1,7 @@
 <% if show_pagination? and @response.total_pages > 1 %>
  <div class="row record-padding">
   <div class="col-md-12">
-    <nav class="pagination" role="region" aria-label="<%= t('views.pagination.aria.container_label') %>">
-      <%= paginate @response, :outer_window => 2, :theme => 'blacklight' %>
-    </nav>
+    <%= render Blacklight::Response::PaginationComponent.new(response: @response) %>
   </div>
  </div>
 <% end %>

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

@@ -1,27 +1,6 @@
-<%= form_tag search_action_url, method: :get, class: 'search-query-form', role: 'search', 'aria-label' => t('blacklight.search.form.submit') do %>
-  <%= render_hash_as_hidden_fields(search_state.params_for_search.except(:q, :search_field, :qt, :page, :utf8)) %>
-  <% if search_fields.length > 1 %>
-    <label for="search_field" class="sr-only"><%= t('blacklight.search.form.search_field.label') %></label>
-  <% end %>
-  <div class="input-group">
-    <% if search_fields.length > 1 %>
-        <%= select_tag(:search_field,
-                       options_for_select(search_fields, h(params[:search_field])),
-                       title: t('blacklight.search.form.search_field.title'),
-                       id: "search_field",
-                       class: "custom-select search-field") %>
-    <% elsif search_fields.length == 1 %>
-      <%= hidden_field_tag :search_field, search_fields.first.last %>
-    <% end %>
-
-    <label for="q" class="sr-only"><%= t('blacklight.search.form.search.label') %></label>
-    <%= text_field_tag :q, params[:q], placeholder: t('blacklight.search.form.search.placeholder'), class: "search-q q form-control rounded-#{search_fields.length > 1 ? '0' : 'left'}", id: "q", autocomplete: presenter.autocomplete_enabled? ? "off" : "", autofocus: presenter.autofocus?, data: { autocomplete_enabled: presenter.autocomplete_enabled?, autocomplete_path: search_action_path(action: :suggest) }  %>
-
-    <span class="input-group-append">
-      <button type="submit" class="btn btn-primary search-btn" id="search">
-        <span class="submit-search-text"><%= t('blacklight.search.form.submit') %></span>
-        <%= blacklight_icon :search, aria_hidden: true %>
-      </button>
-    </span>
-  </div>
-<% end %>
+<%= render(Blacklight::SearchBarComponent.new(
+      url: search_action_url,
+      params: search_state.params_for_search.except(:qt),
+      search_fields: search_fields,
+      presenter: presenter,
+      autocomplete_path: search_action_path(action: :suggest))) %>