blacklight 7.5.1 → 7.6.0

data/app/presenters/blacklight/show_presenter.rb

@@ -20,12 +20,12 @@ module Blacklight
     # @see #document_heading
     # @return [String]
     def html_title
-      return field_values(view_config.html_title_field) if view_config.html_title_field.is_a? Blacklight::Configuration::Field
+      return field_value(view_config.html_title_field) if view_config.html_title_field.is_a? Blacklight::Configuration::Field
 
       if view_config.html_title_field
         fields = Array.wrap(view_config.html_title_field) + [configuration.document_model.unique_key]
-        f = fields.lazy.map { |field| field_config(field) }.detect { |field_config| retrieve_values(field_config).any? }
-        field_values(f)
+        f = fields.lazy.map { |field| field_config(field) }.detect { |field_config| field_presenter(field_config).any? }
+        field_value(f)
       else
         heading
       end

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

@@ -2,7 +2,7 @@
   <div id="appliedParams" class="clearfix constraints-container">
     <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" %>
+    <%= render 'start_over' %>
     <span class="constraints-label sr-only"><%= t('blacklight.search.filters.title') %></span>
     <%= render_constraints(params) %>
   </div>

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

@@ -1,10 +1,10 @@
 <div class="prev_next_links btn-group">
   <%= link_to_previous_page @pagination, raw(t('views.pagination.previous')), params: search_state.to_h, param_name: blacklight_config.facet_paginator_class.request_keys[:page], class: 'btn btn-link', data: { blacklight_modal: "preserve" } do %>
-    <span class="disabled btn btn-disabled"><%= raw(t('views.pagination.previous')) %></span>
+    <%= content_tag :span, raw(t('views.pagination.previous')), class: 'disabled btn btn-disabled' %>
   <% end %>
 
   <%= link_to_next_page @pagination, raw(t('views.pagination.next')), params: search_state.to_h, param_name: blacklight_config.facet_paginator_class.request_keys[:page], class: 'btn btn-link',  data: { blacklight_modal: "preserve" } do %>
-    <span class="disabled btn  btn-disabled"><%= raw(t('views.pagination.next')) %></span>
+    <%= content_tag :span, raw(t('views.pagination.next')), class: 'disabled btn btn-disabled' %>
   <% end %>
 </div>
 

data/app/views/catalog/_field.json.jbuilder

@@ -4,7 +4,7 @@ json.set!(field_name) do
   json.id "#{document_url}##{field_name}"
   json.type 'document_value'
   json.attributes do
-    json.value doc_presenter.field_value(field)
-    json.label field.display_label(view_type)
+    json.value field_presenter.render
+    json.label field_presenter.label(view_type)
   end
 end

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

@@ -2,9 +2,9 @@
 <%# 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| -%>
-    <dt class="blacklight-<%= field_name.parameterize %> col-md-3"><%= render_index_field_label document, field: field_name %></dt>
-    <dd class="blacklight-<%= field_name.parameterize %> col-md-9"><%= doc_presenter.field_value field %></dd>
+  <% 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>

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

@@ -1,4 +1,4 @@
-<%= form_tag search_action_url, method: :get, class: 'search-query-form', role: 'search' do %>
+<%= 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>

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

@@ -1,8 +1,8 @@
 <% doc_presenter = show_presenter(document) %>
 <%# default partial to display solr document fields in catalog show view -%>
 <dl class="row dl-invert document-metadata">
-  <% doc_presenter.fields_to_render.each do |field_name, field| -%>
-    <dt class="blacklight-<%= field_name.parameterize %> col-md-3"><%= render_document_show_field_label document, field: field_name %></dt>
-    <dd class="blacklight-<%= field_name.parameterize %> col-md-9"><%= doc_presenter.field_value field %></dd>
+  <% doc_presenter.fields_to_render.each do |field_name, field, field_presenter| -%>
+    <dt class="blacklight-<%= field_name.parameterize %> col-md-3"><%= render_document_show_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>

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

@@ -1,4 +1,4 @@
-<div id="sortAndPerPage" class="sort-pagination d-md-flex justify-content-between">
+<div id="sortAndPerPage" class="sort-pagination d-md-flex justify-content-between" role="navigation" aria-label="<%= t('blacklight.search.per_page.aria_label')%>">
   <%= render partial: "paginate_compact", object: @response if show_pagination? %>
   <%= render_results_collection_tools wrapping_class: "search-widgets" %>
 </div>

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

