geoblacklight 4.4.1 → 5.0.0.pre.alpha.11

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

@@ -35,7 +35,7 @@ class CatalogController < ApplicationController
     # solr field configuration for search results/index views
     # config.index.show_link = 'title_display'
     # config.index.record_display_type = 'format'
-
+    config.index.document_component = Geoblacklight::SearchResultComponent
     config.index.title_field = Settings.FIELDS.TITLE
 
     # solr field configuration for document/show views
@@ -43,16 +43,9 @@ class CatalogController < ApplicationController
     # To move metadata above the map viewer,
     # remove the lines deleting and re-adding the :show partial
     config.show.display_type_field = "format"
-    config.show.partials.delete(:show)
-    config.show.partials << "show_default_display_note"
-    config.show.partials << "show_default_viewer_container"
-    config.show.partials << "show_default_attribute_table"
-    config.show.partials << "show_default_viewer_information"
-    config.show.partials << :show
-
-    ##
-    # Configure the index document presenter.
-    config.index.document_presenter_class = Geoblacklight::DocumentPresenter
+    config.show.document_component = Geoblacklight::DocumentComponent
+    config.show.sidebar_component = Geoblacklight::Document::SidebarComponent
+    config.header_component = Geoblacklight::HeaderComponent
 
     # solr fields that will be treated as facets by the blacklight application
     #   The ordering of the field names is the order of the display
@@ -307,9 +300,8 @@ class CatalogController < ApplicationController
 
     # Custom tools for GeoBlacklight
     config.add_show_tools_partial :metadata, if: proc { |_context, _config, options| options[:document] && (Settings.METADATA_SHOWN & options[:document].references.refs.map(&:type).map(&:to_s)).any? }
-    config.add_show_tools_partial :carto, partial: "carto", if: proc { |_context, _config, options| options[:document] && options[:document].carto_reference.present? }
-    config.add_show_tools_partial :arcgis, partial: "arcgis", if: proc { |_context, _config, options| options[:document] && options[:document].arcgis_urls.present? }
-    config.add_show_tools_partial :data_dictionary, partial: "data_dictionary", if: proc { |_context, _config, options| options[:document] && options[:document].data_dictionary_download.present? }
+    config.add_show_tools_partial :arcgis, component: Geoblacklight::ArcgisComponent, if: proc { |_context, _config, options| options[:document] && options[:document].arcgis_urls.present? }
+    config.add_show_tools_partial :data_dictionary, component: Geoblacklight::DataDictionaryDownloadComponent, if: proc { |_context, _config, options| options[:document] && options[:document].data_dictionary_download.present? }
 
     # Configure basemap provider for GeoBlacklight maps (uses https only basemap
     # providers with open licenses)
@@ -332,7 +324,7 @@ class CatalogController < ApplicationController
   end
 
   def web_services
-    @response, @documents = action_documents
+    @docs = action_documents
 
     respond_to do |format|
       format.html do

data/lib/generators/geoblacklight/templates/demo-app/Dockerfile

@@ -0,0 +1,31 @@
+# syntax = docker/dockerfile:1
+
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
+ARG RUBY_VERSION=3.3.4
+FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim AS base
+
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential git pkg-config nodejs npm curl libsqlite3-0
+
+RUN npm install --global yarn
+
+ENV RAILS_ENV="development" \
+    BUNDLE_PATH="/usr/local/bundle"
+
+# Rails app lives here
+WORKDIR /rails
+
+# Install gems and javascript packages
+COPY Gemfile .
+RUN bundle install
+COPY package.json .
+RUN yarn install
+
+FROM ghcr.io/geoblacklight/geoblacklight:base AS app
+
+# Add application code
+COPY . .
+
+# Run the server script by default, this can be overwritten at runtime
+EXPOSE 3000
+CMD ["sh", "start-server"]

data/lib/generators/geoblacklight/templates/demo-app/compose.yml

