geoblacklight_admin 0.6.3 → 0.7.0

data/app/models/import_distribution.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "csv"
+
+# ImportDistribution class
+class ImportDistribution < ApplicationRecord
+  include ActiveModel::Validations
+
+  # Callbacks (keep at top)
+  after_commit :set_csv_file_attributes, if: :persisted?
+
+  # Associations
+  has_one_attached :csv_file
+  has_many :document_distributions, dependent: :destroy
+  has_many :import_document_distributions, dependent: :destroy
+  has_many :import_distribution_transitions, autosave: false, dependent: :destroy
+
+  # Validations
+  validates :csv_file, attached: true, content_type: {in: "text/csv", message: "is not a CSV file"}
+
+  validates_with ImportDistribution::CsvHeaderValidator
+
+  # States
+  include Statesman::Adapters::ActiveRecordQueries[
+    transition_class: ImportDistributionTransition,
+    initial_state: :created
+  ]
+
+  def state_machine
+    @state_machine ||= ImportDistributionStateMachine.new(self, transition_class: ImportDistributionTransition)
+  end
+
+  def set_csv_file_attributes
+    parsed = CSV.parse(csv_file.download)
+
+    update_columns(
+      headers: parsed[0],
+      row_count: parsed.size - 1,
+      content_type: csv_file.content_type.to_s,
+      filename: csv_file.filename.to_s,
+      extension: csv_file.filename.extension.to_s
+    )
+  end
+
+  def run!
+    # @TODO: guard this call, unless mappings_valid?
+
+    # Queue Job
+    ImportDistributionsRunJob.perform_later(self)
+
+    # Capture State
+    state_machine.transition_to!(:imported)
+    save
+  end
+end

data/app/models/import_distribution_state_machine.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Import Distribution Statesman
+class ImportDistributionStateMachine
+  include Statesman::Machine
+
+  state :created, initial: true
+  state :imported
+  state :success
+  state :failed
+
+  transition from: :created, to: [:imported]
+  transition from: :imported, to: %i[success failed]
+end

data/app/models/import_distribution_transition.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Add Import Distribution Statesman Transitions
+class ImportDistributionTransition < ApplicationRecord
+  include Statesman::Adapters::ActiveRecordTransition
+
+  # If your transition table doesn't have the default `updated_at` timestamp column,
+  # you'll need to configure the `updated_timestamp_column` option, setting it to
+  # another column name (e.g. `:updated_on`) or `nil`.
+  #
+  # self.updated_timestamp_column = :updated_on
+  # self.updated_timestamp_column = nil
+
+  belongs_to :import_distribution, inverse_of: :import_distribution_transitions
+
+  after_destroy :update_most_recent, if: :most_recent?
+
+  private
+
+  def update_most_recent
+    last_transition = import_distribution.import_distribution_transitions.order(:sort_key).last
+    return if last_transition.blank?
+
+    last_transition.update_column(:most_recent, true)
+  end
+end

data/app/models/import_document_distribution.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# ImportDocumentDistribution class
+class ImportDocumentDistribution < ApplicationRecord
+  has_many :import_document_distribution_transitions, autosave: false, dependent: :destroy
+
+  include Statesman::Adapters::ActiveRecordQueries[
+    transition_class: ImportDocumentDistributionTransition,
+    initial_state: :queued
+  ]
+
+  def state_machine
+    @state_machine ||= ImportDocumentDistributionStateMachine.new(self, transition_class: ImportDocumentDistributionTransition)
+  end
+
+  def to_hash
+    {
+      friendlier_id: friendlier_id,
+      reference_type: ReferenceType.find_by(name: reference_type),
+      url: distribution_url,
+      label: label,
+      import_distribution_id: import_distribution_id
+    }
+  end
+end

data/app/models/import_document_distribution_state_machine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# ImportDocumentDistribution Statesman
+class ImportDocumentDistributionStateMachine
+  include Statesman::Machine
+
+  state :queued, initial: true
+  state :success
+  state :failed
+
+  transition from: :queued, to: %i[success failed]
+  transition from: :failed, to: :success
+end

data/app/models/import_document_distribution_transition.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Add ImportDocumentDistribution Statesman Transitions
+class ImportDocumentDistributionTransition < ApplicationRecord
+  include Statesman::Adapters::ActiveRecordTransition
+
+  belongs_to :import_document_distribution, inverse_of: :import_document_distribution_transitions
+
+  after_destroy :update_most_recent, if: :most_recent?
+
+  private
+
+  def update_most_recent
+    last_transition = import_document_distribution.import_document_distribution_transitions.order(:sort_key).last
+    return if last_transition.blank?
+
+    last_transition.update_column(:most_recent, true)
+  end
+end

