geoblacklight 3.0.0 → 3.3.1

data/README.md

@@ -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

@@ -26,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'
@@ -43,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
@@ -55,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
@@ -121,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/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/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);

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);

data/app/assets/stylesheets/geoblacklight/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/modules/results.scss

@@ -1,4 +1,4 @@
-[data-map="index"] {
+[data-map="index"], [data-map="bookmarks"] {
   height: 480px;
 }
 

data/app/helpers/geoblacklight_helper.rb

@@ -173,7 +173,7 @@ module GeoblacklightHelper
     if I18n.exists?("geoblacklight.help_text.#{feature}.#{key}", locale)
       help_text = I18n.t("geoblacklight.help_text.#{feature}.#{key}")
       tag.h3 class: 'help-text viewer_protocol h6' do
-        tag.a 'data': { toggle: 'popover', title: help_text[:title], content: help_text[:content] } do
+        tag.a data: { toggle: 'popover', title: help_text[:title], content: help_text[:content] } do
           help_text[:title]
         end
       end
@@ -280,6 +280,18 @@ module GeoblacklightHelper
     icon_name = icon if icon_name.blank?
     icon_options = {}
     icon_options = { classes: 'svg_tooltip' } if Settings.USE_GEOM_FOR_RELATIONS_ICON
-    geoblacklight_icon(icon_name, icon_options)
+    geoblacklight_icon(icon_name, **icon_options)
+  end
+
+  ## Returns the data-map attribute value used as the JS map selector
+  def results_js_map_selector(controller_name)
+    case controller_name
+    when 'bookmarks'
+      'bookmarks'
+    when 'catalog'
+      'index'
+    else
+      'index'
+    end
   end
 end

data/app/models/concerns/geoblacklight/solr_document.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 module Geoblacklight
-  # Extends Blacklight::Solr::Document for GeoBlacklight specific functionalit
+  # Extends Blacklight::Solr::Document for GeoBlacklight specific functionality
   module SolrDocument
     extend Blacklight::Solr::Document
 
@@ -70,18 +71,12 @@ module Geoblacklight
       'http://schema.org/Dataset'
     end
 
-    def bounding_box_as_wsen
-      geom_field = fetch(Settings.FIELDS.GEOMETRY, '')
-      exp = /^\s*ENVELOPE\(
-                  \s*([-\.\d]+)\s*,
-                  \s*([-\.\d]+)\s*,
-                  \s*([-\.\d]+)\s*,
-                  \s*([-\.\d]+)\s*
-                  \)\s*$/x # uses 'x' option for free-spacing mode
-      bbox_match = exp.match(geom_field)
-      return geom_field unless bbox_match # return as-is, not a WKT
-      w, e, n, s = bbox_match.captures
-      "#{w} #{s} #{e} #{n}"
+    def geom_field
+      fetch(Settings.FIELDS.GEOMETRY, '')
+    end
+
+    def geometry
+      @geometry ||= Geoblacklight::Geometry.new(geom_field)
     end
 
     def wxs_identifier

data/app/models/concerns/geoblacklight/spatial_search_behavior.rb

@@ -23,7 +23,7 @@ module Geoblacklight
         if Settings.OVERLAP_RATIO_BOOST
           solr_params[:bf] ||= []
           solr_params[:overlap] =
-            "{!field uf=* defType=lucene f=solr_bboxtype score=overlapRatio}Intersects(#{envelope_bounds})"
+            "{!field uf=* defType=lucene f=#{Settings.FIELDS.OVERLAP_FIELD} score=overlapRatio}Intersects(#{envelope_bounds})"
           solr_params[:bf] << "$overlap^#{Settings.OVERLAP_RATIO_BOOST}"
         end
       end
@@ -62,10 +62,10 @@ module Geoblacklight
 
       # Do not suppress action_documents method calls for individual documents
       # ex. CatalogController#web_services (exportable views)
-      return if solr_params[:q]&.include?('{!lucene}layer_slug_s:')
+      return if solr_params[:q]&.include?("{!lucene}#{Settings.FIELDS.UNIQUE_KEY}:")
 
       solr_params[:fq] ||= []
-      solr_params[:fq] << '-suppressed_b: true'
+      solr_params[:fq] << "-#{Settings.FIELDS.SUPPRESSED}: true"
     end
   end
 end

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

@@ -2,5 +2,5 @@
   <div id="documents" class="documents-list col-md-6">
     <%= render documents, :as => :document %>
   </div>
-  <%= content_tag :div, '', id: 'map', class: 'col-md-6', aria: { label: t('geoblacklight.map.label') }, data: { map: 'index', 'catalog-path'=> search_catalog_path , 'map-bbox' => params[:bbox], basemap: geoblacklight_basemap, leaflet_options: leaflet_options } %>
+  <%= content_tag :div, '', id: 'map', class: 'col-md-6', aria: { label: t('geoblacklight.map.label') }, data: { map: results_js_map_selector(controller.controller_name), 'catalog-path'=> search_catalog_path , 'map-bbox' => params[:bbox], basemap: geoblacklight_basemap, leaflet_options: leaflet_options } %>
 </div>

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

@@ -40,7 +40,7 @@
       <%= content_tag :div, '', id: 'map', aria: { label: t('geoblacklight.map.label') }, data: { map: 'home', 'catalog-path'=> search_catalog_path , 'map-bbox' => params[:bbox], basemap: geoblacklight_basemap, leaflet_options: leaflet_options } %>
     </div>
   </div>
-  <div class="text-right">
+  <div id="geoblacklight-version" class="text-right">
     <%= t('geoblacklight.home.version', version: Geoblacklight::VERSION ) %>
   </div>
 </div>

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

@@ -1,5 +1,5 @@
 <% # header bar for doc items in index view -%>
-<%= content_tag :div, class: 'documentHeader index-split row', data: { layer_id: document.id, bbox: document.bounding_box_as_wsen } do %>
+<%= content_tag :div, class: 'documentHeader index-split row', data: { layer_id: document.id, geom: document.geometry.geojson } do %>
   <h3 class="index_title col">
     <% counter = document_counter_with_offset(document_counter) %>
     <span class="document-counter">

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

@@ -6,7 +6,7 @@
       <%= render_help_text_entry('viewer_protocol', document.viewer_protocol) %>
     <% end %>
 
-    <%= content_tag :div, id: 'map', aria: { label: t('geoblacklight.map.label') }, data: { map: 'item', protocol: document.viewer_protocol.camelize, url: document.viewer_endpoint, 'layer-id' => document.wxs_identifier, 'map-bbox' => document.bounding_box_as_wsen, 'catalog-path'=> search_catalog_path, available: document_available?, inspect: show_attribute_table?, basemap: geoblacklight_basemap, leaflet_options: leaflet_options } do %>
+    <%= content_tag :div, id: 'map', aria: { label: t('geoblacklight.map.label') }, data: { map: 'item', protocol: document.viewer_protocol.camelize, url: document.viewer_endpoint, 'layer-id' => document.wxs_identifier, 'map-geom' => document.geometry.geojson, 'catalog-path'=> search_catalog_path, available: document_available?, inspect: show_attribute_table?, basemap: geoblacklight_basemap, leaflet_options: leaflet_options } do %>
     <% end %>
   </div>
 </div>

data/app/views/download/hgl.html.erb

@@ -1,25 +1,27 @@
 <div class="modal-header">
-  <button type="button" class="close" data-dismiss="modal">
+  <h1 class="modal-title"><%= t('geoblacklight.download.hgl_request') %></h1>
+  <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
     <span aria-hidden="true">&times;</span>
   </button>
- <%= content_tag :h4, t('geoblacklight.download.hgl_request'), class: 'text-center' %>
 </div>
 <div class="modal-body">
   <form class="form-horizontal" role="form" id="hglRequest">
     <p><%= t('geoblacklight.download.hgl_instructions')%></p>
     <div class="form-group">
-      <label for="requestEmail" class="col-sm-2 control-label"><%= t('geoblacklight.download.hgl_email')%></label>
-      <div class="col-sm-6">
-        <input class="form-control" type="email" id="requestEmail" />
-      </div>
-      <input type="hidden" id="requestUrl"
-        value="<%= download_hgl_path(id: @document) %>" />
-      <div class="col-sm-2">
-        <button type="submit" class="btn btn-primary"><%= t('geoblacklight.download.hgl_request_button')%></button>
+      <div class="row">
+        <label for="requestEmail" class="col-sm-2 control-label"><%= t('geoblacklight.download.hgl_email')%></label>
+        <div class="col-sm-6">
+          <input class="form-control" type="email" id="requestEmail" />
+        </div>
+        <input type="hidden" id="requestUrl"
+          value="<%= download_hgl_path(id: @document) %>" />
+        <div class="col-sm-2">
+          <button type="submit" class="btn btn-primary"><%= t('geoblacklight.download.hgl_request_button')%></button>
+        </div>
       </div>
     </div>
   </form>
 </div>
 <div class="modal-footer">
-  <button type="button" class="btn btn-default" data-dismiss="modal"><%= t('geoblacklight.download.hgl_close')%></button>
+  <button type="button" class="btn btn-default hide-without-js" data-dismiss="modal"><%= t('geoblacklight.references.services_close')%></button>
 </div>