blacklight 8.8.1 → 9.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a451b7f410e4471509825f5d26bdcd26e641dc6bd812a471e16e1486e7a391e5
-  data.tar.gz: 410b81b50ada2b286b299175e504aa85f5ec87708ae64fb42d9b036c68535c98
+  metadata.gz: a4ffba1fbfab58e820f1953e4c0b1ff8d3bbcd57da645c10a44aa2f0a09f4a7a
+  data.tar.gz: 323b2afff4d4a8b308486ad81978b64f3a88aa8414e890ea5563bd3ae7820d0e
 SHA512:
-  metadata.gz: '08a2cff69bac1f9bd00889b428fef0f63e3aead84dd615126e9b1620b122f058d926172f919f915ce184bb04165eea50783af699309d61d31aaf8544349bc2c5'
-  data.tar.gz: eebf1d8271275ee525c374245be122f41b259bb95888e9d24ee15179ca457e4faa7863440f88f6d88a5b0b2547e5fa3c489e84d688c59a2723dc4ea0695c5149
+  metadata.gz: 8d3bbad62d2d7ecfa2b19657d43dab0186e6a945dbd6093c120f2fa5ba833be91b78f75ccd73379008bfb20e199a44702ce49000ce5561203baae41029a5cd3f
+  data.tar.gz: 6a2837ca8deb3fd6650b947197d8dd5c5320631a339ac04a3e804aa1cc930050c50ed097f6fbff27ad3e50aab1c84b0bfe2817e91a466926dc0d0fd0202945b8

data/.env

@@ -1,6 +1,6 @@
-ALPINE_RUBY_VERSION=3.1.6
-RAILS_VERSION=6.1.4.6
-VIEW_COMPONENT_VERSION=3.12.1
+ALPINE_RUBY_VERSION=3.3
+RAILS_VERSION=7.2.1
+VIEW_COMPONENT_VERSION=3.14.0
 SOLR_PORT=8983
 SOLR_URL=http://solr:8983/solr/blacklight-core
 SOLR_VERSION=latest

data/.github/pull_request_template.md

@@ -0,0 +1,7 @@
+<!--
+Thanks for contributing to Blacklight!
+
+If you changed any SASS files in this pull-request, ensure you have built the CSS.
+You can do this by running `npm run build` and commit the resulting changes to `app/assets/builds/blacklight.css`
+
+-->

data/.github/workflows/ruby.yml

@@ -57,18 +57,10 @@ jobs:
             additional_name: "Solr 8.11.2"
           - ruby: "3.1"
             rails_version: "7.1.5.1"
-          - ruby: "3.1"
-            rails_version: "7.1.5.1"
-            view_component_version: "~> 2.74"
-            additional_name: "/ ViewComponent 2"
-          - ruby: "3.1"
+          - ruby: "3.3"
             rails_version: "7.1.5.1"
             additional_name: "/ Propshaft"
             additional_engine_cart_rails_options: -a propshaft --css=bootstrap
-          - ruby: "3.1"
-            rails_version: "7.1.5.1"
-            bootstrap_version: "~> 4.0"
-            additional_name: "/ Bootstrap 4"
           - ruby: "3.3"
             rails_version: "7.1.5.1"
             api: "true"

data/.rubocop.yml

@@ -10,8 +10,8 @@ inherit_from:
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 3.0
-  TargetRailsVersion: 6.1
+  TargetRubyVersion: 3.1
+  TargetRailsVersion: 7.0
   Exclude:
     - "lib/generators/blacklight/templates/**/*"
     - "blacklight.gemspec"

data/.rubocop_todo.yml

@@ -19,15 +19,6 @@ Capybara/VisibilityMatcher:
     - 'spec/features/search_filters_spec.rb'
     - 'spec/helpers/blacklight_helper_spec.rb'
 
-# Offense count: 5
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: leading, trailing
-Layout/LineContinuationLeadingSpace:
-  Exclude:
-    - 'lib/generators/blacklight/controller_generator.rb'
-    - 'lib/generators/blacklight/user_generator.rb'
-
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowedMethods, AllowedPatterns.