@@ -0,0 +1,26 @@
+services:
+  app:
+    image: ghcr.io/geoblacklight/geoblacklight:main
+    ports:
+      - "3001:3001"
+    links:
+      - "solr:solr"
+    environment:
+      SOLR_URL: "http://solr:8983/solr/blacklight-core"
+      RAILS_DEVELOPMENT_HOSTS: ".githubpreview.dev,.preview.app.github.dev,.app.github.dev,.csb.app"
+    depends_on:
+      - solr
+    command: sh start-server.sh
+  solr:
+    image: solr:9.6.1
+    volumes:
+      - $PWD/solr/conf:/opt/solr/conf
+    ports:
+      - 8984:8983
+    entrypoint:
+      - docker-entrypoint.sh
+      - solr-precreate
+      - blacklight-core
+      - /opt/solr/conf
+      - "-Xms256m"
+      - "-Xmx512m"

data/lib/generators/geoblacklight/templates/demo-app/start-server.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+bundle install
+yarn install
+
+# Build and Install local copy of @geoblackligt/frontend
+# These steps are included in the docker image instead if the image build script
+# to reduce the size of the layers that docker compose has to pull with each new version.
+gempath=$(bundle exec gem which geoblacklight | sed 's/\/lib\/geoblacklight.rb//')
+if [ ! -d "$gempath/dist/" ]; then
+  cd $gempath
+  yarn install
+  yarn vite build
+  cd -
+fi
+yarn add file:$gempath
+
+# Start the server
+bundle exec rake db:prepare
+bundle exec rake geoblacklight:index:seed
+bundle exec rails server -b 0.0.0.0 -p 3001

data/lib/generators/geoblacklight/templates/package.json