data/app/views/admin/document_data_dictionaries/_data_dictionaries_table.html.erb

@@ -0,0 +1,40 @@
+<div class="table-responsive">
+  <table class="table table-striped table-bordered sortable">
+    <thead class="thead-dark">
+      <tr>
+        <th>Name</th>
+        <th>Description</th>
+        <th>Staff Notes</th>
+        <th>Tags</th>
+        <th>Entries</th>
+        <th colspan="2">Actions</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% document_data_dictionaries.each do |document_data_dictionary| %>
+        <tr>
+          <td><%= link_to(document_data_dictionary.name, admin_document_document_data_dictionary_path(document_data_dictionary.friendlier_id, document_data_dictionary)) %></td>
+          <td>
+            <%= document_data_dictionary.description %>
+            <span class="sr-only"><%= document_data_dictionary.inspect %></span>
+          </td>
+          <td>
+            <%= document_data_dictionary.staff_notes %>
+          </td>
+          <td>
+            <%= document_data_dictionary.tags %>
+          </td>
+          <td>
+            <%= link_to "#{document_data_dictionary.document_data_dictionary_entries.count} entries", admin_document_document_data_dictionary_path(document_data_dictionary.friendlier_id, document_data_dictionary) %>
+          </td>
+          <td>
+            <%= link_to 'Edit', edit_admin_document_document_data_dictionary_path(document_data_dictionary.friendlier_id, document_data_dictionary) %>
+          </td>
+          <td>
+            <%= link_to 'Destroy', admin_document_document_data_dictionary_path(document_data_dictionary.friendlier_id, document_data_dictionary), method: :delete, data: { confirm: 'Are you sure?' } %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/app/views/admin/document_data_dictionaries/_document_data_dictionary.html.erb

@@ -0,0 +1,37 @@
+<%- @page_title = "GBL♦Admin - Document - Data Dictionaries" %>
+
+<div id="<%= dom_id document_data_dictionary %>">
+  <h2>
+    <%= document_data_dictionary.name %>
+    <%= link_to '~ Edit Data Dictionary', edit_admin_document_document_data_dictionary_path, { class: 'btn btn-primary float-right' } %>
+  </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>Friendlier Id</th>
+      <td><%= document_data_dictionary.friendlier_id %></td>
+    </tr>
+    <tr>
+      <th>Name</th>
+      <td><%= document_data_dictionary.name %></td>
+    </tr>
+    <tr>
+      <th>Description</th>
+      <td><%= document_data_dictionary.description %></td>
+    </tr>
+    <tr>
+      <th>Staff Notes</th>
+      <td><%= document_data_dictionary.staff_notes %></td>
+    </tr>
+    <tr>
+      <th>Tags</th>
+      <td><%= document_data_dictionary.tags %></td>
+    </tr>
+  </table>
+</div>

data/app/views/admin/document_data_dictionaries/_document_data_dictionary.json.jbuilder

@@ -0,0 +1,2 @@
+json.extract! document_data_dictionary, :id, :friendlier_id, :label, :type, :values, :definition, :definition_source, :parent_friendlier_id, :created_at, :updated_at
+json.url document_data_dictionary_url(document_data_dictionary, format: :json)

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

@@ -0,0 +1,17 @@
+<%= simple_form_for([:admin, @document, @document_data_dictionary]) 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 :name, input_html: { class: 'form-control', autofocus: true } %>
+    <%= f.input :description, input_html: { class: 'form-control' } %>
+    <%= f.input :staff_notes, input_html: { class: 'form-control' } %>
+    <%= f.input :tags, input_html: { class: "form-control mb-2", placeholder: "Comma-separated tags (Optional)", data: { controller: "taginput" } } %>
+    <%= f.file_field :csv_file, direct_upload: true %>
+  </div>
+
+  <div class="form-group mt-3">
+    <%= f.submit class: 'btn btn-primary' %>
+  </div>
+<% end %>

data/app/views/admin/document_data_dictionaries/edit.html.erb

@@ -0,0 +1,12 @@
+<% content_for :title, "Editing document data dictionary" %>
+
+<h1>Editing document data dictionary</h1>
+
+<%= render "form", document_data_dictionary: @document_data_dictionary %>
+
+<br>
+
+<div>
+  <%= link_to "Show this document data dictionary", admin_document_document_data_dictionary_path(@document, @document_data_dictionary) %> |
+  <%= link_to "Back to document data dictionaries", admin_document_document_data_dictionaries_path(@document) %>
+</div>

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

