blacklight 6.20.0 → 7.3.0

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

@@ -1,13 +1,11 @@
-<div id="sidebar" class="<%= sidebar_classes %>">
+<% content_for(:sidebar) do %>
   <%= render 'search_sidebar' %>
-</div>
+<% end %>
 
-<div id="content" class="<%= main_content_classes %>">
-  <% unless has_search_parameters? %>
-    <%# if there are no input/search related params, display the "home" partial -%>
-    <%= render 'home' %>
-    <%= render 'shared/sitelinks_search_box' %>
-  <% else %>
-    <%= render 'search_results' %>
-  <% end %>
-</div>
+<% unless has_search_parameters? %>
+  <%# if there are no input/search related params, display the "home" partial -%>
+  <%= render 'home' %>
+  <%= render 'shared/sitelinks_search_box' %>
+<% else %>
+  <%= render 'search_results' %>
+<% end %>

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

@@ -1,5 +1,86 @@
-json.response do
-  json.docs @presenter.documents
-  json.facets @presenter.search_facets_as_json
+# frozen_string_literal: true
+json.links do
+  json.self url_for(search_state.to_h.merge(only_path: false))
+  json.prev url_for(search_state.to_h.merge(only_path: false, page: @response.prev_page.to_s)) if @response.prev_page
+  json.next url_for(search_state.to_h.merge(only_path: false, page: @response.next_page.to_s)) if @response.next_page
+  json.last url_for(search_state.to_h.merge(only_path: false, page: @response.total_pages.to_s))
+end
+
+json.meta do
   json.pages @presenter.pagination_info
 end
+
+json.data do
+  json.array! @presenter.documents do |document|
+    document_url = polymorphic_url(url_for_document(document))
+    json.id document.id
+    json.type document[blacklight_config.view_config(:index).display_type_field]
+    json.attributes do
+      doc_presenter = index_presenter(document)
+
+      doc_presenter.fields_to_render.each do |field_name, field|
+        json.partial! 'field', field: field,
+                               field_name: field_name,
+                               document_url: document_url,
+                               doc_presenter: doc_presenter
+      end
+    end
+
+    json.links do
+      json.self document_url
+    end
+  end
+end
+
+json.included do
+  json.array! @presenter.search_facets do |facet|
+    json.type 'facet'
+    json.id facet.name
+    json.attributes do
+      facet_config = facet_configuration_for_field(facet.name)
+      json.label facet_field_label(facet_config.key)
+      json.items do
+        json.array! facet.items do |item|
+          json.id
+          json.attributes do
+            json.label item.label
+            json.value item.value
+            json.hits item.hits
+          end
+          json.links do
+            if facet_in_params?(facet.name, item.value)
+              json.remove search_action_path(search_state.remove_facet_params(facet.name, item.value))
+            else
+              json.self path_for_facet(facet.name, item.value, only_path: false)
+            end
+          end
+        end
+      end
+    end
+    json.links do
+      json.self search_facet_path(id: facet.name, only_path: false)
+    end
+  end
+
+  json.array! search_fields do |(label, key)|
+    json.type 'search_field'
+    json.id key
+    json.attributes do
+      json.label label
+    end
+    json.links do
+      json.self url_for(search_state.to_h.merge(search_field: key, only_path: false))
+    end
+  end
+
+  json.array! active_sort_fields do |key, field|
+    json.type 'sort'
+    json.id key
+    json.attributes do
+      json.label field.label
+    end
+    json.links do
+      json.self url_for(search_state.to_h.merge(sort: key, only_path: false))
+    end
+  end
+end

data/app/views/catalog/index.rss.builder

@@ -1,12 +1,14 @@
-xml.instruct! :xml, :version=>"1.0"
-xml.rss(:version=>"2.0") {
+# frozen_string_literal: true
+
+xml.instruct! :xml, version: "1.0"
+xml.rss(version: "2.0") {
   xml.channel {
-    xml.title(t('blacklight.search.title', :application_name => application_name))
+    xml.title(t('blacklight.search.page_title.title', constraints: render_search_to_page_title(params), application_name: application_name))
     xml.link(search_action_url(params.to_unsafe_h))
-    xml.description(t('blacklight.search.title', :application_name => application_name))
+    xml.description(t('blacklight.search.page_title.title', constraints: render_search_to_page_title(params), application_name: application_name))
     xml.language('en-us')
-    @document_list.each_with_index do |document, document_counter|
-      xml << Nokogiri::XML.fragment(render_document_partials(document, blacklight_config.view_config(:rss).partials, document_counter: document_counter))
+    @response.documents.each_with_index do |document, document_counter|
+      xml << render_xml_partials(document, blacklight_config.view_config(:rss).partials, document_counter: document_counter)
     end
   }
 }

data/app/views/catalog/opensearch.xml.builder

@@ -1,10 +1,12 @@
-xml.instruct! :xml, :version=>'1.0'
-xml.OpenSearchDescription(:xmlns=>'http://a9.com/-/spec/opensearch/1.1/') {
-  xml.ShortName application_name
-  xml.Description "#{application_name} Search"
-  xml.Image "#{asset_url('favicon.ico')}", :height=>16, :width=>16, :type=>'image/x-icon'
-  xml.Contact
-  xml.Url :type=>'text/html', :method=>'get', :template=>"#{url_for :controller=>'catalog', :only_path => false}?q={searchTerms}&page={startPage?}"
-  xml.Url :type=>'application/rss+xml', :method=>'get', :template=>"#{url_for :controller=>'catalog', :only_path => false}.rss?q={searchTerms}&page={startPage?}"
-  xml.Url :type=>'application/x-suggestions+json', :method=>'get', :template=>"#{url_for :controller=>'catalog',:action => 'opensearch', :format=> 'json', :only_path => false}?q={searchTerms}"
-}
+# frozen_string_literal: true
+
+xml.instruct! :xml, version: '1.0'
+xml.OpenSearchDescription(xmlns: 'http://a9.com/-/spec/opensearch/1.1/') {
+  xml.ShortName application_name
+  xml.Description "#{application_name} Search"
+  xml.Image asset_url('favicon.ico'), height: 16, width: 16, type: 'image/x-icon'
+  xml.Contact
+  xml.Url type: 'text/html', method: 'get', template: "#{url_for controller: 'catalog', only_path: false}?q={searchTerms}&page={startPage?}"
+  xml.Url type: 'application/rss+xml', method: 'get', template: "#{url_for controller: 'catalog', only_path: false}.rss?q={searchTerms}&page={startPage?}"
+  xml.Url type: 'application/x-suggestions+json', method: 'get', template: "#{url_for controller: 'catalog',action: 'opensearch', format: 'json', only_path: false}?q={searchTerms}"
+}

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

@@ -1,7 +1,12 @@
-<div id="content" class="<%= show_content_classes %>">
-  <%= render_document_main_content_partial %>
-</div>
+<% 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" %>
+    <%= link_back_to_catalog class: 'btn btn-outline-secondary' %>
+  </div>
+<% end %>
 
-<div id="sidebar" class="<%= show_sidebar_classes %>">
-   <%= render_document_sidebar_partial %>
-</div>
+<%= render_document_main_content_partial %>
+
+<% content_for(:sidebar) do %>
+  <%= render_document_sidebar_partial @document %>
+<% end %>

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+document_url = polymorphic_url(@document)
+json.links do
+  json.self document_url
+end
+
+json.data do
+  json.id @document.id
+  json.type @document[blacklight_config.view_config(:show).display_type_field]
+  json.attributes do
+    doc_presenter = show_presenter(@document)
+
+    doc_presenter.fields_to_render.each do |field_name, field|
+      json.partial! 'field', field: field,
+                             field_name: field_name,
+                             document_url: document_url,
+                             doc_presenter: doc_presenter
+    end
+  end
+end

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

@@ -1,5 +1,7 @@
 <div class="modal-header">
-	<button type="button" class="ajax-modal-close close" data-dismiss="modal" aria-hidden="true">×</button>
 	<h1 class="modal-title"><%= t('blacklight.sms.form.title') %></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>
 <%= render :partial => 'sms_form' %>

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

@@ -1,9 +1,13 @@
-<div class="modal-header">
-  <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
-  <h1 class="modal-title"><%= t('blacklight.sms.form.title') %></h1>
-</div>
+<div data-blacklight-modal="container">
+  <div class="modal-header">
+    <h1 class="modal-title"><%= t('blacklight.sms.form.title') %></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">
-  <%= render :partial=>'/flash_msg' %>
-  <span class="ajax-close-modal"></span>
-</div>
+  <div class="modal-body">
+    <%= render partial: '/shared/flash_msg' %>
+    <span data-blacklight-modal="close"></span>
+  </div>
+</div>

data/app/views/kaminari/blacklight/_first_page.html.erb

@@ -6,6 +6,6 @@
     per_page:      number of items to fetch per page
     remote:        data-remote
 -%>
-<li class="<%= 'disabled' if current_page.first? %>">
-  <%= link_to_unless current_page.first?, raw(t 'views.pagination.first'), url, :remote => remote %>
+<li class="page-item <%= 'disabled' if current_page.first? %>">
+  <%= link_to_unless current_page.first?, raw(t 'views.pagination.first'), url, :remote => remote, class: 'page-link', aria: { label: t('views.pagination.aria.go_to_first_page') } %>
 </li>

data/app/views/kaminari/blacklight/_gap.html.erb

@@ -5,7 +5,7 @@
     per_page:      number of items to fetch per page
     remote:        data-remote
 -%>
-<li class="disabled">
-  <span><%= raw(t 'views.pagination.truncate') %></span>
+<li class="page-item disabled">
+  <span class="page-link"><%= raw(t 'views.pagination.truncate') %></span>
 </li>
 

data/app/views/kaminari/blacklight/_last_page.html.erb

@@ -6,6 +6,6 @@
     per_page:      number of items to fetch per page
     remote:        data-remote
 -%>
-<li class="<%= 'disabled' if current_page.last? %>">
-  <%= link_to_unless current_page.last?, raw(t 'views.pagination.last'), url, {:remote => remote} %>
+<li class="page-item <%= 'disabled' if current_page.last? %>">
+  <%= link_to_unless current_page.last?, raw(t 'views.pagination.last'), url, :remote => remote, class: 'page-link', aria: { label: t('views.pagination.aria.go_to_last_page') } %>
 </li>

data/app/views/kaminari/blacklight/_next_page.html.erb

@@ -7,11 +7,11 @@
     remote:        data-remote
 -%>
 <% if current_page.last? %>
-    <li class="disabled">
-      <%= link_to raw(t 'views.pagination.next'), '#', :rel => 'next', :onclick=>'return false;' %>
+    <li class="page-item disabled">
+      <%= link_to raw(t 'views.pagination.next'), '#', :rel => 'next', :onclick=>'return false;', class: 'page-link', aria: { label: t('views.pagination.aria.go_to_next_page') } %>
     </li>
 <% else %>
-    <li>
-      <%= link_to raw(t 'views.pagination.next'), url, :rel => 'next', :remote => remote %>
+    <li class="page-item">
+      <%= link_to raw(t 'views.pagination.next'), url, :rel => 'next', :remote => remote, class: 'page-link', aria: { label: t('views.pagination.aria.go_to_next_page') } %>
     </li>
-<% end %>
+<% end %>

data/app/views/kaminari/blacklight/_page.html.erb

@@ -7,11 +7,13 @@
     per_page:      number of items to fetch per page
     remote:        data-remote
 -%>
-<li class="<%= 'active' if page.current? %>">
+<% page_display = number_with_delimiter(page.to_s) %>
+
+<li class="page-item <%= 'active' if page.current? %>">
   <% if page.current? %>
-    <span><%= number_with_delimiter(page.to_s) %></span>
+    <span class="page-link" aria-label="<%= t('views.pagination.aria.current_page', page: page_display) %>" aria-current="true"><%= page_display %></span>
   <% else %>
-    <%= link_to number_with_delimiter(page.to_s), url, opts = {:remote => remote, :rel => page.next? ? 'next' : page.prev? ? 'prev' : nil} %>
+    <%= link_to page_display, url, :remote => remote, :rel => page.next? ? 'next' : page.prev? ? 'prev' : nil, class: 'page-link', aria: { label: t('views.pagination.aria.go_to_page', page: page_display) } %>
   <% end %>
 </li>
 

data/app/views/kaminari/blacklight/_prev_page.html.erb

@@ -7,12 +7,12 @@
     remote:        data-remote
 -%>
 <% if current_page.first? %>
-    <li class="disabled">
-      <%= link_to raw(t 'views.pagination.previous'), '#', :rel => 'prev', :onclick=>'return false;' %>
+    <li class="page-item disabled">
+      <%= link_to raw(t 'views.pagination.previous'), '#', :rel => 'prev', :onclick=>'return false;', class: 'page-link', aria: { label: t('views.pagination.aria.go_to_previous_page') } %>
     </li>
 <% else %>
-    <li>
-      <%= link_to raw(t 'views.pagination.previous'), url, :rel => 'prev', :remote => remote %>
+    <li class="page-item">
+      <%= link_to raw(t 'views.pagination.previous'), url, :rel => 'prev', :remote => remote, class: 'page-link', aria: { label: t('views.pagination.aria.go_to_previous_page') } %>
     </li>
 <% end %>
 

data/app/views/kaminari/blacklight_compact/_paginator.html.erb

@@ -18,17 +18,17 @@
   <%# #render checks if total_pages > 1, so we can't put our fallback 
   in here .. -%>
   <%= paginator.render do -%>
-    <div class="page_links">
+    <div class="page-links">
       <%= prev_page_tag %> | 
-      <span class="page_entries">
+      <span class="page-entries">
         <%= page_entries_info %>
       </span> | 
       <%= next_page_tag %>
     </div>
   <% end -%>
 <% else -%>
-    <div class="page_links">
-      <span class="page_entries">
+    <div class="page-links">
+      <span class="page-entries">
         <%= page_entries_info %>
       </span>
     </div> 

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

@@ -1,44 +1,17 @@
-<!DOCTYPE html>
-<html lang="en" class="no-js">
-  <head>
-    <meta charset="utf-8">
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-
-    <!-- Mobile viewport optimization h5bp.com/ad -->
-    <meta name="HandheldFriendly" content="True">
-    <meta name="viewport" content="width=device-width,initial-scale=1.0">
-    
-    <!-- Internet Explorer use the highest version available -->
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-
-    <!-- Mobile IE allows us to activate ClearType technology for smoothing fonts for easy reading -->
-    <!--[if IEMobile]>
-      <meta http-equiv="cleartype" content="on">
-    <![endif]-->
-
-    <title><%= render_page_title %></title>
-    <%= opensearch_description_tag application_name, opensearch_catalog_url(:format => 'xml') %>
-    <%= favicon_link_tag %>
-    <%= stylesheet_link_tag "application", media: "all" %>
-    <%= javascript_include_tag "application" %>
-    <%= csrf_meta_tags %>
-    <%= content_for(:head) %>
-  </head>
-  <body class="<%= render_body_class %>">
-  <%= render :partial => 'shared/header_navbar' %>
-
-  <%= render partial: 'shared/ajax_modal' %>
-
-  <div id="main-container" class="<%= container_classes %>">
-    <%= content_tag :h1, application_name, class: 'sr-only application-heading' %>
-
-    <%= render :partial=>'/flash_msg', layout: 'shared/flash_messages' %>
+<% content_for(:content) do %>
+  <% if content_for? :sidebar %>
+    <section id="content" class="<%= main_content_classes %> order-last" aria-label="<%= t('blacklight.search.documents.aria.search_results') %>">
+      <%= yield %>
+    </section>
 
-    <div class="row">
+    <section id="sidebar" class="<%= sidebar_classes %> order-first" aria-label="<%= t('blacklight.search.documents.aria.limit_search') %>">
+      <%= content_for(:sidebar) %>
+    </section>
+  <% else %>
+    <section class="col-md-12">
       <%= yield %>
-    </div>
-  </div>
+    </section>
+  <% end %>
+<% end %>
 
-  <%= render :partial => 'shared/footer' %>
-  </body>
-</html>
+<%= render template: "layouts/blacklight/base" %>

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

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html lang="en" class="no-js">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+
+    <!-- Internet Explorer use the highest version available -->
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+
+    <title><%= render_page_title %></title>
+    <%= opensearch_description_tag application_name, opensearch_catalog_url(format: 'xml') %>
+    <%= favicon_link_tag %>
+    <%= stylesheet_link_tag "application", media: "all" %>
+    <%= javascript_include_tag "application" %>
+    <%= csrf_meta_tags %>
+    <%= content_for(:head) %>
+  </head>
+  <body class="<%= render_body_class %>">
+    <div id="skip-link">
+      <%= 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>
+    <%= render partial: 'shared/header_navbar' %>
+
+  <main id="main-container" class="<%= container_classes %>" role="main" aria-label="<%= t('blacklight.main.aria.main_container') %>">
+    <%= content_for(:container_header) %>
+
+    <%= render partial: 'shared/flash_msg', layout: 'shared/flash_messages' %>
+
+    <div class="row">
+      <%= content_for?(:content) ? yield(:content) : yield %>
+    </div>
+  </main>
+
+    <%= render partial: 'shared/footer' %>
+    <%= render partial: 'shared/modal' %>
+  </body>
+</html>