data/README.md

@@ -2,6 +2,14 @@
 
 ![CI Workflow](https://github.com/projectblacklight/blacklight/actions/workflows/ruby.yml/badge.svg)
 
+## Branches
+
+* The `main` branch is currently where we do new development for the upcoming 9.0 release.
+* The `8.x` series is on the [release-8.x](https://github.com/projectblacklight/blacklight/tree/release-8.x) branch
+* The `7.x` series is on the [release-7.x](https://github.com/projectblacklight/blacklight/tree/release-7.x) branch
+* The `6.x` series is on the [release-6.x](https://github.com/projectblacklight/blacklight/tree/release-6.x) branch
+
+## Description
 
 Blacklight is an open source Solr user interface discovery platform.
 You can use Blacklight to enable searching and browsing of your collections.
@@ -53,15 +61,29 @@ Code contributions are always welcome, instructions for contributing can be foun
 You'll also want some information about how Blacklight expects [Apache Solr](http://lucene.apache.org/solr ) to run, which you can find in [Solr Configuration](https://github.com/projectblacklight/blacklight/wiki/Solr-Configuration#solr-configuration)
 
 ## 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:
+The javascript includes some derivative combination files that are built at release time, that can be used by some javascript pipelines. The derivatives are placed at `app/assets/javascripts/blacklight`, and files there should not be edited by hand.
+
+When any of the javascript components in the gem are changed, you may have to rebuild these derivative files.
+
+
 1. [Install npm](https://www.npmjs.com/get-npm)
-1. run `npm install` to download dependencies
-1. run `npm run prepare` to build the bundle
-1. run `npm publish` to push the javascript package to https://npmjs.org/package/blacklight-frontend
+1. run `bundle exec rake build:npm`
+  (just runs `npm install` to download dependencies and `npm run prepare` to build the bundle)
+
+
+## Releasing versions
+
+You always need to release both the rubygem and npm package simultaneously. For more information, see [wiki](https://github.com/projectblacklight/blacklight/wiki/How-to-release-a-version)
+
+Summary of technical steps:
+
+1. Make sure `./package.json` and  `./VERSION` files have correct and matching versions.
+1. Release ruby gem with `bundle exec rake release`
+1. Release npm package
+  1. Build derivative products included in release with `bundle exec rake build:npm`
+  1. Publish with `npm publish`.
+
+
 
 ## Using the javascript
 Blacklight ships with Javascript that can be compiled either by Webpacker or by

data/VERSION

@@ -1 +1 @@
-8.8.1
+9.0.0.beta1

data/app/assets/builds/blacklight.css

@@ -0,0 +1,448 @@
+/* This is the default blacklight theme. */
+/* 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 CSS file
+   which over-rides things in this file. Or of course you can choose
+   not to use the Blacklight CSS file at all in your local app. */
+:root {
+  --bl-logo-image: url("blacklight/logo.png");
+  --bl-logo-width: 150px;
+  --bl-logo-height: 50px;
+  --bs-secondary-color: rgba(
+    33,
+    37,
+    41,
+    0.75
+  ); /* for compatability with BS < 5.3  */
+  --bl-main-padding-y: 0.5rem;
+  --bl-constraint-remove-hover-bg: #bb2d3b;
+  --bl-constraint-remove-hover-border-color: #bb2d3b;
+  --bl-field-name-color: var(--bs-secondary-color);
+}
+
+.page-link {
+  white-space: nowrap;
+}
+
+dialog.modal[open] {
+  display: block;
+  background: none;
+  border: none;
+  max-height: unset;
+  max-width: unset;
+}
+
+/* Generic layout stuff */
+main {
+  padding-block: var(--bl-main-padding-y);
+}
+
+/*
+  Header bar at top (Bootstrap nav-bar)
+*/
+.navbar-logo {
+  /* The main logo image for the Blacklight instance */
+  background: transparent var(--bl-logo-image) no-repeat top left;
+  background-size: var(--bl-logo-width) var(--bl-logo-height);
+  height: var(--bl-logo-height);
+  overflow: hidden;
+  text-indent: 100%;
+  white-space: nowrap;
+  width: var(--bl-logo-width);
+}
+
+.navbar-search {
+  z-index: 1;
+}
+.navbar-search search {
+  display: contents;
+}
+.navbar-search .search-field {
+  min-width: 7em;
+}
+
+.constraints-container {
+  display: flex;
+  flex-wrap: wrap;
+  gap: 0.5rem 0.25rem;
+}
+
+.applied-filter {
+  --separator-icon: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='currentColor'%3e%3cpath fill-rule='evenodd' d='M4.646 1.646a.5.5 0 0 1 .708 0l6 6a.5.5 0 0 1 0 .708l-6 6a.5.5 0 0 1-.708-.708L10.293 8 4.646 2.354a.5.5 0 0 1 0-.708'/%3e%3c/svg%3e");
+}
+.applied-filter .constraint-value {
+  cursor: default;
+  text-overflow: ellipsis;
+  overflow: hidden;
+  white-space: nowrap;
+  max-width: clamp(288px, 30vw, 500px);
+}
+.applied-filter .constraint-value .filter-name:after {
+  background-color: var(--bs-btn-color);
+  content: "";
+  mask: var(--separator-icon);
+  mask-repeat: no-repeat;
+  display: inline-block;
+  height: 1.1rem;
+  width: 1.25rem;
+  vertical-align: text-bottom;
+  margin-right: -0.2rem;
+  margin-left: 0.25rem;
+  transition: background-color 0.15s ease-in-out;
+}
+.applied-filter .remove {
+  --bs-btn-hover-bg: var(--bl-constraint-remove-hover-bg);
+  --bs-btn-hover-border-color: var(--bl-constraint-remove-hover-border-color);
+  --bs-btn-active-bg: var(--bl-constraint-remove-hover-bg);
+  --bs-btn-active-border-color: var(
+    --bl-constraint-remove-hover-border-color
+  );
+}
+
+.search-widgets {
+  display: flex;
+}
+
+.sort-pagination,
+.pagination-search-widgets {
+  border-bottom: var(--bs-border-width) solid var(--bs-border-color);
+}
+
+.sort-pagination .dropdown-toggle {
+  cursor: pointer;
+}
+
+.no-js .btn-group:focus-within .dropdown-menu {
+  display: block; /* show menu when tabbing to it, without Javascript */
+}
+
+.view-type {
+  display: inline-block;
+}
+
+.modal_form {
+  margin-bottom: 0;
+}
+
+.input-group > .search-q {
+  flex-grow: 4;
+}
+
+.input-group > .search-autocomplete-wrapper {
+  display: inline-block;
+  flex-grow: 4;
+  padding: 0;
+  position: relative;
+}
+.input-group > .search-autocomplete-wrapper .search-q {
+  border: 0;
+  height: 100%;
+  width: 100%;
+}
+.input-group > .search-autocomplete-wrapper ul {
+  display: block;
+}
+
+.search-btn {
+  border-top-left-radius: 0;
+  border-bottom-left-radius: 0;
+  display: flex;
+}
+
+.search-field,
+.search-q {
+  scroll-margin: 5rem;
+}
+
+.documents-list {
+  --bl-results-document-margin-top: 1rem;
+  --bl-results-document-padding-top: 1rem;
+}
+.documents-list .document {
+  display: flex;
+  border-bottom: 1px dotted var(--bs-border-color);
+  margin-top: var(--bl-results-document-margin-top);
+  padding-top: var(--bl-results-document-padding-top);
+}
+.documents-list .document .document-main-section {
+  flex-grow: 1;
+}
+.documents-list .document .document-thumbnail {
+  flex-grow: 0;
+  margin-bottom: 3rem;
+  padding-left: 3rem;
+}
+
+.page-links {
+  display: inline-block;
+  border: 1px solid transparent;
+  padding: 0.375rem 0.75rem;
+  padding-left: 0;
+}
+
+@media (max-width: 575.98px) {
+  .pagination {
+    flex-wrap: wrap;
+  }
+}
+
+.group-key {
+  --bl-border-color: var(--bs-gray-600);
+  border-bottom: 1px solid var(--bl-border-color);
+  clear: right;
+}
+
+.grouped-documents .document {
+  border-bottom: 0;
+}
+
+.bookmark-toggle {
+  --bl-icon-color: var(--bs-primary);
+  /* override for line 21.
+      Creates weird spacing in toolbar when min-width is set to 8rem */
+}
+.no-js .bookmark-toggle input[type=submit] {
+  display: inline;
+}
+.no-js .bookmark-toggle .toggle-bookmark {
+  display: none;
+}
+.bookmark-toggle input[type=submit] {
+  display: none;
+}
+.bookmark-toggle .toggle-bookmark {
+  cursor: pointer;
+}
+.bookmark-toggle .toggle-bookmark .toggle-bookmark-label {
+  font-weight: inherit;
+  min-width: 8.5em;
+}
+.bookmark-toggle .toggle-bookmark .toggle-bookmark-label .blacklight-icons svg {
+  height: 1.25rem;
+  width: 1.25rem;
+  overflow: visible;
+  fill: var(--bl-icon-color);
+}
+.bookmark-toggle .toggle-bookmark .toggle-bookmark-label .blacklight-icons svg.bookmark-checked {
+  display: none;
+}
+.bookmark-toggle .toggle-bookmark .toggle-bookmark-input:checked + span svg.bookmark-checked {
+  display: inherit;
+}
+.bookmark-toggle .toggle-bookmark .toggle-bookmark-input:checked + span svg.bookmark-unchecked {
+  display: none;
+}
+.bookmark-toggle .header-tools .toggle-bookmark-label {
+  min-width: 2rem;
+}
+
+.dl-invert dt {
+  font-weight: normal;
+  color: var(--bl-field-name-color);
+}
+@media (min-width: 768px) {
+  .dl-invert dt {
+    text-align: end;
+  }
+}
+
+.sidenav {
+  --bl-facet-active-bg: var(--bs-success);
+  --bl-facet-active-item-color: var(--bs-success);
+  --bl-facet-remove-color: var(--bs-secondary-color);
+  --bl-facet-remove-hover-color: var(--bs-danger);
+  --bl-facet-label-indent: -15px;
+  --bl-facet-label-padding-left: 15px;
+  --bl-facet-header-padding-y: 0.5rem;
+}
+.sidenav .facet-toggle-button [data-hide-label] {
+  display: inline;
+}
+.sidenav .facet-toggle-button [data-show-label] {
+  display: none;
+}
+.sidenav .facet-toggle-button[aria-expanded=false] [data-hide-label] {
+  display: none;
+}
+.sidenav .facet-toggle-button[aria-expanded=false] [data-show-label] {
+  display: inline;
+}
+
+@media (max-width: 991.98px) {
+  .no-js #sidebar {
+    order: 6 !important;
+  }
+}
+.no-js .facet-content.collapse {
+  display: block;
+}
+.no-js .facet-toggle-handle {
+  display: none;
+}
+.no-js .pivot-facet.collapse {
+  display: block;
+}
+.no-js .facets-collapse.collapse {
+  display: block;
+}
+
+.facets-header {
+  display: flex;
+  justify-content: space-between;
+  padding-block: var(--bl-facet-header-padding-y);
+}
+
+.facets-heading {
+  line-height: inherit;
+}
+
+.facet-limit {
+  --bs-accordion-btn-bg: var(--bs-gray-100);
+  --bs-btn-hover-bg: var(--bs-gray-200);
+  --bs-accordion-active-bg: var(--bs-accordion-btn-bg);
+}
+
+.facet-limit-active {
+  --bs-accordion-btn-bg: var(--bl-facet-active-bg);
+  --bs-btn-hover-bg: var(--bs-accordion-btn-bg);
+  --bs-accordion-btn-color: var(--bs-light);
+  --bs-btn-hover-color: var(--bs-accordion-btn-color);
+  --bs-accordion-active-color: var(--bs-accordion-btn-color);
+}
+
+.facet-values {
+  margin-bottom: 0;
+}
+.facet-values a {
+  text-decoration: none;
+}
+.facet-values li {
+  display: flex;
+  align-items: flex-start;
+  padding: 3px 0;
+}
+.facet-values li.treeitem {
+  display: block;
+}
+.facet-values li .selected {
+  color: var(--bl-facet-active-item-color);
+}
+.facet-values .remove {
+  color: var(--bl-facet-remove-color);
+  font-weight: bold;
+  padding-left: 0.5rem;
+  text-decoration: none;
+}
+.facet-values .remove:hover {
+  color: var(--bl-facet-remove-hover-color);
+  text-decoration: none;
+}
+.facet-values .facet-label {
+  hyphens: auto;
+  overflow-wrap: break-word;
+  padding-left: var(--bl-facet-label-padding-left);
+  padding-right: 1em;
+  text-indent: var(--bl-facet-label-indent);
+}
+.facet-values .facet-count {
+  margin-left: auto;
+}
+.facet-values .facet-checkbox {
+  width: 1.25rem;
+}
+
+.facet-extended-list .sort-options {
+  text-align: right;
+}
+.facet-extended-list .prev-next-links {
+  float: left;
+}
+
+.facet-field-heading {
+  /* This prevents the contained stretch link from covering the panel body */
+  position: relative;
+}
+.facet-field-heading a {
+  color: inherit;
+}
+
+/* Sidenav
+-------------------------------------------------- */
+.pivot-facet.show {
+  display: flex;
+}
+
+.facet-toggle-handle {
+  margin-block: 0;
+  padding-block: 0;
+  padding-inline: 0.5rem;
+  margin-inline-start: -0.75rem;
+}
+.pivot-facet .facet-toggle-handle {
+  margin-inline-start: -1.5rem;
+}
+.facet-toggle-handle.collapsed .show {
+  display: flex;
+}
+.facet-toggle-handle.collapsed .hide {
+  display: none;
+}
+.facet-toggle-handle .show {
+  display: none;
+}
+.facet-toggle-handle .hide {
+  display: flex;
+}
+.facet-toggle-handle .show .icon,
+.facet-toggle-handle .hide .icon {
+  width: 1em;
+  height: 1em;
+  padding: 0.375rem 0.75rem;
+}
+.facet-toggle-handle .show .icon {
+  background: transparent url('data:image/svg+xml,%3csvg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-plus-square" viewBox="0 0 16 16"%3e%3cpath d="M14 1a1 1 0 0 1 1 1v12a1 1 0 0 1-1 1H2a1 1 0 0 1-1-1V2a1 1 0 0 1 1-1h12zM2 0a2 2 0 0 0-2 2v12a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V2a2 2 0 0 0-2-2H2z" /%3e%3cpath d="M8 4a.5.5 0 0 1 .5.5v3h3a.5.5 0 0 1 0 1h-3v3a.5.5 0 0 1-1 0v-3h-3a.5.5 0 0 1 0-1h3v-3A.5.5 0 0 1 8 4z" /%3e%3c/svg%3e') center/1em auto no-repeat;
+}
+.facet-toggle-handle .hide .icon {
+  background: transparent url('data:image/svg+xml,%3csvg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-dash-square" viewBox="0 0 16 16"%3e%3cpath d="M14 1a1 1 0 0 1 1 1v12a1 1 0 0 1-1 1H2a1 1 0 0 1-1-1V2a1 1 0 0 1 1-1h12zM2 0a2 2 0 0 0-2 2v12a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V2a2 2 0 0 0-2-2H2z" /%3e%3cpath d="M4 8a.5.5 0 0 1 .5-.5h7a.5.5 0 0 1 0 1h-7A.5.5 0 0 1 4 8z" /%3e%3c/svg%3e') center/1em auto no-repeat;
+}
+
+/* Search History */
+.search-history {
+  --bl-history-filter-name-color: var(--bs-secondary-color);
+}
+.search-history td {
+  padding: 1rem;
+}
+.search-history .constraint {
+  padding-inline-end: 1rem;
+  display: block;
+}
+.search-history .filter-name {
+  color: var(--bl-history-filter-name-color);
+}
+
+.modal-dialog {
+  border-radius: 5px;
+}
+
+.modal-content .facet-pagination.top {
+  display: none; /* Doesn't display in a modal, but would display on a new page (e.g. without Javascript) */
+}
+.modal-content .page-sidebar {
+  display: none;
+}
+.modal-content .blacklight-modal-close {
+  display: block;
+}
+.modal-content .prev_next_links.btn-group .btn {
+  border: 0;
+}
+
+.blacklight-modal-close {
+  display: none;
+}
+
+.remove .bi {
+  height: 1em;
+  width: 1em;
+}

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

@@ -115,7 +115,7 @@ document.addEventListener('click', ButtonFocus);
 // const basicFunction = (entry) => console.log(entry)
 // const debounced = debounce(basicFunction("I should only be called once"));
 //
-// debounced // does NOT print to the screen because it is invoked again less than 200 milliseconds later
+// debounced // does NOT print to the screen becase it is invoked again less than 200 milliseconds later
 // debounced // does print to the screen
 // ```
 function debounce(func, timeout = 200) {
@@ -137,9 +137,9 @@ const FacetSuggest = async (e) => {
     if (response.ok) {
         const blob = await response.blob();
         const text = await blob.text();
-    
+
         const facetArea = document.querySelector('.facet-extended-list');
-    
+
         if (text && facetArea) {
             facetArea.innerHTML = text;
         }
@@ -261,7 +261,7 @@ const Modal = (() => {
     }
     elements.forEach((el) => frag.appendChild(el));
     modal.activateScripts(frag);
-    
+
     modal.target().querySelector('.modal-content').replaceChildren(frag);
 
     // send custom event with the modal dialog div as the target
@@ -270,7 +270,6 @@ const Modal = (() => {
 
     // if they did preventDefault, don't show the dialog
     if (e.defaultPrevented) return;
-
     modal.show();
   };
 
@@ -321,6 +320,12 @@ const Modal = (() => {
     dom.dispatchEvent(e);
 
     dom.close();
+
+    // Turn body scrolling back to what it was
+    document.body.style["overflow"] = modal.originalBodyOverflow;
+    document.body.style["padding-right"] = modal.originalBodyPaddingRight;
+    modal.originalBodyOverflow = undefined;
+    modal.originalBodyPaddingRight = undefined;
   };
 
   modal.show = function(el) {
@@ -332,6 +337,12 @@ const Modal = (() => {
     dom.dispatchEvent(e);
 
     dom.showModal();
+
+    // Turn off body scrolling
+    modal.originalBodyOverflow = document.body.style['overflow'];
+    modal.originalBodyPaddingRight = document.body.style['padding-right'];
+    document.body.style["overflow"] = "hidden";
+    document.body.style["padding-right"] = "0px";
   };
 
   modal.target = function() {
@@ -474,14 +485,6 @@ const Core = function() {
       const listeners = [];
       if (typeof Turbo !== 'undefined') {
         listeners.push('turbo:load', 'turbo:frame-load');
-      } else 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');
       }
@@ -491,8 +494,8 @@ const Core = function() {
   };
 }();
 
-// turbolinks triggers page:load events on page transition
-// If app isn't using turbolinks, this event will never be triggered, no prob.
+// turbo triggers turbo:load events on page transition
+// If app isn't using turbo, this event will never be triggered, no prob.
 Core.listeners().forEach(function(listener) {
   document.addEventListener(listener, function() {
     Core.activate();