geoblacklight 6.0.0.pre.alpha.4 → 6.0.0.pre.alpha.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bc08775ce43be834055ae0929613c3872f8e5fc1b13f5985cc1dfab51b384d1
-  data.tar.gz: 0d08ac047b371ffa9601de005203705969f0071a5f444e23218bc21baf687e77
+  metadata.gz: 8694955d2e5e0482fdb3da16e55b5fe2b7aaa49d4d2d7bb9f1125cfdabc5ab25
+  data.tar.gz: 21165fb729027815df18f5c038d63600b603bbec571e00c9298af245af793612
 SHA512:
-  metadata.gz: 32c66c5ef1eed6e979587dc8e7d34eeea4ad41ebcb30ab7d3c1be73fc62d7df820c28db6986d3428ec4da986e95ba3366dbdae1ac2ac71609a4bf188c127f9fe
-  data.tar.gz: ef0e4356f8fe1391422c08a88517426f23a0767d93cbc749346bac0d03ac80da21771376cd4e5a59c2d8a017cabd081619fa984ffcb21366d06dba728519a2b1
+  metadata.gz: 247f475b99b5ac95cf7f4578034b54112a82fedcc82ddb92916a7876e8e5daae7144d46b4c7a13c2d1b03588446e91dfb33ffed5a3da0fd25ef688f9d2d8b53b
+  data.tar.gz: 6ad85ca5ef899d7b706854ea3255f01f87e7adfa694bbf42edc0ed56838c0819c79698727c022adebdd9d68f094e6bbf5562e4a7eb4dab32af476f3800c20553

data/Rakefile

@@ -52,7 +52,6 @@ namespace :geoblacklight do
     task seed: ["engine_cart:generate"] do
       within_test_app do
         system "bundle exec rake geoblacklight:index:seed"
-        system "bundle exec rake geoblacklight:downloads:mkdir"
       end
     end
   end

data/app/assets/stylesheets/geoblacklight/record.css

