geoblacklight_admin 0.5.0 → 0.6.0

data/app/models/document.rb

@@ -9,7 +9,7 @@ class Document < Kithe::Work
   delegate :viewer_endpoint, to: :item_viewer
 
   def item_viewer
-    GeoblacklightAdmin::ItemViewer.new(references)
+    GeoblacklightAdmin::ItemViewer.new(distributions)
   end
 
   attr_accessor :skip_callbacks
@@ -34,18 +34,20 @@ class Document < Kithe::Work
   has_many :document_downloads, primary_key: "friendlier_id", foreign_key: "friendlier_id", autosave: false, dependent: :destroy,
     inverse_of: :document
 
+  # - DocumentDistributions
+  has_many :document_distributions, primary_key: "friendlier_id", foreign_key: "friendlier_id", autosave: false, dependent: :destroy,
+    inverse_of: :document
+
   # DocumentAssets - Thumbnails, Attachments, etc
   # @TODO: Redundant? Kithe also includes a members association
   def document_assets
     scope = Kithe::Asset
-    scope = scope.where(parent_id: id)
-
-    # scope = scope.page(params[:page]).per(20).order(created_at: :desc)
+    scope = scope.where(parent_id: id).order(position: :asc)
     scope.includes(:parent)
   end
 
-  def downloadable_assets
-    document_assets.select { |a| a.dct_references_uri_key == "download" }
+  def distributable_assets
+    document_assets.select { |a| a.dct_references_uri_key.present? }
   end
 
   include Statesman::Adapters::ActiveRecordQueries[
@@ -87,7 +89,7 @@ class Document < Kithe::Work
 
   # Downloadable Resouce
   def a_downloadable_resource?
-    references_json.include?("downloadUrl")
+    distributions_json.include?("downloadUrl")
   end
 
   validates_with Document::DateValidator
@@ -96,55 +98,109 @@ class Document < Kithe::Work
   validates_with Document::GeomValidator
 
   # Definte our AttrJSON attributes
-  Element.all.each do |attribute|
-    next if attribute.solr_field == "dct_references_s"
+  if ActiveRecord::Base.connection.table_exists?("elements")
+    Element.all.each do |attribute|
+      next if attribute.solr_field == "dct_references_s"
 
-    if attribute.repeatable?
-      attr_json attribute.solr_field.to_sym, attribute.field_type.to_sym, array: true, default: -> { [] }
-    else
-      attr_json attribute.solr_field.to_sym, attribute.field_type.to_sym, default: ""
+      if attribute.repeatable?
+        attr_json attribute.solr_field.to_sym, attribute.field_type.to_sym, array: true, default: -> { [] }
+      else
+        attr_json attribute.solr_field.to_sym, attribute.field_type.to_sym, default: ""
+      end
     end
   end
 
   attr_json :dct_references_s, Document::Reference.to_type, array: true, default: -> { [] }
 
-  # Index Transformations - *_json functions
-  def references
-    references = ActiveSupport::HashWithIndifferentAccess.new
+  # Distributions
+  # - BEFORE DocumentDistributions
+  #   - Use dct_references_s
+  #   - Use multiple downloads
+  #   - Use distributable assets
+  # - AFTER DocumentDistributions
+  #   - Use document_distributions
+  #   - Use distributable assets
+  # @TODO: Remove BEFORE path once we've migrated to DocumentDistributions
+  def distributions
+    distributions = ActiveSupport::HashWithIndifferentAccess.new
+
+    # AFTER - Add DocumentDistributions to distributions
+    if ENV["GBL_ADMIN_REFERENCES_MIGRATED"] == "true"
+      distributions = document_distributions.to_aardvark_distributions
+    end
 
-    # Prep value arrays
+    # BEFORE - Prep value arrays
+    # @TODO: Remove this once we've migrated to DocumentDistributions
     send(GeoblacklightAdmin::Schema.instance.solr_fields[:reference]).each do |ref|
-      references[Document::Reference::REFERENCE_VALUES[ref.category.to_sym][:uri]] = []
+      if ref.category.present?
+        distributions[Document::Reference::REFERENCE_VALUES[ref.category.to_sym][:uri]] = []
+      end
     end
 
-    # Seed value arrays
+    # BEFORE - Seed value arrays
+    # @TODO: Remove this once we've migrated to DocumentDistributions
     send(GeoblacklightAdmin::Schema.instance.solr_fields[:reference]).each do |ref|
-      # @TODO: Need to support multiple entries per key here
-      references[Document::Reference::REFERENCE_VALUES[ref.category.to_sym][:uri]] << ref.value
+      if ref.category.present?
+        distributions[Document::Reference::REFERENCE_VALUES[ref.category.to_sym][:uri]] << ref.value
+      end
     end
+    logger.debug("\n\nDocument#distributions > seeded: #{distributions}")
 
-    logger.debug("\n\nDocument#references > seeded: #{references}")
-
-    # Apply Downloads
-    references = apply_downloads(references)
+    # BEFORE - Apply Multiple Downloads
+    # @TODO: Remove this once we've migrated to DocumentDistributions
+    if ENV["GBL_ADMIN_REFERENCES_MIGRATED"] == "false"
+      distributions = apply_downloads(distributions)
+      logger.debug("Document#distributions > downloads: #{distributions}")
+    end
 
-    logger.debug("Document#references > downloads: #{references}\n\n")
+    # BEFORE & AFTER - Apply Distributable Assets
+    distributions = apply_assets(distributions)
+    logger.debug("Document#distributions > assets: #{distributions}")
 
     # Need to flatten the arrays here to avoid the following potential error:
     # - ArgumentError: Please use symbols for polymorphic route arguments.
     # - Via: app/helpers/geoblacklight_helper.rb:224:in `render_references_url'
-    references.each do |key, value|
+    distributions.each do |key, value|
       next if key == "http://schema.org/downloadUrl"
       if value.is_a?(Array) && value.length == 1
-        references[key] = value.first
+        distributions[key] = value.first
       end
     end
 
-    references
+    distributions
+  end
+
+  # Distributions JSON
+  # - Indexes to Solr as dct_distributions_s
+  def distributions_json
+    if ENV["GBL_ADMIN_REFERENCES_MIGRATED"] == "true"
+      logger.debug("Document#distributions_json > using document_distributions")
+      distributions = document_distributions.to_aardvark_distributions
+      distributions = apply_assets(distributions)
+      distributions.to_json
+    else
+      logger.debug("Document#distributions > #{distributions.inspect}")
+      logger.debug("Document#distributions_json > using distributions")
+      logger.warn("Deprecation warning: AttrJSON-based dct_references_s will not be supported soon.")
+      self.distributions.to_json
+    end
   end
 
-  def references_json
-    references.to_json
+  def distributions_csv
+    # Initialize CSV
+    # - [document_id, category, value, label]
+    csv = []
+
+    distributions.each do |key, value|
+      if key == "http://schema.org/downloadUrl"
+        value.each do |download|
+          csv << [friendlier_id, ReferenceType.find_by(reference_uri: key).name, download["url"], download["label"]]
+        end
+      else
+        csv << [friendlier_id, ReferenceType.find_by(reference_uri: key)&.name, value, nil]
+      end
+    end
+    csv
   end
 
   def asset_label(asset)
@@ -155,14 +211,33 @@ class Document < Kithe::Work
     end
   end
 
-  # Apply Downloads
+  def apply_assets(distributions)
+    # Distributable Document Assets
+    # - Via DocumentAssets (Assets)
+    # - With Downloadable URI
+    if distributable_assets.present?
+      distributable_assets.each do |asset|
+        if asset.dct_references_uri_key == "download"
+          distributions["http://schema.org/downloadUrl"] ||= []
+          distributions["http://schema.org/downloadUrl"] << asset.to_aardvark_reference["http://schema.org/downloadUrl"]
+        else
+          distributions.merge!(asset.to_aardvark_reference)
+        end
+      end
+    end
+
+    distributions
+  end
+
+  # BEFORE - Apply Downloads
+  # @TODO: Remove this once we've migrated to DocumentDistributions
   # 1. Native Aardvark Downloads
   # 2. Multiple Document Download Links
   # 3. Downloadable Document Assets
-  def apply_downloads(references)
+  def apply_downloads(distributions)
     multiple_downloads = []
 
-    dct_downloads = references["http://schema.org/downloadUrl"]
+    dct_downloads = distributions["http://schema.org/downloadUrl"]
 
     logger.debug("Document#dct_downloads > init: #{dct_downloads}\n\n")
 
@@ -180,35 +255,21 @@ class Document < Kithe::Work
     # Multiple Document Download Links
     # - Via DocumentDownloads
     if document_downloads.present?
-      multiple_downloads << multiple_downloads_array
+      multiple_downloads_array.each do |download|
+        multiple_downloads << download
+      end
     end
 
     logger.debug("Document#dct_downloads > document_downloads: #{multiple_downloads.inspect}\n\n")
 
-    # Downloadable Document Assets
-    # - Via DocumentAssets (Assets)
-    # - With Downloadable URI
-    if downloadable_assets.present?
-      downloadable_assets.each do |asset|
-        logger.debug("\n\n Document#dct_downloads > dupe?: #{multiple_downloads.detect { |d| d[:url].include?(asset.file.url) }}\n\n")
-
-        if multiple_downloads.detect { |d| d[:url].include?(asset.file.url) }
-          logger.debug("\n\n Detected duplicate download URL: #{asset.file.url}\n\n")
-          index = multiple_downloads.index { |d| d[:url].include?(asset.file.url) }
-          multiple_downloads[index] = {label: asset_label(asset), url: asset.file.url}
-        else
-          logger.debug("\n\n No duplicate found - Adding downloadable asset: #{asset.file.url}\n\n")
-          multiple_downloads << {label: asset_label(asset), url: asset.file.url}
-        end
-      end
-    end
+    multiple_downloads = multiple_downloads.uniq { |d| [d[:label], d[:url]] } unless multiple_downloads.empty?
 
-    logger.debug("Document#dct_downloads > downloadable_assets: #{multiple_downloads.inspect}\n\n")
-
-    references[:"http://schema.org/downloadUrl"] = multiple_downloads.flatten unless multiple_downloads.empty?
-    references
+    distributions[:"http://schema.org/downloadUrl"] = multiple_downloads.flatten unless multiple_downloads.empty?
+    distributions
   end
 
+  # BEFORE - Multiple Downloads Array
+  # @TODO: Remove this once we've migrated to DocumentDistributions
   def multiple_downloads_array
     document_downloads.collect { |d| {label: d.label, url: d.value} }
   end
@@ -230,14 +291,9 @@ class Document < Kithe::Work
   #
   def download_text(format)
     download_format = proper_case_format(format)
-    prefix = "Original "
-    begin
-      format = download_format
-    rescue
-      # Need to rescue if format doesn't exist
-    end
-    value = prefix + format.to_s
-    value.html_safe
+    download_format.to_s.html_safe
+  rescue
+    format.to_s.html_safe
   end
 
   ##
@@ -257,7 +313,7 @@ class Document < Kithe::Work
 
   def local?
     local = send(Settings.FIELDS.PROVIDER) || ""
-    local.casecmp(Settings.INSTITUTION_LOCAL_NAME)&.zero?
+    local.casecmp(Settings.INSTITUTION)&.zero?
   end
 
   def restricted?
@@ -273,7 +329,7 @@ class Document < Kithe::Work
   end
 
   def direct_download
-    references.download.to_hash if references.download.present?
+    distributions.download.to_hash if distributions.download.present?
   end
 
   def display_note
@@ -281,11 +337,11 @@ class Document < Kithe::Work
   end
 
   def hgl_download
-    references.hgl.to_hash if references.hgl.present?
+    distributions.hgl.to_hash if distributions.hgl.present?
   end
 
   def oembed
-    references.oembed.endpoint if references.oembed.present?
+    distributions.oembed.endpoint if distributions.oembed.present?
   end
 
   def same_institution?
@@ -294,15 +350,15 @@ class Document < Kithe::Work
   end
 
   def iiif_download
-    references.iiif.to_hash if references.iiif.present?
+    distributions.iiif.to_hash if distributions.iiif.present?
   end
 
   def data_dictionary_download
-    references.data_dictionary.to_hash if references.data_dictionary.present?
+    distributions.data_dictionary.to_hash if distributions.data_dictionary.present?
   end
 
   def external_url
-    references.url&.endpoint
+    distributions.url&.endpoint
   end
 
   def itemtype
@@ -332,7 +388,7 @@ class Document < Kithe::Work
   # :type => a string which if its a Geoblacklight::Constants::URI key
   #          will return a coresponding Geoblacklight::Reference
   def checked_endpoint(type)
-    type = references.send(type)
+    type = distributions.send(type)
     type.endpoint if type.present?
   end
 
@@ -397,6 +453,7 @@ class Document < Kithe::Work
       elsif value[:destination] == "b1g_publication_state_s"
         send(:current_state)
       else
+        next if send(value[:destination]).blank?
         send(value[:destination])
       end
     end

data/app/models/document_distribution.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require "csv"
+
+# DocumentDistribution
+#
+# This class represents a distribution of a document, which includes a URL and a distribution type.
+# It belongs to a document and a reference type, and it supports CSV import and export.
+#
+# Associations:
+# - belongs_to :document
+# - belongs_to :reference_type
+#
+# Callbacks:
+# - after_save :reindex_document
+#
+# Validations:
+# - Validates presence of :friendlier_id, :reference_type_id, :url
+# - Validates uniqueness of :url scoped to :friendlier_id and :reference_type_id
+#
+# Scopes:
+# - to_aardvark_distributions: Converts distributions to aardvark format
+# - to_csv: Converts distributions to CSV format
+class DocumentDistribution < ApplicationRecord
+  belongs_to :document, foreign_key: :friendlier_id, primary_key: :friendlier_id
+  belongs_to :reference_type
+  after_save :reindex_document
+
+  # Validations
+  validates :friendlier_id, :reference_type_id, :url, presence: true
+  validates :url, uniqueness: {scope: [:friendlier_id, :reference_type_id]}
+
+  # Scopes
+  scope :to_aardvark_distributions, -> {
+    distributions = where(friendlier_id: pluck(:friendlier_id)).map(&:to_aardvark_distribution)
+    merged = {}
+    distributions.each do |dist|
+      if dist.keys.first == "http://schema.org/downloadUrl"
+        merged["http://schema.org/downloadUrl"] ||= []
+        merged["http://schema.org/downloadUrl"] << {
+          "url" => dist.values.first,
+          "label" => dist[:label]
+        }
+      else
+        merged[dist.keys.first] = dist.values.first
+      end
+    end
+    merged
+  }
+  scope :to_csv, -> { where(friendlier_id: pluck(:friendlier_id)).map(&:to_csv) }
+
+  # CSV Column Names
+  #
+  # Returns an array of column names for CSV export.
+  #
+  # @return [Array<String>] the CSV column names
+  def self.csv_column_names
+    ["friendlier_id", "reference_type", "distribution_url", "label"]
+  end
+
+  # Import
+  #
+  # Imports document distributions from a CSV file.
+  #
+  # @param file [File] the CSV file to import
+  # @return [Boolean] true if import is successful
+  def self.import(file)
+    logger.debug("CSV Import")
+    ::CSV.foreach(file.path, headers: true) do |row|
+      logger.debug("CSV Row: #{row.to_hash}")
+      document_distribution = DocumentDistribution.find_or_initialize_by(
+        friendlier_id: row.to_hash["friendlier_id"],
+        reference_type_id: ReferenceType.find_by(name: row.to_hash["reference_type"]).id,
+        url: row.to_hash["distribution_url"],
+        label: row.to_hash["label"]
+      )
+
+      logger.debug("Document Distribution: #{document_distribution.inspect}")
+
+      document_distribution.update!(
+        friendlier_id: row.to_hash["friendlier_id"],
+        reference_type_id: ReferenceType.find_by(name: row.to_hash["reference_type"]).id,
+        url: row.to_hash["distribution_url"],
+        label: row.to_hash["label"]
+      )
+    end
+    true
+  end
+
+  # Destroy All
+  #
+  # Destroys document distributions based on a CSV file.
+  #
+  # @param file [File] the CSV file to process
+  # @return [Boolean] true if destroy is successful
+  def self.destroy_all(file)
+    logger.debug("CSV Destroy")
+    ::CSV.foreach(file.path, headers: true) do |row|
+      logger.debug("CSV Row: #{row.to_hash}")
+      if DocumentDistribution.destroy_by(
+        friendlier_id: row.to_hash["friendlier_id"],
+        reference_type_id: ReferenceType.find_by(name: row.to_hash["reference_type"]).id,
+        url: row.to_hash["distribution_url"]
+      )
+        logger.debug("Destroyed: #{row.to_hash}")
+      else
+        logger.debug("Not Destroyed: #{row.to_hash}")
+      end
+    end
+    true
+  end
+
+  # To CSV
+  #
+  # Converts the document distribution to an array suitable for CSV export.
+  #
+  # @return [Array<String>] the CSV row data
+  def to_csv
+    [
+      friendlier_id,
+      reference_type.name,
+      url,
+      label
+    ]
+  end
+
+  # To Aardvark Reference
+  #
+  # Converts the document distribution to an aardvark distribution format.
+  #
+  # @return [Hash] the aardvark reference
+  def to_aardvark_distribution
+    hash = {}
+    hash[reference_type.reference_uri.to_s] = url
+    hash[:label] = label if reference_type.reference_uri.to_s == "http://schema.org/downloadUrl"
+    hash
+  end
+
+  # Reindex Document
+  #
+  # Reindexes the associated document.
+  def reindex_document
+    document.save
+  end
+end

data/app/models/element.rb

@@ -22,6 +22,8 @@ class Element < ApplicationRecord
 
   # Validations
   validates :label, :solr_field, :field_type, presence: true
+  validates :label, uniqueness: true
+  validates :solr_field, uniqueness: true
 
   FIELD_TYPES = %w[
     string

data/app/models/geoblacklight_admin/schema.rb

@@ -31,7 +31,11 @@ module GeoblacklightAdmin
         }
       end
 
-      @fields = @fields.merge(dct_references_import_mappings)
+      unless ENV["GBL_ADMIN_REFERENCES_MIGRATED"] == "true"
+        Rails.logger.warn("Deprecation warning: AttrJSON-based dct_references_s will not be supported soon.")
+        @fields = @fields.merge(dct_references_import_mappings)
+      end
+
       @fields
     end
 
@@ -63,7 +67,11 @@ module GeoblacklightAdmin
         }
       }
 
-      @fields = @fields.merge(dct_references_import_mappings)
+      unless ENV["GBL_ADMIN_REFERENCES_MIGRATED"] == "true"
+        Rails.logger.warn("Deprecation warning: AttrJSON-based dct_references_s will not be supported soon.")
+        @fields = @fields.merge(dct_references_import_mappings)
+      end
+
       @fields = @fields.merge(object_metadata)
       @fields
     end

data/app/models/import/csv_duplicates_validator.rb

@@ -32,6 +32,8 @@ class Import
       end
 
       duplicate_id
+    rescue ArgumentError, ActiveStorage::FileNotFoundError
+      false
     end
   end
 end

data/app/models/import/csv_header_validator.rb

@@ -8,7 +8,7 @@ class Import
   class CsvHeaderValidator < ActiveModel::Validator
     def validate(record)
       valid_csv_header = true
-      unless valid_csv_headers?(record.csv_file)
+      unless valid_csv_headers?(record&.csv_file)
         valid_csv_header = false
         record.errors.add(:csv_file,
           "Missing a required CSV header. Title, Resource Class, Access Rights, and ID are required.")
@@ -20,6 +20,8 @@ class Import
     def valid_csv_headers?(csv_file)
       headers = CSV.parse(csv_file.download)[0]
       (["Title", "Resource Class", "Access Rights", "ID"] - headers).empty?
