geoblacklight 4.5.1 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70ec0fdb43d31e4d9c2d4d5902e5a5d19ea35a6171e6b37f74d9a3fbfd937661
-  data.tar.gz: f4b212c5ec24ee1c4c0263e8c0e1ba2c51c0ebcd7e70cf32ae5ccfe6e0a78d15
+  metadata.gz: 34179258d33036e78dd04f3b8f5afc47b365bd3daba81c8873c48f97054ad8bf
+  data.tar.gz: b8302cd7bca3144905fb54aaa06f8d1999e96c6efebcde45046830e45031e1c6
 SHA512:
-  metadata.gz: 9a6612a445ce525cd2610b4cc0c83a509a523b13e27ea3ee6314ee5f48cbb6da479f9e103c50ae75312911780e39740db155c9d1b6015a05e5dddd71e2237710
-  data.tar.gz: 0fc319d965119d9d7dd79456930fd6f4c32288d68967b9f408adf2da44c4096c7e99f39fe8e575021ef515f705a69e61f7513869774d7a87373972bcbfebebaa
+  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/download_controller.rb

@@ -37,7 +37,12 @@ class DownloadController < ApplicationController
     send_file download_file_path_and_name, x_sendfile: true
   end
 
+  # @deprecated
   def hgl
+    Geoblacklight.deprecation.warn(
+      "DownloadController#hgl and the download_hgl route are deprecated; the Harvard " \
+      "Geospatial Library download integration is removed without replacement in GeoBlacklight 5"
+    )
     @response, @document = search_service.fetch params[:id]
     if params[:email]
       response = Geoblacklight::HglDownload.new(@document, params[:email]).get

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/helpers/arcgis_helper.rb

@@ -5,10 +5,13 @@ module ArcgisHelper
   # Generates an ArcGIS.com viewer url with params that can open content
   # directly
   # See: https://doc.arcgis.com/en/arcgis-online/reference/use-url-parameters.htm
+  # @deprecated
   def arcgis_link(arcgis_urls)
     params = URI.encode_www_form(
       urls: arcgis_urls
     )
     Settings.ARCGIS_BASE_URL + "?" + params
   end
+  Geoblacklight.deprecation.deprecate_methods(ArcgisHelper,
+    arcgis_link: "use Geoblacklight::ArcgisComponent instead")
 end

data/app/helpers/blacklight_helper.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
+# @deprecated GeoBlacklight 5 no longer ships a BlacklightHelper override. The
+#   relations container is rendered by Geoblacklight::Document::SidebarComponent
+#   instead. Applications that define their own BlacklightHelper are unaffected.
 module BlacklightHelper
   include Blacklight::BlacklightHelperBehavior
   include Geoblacklight::GeoblacklightHelperBehavior
   include Blacklight::CatalogHelperBehavior
 
+  # @deprecated
   def render_document_sidebar_partial(document = @document)
     super + (render "relations_container", document: document)
   end

data/app/helpers/carto_helper.rb

@@ -5,6 +5,7 @@ module CartoHelper
   # Creates a Carto OneClick link, using the configuration link
   # @param [String] file_link
   # @return [String]