@@ -0,0 +1,45 @@
+<%- @page_title = "GBL♦Admin - Document - Data Dictionaries" %>
+
+<div class="row mb-2">
+  <div class="col">
+    <h1 style="width:100%;">
+      Document &middot; Data Dictionaries
+
+      <%= link_to '+ New Data Dictionary', new_admin_document_document_data_dictionary_path, { class: 'btn btn-primary float-right' } %>
+    </h1>
+    <% if params[:document_id] %>
+      <h2 class='h3'>
+        <%= link_to(@document.title, admin_document_path(@document)) %>
+        &middot;
+        <%= @document_data_dictionaries.count %> data dictionaries
+      </h2>
+    <% else %>
+      <h2 class='h3'>Data Dictionaries</h2>
+    <% end %>
+
+    <% if @pagy %>
+      <h6>
+        <span class='float-left mt-3'>
+          <%== pagy_info(@pagy, 'data dictionaries'.pluralize(@pagy.count)) %>
+      </span>
+      <span class='float-right'>
+        <%== pagy_bootstrap_nav(@pagy) %>
+      </span>
+  </h6>
+    <% end %>
+
+    <%= render partial: 'data_dictionaries_table', locals: { document_data_dictionaries: @document_data_dictionaries } %>
+
+    <% if @pagy %>
+    <h6>
+      <span class='float-left mt-3'>
+        <%== pagy_info(@pagy, 'data dictionaries'.pluralize(@pagy.count)) %>
+      </span>
+      <span class='float-right'>
+        <%== pagy_bootstrap_nav(@pagy) %>
+      </span>
+      </h6>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/admin/document_data_dictionaries/index.json.jbuilder

@@ -0,0 +1 @@
+json.array! @document_data_dictionaries, partial: "document_data_dictionaries/document_data_dictionary", as: :document_data_dictionary

data/app/views/admin/document_data_dictionaries/new.html.erb

@@ -0,0 +1,78 @@
+<div class="row mb-2">
+  <div class="col">
+    <%= link_to "Back to document data dictionaries", admin_document_document_data_dictionaries_path(@document) %>
+
+    <h1 style="width:100%;">
+      <%= @document.title %> &middot; New Data Dictionary
+    </h1>
+  </div>
+</div>
+
+<div class="row">
+  <div class="col-5">
+    <%= render "form", document_data_dictionary: @document_data_dictionary %>
+  </div>
+
+  <div class="col-6">
+    <h4>Example Data Dictionary CSV File</h4>
+    <table class="table table-bordered">
+      <thead>
+        <tr>
+          <th>friendlier_id*</th>
+          <th>field_name*</th>
+          <th>field_type*</th>
+          <th>values*</th>
+          <th>definition</th>
+          <th>definition_source</th>
+          <th>parent_field_name</th>
+        </tr>
+      </thead>
+      <tbody>
+        <tr>
+          <td>999-0010a</td>
+          <td>Institution</td>
+          <td>string</td>
+          <td>University of Minnesota</td>
+          <td>The name of the institution</td>
+          <td>https://www.umn.edu</td>
+          <td>999-0010UMN</td>
+        </tr>
+        <tr>
+          <td>999-0010a</td>
+          <td>Institution</td>
+          <td>string</td>
+          <td>University of Minnesota Duluth</td>
+          <td>The name of the institution</td>
+          <td>https://www.d.umn.edu</td>
+          <td>999-0010UMN</td>
+        </tr>
+        <tr>
+          <td>...</td>
+          <td>...</td>
+          <td>...</td>
+          <td>...</td>
+          <td>...</td>
+          <td>...</td>
+        </tr>
+      </tbody>
+    </table>
+
+    <h5>CSV File Column Definitions</h5>
+    <dl>
+      <dt>friendlier_id</dt>
+      <dd>The associated document's friendlier id</dd>
+      <dt>field_name</dt>
+      <dd>The name of the field</dd>
+      <dt>field_type</dt>
+      <dd>The type of the field</dd>
+      <dt>values</dt>
+      <dd>The values of the field</dd>
+      <dt>definition</dt>
+      <dd>The definition of the field</dd>
+      <dt>definition_source</dt>
+      <dd>The source of the definition</dd>
+      <dt>parent_field_name</dt>
+      <dd>The parent field's name</dd>
+    </dl>
+  </div>
+</div>

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

