geoblacklight 4.6.0 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3edf2add9fde8d7a1c2989e1270f37643cbb122193e3600b53b10a321a49e902
-  data.tar.gz: 6d0d433f55915af261e636ea4cf640515ffa3fec5a09379949ea992407f18ce6
+  metadata.gz: 34179258d33036e78dd04f3b8f5afc47b365bd3daba81c8873c48f97054ad8bf
+  data.tar.gz: b8302cd7bca3144905fb54aaa06f8d1999e96c6efebcde45046830e45031e1c6
 SHA512:
-  metadata.gz: e07eec26c77cdfe96295c17821db3afef88dadfd4bc31be80b9a4c473ffc0104f7c3fec0d2e7895b7cb79b84654e93029f2d18466d96eb21e745382babc0fc72
-  data.tar.gz: 8b940bf6241ef7343f36855c312c3a3f1459ee6e754457ac01a7dfed56e01cb31c990b027a3d422ccc48c68d6cf9ace81102ec225a326825cbfe1d83ed902558
+  metadata.gz: 7572c629e6892753b88b05c32b3acbbdb9c2251a03373049139d523941c0c732b3a79116ba804f0b432e4bf0715b15b8558013251d714c1ab420271b6d6961d8
+  data.tar.gz: 5843078946e57b56b0717b25c403244e972b0d45c2b97276861506266c1e94e01c8443e0c022dd0a4f3f4c4daad60291525a7b818b925c08a2669153c6f89ce9

data/.github/workflows/ruby.yml

@@ -14,7 +14,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: '3.2'
     - name: Install dependencies
       run: bundle install
     - name: Run linter

data/Gemfile

@@ -18,7 +18,6 @@ group :test do
   gem "rspec-rails", require: false
   gem "simplecov", require: false
   gem "standardrb", require: false
-  gem "webdrivers", require: false
   gem "webmock", require: false
 end
 

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

@@ -1,85 +1,63 @@
 // basemaps
 
