Module: Geoblacklight::DeprecatedConfiguration

Defined in:
lib/geoblacklight/deprecated_configuration.rb

Overview

Boot time checks for application configuration that GeoBlacklight 6 removes.

These cases cannot be caught by deprecating a method, because nothing in GeoBlacklight calls them:

  • An overridden template keeps working on 5.x and is simply never rendered again on 6, so the customization disappears silently.
  • A file the install generator wrote into the application — its routes, its CatalogController, its layout — names a constant that 6 deletes, so the application, not GeoBlacklight, is what fails to boot.
  • A removed setting is only ever read by JavaScript, or by code that 6 deletes outright.

So we look at the application's own files and settings once, at boot. Where several problems live in the same file they are reported as a single warning: a stock 5.x application trips all of them at once and fixes them in one pass, and one line per problem is what makes a maintainer silence the deprecator.

Constant Summary collapse

TEMPLATES =

Templates GeoBlacklight 6 no longer ships, mapped to their replacement. An application that has copied one of these into app/views will keep the file after upgrading, but GeoBlacklight 6 will not render it.

{
  "catalog/_metadata" => "use Geoblacklight::MetadataComponent instead",
  "catalog/_relations_container" => "use Geoblacklight::Document::RelationsContainerComponent instead",
  "relation/index" => "the controller is renamed, so the template moves to app/views/relations/index"
}.freeze
SETTINGS =

Settings keys GeoBlacklight 6 stops acting on, mapped to what happens instead. None of these does it read at all, so the line can come out, and nothing raises to say the customization stopped mattering.

{
  "DOWNLOAD_FORMATS" =>
    "GeoBlacklight 6 removes the generated download subsystem and never reads it. Note the 4.x " \
    "upgrade added this key because GeoBlacklight 5 required it",
  "HELP_TEXT" =>
    "GeoBlacklight 6 removes the viewer help text popovers along with ViewerHelpTextComponent and " \
    "no longer reads the key at all",
  "ICON_MAPPING" =>
    "GeoBlacklight 6 drops the lookup from its geoblacklight_icon helper and removes the " \
    "institution icon components this maps onto, so a provider named here renders as an empty span",
  "LEAFLET" =>
    "GeoBlacklight 6 replaces the leaflet and openlayers viewers with <ogm-viewer> and reads none " \
    "of this section — including the BASEMAPS key 5.3 added for CARTO API keys, which becomes " \
    "light_basemap_url and dark_basemap_url on Geoblacklight.configuration, each the URL of a " \
    "MapLibre style document",
  "SIDEBAR_STATIC_MAP" =>
    "GeoBlacklight 6's StaticMapComponent decides for itself, from whether the record is " \
    "previewable and georeferenced, and never reads this list of viewer protocols",
  "TIMEOUT_DOWNLOAD" =>
    "GeoBlacklight 6 removes the generated download subsystem and never reads it"
}.freeze
CHANGED_SETTINGS =

Settings whose default GeoBlacklight 6 changes. The installer only writes config/settings.yml once, so an application upgrading from 5.x carries its old value forward silently. We warn only when the value is still the 5.x default, so an application that has deliberately chosen a value is left alone.

{}.freeze
STALE_SETTING_VALUES =

Individual setting values that stop matching anything in GeoBlacklight 6.

{}.freeze
REQUIRED_SETTINGS =

Settings that do not exist in 5.x but that GeoBlacklight 6 requires.

{}.freeze
LOCALE_KEYS =

Translation keys GeoBlacklight 6 stops looking up, keyed by prefix so that a whole family is reported as one line rather than 33. An application that translated or reworded any of these keeps the translation in its own locale file, where GeoBlacklight 6 never reads it again, so the customization disappears with no error.

{
  "blacklight.icon." =>
    "GeoBlacklight 6 restructures its icons and ships no labels under blacklight.icon",
  "geoblacklight.download." =>
    "GeoBlacklight 6 keeps this namespace but renames its keys — download_link is now " \
    "original_link, beside downloads, generated_link, iiif_image_link and iiif_manifest_link — " \
    "and drops the rest with the generated download subsystem",
  "geoblacklight.help_text.viewer_protocol." =>
    "GeoBlacklight 6 removes the viewer help text popovers along with ViewerHelpTextComponent",
  "geoblacklight.metadata.toggle_summary" =>
    "GeoBlacklight 6 renders metadata through Geoblacklight::MetadataComponent",
  "geoblacklight.relations.browse_all" =>
    "GeoBlacklight 6 looks up geoblacklight.relations.browse.<field family> instead, so " \
    "browse.member_of rather than browse.member_of_ancestors"
}.freeze
PLURALIZED_LOCALE_KEYS =

Relationship labels that GeoBlacklight 6 turns from a plain string into a pluralized one:/other: pair. I18n does not raise when a String is looked up with a count, so an application that reworded one keeps a label that never pluralizes.

%w[
  member_of_ancestors member_of_descendants part_of_ancestors part_of_descendants
  relation_ancestors relation_descendants replaces_ancestors replaces_descendants
  source_ancestors source_descendants version_of_ancestors version_of_descendants
].map { |key| "geoblacklight.relations.#{key}" }.freeze
RELATIONSHIP_ATTRIBUTES =

The attributes GeoBlacklight 6 declares on a RELATIONSHIPS_SHOWN entry. Its Geoblacklight::Configuration::RelationshipConfig is an ActiveModel, so an attribute that is neither declared here nor tolerated as one of RELATIONSHIP_ATTRIBUTES_REMOVED raises Geoblacklight::Exceptions::InvalidSettings while the configuration is built — before anything can rescue it.

%w[field inverse label query_type].freeze
RELATIONSHIP_ATTRIBUTES_REMOVED =

Attributes GeoBlacklight 6 still accepts on a RELATIONSHIPS_SHOWN entry but does nothing with, mapped to what replaced them. It names these deliberately — every config/settings.yml generated since 4.0 sets icon — so they warn once per boot instead of raising, which is why they are worth reporting separately from an attribute that does raise.

{
  "icon" => "GeoBlacklight 6 labels related records with a resource class badge instead"
}.freeze
REMOVED_HELPER_METHODS =

Helpers the 5.x install generator names with helper_method: in the application's own CatalogController, and that GeoBlacklight 6 removes.

{
  "snippit" => "GeoBlacklight 6 truncates index field values itself",
  "render_value_as_truncate_abstract" =>
    "use `component: Geoblacklight::MetadataDescriptionMarkdownComponent` instead"
}.freeze
ASSET_REFERENCES =

Paths into the @geoblacklight/frontend package that the 5.x install generator wrote into the application's own stylesheets and entrypoints. GeoBlacklight 6 ships plain CSS rather than Sass, so these resolve to nothing and the application's asset build fails rather than degrading quietly.

{
  "@geoblacklight/frontend/app/assets/stylesheets/geoblacklight/geoblacklight" =>
    "GeoBlacklight 6 ships plain CSS instead of Sass; import " \
    "@geoblacklight/frontend/app/assets/stylesheets/geoblacklight.css instead",
  # Matches both the Vite form, which keeps the package prefix, and the importmap
  # form, which the 5.x generator rewrites to a bare path.
  "images/blacklight/logo.svg" =>
    "GeoBlacklight 6 moves the logo to images/geoblacklight/logo.svg, with " \
    "images/geoblacklight/logo-dark.svg for dark mode"
}.freeze
LAYOUT_REFERENCES =

Things the 5.x installed layout does that GeoBlacklight 6 no longer supports. Only the Vite generator copies base.html.erb into the application, but apps on either pipeline copy and adapt it, so match on content rather than on the path.

{
  "shared/header_navbar" =>
    "Blacklight 9 stops shipping the shared/_header_navbar partial this renders; move the masthead " \
    "to blacklight_config.header_component, which is where GeoBlacklight 6 configures it",
  "vite_client_tag" =>
    "GeoBlacklight 6 drops the vite_rails dependency and ships no Vite entrypoints; move the layout to " \
    "the stylesheet and javascript tags your asset pipeline provides"
}.freeze
LAYOUT_GLOBS =

Where an application keeps its layouts.

["app/views/layouts/**/*.{erb,haml}"].freeze
ASSET_GLOBS =

Where an application keeps the asset files the install generator wrote or edited.

[
  "app/assets/stylesheets/**/*.{css,scss}",
  "app/javascript/**/*.{js,css,scss}"
].freeze
REMOVED_CONSTANTS =

GeoBlacklight names an application will only mention if it has subclassed, rendered or configured them itself, and that GeoBlacklight 6 removes or moves. Every one of these raises NameError or NoMethodError rather than degrading, so they are worth finding before the upgrade rather than after it.

Geoblacklight::IconFacetItemComponent is deliberately absent: every generated CatalogController names it, and #catalog_controller_problems already reports it with the facets it is attached to.

{
  "Geoblacklight::AccordionComponent" => "it is removed without replacement",
  "Geoblacklight::AttributeTableComponent" =>
    "the inspect table is drawn inside the <ogm-viewer> element in GeoBlacklight 6",
  "Geoblacklight::DownloadLinksComponent" => "use Geoblacklight::Document::DownloadLinksComponent",
  "Geoblacklight::IndexMapInspectComponent" =>
    "index map inspection happens inside <ogm-viewer> in GeoBlacklight 6",
  "Geoblacklight::IndexMapLegendComponent" =>
    "the legend is emitted by <ogm-viewer> in GeoBlacklight 6",
  "Geoblacklight::LocationLeafletMapComponent" =>
    "use Geoblacklight::OverviewMapComponent for many records, or " \
    "Geoblacklight::LocatorMapComponent for one",
  "Geoblacklight::RelationsComponent" => "use Geoblacklight::Relations::RelationsComponent",
  "Geoblacklight::ViewerHelpTextComponent" => "it is removed without replacement",
  "Geoblacklight::Relation::" => "the namespace is renamed to Geoblacklight::Relations::",
  "Geoblacklight::CsvDownload" => "GeoBlacklight 6 removes the generated download subsystem",
  "Geoblacklight::GeojsonDownload" => "GeoBlacklight 6 removes the generated download subsystem",
  "Geoblacklight::GeotiffDownload" => "GeoBlacklight 6 removes the generated download subsystem",
  "Geoblacklight::KmzDownload" => "GeoBlacklight 6 removes the generated download subsystem",
  "Geoblacklight::ShapefileDownload" => "GeoBlacklight 6 removes the generated download subsystem",
  "RelationController" => "it is renamed to RelationsController",
  "index_fields_display" =>
    "use Geoblacklight::SearchResultComponent#description, which renders the description as Markdown"
}.freeze
CODE_GLOBS =

Where an application keeps code that could name one of those.

[
  "app/**/*.{rb,erb}",
  "config/initializers/*.rb",
  "lib/**/*.rb"
].freeze
ROUTE_CONSTANTS =

Constants the 5.x install generator wrote into the application's own config/routes.rb and that GeoBlacklight 6 deletes. The application's routes file is not something GeoBlacklight rewrites on upgrade, so these raise NameError while Rails draws the routes — before any of our other checks run.

{
  "Geoblacklight::Routes::Downloadable" =>
    "GeoBlacklight 6 removes the generated download subsystem, so delete the `concern " \
    ":gbl_downloadable`, the `namespace :download` block and `resources :download, only: [:show]`"
}.freeze
GEM_REQUIREMENTS =

Version floors GeoBlacklight 6 raises, as => requirement. Unlike everything else here these are not a choice the application made, and the failure does not look like a GeoBlacklight problem: bundler simply refuses to resolve, or Blacklight renders facets the stylesheets no longer match.

{
  "Blacklight" => {
    minimum: "9.1",
    because: "GeoBlacklight 6 calls blacklight_config.dark_mode_support and resolves per-field " \
      "layout components, both of which Blacklight added in 9.1, and its geosearch facet and " \
      "styling are written against Blacklight 9's accordion facets"
  },
  "Rails" => {
    minimum: "8.0",
    because: "GeoBlacklight 6 drops support for earlier versions"
  }
}.freeze

Class Method Summary collapse

Class Method Details

.catalog_controller_problems(controller) ⇒ Array<String>

Parameters:

  • controller (Class)

Returns:

  • (Array<String>) 


455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 455

def self.catalog_controller_problems(controller)
  config = controller.blacklight_config
  problems = []

  icon_facets = config.facet_fields.select do |_key, field|
    field.item_component.to_s == "Geoblacklight::IconFacetItemComponent"
  end
  if icon_facets.any?
    problems << "stop passing `item_component: Geoblacklight::IconFacetItemComponent` to " \
      "#{icon_facets.keys.join(", ")}, because GeoBlacklight 6 removes that class and the reference " \
      "will not resolve"
  end

  # index_fields and show_fields are keyed by Solr field, so the same key can
  # appear in both with different helpers; check them separately.
  {"index" => config.index_fields, "show" => config.show_fields}.each do |kind, fields|
    fields.each do |key, field|
      advice = REMOVED_HELPER_METHODS[field.helper_method.to_s]
      next unless advice
      problems << "stop passing `helper_method: :#{field.helper_method}` to the #{key} #{kind} field, " \
        "because GeoBlacklight 6 removes that helper; #{advice}"
    end
  end

  basemap = config.basemap_provider
  if basemap.present? && basemap.to_s != "positron"
    problems << "translate `config.basemap_provider = #{basemap.to_s.inspect}` into the " \
      "light_basemap_url and dark_basemap_url that GeoBlacklight 6 reads from " \
      "Geoblacklight.configuration, which take the URL of a MapLibre style document rather than " \
      "a preset name; left here it reaches nothing and <ogm-viewer> draws its own basemap"
  end

  problems
end

.current_gem_versions ⇒ Hash{String=>String,nil}

Returns:

  • (Hash{String=>String,nil}) 


503
504
505
506
507
508
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 503

def self.current_gem_versions
  {
    "Blacklight" => (::Blacklight::VERSION if defined?(::Blacklight::VERSION)),
    "Rails" => (::Rails::VERSION::STRING if defined?(::Rails::VERSION::STRING))
  }
end

.dead_asset_references(path) ⇒ Array<String>

Parameters:

  • path (String)

Returns:

  • (Array<String>) 


423
424
425
426
427
428
429
430
431
432
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 423

def self.dead_asset_references(path)
  contents = File.read(path)
  ASSET_REFERENCES.filter_map do |reference, advice|
    "stop importing #{reference}, because #{advice}" if contents.include?(reference)
  end
rescue SystemCallError
  # An unreadable asset file is somebody else's problem; a boot time diagnostic
  # must never be the reason an application fails to start.
  []
end

.dead_layout_references(path) ⇒ Array<String>

Parameters:

  • path (String)

Returns:

  • (Array<String>) 


367
368
369
370
371
372
373
374
375
376
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 367

def self.dead_layout_references(path)
  contents = File.read(path)
  LAYOUT_REFERENCES.filter_map do |reference, advice|
    "stop using #{reference}, because #{advice}" if contents.include?(reference)
  end
rescue SystemCallError
  # An unreadable layout is somebody else's problem; a boot time diagnostic must
  # never be the reason an application fails to start.
  []
end

.gem_requirement_problems(versions) ⇒ Array<String>

Parameters:

  • versions (Hash{String=>String,nil})

Returns:

  • (Array<String>) 


513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 513

def self.gem_requirement_problems(versions)
  GEM_REQUIREMENTS.filter_map do |library, requirement|
    current = versions[library]
    # An unreadable version is not evidence of a problem, so say nothing.
    next unless current && Gem::Version.correct?(current)
    next if Gem::Version.new(current) >= Gem::Version.new(requirement[:minimum])

    "#{library} #{current} is too old for GeoBlacklight 6, which requires #{library} " \
      "#{requirement[:minimum]} or later, because #{requirement[:because]}"
  end
end

.locale_keys(path) ⇒ Array<String>

The dotted keys a locale file defines, with the leading locale dropped so that a translation into any locale matches.

Parameters:

  • path (String)

Returns:

  • (Array<String>) 


621
622
623
624
625
626
627
628
629
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 621

def self.locale_keys(path)
  loaded = YAML.load_file(path, aliases: true)
  return [] unless loaded.is_a?(Hash)

  loaded.each_value.flat_map { |tree| tree.is_a?(Hash) ? dotted_keys(tree) : [] }
rescue
  # A locale file we cannot parse is not ours to complain about.
  []
end

.relationships_shown_problems ⇒ Array<String>

Returns:

  • (Array<String>) 


587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 587

def self.relationships_shown_problems
  entries = ::Settings.RELATIONSHIPS_SHOWN
  return [] unless entries.respond_to?(:to_h)
  entries = entries.to_h
  return [] if entries.empty?

  problems = []

  attributes = entries.each_value.flat_map { |entry|
    entry.respond_to?(:to_h) ? entry.to_h.keys.map(&:to_s) : []
  }.uniq

  RELATIONSHIP_ATTRIBUTES_REMOVED.slice(*attributes).each do |attribute, advice|
    problems << "delete the #{attribute} attribute from RELATIONSHIPS_SHOWN, because #{advice} " \
      "and only warns, once a boot, that the key is dead"
  end

  unrecognized = attributes - RELATIONSHIP_ATTRIBUTES - RELATIONSHIP_ATTRIBUTES_REMOVED.keys
  if unrecognized.any?
    problems << "remove the #{unrecognized.sort.join(", ")} " \
      "#{"attribute".pluralize(unrecognized.size)} from RELATIONSHIPS_SHOWN, which GeoBlacklight 6 " \
      "does not recognize — its RelationshipConfig accepts only " \
      "#{RELATIONSHIP_ATTRIBUTES.join(", ")}, so building the configuration raises " \
      "Geoblacklight::Exceptions::InvalidSettings on boot and again on every search"
  end

  problems
end

.removed_constants_in(path) ⇒ Array<String>

Parameters:

  • path (String)

Returns:

  • (Array<String>) 


395
396
397
398
399
400
401
402
403
404
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 395

def self.removed_constants_in(path)
  contents = File.read(path)
  REMOVED_CONSTANTS.filter_map do |name, advice|
    "stop referring to #{name}, because #{advice}" if contents.include?(name)
  end
rescue SystemCallError
  # An unreadable file is somebody else's problem; a boot time diagnostic must
  # never be the reason an application fails to start.
  []
end

.setting_present?(setting) ⇒ Boolean

Parameters:

  • setting (String)

Returns:

  • (Boolean) 


656
657
658
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 656

def self.setting_present?(setting)
  setting_value(setting).present?
end

.setting_value(setting) ⇒ Object?

Walk a dotted settings path without raising when an ancestor is missing.

Parameters:

  • setting (String) —

    e.g. "LEAFLET.VIEWERS"

Returns:

  • (Object, nil) —

    the value, or nil if any step of the path is missing



646
647
648
649
650
651
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 646

def self.setting_value(setting)
  setting.split(".").reduce(::Settings) do |node, key|
    return nil unless node.respond_to?(key)
    node.public_send(key)
  end
end

.settings_problems ⇒ Array<String>

Returns:

  • (Array<String>) 


542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 542

def self.settings_problems
  problems = relationships_shown_problems

  removed = SETTINGS.select { |setting, _| setting_present?(setting) }
  removed.each { |setting, advice| problems << "remove Settings.#{setting}, because #{advice}" }

  CHANGED_SETTINGS.each do |setting, change|
    next unless setting_value(setting) == change[:from]
    problems << "Settings.#{setting} is still the GeoBlacklight 5 default #{change[:from].inspect}; " \
      "GeoBlacklight 6 uses #{change[:to].inspect} because #{change[:because]}"
  end

  REQUIRED_SETTINGS.each do |setting, advice|
    next unless setting_value(setting).nil?
    problems << "set Settings.#{setting}, because #{advice}"
  end

  STALE_SETTING_VALUES.each do |setting, stale|
    next unless Array(setting_value(setting)).include?(stale[:value])
    problems << "Settings.#{setting} lists #{stale[:value].inspect}, which never matches in " \
      "GeoBlacklight 6; #{stale[:because]}"
  end

  problems.concat(uppercase_convention_problems)
  problems
end

.uppercase_convention_problems ⇒ Array<String>

GeoBlacklight 6 resolves settings case-insensitively and prefers lowercase; an uppercase key still works but makes 6 emit a deprecation for every one of them. Renaming is not safe on its own, because the generated CatalogController and SolrDocument read Settings.UPPERCASE directly.

Returns:

  • (Array<String>) 


575
576
577
578
579
580
581
582
583
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 575

def self.uppercase_convention_problems
  uppercase = ::Settings.to_h.keys.map(&:to_s).select { |key| key.match?(/[A-Z]/) }
  return [] if uppercase.empty?

  ["rename the #{uppercase.size} uppercase top level keys to lowercase, because GeoBlacklight 6 " \
    "resolves settings case-insensitively and warns once per uppercase key it has to fall back to; " \
    "convert the Settings.UPPERCASE reads in app/controllers/catalog_controller.rb and " \
    "app/models/solr_document.rb in the same pass, or the application will not boot"]
end

.warn!(root = Rails.root) ⇒ Object

Warn about everything we can see, once per boot.

Parameters:

  • root (Pathname) (defaults to: Rails.root) —

    the application root to inspect



252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 252

def self.warn!(root = Rails.root)
  if root
    warn_about_templates(root)
    warn_about_locale_keys(root)
    warn_about_routes(root)
    warn_about_asset_references(root)
    warn_about_frontend_package(root)
    warn_about_removed_constants(root)
    warn_about_layouts(root)
  end
  warn_about_settings_file
  warn_about_catalog_controller
  warn_about_gem_requirements
end

.warn_about_asset_references(root) ⇒ Object

One warning per asset file, listing every dead reference in it.

Parameters:

  • root (Pathname) —

    the application root to inspect



409
410
411
412
413
414
415
416
417
418
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 409

def self.warn_about_asset_references(root)
  ASSET_GLOBS.flat_map { |glob| Dir.glob(File.join(root, glob)) }.uniq.sort.each do |path|
    problems = dead_asset_references(path)
    next if problems.empty?

    Geoblacklight.deprecation.warn(
      "#{relative_to(path, root)} needs these changes before GeoBlacklight 6: #{problems.join("; ")}"
    )
  end
end

.warn_about_catalog_controller ⇒ Object

Everything the application's own CatalogController needs before GeoBlacklight 6, reported as a single to-do list.



437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 437

def self.warn_about_catalog_controller
  return unless defined?(::CatalogController)

  problems = catalog_controller_problems(::CatalogController)
  return if problems.empty?

  Geoblacklight.deprecation.warn(
    "app/controllers/catalog_controller.rb needs these changes before GeoBlacklight 6: " +
    problems.join("; ")
  )
rescue
  # A boot time diagnostic must never be the reason an application fails to start.
  nil
end

.warn_about_frontend_package(root) ⇒ Object

The install generator pins @geoblacklight/frontend to the gem's own version, so yarn upgrade keeps the 5.x package: every import then resolves to GeoBlacklight 5 assets against GeoBlacklight 6 markup, with nothing raising.

Parameters:

  • root (Pathname) —

    the application root to inspect



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 334

def self.warn_about_frontend_package(root)
  path = File.join(root, "package.json")
  return unless File.exist?(path)

  pinned = JSON.parse(File.read(path)).dig("dependencies", "@geoblacklight/frontend")
  return if pinned.nil? || pinned.to_s.delete("^0-9.").to_f >= 6

  Geoblacklight.deprecation.warn(
    "#{relative_to(path, root)} pins @geoblacklight/frontend to #{pinned}; GeoBlacklight 6 needs the " \
    "matching 6.x package, and `yarn upgrade` will not cross the major on its own"
  )
rescue JSON::ParserError, SystemCallError
  # A package.json we cannot read is not ours to complain about.
  nil
end

.warn_about_gem_requirements(versions = current_gem_versions) ⇒ Object

Warn when the application is on a version of Blacklight or Rails that GeoBlacklight 6 will not run against. One warning per library, because they are fixed in different lines of the Gemfile and each is its own upgrade.

Parameters:

  • versions (Hash{String=>String,nil}) (defaults to: current_gem_versions) 


495
496
497
498
499
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 495

def self.warn_about_gem_requirements(versions = current_gem_versions)
  gem_requirement_problems(versions).each do |problem|
    Geoblacklight.deprecation.warn(problem)
  end
end

.warn_about_layouts(root) ⇒ Object

One warning per layout, listing everything in it GeoBlacklight 6 drops.

Parameters:

  • root (Pathname) —

    the application root to inspect



353
354
355
356
357
358
359
360
361
362
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 353

def self.warn_about_layouts(root)
  LAYOUT_GLOBS.flat_map { |glob| Dir.glob(File.join(root, glob)) }.uniq.sort.each do |path|
    problems = dead_layout_references(path)
    next if problems.empty?

    Geoblacklight.deprecation.warn(
      "#{relative_to(path, root)} needs these changes before GeoBlacklight 6: #{problems.join("; ")}"
    )
  end
end

.warn_about_locale_keys(root) ⇒ Object

Parameters:

  • root (Pathname) —

    the application root to inspect



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 282

def self.warn_about_locale_keys(root)
  Dir.glob(File.join(root, "config", "locales", "**", "*.{yml,yaml}")).sort.each do |path|
    defined_keys = locale_keys(path)
    next if defined_keys.empty?

    problems = LOCALE_KEYS.filter_map do |prefix, advice|
      matched = defined_keys.select { |key| key.start_with?(prefix) }
      next if matched.empty?

      subject = (matched.size > 1) ? "the #{matched.size} #{prefix}* keys" : matched.first
      "stop translating #{subject}, because #{advice}"
    end

    pluralized = defined_keys & PLURALIZED_LOCALE_KEYS
    if pluralized.any?
      problems << "give the #{pluralized.size} geoblacklight.relations.* #{"label".pluralize(pluralized.size)} " \
        "a one:/other: pair, because GeoBlacklight 6 looks them up with a count and a plain string " \
        "silently never pluralizes"
    end

    next if problems.empty?

    Geoblacklight.deprecation.warn(
      "#{relative_to(path, root)} needs these changes before GeoBlacklight 6: #{problems.join("; ")}"
    )
  end
end

.warn_about_removed_constants(root) ⇒ Object

One warning per file, listing every removed GeoBlacklight name it mentions.

Parameters:

  • root (Pathname) —

    the application root to inspect



381
382
383
384
385
386
387
388
389
390
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 381

def self.warn_about_removed_constants(root)
  CODE_GLOBS.flat_map { |glob| Dir.glob(File.join(root, glob)) }.uniq.sort.each do |path|
    problems = removed_constants_in(path)
    next if problems.empty?

    Geoblacklight.deprecation.warn(
      "#{relative_to(path, root)} needs these changes before GeoBlacklight 6: #{problems.join("; ")}"
    )
  end
end

.warn_about_routes(root) ⇒ Object

Parameters:

  • root (Pathname) —

    the application root to inspect



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 312

def self.warn_about_routes(root)
  path = File.join(root, "config", "routes.rb")
  return unless File.exist?(path)

  contents = File.read(path)
  problems = ROUTE_CONSTANTS.filter_map { |constant, advice| advice if contents.include?(constant) }
  return if problems.empty?

  Geoblacklight.deprecation.warn(
    "#{relative_to(path, root)} needs these changes before GeoBlacklight 6: #{problems.join("; ")}"
  )
rescue SystemCallError
  # An unreadable routes file is somebody else's problem; a boot time diagnostic
  # must never be the reason an application fails to start.
  nil
end

.warn_about_settings_file ⇒ Object

Everything the application's own config/settings.yml needs before GeoBlacklight 6, as a single to-do list. A generated 5.x settings file trips several of these at once and they are all fixed in the one file.



529
530
531
532
533
534
535
536
537
538
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 529

def self.warn_about_settings_file
  return unless defined?(::Settings)

  problems = settings_problems
  return if problems.empty?

  Geoblacklight.deprecation.warn(
    "config/settings.yml needs these changes before GeoBlacklight 6: " + problems.join("; ")
  )
end

.warn_about_templates(root) ⇒ Object

Parameters:

  • root (Pathname) —

    the application root to inspect



269
270
271
272
273
274
275
276
277
278
 
# File 'lib/geoblacklight/deprecated_configuration.rb', line 269

def self.warn_about_templates(root)
  TEMPLATES.each do |template, advice|
    Dir.glob(File.join(root, "app", "views", "#{template}.*")).sort.each do |override|
      Geoblacklight.deprecation.warn(
        "#{relative_to(override, root)} overrides #{template}, which is removed in " \
        "GeoBlacklight 6; #{advice}"
      )
    end
  end
end