+    rescue ArgumentError, ActiveStorage::FileNotFoundError
+      false
     end
   end
 end

data/app/models/import_btaa_aardvark.rb

@@ -5,7 +5,7 @@ class ImportBtaaAardvark < Import
   # validations, constants and methods
 
   def mapping_configuration
-    Geomg.field_mappings_btaa_aardvark
+    GeoblacklightAdmin::Schema.instance.importable_fields
   end
 
   def klass_delimiter
@@ -98,7 +98,7 @@ class ImportBtaaAardvark < Import
       json_data.each do |key, value|
         reference = {
           value: value,
-          category: Geomg.uri_2_category_references_mappings[key]
+          category: GeoblacklightAdmin::FieldMappingsBtaaAardvark.uri_2_category_references_mappings[key]
         }
         references << reference
       end

data/app/models/import_document_state_machine.rb

@@ -9,4 +9,5 @@ class ImportDocumentStateMachine
   state :failed
 
   transition from: :queued, to: %i[success failed]
+  transition from: :failed, to: :success
 end

data/app/models/import_gblv1.rb

@@ -5,7 +5,7 @@ class ImportGblv1 < Import
   # validations, constants and methods
 
   def mapping_configuration
-    Geomg.field_mappings_gblv1
+    GeoblacklightAdmin::Schema.instance.importable_fields
   end
 
   def klass_delimiter
