geoblacklight 4.5.1 → 4.7.0

data/lib/geoblacklight.rb

@@ -1,11 +1,28 @@
 # frozen_string_literal: true
 
 require "active_support/dependencies"
+require "active_support/deprecation"
 require "geoblacklight/engine"
 
 module Geoblacklight
+  # Deprecator for GeoBlacklight's own deprecations. Anything deprecated here is
+  # slated for removal in GeoBlacklight 5.0.
+  #
+  # Downstream applications can configure its behavior the same way they would any
+  # other Rails deprecator, e.g. in config/application.rb:
+  #
+  #   config.active_support.deprecation = :raise
+  #
+  # or directly:
+  #
+  #   Geoblacklight.deprecation.behavior = :silence
+  def self.deprecation
+    @deprecation ||= ActiveSupport::Deprecation.new("5.0", "GeoBlacklight")
+  end
+
   require "geoblacklight/bounding_box"
   require "geoblacklight/constants"
+  require "geoblacklight/deprecated_configuration"
   require "geoblacklight/exceptions"
   require "geoblacklight/geometry"
   require "geoblacklight/view_helper_override"

data/lib/tasks/geoblacklight.rake

@@ -24,6 +24,9 @@ namespace :geoblacklight do
 
   desc "Run Solr and GeoBlacklight for interactive development with Webpack enabled"
   task :webpack do |_t|
+    Geoblacklight.deprecation.warn(
+      "The geoblacklight:webpack rake task is deprecated and will be removed without replacement in GeoBlacklight 5"
+    )
     require "solr_wrapper"
     SolrWrapper.wrap(port: "8983") do |solr|
       solr.with_collection(name: "blacklight-core", dir: File.join(File.expand_path("../../", File.dirname(__FILE__)), "solr", "conf")) do
@@ -48,6 +51,11 @@ namespace :geoblacklight do
       docs = []
 
       if args.remote
+        Geoblacklight.deprecation.warn(
+          "The [:remote] argument to geoblacklight:index:seed is deprecated and will be " \
+          "removed in GeoBlacklight 5; the task always indexes the fixtures bundled with " \
+          "the installed gem"
+        )
         puts "Indexing - Remote test fixtures"
         JSON.parse(
           URI.parse("https://api.github.com/repos/geoblacklight/geoblacklight/contents/spec/fixtures/solr_documents").open.read
@@ -67,6 +75,9 @@ namespace :geoblacklight do
 
     desc "Ingests a GeoHydra transformed.json"
     task ingest_all: :environment do
+      Geoblacklight.deprecation.warn(
+        "The geoblacklight:index:ingest_all rake task is deprecated and will be removed without replacement in GeoBlacklight 5"
+      )
       docs = JSON.parse(File.read(Rails.root.join("tmp", "transformed.json")))
       docs.each do |doc|
         Blacklight.default_index.connection.add doc
@@ -76,6 +87,9 @@ namespace :geoblacklight do
 
     desc "Ingests a directory of geoblacklight.json files"
     task :ingest, [:directory] => :environment do |_t, args|
+      Geoblacklight.deprecation.warn(
+        "The geoblacklight:index:ingest rake task is deprecated and will be removed without replacement in GeoBlacklight 5"
+      )
       args.with_defaults(directory: "data")
       Dir.glob(File.join(args[:directory], "**", "geoblacklight.json")).each do |fn|
         puts "Ingesting #{fn}"
@@ -121,6 +135,9 @@ namespace :geoblacklight do
   namespace :solr do
     desc "Put sample data into solr"
     task seed: :environment do
+      Geoblacklight.deprecation.warn(
+        "The geoblacklight:solr:seed rake task is deprecated and will be removed in GeoBlacklight 5; use geoblacklight:index:seed instead"
+      )
       Rake::Task["geoblacklight:index:seed"].invoke
     end
   end

data/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@geoblacklight/frontend",
   "type": "module",
-  "version": "4.4.6",
+  "version": "4.7.0",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public"
@@ -28,7 +28,8 @@
     "@samvera/clover-iiif": "^2.3.2",
     "ol": "8.1.0",
     "ol-pmtiles": "^0.3.0",
-    "react": "^18.2.0"
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
   "devDependencies": {
     "vite": "^5.0.0"

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