blacklight 7.0.0.rc1 → 7.0.0.rc2

data/app/services/blacklight/field_retriever.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   class FieldRetriever
     # @param [SolrDocument] document

data/app/services/blacklight/search_service.rb

@@ -2,17 +2,15 @@
 # SearchService returns search results from the repository
 module Blacklight
   class SearchService
-    def initialize(blacklight_config, user_params = {})
-      @blacklight_config = blacklight_config
+    def initialize(config:, user_params: {}, search_builder_class: config.search_builder_class)
+      @blacklight_config = config
       @user_params = user_params
+      @search_builder_class = search_builder_class
     end
 
-    # TODO: Can this be private?
+    # The blacklight_config is accessed by the search_builder
     attr_reader :blacklight_config
 
-    # Override this method to use a search builder other than the one in the config
-    delegate :search_builder_class, to: :blacklight_config
-
     def search_builder
       search_builder_class.new(self)
     end
@@ -86,11 +84,10 @@ module Blacklight
       [user_params[:q], response.documents.flat_map { |doc| doc[field] }.uniq]
     end
 
-    delegate :repository, to: :blacklight_config
-
     private
 
-    attr_reader :user_params
+    attr_reader :search_builder_class, :user_params
+    delegate :repository, to: :blacklight_config
 
     ##
     # The key to use to retrieve the grouped field to display
@@ -139,6 +136,7 @@ module Blacklight
       query = search_builder
               .with(user_params)
               .where(blacklight_config.document_model.unique_key => ids)
+              .merge(blacklight_config.fetch_many_document_params)
               .merge(extra_controller_params)
 
       solr_response = repository.search(query)

data/app/values/blacklight/types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   # These are data types that blacklight can use to coerce values from the index
   module Types
@@ -17,6 +19,7 @@ module Blacklight
       def self.coerce(input)
         field = String.coerce(input)
         return if field.blank?
+
         begin
           ::Date.parse(field)
         rescue ArgumentError

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

@@ -1,21 +1,20 @@
 <% @page_title = t('blacklight.bookmarks.page_title', :application_name => application_name) %>
 
 <div id="content" class="col-md-12">
-<h2 class='page-heading'><%= t('blacklight.bookmarks.title') %></h2>
+  <h1 class='page-heading'><%= t('blacklight.bookmarks.title') %></h1>
 
-<%- if current_or_guest_user.blank? -%>
+  <%- if current_or_guest_user.blank? -%>
 
-  <h3 class='section-heading'><%= t('blacklight.bookmarks.need_login') %></h3>
+    <h2 class='section-heading'><%= t('blacklight.bookmarks.need_login') %></h2>
 
-<%- elsif @response.documents.blank? -%>
+  <%- elsif @response.documents.blank? -%>
 
-  <h3 class='section-heading'><%= t('blacklight.bookmarks.no_bookmarks') %></h3>
-<% else %>
-  <%= render 'sort_and_per_page' %>
-  <%= render partial: 'tools', locals: { document_list: @response.documents } %>
-
-  <%= render_document_index %>
-  <%= render 'results_pagination' %>
-<% end %>
+    <h2 class='section-heading'><%= t('blacklight.bookmarks.no_bookmarks') %></h2>
+  <% else %>
+    <%= render 'sort_and_per_page' %>
+    <%= render partial: 'tools', locals: { document_list: @response.documents } %>
+    <h2 class='section-heading sr-only'><%= t('blacklight.bookmarks.list_title') %></h2>
+    <%= render_document_index %>
+    <%= render 'results_pagination' %>
+  <% end %>
 </div>
-

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

@@ -1,20 +1,20 @@
 
 <% @documents.each do |document| %>
 
-  <h3 class="modal-title"><%= document_heading(document) %></h3>
+  <h1 class="modal-title"><%= document_heading(document) %></h1>
 
 <% if document.respond_to?(:export_as_mla_citation_txt) %>
-  <h4><%= t('blacklight.citation.mla') %></h4>
+  <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) %>
-  <h4><%= t('blacklight.citation.apa') %></h4>
+  <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) -%>
-  <h4><%= t('blacklight.citation.chicago') %></h4>
+  <h2><%= t('blacklight.citation.chicago') %></h2>
   <%= document.send(:export_as_chicago_citation_txt).html_safe %>
 <%- end -%>
 

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