@@ -81,7 +81,7 @@ class ImportGblv1 < Import
       json_data.each do |key, value|
         reference = {
           value: value,
-          category: Geomg::FieldMappingsGblv1.uri_2_category_references_mappings[key]
+          category: GeoblacklightAdmin::FieldMappingsGblv1.uri_2_category_references_mappings[key]
         }
         references << reference
       end

data/app/models/reference_type.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# The ReferenceType class represents a reference entity in the application.
+# It includes validations for presence and uniqueness of reference attributes,
+# and manages the position of references within the system.
+class ReferenceType < ApplicationRecord
+  has_many :document_distributions, dependent: :destroy
+
+  # Validations
+  # Ensures that both reference_type and reference_uri are present and unique.
+  validates :name, :reference_type, :reference_uri, presence: true
+  validates :name, :reference_type, uniqueness: true
+
+  # Callbacks
+  # Sets the position of the reference before it is created.
+  before_create :set_last_position
+
+  # Sets the position of the reference to the next available position.
+  # If no references exist, it sets the position to 1.
+  #
+  # @return [void]
+  def set_last_position
+    position = ReferenceType.all.order(position: :desc)&.first&.position
+    self.position = position.blank? ? 1 : position + 1
+  end
+
+  # Class method to sort elements based on an array of IDs.
+  # Updates the position of each ReferenceType according to the order in the array.
+  #
+  # @param id_array [Array<Integer>] An array of element IDs to be sorted.
+  # @return [void]
+  def self.sort_elements(id_array)
+    transaction do
+      logger.debug { id_array.inspect }
+      id_array.each_with_index do |elm_id, i|
+        ReferenceType.update(elm_id, position: i)
+      end
+    end
+  end
+end

data/app/models/user.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
+require "devise"
+
 # User
 class User < ApplicationRecord
+  extend Devise::Models
   include Blacklight::User
 
   # Include default devise modules. Others available are:
   # :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
-  devise :invitable, :database_authenticatable,
-    :recoverable, :rememberable, :validatable
+  devise :database_authenticatable, :recoverable, :rememberable, :validatable
 
   has_many :bookmarks, dependent: :destroy, as: :user
   has_many :notifications, dependent: :destroy, as: :recipient