@@ -33,11 +33,47 @@
 
 /* Sidebar */
 .page-sidebar {
-  .card + .card {
+  .card + .card,
+  turbo-frame .card {
     margin-top: 1rem;
   }
 
+  .card ul {
+    margin-bottom: 0;
+  }
+
   .card-header {
     font-weight: 500;
   }
 }
+
+/* Login button */
+.login-btn {
+  --gbl-login-btn-bg: rgba(var(--bs-body-color-rgb), 0.03);
+
+  --bs-btn-color: var(--gbl-login-btn-color);
+  --bs-btn-bg: var(--gbl-login-btn-bg);
+  --bs-btn-border-color: var(--bs-border-color-translucent);
+  --bs-btn-hover-color: var(--gbl-login-btn-color);
+  --bs-btn-hover-bg: var(--gbl-login-btn-bg);
+  --bs-btn-hover-border-color: var(--bs-border-color-translucent);
+}
+
+/* Downloads */
+.download a {
+  display: block;
+
+  .title {
+    margin: 0;
+    display: inline;
+  }
+
+  .badge {
+    float: inline-end;
+    margin-top: 0.1em;
+  }
+
+  .badge + .title {
+    word-break: break-all;
+  }
+}

data/app/components/geoblacklight/document/download_link_component.html.erb

@@ -0,0 +1,6 @@
+<li class="download list-group-item list-group-item-action">
+  <%= link_to url, class: 'nav-link', data: @data do %>
+    <% if file_type.present? %><span class="badge text-bg-secondary"><%= file_type %></span><% end %>
+    <p class="title"><%= title %></p>
+  <% end %>
+</li>

data/app/components/geoblacklight/document/download_link_component.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  module Document
+    # A single resource available for download on a record
+    class DownloadLinkComponent < ViewComponent::Base
+      attr_reader :url
+
+      # @param url [String] the URL of the download link
+      # @param title [String, nil] the title of the download link
+      # @param file_type [String, nil] file type for what will be downloaded (e.g. zip)
+      # @param data_file_type [String, nil] file type for the actual data (e.g. Shapefile)
+      def initialize(url:, title: nil, file_type: nil, data_file_type: nil)
+        @url = url
+        @title = title
+        @file_type = file_type
+        @data_file_type = data_file_type
+        super()
+      end
+
+      # Use format to label the download if no title is provided
+      def title
+        @title || generated_title_from_format || title_from_format
+      end
+
+      # Infer the file type from the URL if not provided
+      def file_type
+        @file_type || wfs_file_type || requested_file_type || file_extension
+      end
+
+      private
+
+      def format_label
+        t(@data_file_type&.downcase || file_type, scope: "geoblacklight.formats", default: @data_file_type || file_type)
+      end
+
+      def title_from_format
+        t("geoblacklight.download.original_link", download_format: format_label)
+      end
+
+      def generated_title_from_format
+        t("geoblacklight.download.generated_link", download_format: format_label) if generated?
+      end
+
+      def file_extension
+        File.extname(url).delete(".").upcase
+      end
+
+      def requested_file_type
+        url.match(/format=([^&]+)/)&.captures&.first&.upcase
+      end
+
+      def wfs_file_type
+        url.match(/outputFormat=([^&]+)/)&.captures&.first&.upcase if generated_via_wfs?
+      end
+
+      def generated?
+        url.match?(/format=([^&]+)/) || generated_via_wfs?
+      end
+
+      def generated_via_wfs?
+        url.match?(/service=WFS/i)
+      end
+    end
+  end
+end

data/app/components/geoblacklight/document/download_links_component.html.erb

@@ -0,0 +1,8 @@
+<div data-controller="downloads" class="downloads card">
+  <div class="card-header"><%= t("geoblacklight.download.downloads") %></div>
+  <ul class="list-group list-group-flush">
+    <% download_links.each do |link| %>
+      <%= render link %>
+    <% end %>
+  </ul>
+</div>

data/app/components/geoblacklight/document/download_links_component.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  module Document
+    # Display expandable file download links in sidebar
+    class DownloadLinksComponent < ViewComponent::Base
+      attr_reader :document
+
+      def initialize(document:)
+        @document = document
+        super()
+      end
+
+      def render?
+        download_links.any? && helpers.document_available?(document)
+      end
+
+      def download_links
+        (direct_download_links + iiif_download_links).compact
+      end
+
+      # Direct download links to files
+      def direct_download_links
+        direct_downloads = Array(document.direct_download&.dig(:download))
+        return [] unless direct_downloads.present?
+
+        # Use label and url for multiple downloads; use format to label otherwise
+        direct_downloads.map do |entry|
+          if entry.is_a?(Hash)
+            Geoblacklight::Document::DownloadLinkComponent.new(
+              title: entry["label"],
+              url: entry["url"]
+            )
+          else
+            Geoblacklight::Document::DownloadLinkComponent.new(
+              url: entry,
+              data_file_type: document.file_format
+            )
+          end
+        end
+      end
+
+      # Links to IIIF image and manifest downloads
+      def iiif_download_links
+        [
+          document.iiif_download.present? && Geoblacklight::Document::DownloadLinkComponent.new(
+            title: t("geoblacklight.download.iiif_image_link"),
+            url: document.iiif_download[:iiif].sub(/\/info\.json$/, "/full/full/0/default.jpg")
+          ),
+          document.references.iiif_manifest.present? && Geoblacklight::Document::DownloadLinkComponent.new(
+            title: t("geoblacklight.download.iiif_manifest_link"),
+            url: document.references.iiif_manifest.endpoint,
+            file_type: "JSON"
+          )
+        ].compact_blank
+      end
+    end
+  end
+end

data/app/components/geoblacklight/document/sidebar_component.html.erb

@@ -1,11 +1,5 @@
-<%= render_static_map_component %>
 <%= render_show_tools %>
 
-<div class="sidebar-buttons mt-3">
-  <% sidebar_buttons.each do | sidebar_button | %>
-    <%= render sidebar_button %>
-  <% end %>
-</div>
-
-<%= render_more_like_this %>
-<%= render Geoblacklight::Document::RelationsContainerComponent.new(document: document) %>
+<% panels.each do |panel| %>
+  <%= render panel %>
+<% end %>

data/app/components/geoblacklight/document/sidebar_component.rb

@@ -3,20 +3,15 @@
 module Geoblacklight
   module Document
     class SidebarComponent < Blacklight::Document::SidebarComponent
-      def render_static_map_component
-        render Geoblacklight::StaticMapComponent.new(document:)
-      end
-
-      def sidebar_buttons
+      def panels
         [
-          Geoblacklight::DownloadLinksComponent.new(document:),
-          Geoblacklight::LoginLinkComponent.new(document:)
+          Geoblacklight::StaticMapComponent.new(document:),
+          Geoblacklight::Document::DownloadLinksComponent.new(document:),
+          Geoblacklight::LoginLinkComponent.new(document:),
+          Geoblacklight::Document::RelationsContainerComponent.new(document: document),
+          Blacklight::Document::MoreLikeThisComponent.new(document:)
         ]
       end
-
-      def render_more_like_this
-        render Blacklight::Document::MoreLikeThisComponent.new(document:)
-      end
     end
   end
 end

data/app/components/geoblacklight/login_link_component.html.erb

@@ -1,5 +1,3 @@
-<div class="card authentication">
-    <div class="card-header">
-        <%= link_to t('geoblacklight.tools.login_to_view'), new_user_session_path(referrer: request.original_url), class: ['btn', 'btn-default', 'sidebar-btn'] %>
-    </div>
-</div>
+<%= link_to t('geoblacklight.tools.login_to_view'),
+            new_user_session_path(referrer: request.original_url),
+            class: ['btn', 'login-btn', 'd-block'] %>

data/app/javascript/geoblacklight/core.js

@@ -6,7 +6,6 @@ import initializeMetadataDownload from "geoblacklight/initializers/metadata_down
 
 // Stimulus controllers
 import ClipboardController from "geoblacklight/controllers/clipboard_controller"
-import DownloadsController from "geoblacklight/controllers/downloads_controller"
 import LeafletViewerController from "geoblacklight/controllers/leaflet_viewer_controller"
 import OembedViewerController from "geoblacklight/controllers/oembed_viewer_controller"
 import OpenlayersViewerController from "geoblacklight/controllers/openlayers_viewer_controller"
@@ -53,7 +52,6 @@ if (typeof Stimulus !== "undefined") {
   Stimulus.register("oembed-viewer", OembedViewerController)
   Stimulus.register("leaflet-viewer", LeafletViewerController)
   Stimulus.register("search-results", SearchResultsController)
-  Stimulus.register("downloads", DownloadsController)
   Stimulus.register("clipboard", ClipboardController)
 } else {
   console.error(

data/app/javascript/geoblacklight/index.js

@@ -3,7 +3,6 @@ import OpenlayersViewerController from "geoblacklight/controllers/openlayers_vie
 import OembedViewerController from "geoblacklight/controllers/oembed_viewer_controller"
 import LeafletViewerController from "geoblacklight/controllers/leaflet_viewer_controller"
 import SearchResultsController from "geoblacklight/controllers/search_results_controller"
-import DownloadsController from "geoblacklight/controllers/downloads_controller"
 import ClipboardController from "geoblacklight/controllers/clipboard_controller"
 
 // GBL core
@@ -18,7 +17,6 @@ export default {
   OembedViewerController,
   LeafletViewerController,
   SearchResultsController,
-  DownloadsController,
   ClipboardController,
   openLayersBasemaps,
   leafletBasemaps,

data/app/javascript/geoblacklight/leaflet/inspection.js

@@ -1,4 +1,5 @@
 import { identifyFeatures } from "esri-leaflet"
+import { polygon, geoJSON, circleMarker, layerGroup } from "leaflet"
 import {
   appendErrorMessage,
   appendLoadingMessage,
@@ -73,7 +74,7 @@ export const overlayLayer = (map, data, layer) => {
   const color = map.options.selected_color
 
   if (data._latlngs) {
-    overlayLayer = L.polygon(data._latlngs, {
+    overlayLayer = polygon(data._latlngs, {
       color: color,
       weight: 2,
       layer: true,
@@ -82,13 +83,13 @@ export const overlayLayer = (map, data, layer) => {
       highlightLayer: true,
     })
   } else {
-    overlayLayer = L.geoJSON(data, {
+    overlayLayer = geoJSON(data, {
       color: color,
       opacity: opacity,
       addToOpacitySlider: true,
       highlightLayer: true,
       pointToLayer: function (feature, latlng) {
-        return L.circleMarker(latlng, {
+        return circleMarker(latlng, {
           radius: 8,
           fillColor: color,
           color: color,
@@ -99,7 +100,7 @@ export const overlayLayer = (map, data, layer) => {
       },
     })
   }
-  L.layerGroup([overlayLayer]).addTo(map)
+  layerGroup([overlayLayer]).addTo(map)
 }
 
 export const tiledMapLayerInspection = (map, layer) => {

data/app/models/concerns/geoblacklight/solr_document.rb

@@ -10,7 +10,6 @@ module Geoblacklight
     include Geoblacklight::SolrDocument::Arcgis
     include Geoblacklight::SolrDocument::Citation
 
-    delegate :download_types, to: :references
     delegate :viewer_protocol, to: :item_viewer
     delegate :viewer_endpoint, to: :item_viewer
 
@@ -45,7 +44,7 @@ module Geoblacklight
     end
 
     def downloadable?
-      (direct_download || download_types.present? || iiif_download) && available?
+      (direct_download || iiif_download) && available?
     end
 
     def references

data/config/locales/geoblacklight.en.yml

@@ -6,20 +6,11 @@ en:
       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"
-      preparing: "Preparing download..."
-      ready: "Download ready (%{type})"
-      failed: "Download failed (%{type})"
+      downloads: "Downloads"
+      original_link: "Original %{download_format}"
+      generated_link: "Generated %{download_format}"
+      iiif_image_link: "Full-size image"
+      iiif_manifest_link: "IIIF manifest"
     home:
       headline: "Explore and discover..."
       search_heading: "Find the maps and data you need"

data/lib/generators/geoblacklight/install_generator.rb

@@ -39,11 +39,6 @@ module Geoblacklight
         namespace :wms do
           concerns :gbl_wms
         end
-        concern :gbl_downloadable, Geoblacklight::Routes::Downloadable.new
-        namespace :download do
-          concerns :gbl_downloadable
-        end
-        resources :download, only: [:show]
       ROUTES
 
       inject_into_file "config/routes.rb", routes, before: /^end/
@@ -62,6 +57,10 @@ module Geoblacklight
       directory "../../../../solr", "solr"
     end
 
+    def add_rsolr_gem
+      gem "rsolr", ">= 1.0", "< 3"
+    end
+
     def docker_compose
       copy_file "../../../../compose.yml", "compose.yml"
     end
@@ -84,10 +83,6 @@ module Geoblacklight
       end
     end
 
-    def create_downloads_directory
-      FileUtils.mkdir_p("tmp/cache/downloads") unless File.directory?("tmp/cache/downloads")
-    end
-
     def update_application_name
       gsub_file("config/locales/blacklight.en.yml", "Blacklight", "GeoBlacklight")
     end

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

@@ -7,14 +7,11 @@
 #   example:
 #     # config/initializers/geoblacklight.rb
 #     config = GeoBlacklight.configuration
-#     config.timeout_download = 10
+#     config.bbox_within_boost = "10"
 
 # # ArcGIS Online Base URL
 # arcgis_base_url: "https://www.arcgis.com/apps/mapviewer/index.html"
 
-# # File path for downloads
-# download_path: "<%= Rails.root.join('tmp', 'cache', 'downloads') %>"
-
 # # The bq boost value for spatial search matches within a bounding box
 # bbox_within_boost: "10"
 
@@ -103,9 +100,6 @@
 #   - "iso19139"
 #   - "html"
 
-# # (For external Download) timeout and open_timeout parameters for Faraday
-# timeout_download: 180
-
 # # (For WMS inspection) timeout and open_timeout parameters for Faraday
 # timeout_wms: 4
 
@@ -219,14 +213,6 @@
 #     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. Keys are OGC WMS request parameter names and are sent to
 # # remote WMS servers, so they are intentionally left uppercase.
 # wms_params:

data/lib/geoblacklight/configuration/settings_builder.rb

@@ -22,12 +22,9 @@ module Geoblacklight
           assign(config, :sidebar_static_map, settings.SIDEBAR_STATIC_MAP)
           assign(config, :iiif_drag_drop_link, settings.IIIF_DRAG_DROP_LINK)
           assign(config, :homepage_map_geom, settings.HOMEPAGE_MAP_GEOM)
-          assign(config, :vector_download_formats, settings.DOWNLOAD_FORMATS&.VECTOR)
           assign(config, :metadata_shown, settings.METADATA_SHOWN)
           assign(config, :webservices_shown, settings.WEBSERVICES_SHOWN)
           assign(config, :relationships_shown, build_relationships)
-          assign(config, :timeout_download, settings.TIMEOUT_DOWNLOAD)
-          assign(config, :download_path, settings.DOWNLOAD_PATH)
           assign(config, :gbl_params, settings.GBL_PARAMS)
           assign(config, :wms_params, settings.WMS_PARAMS&.to_h)
           assign(config, :timeout_wms, settings.TIMEOUT_WMS)

data/lib/geoblacklight/configuration.rb

@@ -15,9 +15,6 @@ module Geoblacklight
     # Institution deployed at
     attribute :institution, :string, default: "Stanford"
 
-    # (For external Download) timeout and open_timeout parameters for Faraday
-    attribute :timeout_download, :integer, default: 180
-
     # (For WMS inspection) timeout and open_timeout parameters for Faraday
     attribute :timeout_wms, :integer, default: 4
 
@@ -44,9 +41,6 @@ module Geoblacklight
     #   config.homepage_map_geom = '{"type":"Polygon","coordinates":[[[-73.58,42.93],[-73.58,41.20],[-69.90,41.20],[-69.90,42.93]]]}'
     attribute :homepage_map_geom, :string
 
-    # Vector data download formats to be displayed
-    attr_accessor :vector_download_formats  # typed as Array
-
     # Metadata shown in tool panel
     attr_accessor :metadata_shown # typed as Array
 
@@ -56,11 +50,8 @@ module Geoblacklight
     # Relationships to display
     attr_accessor :relationships_shown # typed as RelationshipsConfig
 
-    attribute :download_path, :string
-
     def initialize
       super
-      self.download_path ||= Rails.root.join("tmp", "cache", "downloads")
       @relationships_shown = RelationshipsConfig.new
       @gbl_params = [
         :bbox, :email, :file, :format, :id, :logo, :provider, :type,
@@ -95,7 +86,6 @@ module Geoblacklight
         ]
       }
 
-      @vector_download_formats = ["Shapefile", "KMZ", "GeoJSON", "CSV"]
       @metadata_shown = ["mods", "fgdc", "iso19139", "html"]
       @webservices_shown = %w[
         wms

data/lib/geoblacklight/exceptions.rb

@@ -2,29 +2,6 @@
 
 module Geoblacklight
   module Exceptions
-    class ExternalDownloadFailed < StandardError
-      def initialize(options = {})
-        @options = options
-      end
-
-      ##
-      # URL tried from failed download
-      # @return [String]
-      def url
-        @options[:url].to_s
-      end
-
-      ##
-      # Message passed from a failed download
-      # @return [String]
-      def message
-        @options[:message].to_s
-      end
-    end
-
-    class WrongDownloadFormat < StandardError
-    end
-
     class WrongBoundingBoxFormat < StandardError
     end
   end

data/lib/geoblacklight/references.rb

@@ -43,34 +43,6 @@ module Geoblacklight
       @refs.find { |reference| reference.type == ref_type }
     end
 
-    ##
-    # Preferred download (should be a file download)
-    # @return [Hash, nil]
-    def preferred_download
-      file_download if download.present?
-    end
-
-    ##
-    # Download hash based off of format type
-    # @return [Hash, nil]
-    def downloads_by_format
-      case format
-      when "Shapefile"
-        vector_download_formats
-      when "GeoTIFF"
-        geotiff_download_formats
-      when "ArcGRID"
-        arcgrid_download_formats
-      end
-    end
-
-    ##
-    # Generated download types from wxs services
-    # @return (see #downloads_by_format)
-    def download_types
-      downloads_by_format
-    end
-
     ##
     # Returns all of the Esri webservices for given set of references
     def esri_webservices
@@ -92,58 +64,6 @@ module Geoblacklight
       end
     end
 
-    ##
-    # Download hash for a static file download
-    # @return (see #downloads_by_format)
-    def file_download
-      {file_download: download.to_hash}
-    end
-
-    ##
-    # Download hash for a Shapefile file (currently only vector) with a wms and wfs reference
-    # present
-    # @return (see #downloads_by_format)
-    def vector_download_formats
-      return unless wms.present? && wfs.present?
-
-      download_formats = {}
-      format_list.each { |format| download_formats.merge!(web_service_hash(format)) }
-      download_formats
-    end
-
-    def format_list
-      Geoblacklight.configuration.vector_download_formats || []
-    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
-
-    ##
-    # Download hash for a GeoTiff file with a WMS reference present
-    # @return (see #downloads_by_format)
-    def geotiff_download_formats
-      {geotiff: wms.to_hash} if wms.present?
-    end
-
-    ##
-    # Download hash for an ArcGRID file with a WMS reference present
-    # @return (see #downloads_by_format)
-    def arcgrid_download_formats
-      {geotiff: wms.to_hash} if wms.present?
-    end
-
     ##
     # Adds a call to references for defined URI keys
     def method_missing(m, *args, &b)

data/lib/geoblacklight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Geoblacklight
-  VERSION = "6.0.0-alpha.4"
+  VERSION = "6.0.0-alpha.5"
 end

data/lib/geoblacklight.rb

@@ -3,7 +3,6 @@
 require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem
 loader.ignore("#{__dir__}/generators")
-loader.collapse("#{__dir__}/geoblacklight/download")
 loader.collapse("#{__dir__}/geoblacklight/wms_layer")
 loader.setup
 require "geoblacklight/engine"