@@ -1,5 +1,7 @@
 <% if query_has_constraints? %>
   <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" %>
     <span class="constraints-label sr-only"><%= t('blacklight.search.filters.title') %></span>
     <%= render_constraints(params) %>

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

@@ -1,5 +1,5 @@
 <% if should_show_spellcheck_suggestions? @response %>
   <div id="spell">
-    <h4 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></h4>
+    <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 %>

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

@@ -1,21 +1,22 @@
+# frozen_string_literal: true
+
 xml.entry do
   xml.title index_presenter(document).label(document_show_link_field(document))
-  
+
   # updated is required, for now we'll just set it to now, sorry
   xml.updated Time.current.iso8601
-  
+
   xml.link    "rel" => "alternate", "type" => "text/html", "href" => polymorphic_url(url_for_document(document))
   # add other doc-specific formats, atom only lets us have one per
   # content type, so the first one in the list wins.
-  xml << show_presenter(document).link_rel_alternates(unique: true)      
-  
+  xml << show_presenter(document).link_rel_alternates(unique: true)
+
   xml.id polymorphic_url(url_for_document(document))
-  
-  
+
   if document.to_semantic_values.key? :author
     xml.author { xml.name(document.to_semantic_values[:author].first) }
   end
-  
+
   with_format("html") do
     xml.summary "type" => "html" do
       xml.text! render_document_partial(document,
@@ -23,23 +24,23 @@ xml.entry do
       document_counter: document_counter)
     end
   end
-  
-  #If they asked for a format, give it to them. 
+
+  #If they asked for a format, give it to them.
   if (params["content_format"] &&
     document.export_formats[params["content_format"].to_sym])
-    
+
     type = document.export_formats[params["content_format"].to_sym][:content_type]
-    
+
     xml.content type: type do |content_element|
       data = document.export_as(params["content_format"])
-      
+
       # encode properly. See:
       # http://tools.ietf.org/html/rfc4287#section-4.1.3.3
       type = type.downcase
-      if (type.downcase =~ /\+|\/xml$/)
-        # xml, just put it right in              
+      if (type.downcase =~ %r{\+|/xml$})
+        # xml, just put it right in
         content_element << data
