geoblacklight_admin 0.5.1 → 0.6.0

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_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/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

data/app/services/export_csv_document_distributions_service.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "csv"
+
+# ExportCsvDocumentDistributionsService
+#
+# This service is responsible for exporting document distributions to a CSV format.
+# It broadcasts the progress of the export process via ActionCable.
+class ExportCsvDocumentDistributionsService
+  # Returns a short name for the service.
+  #
+  # @return [String] the short name of the service.
+  def self.short_name
+    "Document Distributions"
+  end
+
+  # Initiates the CSV export process for the given document IDs.
+  #
+  # @param document_ids [Array] an array of document IDs to export.
+  # @return [Array] the generated CSV file content as an array of rows.
+  #
+  # This method broadcasts the progress of the export process to the "export_channel".
+  # It processes the document IDs in slices and handles any NoMethodError exceptions
+  # that occur during the export process.
+  def self.call(document_ids)
+    ActionCable.server.broadcast("export_channel", {progress: 0})
+
+    document_ids = document_ids.flatten
+    total = document_ids.size
+    count = 0
+    slice_count = 100
+    csv_file = []
+
+    Rails.logger.debug { "\n\nExportCsvDocumentDistributionsService: #{document_ids.inspect}\n\n" }
+
+    CSV.generate(headers: true) do |_csv|
+      csv_file << DocumentDistribution.csv_column_names
+      document_ids.each_slice(slice_count) do |slice|
+        # Broadcast progress percentage
+        count += slice_count
+        progress = ((count.to_f / total) * 100).round
+        progress = 100 if progress > 100
+
+        ActionCable.server.broadcast("export_channel", {progress: progress})
+        slice.each do |doc_id|
+          doc = Document.find_by(friendlier_id: doc_id)
+
+          Rails.logger.debug { "\n\nDocDistributions: #{doc.document_distributions.size}\n\n" }
+
+          doc.document_distributions.each do |distribution|
+            csv_file << distribution.to_csv
+          end
+        rescue NoMethodError
+          Rails.logger.debug { "\n\nExport Failed: #{doc_id.inspect}\n\n" }
+        end
+      end
+    end
+
+    csv_file
+  end
+end

data/app/services/geoblacklight_admin/image_service/tms.rb

@@ -23,16 +23,12 @@ module GeoblacklightAdmin
         # Parse the URL using Addressable::URI which handles more complex URIs
         parsed_url = Addressable::URI.parse(document.viewer_endpoint)
 
-        puts "Parsed URL: #{parsed_url.inspect}"
-
         # Build a hash to store the extracted components
         parsed_data = {
           base_url: "#{parsed_url.scheme}://#{parsed_url.host}#{parsed_url.port ? ":" + parsed_url.port.to_s : ""}",
           path_pattern: parsed_url.path
         }
 
-        puts "Parsed Data: #{parsed_data.inspect}"
-
         endpoint = parsed_data[:base_url]
         "#{endpoint}/geoserver/wms/reflect?" \
           "&FORMAT=image%2Fpng" \

data/app/services/geoblacklight_admin/image_service.rb

@@ -191,7 +191,7 @@ module GeoblacklightAdmin
 
     # Retreives a url to a static thumbnail from the document's dct_references field, if it exists.
     def image_reference
-      @document.references["http://schema.org/thumbnailUrl"]
+      @document.distributions["http://schema.org/thumbnailUrl"]
     end
 
     # Default image size.

data/app/services/geoblacklight_admin/item_viewer.rb

@@ -2,9 +2,9 @@
 
 module GeoblacklightAdmin
   class ItemViewer
-    def initialize(references)
-      @references = references
-      @keys = references.keys.collect { |k| reference_uri_2_key(k) }
+    def initialize(distributions)
+      @distributions = distributions
+      @keys = distributions.keys.collect { |k| reference_uri_2_key(k) }
     end
 
     def viewer_protocol
@@ -12,7 +12,7 @@ module GeoblacklightAdmin
     end
 
     def viewer_endpoint
-      @references[viewer_protocol_2_endpoint]
+      @distributions[viewer_protocol_2_endpoint]
     end
 
     def reference_uri_2_key(value)

data/app/views/admin/bulk_actions/show.html.erb

@@ -43,7 +43,7 @@
           <% if @bulk_action.state_machine.current_state == 'created' %>
             <%= form_tag run_admin_bulk_action_path(@bulk_action), method: :patch do -%>
               <%= hidden_field_tag :run, true -%>
-              <%= submit_tag 'Run Bulk Action' -%>
+              <%= submit_tag '+ Run Bulk Action', class: 'btn btn-primary btn-block' -%>
             <%- end -%>
           <% else %>
             <%= @bulk_action.state_machine.current_state %>

