blacklight 7.1.0 → 7.2.0

data/app/assets/stylesheets/blacklight/_icons.scss

@@ -13,22 +13,22 @@
 
 @each $color, $value in $theme-colors {
   .btn-#{$color} {
-    .blacklight-icons g {
-      @include stroke-yiq(theme-color($color));
+    .blacklight-icons svg {
+      @include fill-yiq(theme-color($color));
     }
   }
 
   .btn-outline-#{$color} {
-    .blacklight-icons g {
-      stroke: $value;
+    .blacklight-icons svg {
+      fill: $value;
     }
 
     &.hover,
     &:hover,
     &:active,
     &.active {
-      .blacklight-icons g {
-        @include stroke-yiq(theme-color($color));
+      .blacklight-icons svg {
+        @include fill-yiq(theme-color($color));
       }
     }
   }

data/app/assets/stylesheets/blacklight/_mixins.scss

@@ -1,6 +1,6 @@
 // Stroke contrast
 // Ripped off from https://github.com/twbs/bootstrap/commit/c31d52499811d5c68d122db806ce27a112b489bd
-@mixin stroke-yiq($color) {
+@mixin fill-yiq($color) {
   $r: red($color);
   $g: green($color);
   $b: blue($color);
@@ -8,8 +8,8 @@
   $yiq: (($r * 299) + ($g * 587) + ($b * 114)) / 1000;
 
   @if ($yiq >= 150) {
-    stroke: #111;
+    fill: #111;
   } @else {
-    stroke: #fff;
+    fill: #fff;
   }
 }

data/app/controllers/concerns/blacklight/facet.rb

@@ -4,7 +4,7 @@ module Blacklight
   # They are only dependent on `blacklight_config` and `@response`
   #
   module Facet
-    delegate :facet_configuration_for_field, to: :blacklight_config
+    delegate :facet_configuration_for_field, :facet_field_names, to: :blacklight_config
 
     def facet_paginator(field_config, response_data)
       blacklight_config.facet_paginator_class.new(
@@ -22,12 +22,6 @@ module Blacklight
       fields.map { |field| facet_by_field_name(field) }.compact
     end
 
-    # @param group [String] a group name of facet fields
-    # @return [Array<String>] a list of the facet field names from the configuration
-    def facet_field_names(group = nil)
-      blacklight_config.facet_fields.select { |_facet, opts| group == opts[:group] }.values.map(&:field)
-    end
-
     def facet_group_names
       blacklight_config.facet_fields.map { |_facet, opts| opts[:group] }.uniq
     end

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -3,13 +3,13 @@ module Blacklight::CatalogHelperBehavior
   extend Deprecation
   self.deprecation_horizon = 'blacklight 8.0'
 
-  include ConfigurationHelperBehavior
-  include ComponentHelperBehavior
-  include FacetsHelperBehavior
-  include RenderConstraintsHelperBehavior
-  include RenderPartialsHelperBehavior
-  include SearchHistoryConstraintsHelperBehavior
-  include SuggestHelperBehavior
+  include Blacklight::ConfigurationHelperBehavior
+  include Blacklight::ComponentHelperBehavior
+  include Blacklight::FacetsHelperBehavior
+  include Blacklight::RenderConstraintsHelperBehavior
+  include Blacklight::RenderPartialsHelperBehavior
+  include Blacklight::SearchHistoryConstraintsHelperBehavior
+  include Blacklight::SuggestHelperBehavior
 
   # @param [Hash] options
   # @option options :route_set the route scope to use when constructing the link
@@ -31,22 +31,21 @@ module Blacklight::CatalogHelperBehavior
 
   ##
   # Override the Kaminari page_entries_info helper with our own, blacklight-aware
-  # implementation.
-  # Displays the "showing X through Y of N" message.
+  # implementation. Why do we have to do this?
+  #  - We need custom counting information for grouped results
+  #  - We need to provide number_with_delimiter strings to i18n keys
+  # If we didn't have to do either one of these, we could get away with removing
+  # this entirely.
   #
   # @param [RSolr::Resource] collection (or other Kaminari-compatible objects)
   # @return [String]
-  def page_entries_info(collection, options = {})
+  def page_entries_info(collection, entry_name: nil)
     return unless show_pagination? collection
 
-    entry_name = if options[:entry_name]
-                   options[:entry_name]
-                 elsif collection.respond_to? :model  # DataMapper
-                   collection.model.model_name.human.downcase
-                 elsif collection.respond_to?(:model_name) && !collection.model_name.nil? # AR, Blacklight::PaginationMethods
-                   collection.model_name.human.downcase
+    entry_name = if entry_name
+                   entry_name.pluralize(collection.size, I18n.locale)
                  else
-                   t('blacklight.entry_name.default')
+                   collection.entry_name(count: collection.size).downcase
                  end
 
     entry_name = entry_name.pluralize unless collection.total_count == 1

data/app/helpers/blacklight/layout_helper_behavior.rb

@@ -22,14 +22,14 @@ module Blacklight
     # Classes used for sizing the main content of a Blacklight page
     # @return [String]
     def main_content_classes
-      'col-md-9'
+      'col-lg-9'
     end
 
     ##
     # Classes used for sizing the sidebar content of a Blacklight page
     # @return [String]
     def sidebar_classes
-      'page-sidebar col-md-3'
+      'page-sidebar col-lg-3'
     end
 
     ##

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -66,7 +66,7 @@ module Blacklight::UrlHelperBehavior
   # @param [Integer] counter
   # @example
   #   session_tracking_params(SolrDocument.new(id: 123), 7)
-  #   => { data: { :'tracker-href' => '/catalog/123/track?counter=7&search_id=999' } }
+  #   => { 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))
 

data/app/javascript/blacklight/button_focus.js

@@ -0,0 +1,9 @@
+Blacklight.onLoad(function() {
+  // Button clicks should change focus. As of 10/3/19, Firefox for Mac and
+  // Safari both do not set focus to a button on button click.
+  document.querySelectorAll('button.collapse-toggle').forEach((button) => {
+    button.addEventListener('click', () => {
+      event.target.focus();
+    });
+  });
+});

data/app/javascript/blacklight/facet_load.js

@@ -1,23 +1,22 @@
 /*global Blacklight */
 
-(function($) {
-  'use strict';
-  
-  Blacklight.doResizeFacetLabelsAndCounts = function() {
-    // adjust width of facet columns to fit their contents
-    function longer (a,b){ return b.textContent.length - a.textContent.length; }
+'use strict';
 
-    $('ul.facet-values, ul.pivot-facet').each(function(){
-      var longest = $(this).find('span.facet-count').sort(longer)[0];
-      
-      if (longest && longest.textContent) {
-        var width = longest.textContent.length + 1 + 'ch';
-        $(this).find('.facet-count').first().width(width);
-      }
-    });
-  };
+Blacklight.doResizeFacetLabelsAndCounts = function() {
+  // adjust width of facet columns to fit their contents
+  function longer (a,b) { return b.textContent.length - a.textContent.length }
 
-  Blacklight.onLoad(function() {
-    Blacklight.doResizeFacetLabelsAndCounts();
-  });
-})(jQuery);
+  document.querySelectorAll('.facet-values, .pivot-facet').forEach(function(elem){
+    const nodes = elem.querySelectorAll('.facet-count')
+    // TODO: when we drop ie11 support, this can become the spread operator:
+    const longest = Array.from(nodes).sort(longer)[0]
+    if (longest && longest.textContent) {
+      const width = longest.textContent.length + 1 + 'ch'
+      elem.querySelector('.facet-count').style.width = width
+    }
+  })
+}
+
+Blacklight.onLoad(function() {
+  Blacklight.doResizeFacetLabelsAndCounts()
+})

data/app/javascript/blacklight/search_context.js

@@ -1,49 +1,67 @@
-(function($) {
-  Blacklight.doSearchContextBehavior = function() {
-    if (typeof Blacklight.do_search_context_behavior == 'function') {
-      console.warn("do_search_context_behavior is deprecated. Use doSearchContextBehavior instead.");
-      return Blacklight.do_search_context_behavior();
-    }
-    $('a[data-context-href]').on('click.search-context', Blacklight.handleSearchContextMethod);
-  };
-
-  // this is the $.rails.handleMethod with a couple adjustments, described inline:
-  // first, we're attaching this directly to the event handler, so we can check for meta-keys
-  Blacklight.handleSearchContextMethod = function(event) {
-    if (typeof Blacklight.handle_search_context_method == 'function') {
-      console.warn("handle_search_context_method is deprecated. Use handleSearchContextMethod instead.");
-      return Blacklight.handle_search_context_method(event);
-    }
-    var link = $(this);
-
-    // instead of using the normal href, we need to use the context href instead
-    var href = link.data('context-href'),
-      method = 'post',
-      target = link.attr('target'),
-      csrfToken = $('meta[name=csrf-token]').attr('content'),
-      csrfParam = $('meta[name=csrf-param]').attr('content'),
-      form = $('<form method="post" action="' + href + '"></form>'),
-      metadataInput = '<input name="_method" value="' + method + '" type="hidden" />',
-      redirectHref = '<input name="redirect" value="' + link.attr('href') + '" type="hidden" />';
-
-    // check for meta keys.. if set, we should open in a new tab
-    if(event.metaKey || event.ctrlKey) {
-      target = '_blank';
-    }
-
-    if (csrfParam !== undefined && csrfToken !== undefined) {
-      metadataInput += '<input name="' + csrfParam + '" value="' + csrfToken + '" type="hidden" />';
-    }
-
-    if (target) { form.attr('target', target); }
-
-    form.hide().append(metadataInput).append(redirectHref).appendTo('body');
-    form.submit();
-
-    return false;
-  };
-
-  Blacklight.onLoad(function() {
-      Blacklight.doSearchContextBehavior();
-  });
-})(jQuery);
+Blacklight.doSearchContextBehavior = function() {
+  if (typeof Blacklight.do_search_context_behavior == 'function') {
+    console.warn("do_search_context_behavior is deprecated. Use doSearchContextBehavior instead.");
+    return Blacklight.do_search_context_behavior();
+  }
+
+  const elements = document.querySelectorAll('a[data-context-href]')
+  // Equivalent to Array.from(), but supports ie11
+  const nodes = Array.prototype.slice.call(elements)
+
+  nodes.forEach(function(element) {
+    element.addEventListener('click', function(e) {
+      Blacklight.handleSearchContextMethod.call(e.target, e)
+    })
+  })
+};
+
+// this is the Rails.handleMethod with a couple adjustments, described inline:
+// first, we're attaching this directly to the event handler, so we can check for meta-keys
+Blacklight.handleSearchContextMethod = function(event) {
+  if (typeof Blacklight.handle_search_context_method == 'function') {
+    console.warn("handle_search_context_method is deprecated. Use handleSearchContextMethod instead.");
+    return Blacklight.handle_search_context_method(event);
+  }
+  var link = this
+
+  // instead of using the normal href, we need to use the context href instead
+  let href = link.getAttribute('data-context-href')
+  let target = link.getAttribute('target')
+  let csrfToken = Rails.csrfToken()
+  let csrfParam = Rails.csrfParam()
+  let form = document.createElement('form')
+  form.method = 'post'
+  form.action = href
+
+
+  let formContent = `<input name="_method" value="post" type="hidden" />
+    <input name="redirect" value="${link.getAttribute('href')}" type="hidden" />`
+
+  // check for meta keys.. if set, we should open in a new tab
+  if(event.metaKey || event.ctrlKey) {
+    target = '_blank';
+  }
+
+  if (csrfParam !== undefined && csrfToken !== undefined) {
+    formContent += `<input name="${csrfParam}" value="${csrfToken}" type="hidden" />`
+  }
+
+  // Must trigger submit by click on a button, else "submit" event handler won't work!
+  // https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit
+  formContent += '<input type="submit" />'
+
+  if (target) { form.setAttribute('target', target); }
+
+  form.style.display = 'none'
+  form.innerHTML = formContent
+  document.body.appendChild(form)
+  form.querySelector('[type="submit"]').click()
+
+  event.preventDefault()
+  event.stopPropagation()
+  event.stopImmediatePropagation()
+};
+
+Blacklight.onLoad(function() {
+  Blacklight.doSearchContextBehavior();
+});

data/app/models/blacklight/icon.rb

@@ -2,22 +2,39 @@
 
 module Blacklight
   class Icon
-    attr_reader :icon_name
+    attr_reader :icon_name, :aria_hidden, :label, :role
     ##
     # @param [String, Symbol] icon_name
     # @param [Hash] options
     # @param [String] classes additional classes separated by a string
-    def initialize(icon_name, classes: '', aria_hidden: false)
+    # @param [Boolean] aria_hidden include aria_hidden attribute
+    # @param [Boolean] label include <title> and aria-label as part of svg
+    # @param [String] role role attribute to be included in svg
+    def initialize(icon_name, classes: '', aria_hidden: false, label: true, role: 'image')
       @icon_name = icon_name
       @classes = classes
       @aria_hidden = aria_hidden
+      @label = label
+      @role = role
     end
 
     ##
-    # Returns the raw source, but you could extend this to add additional attributes
+    # Returns an updated version of the svg source
     # @return [String]
     def svg
-      file_source
+      svg = ng_xml.at_xpath('svg')
+      svg['role'] = role
+      svg['aria-labelled-by'] = unique_id if label
+      svg.add_child("<title id='#{unique_id}'>#{icon_label}</title>") if label
+      ng_xml.to_xml
+    end
+
+    def icon_label
+      I18n.translate("blacklight.icon.#{icon_name}", default: "#{icon_name} icon")
+    end
+
+    def unique_id
+      @unique_id ||= "bl-icon-#{icon_name}-#{SecureRandom.hex(8)}"
     end
 
     ##
@@ -25,7 +42,7 @@ module Blacklight
     def options
       {
         class: classes,
-        "aria-hidden": (true if @aria_hidden)
+        "aria-hidden": (true if aria_hidden)
       }
     end
 
@@ -43,6 +60,10 @@ module Blacklight
       file.source.force_encoding('UTF-8')
     end
 
+    def ng_xml
+      @ng_xml ||= Nokogiri::XML(file_source).remove_namespaces!
+    end
+
     private
 
     def file

data/app/presenters/blacklight/search_bar_presenter.rb

@@ -31,7 +31,9 @@ module Blacklight
     #
     # @return [Boolean]
     def autofocus?
-      controller.is_a?(Blacklight::Catalog) &&
+      configuration.enable_search_bar_autofocus.present? &&
+        configuration.enable_search_bar_autofocus &&
+        controller.is_a?(Blacklight::Catalog) &&
         controller.action_name == "index" &&
         !controller.has_search_parameters?
     end

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

@@ -4,35 +4,33 @@
   # 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.
   -%>
-  <% unless bookmarked? document %>
+  <% if bookmarked? document %>
     <%= form_tag(bookmark_path(document),
-                 method: :put,
-                 class: 'bookmark-toggle',
+                 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.add.button'),
+      <%= submit_tag(t('blacklight.bookmarks.remove.button'),
                      id: "bookmark_toggle_#{document.id.to_s.parameterize}",
-                     class: "bookmark-add btn btn-outline-secondary") %>
+                     class: "bookmark-remove btn btn-outline-secondary") %>
     <% end %>
   <% else %>
     <%= form_tag(bookmark_path(document),
-                 method: :delete,
-                 class: "bookmark-toggle",
+                 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.remove.button'),
-                     id: "bookmark_toggle_#{document.id.to_s.parameterize}",
-                     class: "bookmark-remove btn btn-outline-secondary") %>
+                 }) 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 %>
-<% else %>
-  &nbsp;
 <% end %>

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

@@ -1,6 +1,6 @@
 <% # main container for facets/limits menu -%>
 <% if has_facet_values? facet_field_names(groupname) %>
-<div id="facets<%= "-#{groupname}" unless groupname.nil? %>" class="facets sidenav facets-toggleable-sm">
+<div id="facets<%= "-#{groupname}" unless groupname.nil? %>" class="facets sidenav facets-toggleable-md">
 
   <div class="navbar">
     <h2 class="facets-heading">