blacklight 6.21.0 → 7.3.0

data/.travis.yml

@@ -2,44 +2,33 @@ dist: bionic
 addons:
   chrome: stable
 language: ruby
-sudo: false
 
 notifications:
   email: false
 
-rvm:
-  - 2.5.7
-
 matrix:
   include:
+    - rvm: 2.6.5
+      env: "RAILS_VERSION=6.0.0 ENGINE_CART_RAILS_OPTIONS=\"--skip-webpack-install\""
+    - rvm: 2.6.5
+      env: "RAILS_VERSION=5.2.3"
+    - rvm: 2.5.7
+      env: "RAILS_VERSION=5.1.7"
     - rvm: 2.5.7
-      env: "RAILS_VERSION=5.2.0"
-    - rvm: 2.4.4
-      env: "RAILS_VERSION=4.2.10"
-    - rvm: 2.2.10
-      env: "RAILS_VESION=5.0.7"
-    - rvm: 2.3.7
-      env: "RAILS_VERSION=5.1.6"
-    - rvm: jruby-9.1.17.0
-      env: "RAILS_VERSION=5.2.0 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
+      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.1.17.0
-    - rvm: 2.4.4
-      env: "RAILS_VERSION=4.2.10"
-    - rvm: 2.2.10
-      env: "RAILS_VESION=5.0.7"
+    - rvm: jruby-9.2.8.0
   fast_finish: true
 
 before_install:
-  - gem update --system
-  - gem install bundler
-  - google-chrome-stable --headless --disable-gpu --remote-debugging-port=9222 http://localhost &
-
-before_script:
-  - if [[ "${RAILS_VERSION}" =~ ^4.2.* ]]; then perl -pi -e "s/ActiveRecord::Migration\[[\d\.]+\]/ActiveRecord::Migration/" db/migrate/*; fi
-
-env:
- - "RAILS_VERSION=5.1.1"
+  - docker pull solr:7
+  - docker run -d -p 8983:8983 -v $PWD/lib/generators/blacklight/templates/solr/conf:/myconfig solr:7 solr-create -c blacklight-core -d /myconfig
+  - docker ps -a
+  - google-chrome-stable --headless --disable-gpu --no-sandbox --remote-debugging-port=9222 http://localhost &
 
 notifications:
   irc: "irc.freenode.org#blacklight"
@@ -48,6 +37,14 @@ notifications:
 
 global_env:
   - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-  - ENGINE_CART_RAILS_OPTIONS='--skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+  - ENGINE_CART_RAILS_OPTIONS='--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+  - CC_TEST_REPORTER_ID=5042c7358c96b0b926088a4cda3e132fffe7a66ce8047cdb1dc6f0b4b6676b79
 
 jdk: openjdk11
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing to Blacklight
+
+Blacklight is a collaborative, open source project produced by developers from many diverse  organizations. The Blacklight developers want to create an out-of-the-box framework that is easy to install and get started with, both as a service to the community and in the interests of our own institutions in creating a sustainable project and product.
+
+Development is largely motivated by the needs of each developer’s organization, and we work on the shared project together so we can benefit from the community’s development efforts, experiences building discovery systems, and shared problem solving.
+
+We always welcome contributions from the community, especially to add new features, address bugs or defects, and clarify existing code for future developers.
+
+## Adding a ticket
+Let us know you're interested in working on a feature by filing a ticket in our [issue tracker](https://github.com/projectblacklight/blacklight/issues).
+
+## Making Your Changes
+
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
+* After making your changes, be sure to run the [Blacklight tests](https://github.com/projectblacklight/blacklight/wiki/testing) to make sure everything works.
+* Submit your change as a [Pull Request](https://help.github.com/en/articles/about-pull-requests).
+
+## 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. The #blacklight channel on [code4lib Slack](https://code4lib.org/irc/) is another active forum for informal discussion and troubleshooting.
+
+## Becoming a Committer
+
+Anyone can contribute to Blacklight using pull requests, the issue tracker, and being active on the mailing list and IRC channels. Being a contributor means that you take an active interest in the project and contribute regularly in some way, ranging from asking sensible questions (which documents the project and provides feedback to developers) to providing new features as patches.
+
+If you become a valuable contributor to the project you may be invited to become a committer.  Blacklight code contributors become committers after being sponsored by one of the current active committers.  The committers will take an Apache-style (+1/0/-1) vote to elevate them, and then a formal invitation will be extended to the contributor.
+
+Committers should be:
+
+- technically adept
+- constructive, positive members of the Blacklight software community
+- committed to producing useful, practical code for the community
+
+You're expected to:
+
+- contribute patches and new functionality to Blacklight and other shared development efforts (RSolr, Blacklight plugins, etc)
+- actively participate in technical discussions on the email list, IRC, and github
+- answer user support questions via the various channels
+- review pull requests from fellow committers and the community
+- test-drive new release candidates against your own institution's Blacklight applications
+- participate in regular committer meetings, usually in the form of conference calls, to coordinate development & direction

data/Gemfile

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Please see blacklight.gemspec for dependency information.
 gemspec path: File.expand_path('..', __FILE__)
 
 group :test do
-  gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+  gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
 end
 
 # BEGIN ENGINE_CART BLOCK
@@ -32,14 +34,13 @@ else
   end
 
   case ENV['RAILS_VERSION']
-  when /^5.[12]/
+  when /^5.[12]/, /^6.0/
     gem 'sass-rails', '~> 5.0'
   when /^4.2/
     gem 'responders', '~> 2.0'
     gem 'sass-rails', '>= 5.0'
     gem 'coffee-rails', '~> 4.1.0'
     gem 'json', '~> 1.8'
-    gem 'capybara', '~> 2.0'
   when /^4.[01]/
     gem 'sass-rails', '< 5.0'
   end

data/README.md

@@ -1,13 +1,13 @@
 # Blacklight
 
-[![Build Status](https://travis-ci.org/projectblacklight/blacklight.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight) [![Gem Version](https://badge.fury.io/rb/blacklight.png)](http://badge.fury.io/rb/blacklight) [![Coverage Status](https://coveralls.io/repos/github/projectblacklight/blacklight/badge.svg?branch=master)](https://coveralls.io/github/projectblacklight/blacklight?branch=master)
+[![Build Status](https://travis-ci.org/projectblacklight/blacklight.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight) [![Gem Version](https://badge.fury.io/rb/blacklight.png)](http://badge.fury.io/rb/blacklight) [![Test Coverage](https://api.codeclimate.com/v1/badges/83fd270492c136594e59/test_coverage)](https://codeclimate.com/github/projectblacklight/blacklight/test_coverage)
 
 Blacklight is an open source Solr user interface discovery platform.
 You can use Blacklight to enable searching and browsing of your collections.
 Blacklight uses the [Apache Solr](http://lucene.apache.org/solr) search engine
 to search full text and/or metadata.  Blacklight has a highly
 configurable Ruby on Rails front-end. Blacklight was originally developed at
-the University of Virginia Library and is made public under an Apache 2.0 license. 
+the University of Virginia Library and is made public under an Apache 2.0 license.
 
 ## Installation
 
@@ -34,9 +34,26 @@ rails generate blacklight:install
 
 ## Dependencies
 
-* Ruby 2.1+
+* Ruby 2.2+
 * Bundler
-* Rails 4.2+
+* Rails 5.1+
 
-## Configuring Apache Solr 
+## Configuring Apache Solr
 You'll also want some information about how Blacklight expects [Apache Solr](http://lucene.apache.org/solr ) to run, which you can find in [README_SOLR](https://github.com/projectblacklight/blacklight/wiki/README_SOLR)
+
+## Building the javascript
+The javascript is built by npm from sources in `app/javascript` into a bundle
+in `app/assets/javascripts/blacklight/blacklight.js`. This file should not be edited
+by hand as any changes would be overwritten.  When any of the javascript
+components in the gem are changed, this bundle should be rebuild with the
+following steps:
+1. [Install npm](https://www.npmjs.com/get-npm)
+1. run `npm install` to download dependencies
+1. run `npm run js-compile-bundle` to build the bundle
+1. run `npm publish` to push the javascript package to https://npmjs.org/package/blacklight-frontend
+
+## Using the javascript
+Blacklight ships with Javascript that can be compiled either by Webpacker or by
+Sprockets. To use Webpacker see the directions at https://github.com/projectblacklight/blacklight/wiki/Using-Webpacker-to-compile-javascript-assets
+
+If you prefer to use Sprockets, simply run the install generator, which will run the assets generator. For details see https://github.com/projectblacklight/blacklight/wiki/Using-Sprockets-to-compile-javascript-assets

data/Rakefile

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'rails'
 begin
@@ -12,4 +13,4 @@ Bundler::GemHelper.install_tasks
 load "tasks/blacklight.rake"
 load "lib/railties/blacklight.rake"
 
-task :default => [:rubocop, :ci]
+task default: [:rubocop, :ci]

data/VERSION

@@ -1 +1 @@
-6.21.0
+7.3.0

data/Vagrantfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 

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

@@ -0,0 +1 @@
+<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

@@ -0,0 +1 @@
+<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

@@ -1,59 +1,497 @@
-// This file is generated by Blacklight. You probably don't want to edit
-//   this file directly, or you'll have to manually merge your changes if later
-//   versions of Blacklight change this file. Instead, use your own JS file
-//   which over-rides things in this JS file, as described below.
-//
-// These javascript files are compiled in via the Rails asset pipeline:
-//= require blacklight/core
-//= require blacklight/autocomplete
-//= require blacklight/bookmark_toggle
-//= require blacklight/collapsable
-//= require blacklight/facet_load
-//= require blacklight/ajax_modal
-//= require blacklight/search_context
-//= require blacklight/autofocus
-//
-//Bootstrap JS for providing collapsable tablet/mobile menu/alert boxes
-//= require bootstrap/transition
-//= require bootstrap/collapse
-//= require bootstrap/dropdown
-//= require bootstrap/alert
-//= require bootstrap/modal
-
-// Twitter Typeahead for autocomplete
-//= require twitter/typeahead
-
-/* Blacklight has a Javascript setup meant to support local disabling, 
-  modification, and use of Blacklight behaviors. 
-  
-  There is a global Blacklight object, available to your local JS. 
-  
-  Individual logic to apply JS behaviors to particular elements is 
-  stored in functions on that Blacklight object. 
-  
-  The actual behaviors themselves are implemented as JQuery plugins, 
-  JQuery-UI widgets (a special kind of JQuery plugin), or in some cases
-  just as logic in the Blacklight global object. 
-  
-  All of these things can be modified by your local JS code -- these functions
-  are all set up on js load, and only called on document ready, so do your
-  modifications just on js load, and they'll be made by the time document ready
-  comes along. 
-  
-  Examples, in your application's own JS:
-        
-    Turn off adding of behavior to facet 'more' links, using a no-op function:
-    
-        Blacklight.do_more_facets_behavior = function() {};
-        
-    Change the implementation of facet 'more' link behavior to use entirely
-    different JS. 
-    
-        Blacklight.do_more_facets_behavior = function() {
-          $(Blacklight.do_more_facets_behavior.selector).each(function() {
-            //my own thing!
-          });
-        };
-*/
+Blacklight = function () {
+  var buffer = new Array();
+  return {
+    onLoad: function (func) {
+      buffer.push(func);
+    },
+    activate: function () {
+      for (var i = 0; i < buffer.length; i++) {
+        buffer[i].call();
+      }
+    },
+    listeners: function () {
+      var listeners = [];
+
+      if (typeof Turbolinks !== 'undefined' && Turbolinks.supported) {
+        // Turbolinks 5
+        if (Turbolinks.BrowserAdapter) {
+          listeners.push('turbolinks:load');
+        } else {
+          // Turbolinks < 5
+          listeners.push('page:load', 'DOMContentLoaded');
+        }
+      } else {
+        listeners.push('DOMContentLoaded');
+      }
+
+      return listeners;
+    }
+  };
+}(); // turbolinks triggers page:load events on page transition
+// If app isn't using turbolinks, this event will never be triggered, no prob.
+
 