@@ -0,0 +1,78 @@
+<%- @page_title = "GBL♦Admin - Document - Data Dictionaries" %>
+
+<div class="row mb-2">
+  <div class="col">
+    <%= link_to "Back to document data dictionaries", admin_document_document_data_dictionaries_path(@document) %>
+
+    <h1 style="width:100%;">
+      <%= @document.title %> &middot; Data Dictionaries &middot; <%= @document_data_dictionary.name %>
+
+      <%= link_to '+ New Entry', new_admin_document_document_data_dictionary_document_data_dictionary_entry_path(@document, @document_data_dictionary), { class: 'btn btn-primary float-right' } %>
+    </h1>
+  </div>
+</div>
+
+<div class="row">
+  <div class="col-12">
+    <h6>
+      <span class='float-left mt-3'>
+      <%== pagy_info(@pagy) %>
+      </span>
+      <span class='float-right'>
+        <%== pagy_bootstrap_nav(@pagy) %>
+      </span>
+    </h6>
+
+    <div class="table-responsive">
+      <table class="table table-striped table-bordered sortable">
+        <thead class="thead-dark">
+          <tr>
+            <th class="header">field_name</th>
+            <th class="header">field_type</th>
+            <th class="header">values</th>
+            <th class="header">definition</th>
+            <th class="header">definition_source</th>
+            <th class="header">parent_field_name</th>
+            <th class="header">Reorder</th>
+            <th class="header" colspan="2">Actions</th>
+          </tr>
+        </thead>
+        <tbody>
+        <% @document_data_dictionary.document_data_dictionary_entries.each do |entry| %>
+          <tr data-id="<%=entry.id%>">
+            <td><%= entry.field_name %></td>
+            <td><%= entry.field_type %></td>
+            <td><%= entry.values %></td>
+            <td><%= entry.definition %></td>
+            <td><%= entry.definition_source %></td>
+            <td><%= entry.parent_field_name %></td>
+            <td class="handle" style="text-align:center">&varr;</td>
+            <td>
+              <%= link_to 'Edit', edit_admin_document_document_data_dictionary_document_data_dictionary_entry_path(@document, @document_data_dictionary, entry.id) %>
+            </td>
+            <td>
+              <%= link_to 'Destroy', admin_document_document_data_dictionary_document_data_dictionary_entry_path(@document, @document_data_dictionary, entry.id), method: :delete, data: { confirm: 'Are you sure?' } %>
+            </td>
+          </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+
+    <h6>
+      <span class='float-left mt-3'>
+        <%== pagy_info(@pagy) %>
+      </span>
+      <span class='float-right'>
+        <%== pagy_bootstrap_nav(@pagy) %>
+      </span>
+    </h6>
+  </div>
+</div>
+
+<script>
+  GBLADMIN.SortElements(
+    $("tbody"),
+    "<%= sort_admin_document_document_data_dictionary_document_data_dictionary_entries_path(@document, @document_data_dictionary) %>"
+  );
+</script>

data/app/views/admin/document_data_dictionaries/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! "document_data_dictionaries/document_data_dictionary", document_data_dictionary: @document_data_dictionary

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

@@ -0,0 +1,19 @@
+<%= simple_form_for([:admin, @document, @document_data_dictionary, @document_data_dictionary_entry]) 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 :document_data_dictionary_id, as: :hidden, input_html: { value: @document_data_dictionary.id } %>
+    <%= f.input :field_name, input_html: { class: 'form-control', autofocus: true } %>
+    <%= f.input :field_type, input_html: { class: 'form-control' } %>
+    <%= f.input :values, input_html: { class: 'form-control' } %>
+    <%= f.input :definition, input_html: { class: 'form-control' } %>
+    <%= f.input :definition_source, input_html: { class: 'form-control' } %>
+    <%= f.input :parent_field_name, input_html: { class: 'form-control' } %>
+  </div>
+
+  <div class="form-group">
+    <%= f.submit class: 'btn btn-primary' %>
+  </div>
+<% end %>

data/app/views/admin/document_data_dictionary_entries/edit.html.erb

@@ -0,0 +1,12 @@
+<% content_for :title, "Editing document data dictionary entry" %>
+
+<h1>Editing document data dictionary entry</h1>
+
+<%= render "form", document_data_dictionary_entry: @document_data_dictionary_entry %>
+
+<br>
+
+<div>
+  <%= link_to "Show this document data dictionary entry", admin_document_document_data_dictionary_document_data_dictionary_entry_path(@document, @document_data_dictionary, @document_data_dictionary_entry) %> |
+  <%= link_to "Back to document data dictionary entries", admin_document_document_data_dictionary_document_data_dictionary_entries_path(@document, @document_data_dictionary) %>
+</div>

data/app/views/admin/document_data_dictionary_entries/new.html.erb

@@ -0,0 +1,16 @@
+<div class="row mb-2">
+  <div class="col">
+    <%= link_to "Back to document data dictionaries", admin_document_document_data_dictionaries_path(@document) %>
+
+    <h1 style="width:100%;">
+      <%= @document.title %> &middot; New Data Dictionary Entry
+    </h1>
+  </div>
+</div>
+
+<div class="row">
+  <div class="col-5">
+    <%= render "form", document_data_dictionary_entry: @document_data_dictionary_entry %>
+
+    <%= link_to "Back to document data dictionary entries", admin_document_document_data_dictionary_document_data_dictionary_entries_path(@document, @document_data_dictionary) %>
+  </div>

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

@@ -6,12 +6,12 @@
       Document · Distributions
 
       <% if params[:document_id] %>
-        <%= link_to '+ Import CSV', import_admin_document_document_distributions_path(@document), { class: 'btn btn-primary float-right' } %>
+        <%= link_to '+ Import CSV', new_admin_import_distribution_path, { class: 'btn btn-primary float-right' } %>
 
         <%= link_to '+ New Distribution', new_admin_document_document_distribution_path(@document), { class: 'btn btn-primary float-right mr-2' } %>
       <% else %>
         <%= link_to '- Delete CSV', destroy_all_admin_document_distributions_path, { class: 'btn btn-danger float-right' } %>
-        <%= link_to '+ Import CSV', import_admin_document_distributions_path, { class: 'btn btn-primary float-right mr-4' } %>
+        <%= link_to '+ Import CSV', new_admin_import_distribution_path, { class: 'btn btn-primary float-right mr-4' } %>
       <% end %>
     </h1>
 

data/app/views/admin/documents/_form_nav.html.erb

@@ -32,6 +32,10 @@
         Additional Assets 
         <span class="badge badge-light"><%= @document.document_assets.count %></span>
       <% end %>
+      <%= link_to admin_document_document_data_dictionaries_url(@document), class: "ml-2" do %>
+        Data Dictionaries 
+        <span class="badge badge-light"><%= @document.document_data_dictionaries.count %></span>
+      <% end %>
       <%= link_to admin_document_document_distributions_url(@document), class: "ml-2" do %>
         Distributions
       <% end %>

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

@@ -0,0 +1,21 @@
+<% if @import_distribution.errors.any? %>
+  <div class="alert alert-danger mb-4" role="alert">
+    <h2 class="h4" class="alert-heading"><%= pluralize(@import_distribution.errors.count, "error") %> prohibited this import distribution from being saved</h2>
+    <ol class="mb-0">
+      <% @import_distribution.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+    </ol>
+  </div>
+<% end %>
+
+<div class="form-inputs">
+  <%= f.input :name, {autofocus: true} %>
+  <%= f.input :source %>
+  <%= f.input :description %>
+  <%= f.file_field :csv_file, direct_upload: true %>
+</div>
+
+<div class="form-actions">
+  <%= f.button :submit, "+ Create Import Distributions", {class: 'btn btn-primary'} %>
+</div>

data/app/views/admin/import_distributions/_import_distribution.json.jbuilder

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+json.extract! import_distribution, :id, :name, :filename, :source, :description, :row_count, :headers, :encoding, :content_type,
+  :extension, :validity, :validation_result, :created_at, :updated_at
+json.url import_distribution_url(import_distribution, format: :json)

data/app/views/admin/import_distributions/_show_failed_tab.html.erb

@@ -0,0 +1,36 @@
+<h6>
+  <span class='float-left mt-3'>
+    <%== pagy_info(@pagy_failed) %>
+  </span>
+  <span class='float-right'>
+    <%== pagy_bootstrap_nav(@pagy_failed) %>
+  </span>
+</h6>
+
+<table class="table table-striped">
+  <thead>
+    <tr>
+      <th>State</th>
+      <th>Title</th>
+      <th>Identifier</th>
+      <th>Reason</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @import_failed_distributions.each_with_index do |distribution, index| %>
+      <tr>
+        <td>
+          <span class="badge badge-danger">
+            <%= distribution.state_machine.current_state %>
+          </span>
+        </td>
+        <td><%= distribution.friendlier_id %></td>
+        <td>
+          <%= link_to admin_import_distribution_path(@import_distribution, distribution) do %>
+            <%= distribution.state_machine&.last_transition&.metadata %>
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>