geoblacklight 2.4.0 → 3.3.0

data/README.md

@@ -1,6 +1,6 @@
 # GeoBlacklight
 
-[![CircleCI](https://circleci.com/gh/geoblacklight/geoblacklight.svg?style=svg)](https://circleci.com/gh/geoblacklight/geoblacklight) | [![Coverage Status](https://img.shields.io/coveralls/geoblacklight/geoblacklight.svg)](https://coveralls.io/r/geoblacklight/geoblacklight?branch=coveralls) | [![Gem Version](https://img.shields.io/gem/v/geoblacklight.svg)](https://github.com/geoblacklight/geoblacklight/releases)
+[![CircleCI](https://circleci.com/gh/geoblacklight/geoblacklight.svg?style=svg)](https://circleci.com/gh/geoblacklight/geoblacklight) | [![Coverage Status](https://raw.githubusercontent.com/geoblacklight/geoblacklight/coverage-badge/coverage.svg)]() | [![Gem Version](https://img.shields.io/gem/v/geoblacklight.svg)](https://github.com/geoblacklight/geoblacklight/releases)
 
 GeoBlacklight is a world-class discovery platform for geospatial (GIS) holdings. It
 is an open collaborative project aiming to build off of the successes
@@ -13,7 +13,7 @@ communities. We're actively looking for community input and development partners
 In order to create a new GeoBlacklight application from the template, run the following:
 
 ```
-$ rails new app-name -m https://raw.githubusercontent.com/geoblacklight/geoblacklight/master/template.rb
+$ DISABLE_SPRING=1 rails new app-name -m https://raw.githubusercontent.com/geoblacklight/geoblacklight/main/template.rb
 ```
 
 To launch app:
@@ -26,7 +26,7 @@ $ rake geoblacklight:server
 Note that this method launches an application that does not have any fixture records to be examined. You may want to launch a test application that has fixture data loaded into a Solr core. If so, refer to the [development guide](https://github.com/geoblacklight/geoblacklight/wiki/Development). For further information on installing a blank app, see the [installation guide](https://github.com/geoblacklight/geoblacklight/wiki/Installation)
 
 ### Webpacker
-GeoBlacklight can use [Webpacker](https://github.com/rails/webpacker) in order to manage JavaScript dependencies and assets, which requires that either [Yarn](https://yarnpkg.com/) or the [Node Package Manager](https://www.npmjs.com/) be available on the system where this is deployed.  How Webpacker interacts with Rails is overviewed within its own documentation, including [how best to configure JavaScript processing settings](https://github.com/rails/webpacker/blob/master/docs/webpack.md). We encourage you to review this.
+GeoBlacklight can use [Webpacker](https://github.com/rails/webpacker) in order to manage JavaScript dependencies and assets, which requires that either [Yarn](https://yarnpkg.com/) or the [Node Package Manager](https://www.npmjs.com/) be available on the system where this is deployed.  How Webpacker interacts with Rails is overviewed within its own documentation, including [how best to configure JavaScript processing settings](https://github.com/rails/webpacker). We encourage you to review this.
 
 ### Contributing
 Interested in contributing to GeoBlacklight? Please see our [contributing](CONTRIBUTING.md) guide.

data/Rakefile

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 require 'rails'
 begin
   require 'bundler/setup'
@@ -25,9 +26,9 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.verbose = false
 end
 
-desc 'Run Teaspoon JavaScript tests'
-task :teaspoon do
-  system('teaspoon --require=.internal_test_app/spec/teaspoon_env.rb')
+desc 'Run JavaScript unit tests'
+task :javascript_tests do
+  system '/bin/bash -c yarn test'
 end
 
 desc 'Run test suite'
@@ -42,7 +43,7 @@ task ci: ['geoblacklight:generate'] do
     end
   end
   # Run JavaScript tests
-  Rake::Task['teaspoon'].invoke
+  Rake::Task['javascript_tests'].invoke
 end
 
 namespace :geoblacklight do
@@ -54,6 +55,7 @@ namespace :geoblacklight do
 
   desc 'Create the test rails app'
   task generate: ['engine_cart:generate'] do
+    # Intentionally Empty Block
   end
 
   namespace :internal do
@@ -120,6 +122,13 @@ namespace :geoblacklight do
       end
     end
   end
+
+  desc 'Stdout output asset paths'
+  task :asset_paths do
+    within_test_app do
+      system 'bundle exec rake geoblacklight:application_asset_paths'
+    end
+  end
 end
 
 task default: [:ci]

data/app/assets/javascripts/geoblacklight/downloaders/downloader.js

@@ -3,7 +3,7 @@
 
   var Downloader = L.Class.extend({
     options: {
-      spinner: $('<i class="fa fa-spinner fa-spin fa-2x fa-align-center"></i>')
+      spinner: $('<div class="spinner-border spinner-border-sm float-right" role="status"><span class="sr-only">Downloading</span></div>')
     },
 
     initialize: function(el, options) {

data/app/assets/javascripts/geoblacklight/geoblacklight.js

@@ -19,6 +19,17 @@
     }
   };
 
+  /**
+   * Convert GeoJSON string to Leaflet LatLngBounds.
+   * @param {String} geojson GeoJSON string
+   * @return {L.LatLngBounds} Converted Leaflet LatLngBounds object
+   */
+  L.geoJSONToBounds = function(geojson) {
+    var layer = L.geoJSON();
+    layer.addData(geojson);
+    return layer.getBounds();
+  }
+
   var GeoBlacklight = L.Class.extend({
     statics: {
       __version__: '2.0.0',
@@ -38,5 +49,11 @@
 
   // Hash for leaflet controls.
   GeoBlacklight.Controls = {};
+
+  // Basic support of CommonJS module
+  if (typeof exports === "object") {
+    module.exports = GeoBlacklight;
+  }
+
   global.GeoBlacklight = GeoBlacklight;
-}(this);
+}(this || {});

data/app/assets/javascripts/geoblacklight/modules/bookmarks.js

@@ -0,0 +1,43 @@
+Blacklight.onLoad(function() {
+  $('[data-map="bookmarks"]').each(function() {
+    var data = $(this).data(),
+    world = L.latLngBounds([[-90, -180], [90, 180]]),
+    geoblacklight, bbox;
+
+    if (typeof data.mapGeom === 'string') {
+      bbox = L.geoJSONToBounds(data.mapGeom);
+    } else {
+      $('.document [data-geom]').each(function() {
+        try {
+          var currentBounds = L.geoJSONToBounds($(this).data().geom);
+          if (!world.contains(currentBounds)) {
+            throw "Invalid bounds";
+          }
+          if (typeof bbox === 'undefined') {
+            bbox = currentBounds;
+          } else {
+            bbox.extend(currentBounds);
+          }
+        } catch (e) {
+          bbox = L.bboxToBounds("-180 -90 180 90");
+        }
+      });
+    }
+
+    // instantiate new map
+    geoblacklight = new GeoBlacklight.Viewer.Map(this, { bbox: bbox });
+    geoblacklight.removeBoundsOverlay();
+
+    // set hover listeners on map
+    $('#content')
+      .on('mouseenter', '#documents [data-layer-id]', function() {
+        if($(this).data('bbox') !== "") {
+          var geom = $(this).data('geom')
+          geoblacklight.addGeoJsonOverlay(geom)
+        }
+      })
+      .on('mouseleave', '#documents [data-layer-id]', function() {
+        geoblacklight.removeBoundsOverlay();
+      });
+  });
+});

data/app/assets/javascripts/geoblacklight/modules/metadata_download_button.js

@@ -45,9 +45,14 @@
       }
     },
   });
+  
+  // Basic support of CommonJS module
+  if (typeof exports === "object") {
+    module.exports = MetadataDownloadButton;
+  }
 
   global.GeoBlacklight.MetadataDownloadButton = MetadataDownloadButton;
   global.GeoBlacklight.metadataDownloadButton = function metadataDownloadButton(el, options) {
     return new MetadataDownloadButton(el, options);
   };
-})(this);
+})(this || { GeoBlacklight: {}});

data/app/assets/javascripts/geoblacklight/modules/results.js

@@ -14,13 +14,12 @@ Blacklight.onLoad(function() {
     world = L.latLngBounds([[-90, -180], [90, 180]]),
     geoblacklight, bbox;
 
-    if (typeof data.mapBbox === 'string') {
-      bbox = L.bboxToBounds(data.mapBbox);
+    if (typeof data.mapGeom === 'string') {
+      bbox = L.geoJSONToBounds(data.mapGeom);
     } else {
-      $('.document [data-bbox]').each(function() {
-
+      $('.document [data-geom]').each(function() {
         try {
-          var currentBounds = L.bboxToBounds($(this).data().bbox);
+          var currentBounds = L.geoJSONToBounds($(this).data().geom);
           if (!world.contains(currentBounds)) {
             throw "Invalid bounds";
           }
@@ -50,9 +49,9 @@ Blacklight.onLoad(function() {
     // set hover listeners on map
     $('#content')
       .on('mouseenter', '#documents [data-layer-id]', function() {
-        if($(this).data('bbox').length > 0) {
-          var bounds = L.bboxToBounds($(this).data('bbox'));
-          geoblacklight.addBoundsOverlay(bounds);
+        if($(this).data('bbox') !== "") {
+          var geom = $(this).data('geom')
+          geoblacklight.addGeoJsonOverlay(geom)
         }
       })
       .on('mouseleave', '#documents [data-layer-id]', function() {

data/app/assets/javascripts/geoblacklight/modules/svg_tooltips.js

@@ -0,0 +1,31 @@
+/* global Blacklight */
+
+Blacklight.onLoad(function() {
+  'use strict';
+
+  $('body').on('mouseenter', '.blacklight-icons.svg_tooltip svg', function() {
+    var svgTitle = $(this).find('title');
+    var titleText = svgTitle && svgTitle.text();
+
+    if (titleText !== undefined && titleText !== '') {
+      $(this).tooltip({ placement: 'bottom', title: titleText });
+      $(this).tooltip('show');
+
+      // Store the original title in the data-original-title attribute
+      // and remove the title element on mouseenter.
+      // This prevents the title from interfering w/ Bootstrap's tooltip.
+      $(this).attr('data-original-title', titleText);
+      svgTitle.remove();
+    }
+  });
+
+  $('body').on('mouseleave', '.blacklight-icons.svg_tooltip svg', function() {
+    var originalTitle = $(this).attr('data-original-title');
+
+    if (originalTitle !== undefined && originalTitle !== '') {
+      // Restore the SVG title element from data-original-title on mouseleave
+      $(this).prepend($('<title>' + originalTitle + '</title>'));
+      $(this).attr('data-original-title', '');
+    }
+  });
+});

data/app/assets/javascripts/geoblacklight/modules/util.js

@@ -36,3 +36,8 @@ GeoBlacklight.Util = {
     }
   }
 };
+
+// Basic support of CommonJS module
+if (typeof exports === "object") {
+  module.exports = GeoBlacklight.Util;
+}

data/app/assets/javascripts/geoblacklight/viewers/esri.js

@@ -4,7 +4,7 @@ GeoBlacklight.Viewer.Esri = GeoBlacklight.Viewer.Map.extend({
   layerInfo: {},
 
   load: function() {
-    this.options.bbox = L.bboxToBounds(this.data.mapBbox);
+    this.options.bbox = L.geoJSONToBounds(this.data.mapGeom);
     this.map = L.map(this.element).fitBounds(this.options.bbox);
     this.map.addLayer(this.selectBasemap());
     this.map.addLayer(this.overlay);
@@ -50,8 +50,8 @@ GeoBlacklight.Viewer.Esri = GeoBlacklight.Viewer.Map.extend({
   appendLoadingMessage: function() {
     var spinner = '<tbody class="attribute-table-body"><tr><td colspan="2">' +
       '<span id="attribute-table">' +
-      '<i class="fa fa-spinner fa-spin fa-align-center">' +
-      '</i></span>' +
+      '<div class="spinner-border" role="status"><span class="sr-only">Inspecting</span></div>' +
+      '</span>' +
       '</td></tr></tbody>';
 
     $('.attribute-table-body').html(spinner);

data/app/assets/javascripts/geoblacklight/viewers/esri/tiled_map_layer.js

@@ -30,7 +30,7 @@ GeoBlacklight.Viewer.TiledMapLayer = GeoBlacklight.Viewer.Esri.extend({
       _this.appendLoadingMessage();
 
       // query layer at click location
-      L.esri.Tasks.identifyFeatures({
+      L.esri.identifyFeatures({
         url: layer.options.url,
         useCors: true
       })

data/app/assets/javascripts/geoblacklight/viewers/index_map.js

@@ -67,4 +67,4 @@ GeoBlacklight.Viewer.IndexMap = GeoBlacklight.Viewer.Map.extend({
         _this.map.fitBounds(geoJSONLayer.getBounds());
     });
   }
-});
+});

data/app/assets/javascripts/geoblacklight/viewers/map.js

@@ -14,8 +14,8 @@ GeoBlacklight.Viewer.Map = GeoBlacklight.Viewer.extend({
   overlay: L.layerGroup(),
 
   load: function() {
-    if (this.data.mapBbox) {
-      this.options.bbox = L.bboxToBounds(this.data.mapBbox);
+    if (this.data.mapGeom) {
+      this.options.bbox = L.geoJSONToBounds(this.data.mapGeom);
     }
     this.map = L.map(this.element).fitBounds(this.options.bbox);
 
@@ -53,6 +53,16 @@ GeoBlacklight.Viewer.Map = GeoBlacklight.Viewer.extend({
     this.overlay.clearLayers();
   },
 
+  /**
+   * Add a GeoJSON overlay to map.
+   * @param {string} geojson GeoJSON string
+   */
+  addGeoJsonOverlay: function(geojson) {
+    var layer = L.geoJSON();
+    layer.addData(geojson);
+    this.overlay.addLayer(layer);
+  },
+
   /**
   * Selects basemap if specified in data options, if not return positron.
   */

data/app/assets/javascripts/geoblacklight/viewers/tms.js

@@ -0,0 +1,10 @@
+//= require geoblacklight/viewers/wms
+
+GeoBlacklight.Viewer.Tms = GeoBlacklight.Viewer.Wms.extend({
+
+  addPreviewLayer: function() {
+    var _this = this;
+    var wmtsLayer = L.tileLayer(this.data.url);
+    this.overlay.addLayer(wmtsLayer);
+  }
+});

data/app/assets/javascripts/geoblacklight/viewers/wms.js

@@ -3,7 +3,7 @@
 GeoBlacklight.Viewer.Wms = GeoBlacklight.Viewer.Map.extend({
 
   load: function() {
-    this.options.bbox = L.bboxToBounds(this.data.mapBbox);
+    this.options.bbox = L.geoJSONToBounds(this.data.mapGeom);
     this.map = L.map(this.element).fitBounds(this.options.bbox);
     this.map.addLayer(this.selectBasemap());
     this.map.addLayer(this.overlay);
@@ -23,7 +23,7 @@ GeoBlacklight.Viewer.Wms = GeoBlacklight.Viewer.Map.extend({
       format: 'image/png',
       transparent: true,
       tiled: true,
-      CRS: 'EPSG:900913',
+      CRS: 'EPSG:3857',
       opacity: this.options.opacity,
       detectRetina: _this.detectRetina()
     });
@@ -34,7 +34,7 @@ GeoBlacklight.Viewer.Wms = GeoBlacklight.Viewer.Map.extend({
   setupInspection: function() {
     var _this = this;
     this.map.on('click', function(e) {
-      spinner = '<tbody class="attribute-table-body"><tr><td colspan="2"><span id="attribute-table"><i class="fa fa-spinner fa-spin fa-align-center"></i></span></td></tr></tbody>';
+      spinner = '<tbody class="attribute-table-body"><tr><td colspan="2"><span id="attribute-table"><div class="spinner-border" role="status"><span class="sr-only">Inspecting</span></div></span></td></tr></tbody>';
       $('.attribute-table-body').replaceWith(spinner);
       var wmsoptions = {
         URL: _this.data.url,

data/app/assets/stylesheets/geoblacklight/geoblacklight.scss

@@ -0,0 +1,2 @@
+@import 'leaflet';
+@import 'modules/base';

data/app/assets/stylesheets/geoblacklight/modules/_base.scss

@@ -0,0 +1,33 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ */
+
+@import 'styles';
+@import 'facets';
+@import 'mixins';
+@import 'icon-customization';
+@import 'home';
+@import 'index_maps';
+@import 'item';
+@import 'layer_opacity';
+@import 'metadata';
+@import 'metadata_content';
+@import 'metadata_missing';
+@import 'metadata_markup';
+@import 'modal';
+@import 'results';
+@import 'geosearch';
+@import 'search_widgets';
+@import 'sidebar';
+@import 'toolbar';
+@import 'web_services';
+@import 'blacklight_overrides';
+@import 'downloads';

data/app/assets/stylesheets/geoblacklight/{_blacklight_overrides.scss → modules/_blacklight_overrides.scss}

@@ -2,7 +2,7 @@
   Stylesheet for overriding styles inherited from Blacklight proper
 **/
 
-$logo-image: image_url('blacklight/logo.svg') !default
+$logo-image: image_url('blacklight/logo.svg') !default;
 
 .navbar-logo {  /* The main logo image for the Blacklight instance */
   @if $logo-image {

data/app/assets/stylesheets/geoblacklight/{_styles.scss → modules/_styles.scss}

@@ -1,4 +1,5 @@
 #table-container{
   overflow:scroll;
+  margin-top: 20px;
   max-height: 450px;
 }

data/app/assets/stylesheets/geoblacklight/modules/downloads.scss

@@ -1,91 +1,74 @@
-%downloads-exports {
-  .list-group-item {
-    display: inline-block;
-    width: 100%;
-  }
-}
-
-%download-export-links {
-  a {
-    width: 100%;
-    font-weight: 600;
-    background-color: $link-color;
-    color: #ffffff;
-    border-color: darken($link-color, 6.5%);
-    white-space: inherit;
-  }
-}
+// Common styling for the Downloads, Export, and Authentication cards
+.downloads,
+.card.exports,
+.authentication {
+  @include sidebar-children;
 
-@mixin download-export {
-  &-link {
-    &-container {
-      text-align: center;
-      @extend %download-export-links;
+  .list-group {
+    &.list-group-nested .list-group-item:last-child {
+      padding-bottom: 0;
     }
-  }
-}
 
-.downloads {
-  @include sidebar-children;
-  @extend %downloads-exports;
+    .list-group-item {
+      padding: 8px 20px;
 
-  .download {
-    @include download-export;
+      a {
+        @extend .btn-primary;
+      }
+    }
   }
 }
 
+// This section could be eliminated if we update the Authentication card
+// to follow the pattern of Dowloads and Exports (put the button in a
+// list-group rather than the card header).
 .authentication {
-  @include sidebar-children;
   .card-header {
     background-color: inherit;
     border-bottom: inherit;
 
-    @extend %download-export-links;
+    a {
+      @extend .btn-primary;
+    }
   }
 }
 
-.exports {
-  @include sidebar-children;
-  @extend %downloads-exports;
-
+// Specific to the Export card (mostly because of the current external
+// label + button approach, which could be mostly eliminated by reworking
+// as suggested in https://github.com/sul-dlss/earthworks/issues/646)
+.card.exports {
   .card-header {
-    .fa-spinner {
-      float: right;
+    .spinner-border { // if this is used, it probably should go in the card body rather than the card header
+      position: absolute;
+      right: 1rem;
+      top: 1rem;
     }
   }
 
   .export {
-    @include download-export;
-
-    padding-left: 0px;
-    padding-right: 0px;
     text-align: center;
-    width: 100%;
 
     @include media-breakpoint-up(xl) {
       text-align: left;
     }
 
-    &-label {
-      padding: 6px 12px;
+    .export-label {
+      padding: 6px 6px 6px 0;
 
       @include media-breakpoint-up(xl) {
         display: inline-block;
       }
     }
 
-    &-link {
-      &-container {
+    .export-link-container {
+      @include media-breakpoint-up(xl) {
+        display: inline-block;
+        float: right;
+      }
 
+      a {
         @include media-breakpoint-up(xl) {
-          display: inline-block;
-          float: right;
-        }
-
-        a {
-          @include media-breakpoint-up(xl) {
-            width: inherit;
-          }
+          width: inherit;
         }
       }
     }