-GeoBlacklight.Basemaps = {
-  darkMatter: L.tileLayer(
-    'https://{s}.basemaps.cartocdn.com/dark_all/{z}/{x}/{y}{retina}.png', {
-      attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
-      maxZoom: 18,
-      worldCopyJump: true,
-      retina: '@2x',
-      detectRetina: false
-    }
-  ),
-  positron: L.tileLayer(
-    'https://{s}.basemaps.cartocdn.com/light_all/{z}/{x}/{y}{retina}.png', {
-      attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
-      maxZoom: 18,
-      worldCopyJump: true,
-      retina: '@2x',
-      detectRetina: false
-    }
-  ),
-  positronLite: L.tileLayer(
-    'https://{s}.basemaps.cartocdn.com/light_nolabels/{z}/{x}/{y}{retina}.png', {
-      attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
-      maxZoom: 18,
-      worldCopyJump: true,
-      retina: '@2x',
-      detectRetina: false
-    }
-  ),
-  worldAntique: L.tileLayer(
-    'https://cartocdn_{s}.global.ssl.fastly.net/base-antique/{z}/{x}/{y}{retina}.png', {
-      attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
-      maxZoom: 18,
-      worldCopyJump: true,
-      retina: '@2x',
-      detectRetina: false
-    }
-  ),
-  worldEco: L.tileLayer(
-    'https://cartocdn_{s}.global.ssl.fastly.net/base-eco/{z}/{x}/{y}{retina}.png', {
-      attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
-      maxZoom: 18,
-      worldCopyJump: true,
-      retina: '@2x',
-      detectRetina: false
-    }
-  ),
-  flatBlue: L.tileLayer(
-    'https://cartocdn_{s}.global.ssl.fastly.net/base-flatblue/{z}/{x}/{y}{retina}.png', {
-      attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
-      maxZoom: 18,
-      worldCopyJump: true,
-      retina: '@2x',
-      detectRetina: false
-    }
-  ),
-  midnightCommander: L.tileLayer(
-    'https://cartocdn_{s}.global.ssl.fastly.net/base-midnight/{z}/{x}/{y}{retina}.png', {
-      attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
-      maxZoom: 18,
-      worldCopyJump: true,
-      retina: '@2x',
-      detectRetina: false
-    }
-  ),
-  openstreetmapHot: L.tileLayer(
-    'https://{s}.tile.openstreetmap.fr/hot/{z}/{x}/{y}.png', {
-      attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a>, Tiles courtesy of <a href="http://hot.openstreetmap.org/" target="_blank">Humanitarian OpenStreetMap Team</a>', 
-      maxZoom: 19,
-      worldCopyJump: true,
-      retina: '@2x',
-      detectRetina: false
-    }
-  ),
-  openstreetmapStandard: L.tileLayer(
-    'https://tile.openstreetmap.org/{z}/{x}/{y}.png', {
-      attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors',
-      maxZoom: 19,
-      worldCopyJump: true,
-      retina: '@2x',
-      detectRetina: false
-    }
-  )
+/**
+* Raster XYZ tile definitions for the basemaps GeoBlacklight ships with. Each
+* definition is passed to L.tileLayer as its options, so it carries the URL
+* template alongside the layer options it needs.
+*
+* Applications can change any of these, or add their own, by setting
+* LEAFLET.BASEMAPS in settings.yml. See selectBasemap in viewers/map.js.
+*/
+GeoBlacklight.BasemapDefinitions = {
+  darkMatter: {
+    url: 'https://{s}.basemaps.cartocdn.com/dark_all/{z}/{x}/{y}{retina}.png',
+    attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
+    maxZoom: 18,
+    worldCopyJump: true,
+    retina: '@2x',
+    detectRetina: false
+  },
+  positron: {
+    url: 'https://{s}.basemaps.cartocdn.com/light_all/{z}/{x}/{y}{retina}.png',
+    attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
+    maxZoom: 18,
+    worldCopyJump: true,
+    retina: '@2x',
+    detectRetina: false
+  },
+  positronLite: {
+    url: 'https://{s}.basemaps.cartocdn.com/light_nolabels/{z}/{x}/{y}{retina}.png',
+    attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
+    maxZoom: 18,
+    worldCopyJump: true,
+    retina: '@2x',
+    detectRetina: false
+  },
+  openstreetmapHot: {
+    url: 'https://{s}.tile.openstreetmap.fr/hot/{z}/{x}/{y}.png',
+    attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a>, Tiles courtesy of <a href="http://hot.openstreetmap.org/" target="_blank">Humanitarian OpenStreetMap Team</a>',
+    maxZoom: 19,
+    worldCopyJump: true,
+    retina: '@2x',
+    detectRetina: false
+  },
+  openstreetmapStandard: {
+    url: 'https://tile.openstreetmap.org/{z}/{x}/{y}.png',
+    attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors',
+    maxZoom: 19,
+    worldCopyJump: true,
+    retina: '@2x',
+    detectRetina: false
+  }
 };
+
+/**
+* Layer instances for the shipped definitions. Kept so that applications
+* referencing or replacing GeoBlacklight.Basemaps entries keep working.
+*/
+GeoBlacklight.Basemaps = {};
+
+Object.keys(GeoBlacklight.BasemapDefinitions).forEach(function(name) {
+  var definition = GeoBlacklight.BasemapDefinitions[name];
+  GeoBlacklight.Basemaps[name] = L.tileLayer(definition.url, definition);
+});

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

@@ -65,13 +65,30 @@ GeoBlacklight.Viewer.Map = GeoBlacklight.Viewer.extend({
 
   /**
   * Selects basemap if specified in data options, if not return positron.
+  *
+  * Applications can change a basemap's URL -- to add a CARTO API key, for
+  * example -- or define basemaps of their own by setting LEAFLET.BASEMAPS in
+  * settings.yml. Those values are merged over the shipped definition, so an
+  * override that gives only a url keeps the shipped attribution and zoom.
   */
   selectBasemap: function() {
-    var _this = this;
-    if (_this.data.basemap) {
-      return GeoBlacklight.Basemaps[_this.data.basemap];
-    } else {
-      return GeoBlacklight.Basemaps.positron;
+    var name = this.data.basemap || 'positron';
+    var options = this.data.leafletOptions || {};
+    var overrides = options.BASEMAPS || {};
+    var definition;
+
+    // A configured basemap wins, so an application can override a shipped one
+    if (overrides[name]) {
+      definition = L.extend(
+        {}, GeoBlacklight.BasemapDefinitions[name], overrides[name]
+      );
+      if (definition.url) {
+        return L.tileLayer(definition.url, definition);
+      }
     }
+
+    // Otherwise use the shipped layer, which an application may itself have
+    // replaced in GeoBlacklight.Basemaps
+    return GeoBlacklight.Basemaps[name] || GeoBlacklight.Basemaps.positron;
   }
 });

data/app/controllers/relation_controller.rb

@@ -2,6 +2,7 @@
 
 class RelationController < ApplicationController
   include Blacklight::Configurable
+
   # include Blacklight::SearchHelper
   copy_blacklight_config_from(CatalogController)
 

data/app/javascript/openlayers/basemaps.js

@@ -14,26 +14,6 @@ export  const openLayersBasemaps = {
     attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
     maxZoom: 18
   },
-  worldAntique: {
-    url: 'https://cartocdn_{a-d}.global.ssl.fastly.net/base-antique/{z}/{x}/{y}.png',
-    attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
-    maxZoom: 18
-  },
-  worldEco: {
-    url: 'https://cartocdn_{a-d}.global.ssl.fastly.net/base-eco/{z}/{x}/{y}.png',
-    attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
-    maxZoom: 18
-  },
-  flatBlue: {
-    url: 'https://cartocdn_{a-d}.global.ssl.fastly.net/base-flatblue/{z}/{x}/{y}.png',
-    attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
-    maxZoom: 18
-  },
-  midnightCommander: {
-    url: 'https://cartocdn_{a-d}.global.ssl.fastly.net/base-midnight/{z}/{x}/{y}.png',
-    attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributions">Carto</a>',
-      maxZoom: 18
-  },
   openstreetmapHot: {
     url: 'https://{a-c}.tile.openstreetmap.fr/hot/{z}/{x}/{y}.png',
     attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a>, Tiles courtesy of <a href="http://hot.openstreetmap.org/" target="_blank">Humanitarian OpenStreetMap Team</a>', 

data/app/javascript/openlayers/ol_initializer.js

@@ -33,17 +33,42 @@ export default class OlInitializer {
   }
 
   baseLayer () {
-    const basemap = openLayersBasemaps[this.data.basemap]
+    const basemap = this.basemapDefinition()
     const layer = new TileLayer({
       source: new XYZ({
         attributions: basemap["attribution"],
-        url: basemap["url"],
+        url: this.normalizeUrl(basemap["url"]),
         maxZoom: basemap["maxZoom"]
       })
     })
     return layer
   }
 
+  // The basemap to draw, with any BASEMAPS values from settings.yml merged
+  // over the shipped definition. This lets an application change a basemap's
+  // URL -- to add a CARTO API key, for example -- without restating the rest
+  // of the definition, and lets it define basemaps of its own.
+  basemapDefinition () {
+    const name = this.data.basemap || 'positron'
+    const definition = {
+      ...openLayersBasemaps[name],
+      ...this.basemapOverrides()[name]
+    }
+    if (definition.url) return definition
+    return openLayersBasemaps.positron
+  }
+
+  basemapOverrides () {
+    return JSON.parse(this.data.leafletOptions || '{}').BASEMAPS || {}
+  }
+
+  // Leaflet and OpenLayers spell tile URL templates differently, so accept
+  // the Leaflet form a configured basemap is most likely to be written in:
+  // {s} becomes OpenLayers' subdomain range, and {retina} drops out.
+  normalizeUrl (url) {
+    return url.replace(/\{s\}/g, '{a-d}').replace(/\{retina\}/g, '')
+  }
+
   initializePmtiles () {
     const vectorLayer = new VectorTile({
       declutter: true,

data/app/presenters/geoblacklight/document_presenter.rb

@@ -10,6 +10,7 @@ module Geoblacklight
   #   longer exists.
   class DocumentPresenter < Blacklight::IndexPresenter
     include ActionView::Helpers::OutputSafetyHelper
+
     ##
     # Presents configured index fields in search results. Passes values through
     # configured helper_method. Multivalued fields separated by presenter

data/geoblacklight.gemspec

@@ -35,11 +35,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-rails"
   spec.add_development_dependency "engine_cart", "~> 2.0"
   spec.add_development_dependency "capybara", ">= 2.5.0"
-  spec.add_development_dependency "selenium-webdriver"
+  spec.add_development_dependency "selenium-webdriver", ">= 4.11"
   spec.add_development_dependency "factory_bot_rails"
   spec.add_development_dependency "database_cleaner", "~> 2.0"
   spec.add_development_dependency "simplecov", "~> 0.22"
   spec.add_development_dependency "foreman"
-  spec.add_development_dependency "standardrb", "1.0.1"
+  spec.add_development_dependency "standard", "~> 1.56.0"
   spec.add_development_dependency "webmock", "~> 3.14"
 end

data/lib/generators/geoblacklight/install_generator.rb

@@ -124,7 +124,7 @@ module Geoblacklight
       if propshaft_present
         gsub_file "Gemfile", /^(\s*gem\s+["']propshaft["'].*)$/, '# \1'
       end
-      unless gemfile.match?(/gem ['\"]sprockets-rails['\"]/)
+      unless gemfile.match?(/gem ['"]sprockets-rails['"]/)
         append_to_file "Gemfile" do
           "\ngem 'sprockets-rails'\n"
         end

data/lib/generators/geoblacklight/templates/catalog_controller.rb

@@ -317,12 +317,11 @@ class CatalogController < ApplicationController
     # 'positron'
     # 'darkMatter'
     # 'positronLite'
-    # 'worldAntique'
-    # 'worldEco'
-    # 'flatBlue'
-    # 'midnightCommander'
     # 'openstreetmapHot'
     # 'openstreetmapStandard'
+    #
+    # To change one of these basemaps' tile URLs, or to add a basemap of your
+    # own and name it here, set LEAFLET.BASEMAPS in settings.yml
 
     config.basemap_provider = "positron"
 

data/lib/generators/geoblacklight/templates/settings.yml

@@ -229,6 +229,25 @@ WMS_PARAMS:
 # Settings for leaflet
 LEAFLET:
   MAP:
+  # Basemap definitions, keyed by the name config.basemap_provider selects.
+  # Anything set here is merged over the basemap GeoBlacklight ships with, so
+  # you can change just the url and keep the rest of the definition.
+  #
+  # CARTO now watermarks raster tiles requested without an API key, which
+  # affects the positron, positronLite and darkMatter basemaps. Request a free
+  # key at https://carto.com/basemaps/apikey/ and pass it as a key parameter:
+  # BASEMAPS:
+  #   positron:
+  #     url: 'https://basemaps.cartocdn.com/light_all/{z}/{x}/{y}.png?key=YOUR_KEY'
+  #   darkMatter:
+  #     url: 'https://basemaps.cartocdn.com/dark_all/{z}/{x}/{y}.png?key=YOUR_KEY'
+  #
+  # You can also define a basemap of your own here and select it with
+  # config.basemap_provider = 'myBasemap' in your CatalogController:
+  #   myBasemap:
+  #     url: 'https://tiles.example.edu/{z}/{x}/{y}.png'
+  #     attribution: 'Tiles courtesy of Example University'
+  #     maxZoom: 18
   LAYERS:
     DETECT_RETINA: true
     INDEX:

data/lib/geoblacklight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Geoblacklight
-  VERSION = "4.6.0"
+  VERSION = "4.7.0"
 end

data/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@geoblacklight/frontend",
   "type": "module",
-  "version": "4.6.0",
+  "version": "4.7.0",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public"

data/spec/features/configurable_basemap_spec.rb

@@ -34,4 +34,60 @@ feature "Configurable basemap", js: true do
       expect(page).to have_css "img[src*='hot']"
     end
   end
+  feature "with a configured tile URL for a shipped basemap" do
+    before do
+      CatalogController.blacklight_config.basemap_provider = "positron"
+      Settings.LEAFLET.BASEMAPS = {
+        positron: {
+          url: "https://basemaps.cartocdn.com/light_all/{z}/{x}/{y}.png?key=fake-carto-key"
+        }
+      }
+    end
+    after { Settings.LEAFLET.BASEMAPS = nil }
+
+    scenario "requests tiles from the configured URL" do
+      visit root_path
+      expect(page).to have_css "img[src*='key=fake-carto-key']"
+    end
+    scenario "keeps the attribution from the shipped definition" do
+      visit root_path
+      expect(page).to have_css ".leaflet-control-attribution", text: "Carto"
+    end
+  end
+  feature "with a basemap the application defines itself" do
+    before do
+      CatalogController.blacklight_config.basemap_provider = "myBasemap"
+      Settings.LEAFLET.BASEMAPS = {
+        myBasemap: {
+          url: "/tiles/{z}/{x}/{y}.png",
+          attribution: "Tiles courtesy of Example University",
+          maxZoom: 18
+        }
+      }
+    end
+    after { Settings.LEAFLET.BASEMAPS = nil }
+
+    scenario "requests tiles from the application's basemap" do
+      visit root_path
+      # visible: :all because these tiles 404, so the images have no dimensions
+      expect(page).to have_css "img[src*='/tiles/']", visible: :all
+    end
+    scenario "credits the application's basemap" do
+      visit root_path
+      expect(page).to have_css ".leaflet-control-attribution",
+        text: "Tiles courtesy of Example University"
+    end
+  end
+  feature "using a basemap GeoBlacklight no longer ships" do
+    before do
+      # worldEco was one of the CARTO basemaps served from the retired
+      # cartocdn fastly endpoints; applications still naming one should get a
+      # working basemap rather than none
+      CatalogController.blacklight_config.basemap_provider = "worldEco"
+    end
+    scenario "falls back to positron rather than drawing no basemap" do
+      visit root_path
+      expect(page).to have_css "img[src*='light_all']", visible: :all
+    end
+  end
 end

data/spec/lib/geoblacklight/view_helper_override_spec.rb

@@ -4,6 +4,7 @@ require "spec_helper"
 
 class GeoblacklightControllerTestClass
   include AbstractController::Translation
+
   attr_accessor :params
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geoblacklight
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.7.0
 platform: ruby
 authors:
 - Mike Graves
@@ -10,7 +10,7 @@ authors:
 - Jack Reed
 bindir: bin
 cert_chain: []
-date: 2026-09-01 00:00:00.000000000 Z
+date: 2026-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -268,14 +268,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.11'
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -333,19 +333,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: standardrb
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.56.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.56.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement