Tools improvements (#673)

* update word translation tool, allow multiple wbw translation for same language

* fix wbw translation progress calculation

* add resources tab on profile page

* allow adding missing footntoe to draft translation

* improve the profile page

* show permission info

Author: naveed-ahmad

app/admin/draft/translation.rb

@@ -38,12 +38,34 @@
     end
   end
 
+  action_item :add_footnote, only: :show do
+    if !resource.imported?
+      link_to 'Add footnote', add_footnote_cms_draft_translation_path(resource),
+              data: { controller: 'ajax-modal', url: add_footnote_cms_draft_translation_path(resource), css_class: 'modal-lg' }
+    end
+  end
+
   member_action :import, method: 'put' do
     translation = resource.import!
 
     redirect_to [:cms, translation], notice: 'Draft translation is approved and imported successfully'
   end
 
+  member_action :add_footnote, method: 'get' do
+    @draft = resource
+    render partial: 'admin/draft/add_footnote'
+  end
+
+  member_action :save_footnote, method: 'put' do
+    if params[:draft_text].to_s.match?(Draft::Translation::INLINE_FOOTNOTE_REGEXP)
+      resource.add_inline_footnotes!(params[:draft_text])
+      redirect_to [:cms, resource], notice: 'Footnote(s) added to draft translation'
+    else
+      redirect_to add_footnote_cms_draft_translation_path(resource),
+                  alert: 'No footnote markers found. Wrap footnote text in << and >>.'
+    end
+  end
+
   index do
     id_column
     column :text_matched

app/admin/settings/resource_permission.rb

@@ -13,6 +13,8 @@
       row :permission_to_host_info
       row :permission_to_share_info
       row :source_info
+      row :copyright_notice
+      row :contact_info
       row :created_at
       row :updated_at
     end
@@ -44,6 +46,7 @@
       f.input :permission_to_share_info
       f.input :source_info, as: :text
       f.input :copyright_notice, as: :text
+      f.input :contact_info, as: :text
     end
 
     f.actions

app/admin/user.rb

@@ -67,6 +67,7 @@
       row :first_name
       row :last_name
       row :email
+      row :about_me
       row :created_at
 
       if can?(:moderate, resource)

app/controllers/profiles_controller.rb

@@ -48,11 +48,11 @@ def submitted_params
   end
 
   def account_update_params
-    params.require(:user).permit(:first_name, :last_name, :email, :password, :password_confirmation, :current_password)
+    params.require(:user).permit(:first_name, :last_name, :email, :about_me, :password, :password_confirmation, :current_password)
   end
 
   def profile_update_params
-    params.require(:user).permit(:first_name, :last_name, :email)
+    params.require(:user).permit(:first_name, :last_name, :email, :about_me)
   end
 
   def update_notice

app/controllers/word_translations_controller.rb

@@ -1,27 +1,11 @@
 class WordTranslationsController < CommunityController
   before_action :authorize_access!, only: [:new, :edit, :update, :create]
-  before_action :init_presenter
-  def index
-    @word_translation_languages = Language.where(id: ResourceContent.translations.one_word.select('language_id'))
+  before_action :require_resource, except: [:select_resource]
 
-    verses = Verse
-    if params[:filter_juz].to_i > 0
-      verses = verses.where(juz_number: params[:filter_juz].to_i)
-    end
-
-    if params[:filter_chapter].to_i > 0
-      verses = verses.where(chapter_id: params[:filter_chapter].to_i)
-    end
-
-    if params[:verse_number].to_i > 0
-      verses = verses.where(verse_number: params[:verse_number].to_i)
-    end
-
-    if params[:filter_missing] == 'true'
-      verses = verses.verses_with_missing_translations(language.id)
-    end
+  def select_resource
+  end
 
-    @pagy, @verses = pagy(verses.order("verse_index #{sort_order}"))
+  def index
   end
 
   def show
@@ -43,30 +27,24 @@ def new
              end
 
     if @verse.blank?
-      return redirect_back fallback_location: word_translations_path(language: language.id), alert: 'Verse not found'
+      return redirect_back fallback_location: word_translations_path(resource_id: resource.id), alert: 'Verse not found'
     end
-
-    prepare_wbw_translations
   end
 
   def create
     @verse = Verse.find(params[:verse_id])
     @verse.update_word_translations(wbw_translations_params)
 
-    redirect_to word_translation_path(@verse, language: language.id)
+    redirect_to word_translation_path(@verse, resource_id: resource.id)
   end
 
   def group_info
-    @word_translation = WordTranslation.where(
-      word_id: params[:word_id],
-      language_id: language.id
-    ).first_or_initialize
+    @word_translation = @presenter.group_word_translation(params[:word_id])
     @verse = @word_translation.word&.verse
 
     if request.post?
       if @word_translation.create_or_update_group_translation(group_translation_params)
         flash[:notice] = 'Group info updated'
-        prepare_wbw_translations
         render 'update_group_info'
       else
         render_turbo_validations(@word_translation, {action: :update})
@@ -92,6 +70,7 @@ def wbw_translations_params
       :id,
       :word_id,
       :language_id,
+      :resource_content_id,
       :text,
       :group_text,
       :group_word_id
@@ -116,29 +95,27 @@ def eager_load_translations
     end
   end
 
-  def load_resource
-    @resource ||= ResourceContent.translations.one_word.where(language: language).first
+  def resource
+    @resource ||= @presenter.resource
   end
 
-  def load_resource_access
-    @access = can_manage?(load_resource)
+  def require_resource
+    if resource.blank?
+      redirect_to select_resource_word_translations_path and return
+    end
   end
 
-  def prepare_wbw_translations
-    @wbw_translations = []
+  def language
+    @language ||= resource&.language || super
+  end
 
-    @verse.words.order('position asc').each_with_index do |word, i|
-      next if word.char_type_name == 'end'
-      wbw_translation = @verse
-                          .word_translations
-                          .where(language_id: language.id)
-                          .find_or_initialize_by(word_id: word.id)
+  alias current_language language
 
-      @wbw_translations << wbw_translation
-    end
+  def load_resource_access
+    @access = can_manage?(resource)
   end
 
   def init_presenter
     @presenter = WordTranslationsPresenter.new(self)
   end
-end
+end

app/helpers/profiles_helper.rb

@@ -8,9 +8,20 @@ def profile_tab_link(name, tab, active_tab)
   end
 
   def contribution_filter_link(label, item_type, active_type)
-    active = item_type == active_type
+    profile_filter_chip label, profile_path(tab: "contributions", item_type: item_type), item_type == active_type
+  end
+
+  def download_filter_link(label, resource_type, active_type)
+    profile_filter_chip label, profile_path(tab: "downloads", download_type: resource_type), resource_type == active_type
+  end
+
+  def resource_filter_link(label, sub_type, active_type)
+    profile_filter_chip label, profile_path(tab: "resources", resource_type: sub_type), sub_type == active_type
+  end
+
+  def profile_filter_chip(label, url, active)
     classes = active ? "bg-[#46ac7a] text-white border-[#46ac7a]" : "text-gray-600 border-gray-200 hover:text-black"
-    link_to label, profile_path(tab: "contributions", item_type: item_type),
+    link_to label, url,
             class: "text-xs px-3 py-1 rounded-full border #{classes}",
             data: { turbo_frame: "profile_panel" }
   end
@@ -22,4 +33,50 @@ def contribution_cms_url(item)
   rescue StandardError
     nil
   end
+
+  def resource_tool(resource_content)
+    return { label: nil, url: nil } unless resource_content
+
+    case resource_content.sub_type
+    when ResourceContent::SubType::Translation
+      if resource_content.cardinality_type == ResourceContent::CardinalityType::OneWord
+        { label: "Word translation", url: word_translations_path(resource_id: resource_content.id) }
+      else
+        { label: "Ayah translation", url: translation_proofreadings_path(resource_id: resource_content.id) }
+      end
+    when ResourceContent::SubType::Tafsir
+      { label: "Tafsir", url: tafsir_proofreadings_path(resource_id: resource_content.id) }
+    when ResourceContent::SubType::Transliteration
+      { label: "Transliteration", url: arabic_transliterations_path(resource_id: resource_content.id) }
+    when ResourceContent::SubType::Audio
+      audio_resource_tool(resource_content)
+    when ResourceContent::SubType::Layout
+      mushaf = Mushaf.find_by(resource_content_id: resource_content.id)
+      { label: "Mushaf layout", url: mushaf ? mushaf_layout_path(mushaf.id) : nil }
+    when ResourceContent::SubType::Info
+      { label: "Surah info", url: surah_infos_path(language_id: resource_content.language_id) }
+    when ResourceContent::SubType::Mutashabihat
+      { label: "Mutashabihat", url: morphology_phrases_path }
+    else
+      { label: resource_content.sub_type&.humanize, url: nil }
+    end
+  rescue StandardError
+    { label: resource_content&.sub_type&.humanize, url: nil }
+  end
+
+  private
+
+  def audio_resource_tool(resource_content)
+    ayah_recitation = Recitation.find_by(resource_content_id: resource_content.id)
+    if ayah_recitation
+      return { label: "Ayah audio", url: ayah_audio_files_path(id: ayah_recitation.id) }
+    end
+
+    surah_recitation = Audio::Recitation.find_by(resource_content_id: resource_content.id)
+    if surah_recitation
+      return { label: "Surah audio", url: surah_audio_files_path(recitation_id: surah_recitation.id) }
+    end
+
+    { label: "Audio", url: nil }
+  end
 end

app/helpers/tool_docs_helper.rb

@@ -88,20 +88,26 @@ def word_translation_help
       },
       {
         type: 'step',
-        title: 'Step 1: Find the word translation for a specific language',
-        text: "Use the available filters to find the desired translation. You can filter by <code>Language</code> <code>Surah</code> and <code>Ayah</code> to narrow down the results. Click <code>Show</code> to display the selected Ayah, where a list of words and their corresponding translations will appear.",
+        title: 'Step 1: Select a translation resource',
+        text: "A language can have more than one word-by-word translation, so start by picking the resource you want to work on from the <code>Select resource</code> page. Each resource is maintained separately.",
         screenshot: 'word_translations.png'
       },
       {
         type: 'step',
-        title: 'Step 2: Read the translation',
-        text: "Review the translation of each word carefully. If an update is needed, click the <code>Edit</code> button to fix the translation.",
+        title: 'Step 2: Find an ayah',
+        text: "Once a resource is selected, use the <code>Surah</code> and <code>Ayah</code> filters to narrow down the results. Click <code>Show</code> to display the selected Ayah, where a list of words and their corresponding translations will appear.",
+        screenshot: 'word_translations.png'
+      },
+      {
+        type: 'step',
+        title: 'Step 3: Read the translation',
+        text: "Review the translation of each word carefully. Words without a translation are highlighted so you can spot gaps at a glance. If an update is needed, click the <code>Edit</code> button to fix the translation.",
         screenshot: 'ayah-words-translation.png'
       },
       {
         type: 'step',
-        title: 'Step 3: Update the translation',
-        text: "The page will display the Ayah along with a list of all its words. To help focus, only one word will be shown at a time. Each word comes with an input field where you can correct its translation. Once you're satisfied with the update, click <code>Save translations</code> to save the changes.",
+        title: 'Step 4: Update the translation',
+        text: "The page will display the Ayah along with a list of all its words. Each word is shown as its own card with an input field, its current translation, and the English translation for reference. Once you're satisfied with the update, click <code>Save translations</code> to save the changes.",
         screenshot: 'update-word-translation.png'
       },
       {
@@ -110,10 +116,10 @@ def word_translation_help
       },
       {
         type: 'step',
-        title: 'Step 3.1: Update the group translation',
+        title: 'Step 4.1: Update the group translation',
         sections: [
           {
-            text: "If you find a group of words that should be translated together, you can group them. To do this, click the <code>Create Group translation</code> button(Or <code>Edit Group translation</code> if you need to change an existing group) to open the group translation modal.",
+            text: "If you find a group of words that should be translated together, you can group them. To do this, click the <code>Create group</code> button (or <code>Edit group</code> if you need to change an existing group) to open the group translation modal.",
             screenshot: 'create-group.png'
           },
           {

app/helpers/tools_helper.rb

@@ -92,7 +92,7 @@ def developer_tools
       ToolCard.new(
         title: 'Word by Word translation',
         description: 'Proofread and suggest fixes for word by word translations in multiple languages.',
-        url: word_translations_path,
+        url: select_resource_word_translations_path,
         type: 'corpus',
         tags: [['Translation', 'translation'], ['Word by Word', 'word-by-word']],
         icon: 'translation.svg',

app/models/draft/translation.rb

@@ -28,8 +28,11 @@
 #  index_draft_translations_on_verse_id             (verse_id)
 #
 
+
 class Draft::Translation < ApplicationRecord
   REGEXP_FOOTNOTE_ID = /foot_note=(?<id>\d+)/
+  INLINE_FOOTNOTE_REGEXP = /<<(?<text>.+?)>>/m
+  FOOTNOTE_SUP_REGEXP = %r{<sup foot_note=["']?(?<id>\d+)["']?>\d+</sup>}
   include HasMetaData
   include PaperTrailAttribution
 
@@ -173,4 +176,35 @@ def original_footnote_text(foot_note_id)
   def update_footnote_count
     update_column :footnotes_count, foot_notes.count
   end
+
+  def add_inline_footnotes!(raw_text)
+    footnote_resource_id = foot_notes.first&.resource_content_id ||
+                           resource_content.meta_value('related-footnote-resource-id')
+
+    text = raw_text.to_s.gsub(/<<\s*>>/, '').gsub(INLINE_FOOTNOTE_REGEXP) do
+      inner = Regexp.last_match(:text).strip
+      next '' if inner.blank?
+
+      footnote = foot_notes.create!(
+        draft_text: inner,
+        resource_content_id: footnote_resource_id
+      )
+      "<sup foot_note=#{footnote.id}>0</sup>"
+    end
+
+    self.draft_text = renumber_footnote_sups(text)
+    save!
+    update_footnote_count
+    self
+  end
+
+  private
+
+  def renumber_footnote_sups(text)
+    index = 0
+    text.gsub(FOOTNOTE_SUP_REGEXP) do
+      index += 1
+      "<sup foot_note=#{Regexp.last_match(:id)}>#{index}</sup>"
+    end
+  end
 end

app/models/user_project.rb

@@ -21,6 +21,8 @@ class UserProject < ApplicationRecord
   belongs_to :resource_content, optional: true
   belongs_to :user, optional: true
 
+  scope :approved, -> { where(approved: true) }
+
   validates :reason_for_request, :language_proficiency, :motivation_and_goals, presence: true
   validates :review_process_acknowledgment, presence: {message: 'Please check the review process acknowledge'}
   validate :unique_request_per_resource