geoblacklight 5.2.0 → 5.4.0

data/app/javascript/geoblacklight/openlayers/basemaps.js

@@ -14,26 +14,6 @@ export default {
     attributions: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributionss">Carto</a>',
     maxZoom: 18
   },
-  worldAntique: {
-    url: 'https://cartocdn_{a-d}.global.ssl.fastly.net/base-antique/{z}/{x}/{y}.png',
-    attributions: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributionss">Carto</a>',
-    maxZoom: 18
-  },
-  worldEco: {
-    url: 'https://cartocdn_{a-d}.global.ssl.fastly.net/base-eco/{z}/{x}/{y}.png',
-    attributions: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributionss">Carto</a>',
-    maxZoom: 18
-  },
-  flatBlue: {
-    url: 'https://cartocdn_{a-d}.global.ssl.fastly.net/base-flatblue/{z}/{x}/{y}.png',
-    attributions: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributionss">Carto</a>',
-    maxZoom: 18
-  },
-  midnightCommander: {
-    url: 'https://cartocdn_{a-d}.global.ssl.fastly.net/base-midnight/{z}/{x}/{y}.png',
-    attributions: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://carto.com/attributionss">Carto</a>',
-      maxZoom: 18
-  },
   openstreetmapHot: {
     url: 'https://{a-c}.tile.openstreetmap.fr/hot/{z}/{x}/{y}.png',
     attributions: '&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/geoblacklight/openlayers/layers.js

@@ -38,7 +38,7 @@ export const cogLayer = (url) => {
   return new WebGLTileLayer({
     source: new GeoTIFF({
       sources: [{ url }],
-      convertToRGB: true,
+      convertToRGB: "auto",
     }),
   });
 };

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

@@ -31,6 +31,22 @@ module Geoblacklight
       attribute :format, :string, Settings.FIELDS.FORMAT
     end
 
+    ##
+    # Warn once per reader name rather than once per document: a search results page
+    # would otherwise emit one warning per result, because
+    # ActiveSupport::Deprecation does not deduplicate.
+    # @param method [Symbol]
+    def self.warn_about_url_reader(method)
+      @warned_url_readers ||= Set.new
+      return unless @warned_url_readers.add?(method)
+
+      Geoblacklight.deprecation.warn(
+        "SolrDocument##{method} is resolved dynamically by Geoblacklight::SolrDocument#method_missing, " \
+        "which GeoBlacklight 6 removes; call references.#{method.to_s.delete_suffix("_url")}&.endpoint " \
+        "instead"
+      )
+    end
+
     def available?
       public? || same_institution?
     end
@@ -44,7 +60,7 @@ module Geoblacklight
     end
 
     def downloadable?
-      (direct_download || download_types.present? || iiif_download) && available?
+      Geoblacklight.deprecation.silence { direct_download || download_types.present? || iiif_download } && available?
     end
 
     def references
@@ -101,7 +117,8 @@ module Geoblacklight
 
     def method_missing(method, *args, &block)
       if /.*_url$/.match?(method.to_s)
-        checked_endpoint(method.to_s.gsub("_url", ""))
+        Geoblacklight::SolrDocument.warn_about_url_reader(method)
+        Geoblacklight.deprecation.silence { checked_endpoint(method.to_s.gsub("_url", "")) }
       else
         super
       end

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

@@ -1,3 +1,5 @@
+<%# Removed in GeoBlacklight 6. The deprecated helpers it calls are silenced here so that a stock application is not warned once per request; Geoblacklight::DeprecatedConfiguration warns at boot if an application overrides it. %>
+<% Geoblacklight.deprecation.silence do %>
 <% document ||= @documents.first %>
 
 <div class='metadata-view'>
@@ -25,3 +27,4 @@
     <% end %>
   </div>
 </div>
+<% end %>

data/config/importmap.rb

@@ -3,18 +3,12 @@
 # OpenLayers viewer
 pin "ol", to: "https://esm.sh/ol@8.1.0"
 pin "ol/", to: "https://esm.sh/ol@8.1.0/"
-pin "ol-pmtiles", to: "https://cdn.skypack.dev/ol-pmtiles@0.3.0"
+pin "ol-pmtiles", to: "https://cdn.jsdelivr.net/npm/ol-pmtiles@0.3.0/+esm"
 
 # Leaflet viewer
-pin "leaflet", to: "https://cdn.skypack.dev/leaflet@1.9.4"
-pin "esri-leaflet", to: "https://cdn.skypack.dev/esri-leaflet@3.0.12"
-pin "leaflet-fullscreen", to: "https://cdn.skypack.dev/leaflet-fullscreen@1.0.2"
-
-# Clover viewer
-pin "react", to: "https://esm.sh/react@18.3.1"
-pin "react-dom/client", to: "https://esm.sh/react-dom@18.3.1/client"
-pin "@samvera/clover-iiif/viewer", to: "https://esm.sh/@samvera/clover-iiif@2.10.0/dist/viewer"
-pin "@samvera/clover-iiif/image", to: "https://esm.sh/@samvera/clover-iiif@2.10.0/dist/image"
+pin "leaflet", to: "https://cdn.jsdelivr.net/npm/leaflet@1.9.4/dist/leaflet-src.esm.js"
+pin "esri-leaflet", to: "https://cdn.jsdelivr.net/npm/esri-leaflet@3.0.19/+esm"
+pin "leaflet.fullscreen", to: "https://cdn.jsdelivr.net/npm/leaflet.fullscreen@5.3.0/+esm"
 
 # Geoblacklight
 pin_all_from Geoblacklight::Engine.root.join("app", "javascript", "geoblacklight"), under: "geoblacklight"

data/config/locales/geoblacklight.en.yml

@@ -93,6 +93,7 @@ en:
       attribute: 'Attribute'
       value: 'Value'
       click_map: 'Click on map to inspect values'
+      table_name: 'Map data'
     help_text:
       viewer_protocol:
         cog:

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 "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"
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "axe-core-rspec"

data/lib/generators/geoblacklight/assets/importmap_generator.rb

@@ -21,16 +21,19 @@ module Geoblacklight
         delivered via CDN.
       DESCRIPTION
 
-      # Switch bootstrap import to ESM version so we can import individual parts
+      # Switch Blacklight's bootstrap and popper imports to ESM versions so we
+      # can import individual modules
       def use_bootstrap_esm
-        gsub_file "config/importmap.rb", /dist\/js\/bootstrap\.js/, "dist/js/bootstrap.esm.js"
+        gsub_file "config/importmap.rb", %r{dist/js/bootstrap.js}, "dist/js/bootstrap.esm.js"
+        gsub_file "config/importmap.rb", %r{dist/umd/popper.min.js}, "dist/esm/popper.js"
       end
 
-      # Add the customization overrides and insert before bootstrap import
+      # Add the SCSS customization overrides and insert before bootstrap import
       def add_customizations
         copy_file "assets/_customizations.scss", "app/assets/stylesheets/_customizations.scss"
         gsub_file "app/assets/stylesheets/_customizations.scss", "@geoblacklight/frontend/app/assets/", ""
-        insert_into_file "app/assets/stylesheets/application.bootstrap.scss", "@import 'customizations';\n", before: "@import 'bootstrap/scss/bootstrap';"
+        insert_into_file "app/assets/stylesheets/application.bootstrap.scss", "@import 'customizations';\n",
+          before: "@import 'bootstrap/scss/bootstrap';"
       end
 
       # Add CDN imports for CSS files used by Geoblacklight (leaflet, openlayers)
@@ -38,9 +41,9 @@ module Geoblacklight
         insert_into_file "app/assets/stylesheets/application.bootstrap.scss", before: "@import 'customizations';\n" do
           <<~SCSS
             /* GeoBlacklight dependencies CSS */
-            @import url("https://cdn.skypack.dev/leaflet@1.9.4/dist/leaflet.css");
-            @import url("https://cdn.jsdelivr.net/npm/leaflet-fullscreen@1.0.2/dist/leaflet.fullscreen.css");
-            @import url("https://cdn.skypack.dev/ol@8.1.0/ol.css");
+            @import url("https://cdn.jsdelivr.net/npm/leaflet@1.9.4/dist/leaflet.css");
+            @import url("https://cdn.jsdelivr.net/npm/leaflet.fullscreen@5.3.0/dist/Control.FullScreen.css");
+            @import url("https://cdn.jsdelivr.net/npm/ol@8.1.0/ol.css");
 
           SCSS
         end

data/lib/generators/geoblacklight/assets/vite_generator.rb

@@ -16,8 +16,8 @@ module Geoblacklight
       SCSS entrypoint file, which will be bundled by Vite.
 
       Geoblacklight's frontend assets are installed from the npm package. In
-      local development they automatically reference the versions from the
-      outer directory (the Geoblacklight repository) via a yarn symlink.
+      CI they automatically reference the versions from the outer directory
+      (the Geoblacklight repository) via a yarn symlink.
       DESCRIPTION
 
       # Install Vite
@@ -26,6 +26,13 @@ module Geoblacklight
         run "bundle install"
       end
 
+      # Symlink geoblacklight's frontend assets in CI
+      def link_geoblacklight_package
+        if options[:test]
+          run "yarn link @geoblacklight/frontend"
+        end
+      end
+
       # Add our version of the Blacklight base layout with Vite helper tags
       def geoblacklight_base_layout
         copy_file "base.html.erb", "app/views/layouts/blacklight/base.html.erb"

data/lib/generators/geoblacklight/assets_generator.rb

@@ -4,7 +4,7 @@ module Geoblacklight
   # Run general asset setup and then delegate to the appropriate generator
   # Based on Blacklight::AssetsGenerator
   class AssetsGenerator < Rails::Generators::Base
-    class_option :"asset-pipeline", type: :string, default: ENV.fetch("ASSET_PIPELINE", "vite"), desc: "Choose the asset pipeline to use (vite or importmap)"
+    class_option :"asset-pipeline", type: :string, default: ENV.fetch("ASSET_PIPELINE", "importmap"), desc: "Choose the asset pipeline to use (vite or importmap)"
     class_option :test, type: :boolean, default: ENV.fetch("CI", false), aliases: "-t", desc: "Indicates that app will be installed in a test environment"
 
     # Pick a version of the frontend asset package and install it.
@@ -27,7 +27,7 @@ module Geoblacklight
       generator = if options[:"asset-pipeline"]
         "geoblacklight:assets:#{options[:"asset-pipeline"]}"
       else
-        "geoblacklight:assets:vite"
+        "geoblacklight:assets:importmap"
       end
 
       generate generator, generated_options

data/lib/generators/geoblacklight/templates/assets/application.scss

@@ -2,7 +2,7 @@
 
 // Leaflet, OpenLayers, GeoBlacklight (includes Blacklight and Bootstrap)
 @import "leaflet/dist/leaflet.css";
-@import "leaflet-fullscreen/dist/leaflet.fullscreen.css";
+@import "leaflet.fullscreen/dist/Control.FullScreen.css";
 @import "ol/ol.css";
 @import "~/stylesheets/geoblacklight.scss";
 

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

@@ -224,7 +224,7 @@ class CatalogController < ApplicationController
 
     config.add_search_field "all_fields", label: "All Fields"
     # config.add_search_field 'dct_title_ti', :label => 'Title'
-    # config.add_search_field 'dct_description_ti', :label => 'Description'
+    # config.add_search_field 'dct_description_tmi', :label => 'Description'
 
     # Now we see how to over-ride Solr request handler defaults, in this
     # case for a BL "search field", which is really a dismax aggregate
@@ -309,12 +309,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

@@ -231,6 +231,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
   BOUNDSOVERLAY:
     INDEX:
       color: '#3388ff'
@@ -247,6 +266,7 @@ LEAFLET:
     HOVERTOWAKE: false
     MESSAGE: 'Click to Wake'
     BACKGROUND: 'rgba(214, 214, 214, .7)'
+  SIDEBAR: false # set to true to display attribute table as sidebar on map
   LAYERS:
     DETECT_RETINA: true
     INDEX: