geoblacklight_admin 0.5.0 → 0.6.0

data/app/javascript/index.js

@@ -1,8 +1,14 @@
 console.log('Vite ⚡️ Rails - GBL Admin')
 
-// Stimulus
+// Import Stimulus and controllers
 import { Application } from '@hotwired/stimulus'
 import ResultsController from "./controllers/results_controller"
 
+// Initialize Stimulus
 window.Stimulus = Application.start()
-Stimulus.register("results", ResultsController)
+
+// Register controllers
+Stimulus.register("results", ResultsController)
+
+// Import channels
+import '../channels';

data/app/jobs/bulk_action_revert_document_job.rb

@@ -21,18 +21,14 @@ class BulkActionRevertDocumentJob < ApplicationJob
     logger.debug("Revert PubStatus - #{document.friendlier_id}")
 
     versions = document.versions
-    document = versions[doc.version].reify
+    document = versions[doc.current_version].reify
     document&.skip_callbacks = true
 
-    if document&.save
-      doc.state_machine.transition_to!(:success)
-    else
-      doc.state_machine.transition_to!(:failed)
-    end
+    document.save
   end
 
   def revert_delete(doc)
-    document = Document.new(id: doc.document_id)
+    document = Document.find_by!(friendlier_id: doc.friendlier_id)
 
     logger.debug("Revert Delete - #{document.id}")
 
@@ -40,10 +36,6 @@ class BulkActionRevertDocumentJob < ApplicationJob
     document = versions.last.reify
     document.skip_callbacks = true
 
-    if document.save
-      doc.state_machine.transition_to!(:success)
-    else
-      doc.state_machine.transition_to!(:failed)
-    end
+    document.save
   end
 end

data/app/jobs/bulk_action_run_document_job.rb

@@ -25,11 +25,7 @@ class BulkActionRunDocumentJob < ApplicationJob
 
     logger.debug("Update PubStatus - #{document.friendlier_id} => #{field_value}")
 
-    if document.update!(publication_state: field_value.to_sym)
-      doc.state_machine.transition_to!(:success)
-    else
-      doc.state_machine.transition_to!(:failed)
-    end
+    document.update!(publication_state: field_value.to_sym)
   end
 
   def update_delete(doc, field_value)
@@ -37,10 +33,6 @@ class BulkActionRunDocumentJob < ApplicationJob
 
     logger.debug("Update Delete - #{document.friendlier_id} => #{field_value}")
 
-    if document.destroy
-      doc.state_machine.transition_to!(:success)
-    else
-      doc.state_machine.transition_to!(:failed)
-    end
+    document.destroy
   end
 end

data/app/jobs/export_job.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "csv"
+require "zip"
 
 # ExportJob
 class ExportJob < ApplicationJob
@@ -23,27 +24,53 @@ class ExportJob < ApplicationJob
     logger.debug("Document Ids: #{document_ids}")
 
     # Send progress
-    file_content = export_service.call(document_ids)
+    file_content_documents = export_service.call(document_ids)
+    file_content_document_distributions = ExportCsvDocumentDistributionsService.call(document_ids)
 
-    # Write into tempfile
-    @tempfile = Tempfile.new(["export-#{Time.zone.today}", ".csv"]).tap do |file|
+    # Write Documents into tempfile
+    @tempfile_documents = Tempfile.new(["documents-#{Time.zone.today}", ".csv"]).tap do |file|
       CSV.open(file, "wb") do |csv|
-        file_content.each do |row|
+        file_content_documents.each do |row|
           csv << row
         end
       end
+      logger.debug("Tempfile Documents Path: #{file.path}")
+      logger.debug("Tempfile Documents Size: #{File.size(file.path)} bytes")
     end
 
+    # Write DocumentDistributions into tempfile
+    @tempfile_document_distributions = Tempfile.new(["document-distributions-#{Time.zone.today}", ".csv"]).tap do |file|
+      CSV.open(file, "wb") do |csv|
+        file_content_document_distributions.each do |row|
+          csv << row
+        end
+      end
+      logger.debug("Tempfile Document Distributions Path: #{file.path}")
+      logger.debug("Tempfile Document Distributions Size: #{File.size(file.path)} bytes")
+    end
+
+    # Create a zip file containing both tempfiles
+    zipfile_name = "export-#{Time.zone.today}.zip"
+    tmp_dir = Rails.root.join("tmp")
+    @tempfile_zip = Tempfile.new([zipfile_name, ".zip"], tmp_dir)
+
+    Zip::File.open(@tempfile_zip.path, Zip::File::CREATE) do |zipfile|
+      zipfile.add("documents.csv", @tempfile_documents.path)
+      zipfile.add("document-distributions.csv", @tempfile_document_distributions.path)
+    end
+    logger.debug("Zipfile Path: #{@tempfile_zip.path}")
+    logger.debug("Zipfile Size: #{File.size(@tempfile_zip.path)} bytes")
+
     # Create notification
     # Message: "Download Type|Row Count|Button Label"