@@ -0,0 +1 @@
+<%= link_to t('blacklight.search.start_over'), start_over_path, class: "catalog_startOverLink btn btn-primary" %>

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

@@ -1,4 +1,4 @@
-<% if presenter(document).thumbnail.exists? && tn = presenter(document).thumbnail.thumbnail_tag({}, counter: document_counter_with_offset(document_counter)) %>
+<% if presenter(document).thumbnail.exists? && tn = presenter(document).thumbnail.thumbnail_tag({ alt: '' }, 'aria-hidden': true, tabindex: -1, counter: document_counter_with_offset(document_counter)) %>
 <div class="document-thumbnail">
   <%= tn %>
 </div>

data/app/views/catalog/index.json.jbuilder

@@ -17,11 +17,12 @@ json.data do
     json.id document.id
     json.type doc_presenter.display_type.first
     json.attributes do
-      doc_presenter.fields_to_render.each do |field_name, field|
+      doc_presenter.fields_to_render.each do |field_name, field, field_presenter|
         json.partial! 'field', field: field,
                                field_name: field_name,
                                document_url: document_url,
                                doc_presenter: doc_presenter,
+                               field_presenter: field_presenter,
                                view_type: 'index'
       end
     end

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

@@ -1,6 +1,6 @@
 <% if current_search_session %>
   <div id="appliedParams" class="clearfix constraints-container">
-    <%= link_to t('blacklight.search.start_over'), start_over_path, class: "catalog_startOverLink btn btn-primary" %>
+    <%= render 'start_over' %>
     <%= link_back_to_catalog class: 'btn btn-outline-secondary' %>
   </div>
 <% end %>

data/app/views/catalog/show.json.jbuilder

@@ -11,11 +11,12 @@ json.data do
   json.id @document.id
   json.type doc_presenter.display_type.first
   json.attributes do
-    doc_presenter.fields_to_render.each do |field_name, field|
+    doc_presenter.fields_to_render.each do |field_name, field, field_presenter|
       json.partial! 'field', field: field,
                              field_name: field_name,
                              document_url: document_url,
                              doc_presenter: doc_presenter,
+                             field_presenter: field_presenter,
                              view_type: 'show'
     end
   end

data/app/views/layouts/blacklight/base.html.erb

@@ -17,11 +17,11 @@
     <%= content_for(:head) %>
   </head>
   <body class="<%= render_body_class %>">
-    <div id="skip-link">
+    <nav id="skip-link" role="navigation" aria-label="<%= t('blacklight.skip_links') %>">
       <%= link_to t('blacklight.skip_links.search_field'), '#search_field', class: 'element-invisible element-focusable rounded-bottom py-2 px-3', data: { turbolinks: 'false' } %>
       <%= link_to t('blacklight.skip_links.main_content'), '#main-container', class: 'element-invisible element-focusable rounded-bottom py-2 px-3', data: { turbolinks: 'false' } %>
       <%= content_for(:skip_links) %>
-    </div>
+    </nav>
     <%= render partial: 'shared/header_navbar' %>
 
   <main id="main-container" class="<%= container_classes %>" role="main" aria-label="<%= t('blacklight.main.aria.main_container') %>">

data/config/locales/blacklight.ar.yml

@@ -22,6 +22,7 @@ ar:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'تخطي الروابط'
       main_content: 'انتقل إلى المحتوى الرئيسي'
       search_field: 'انتقل إلى البحث'
       first_result: 'انتقل إلى النتيجة الأولى'
@@ -159,6 +160,7 @@ ar:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> لكل صفحة</span>'
         title: 'عدد النتائج المعروضة في الصفحة'
         submit: 'تحديث'
+        aria_label: 'الملاحة النتائج'
       sort:
         label: 'ترتيب حسب %{field}' # TODO: Remove during major release
         label_html: 'ترتيب <span class="d-none d-sm-inline"> حسب %{field}</span>'

data/config/locales/blacklight.de.yml

@@ -22,6 +22,7 @@ de:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'Links überspringen'
       main_content: 'Zum Hauptinhalt gehen'
       search_field: 'Gehen Sie zur Suchleiste'
       first_result: 'Gehe zum ersten Suchergebnis'