+  # @deprecated
   def carto_link(file_link)
     params = URI.encode_www_form(
       file: file_link,
@@ -17,9 +18,13 @@ module CartoHelper
   ##
   # Removes blank space from provider to accomodate Carto OneClick
   #
+  # @deprecated
   def carto_provider
     application_name.delete(" ")
   end
+  Geoblacklight.deprecation.deprecate_methods(CartoHelper,
+    carto_link: "the Carto OneClick integration is removed without replacement in GeoBlacklight 5",
+    carto_provider: "the Carto OneClick integration is removed without replacement in GeoBlacklight 5")
 
   private
 

data/app/helpers/geoblacklight/geoblacklight_helper_behavior.rb

@@ -3,6 +3,9 @@
 ##
 # Adds helper behavior logic for GeoBlacklight, to used alongside
 # BlacklightHelperBehavior
+#
+# @deprecated This module is removed in GeoBlacklight 5. Search result
+#   presentation moved to Geoblacklight::SearchResultComponent.
 module Geoblacklight
   module GeoblacklightHelperBehavior
     include Blacklight::BlacklightHelperBehavior
@@ -11,8 +14,11 @@ module Geoblacklight
     # Calls the presenter on the requested method
     # @param [Symbol, String] presenting_method
     # @return [String]
+    # @deprecated
     def geoblacklight_present(presenting_method, document = @document)
-      document_presenter(document).try(presenting_method.to_sym) || ""
+      Geoblacklight.deprecation.silence { document_presenter(document).try(presenting_method.to_sym) } || ""
     end
+    Geoblacklight.deprecation.deprecate_methods(Geoblacklight::GeoblacklightHelperBehavior,
+      geoblacklight_present: "use Geoblacklight::SearchResultComponent instead")
   end
 end

data/app/helpers/geoblacklight_helper.rb

@@ -5,14 +5,20 @@ module GeoblacklightHelper
     @document.public? || (@document.same_institution? && user_signed_in?)
   end
 
+  # @deprecated
   def document_downloadable?
     document_available? && @document.downloadable?
   end
 
+  # @deprecated
   def iiif_jpg_url
     @document.references.iiif.endpoint.sub! "info.json", "full/full/0/default.jpg"
   end
+  Geoblacklight.deprecation.deprecate_methods(GeoblacklightHelper,
+    document_downloadable?: "use Geoblacklight::DownloadLinksComponent instead",
+    iiif_jpg_url: "use Geoblacklight::DownloadLinksComponent instead")
 
+  # @deprecated
   def download_link_file(label, id, url)
     link_to(
       label,
@@ -26,6 +32,7 @@ module GeoblacklightHelper
     )
   end
 
+  # @deprecated
   def download_link_hgl(text, document)
     link_to(
       text,
@@ -41,20 +48,24 @@ module GeoblacklightHelper
 
   # Generates the link markup for the IIIF JPEG download
   # @return [String]
+  # @deprecated
   def download_link_iiif
-    link_to(
-      download_text("JPG"),
-      iiif_jpg_url,
-      "contentUrl" => iiif_jpg_url,
-      :data => {
-        download: "trigger"
-      }
-    )
+    Geoblacklight.deprecation.silence do
+      link_to(
+        download_text("JPG"),
+        iiif_jpg_url,
+        "contentUrl" => iiif_jpg_url,
+        :data => {
+          download: "trigger"
+        }
+      )
+    end
   end
 
+  # @deprecated
   def download_link_generated(download_type, document)
     link_to(
-      t("geoblacklight.download.export_link", download_format: export_format_label(download_type)),
+      t("geoblacklight.download.export_link", download_format: Geoblacklight.deprecation.silence { export_format_label(download_type) }),
       "",
       data: {
         download_path: download_path(document.id, type: download_type),
@@ -64,6 +75,11 @@ module GeoblacklightHelper
       }
     )
   end
+  Geoblacklight.deprecation.deprecate_methods(GeoblacklightHelper,
+    download_link_file: "use Geoblacklight::DownloadLinksComponent instead",
+    download_link_iiif: "use Geoblacklight::DownloadLinksComponent instead",
+    download_link_generated: "use Geoblacklight::DownloadLinksComponent instead",
+    download_link_hgl: "the Harvard Geospatial Library download integration is removed without replacement in GeoBlacklight 5")
 
   ##
   # Blacklight catalog controller helper method to truncate field value to 150 chars
@@ -91,14 +107,19 @@ module GeoblacklightHelper
   ##
   # Looks up properly formatted names for formats
   #
+  # @deprecated
   def proper_case_format(format)
     t("geoblacklight.formats.#{format.to_s.parameterize(separator: "_")}")
   end
 
   # Format labels are customized for exports - look up the appropriate key.
+  # @deprecated
   def export_format_label(format)
     t("geoblacklight.download.export_#{format.to_s.parameterize(separator: "_")}_link")
   end
+  Geoblacklight.deprecation.deprecate_methods(GeoblacklightHelper,
+    proper_case_format: "use Geoblacklight::DownloadLinksComponent instead",
+    export_format_label: "use Geoblacklight::DownloadLinksComponent instead")
 
   ##
   # Looks up formatted names for references
@@ -111,15 +132,19 @@ module GeoblacklightHelper
   ##
   # Wraps download text with proper_case_format
   #
+  # @deprecated
   def download_text(format)
-    download_format = proper_case_format(format)
+    download_format = Geoblacklight.deprecation.silence { proper_case_format(format) }
     value = t("geoblacklight.download.download_link", download_format: download_format)
     value.html_safe
   end
+  Geoblacklight.deprecation.deprecate_methods(GeoblacklightHelper,
+    download_text: "use Geoblacklight::DownloadLinksComponent instead")
 
   ##
   # Deteremines if a feature should include help text popover
   # @return [Boolean]
+  # @deprecated
   def show_help_text?(feature, key)
     Settings&.HELP_TEXT&.send(feature)&.include?(key)
   end
@@ -127,6 +152,7 @@ module GeoblacklightHelper
   ##
   # Render help text popover for a given feature and translation key
   # @return [HTML tag]
+  # @deprecated
   def render_help_text_entry(feature, key)
     if I18n.exists?("geoblacklight.help_text.#{feature}.#{key}", locale)
       help_text = I18n.t("geoblacklight.help_text.#{feature}.#{key}")
@@ -139,20 +165,29 @@ module GeoblacklightHelper
       tag.span class: "help-text translation-missing"
     end
   end
+  Geoblacklight.deprecation.deprecate_methods(GeoblacklightHelper,
+    show_help_text?: "use Geoblacklight::ViewerHelpTextComponent instead",
+    render_help_text_entry: "use Geoblacklight::ViewerHelpTextComponent instead")
 
   ##
   # Determines if item view should render the sidebar static map
   # @return [Boolean]
+  # @deprecated
   def render_sidebar_map?(document)
-    Settings.SIDEBAR_STATIC_MAP&.any? { |vp| document.viewer_protocol == vp }
+    Geoblacklight.deprecation.silence { Settings.SIDEBAR_STATIC_MAP&.any? { |vp| document.viewer_protocol == vp } }
   end
+  Geoblacklight.deprecation.deprecate_methods(GeoblacklightHelper,
+    render_sidebar_map?: "use Geoblacklight::StaticMapComponent instead")
 
   ##
   # Deteremines if item view should include attribute table
   # @return [Boolean]
+  # @deprecated
   def show_attribute_table?
     document_available? && @document.inspectable?
   end
+  Geoblacklight.deprecation.deprecate_methods(GeoblacklightHelper,
+    show_attribute_table?: "use Geoblacklight::AttributeTableComponent instead")
 
   ##
   # Render value for a document's field as a truncate abstract
@@ -176,6 +211,7 @@ module GeoblacklightHelper
   # Renders the partials for a Geoblacklight::Reference in the web services
   # modal
   # @param [Geoblacklight::Reference]
+  # @deprecated
   def render_web_services(reference)
     render(
       partial: "web_services_#{reference.type}",
@@ -184,6 +220,8 @@ module GeoblacklightHelper
   rescue ActionView::MissingTemplate
     render partial: "web_services_default", locals: {reference: reference}
   end
+  Geoblacklight.deprecation.deprecate_methods(GeoblacklightHelper,
+    render_web_services: "use Geoblacklight::WebServicesComponent instead")
 
   ##
   # Returns a hash of the leaflet plugin settings to pass to the viewer.
@@ -246,28 +284,33 @@ module GeoblacklightHelper
     end
   end
 
+  # @deprecated
   def viewer_container
-    if openlayers_container?
-      ol_viewer
-    elsif iiif_manifest_container?
-      iiif_manifest_viewer
-    else
-      leaflet_viewer
+    Geoblacklight.deprecation.silence do
+      if openlayers_container?
+        ol_viewer
+      elsif iiif_manifest_container?
+        iiif_manifest_viewer
+      else
+        leaflet_viewer
+      end
     end
   end
 
+  # @deprecated
   def openlayers_container?
     return false unless @document
     @document.item_viewer.pmtiles || @document.item_viewer.cog
   end
 
+  # @deprecated
   def leaflet_viewer
     tag.div(nil,
       id: "map",
       data: {
-        :map => "item", :protocol => @document.viewer_protocol.camelize,
+        :map => "item", :protocol => Geoblacklight.deprecation.silence { @document.viewer_protocol }.camelize,
         :url => @document.viewer_endpoint,
-        "layer-id" => @document.wxs_identifier,
+        "layer-id" => Geoblacklight.deprecation.silence { @document.wxs_identifier },
         "map-geom" => @document.geometry.geojson,
         "catalog-path" => search_catalog_path,
         :available => document_available?,
@@ -276,13 +319,14 @@ module GeoblacklightHelper
       })
   end
 
+  # @deprecated
   def ol_viewer
     tag.div(nil,
       id: "ol-map",
       data: {
-        :map => "item", :protocol => @document.viewer_protocol.camelize,
+        :map => "item", :protocol => Geoblacklight.deprecation.silence { @document.viewer_protocol }.camelize,
         :url => @document.viewer_endpoint,
-        "layer-id" => @document.wxs_identifier,
+        "layer-id" => Geoblacklight.deprecation.silence { @document.wxs_identifier },
         "map-geom" => @document.geometry.geojson,
         "catalog-path" => search_catalog_path,
         :available => document_available?,
@@ -291,12 +335,21 @@ module GeoblacklightHelper
       })
   end
 
+  # @deprecated
   def iiif_manifest_container?
     return false unless @document
     @document&.item_viewer&.viewer_preference&.key?(:iiif_manifest)
   end
 
+  # @deprecated
   def iiif_manifest_viewer
     tag.div(nil, id: "clover-viewer", iiif_content: @document.viewer_endpoint)
   end
+  Geoblacklight.deprecation.deprecate_methods(GeoblacklightHelper,
+    viewer_container: "use Geoblacklight::ItemMapViewerComponent instead",
+    openlayers_container?: "use Geoblacklight::ItemMapViewerComponent instead",
+    leaflet_viewer: "use Geoblacklight::ItemMapViewerComponent instead",
+    ol_viewer: "use Geoblacklight::ItemMapViewerComponent instead",
+    iiif_manifest_container?: "use Geoblacklight::ItemMapViewerComponent instead",
+    iiif_manifest_viewer: "use Geoblacklight::ItemMapViewerComponent instead")
 end

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/models/concerns/geoblacklight/solr_document/carto.rb

@@ -4,14 +4,21 @@ module Geoblacklight
   module SolrDocument
     ##
     # Module for providing external Carto download references for a document
+    #
+    # @deprecated The Carto OneClick integration is removed without replacement
+    #   in GeoBlacklight 5. Remove the `:carto` show tools partial from your
+    #   CatalogController before upgrading.
     module Carto
       ##
       # Returns a url to a file that should be used with CartoDB integration
       # @return [String]
+      # @deprecated
       def carto_reference
         return unless public? && download_types.try(:[], :geojson).present?
         Geoblacklight::GeojsonDownload.new(self).url_with_params
       end
+      Geoblacklight.deprecation.deprecate_methods(Geoblacklight::SolrDocument::Carto,
+        carto_reference: "the Carto OneClick integration is removed without replacement in GeoBlacklight 5")
     end
   end
 end