@@ -1,6 +1,12 @@
 {
   "dependencies": {
-    "@geoblacklight/frontend": "^4.4"
+    "@github/auto-complete-element": "3.6.2",
+    "@hotwired/stimulus": "^3.2.2",
+    "@hotwired/turbo-rails": "^8.0.4",
+    "@popperjs/core": "2.11.8",
+    "blacklight-frontend": "8.3.0",
+    "bootstrap": "^5.3.3",
+    "sass": "^1.77.7"
   },
   "devDependencies": {
     "vite": "^5.1.5",

data/lib/generators/geoblacklight/templates/settings.yml

@@ -1,9 +1,3 @@
-# Configurable Logo Used for CartoDB export
-APPLICATION_LOGO_URL: 'http://geoblacklight.org/images/geoblacklight-logo.png'
-
-# Carto OneClick Service https://carto.com/engine/open-in-carto/
-CARTO_ONECLICK_LINK: 'http://oneclick.carto.com/'
-
 # ArcGIS Online Base URL
 ARCGIS_BASE_URL: 'https://www.arcgis.com/home/webmap/viewer.html'
 
@@ -98,7 +92,7 @@ METADATA_SHOWN:
   - 'html'
 
 # (For external Download) timeout and open_timeout parameters for Faraday
-TIMEOUT_DOWNLOAD: 16
+TIMEOUT_DOWNLOAD: 180
 
 # (For WMS inspection) timeout and open_timeout parameters for Faraday
 TIMEOUT_WMS: 4
@@ -215,7 +209,15 @@ RELATIONSHIPS_SHOWN:
     inverse: :VERSION_OF_ANCESTORS
     label: geoblacklight.relations.version_of_descendants
     query_type: descendants
-    
+
+# Vector data download formats to be displayed
+DOWNLOAD_FORMATS:
+  VECTOR:
+    - 'Shapefile'
+    - 'KMZ'
+    - 'GeoJSON'
+    - 'CSV'
+
 # WMS Parameters
 WMS_PARAMS:
   :SERVICE: 'WMS'
@@ -224,11 +226,19 @@ WMS_PARAMS:
   :STYLES: ''
   :SRS: 'EPSG:4326'
   :EXCEPTIONS: 'application/json'
-  :INFO_FORMAT: 'text/html'
+  :INFO_FORMAT: 'application/json'
 
 # Settings for leaflet
 LEAFLET:
   MAP:
+  BOUNDSOVERLAY:
+    INDEX:
+      color: '#3388ff'
+    SHOW:
+      color: '#3388ff'
+    STATIC_MAP:
+      color: '#3388ff'
+  SELECTED_COLOR: "#2C7FB8"
   LAYERS:
     DETECT_RETINA: true
     INDEX:
@@ -236,57 +246,52 @@ LEAFLET:
         color: "#7FCDBB"
         weight: 1
         radius: 4
+        sr_color_name: "Green"
       UNAVAILABLE:
         <<: *default
         color: "#EDF8B1"
+        sr_color_name: "Yellow"
       SELECTED:
         <<: *default
         color: "#2C7FB8"
-  VIEWERS:
-    DYNAMICMAPLAYER:
-      CONTROLS:
-        - 'Opacity'
-        - 'Fullscreen'
-    FEATURELAYER:
-      CONTROLS:
-        - 'Opacity'
-        - 'Fullscreen'
-    IIIF:
-      CONTROLS:
-        - 'Fullscreen'
-    IMAGEMAPLAYER:
-      CONTROLS:
-        - 'Opacity'
-        - 'Fullscreen'
-    INDEXMAP:
-      CONTROLS:
-        - 'Fullscreen'
-    TILEDMAPLAYER:
-      CONTROLS:
-        - 'Opacity'
-        - 'Fullscreen'
-    WMS:
-      CONTROLS:
-        - 'Opacity'
-        - 'Fullscreen'
+        sr_color_name: "Blue"
 
 # Toggle the help text feature that offers users context
 HELP_TEXT:
   viewer_protocol:
+      - 'cog'
       - 'dynamic_map_layer'
       - 'feature_layer'
       - 'iiif'
       - 'iiif_manifest'
       - 'image_map_layer'
       - 'index_map'
-      - 'tiled_map_layer'
-      - 'wms'
-      - 'tms'
       - 'oembed'
       - 'pmtiles'
-      - 'cog'
+      - 'tiled_map_layer'
+      - 'tilejson'
+      - 'tms'
+      - 'wms'
+      - 'wmts'
+      - 'xyz'
 
 # Enable catalog#show sidebar static map for items with the following viewer protocols
 SIDEBAR_STATIC_MAP:
   - 'iiif'
   - 'iiif_manifest'
+
+IIIF_DRAG_DROP_LINK: '@manifest?manifest=@manifest'
+
+ICON_MAPPING:
+  chicago: university-of-chicago
+  illinois: university-of-illinois-urbana-champaign
+  iowa: university-of-iowa
+  maryland: university-of-maryland
+  michigan-state: michigan-state-university
+  michigan: university-of-michigan
+  minnesota: university-of-minnesota
+  nebraska: university-of-nebraska-lincoln
+  ohio-state: the-ohio-state-university
+  penn-state: pennsylvania-state-university
+  purdue: purdue-university
+  wisconsin: university-of-wisconsin-madison

data/lib/generators/geoblacklight/templates/vite.config.ts

@@ -1,8 +1,23 @@
-import { defineConfig } from 'vite'
-import rails from 'vite-plugin-rails'
+import { defineConfig, searchForWorkspaceRoot } from "vite";
+import rails from "vite-plugin-rails";
 
-export default defineConfig({
-  plugins: [
-    rails(),
-  ]
-})
+export default defineConfig(({ mode }) => {
+  return {
+    build: {
+      minify: mode === "production",
+      manifest: true,
+      sourcemap: true,
+    },
+    server: {
+      fs: {
+        allow: [
+          // search up for workspace root
+          searchForWorkspaceRoot(process.cwd()),
+          // One directory up (from .internal_test_app where we do `yarn link @geoblacklight`)
+          `${process.cwd()}/..`,
+        ],
+      },
+    },
+    plugins: [rails()],
+  };
+});

data/lib/geoblacklight/bounding_box.rb

@@ -28,6 +28,22 @@ module Geoblacklight
       "#{west} #{south} #{east} #{north}"
     end
 
+    # Output a GeoJSON representation of the bounding box
+    def to_geojson
+      {
+        "type" => "Polygon",
+        "coordinates" => [
+          [
+            [west.to_f, south.to_f],
+            [west.to_f, north.to_f],
+            [east.to_f, north.to_f],
+            [east.to_f, south.to_f],
+            [west.to_f, south.to_f]
+          ]
+        ]
+      }.to_json
+    end
+
     ##
     # Create a Geoblacklight::BoundingBox from a Solr rectangle syntax
     # @param [String] bbox as "W S E N"

data/lib/geoblacklight/constants.rb

@@ -21,7 +21,6 @@ module Geoblacklight
       tms: "https://wiki.osgeo.org/wiki/Tile_Map_Service_Specification",
       tilejson: "https://github.com/mapbox/tilejson-spec",
       xyz: "https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames",
-      hgl: "http://schema.org/DownloadAction",
       feature_layer: "urn:x-esri:serviceType:ArcGIS#FeatureLayer",
       tiled_map_layer: "urn:x-esri:serviceType:ArcGIS#TiledMapLayer",
       dynamic_map_layer: "urn:x-esri:serviceType:ArcGIS#DynamicMapLayer",

data/lib/geoblacklight/download/csv_download.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class CsvDownload < Geoblacklight::Download
+    CSV_DOWNLOAD_PARAMS = {service: "wfs",
+                           version: "2.0.0",
+                           request: "GetFeature",
+                           srsName: "EPSG:4326",
+                           outputformat: "csv"}.freeze
+
+    def initialize(document, options = {})
+      request_params = CSV_DOWNLOAD_PARAMS.merge(typeName: document.wxs_identifier)
+      super(document, {
+        type: "csv",
+        extension: "csv",
+        request_params: request_params,
+        content_type: "text/csv",
+        service_type: "wfs"
+      }.merge(options))
+    end
+  end
+end

data/lib/geoblacklight/download/geojson_download.rb

@@ -11,7 +11,7 @@ module Geoblacklight
     }.freeze
 
     def initialize(document, options = {})
-      request_params = GEOJSON_DOWNLOAD_PARAMS.merge(typeName: document[Settings.FIELDS.WXS_IDENTIFIER])
+      request_params = GEOJSON_DOWNLOAD_PARAMS.merge(typeName: document.wxs_identifier)
       super(document, {
         type: "geojson",
         extension: "json",

data/lib/geoblacklight/download/geotiff_download.rb

@@ -8,7 +8,7 @@ module Geoblacklight
     }.freeze
 
     def initialize(document, options = {})
-      request_params = GEOTIFF_DOWNLOAD_PARAMS.merge(layers: document[Settings.FIELDS.WXS_IDENTIFIER])
+      request_params = GEOTIFF_DOWNLOAD_PARAMS.merge(layers: document.wxs_identifier)
       super(document, {
         type: "geotiff",
         extension: "tif",

data/lib/geoblacklight/download/kmz_download.rb

@@ -11,7 +11,7 @@ module Geoblacklight
 
     def initialize(document, options = {})
       bbox_wsen = document.geometry.bounding_box
-      request_params = KMZ_DOWNLOAD_PARAMS.merge(layers: document[Settings.FIELDS.WXS_IDENTIFIER], bbox: bbox_wsen)
+      request_params = KMZ_DOWNLOAD_PARAMS.merge(layers: document.wxs_identifier, bbox: bbox_wsen)
       super(document, {
         type: "kmz",
         extension: "kmz",

data/lib/geoblacklight/download/shapefile_download.rb

@@ -9,7 +9,7 @@ module Geoblacklight
                                  outputformat: "SHAPE-ZIP"}.freeze
 
     def initialize(document, options = {})
-      request_params = SHAPEFILE_DOWNLOAD_PARAMS.merge(typeName: document[Settings.FIELDS.WXS_IDENTIFIER])
+      request_params = SHAPEFILE_DOWNLOAD_PARAMS.merge(typeName: document.wxs_identifier)
       super(document, {
         type: "shapefile",
         extension: "zip",

data/lib/geoblacklight/download.rb

@@ -102,7 +102,7 @@ module Geoblacklight
     # URL for download
     # @return [String] URL that is checked in download
     def url
-      url = @document.references.send(@options[:service_type]).endpoint
+      url = @document.references.public_send(@options[:service_type]).endpoint
       url += "/reflect" if @options[:reflect]
       url
     end

data/lib/geoblacklight/engine.rb

@@ -7,7 +7,6 @@ require "faraday"
 require "geoblacklight/version"
 require "nokogiri"
 require "mime/types"
-require "handlebars_assets"
 
 module Geoblacklight
   class Engine < ::Rails::Engine
@@ -16,14 +15,24 @@ module Geoblacklight
     initializer "geoblacklight.helpers" do
       config.after_initialize do
         ActionView::Base.send :include, GeoblacklightHelper
-        ActionView::Base.send :include, CartoHelper
       end
     end
 
-    config.to_prepare do
-      unless SearchHistoryController.helpers.is_a?(Geoblacklight::ViewHelperOverride)
-        SearchHistoryController.send(:helper, Geoblacklight::ViewHelperOverride)
-      end
+    PRECOMPILE_ASSETS = %w[favicon.ico geoblacklight/geoblacklight.umd.cjs geoblacklight/geoblacklight.umd.cjs.map geoblacklight/geoblacklight.js geoblacklight/geoblacklight.js.map].freeze
+
+    # Make the source JS and CSS available to built apps
+    initializer "geoblacklight.assets" do |app|
+      app.config.assets.paths << Geoblacklight::Engine.root.join("app/javascript")
+      app.config.assets.paths << Geoblacklight::Engine.root.join("app/assets")
+      app.config.assets.precompile += Geoblacklight::Engine::PRECOMPILE_ASSETS
+    end
+
+    # Add the Geoblacklight importmap to the built app's importmap
+    initializer "geoblacklight.importmap", before: "importmap" do |app|
+      next unless app.config.respond_to?(:importmap) # skip for Vite
+
+      app.config.importmap.paths << Engine.root.join("config/importmap.rb")
+      app.config.importmap.cache_sweepers << Engine.root.join("app/assets/javascripts")
     end
   end
 end

data/lib/geoblacklight/item_viewer.rb

@@ -7,7 +7,7 @@ module Geoblacklight
     end
 
     def viewer_protocol
-      return "map" if viewer_preference.nil?
+      return if viewer_preference.nil?
       viewer_preference.keys.first.to_s
     end
 

data/lib/geoblacklight/metadata/base.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require "geoblacklight/faraday_middleware/follow_redirects"
+require "geo_combine"
+
 module Geoblacklight
   module Metadata
     ##

data/lib/geoblacklight/references.rb

@@ -4,6 +4,7 @@ module Geoblacklight
   # References is a geoblacklight-schema dct:references parser
   class References
     attr_reader :refs, :reference_field
+
     def initialize(document, reference_field = Settings.FIELDS.REFERENCES)
       @document = document
       @reference_field = reference_field
@@ -31,7 +32,7 @@ module Geoblacklight
     # Accessor for a document's file format
     # @return [String] file format for the document
     def format
-      @document[Settings.FIELDS.FORMAT]
+      @document.file_format
     end
 
     ##
@@ -72,9 +73,9 @@ module Geoblacklight
     ##
     # Returns all of the Esri webservices for given set of references
     def esri_webservices
-      %w[tiled_map_layer dynamic_map_layer feature_layer image_map_layer].map do |layer_type|
+      %w[tiled_map_layer dynamic_map_layer feature_layer image_map_layer].filter_map do |layer_type|
         send(layer_type)
-      end.compact
+      end
     end
 
     private
@@ -103,11 +104,29 @@ module Geoblacklight
     # @return (see #downloads_by_format)
     def vector_download_formats
       return unless wms.present? && wfs.present?
-      {
-        shapefile: wfs.to_hash,
-        kmz: wms.to_hash,
-        geojson: wfs.to_hash
-      }
+
+      download_formats = {}
+      format_list.each { |format| download_formats.merge!(web_service_hash(format)) }
+      download_formats
+    end
+
+    def format_list
+      Settings.DOWNLOAD_FORMATS&.VECTOR
+    end
+
+    def web_service_hash(format)
+      case format
+      when "Shapefile"
+        {shapefile: wfs.to_hash}
+      when "KMZ"
+        {kmz: wms.to_hash}
+      when "GeoJSON"
+        {geojson: wfs.to_hash}
+      when "CSV"
+        {csv: wfs.to_hash}
+      else
+        {}
+      end
     end
 
     ##

data/lib/geoblacklight/routes/downloadable.rb

@@ -9,7 +9,6 @@ module Geoblacklight
 
       def call(mapper, _options = {})
         mapper.get "file/:id", action: "file", as: :file
-        mapper.get "hgl/:id", action: "hgl", as: :hgl
       end
     end
   end

data/lib/geoblacklight/routes.rb

@@ -2,8 +2,5 @@
 
 module Geoblacklight
   module Routes
-    require "geoblacklight/routes/exportable"
-    require "geoblacklight/routes/downloadable"
-    require "geoblacklight/routes/wms"
   end
 end

data/lib/geoblacklight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Geoblacklight
-  VERSION = "4.4.1"
+  VERSION = "5.0.0-alpha.11"
 end

data/lib/geoblacklight/wms_layer/feature_info_response.rb

@@ -15,15 +15,18 @@ module Geoblacklight
     end
 
     def format
+      JSON.parse(@response.body)
+    rescue
       page = Nokogiri::HTML(@response.body)
-      table_values = {values: []}
-      page.css("th").each do |th|
-        table_values[:values].push([th.text])
-      end
+      properties = {}
+      values = {}
       page.css("td").each_with_index do |td, index|
-        table_values[:values][index].push(td.text) unless index >= table_values[:values].count
+        values[index] = td.text
+      end
+      page.css("th").each_with_index do |th, index|
+        properties[th.text] = values[index] unless index >= values.keys.count
       end
-      table_values
+      {features: [{properties: properties, isHTML: true}]}
     end
 
     def error?

data/lib/geoblacklight.rb

@@ -2,38 +2,14 @@
 
 require "active_support/dependencies"
 require "geoblacklight/engine"
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/generators")
+loader.collapse("#{__dir__}/geoblacklight/download")
+loader.collapse("#{__dir__}/geoblacklight/wms_layer")
+loader.setup
 
 module Geoblacklight
-  require "geoblacklight/bounding_box"
-  require "geoblacklight/constants"
-  require "geoblacklight/exceptions"
-  require "geoblacklight/geometry"
-  require "geoblacklight/view_helper_override"
-  require "geoblacklight/item_viewer"
-  require "geoblacklight/wms_layer"
-  require "geoblacklight/wms_layer/feature_info_response"
-  require "geoblacklight/download"
-  require "geoblacklight/download/geojson_download"
-  require "geoblacklight/download/geotiff_download"
-  require "geoblacklight/download/kmz_download"
-  require "geoblacklight/download/shapefile_download"
-  require "geoblacklight/download/hgl_download"
-  require "geoblacklight/metadata"
-  require "geoblacklight/metadata/base"
-  require "geoblacklight/metadata/fgdc"
-  require "geoblacklight/metadata/html"
-  require "geoblacklight/metadata/iso19139"
-  require "geoblacklight/metadata_transformer"
-  require "geoblacklight/metadata_transformer/base"
-  require "geoblacklight/metadata_transformer/fgdc"
-  require "geoblacklight/metadata_transformer/iso19139"
-  require "geoblacklight/reference"
-  require "geoblacklight/references"
-  require "geoblacklight/routes"
-  require "geoblacklight/relation/descendants"
-  require "geoblacklight/relation/ancestors"
-  require "geoblacklight/relation/relation_response"
-
   def self.logger
     ::Rails.logger
   end