blacklight 7.1.0 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1781363312295e0871899850efea8278e255485d84991ad9e5ce1c798eba9680
-  data.tar.gz: 2be4ffe011dc4a8c96d58097db27c768422fb24b2528cd9cbc8d91cf80728072
+  metadata.gz: 00a998f008fdf60cfe8e5623d8230c040e82f3a43daed779ad0aa276361b6050
+  data.tar.gz: 2ec969ac9ad9f859206c684d3380945345c175362dae5e0fc785d7aa9d4a697e
 SHA512:
-  metadata.gz: 737b9592762ed056e36f6d41a5560387764bf01643bcfee555c0bc8e17ddf7d6d663161a6bc777c41d0cdbf8e157ae42ab2ed92f4d596dbeac0409b76a4d8a17
-  data.tar.gz: 62e3b74deba357f21e09145d6fcd25a241d05b1fbcd6ca3e40c3794fca3fe202074e8bab9ecbb2dac21b1980db54a9cee6af62144fe6545760b9d135ba4cfed7
+  metadata.gz: 67616cd584f0210b58b23de20c4c216e0f10ac9e547458b1eb98c34d6169372f42ca43b2131e804d9d0846c77218db81e36947223e5e96f8e470158a65bddfe9
+  data.tar.gz: 37a72f8450db7388d77764ff430b12962febc213a0a3cb8f5e1a84bff134dc1edbf2f79f08bf4f68980c71d4b47ccea7396554f99dfb6ea50847ea729851396f

data/.jshintrc

@@ -1,4 +1,5 @@
 {
+  "asi": true,
   "browser": true,
   "jquery": true,
   "node": true,
@@ -15,6 +16,7 @@
   "unused": true,
   "eqnull": true,
   "predef": [
-    "Blacklight"
+    "Blacklight",
+    "Rails"
   ]
 }

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-08-05 11:45:43 -0500 using RuboCop version 0.63.1.
+# on 2019-09-11 10:59:32 -0500 using RuboCop version 0.63.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -36,7 +36,7 @@ Layout/ClosingParenthesisIndentation:
   Exclude:
     - 'app/views/catalog/index.atom.builder'
 
-# Offense count: 109
+# Offense count: 108
 # Cop supports --auto-correct.
 Layout/EmptyLineAfterMagicComment:
   Enabled: false
@@ -185,7 +185,7 @@ Lint/UselessComparison:
   Exclude:
     - 'spec/models/blacklight/document/active_model_shim_spec.rb'
 
-# Offense count: 57
+# Offense count: 58
 Metrics/AbcSize:
   Max: 49
 
@@ -245,10 +245,10 @@ Naming/UncommunicativeMethodParamName:
   Exclude:
     - 'app/models/blacklight/facet_paginator.rb'
     - 'app/models/concerns/blacklight/document.rb'
-    - 'app/models/concerns/blacklight/solr/document.rb'
     - 'app/presenters/blacklight/rendering/link_to_facet.rb'
     - 'lib/blacklight/nested_open_struct_with_hash_access.rb'
     - 'lib/blacklight/search_state.rb'
+    - 'lib/blacklight/solr/document.rb'
     - 'lib/blacklight/solr/search_builder_behavior.rb'
     - 'spec/features/search_context_spec.rb'
     - 'spec/features/search_results_spec.rb'
@@ -290,7 +290,7 @@ RSpec/BeforeAfterAll:
     - 'spec/models/blacklight/document/sms_spec.rb'
     - 'spec/models/blacklight/solr/document_spec.rb'
 
-# Offense count: 70
+# Offense count: 71
 # Configuration parameters: Prefixes.
 # Prefixes: when, with, without
 RSpec/ContextWording:
@@ -330,7 +330,7 @@ RSpec/FilePath:
     - 'spec/presenters/pipeline_spec.rb'
     - 'spec/presenters/thumbnail_presenter_spec.rb'
 
-# Offense count: 197
+# Offense count: 196
 # Configuration parameters: AssignmentOnly.
 RSpec/InstanceVariable:
   Enabled: false
@@ -386,7 +386,7 @@ RSpec/MessageSpies:
 RSpec/MultipleExpectations:
   Max: 16
 
-# Offense count: 329
+# Offense count: 332
 # Configuration parameters: IgnoreSharedExamples.
 RSpec/NamedSubject:
   Enabled: false
@@ -587,9 +587,9 @@ Style/NumericPredicate:
   Exclude:
     - 'spec/**/*'
     - 'app/helpers/blacklight/catalog_helper_behavior.rb'
-    - 'app/models/blacklight/solr/facet_paginator.rb'
     - 'app/services/blacklight/search_service.rb'
     - 'lib/blacklight/search_builder.rb'
+    - 'lib/blacklight/solr/facet_paginator.rb'
     - 'lib/blacklight/solr/response/facets.rb'
     - 'lib/blacklight/solr/search_builder_behavior.rb'
     - 'lib/railties/blacklight.rake'

data/.travis.yml

@@ -8,20 +8,20 @@ notifications:
 
 matrix:
   include:
-    - rvm: 2.6.0
-      env: "RAILS_VERSION=5.2.2"
-    - rvm: 2.5.3
-      env: "RAILS_VERSION=5.1.6"
-    - rvm: 2.4.5
-      env: "RAILS_VERSION=5.2.1"
-    - rvm: 2.5.3
-      env: "RAILS_VERSION=5.2.1 BLACKLIGHT_API_TEST=true ENGINE_CART_RAILS_OPTIONS=\"--api --skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-test\""
-    - rvm: 2.4.5
-      env: "RAILS_VERSION=5.1.6"
-    - rvm: jruby-9.2.0.0
-      env: "RAILS_VERSION=5.1.6 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
+    - rvm: 2.6.5
+      env: "RAILS_VERSION=5.2.3"
+    - rvm: 2.5.7
+      env: "RAILS_VERSION=5.1.7"
+    - rvm: 2.4.9
+      env: "RAILS_VERSION=5.2.3"
+    - rvm: 2.5.7
+      env: "RAILS_VERSION=5.2.3 BLACKLIGHT_API_TEST=true ENGINE_CART_RAILS_OPTIONS=\"--api --skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-test\""
+    - rvm: 2.4.9
+      env: "RAILS_VERSION=5.1.7"
+    - rvm: jruby-9.2.8.0
+      env: "RAILS_VERSION=5.1.7 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
   allow_failures:
-    - rvm: jruby-9.2.0.0
+    - rvm: jruby-9.2.8.0
   fast_finish: true
 
 before_install:

data/CONTRIBUTING.md

@@ -20,11 +20,13 @@ Let us know you're interested in working on a feature by filing a ticket in our
 
 ## Pull Requests and Code Review
 - Pull requests must be reviewed and approved by one non-author with write-permissions
+- If additional code changes are made after approval, another approval (from the same or another qualified person) is required.
 - A reviewer who has approved a PR but has not merged it should provide a comment (e.g. "This looks good, I'm just waiting for Travis to build", "This is a breaking change. I would like at least one more reviewer.")
 - An approved PR may be merged by the reviewer, the author, or another committer
+- Additional discussion and feedback by non-maintainers is heartily encouraged.
 
 ## Support
-If you are interested in working on the Blacklight plugin, but want guidance or support, please send an email to our [Blacklight-development mailing list](http://groups.google.com/group/blacklight-development) and we'll be glad to help.
+If you are interested in working on the Blacklight plugin, but want guidance or support, please send an email to our [Blacklight-development mailing list](http://groups.google.com/group/blacklight-development) and we'll be glad to help. The #blacklight channel on [code4lib Slack](https://code4lib.org/irc/) is another active forum for informal discussion and troubleshooting.
 
 ## Becoming a Committer
 

data/Gemfile

@@ -34,6 +34,8 @@ else
   end
 
   case ENV['RAILS_VERSION']
+  when /^5.[12]/
+    gem 'sass-rails', '~> 5.0'
   when /^4.2/
     gem 'responders', '~> 2.0'
     gem 'sass-rails', '>= 5.0'

data/VERSION

@@ -1 +1 @@
-7.1.0
+7.2.0

data/app/assets/images/blacklight/list.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16"><style>.a{stroke-width:2;}</style><title>List</title><desc>  Created with Sketch.</desc><g fill="none"><path d="M4.9 2L14 2" class="a"/><path d="M5 6L14 6" class="a"/><path d="M5 10L14 10" class="a"/><path d="M5 14L14 14" class="a"/><circle cx="2" cy="2" r="1"/><circle cx="2" cy="6" r="1"/><circle cx="2" cy="10" r="1"/><circle cx="2" cy="14" r="1"/></g></svg>
+<svg width="14" height="14" xmlns="http://www.w3.org/2000/svg"><circle cx="1" cy="1" r="1"/><circle cx="1" cy="5" r="1"/><circle cx="1" cy="9" r="1"/><circle cx="1" cy="13" r="1"/><path d="M4 8.5h9v1H4zM4 4.5h9v1H4zM4 .5h9v1H4zM4 12.5h9v1H4z"/></svg>

data/app/assets/images/blacklight/search.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16"><title>Search</title><g fill="none"><g stroke="#000"><circle cx="6" cy="6" r="5"/><path d="M14 14L10 10" style="stroke-linejoin:round;stroke-width:2"/></g></g></svg>
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 20 20"><path fill="none" d="M0 0h24v24H0V0z"/><path d="M15.5 14h-.79l-.28-.27C15.41 12.59 16 11.11 16 9.5 16 5.91 13.09 3 9.5 3S3 5.91 3 9.5 5.91 16 9.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19l-4.99-5zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"/></svg>

data/app/assets/javascripts/blacklight/blacklight.js

@@ -95,6 +95,16 @@ Blacklight.onLoad(function () {
     Blacklight.doBookmarkToggleBehavior();
   });
 })(jQuery);
+
+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();
+    });
+  });
+});
 /* A JQuery plugin (should this be implemented as a widget instead? not sure)
    that will convert a "toggle" form, with single submit button to add/remove
    something, like used for Bookmarks, into an AJAXy checkbox instead.
@@ -126,7 +136,6 @@ Blacklight.onLoad(function () {
    });
 */
 
