geoblacklight 5.3.0 → 5.4.0

data/lib/geoblacklight/engine.rb

@@ -10,6 +10,19 @@ require "mime/types"
 
 module Geoblacklight
   class Engine < ::Rails::Engine
+    # Register GeoBlacklight's deprecator so that applications can configure it
+    # alongside Rails' own, e.g. `config.active_support.deprecation = :raise`.
+    initializer "geoblacklight.deprecator" do |app|
+      app.deprecators[:geoblacklight] = Geoblacklight.deprecation if app.respond_to?(:deprecators)
+    end
+
+    # Warn about application configuration that GeoBlacklight 6 removes. This runs
+    # once per boot rather than per request, because nothing in GeoBlacklight calls
+    # the deprecated templates or settings on the application's behalf.
+    config.after_initialize do
+      Geoblacklight::DeprecatedConfiguration.warn!
+    end
+
     # GeoblacklightHelper is needed by all helpers, so we inject it
     # into action view base here.
     initializer "geoblacklight.helpers" do

data/lib/geoblacklight/references.rb

@@ -52,6 +52,7 @@ module Geoblacklight
     ##
     # Download hash based off of format type
     # @return [Hash, nil]
+    # @deprecated
     def downloads_by_format
       case format
       when "Shapefile"
@@ -66,8 +67,9 @@ module Geoblacklight
     ##
     # Generated download types from wxs services
     # @return (see #downloads_by_format)
+    # @deprecated
     def download_types
-      downloads_by_format
+      Geoblacklight.deprecation.silence { downloads_by_format }
     end
 
     ##
@@ -156,5 +158,8 @@ module Geoblacklight
     def respond_to_missing?(m, *args, &b)
       Geoblacklight::Constants::URI.key?(m) || super
     end
+    Geoblacklight.deprecation.deprecate_methods(Geoblacklight::References,
+      downloads_by_format: "GeoBlacklight 6 removes the generated download subsystem: downloads are direct links only, rendered by Geoblacklight::Document::DownloadLinksComponent",
+      download_types: "GeoBlacklight 6 removes the generated download subsystem: downloads are direct links only, rendered by Geoblacklight::Document::DownloadLinksComponent")
   end
 end

data/lib/geoblacklight/relation/ancestors.rb

@@ -4,6 +4,9 @@ module Geoblacklight
   module Relation
     class Ancestors
       def initialize(id, field, repository)
+        Geoblacklight.deprecation.warn(
+          "GeoBlacklight 6 renames the Geoblacklight::Relation namespace to Geoblacklight::Relations, and RelationController to RelationsController, so update any reference to Geoblacklight::Relation::Ancestors"
+        )
         @search_id = id
         @field = field
         @repository = repository

data/lib/geoblacklight/relation/descendants.rb

@@ -4,6 +4,9 @@ module Geoblacklight
   module Relation
     class Descendants
       def initialize(id, field, repository)
+        Geoblacklight.deprecation.warn(
+          "GeoBlacklight 6 renames the Geoblacklight::Relation namespace to Geoblacklight::Relations, and RelationController to RelationsController, so update any reference to Geoblacklight::Relation::Descendants"
+        )
         @search_id = id
         @field = field
         @repository = repository

data/lib/geoblacklight/relation/relation_response.rb

@@ -5,6 +5,9 @@ module Geoblacklight
     class RelationResponse
       attr_reader :search_id, :link_id
       def initialize(id, repository)
+        Geoblacklight.deprecation.warn(
+          "GeoBlacklight 6 renames the Geoblacklight::Relation namespace to Geoblacklight::Relations, and RelationController to RelationsController, so update any reference to Geoblacklight::Relation::RelationResponse"
+        )
         @link_id = id
         @search_id = RSolr.solr_escape(id)
         @repository = repository
@@ -14,7 +17,7 @@ module Geoblacklight
         if Settings.RELATIONSHIPS_SHOWN.key?(method)
           field = Settings.RELATIONSHIPS_SHOWN[method].field
           query_type = query_type(Settings.RELATIONSHIPS_SHOWN[method])
-          @results = query_type.new(@search_id, field, @repository).results
+          @results = Geoblacklight.deprecation.silence { query_type.new(@search_id, field, @repository) }.results
         else
           super
         end

data/lib/geoblacklight/version.rb

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

data/lib/geoblacklight.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support/dependencies"
+require "active_support/deprecation"
 require "geoblacklight/engine"
 require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem
@@ -13,4 +14,19 @@ module Geoblacklight
   def self.logger
     ::Rails.logger
   end
+
+  # Deprecator for GeoBlacklight's own deprecations. Anything deprecated here is
+  # slated for removal in GeoBlacklight 6.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("6.0", "GeoBlacklight")
+  end
 end

data/lib/tasks/geoblacklight.rake

@@ -54,14 +54,23 @@ namespace :geoblacklight do
   namespace :downloads do
     desc "Delete all cached downloads"
     task delete: :environment do
+      Geoblacklight.deprecation.warn(
+        "The geoblacklight:downloads:delete rake task is deprecated; GeoBlacklight 6 removes the generated download subsystem: downloads are direct links only, rendered by Geoblacklight::Document::DownloadLinksComponent"
+      )
       FileUtils.rm_rf Dir.glob(Rails.root.join("tmp", "cache", "downloads", "*"))
     end
     desc "Create download directory"
     task mkdir: :environment do
+      Geoblacklight.deprecation.warn(
+        "The geoblacklight:downloads:mkdir rake task is deprecated; GeoBlacklight 6 removes the generated download subsystem: downloads are direct links only, rendered by Geoblacklight::Document::DownloadLinksComponent"
+      )
       FileUtils.mkdir_p(Rails.root.join("tmp", "cache", "downloads"), verbose: true)
     end
     desc "Precaches a download"
     task :precache, %i[doc_id download_type timeout] => [:environment] do |_t, args|
+      Geoblacklight.deprecation.warn(
+        "The geoblacklight:downloads:precache rake task is deprecated; GeoBlacklight 6 removes the generated download subsystem: downloads are direct links only, rendered by Geoblacklight::Document::DownloadLinksComponent"
+      )
       unless args[:doc_id] && args[:download_type] && args[:timeout]
         raise "Please supply required arguments [document_id, download_type and timeout]"
       end

data/package.json

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

data/solr/conf/solrconfig.xml

@@ -117,9 +117,9 @@
       <str name="q.alt">*:*</str>
       <str name="qf">
         text^1
-        dct_description_ti^2
+        dct_description_tmi^2
         dct_creator_tmi^3
-        dct_publisher_ti^3
+        dct_publisher_tmi^3
         dct_isPartOf_tmi^4
         dct_subject_tmi^5
         dct_spatial_tmi^5
@@ -127,16 +127,16 @@
         dct_title_ti^6
         dct_accessRights_ti^7
         dct_provider_ti^8
-        gbl_resourceClass_ti^9
-        gbl_resourceType_ti^9
-        dct_identifier_ti^10
+        gbl_resourceClass_tmi^9
+        gbl_resourceType_tmi^9
+        dct_identifier_tmi^10
         id_ti^10
       </str>
       <str name="pf"><!-- phrase boost within result set -->
         text^1
-        dct_description_ti^2
+        dct_description_tmi^2
         dct_creator_tmi^3
-        dct_publisher_ti^3
+        dct_publisher_tmi^3
         dct_isPartOf_tmi^4
         dct_subject_tmi^5
         dct_spatial_tmi^5
@@ -144,9 +144,9 @@
         dct_title_ti^6
         dct_accessRights_ti^7
         dct_provider_ti^8
-        gbl_resourceClass_ti^9
-        gbl_resourceType_ti^9
-        dct_identifier_ti^10
+        gbl_resourceClass_tmi^9
+        gbl_resourceType_tmi^9
+        dct_identifier_tmi^10
         id_ti^10
       </str>
       <bool name="facet">true</bool>

data/spec/features/configurable_basemap_spec.rb

@@ -3,6 +3,15 @@
 require "spec_helper"
 
 feature "Configurable basemap", js: true do
+  # CatalogController.blacklight_config is memoized and shared by the whole suite,
+  # so a scenario that sets a basemap has to put the original back. An around hook
+  # wraps the nested before hooks that do the setting.
+  around do |example|
+    original = CatalogController.blacklight_config.basemap_provider
+    example.run
+    CatalogController.blacklight_config.basemap_provider = original
+  end
+
   scenario "defaults to positron" do
     visit root_path
     expect(page).to have_css "img[src*='carto']", visible: :all
@@ -37,4 +46,63 @@ feature "Configurable basemap", js: true do
       expect(page).to have_css "img[src*='hot']", visible: :all
     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']", visible: :all
+    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/features/relations_spec.rb

@@ -33,10 +33,9 @@ feature "Display related documents" do
   end
 
   scenario "Relationship browse link returns relationship-scoped results", js: true do
-    # Wabash Topo parent record
-    visit solr_document_path("eee6150b-ce2f-4837-9d17-ce72a0c1c26f")
+    visit solr_document_path("princeton-1r66j405w")
 
-    expect(page).to have_content(:all, "Has part...")
+    expect(page).to have_content(:all, "Derived records...")
     expect(page).to have_link("Browse all 4 records...", visible: :all)
     click_link("Browse all 4 records...", visible: :all)