geoblacklight 5.3.0 → 6.0.0.pre.alpha.1

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

@@ -1,4 +1,4 @@
-<div class='row'>
+<div class="row">
   <div
     id="documents"
     class="documents-list col-md-6"
@@ -14,8 +14,8 @@
     </div>
   </div>
   <% if results_js_map_selector(controller.controller_name) == "index" %>
-    <%= render(Geoblacklight::LocationLeafletMapComponent.new(page: 'index', geosearch: { dynamic: true }, classes: 'col-md-6 sticky-top position-sticky leaflet-viewer')) %>
+    <%= render(Geoblacklight::LocationLeafletMapComponent.new(page: 'index', geosearch: { dynamic: true }, classes: 'col-md-6 sticky-top position-sticky leaflet-viewer border')) %>
   <% else %>
-    <%= render(Geoblacklight::LocationLeafletMapComponent.new(page: 'index', classes: 'col-md-6 leaflet-viewer')) %>
+    <%= render(Geoblacklight::LocationLeafletMapComponent.new(page: 'index', classes: 'col-md-6 leaflet-viewer border')) %>
   <% end %>
 </div>

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

@@ -1,24 +1,32 @@
-<div class='container'>
-  <div class='row text-center'>
-    <div class='col-sm'>
+<div class="container">
+  <div class="row text-center">
+    <div class="col-sm">
       <%= content_tag :h3, t('geoblacklight.home.category_heading') %>
-      <div class='row'>
-        <%= render(Geoblacklight::HomepageFeatureFacetComponent.new(icon: 'home', label: 'geoblacklight.home.institution', facet_field: Settings.FIELDS.PROVIDER, response: @response)) %>
+      <div class="row">
+        <%= render(Geoblacklight::HomepageFeatureFacetComponent.new(icon: 'home', label: 'geoblacklight.home.institution',
+          facet_field_presenter: facet_field_presenter(blacklight_config.facet_fields[Geoblacklight.configuration.fields.provider], {}),
+          items: @response.aggregations[Geoblacklight.configuration.fields.provider].items)) %>
 
-        <%= render(Geoblacklight::HomepageFeatureFacetComponent.new(icon: 'arrow-circle-down', label: 'geoblacklight.home.data_type', facet_field: Settings.FIELDS.RESOURCE_TYPE, response: @response)) %>
+        <%= render(Geoblacklight::HomepageFeatureFacetComponent.new(icon: 'arrow-circle-down', label: 'geoblacklight.home.data_type',
+          facet_field_presenter: facet_field_presenter(blacklight_config.facet_fields[Geoblacklight.configuration.fields.resource_type], {}),
+          items: @response.aggregations[Geoblacklight.configuration.fields.resource_type].items)) %>
       </div>
-      <div class='row'>
-        <%= render(Geoblacklight::HomepageFeatureFacetComponent.new(icon: 'globe', label: 'geoblacklight.home.placename', facet_field: Settings.FIELDS.SPATIAL_COVERAGE, response: @response)) %>
+      <div class="row">
+        <%= render(Geoblacklight::HomepageFeatureFacetComponent.new(icon: 'globe', label: 'geoblacklight.home.placename',
+          facet_field_presenter: facet_field_presenter(blacklight_config.facet_fields[Geoblacklight.configuration.fields.spatial_coverage], {}),
+          items: @response.aggregations[Geoblacklight.configuration.fields.spatial_coverage].items)) %>
 
-        <%= render(Geoblacklight::HomepageFeatureFacetComponent.new(icon: 'tags', label: 'geoblacklight.home.subject', facet_field: Settings.FIELDS.SUBJECT, response: @response)) %>
+        <%= render(Geoblacklight::HomepageFeatureFacetComponent.new(icon: 'tags', label: 'geoblacklight.home.subject',
+          facet_field_presenter: facet_field_presenter(blacklight_config.facet_fields[Geoblacklight.configuration.fields.subject], {}),
+          items: @response.aggregations[Geoblacklight.configuration.fields.subject].items)) %>
       </div>
     </div>
-    <div class='col-sm'>
+    <div class="col-sm">
       <%= content_tag :h3, t('geoblacklight.home.map_heading') %>
-      <%= render(Geoblacklight::LocationLeafletMapComponent.new(page: 'home', geosearch: { dynamic: false })) %>
+      <%= render(Geoblacklight::LocationLeafletMapComponent.new(page: 'home', geosearch: { dynamic: false }, classes: 'border')) %>
     </div>
   </div>
-  <div id="geoblacklight-version" class="text-end">
-    <%= t('geoblacklight.home.version', version: Geoblacklight::VERSION ) %>
-  </div>
+</div>
+<div id="geoblacklight-version" class="text-end">
+  <%= t('geoblacklight.home.version', version: Geoblacklight::VERSION ) %>
 </div>

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

@@ -1,6 +1,6 @@
 <% document ||= @documents.first %>
 
-<div class='metadata-view'>
+<div class="metadata-view">
   <div class="container-fluid">
     <ul class="nav nav-pills" role="tablist">
       <% document.references.shown_metadata.each do |metadata| %>

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

@@ -1 +1 @@
-<%= content_tag(:div, nil, data: {relations: true, url: solr_document_path(document.id)}) %>
+<%= content_tag(:div, nil, data: {relations: true, url: solr_document_path(document.id)}) %>

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

@@ -5,7 +5,6 @@
 <% unless has_search_parameters? %>
   <%# if there are no input/search related params, display the "home" partial -%>
   <%= render 'home' %>
-  <%= render 'shared/sitelinks_search_box' %>
 <% else %>
   <% content_for(:sidebar) do %>
     <% conf = blacklight_config.view_config(document_index_view_type) %>

data/app/views/catalog/metadata/_markup.html.erb

@@ -1,8 +1,7 @@
 <div id="metadata-markup-container" class="container-fluid">
   <div class="alert alert-warning" role="alert">
-    <span class="glyphicon glyphicon-exclamation-sign" aria-hidden="true"></span>
     <span class="visually-hidden">Error:</span>
-    <span><%= t('geoblacklight.metadata.metadata_error')%></span>
+    <span><%= t('geoblacklight.metadata.transform_error') %></span>
   </div>
   <%= CodeRay.scan(content, :xml).div.html_safe %>
 </div>

data/app/views/catalog/metadata/_missing.html.erb

@@ -1,6 +1,6 @@
 <div id="metadata-error-container" class="container-fluid">
   <div>
-    <h1><%= t('geoblacklight.metadata.metadata_error')%></h1>
+    <h1><%= t('geoblacklight.metadata.metadata_error') %></h1>
   </div>
-  <p><%= t('geoblacklight.metadata.metadata_trace')%></p>
+  <p><%= t('geoblacklight.metadata.metadata_trace') %></p>
 </div>

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

@@ -15,5 +15,5 @@
   <% end %>
   <% component.with_footer do %>
     <button type="button" class="btn btn-secondary" data-bl-dismiss="modal"><%= t('blacklight.modal.close') %></button>
-  <% end %> 
+  <% end %>
 <% end %>

data/app/views/relation/index.html.erb

@@ -1,3 +1,3 @@
-<%- Settings.RELATIONSHIPS_SHOWN.each do |relationship_type, rel_type_info| %>
+<%- Geoblacklight.configuration.relationships_shown.each do |relationship_type, rel_type_info| %>
   <%= render Geoblacklight::RelationsComponent.new(relations: @relations, relationship_type:, rel_type_info:) %>
 <% end %>

data/app/views/relation/index.json.jbuilder

@@ -2,7 +2,7 @@
 
 json.current_doc @relations.search_id
 json.relations do
-  Settings.RELATIONSHIPS_SHOWN.each do |key, _value|
+  Geoblacklight.configuration.relationships_shown.each do |key, _value|
     json.set! key.downcase.to_s, @relations.public_send(key) unless @relations.public_send(key)["numFound"].to_i.zero?
   end
 end

data/config/initializers/rails_config.rb

@@ -3,6 +3,3 @@
 Config.setup do |config|
   config.const_name = "Settings"
 end
-
-Settings.prepend_source!(File.expand_path("new_gbl_settings_defaults_4_1.yml", __dir__))
-Settings.reload!

data/config/locales/geoblacklight.en.yml

@@ -1,99 +1,100 @@
 en:
   geoblacklight:
-    bbox_label: 'Bounding Box'
-    location: 'Location'
+    bbox_label: "Bounding Box"
+    location: "Location"
     clipboard:
       citation: Citation copied to clipboard
       web_service: Web service copied to clipboard
     download:
-      download: 'Download'
-      download_link: 'Original %{download_format}'
-      success: 'Your file %{title} is ready for download'
-      error: 'Sorry, the requested file could not be downloaded.'
-      export_formats: 'Export Formats'
-      export_link: 'Export %{download_format}'
-      export_shapefile_link: 'Shapefile'
-      export_kmz_link: 'KMZ'
-      export_geojson_link: 'GeoJSON'
-      export_geotiff_link: 'GeoTIFF'
-      export_csv_link: 'CSV'
+      download: "Download"
+      download_link: "Original %{download_format}"
+      success: "Your file %{title} is ready for download"
+      error: "Sorry, the requested file could not be downloaded."
+      export_formats: "Export Formats"
+      export_link: "Export %{download_format}"
+      export_shapefile_link: "Shapefile"
+      export_kmz_link: "KMZ"
+      export_geojson_link: "GeoJSON"
+      export_geotiff_link: "GeoTIFF"
+      export_csv_link: "CSV"
     home:
-      headline: 'Explore and discover...'
-      search_heading: 'Find the maps and data you need'
-      category_heading: 'Find by...'
-      map_heading: 'Find by location'
-      institution: 'Institution'
-      data_type: 'Data type'
-      placename: 'Placename'
-      subject: 'Subject'
-      version: 'GeoBlacklight version %{version}'
+      headline: "Explore and discover..."
+      search_heading: "Find the maps and data you need"
+      category_heading: "Find by..."
+      map_heading: "Find by location"
+      institution: "Institution"
+      data_type: "Data type"
+      placename: "Placename"
+      subject: "Subject"
+      version: "GeoBlacklight version %{version}"
     tools:
-      login_to_view: 'Login to View and Download'
-      open_arcgis: 'Open in ArcGIS Online'
+      login_to_view: "Login to View and Download"
+      open_arcgis: "Open in ArcGIS Online"
     formats:
-      arcgrid: 'ArcGRID'
-      geojson: 'GeoJSON'
-      geotiff: 'GeoTIFF'
-      kmz: 'KMZ'
-      shapefile: 'Shapefile'
-      jpg: 'JPG'
-      csv: 'CSV'
-      esri_geodatabase: 'ESRI Geodatabase'
-      sqlite_database: 'SQLite Database'
+      arcgrid: "ArcGRID"
+      geojson: "GeoJSON"
+      geotiff: "GeoTIFF"
+      kmz: "KMZ"
+      shapefile: "Shapefile"
+      jpg: "JPG"
+      csv: "CSV"
+      esri_geodatabase: "ESRI Geodatabase"
+      sqlite_database: "SQLite Database"
     map:
-      label: 'Zoomable map'
+      label: "Zoomable map"
     references:
-      wms: 'Web Mapping Service (WMS)'
-      wms_abv: 'WMS'
-      wms_label: 'layers'
-      wfs: 'Web Feature Service (WFS)'
-      wfs_abv: 'WFS'
-      wfs_label: 'typeNames'
-      iiif: 'International Image Interoperability Framework (IIIF)'
-      iso19139: 'ISO 19139'
-      mods: 'MODS'
-      fgdc: 'FGDC'
-      html: 'HTML'
-      feature_layer: 'ArcGIS Feature Layer'
-      tiled_map_layer: 'ArcGIS Tiled Map Layer'
-      dynamic_map_layer: 'ArcGIS Dynamic Map Layer'
-      image_map_layer: 'ArcGIS Image Map Layer'
-      data_dictionary: 'Documentation'
-      services: 'Web services'
-      tms: 'Tile Map Service'
-      tilejson: 'TileJSON Document'
-      xyz: 'XYZ Tiles'
-      wmts: 'Web Map Tile Service'
-      pmtiles: 'PMTiles Layer'
-      cog: 'COG Layer'
+      wms: "Web Mapping Service (WMS)"
+      wms_abv: "WMS"
+      wms_label: "layers"
+      wfs: "Web Feature Service (WFS)"
+      wfs_abv: "WFS"
+      wfs_label: "typeNames"
+      iiif: "International Image Interoperability Framework (IIIF)"
+      iso19139: "ISO 19139"
+      mods: "MODS"
+      fgdc: "FGDC"
+      html: "HTML"
+      feature_layer: "ArcGIS Feature Layer"
+      tiled_map_layer: "ArcGIS Tiled Map Layer"
+      dynamic_map_layer: "ArcGIS Dynamic Map Layer"
+      image_map_layer: "ArcGIS Image Map Layer"
+      data_dictionary: "Documentation"
+      services: "Web services"
+      tms: "Tile Map Service"
+      tilejson: "TileJSON Document"
+      xyz: "XYZ Tiles"
+      wmts: "Web Map Tile Service"
+      pmtiles: "PMTiles Layer"
+      cog: "COG Layer"
     relations:
-      member_of_ancestors: 'Belongs to collection...'
-      member_of_descendants: 'Collection records...'
-      part_of_ancestors: 'Is part of...'
-      part_of_descendants: 'Has part...'
-      relation_ancestors: 'Related records...'
-      relation_descendants: 'Related records...'
-      replaces_ancestors: 'Replaces...'
-      replaces_descendants: 'Is replaced by...'
-      source_ancestors: 'Source records...'
-      source_descendants: 'Derived records...'
-      version_of_ancestors: 'Is version of...'
-      version_of_descendants: 'Has version...'
+      member_of_ancestors: "Belongs to collection..."
+      member_of_descendants: "Collection records..."
+      part_of_ancestors: "Is part of..."
+      part_of_descendants: "Has part..."
+      relation_ancestors: "Related records..."
+      relation_descendants: "Related records..."
+      replaces_ancestors: "Replaces..."
+      replaces_descendants: "Is replaced by..."
+      source_ancestors: "Source records..."
+      source_descendants: "Derived records..."
+      version_of_ancestors: "Is version of..."
+      version_of_descendants: "Has version..."
       browse_all_no_count: "Browse all records..."
       browse_all: "Browse all %{count} records..."
     modal:
       copy-citation: "Copy Citation"
     metadata:
-      toggle_summary: 'Toggle summary'
-      view_metadata: 'View Metadata'
-      more_details: 'More details at'
-      metadata_error: 'The metadata view for selected schema is not available'
-      metadata_trace: 'Please select another metadata view. Alternately, try downloading the file or reaching out to the holding institution.'
+      metadata_error: The metadata view for selected schema is not available
+      metadata_trace: Please select another metadata view. Alternately, try downloading the file or reaching out to the holding institution.
+      more_details: More details at
+      toggle_summary: Toggle summary
+      transform_error: HTML view for selected schema is not available
+      view_metadata: View Metadata
     show:
-      attribute: 'Attribute'
-      value: 'Value'
-      click_map: 'Click on map to inspect values'
-      table_name: 'Map data'
+      attribute: "Attribute"
+      value: "Value"
+      click_map: "Click on map to inspect values"
+      table_name: "Map data"
     help_text:
       viewer_protocol:
         cog:

data/geoblacklight.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.required_rubygems_version = ">= 2.5.2"
 
   spec.add_dependency "rails", ">= 6.1", "< 9"
-  spec.add_dependency "blacklight", "~> 8.0"
+  spec.add_dependency "blacklight", ">= 8.0", "< 10"
   spec.add_dependency "config"
   spec.add_dependency "faraday", "~> 2.0"
   spec.add_dependency "coderay"
@@ -28,7 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mime-types"
   spec.add_dependency "rgeo-geojson"
   spec.add_dependency "rsolr"
-  spec.add_dependency "vite_rails", "~> 3.0"
   spec.add_dependency "zeitwerk"
 
   spec.add_development_dependency "rails-controller-testing"

data/lib/generators/geoblacklight/assets_generator.rb

@@ -1,36 +1,45 @@
 # frozen_string_literal: true
 
 module Geoblacklight
-  # Run general asset setup and then delegate to the appropriate generator
-  # Based on Blacklight::AssetsGenerator
+  # Set up the delivery strategies for CSS and JS assets.
   class AssetsGenerator < Rails::Generators::Base
-    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.
-    #
-    # If a branch was specified (e.g. you are running a template.rb build
-    # against a test branch), use the latest version available on npm.
-    #
-    # Otherwise, pick the version from npm that matches our Geoblacklight
-    # gem version.
-    def add_frontend
-      if ENV["BRANCH"]
-        run "yarn add @geoblacklight/frontend@latest"
-      else
-        run "yarn add @geoblacklight/frontend@#{Geoblacklight::VERSION}"
-      end
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc <<-DESCRIPTION
+      This generator sets up compilation/delivery of JS and CSS. It assumes that
+      the JS pipeline is importmaps (the default in Rails 8) and that the CSS
+      pipeline has already been created via the `rails new` option --css=bootstrap.
+
+      JS sources from the Blacklight and Geoblacklight gems are delivered as
+      ES modules via importmap, and their dependencies are pinned to versions
+      delivered via CDN.
+
+      CSS needed for Geoblacklight's dependencies (e.g. leaflet viewer) are
+      imported via CDN in the app's main bootstrap stylesheet. Geoblacklight's own
+      stylesheet is imported from the frontend asset package installed via yarn.
+    DESCRIPTION
+
+    # 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", %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
 
-    def run_asset_pipeline_specific_generator
-      generated_options = "--test=true" if options[:test]
-      generator = if options[:"asset-pipeline"]
-        "geoblacklight:assets:#{options[:"asset-pipeline"]}"
-      else
-        "geoblacklight:assets:importmap"
-      end
+    # Import Geoblacklight's JS using the name that importmap has pinned
+    def add_geoblacklight_js
+      append_to_file "app/javascript/application.js", 'import Geoblacklight from "geoblacklight";'
+    end
+
+    # Add Geoblacklight's stylesheet
+    def add_geoblacklight_styles
+      append_to_file "app/assets/stylesheets/application.css", "@import url(\"geoblacklight.css\");"
+    end
 
-      generate generator, generated_options
+    # Add the CSS customization override stylesheet
+    def add_customizations
+      copy_file "assets/customizations.css", "app/assets/stylesheets/customizations.css"
+      append_to_file "app/assets/stylesheets/application.css", "\n@import url(\"customizations.css\");"
     end
   end
 end

data/lib/generators/geoblacklight/install_generator.rb

@@ -4,18 +4,16 @@ require "rails/generators"
 
 module Geoblacklight
   class Install < Rails::Generators::Base
-    source_root File.expand_path("../templates", __FILE__)
+    source_root File.expand_path("templates", __dir__)
     desc "Install Geoblacklight"
 
-    class_option :test, type: :boolean, default: false, aliases: "-t", desc: "Indicates that app will be installed in a test environment"
-
     def allow_geoblacklight_params
       gbl_params = <<-PARAMS
         before_action :allow_geoblacklight_params
 
         def allow_geoblacklight_params
           # Blacklight::Parameters will pass these to params.permit
-          blacklight_config.search_state_fields.append(Settings.GBL_PARAMS)
+          blacklight_config.search_state_fields.append(Geoblacklight.configuration.gbl_params)
         end
       PARAMS
 
@@ -23,7 +21,8 @@ module Geoblacklight
     end
 
     def raise_unpermitted_params
-      inject_into_file "config/environments/test.rb", "config.action_controller.action_on_unpermitted_parameters = :raise\n", before: /^end/
+      inject_into_file "config/environments/test.rb",
+        "config.action_controller.action_on_unpermitted_parameters = :raise\n", before: /^end/
     end
 
     def mount_geoblacklight_engine
@@ -79,7 +78,7 @@ module Geoblacklight
 
     def add_unique_key
       inject_into_file "app/models/solr_document.rb", after: "# self.unique_key = 'id'" do
-        "\n  self.unique_key = Settings.FIELDS.UNIQUE_KEY"
+        "\n  self.unique_key = Geoblacklight.configuration.fields.id"
       end
     end
 
@@ -103,11 +102,7 @@ module Geoblacklight
     end
 
     def generate_assets
-      if options[:test]
-        generate "geoblacklight:assets", "--test=true"
-      else
-        generate "geoblacklight:assets"
-      end
+      generate "geoblacklight:assets"
     end
   end
 end

data/lib/generators/geoblacklight/templates/assets/customizations.css

@@ -0,0 +1,6 @@
+/* Local Application Customizations */
+
+:root {
+  /* Header Logo */
+  --bl-logo-image: url("geoblacklight/logo.svg");
+}