@@ -151,6 +152,7 @@ de:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> pro Seite</span>'
         title: 'Anzahl der Ergebnisse, die pro Seite angezeigt werden'
         submit: 'Aktualisieren'
+        aria_label: 'Ergebnisnavigation'
       sort:
         label: 'Ordnen nach %{field}' # TODO: Remove during major release
         label_html: 'Ordnen<span class="d-none d-sm-inline"> nach %{field}</span>'

data/config/locales/blacklight.en.yml

@@ -22,6 +22,7 @@ en:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'Skip links'
       main_content: 'Skip to main content'
       search_field: 'Skip to search'
       first_result: 'Skip to first result'
@@ -151,6 +152,7 @@ en:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> per page</span>'
         title: 'Number of results to display per page'
         submit: 'Update'
+        aria_label: 'Results navigation'
       sort:
         label: 'Sort by %{field}' # TODO: Remove during major release
         label_html: 'Sort<span class="d-none d-sm-inline"> by %{field}</span>'

data/config/locales/blacklight.es.yml

@@ -22,6 +22,7 @@ es:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'Saltar enlaces'
       main_content: 'Saltar al contenido principal'
       search_field: 'Salta a la búsqueda'
       first_result: 'Salta al primer resultado de búsqueda'
@@ -151,6 +152,7 @@ es:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> por página</span>'
         title: 'El número de resultados a mostrar por página'
         submit: 'Actualización'
+        aria_label: 'Navegación de resultados'
       sort:
         label: 'Ordenar por %{field}' # TODO: Remove during major release
         label_html: 'Ordenar<span class="d-none d-sm-inline"> por %{field}</span>'

data/config/locales/blacklight.fr.yml

@@ -22,6 +22,7 @@ fr:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'Sauter les liens'
       main_content: 'Aller au contenu principal'
       search_field: 'Aller à la recherche'
       first_result: 'Aller au premier résultat de recherche'
@@ -154,6 +155,7 @@ fr:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> par page</span>'
         title: 'Nombre de résultats à afficher par page'
         submit: 'mettre à jour'
+        aria_label: 'Navigation dans les résultats'
       sort:
         label: 'Trier par %{field}' # TODO: Remove during major release
         label_html: 'Trier<span class="d-none d-sm-inline"> par %{field}</span>'

data/config/locales/blacklight.hu.yml

@@ -22,6 +22,7 @@ hu:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'átugrani a linkeket'
       main_content: 'Ugrás a tartalomra'
       search_field: 'Ugrás a keresésre'
       first_result: 'Ugrás az első keresési eredményre'
@@ -151,6 +152,7 @@ hu:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> oldalanként</span>'
         title: 'Az eredmények száma oldalanként'
         submit: 'Frissítés'
+        aria_label: 'Eredmények navigáció'
       sort:
         label: 'Rendezés %{field}' # TODO: Remove during major release
         label_html: 'Rendezés<span class="d-none d-sm-inline"> %{field}</span>'

data/config/locales/blacklight.it.yml

@@ -22,6 +22,7 @@ it:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'Saltare i collegamenti'
       main_content: 'Vai al contenuto principale'
       search_field: 'Vai alla ricerca'
       first_result: 'Vai al primo risultato di ricerca'
@@ -151,6 +152,7 @@ it:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> per pagina</span>'
         title: 'Risultati per pagina'
         submit: 'Aggiorna'
+        aria_label: 'Navigazione dei risultati'
       sort:
         label: 'Ordina per %{field}' # TODO: Remove during major release
         label_html: 'Ordina<span class="d-none d-sm-inline"> per %{field}</span>'

data/config/locales/blacklight.nl.yml

@@ -22,6 +22,7 @@ nl:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'links overslaan'
       main_content: 'Ga naar de hoofdinhoud'
       search_field: 'Ga naar de zoekopdracht'
       first_result: 'Ga naar het eerste zoekresultaat'
@@ -151,6 +152,7 @@ nl:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> per pagina</span>'
         title: 'Toon aantal zoekresultaten per pagina'
         submit: 'Update'