-    notification = ExportNotification.with(message: "CSV (#{export_service.short_name})|#{ActionController::Base.helpers.number_with_delimiter(file_content.size - 1)} rows|CSV")
+    notification = ExportNotification.with(message: "ZIP (#{export_service.short_name})|#{ActionController::Base.helpers.number_with_delimiter(file_content_documents.size - 1)} rows|ZIP")
 
     # Deliver notification
     notification.deliver(current_user)
 
-    # Attach CSV file (can only attach after persisted)
-    notification.record.file.attach(io: @tempfile, filename: "geomg-export-#{Time.zone.today}.csv",
-      content_type: "text/csv")
+    # Attach ZIP file (can only attach after persisted)
+    notification.record.file.attach(io: File.open(@tempfile_zip), filename: zipfile_name,
+      content_type: "application/zip")
 
     # Update UI
     ActionCable.server.broadcast("export_channel", {

data/app/jobs/geoblacklight_admin/delete_thumbnail_job.rb

@@ -1,11 +1,30 @@
 # frozen_string_literal: true
 
+##
+# Module for GeoblacklightAdmin related jobs.
 module GeoblacklightAdmin
+  ##
+  # A job to delete the thumbnail associated with a Solr document.
+  #
+  # This job is enqueued with a priority queue and can optionally handle
+  # a bad document ID to transition its state.
   class DeleteThumbnailJob < ApplicationJob
+    ##
+    # Determines the queue to use based on the last argument.
     queue_as do
       arguments.last
     end
 
+    ##
+    # Performs the job to delete a thumbnail.
+    #
+    # @param solr_document_id [String] the ID of the Solr document
+    # @param bad_id [String, nil] optional ID of a bad document to transition
+    # @param queue [Symbol] the queue to use, defaults to :priority
+    #
+    # If the document has a thumbnail, it will be destroyed.
+    # If a bad_id is provided, it will transition the state of the
+    # BulkActionDocument to :success.
     def perform(solr_document_id, bad_id = nil, queue = :priority)
       document = Document.find_by_friendlier_id(solr_document_id)
       if document.thumbnail.present?

data/app/jobs/geoblacklight_admin/remove_parent_dct_references_uri_job.rb

@@ -1,9 +1,25 @@
 # frozen_string_literal: true
 
+##
+# Module for GeoblacklightAdmin jobs.
 module GeoblacklightAdmin
+  ##
+  # Job to remove a specific DCT references URI from the parent asset.
+  #
+  # This job is queued with a priority level and is responsible for
+  # removing a DCT references URI from the parent of a given asset.
   class RemoveParentDctReferencesUriJob < ApplicationJob
     queue_as :priority
 
+    ##
+    # Performs the job of removing the DCT references URI from the parent asset.
+    #
+    # This method checks if the asset has a `dct_references_uri_key` present.
+    # If present, it deletes the URI from the parent's `dct_references_s` array
+    # if it matches the asset's full file URL, and then saves the parent asset.
+    #
+    # @param asset [Object] The asset whose parent's DCT references URI is to be removed.
+    # @raise [StandardError] Logs an error if an exception occurs during the process.
     def perform(asset)
       if asset.dct_references_uri_key.present?
         asset.parent.dct_references_s.delete_if { |i| i.value == asset.full_file_url }

data/app/jobs/geoblacklight_admin/set_parent_dct_references_uri_job.rb

@@ -1,9 +1,26 @@
 # frozen_string_literal: true
 
+##
+# Module for GeoblacklightAdmin jobs.
 module GeoblacklightAdmin
+  ##
+  # Job to set the parent DCT references URI for a given asset.
+  #
+  # This job is responsible for creating a new reference for the asset's
+  # DCT references URI key and appending it to the parent asset's
+  # `dct_references_s` array. It then saves the parent asset.
+  #
+  # If an error occurs during the process, it logs the error message.
   class SetParentDctReferencesUriJob < ApplicationJob
+    # Sets the queue for this job to :priority
     queue_as :priority
 
+    ##
+    # Performs the job to set the parent DCT references URI.
+    #
+    # @param asset [Object] The asset for which the DCT references URI is to be set.
+    #
+    # @return [void]
     def perform(asset)
       if asset.dct_references_uri_key.present?
         reference = Document::Reference.new

data/app/jobs/geoblacklight_admin/store_image_job.rb

@@ -1,11 +1,33 @@
 # frozen_string_literal: true
 
+##
+# Module for GeoblacklightAdmin jobs.
 module GeoblacklightAdmin
+  ##
+  # StoreImageJob is responsible for handling the storage of images
+  # associated with a Solr document. It manages the lifecycle of the
+  # image storage process, including state transitions and error handling.
   class StoreImageJob < ApplicationJob
+    ##
+    # Sets the queue for the job based on the last argument provided.
     queue_as do
       arguments.last
     end
 
+    ##
+    # Performs the job to store an image for a given Solr document.
+    #
+    # @param solr_document_id [String] the ID of the Solr document
+    # @param bad_id [String, nil] optional ID for a BulkActionDocument
+    # @param queue [Symbol] the queue to use for the job, defaults to :default
+    #
+    # This method:
+    # - Finds the document by its friendlier ID.
+    # - Deletes any existing thumbnail.
+    # - Transitions the document's thumbnail state to 'queued'.
+    # - Waits for a random period to ensure polite crawling.
+    # - Stores the image using the ImageService.
+    # - Transitions the BulkActionDocument state to 'success' if a bad_id is provided.
     def perform(solr_document_id, bad_id = nil, queue = :default)
       # Find the document
       document = Document.find_by_friendlier_id(solr_document_id)

data/app/jobs/import_document_job.rb

@@ -5,10 +5,7 @@ class ImportDocumentJob < ApplicationJob
   queue_as :priority
 
   def perform(import_document)
-    # @TODO: Check for friendlier_id or raise error
-    document = Document.where(
-      friendlier_id: import_document.friendlier_id
-    ).first_or_create
+    document = Document.find_or_create_by(friendlier_id: import_document.friendlier_id)
 
     # Set the geom
     document.set_geometry

data/app/jobs/import_run_job.rb

@@ -5,7 +5,7 @@ class ImportRunJob < ApplicationJob
   queue_as :priority
 
   def perform(import)
-    data = CSV.parse(import.csv_file.download.force_encoding("UTF-8"), headers: true)
+    data = CSV.parse(import.csv_file.download, headers: true)
 
     data.each do |doc|
       extract_hash = doc.to_h

data/app/models/admin/bookmark.rb

@@ -8,7 +8,7 @@ module Admin
     validates :user_id, presence: true
 
     def document_id
-      document_id
+      document.id
     end
 
     def document_type

data/app/models/asset.rb

@@ -1,4 +1,6 @@
 class Asset < Kithe::Asset
+  belongs_to :parent, class_name: "Document", optional: true
+
   include AttrJson::Record::QueryScopes
   include Rails.application.routes.url_helpers
 
@@ -17,6 +19,8 @@ class Asset < Kithe::Asset
     "public" => :kithe_derivatives
   }.freeze
 
+  scope :to_aardvark_references, -> { where(parent_id: pluck(:parent_id)).map(&:to_aardvark_reference) }
+
   def full_file_url
     if Rails.env.development?
       "http://localhost:3000" + file.url
@@ -45,6 +49,22 @@ class Asset < Kithe::Asset
   def reindex_parent
     parent.save if parent.present?
   end
+
+  def to_aardvark_reference
+    hash = {}
+    if dct_references_uri_key.present?
+      reference_type = ReferenceType.find_by_name(dct_references_uri_key)
+      hash[reference_type.reference_uri.to_s] = if reference_type.reference_uri.to_s == "http://schema.org/downloadUrl"
+        {
+          "url" => full_file_url,
+          "label" => label.present? ? label : file.metadata["filename"]
+        }
+      else
+        full_file_url
+      end
+    end
+    hash
+  end
 end
 
 # Allow DocumentAsset to be used as a synonym for Asset

data/app/models/bulk_action.rb

@@ -2,6 +2,7 @@
 
 require "uri"
 require "cgi"
+require "statesman"
 
 # BulkAction
 class BulkAction < ApplicationRecord
@@ -19,7 +20,7 @@ class BulkAction < ApplicationRecord
   validates :scope, :field_name, :field_value, presence: true
 
   # States
-  include Statesman::Adapters::ActiveRecordQueries[
+  include ::Statesman::Adapters::ActiveRecordQueries[
     transition_class: BulkActionTransition,
     initial_state: :created
   ]

data/app/models/bulk_actions/change_publication_state.rb

@@ -3,29 +3,4 @@ module BulkActions
   class ChangePublicationState < BulkAction
     # Add specific methods and validations for ChangePublicationState here
   end
-
-  # Subclass for PublishDocument
-  class PublishDocument < BulkAction
-    # Add specific methods and validations for PublishDocument here
-  end
-
-  # Subclass for UnpublishDocument
-  class UnpublishDocument < BulkAction
-    # Add specific methods and validations for UnpublishDocument here
-  end
-
-  # Subclass for DraftDocument
-  class DraftDocument < BulkAction
-    # Add specific methods and validations for DraftDocument here
-  end
-
-  # Subclass for HarvestThumbnails
-  class HarvestThumbnails < BulkAction
-    # Add specific methods and validations for HarvestThumbnails here
-  end
-
-  # Subclass for DeleteThumbnails
-  class DeleteThumbnails < BulkAction
-    # Add specific methods and validations for DeleteThumbnails here
-  end
 end

data/app/models/bulk_actions/delete_thumbnails.rb

@@ -0,0 +1,6 @@
+module BulkActions
+  # Subclass for DeleteThumbnails
+  class DeleteThumbnails < BulkAction
+    # Add specific methods and validations for DeleteThumbnails here
+  end
+end

data/app/models/bulk_actions/draft_document.rb

@@ -0,0 +1,6 @@
+module BulkActions
+  # Subclass for DraftDocument
+  class DraftDocument < BulkAction
+    # Add specific methods and validations for DraftDocument here
+  end
+end

data/app/models/bulk_actions/harvest_thumbnails.rb

@@ -0,0 +1,6 @@
+module BulkActions
+  # Subclass for HarvestThumbnails
+  class HarvestThumbnails < BulkAction
+    # Add specific methods and validations for HarvestThumbnails here
+  end
+end

data/app/models/bulk_actions/publish_document.rb

@@ -0,0 +1,6 @@
+module BulkActions
+  # Subclass for PublishDocument
+  class PublishDocument < ChangePublicationState
+    # Add specific methods and validations for PublishDocument here
+  end
+end

data/app/models/bulk_actions/unpublish_document.rb

@@ -0,0 +1,6 @@
+module BulkActions
+  # Subclass for UnpublishDocument
+  class UnpublishDocument < BulkAction
+    # Add specific methods and validations for UnpublishDocument here
+  end
+end

data/app/models/document/geom_validator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "rgeo"
+require "rgeo/wkrep/wkt_parser"
 
 # GEOM Validation
 #
@@ -65,6 +66,13 @@ class Document
           "Invalid polygon: all points are coplanar input, Solr will not index")
       end
 
+      # Guard against coplanar points
+      if geom == "POLYGON((-180.0 90.0, 180.0 90.0, 180.0 -90.0, -180.0 -90.0, -180.0 90.0))"
+        valid_geom = false
+        record.errors.add(GeoblacklightAdmin::Schema.instance.solr_fields[:geometry],
+          "Invalid polygon: all points are coplanar input, Solr will not index")
+      end
+
       valid_geom
     end
 

data/app/models/document/reference.rb

@@ -7,17 +7,37 @@ class Document
     # Via GBL Wiki
     # https://github.com/geoblacklight/geoblacklight/wiki/External-references
     REFERENCE_VALUES = {
-      wcs: {
-        label: "Web Coverage Service (WCS)",
-        uri: "http://www.opengis.net/def/serviceType/ogc/wcs"
+      arcgis_dynamic_map_layer: {
+        label: "ArcGIS DynamicMapLayer",
+        uri: "urn:x-esri:serviceType:ArcGIS#DynamicMapLayer"
       },
-      wms: {
-        label: "Web Mapping Service (WMS)",
-        uri: "http://www.opengis.net/def/serviceType/ogc/wms"
+      arcgis_feature_layer: {
+        label: "ArcGIS FeatureLayer",
+        uri: "urn:x-esri:serviceType:ArcGIS#FeatureLayer"
       },
-      wfs: {
-        label: "Web Feature Service (WFS)",
-        uri: "http://www.opengis.net/def/serviceType/ogc/wfs"
+      arcgis_image_map_layer: {
+        label: "ArcGIS ImageMapLayer",
+        uri: "urn:x-esri:serviceType:ArcGIS#ImageMapLayer"
+      },
+      arcgis_tiled_map_layer: {
+        label: "ArcGIS TiledMapLayer",
+        uri: "urn:x-esri:serviceType:ArcGIS#TiledMapLayer"
+      },
+      cog: {
+        label: "COG",
+        uri: "https://github.com/cogeotiff/cog-spec"
+      },
+      documentation_download: {
+        label: "Data dictionary / documentation download",
+        uri: "http://lccn.loc.gov/sh85035852"
+      },
+      documentation_external: {
+        label: "Full layer description",
+        uri: "http://schema.org/url"
+      },
+      download: {
+        label: "Direct download file",
+        uri: "http://schema.org/downloadUrl"
       },
       iiif_image: {
         label: "IIIF Image API",
@@ -31,81 +51,37 @@ class Document
         label: "Image file",
         uri: "http://schema.org/image"
       },
-      download: {
-        label: "Direct download file",
-        uri: "http://schema.org/downloadUrl"
-      },
-      thumbnail: {
-        label: "Thumbnail file",
-        uri: "http://schema.org/thumbnailUrl"
-      },
-      documentation_download: {
-        label: "Data dictionary / documentation download",
-        uri: "http://lccn.loc.gov/sh85035852"
-      },
-      documentation_external: {
-        label: "Full layer description",
-        uri: "http://schema.org/url"
-      },
-      metadata_iso: {
-        label: "Metadata in ISO 19139",
-        uri: "http://www.isotc211.org/schemas/2005/gmd/"
-      },
       metadata_fgdc: {
         label: "Metadata in FGDC",
         uri: "http://www.opengis.net/cat/csw/csdgm"
       },
-      metadata_mods: {
-        label: "Metadata in MODS",
-        uri: "http://www.loc.gov/mods/v3"
-      },
       metadata_html: {
         label: "Metadata in HTML",
         uri: "http://www.w3.org/1999/xhtml"
       },
-      arcgis_feature_layer: {
-        label: "ArcGIS FeatureLayer",
-        uri: "urn:x-esri:serviceType:ArcGIS#FeatureLayer"
-      },
-      arcgis_tiled_map_layer: {
-        label: "ArcGIS TiledMapLayer",
-        uri: "urn:x-esri:serviceType:ArcGIS#TiledMapLayer"
-      },
-      arcgis_dynamic_map_layer: {
-        label: "ArcGIS DynamicMapLayer",
-        uri: "urn:x-esri:serviceType:ArcGIS#DynamicMapLayer"
-      },
-      arcgis_image_map_layer: {
-        label: "ArcGIS ImageMapLayer",
-        uri: "urn:x-esri:serviceType:ArcGIS#ImageMapLayer"
-      },
-      harvard_download: {
-        label: "Harvard Download",
-        uri: "http://schema.org/DownloadAction"
+      metadata_iso: {
+        label: "Metadata in ISO 19139",
+        uri: "http://www.isotc211.org/schemas/2005/gmd/"
       },
-      open_index_map: {
-        label: "OpenIndexMap",
-        uri: "https://openindexmaps.org"
+      metadata_mods: {
+        label: "Metadata in MODS",
+        uri: "http://www.loc.gov/mods/v3"
       },
       oembed: {
         label: "oEmbed",
         uri: "https://oembed.com"
       },
-      cog: {
-        label: "COG",
-        uri: "https://github.com/cogeotiff/cog-spec"
+      open_index_map: {
+        label: "OpenIndexMap",
+        uri: "https://openindexmaps.org"
       },
       pmtiles: {
         label: "PMTiles",
         uri: "https://github.com/protomaps/PMTiles"
       },
-      xyz_tiles: {
-        label: "XYZ Tiles",
-        uri: "https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames"
-      },
-      wmts: {
-        label: "WMTS",
-        uri: "http://www.opengis.net/def/serviceType/ogc/wmts"
+      thumbnail: {
+        label: "Thumbnail file",
+        uri: "http://schema.org/thumbnailUrl"
       },
       tile_json: {
         label: "TileJSON",
@@ -114,6 +90,26 @@ class Document
       tile_map_service: {
         label: "Tile Map Service",
         uri: "https://wiki.osgeo.org/wiki/Tile_Map_Service_Specification"
+      },
+      wcs: {
+        label: "Web Coverage Service (WCS)",
+        uri: "http://www.opengis.net/def/serviceType/ogc/wcs"
+      },
+      wfs: {
+        label: "Web Feature Service (WFS)",
+        uri: "http://www.opengis.net/def/serviceType/ogc/wfs"
+      },
+      wmts: {
+        label: "WMTS",
+        uri: "http://www.opengis.net/def/serviceType/ogc/wmts"
+      },
+      wms: {
+        label: "Web Mapping Service (WMS)",
+        uri: "http://www.opengis.net/def/serviceType/ogc/wms"
+      },
+      xyz_tiles: {
+        label: "XYZ Tiles",
+        uri: "https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames"
       }
     }.freeze
 
@@ -127,5 +123,9 @@ class Document
 
     attr_json :category, :string
     attr_json :value, :string
+
+    def self.reference_values
+      REFERENCE_VALUES
+    end
   end
 end