+Blacklight.listeners().forEach(function (listener) {
+  document.addEventListener(listener, function () {
+    Blacklight.activate();
+  });
+});
 $('.no-js').removeClass('no-js').addClass('js');
+/*global Bloodhound */
+
+Blacklight.onLoad(function () {
+  'use strict';
+
+  $('[data-autocomplete-enabled="true"]').each(function () {
+    var $el = $(this);
+
+    if ($el.hasClass('tt-hint')) {
+      return;
+    }
+
+    var suggestUrl = $el.data().autocompletePath;
+    var terms = new Bloodhound({
+      datumTokenizer: Bloodhound.tokenizers.obj.whitespace('value'),
+      queryTokenizer: Bloodhound.tokenizers.whitespace,
+      remote: {
+        url: suggestUrl + '?q=%QUERY',
+        wildcard: '%QUERY'
+      }
+    });
+    terms.initialize();
+    $el.typeahead({
+      hint: true,
+      highlight: true,
+      minLength: 2
+    }, {
+      name: 'terms',
+      displayKey: 'term',
+      source: terms.ttAdapter()
+    });
+  });
+});
+
+(function ($) {
+  //change form submit toggle to checkbox
+  Blacklight.doBookmarkToggleBehavior = function () {
+    if (typeof Blacklight.do_bookmark_toggle_behavior == 'function') {
+      console.warn("do_bookmark_toggle_behavior is deprecated. Use doBookmarkToggleBehavior instead.");
+      return Blacklight.do_bookmark_toggle_behavior();
+    }
+
+    $(Blacklight.doBookmarkToggleBehavior.selector).blCheckboxSubmit({
+      // cssClass is added to elements added, plus used for id base
+      cssClass: 'toggle-bookmark',
+      success: function (checked, response) {
+        if (response.bookmarks) {
+          $('[data-role=bookmark-counter]').text(response.bookmarks.count);
+        }
+      }
+    });
+  };
+
+  Blacklight.doBookmarkToggleBehavior.selector = 'form.bookmark-toggle';
+  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.
+
+   Apply to a form. Does require certain assumption about the form:
+    1) The same form 'action' href must be used for both ADD and REMOVE
+       actions, with the different being the hidden input name="_method"
+       being set to "put" or "delete" -- that's the Rails method to pretend
+       to be doing a certain HTTP verb. So same URL, PUT to add, DELETE
+       to remove. This plugin assumes that.
+
+       Plus, the form this is applied to should provide a data-doc-id
+       attribute (HTML5-style doc-*) that contains the id/primary key
+       of the object in question -- used by plugin for a unique value for
+       DOM id's.
+
+  Uses HTML for a checkbox compatible with Bootstrap 3.
+
+   Pass in options for your class name and labels:
+   $("form.something").blCheckboxSubmit({
+        //cssClass is added to elements added, plus used for id base
+        cssClass: "toggle_my_kinda_form",
+        error: function() {
+          #optional callback
+        },
+        success: function(after_success_check_state) {
+          #optional callback
+        }
+   });
+*/
+
+(function ($) {
+  $.fn.blCheckboxSubmit = function (argOpts) {
+    this.each(function () {
+      var options = $.extend({}, $.fn.blCheckboxSubmit.defaults, argOpts);
+      var form = $(this);
+      form.children().hide(); //We're going to use the existing form to actually send our add/removes
+      //This works conveneintly because the exact same action href is used
+      //for both bookmarks/$doc_id.  But let's take out the irrelevant parts
+      //of the form to avoid any future confusion.
+
+      form.find('input[type=submit]').remove(); //View needs to set data-doc-id so we know a unique value
+      //for making DOM id
+
+      var uniqueId = form.attr('data-doc-id') || Math.random(); // if form is currently using method delete to change state,
+      // then checkbox is currently checked
+
+      var checked = form.find('input[name=_method][value=delete]').length != 0;
+      var checkbox = $('<input type="checkbox">').addClass(options.cssClass).attr('id', options.cssClass + '_' + uniqueId);
+      var label = $('<label>').addClass(options.cssClass).attr('for', options.cssClass + '_' + uniqueId).attr('title', form.attr('title') || '');
+      var span = $('<span>');
+      label.append(checkbox);
+      label.append(' ');
+      label.append(span);
+      var checkboxDiv = $('<div class="checkbox" />').addClass(options.cssClass).append(label);
+
+      function updateStateFor(state) {
+        checkbox.prop('checked', state);
+        label.toggleClass('checked', state);
+
+        if (state) {
+          //Set the Rails hidden field that fakes an HTTP verb
+          //properly for current state action.
+          form.find('input[name=_method]').val('delete');
+          span.html(form.attr('data-present'));
+        } else {
+          form.find('input[name=_method]').val('put');
+          span.html(form.attr('data-absent'));
+        }
+      }
+
+      form.append(checkboxDiv);
+      updateStateFor(checked);
+      checkbox.click(function () {
+        span.html(form.attr('data-inprogress'));
+        label.attr('disabled', 'disabled');
+        checkbox.attr('disabled', 'disabled');
+        $.ajax({
+          url: form.attr('action'),
+          dataType: 'json',
+          type: form.attr('method').toUpperCase(),
+          data: form.serialize(),
+          error: function () {
+            label.removeAttr('disabled');
+            checkbox.removeAttr('disabled');
+            options.error.call();
+          },
+          success: function (data, status, xhr) {
+            //if app isn't running at all, xhr annoyingly
+            //reports success with status 0.
+            if (xhr.status != 0) {
+              checked = !checked;
+              updateStateFor(checked);
+              label.removeAttr('disabled');
+              checkbox.removeAttr('disabled');
+              options.success.call(form, checked, xhr.responseJSON);
+            } else {
+              label.removeAttr('disabled');
+              checkbox.removeAttr('disabled');
+              options.error.call();
+            }
+          }
+        });
+        return false;
+      }); //checkbox.click
+    }); //this.each
+
+    return this;
+  };
+
+  $.fn.blCheckboxSubmit.defaults = {
+    //cssClass is added to elements added, plus used for id base
+    cssClass: 'blCheckboxSubmit',
+    error: function () {
+      alert("Error");
+    },
+    success: function () {} //callback
+
+  };
+})(jQuery);
+/*global Blacklight */
+
+
+'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;
+  }
+
+  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();
+});
+/*
+  The blacklight modal plugin can display some interactions inside a Bootstrap
+  modal window, including some multi-page interactions.
+
+  It supports unobtrusive Javascript, where a link or form that would have caused
+  a new page load is changed to display it's results inside a modal dialog,
+  by this plugin.  The plugin assumes there is a Bootstrap modal div
+  on the page with id #blacklight-modal to use as the modal -- the standard Blacklight
+  layout provides this.
+
+  To make a link or form have their results display inside a modal, add
+  `data-blacklight-modal="trigger"` to the link or form. (Note, form itself not submit input)
+  With Rails link_to helper, you'd do that like:
+
+      link_to something, link, data: { blacklight_modal: "trigger" }
+
+  The results of the link href or form submit will be displayed inside
+  a modal -- they should include the proper HTML markup for a bootstrap modal's
+  contents. Also, you ordinarily won't want the Rails template with wrapping
+  navigational elements to be used.  The Rails controller could suppress
+  the layout when a JS AJAX request is detected, OR the response
+  can include a `<div data-blacklight-modal="container">` -- only the contents
+  of the container will be placed inside the modal, the rest of the
+  page will be ignored.
+
+  If you'd like to have a link or button that closes the modal,
+  you can just add a `data-dismiss="modal"` to the link,
+  standard Bootstrap convention. But you can also have
+  an href on this link for non-JS contexts, we'll make sure
+  inside the modal it closes the modal and the link is NOT followed.
+
+  Link or forms inside the modal will ordinarily cause page loads
+  when they are triggered. However, if you'd like their results
+  to stay within the modal, just add `data-blacklight-modal="preserve"`
+  to the link or form.
+
+  Here's an example of what might be returned, demonstrating most of the devices available:
+
+    <div data-blacklight-modal="container">
+      <div class="modal-header">
+        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
+        <h3 class="modal-title">Request Placed</h3>
+      </div>
+
+      <div class="modal-body">
+        <p>Some message</p>
+        <%= link_to "This result will still be within modal", some_link, data: { blacklight: "preserve" } %>
+      </div>
+
+
+      <div class="modal-footer">
+        <%= link_to "Close the modal", request_done_path, class: "submit button dialog-close", data: { dismiss: "modal" } %>
+      </div>
+    </div>
+
+
+  One additional feature. If the content returned from the AJAX modal load
+  has an element with `data-blacklight-modal=close`, that will trigger the modal
+  to be closed. And if this element includes a node with class "flash_messages",
+  the flash-messages node will be added to the main page inside #main-flahses.
+
+  == Events
+
+  We'll send out an event 'loaded.blacklight.blacklight-modal' with the #blacklight-modal
+  dialog as the target, right after content is loaded into the modal but before
+  it is shown (if not already a shown modal).  In an event handler, you can
+  inspect loaded content by looking inside $(this).  If you call event.preventDefault(),
+  we won't 'show' the dialog (although it may already have been shown, you may want to
+  $(this).modal("hide") if you want to ensure hidden/closed.
+
+  The data-blacklight-modal=close behavior is implemented with this event, see for example.
+*/
+// 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
+
+
+Blacklight.modal.modalSelector = '#blacklight-modal'; // Trigger selectors identify forms or hyperlinks that should open
+// inside a modal dialog.
+
+Blacklight.modal.triggerLinkSelector = 'a[data-blacklight-modal~=trigger]';
+Blacklight.modal.triggerFormSelector = 'form[data-blacklight-modal~=trigger]'; // preserve selectors identify forms or hyperlinks that, if activated already
+// inside a modal dialog, should have destinations remain inside the modal -- but
+// won't trigger a modal if not already in one.
+//
+// No need to repeat selectors from trigger selectors, those will already
+// be preserved. MUST be manually prefixed with the modal selector,
+// so they only apply to things inside a modal.
+
+Blacklight.modal.preserveLinkSelector = Blacklight.modal.modalSelector + ' a[data-blacklight-modal~=preserve]';
+Blacklight.modal.containerSelector = '[data-blacklight-modal~=container]';
+Blacklight.modal.modalCloseSelector = '[data-blacklight-modal~=close]'; // Called on fatal failure of ajax load, function returns content
+// to show to user in modal.  Right now called only for extreme
+// network errors.
+
+Blacklight.modal.onFailure = function (data) {
+  var contents = '<div class="modal-header">' + '<div class="modal-title">Network Error</div>' + '<button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="Close">' + '  <span aria-hidden="true">&times;</span>' + '</button>';
+  $(Blacklight.modal.modalSelector).find('.modal-content').html(contents);
+  $(Blacklight.modal.modalSelector).modal('show');
+};
+
+Blacklight.modal.receiveAjax = function (contents) {
+  // does it have a data- selector for container?
+  // important we don't execute script tags, we shouldn't.
+  // code modelled off of JQuery ajax.load. https://github.com/jquery/jquery/blob/master/src/ajax/load.js?source=c#L62
+  var container = $('<div>').append(jQuery.parseHTML(contents)).find(Blacklight.modal.containerSelector).first();
+
+  if (container.length !== 0) {
+    contents = container.html();
+  }
+
+  $(Blacklight.modal.modalSelector).find('.modal-content').html(contents); // send custom event with the modal dialog div as the target
+
+  var e = $.Event('loaded.blacklight.blacklight-modal');
+  $(Blacklight.modal.modalSelector).trigger(e); // if they did preventDefault, don't show the dialog
+
+  if (e.isDefaultPrevented()) return;
+  $(Blacklight.modal.modalSelector).modal('show');
+};
+
+Blacklight.modal.modalAjaxLinkClick = function (e) {
+  e.preventDefault();
+  $.ajax({
+    url: $(this).attr('href')
+  }).fail(Blacklight.modal.onFailure).done(Blacklight.modal.receiveAjax);
+};
+
+Blacklight.modal.modalAjaxFormSubmit = function (e) {
+  e.preventDefault();
+  $.ajax({
+    url: $(this).attr('action'),
+    data: $(this).serialize(),
+    type: $(this).attr('method') // POST
+
+  }).fail(Blacklight.modal.onFailure).done(Blacklight.modal.receiveAjax);
+};
+
+Blacklight.modal.setupModal = function () {
+  // Event indicating blacklight is setting up a modal link,
+  // you can catch it and call e.preventDefault() to abort
+  // setup.
+  var e = $.Event('setup.blacklight.blacklight-modal');
+  $('body').trigger(e);
+  if (e.isDefaultPrevented()) return; // Register both trigger and preserve selectors in ONE event handler, combining
+  // into one selector with a comma, so if something matches BOTH selectors, it
+  // still only gets the event handler called once.
+
+  $('body').on('click', Blacklight.modal.triggerLinkSelector + ', ' + Blacklight.modal.preserveLinkSelector, Blacklight.modal.modalAjaxLinkClick);
+  $('body').on('submit', Blacklight.modal.triggerFormSelector + ', ' + Blacklight.modal.preserveFormSelector, Blacklight.modal.modalAjaxFormSubmit); // Catch our own custom loaded event to implement data-blacklight-modal=closed
+
+  $('body').on('loaded.blacklight.blacklight-modal', Blacklight.modal.checkCloseModal); // we support doing data-dismiss=modal on a <a> with a href for non-ajax
+  // use, we need to suppress following the a's href that's there for
+  // non-JS contexts.
+
+  $('body').on('click', Blacklight.modal.modalSelector + ' a[data-dismiss~=modal]', function (e) {
+    e.preventDefault();
+  });
+}; // A function used as an event handler on loaded.blacklight.blacklight-modal
+// to catch contained data-blacklight-modal=closed directions
+
+
+Blacklight.modal.checkCloseModal = function (event) {
+  if ($(event.target).find(Blacklight.modal.modalCloseSelector).length) {
+    var modalFlashes = $(this).find('.flash_messages');
+    $(event.target).modal('hide');
+    event.preventDefault();
+    var mainFlashes = $('#main-flashes');
+    mainFlashes.append(modalFlashes);
+    modalFlashes.fadeIn(500);
+  }
+};
+
+Blacklight.onLoad(function () {
+  Blacklight.modal.setupModal();
+});
+
+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();
+});
+