+        aria_label: 'Resultaten navigatie'
       sort:
         label: 'Sorteer op %{field}' # TODO: Remove during major release
         label_html: 'Sorteer<span class="d-none d-sm-inline"> op %{field}</span>'

data/config/locales/blacklight.pt-BR.yml

@@ -23,6 +23,7 @@ pt-BR:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'pular links'
       main_content: 'Ir para o conteúdo principal'
       search_field: 'Ir para a pesquisa'
       first_result: 'Ir para o primeiro resultado da pesquisa'
@@ -152,6 +153,7 @@ pt-BR:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> por página</span>'
         title: 'Número de resultados para mostrar por página'
         submit: 'Atualizar'
+        aria_label: 'Navegação de resultados'
       sort:
         label: 'Ordenar por %{field}' # TODO: Remove during major release
         label_html: 'Ordenar<span class="d-none d-sm-inline"> por %{field}</span>'

data/config/locales/blacklight.sq.yml

@@ -22,6 +22,7 @@ sq:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'lidhjet e kaloni'
       main_content: 'Shkoni tek përmbajtja kryesore'
       search_field: 'Shkoni në kërkim'
       first_result: 'Shkoni te rezultati i parë i kërkimit'
@@ -151,6 +152,7 @@ sq:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> për faqe</span>'
         title: 'Numri i rezultateve që do të shfaqen për faqe'
         submit: 'Përditëso'
+        aria_label: 'Rezultatet e lundrimit'
       sort:
         label: 'Klasifikoj sipas %{field}' # TODO: Remove during major release
         label_html: 'Klasifikoj<span class="d-none d-sm-inline"> sipas %{field}</span>'

data/config/locales/blacklight.zh.yml

@@ -22,6 +22,7 @@ zh:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: '跳过链接'
       main_content: '转到主要内容'
       search_field: '转到搜索'
       first_result: '转到第一个搜索结果'
@@ -151,6 +152,7 @@ zh:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> 每页</span>'
         title: '每页显示结果数'
         submit: '更新'
+        aria_label: '结果导航'
       sort:
         label: '按 %{field} 排序' # TODO: Remove during major release
         label_html: '<span class="d-none d-sm-inline">按 %{field} </span>排序'

data/lib/blacklight/configuration/field.rb

@@ -19,12 +19,13 @@ module Blacklight
       raise ArgumentError, "Must supply a field name" if self.field.nil?
     end
 
-    def display_label(context = nil)
+    def display_label(context = nil, **options)
       field_label(
         (:"blacklight.search.fields.#{context}.#{key}" if context),
         :"blacklight.search.fields.#{key}",
         label,
-        default_label
+        default_label,
+        **options
       )
     end
 
@@ -50,10 +51,10 @@ module Blacklight
     #     before falling  back to the label
     #   @param [Symbol] any number of additional keys
     #   @param [Symbol] ...
-    def field_label *i18n_keys
+    def field_label *i18n_keys, **options
       first, *rest = i18n_keys.compact
 
-      I18n.t(first, default: rest)
+      I18n.t(first, default: rest, **options)
     end
   end
 end

data/spec/helpers/blacklight_helper_spec.rb

@@ -208,6 +208,23 @@ RSpec.describe BlacklightHelper do
     end
   end
 
+  describe '#render_index_field_label' do
+    let(:doc) { SolrDocument.new({}) }
+
+    before do
+      allow(helper).to receive_messages(document_index_view_type: :current_view)
+    end
+
+    it 'accepts an explicit field label' do
+      expect(helper.render_index_field_label(doc, field: 'xyz', label: 'some label')).to eq 'some label:'
+    end
+
+    it 'calculates the appropriate field label for a field' do
+      allow(helper).to receive(:blacklight_config).and_return(CatalogController.blacklight_config)
+      expect(helper.render_index_field_label(doc, field: 'xyz')).to eq 'Xyz:'
+    end
+  end
+
   describe "render_grouped_response?" do
     it "checks if the response ivar contains grouped data" do
       assign(:response, instance_double(Blacklight::Solr::Response, grouped?: true))

data/spec/helpers/catalog_helper_spec.rb

@@ -39,13 +39,6 @@ RSpec.describe CatalogHelper do
       expect(html).to be_html_safe
     end
 
