export/import draft translation (#666)

Author: naveed-ahmad

app/admin/content/resource_content.rb

@@ -217,6 +217,32 @@
     redirect_to [:cms, resource], notice: "#{resource.name} will be exported and sent to you via email. You can also download the export from this page after few minutes."
   end
 
+  member_action :export_draft_translations, method: 'get' do
+    authorize! :export, resource
+
+    data = resource.export_draft_translations
+
+    send_data JSON.generate(data, state: JsonNoEscapeHtmlState.new),
+              filename: "draft-translations-#{resource.id}.json",
+              type: 'application/json'
+  end
+
+  member_action :import_draft_translations, method: 'post' do
+    authorize! :manage, resource
+
+    file = params.dig(:resource_content, :draft_file)
+
+    if file.blank?
+      flash[:error] = 'Please select a draft translations JSON file to import.'
+      return redirect_to [:cms, resource]
+    end
+
+    stats = resource.import_draft_translations(file.read)
+
+    redirect_to [:cms, resource],
+                notice: "Draft translations imported: #{stats[:created]} created, #{stats[:updated]} updated, #{stats[:skipped]} skipped."
+  end
+
   index do
     id_column
 
@@ -490,6 +516,12 @@
     end
   end
 
+  sidebar 'Draft translations', only: :show, if: -> { can?(:manage, resource) && resource.translation? && !resource.one_word? } do
+    div do
+      render 'admin/draft_translations_transfer'
+    end
+  end
+
   sidebar 'Contribution access', only: :show, if: -> { can?(:manage, resource) } do
     table do
       thead do

app/assets/stylesheets/shared/content.scss

@@ -120,3 +120,29 @@ body {
 .b{
   font-weight: bold;
 }
+
+sup.footnote-marker {
+  cursor: pointer;
+  font-size: 0.7em;
+  padding: 0.1em 0.3em;
+  margin: 0 0.15em;
+  color: #006d98;
+  font-weight: 700;
+  border-radius: 4px;
+  background-color: rgba(0, 109, 152, 0.08);
+  transition: background-color 0.15s ease;
+}
+
+sup.footnote-marker:hover {
+  background-color: rgba(0, 109, 152, 0.2);
+}
+
+sup.footnote-grammar {
+  color: #707070;
+  font-style: italic;
+  background-color: rgba(112, 112, 112, 0.1);
+}
+
+sup.footnote-grammar:hover {
+  background-color: rgba(112, 112, 112, 0.22);
+}

app/javascript/controllers/translation_footnote_controller.js

@@ -1,14 +1,33 @@
 import {Controller} from "@hotwired/stimulus";
 
+const HARDCODED_FOOTNOTES = {
+  pl: "Plural — the Arabic address or verb is plural",
+  sg: "Singular — the Arabic address or verb is singular",
+  dl: "Dual — the Arabic address or verb is dual",
+};
+
 export default class extends Controller {
   connect() {
     this.inlineFootnotes()
   }
 
   inlineFootnotes() {
     const footnotes = this.element.querySelectorAll('sup')
-    footnotes.forEach((dom, _i ) => {
-      $(dom).append(`(${dom.getAttribute('foot_note')})`)
+    footnotes.forEach((dom) => {
+      const footNote = dom.getAttribute('foot_note')
+      const marker = (dom.textContent || '').trim().toLowerCase()
+
+      dom.classList.add('footnote-marker')
+
+      if (!footNote && HARDCODED_FOOTNOTES[marker]) {
+        dom.classList.add('footnote-grammar')
+        dom.setAttribute('title', HARDCODED_FOOTNOTES[marker])
+        return
+      }
+
+      if (footNote) {
+        $(dom).append(`(${footNote})`)
+      }
     })
   }
-}
+}

app/models/resource_content.rb

@@ -648,6 +648,99 @@ def import_draft_tafsir(id)
     resource.run_draft_import_hooks
   end
 
+  def export_draft_translations
+    translations = Draft::Translation
+                     .where(resource_content_id: id)
+                     .includes(:verse, :foot_notes)
+                     .order(:verse_id)
+
+    {
+      resource_content_id: id,
+      name: name,
+      language_name: language_name,
+      records_count: translations.size,
+      translations: translations.map do |translation|
+        {
+          verse_key: translation.verse.verse_key,
+          draft_text: translation.draft_text,
+          current_text: translation.current_text,
+          text_matched: translation.text_matched,
+          need_review: translation.need_review,
+          footnotes_count: translation.footnotes_count,
+          current_footnotes_count: translation.current_footnotes_count,
+          meta_data: translation.meta_data,
+          foot_notes: translation.foot_notes.map do |foot_note|
+            {
+              id: foot_note.id,
+              resource_content_id: foot_note.resource_content_id,
+              draft_text: foot_note.draft_text,
+              current_text: foot_note.current_text,
+              text_matched: foot_note.text_matched
+            }
+          end
+        }
+      end
+    }
+  end
+
+  def import_draft_translations(json)
+    data = json.is_a?(String) ? JSON.parse(json) : json
+    stats = { created: 0, updated: 0, skipped: 0 }
+
+    (data['translations'] || []).each do |row|
+      verse = Verse.find_by(verse_key: row['verse_key'])
+
+      if verse.nil?
+        stats[:skipped] += 1
+        next
+      end
+
+      draft = Draft::Translation
+                .where(resource_content_id: id, verse_id: verse.id)
+                .first_or_initialize
+
+      was_new = draft.new_record?
+
+      draft.draft_text = row['draft_text']
+      draft.current_text = row['current_text']
+      draft.text_matched = row['text_matched']
+      draft.need_review = row['need_review']
+      draft.meta_data = row['meta_data']
+      draft.imported = false
+      draft.save(validate: false)
+
+      draft.foot_notes.destroy_all
+      id_map = {}
+
+      (row['foot_notes'] || []).each do |note|
+        foot_note = draft.foot_notes.create(
+          resource_content_id: note['resource_content_id'],
+          draft_text: note['draft_text'],
+          current_text: note['current_text']
+        )
+        foot_note.update_columns(
+          current_text: note['current_text'],
+          text_matched: note['text_matched']
+        )
+        id_map[note['id'].to_s] = foot_note.id if note['id']
+      end
+
+      if id_map.present?
+        text = draft.draft_text.to_s
+        id_map.each do |old_id, new_id|
+          text = text.sub(/foot_note=(['"]?)#{old_id}\1/, "foot_note=#{new_id}")
+        end
+        draft.update_column(:draft_text, text)
+      end
+
+      was_new ? stats[:created] += 1 : stats[:updated] += 1
+    end
+
+    run_draft_import_hooks
+
+    stats
+  end
+
   def export_file_name
     ExportService.new(self).get_export_file_name
   end

app/views/admin/_draft_translations_transfer.html.erb

@@ -0,0 +1,19 @@
+<div class="mt-2">
+  <% count = resource.draft_translations.count %>
+
+  <% if count > 0 %>
+    <p class="mb-1"><%= count %> draft translation<%= 's' unless count == 1 %> available.</p>
+    <%= link_to 'Export draft translations', export_draft_translations_cms_resource_content_path(resource), class: 'button' %>
+  <% else %>
+    <p class="mb-1">No draft translations to export.</p>
+  <% end %>
+
+  <hr class="my-3">
+
+  <%= form_with model: resource, url: import_draft_translations_cms_resource_content_path(resource),
+                method: :post, enctype: 'multipart/form-data' do |form| %>
+    <h4>Import draft translations</h4>
+    <%= form.file_field :draft_file, required: true, accept: 'application/json,.json' %>
+    <%= form.submit 'Upload & import', data: { disable_with: 'Importing...', confirm: 'This will create or overwrite draft translations for this resource. Continue?' } %>
+  <% end %>
+</div>