-      elsif (type.downcase =~ /text\//)
+      elsif (type.downcase =~ %r{text/})
         # text, escape
         content_element.text! data
       else
@@ -47,6 +48,6 @@ xml.entry do
         content_element << Base64.encode64(data)
       end
     end
-    
+
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 xml.item do  
   xml.title(index_presenter(document).label(document_show_link_field(document)) || (document.to_semantic_values[:title].first if document.to_semantic_values.key?(:title)))
   xml.link(polymorphic_url(url_for_document(document)))

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

@@ -1,9 +1,10 @@
 <nav class="alpha-filter">
-  <%= link_to t('blacklight.search.facets.clear'), @pagination.params_for_resort_url('index', search_state.to_h.except(@pagination.request_keys[:prefix])), data: { blacklight_modal: "preserve" }, class: ['btn btn-outline-secondary', ('disabled' unless @pagination.prefix.present?)].join(' ') %>
-
-  <ol class="pagination">
+  <ol class="pagination pagination-sm justify-content-center">
+    <li class="page-item <%= 'active' if @pagination.prefix.blank? %>">
+      <%= link_to t('blacklight.search.facets.all'), @pagination.params_for_resort_url('index', search_state.to_h.except(@pagination.request_keys[:prefix])), data: { blacklight_modal: "preserve" }, class: 'page-link' %>
+    </li>
     <% @facet.index_range.each do |letter| %>
-      <li class="<%= 'active' if @pagination.prefix == letter %>"><%= link_to(letter, @pagination.params_for_resort_url('index', search_state.to_h.merge(@pagination.request_keys[:prefix] => letter)), data: { blacklight_modal: "preserve" }) %></li>
+      <li class="page-item <%= 'active' if @pagination.prefix == letter %>"><%= link_to(letter, @pagination.params_for_resort_url('index', search_state.to_h.merge(@pagination.request_keys[:prefix] => letter)), class: 'page-link', data: { blacklight_modal: "preserve" }) %></li>
     <% end %>
   </ol>
 </nav>

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

@@ -1,10 +1,8 @@
 <div class="card facet-limit blacklight-<%= facet_field.key.parameterize %> <%= 'facet-limit-active' if facet_field_in_params?(facet_field.key) %>">
-  <h3 class="panel-title card-header <%= "collapsed" if should_collapse_facet?(facet_field) %> collapse-toggle facet-field-heading" data-toggle="collapse" data-target="#<%= facet_field_id(facet_field) %>">
+  <h3 class="card-header <%= "collapsed" if should_collapse_facet?(facet_field) %> collapse-toggle facet-field-heading" aria-expanded="false" data-toggle="collapse" data-target="#<%= facet_field_id(facet_field) %>">
     <%= link_to facet_field_label(facet_field.key), "##{ facet_field_id(facet_field)}", "data-turbolinks": false %>
   </h3>
-  <div id="<%= facet_field_id(facet_field) %>" class="card-block panel-collapse facet-content <%= should_collapse_facet?(facet_field) ? 'collapse' : 'show' %>">
-    <div class="panel-body">
-      <%= yield %>
-    </div>
+  <div id="<%= facet_field_id(facet_field) %>" class="card-body panel-collapse facet-content <%= should_collapse_facet?(facet_field) ? 'collapse' : 'show' %>">
+    <%= yield %>
   </div>
 </div>

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

@@ -1,14 +1,15 @@
 <% # main container for facets/limits menu -%>
 <% if has_facet_values? %>
 <div id="facets" class="facets sidenav facets-toggleable-sm">
-  <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#facet-panel-collapse" aria-controls="facet-panel-collapse" aria-expanded="false" aria-label="Toggle facets">
-    <span class="navbar-toggler-icon"></span>
-  </button>
 
-  <div class="top-panel-heading">
+  <div class="navbar">
     <h2 class="facets-heading">
       <%= t('blacklight.search.facets.title') %>
     </h2>
+
+    <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#facet-panel-collapse" aria-controls="facet-panel-collapse" aria-expanded="false" aria-label="Toggle facets">
+      <span class="navbar-toggler-icon"></span>
+    </button>
   </div>
 
   <div id="facet-panel-collapse" class="facets-collapse collapse">

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+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.label
+  end
+end

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

@@ -1,7 +1,7 @@
 <% # container for all groups in index view -%>
 <div id="groups">
   <%- @response.groups.each do |g| %>
-    <h3 class="group-key"><%= g.key %></h3>
+    <h2 class="group-key"><%= g.key %></h2>
     <div class="grouped-documents">
       <%= render_document_index g.docs %>
     </div>

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

@@ -1,8 +1,8 @@
 <div class="jumbotron text-center">
-  <h2 class="jumbotron-heading"><%= t('blacklight.welcome') %></h2>
+  <h1 class="jumbotron-heading"><%= t('blacklight.welcome') %></h1>
 
   <p class="lead">Blacklight is a multi-institutional open-source collaboration building a better discovery platform framework.</p>
-  
+
   <p>
     <%= link_to 'Read the Documentation', 'https://github.com/projectblacklight/blacklight/wiki', class: 'btn btn-primary' %>
     <%= link_to 'See Examples', 'http://projectblacklight.org', class: 'btn btn-outline-secondary' %>
@@ -10,7 +10,7 @@
 </div>
 
 <div id="getting-started">
-  <h3>Here’s how to get started customizing your application:</h3>
+  <h2>Here’s how to get started customizing your application:</h2>
 
   <p>There are many ways to override specific behaviors and views in Blacklight. Because Blacklight is distributed as a Rails engine-based gem, all customization of Blacklight behavior should be done within your application by overriding Blacklight-provided behaviors with your own.</p>
 
@@ -31,8 +31,8 @@
 
 <%# This is the same panel shown in the Rails welcome template %>
 <div id="about" class="card">
-  <h3 class='card-header collapsed collapse-toggle' data-toggle="collapse" data-target="#about-content"><a href="/rails/info/properties">About your application&rsquo;s environment</a></h3>
-  <div id="about-content" class="card-block collapse"></div>
+  <h2 class='card-header collapsed collapse-toggle' data-toggle="collapse" data-target="#about-content"><a href="/rails/info/properties">About your application&rsquo;s environment</a></h2>
+  <div id="about-content" class="card-body collapse"></div>
 </div>
 
 <script>

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

@@ -1,12 +1,10 @@
-<% doc_presenter = index_presenter(document) %> 
+<% doc_presenter = index_presenter(document) %>
 <%# default partial to display solr document fields in catalog index view -%>
 <dl class="document-metadata dl-invert row">
-  
-  <% index_fields(document).each do |field_name, field| -%>
-    <% if should_render_index_field? document, 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_name %></dd>
-    <% end -%>
+
+  <% 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>
   <% end -%>
 
 </dl>

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

@@ -15,7 +15,7 @@
         <%= t('blacklight.search.documents.counter', counter: counter) %>
       </span>
     <% end %>
-    <%= link_to_document document, document_show_link_field(document), counter: counter %>
+    <%= link_to_document document, counter: counter %>
   </h3>
 
   <%= document_actions %>

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

@@ -1,7 +1,7 @@
 <% 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">
+  <button type="button" class="btn btn-outline-secondary dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
     <%= t(:'blacklight.search.per_page.button_label', :count => current_per_page) %> <span class="caret"></span>
   </button>
   <div class="dropdown-menu dropdown-menu-right" role="menu">

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

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

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

@@ -15,7 +15,7 @@
     <% 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", id: "q", autofocus: presenter.autofocus?, data: { autocomplete_enabled: presenter.autocomplete_enabled?, autocomplete_path: search_action_path(action: :suggest) }  %>
+    <%= text_field_tag :q, params[:q], placeholder: t('blacklight.search.form.search.placeholder'), class: "search-q q form-control", id: "q", 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">

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

@@ -1,5 +1,3 @@
-<h2 class="sr-only top-content-title"><%= t('blacklight.search.search_results_header') %></h2>
-
 <% @page_title = t('blacklight.search.page_title.title', :constraints => render_search_to_page_title(params), :application_name => application_name) %>
 
 <% content_for(:head) do -%>
@@ -10,6 +8,8 @@
 <% end %>
 
 <% content_for(:container_header) do -%>
+  <h1 class="sr-only top-content-title"><%= t('blacklight.search.header') %></h1>
+
   <%= render 'constraints' %>
 <% end %>
 

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

@@ -1,10 +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">
-  <% document_show_fields(document).each do |field_name, field| -%>
-    <% if should_render_show_field? document, 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_name %></dd>
-    <% end -%>
+  <% 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>
   <% end -%>
 </dl>

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

@@ -1,3 +1,3 @@
 <li class="more_like_this_document">
-  <span class="mlt_title"><%= link_to_document document, document_show_link_field(document) %></span>
+  <span class="mlt_title"><%= link_to_document document %></span>
 </li>

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

@@ -3,7 +3,7 @@
 <% unless @document.more_like_this.empty? %>
   <div class="card">
     <div class="card-header">More Like This</div>
-    <div class="card-block">
+    <div class="card-body">
       <%= render :collection => @document.more_like_this, :partial => 'show_more_like_this', :as => :document %>
     </div>
   </div>

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

@@ -10,7 +10,7 @@
 <% if show_doc_actions? %>
   <div class="card show-tools">
     <div class="card-header">
-      <%= t('blacklight.tools.title') %>
+      <h2 class="mb-0 h6"><%= t('blacklight.tools.title') %></h2>
     </div>
 
     <ul class="list-group list-group-flush">

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

@@ -1,6 +1,6 @@
 <% if show_sort_and_per_page? and active_sort_fields.many? %>
 <div id="sort-dropdown" class="sort-dropdown btn-group">
-  <button type="button" class="btn btn-outline-secondary dropdown-toggle" data-toggle="dropdown">
+  <button type="button" class="btn btn-outline-secondary dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
       <%= t('blacklight.search.sort.label', :field =>sort_field_label(current_sort_field.key)) %> <span class="caret"></span>
   </button>