-
 (function ($) {
   $.fn.blCheckboxSubmit = function (argOpts) {
     this.each(function () {
@@ -216,42 +225,32 @@ Blacklight.onLoad(function () {
 
   };
 })(jQuery);
-
-(function ($) {
-  Blacklight.onLoad(function () {
-    // when clicking on a link that toggles the collapsing behavior, don't do anything
-    // with the hash or the page could jump around.
-    $(document).on('click', 'a[data-toggle=collapse][href="#"], [data-toggle=collapse] a[href="#"]', function (event) {
-      event.preventDefault();
-    });
-  });
-})(jQuery);
 /*global Blacklight */
 
 
-(function ($) {
-  'use strict';
+'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;
-    }
+Blacklight.doResizeFacetLabelsAndCounts = function () {
+  // adjust width of facet columns to fit their contents
+  function longer(a, b) {
+    return b.textContent.length - a.textContent.length;
+  }
 
-    $('ul.facet-values, ul.pivot-facet').each(function () {
-      var longest = $(this).find('span.facet-count').sort(longer)[0];
+  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:
 
-      if (longest && longest.textContent) {
-        var width = longest.textContent.length + 1 + 'ch';
-        $(this).find('.facet-count').first().width(width);
-      }
-    });
-  };
+    const longest = Array.from(nodes).sort(longer)[0];
 
-  Blacklight.onLoad(function () {
-    Blacklight.doResizeFacetLabelsAndCounts();
+    if (longest && longest.textContent) {
+      const width = longest.textContent.length + 1 + 'ch';
+      elem.querySelector('.facet-count').style.width = width;
+    }
   });
-})(jQuery);
+};
+
+Blacklight.onLoad(function () {
+  Blacklight.doResizeFacetLabelsAndCounts();
+});
 /*
   The blacklight modal plugin can display some interactions inside a Bootstrap
   modal window, including some multi-page interactions.
@@ -327,7 +326,6 @@ Blacklight.onLoad(function () {
 // We keep all our data in Blacklight.modal object.
 // Create lazily if someone else created first.
 
-
 if (Blacklight.modal === undefined) {
   Blacklight.modal = {};
 } // a Bootstrap modal div that should be already on the page hidden
@@ -432,54 +430,68 @@ Blacklight.onLoad(function () {
   Blacklight.modal.setupModal();
 });
 
-(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();
-    }
+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
+  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
+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 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
+  var link = this; // instead of using the normal href, we need to use the context href instead
 
-    if (event.metaKey || event.ctrlKey) {
-      target = '_blank';
-    }
+  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 (csrfParam !== undefined && csrfToken !== undefined) {
-      metadataInput += '<input name="' + csrfParam + '" value="' + csrfToken + '" type="hidden" />';
-    }
+  if (event.metaKey || event.ctrlKey) {
+    target = '_blank';
+  }
 
-    if (target) {
-      form.attr('target', target);
-    }
+  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
 
-    form.hide().append(metadataInput).append(redirectHref).appendTo('body');
-    form.submit();
-    return false;
-  };
 
-  Blacklight.onLoad(function () {
-    Blacklight.doSearchContextBehavior();
-  });
-})(jQuery);
+  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/assets/stylesheets/blacklight/_bootstrap_overrides.scss

@@ -2,26 +2,30 @@
   @extend .py-2;
 }
 
-.card-header.collapse-toggle {
-  margin-bottom: 0;
+// Facet field headings and buttons
+.facet-field-heading {
+  border-bottom: 0;
+  
+  button {
+    font-weight: $headings-font-weight;
 
-  &::after {
-    content: "❯";
-    float: right;
-    transform: rotate(90deg);
-  }
+    &::after {
+      content: "❯";
+      float: right;
+      transform: rotate(90deg);
+    }
 
-  &.collapsed {
-    border-bottom: 0;
+    &.collapsed {
+      border-bottom: 0;
 
-    &::after {
-      transform: rotate(0deg);
-      transition: transform 0.1s ease;
+      &::after {
+        transform: rotate(0deg);
+        transition: transform 0.1s ease;
+      }
     }
   }
 }
 
-
 .page-link {
   white-space: nowrap;
 }

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

@@ -123,6 +123,9 @@
   a {
     color: inherit;
   }
+
+  /* This prevents the contained stretch link from covering the panel body */
+  position: relative
 }
 
 /* Sidenav

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

@@ -53,3 +53,29 @@
     }
   }
 }
+
+#skip-link {
+  position: absolute;
+  top: 5px;
+  left: 10px;
+  z-index: 1;
+
+  .element-invisible {
+    position: absolute !important;
+    clip: rect(1px, 1px, 1px, 1px);
+    overflow: hidden;
+    height: 1px;
+  }
+
+  .element-invisible.element-focusable:active,
+  .element-invisible.element-focusable:focus {
+    position: static !important;
+    clip: auto;
+    overflow: visible;
+    height: auto;
+  }
+
+  a:focus {
+    background-color: $white;
+  }
+}