-    it "with an empty page of results" do
-      @response = double(limit_value: -1)
-
-      html = page_entries_info(@response)
-      expect(html).to be_blank
-    end
-
     context "when response.entry_name is nil" do
       it "does not raise an error" do
         collection = mock_response total: 10

data/spec/presenters/blacklight/document_presenter_spec.rb

@@ -1,81 +1,41 @@
 # frozen_string_literal: true
 
 RSpec.describe Blacklight::DocumentPresenter do
-  let(:presenter) { described_class.new(doc, view_context) }
-  let(:doc) { instance_double(SolrDocument) }
-  let(:blacklight_config) { instance_double(Blacklight::Configuration) }
-  let(:view_context) { double('View context', should_render_field?: true, blacklight_config: blacklight_config) }
+  subject(:presenter) { described_class.new(doc, request_context) }
 
-  describe '#fields_to_render' do
-    subject { presenter.fields_to_render }
-
-    let(:field_config) { double(field: 'asdf') }
-
-    context 'when all of the fields have values' do
-      before do
-        allow(presenter).to receive_messages(fields: { 'title' => field_config },
-                                             render_field?: true,
-                                             has_value?: true)
-      end
+  let(:doc) { SolrDocument.new('asdf' => 'asdf') }
+  let(:blacklight_config) { Blacklight::Configuration.new }
+  let(:request_context) { double('View context', should_render_field?: true, blacklight_config: blacklight_config) }
+  let(:controller) { double }
+  let(:params) { {} }
+  let(:search_state) { Blacklight::SearchState.new(params, blacklight_config, controller) }
 
-      it { is_expected.to eq('title' => field_config) }
-    end
+  before do
+    allow(request_context).to receive(:search_state).and_return(search_state)
   end
 
-  describe '#render_field?' do
-    subject { presenter.send(:render_field?, field_config) }
-
-    let(:field_config) { double('field config', if: true, unless: false) }
-
-    before do
-      allow(presenter).to receive_messages(document_has_value?: true)
-    end
-
-    it { is_expected.to be true }
+  describe '#fields_to_render' do
+    subject { presenter.fields_to_render.to_a }
 
-    context 'when the view context says not to render the field' do
-      let(:view_context) { double('View context', should_render_field?: false, blacklight_config: blacklight_config) }
+    let(:field_config) { Blacklight::Configuration::Field.new(field: 'asdf') }
 
+    context 'when all of the fields have values' do
       before do
-        allow(field_config).to receive_messages(if: false)
+        allow(presenter).to receive_messages(fields: { 'title' => field_config })
       end
 
-      it { is_expected.to be false }
+      it { is_expected.to include(['title', field_config, an_instance_of(Blacklight::FieldPresenter)]) }
     end
   end
 
-  describe '#has_value?' do
-    subject { presenter.send(:has_value?, field_config) }
-
-    context 'when the document has the field value' do
-      let(:field_config) { double(field: 'asdf', highlight: false, accessor: nil, default: nil, values: nil) }
-
-      before do
-        allow(doc).to receive(:fetch).with('asdf', nil).and_return(['value'])
-      end
-
-      it { is_expected.to be true }
-    end
-
-    context 'when the document has a highlight field value' do
-      let(:field_config) { double(field: 'asdf', highlight: true) }
-
-      before do
-        allow(doc).to receive(:has_highlight_field?).with('asdf').and_return(true)
-        allow(doc).to receive(:highlight_field).with('asdf').and_return(['value'])
-      end
-
-      it { is_expected.to be true }
-    end
-
-    context 'when the field is a model accessor' do
-      let(:field_config) { double(field: 'asdf', highlight: false, accessor: true) }
-
-      before do
-        allow(doc).to receive(:send).with('asdf').and_return(['value'])
-      end
+  describe '#field_value' do
+    let(:field_presenter) { instance_double(Blacklight::FieldPresenter, render: 'xyz') }
+    let(:field_config) { instance_double(Blacklight::Configuration::Field) }
+    let(:options) { { a: 1 } }
 
-      it { is_expected.to be true }
+    it 'calls the field presenter' do
+      allow(Blacklight::FieldPresenter).to receive(:new).with(request_context, doc, field_config, options).and_return(field_presenter)
+      expect(presenter.field_value(field_config, options)).to eq 'xyz'
     end
   end
 end