data/app/views/admin/document_accesses/import.html.erb

@@ -15,7 +15,11 @@
       <h2 class='h3'>Import for Multiple Documents</h2>
     <% end %>
 
-    <h3 class='h4'>Import a CSV File</h3>
+    <p class="alert alert-info" role="alert">
+      <strong>Note:</strong> New Institutional Access URLs will be created. Existing Institutional Access URLs will be updated per the CSV file.
+    </p>
+
+    <h3 class='h4'>Upload a CSV File</h3>
     <%= simple_form_for DocumentAccess.new, url: import_admin_document_accesses_path, method: :post, multipart: true do |f| %>
       <div class="form-inputs">
         <%= f.simple_fields_for :assets do |asset_fields| %>
@@ -24,7 +28,7 @@
       </div>
 
       <div class="form-actions">
-        <%= submit_tag "Import CSV", {class: 'btn btn-primary'} %>
+        <%= submit_tag "+ Import CSV", {class: 'btn btn-primary'} %>
       </div>
     <% end %>
   </div>

data/app/views/admin/document_assets/_assets_table.html.erb

@@ -0,0 +1,49 @@
+<div class="table-responsive">
+  <table class="table table-striped table-bordered sortable">
+    <thead class="thead-dark">
+      <tr>
+        <th>Thumbnail</th>
+        <th>Preview</th>
+        <th>Title</th>
+        <th>Label</th>
+        <th>MimeType</th>
+        <th>Reference URI Type</th>
+        <th colspan="2">Actions</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% document_assets.each do |document_asset| %>
+        <tr>
+        <td>
+          <%= form_with model: document_asset, url: admin_document_document_asset_path(document_asset.parent, document_asset), method: :put, remote: true, class: 'thumbnail-form' do |f| %>
+            <%= f.check_box :thumbnail, class: 'thumbnail-toggle', onchange: "this.form.submit()" %>
+              <%= f.submit 'Save', class: 'btn btn-sm btn-primary d-none' %>
+            <% end %>
+          </td>
+          <td>
+            <% if document_asset.respond_to?(:thumbnail) %>
+              <% unless document_asset.file_url(:thumb_standard).nil? %>
+                <%= image_tag(document_asset.file_url(:thumb_standard), { height: 100 }) %>
+              <% end %>
+            <% end %>
+          </td>
+          <td><%= link_to(document_asset.title, document_asset.file.url) %></td>
+          <td><%= document_asset.label %></td>
+          <td>
+            <%= document_asset.file_data["metadata"]["mime_type"] %>
+            <span class="sr-only"><%= document_asset.inspect %></span>
+          </td>
+          <td>
+            <%= document_asset.dct_references_uri_key %>
+          </td>
+          <td>
+            <%= link_to 'Edit', edit_admin_document_document_asset_path(document_asset.parent, document_asset) %>
+          </td>
+          <td>
+            <%= link_to 'Destroy', admin_document_document_asset_path(document_asset.parent, document_asset), method: :delete, data: { confirm: 'Are you sure?' } %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/app/views/admin/document_assets/_form.html.erb

@@ -1,11 +1,10 @@
-<%= @document_asset.class %>
-
 <%= simple_form_for [:admin, @document, @document_asset], :url => admin_document_document_asset_path(@document, @document_asset) do |f| %>
   <%= f.error_notification %>
   <%= f.error_notification message: f.object.errors[:base].to_sentence if f.object.errors[:base].present? %>
 
   <div class="form-inputs">
-    <%= f.input :parent_id, input_html: { value: @document.friendlier_id, readonly: true } %>
+    <%= link_to "Parent Document", admin_document_path(@document_asset.parent) %>
+    <%= f.input :parent_id, as: :hidden %>
     <%= f.input :title %>
     <%= f.input :label %>
     <%= f.input :dct_references_uri_key, collection: I18n.t("activemodel.enum_values.document/reference.category").invert.sort.insert(0, ["Choose Reference Type", nil]), label: 'Reference' %>

data/app/views/admin/document_assets/index.html.erb

@@ -30,53 +30,7 @@
     </h6>
     <% end %>
 
-    <div class="table-responsive">
-      <table class="table table-striped table-bordered sortable">
-        <thead class="thead-dark">
-          <tr>
-            <th>Thumbnail</th>
-            <th>Preview</th>
-            <th>Title</th>
-            <th>Label</th>
-            <th>MimeType</th>
-            <th>Reference URI Type</th>
-            <th colspan="2">Actions</th>
-          </tr>
-        </thead>
-        <tbody>
-          <% @document_assets.each do |document_asset| %>
-            <tr>
-              <td>
-                <% if document_asset.respond_to?(:thumbnail) %>
-                  <%= document_asset.thumbnail %> 
-                <% end %>
-              </td>
-              <td>
-                <% if document_asset.respond_to?(:thumbnail) %>
-                  <% unless document_asset.file_url(:thumb_standard).nil? %>
-                    <%= image_tag(document_asset.file_url(:thumb_standard), { height: 100 }) %>
-                  <% end %>
-                <% end %>
-              </td>
-              <td><%= link_to(document_asset.title, document_asset.file.url) %></td>
-              <td><%= document_asset.label %></td>
-              <td>
-                <%= document_asset.file_data["metadata"]["mime_type"] %>
-                <span class="sr-only"><%= document_asset.inspect %></span>
-              </td>
-              <td>
-                <%= document_asset.dct_references_uri_key %>
-              </td>
-              <td>
-                <%= link_to 'Edit', edit_admin_document_document_asset_path(document_asset.parent, document_asset) %>
-              </td>
-              <td>
-                <%= link_to 'Destroy', admin_document_document_asset_path(document_asset.parent, document_asset), method: :delete, data: { confirm: 'Are you sure?' } %>
-              </td>
-            </tr>
-          <% end %>
-        </tbody>
-      </table>
+    <%= render partial: 'assets_table', locals: { document_assets: @document_assets } %>
 
       <% if @pagy %>
       <h6>

data/app/views/admin/document_distributions/_document_distribution.html.erb

@@ -0,0 +1,39 @@
+<%- @page_title = "GBL♦Admin - Document - Distribution - #{document_distribution.url}" %>
+
+<h1>Distribution</h1>
+
+<div class="row">
+  <div class="col-9">
+    <h2>
+      <%= document_distribution.url %>
+      <span class="float-right">
+        <%= link_to '~ Edit Distribution', edit_admin_document_document_distribution_path(@document, document_distribution), { class: 'btn btn-primary' } %>
+        <%= button_to "Destroy this distribution", admin_document_document_distribution_path(@document, document_distribution), method: :delete, class: "btn btn-danger" %>
+      </span>
+    </h2>
+
+    <table class="table table-bordered">
+      <thead class="thead-dark">
+        <tr>
+          <th class="header" style="width:300px;">Attribute</th>
+          <th class="header">Value</th>
+        </tr>
+      </thead>
+      <tr>
+        <th>Reference Type</th>
+        <td><%= document_distribution.reference_type.reference_type %></td>
+      </tr>
+      <tr>
+        <th>Reference URL</th>
+        <td><%= document_distribution.url %></td>
+      </tr>
+      <tr>
+        <th>Label</th>
+        <td><%= document_distribution.label %></td>
+      </tr>
+    </table>
+  </div>
+</div>
+
+<%= link_to 'Edit', edit_admin_document_document_distribution_path(@document, document_distribution) %> |
+<%= link_to 'Back', admin_document_document_distributions_path(@document) %>

data/app/views/admin/document_distributions/_document_distribution.json.jbuilder

@@ -0,0 +1,2 @@
+json.extract! document_distribution, :id, :created_at, :updated_at
+json.url document_distribution_url(document_distribution, format: :json)

data/app/views/admin/document_distributions/_form.html.erb

@@ -0,0 +1,34 @@
+<%= simple_form_for([:admin, @document, @document_distribution]) do |f| %>
+  <%= f.error_notification %>
+  <%= f.error_notification message: f.object.errors[:base].to_sentence if f.object.errors[:base].present? %>
+
+  <div class="form-inputs">
+    <%= f.input :friendlier_id, input_html: { value: @document.friendlier_id, readonly: true } %>
+    <%= f.input :reference_type_id, as: :select, collection: ReferenceType.all.map { |r| [r.reference_type, r.id] }, label: 'Reference Type' %>
+    <%= f.input :url, label: 'Distribution URL' %>
+    <%= f.input :label, autofocus: true, input_html: { disabled: true, id: 'label-input' } %>
+    
+  </div>
+
+  <div class="form-actions">
+    <%= f.button :submit, 'Create Download URL', {class: 'btn btn-primary'} %>
+  </div>
+<% end %>
+
+<script>
+document.addEventListener('DOMContentLoaded', function() {
+  const distributionSelect = document.querySelector('select[name="document_distribution[reference_type_id]"]');
+  const labelInput = document.getElementById('label-input');
+
+  function toggleLabelInput() {
+    if (distributionSelect.options[distributionSelect.selectedIndex].text === 'Download file') {
+      labelInput.disabled = false;
+    } else {
+      labelInput.disabled = true;
+    }
+  }
+
+  distributionSelect.addEventListener('change', toggleLabelInput);
+    toggleLabelInput(); // Initial check
+  });
+</script>