Merge branch 'jh-remove_html_todolist' into 'master'

Remove HTML todolist functionality

See merge request gitlab-org/gitlab!48020

lib/gitlab/i18n/html_todo.yml

-#
-# PLEASE DO NOT ADD NEW STRINGS TO THIS FILE.
-#
-# See https://docs.gitlab.com/ee/development/i18n/externalization.html#html
-# for information on how to handle HTML in translations.
-
-#
-# This file contains strings that need to be fixed to use the
-# updated HTML guidelines. Any strings in this file will no
-# longer be able to be translated until they have been updated.
-#
-# This file (and the functionality around it) will be removed
-# once https://gitlab.com/gitlab-org/gitlab/-/issues/217933 is complete.
-#
-# See https://gitlab.com/gitlab-org/gitlab/-/issues/19485 for more details
-# why this change has been made.
-#
-
-#
-# Strings below are fixed in the source code but the translations are still present in CrowdIn so the
-# locale files will fail the linter. They can be deleted after next CrowdIn sync, likely in:
-# https://gitlab.com/gitlab-org/gitlab/-/issues/226008
-#
-
-"This commit was signed with an <strong>unverified</strong> signature.":
-  plural_id:
-  translations:
-    - "このコミットは<strong>検証されていない</strong> 署名でサインされています。"
-    - "Этот коммит был подписан <strong>непроверенной</strong> подписью."
-    - "此提交使用 <strong>未经验证的</strong> 签名进行签名。"
-    - "Цей коміт підписано <strong>неперевіреним</strong> підписом."
-    - "Esta commit fue firmado con una firma <strong>no verificada</strong>."
-"This commit was signed with a <strong>verified</strong> signature and the committer email is verified to belong to the same user.":
-  plural_id:
-  translations:
-    - "このコミットは <strong>検証済み</strong> の署名でサインされており、このコミッターのメールは同じユーザーのものであることが検証されています。"
-    - "Это коммит был подписан <strong>верифицированной</strong> подписью и коммитер подтвердил, что адрес почты принадлежит ему."
-    - "此提交使用 <strong>已验证</strong> 的签名进行签名，并且已验证提交者的电子邮件属于同一用户。"
-    - "Цей коміт підписано <strong>перевіреним</strong> підписом і адреса електронної пошти комітера гарантовано належить тому самому користувачу."
-    - "Este commit fue firmado con una firma verificada, y <strong>se ha verificado</strong> que la dirección de correo electrónico del committer y la firma pertenecen al mismo usuario."
-"Branch <strong>%{branch_name}</strong> was created. To set up auto deploy, choose a GitLab CI Yaml template and commit your changes. %{link_to_autodeploy_doc}":
-  plural_id:
-  translations:
-    - "分支 <strong>%{branch_name}</strong> 已創建。如需設置自動部署， 請選擇合適的 GitLab CI Yaml 模板併提交更改。%{link_to_autodeploy_doc}"
-    - "O branch <strong>%{branch_name}</strong> foi criado. Para configurar o deploy automático, selecione um modelo de Yaml do GitLab CI e commit suas mudanças. %{link_to_autodeploy_doc}"
-    - "<strong>%{branch_name}</strong> ブランチが作成されました。自動デプロイを設定するには、GitLab CI Yaml テンプレートを選択して、変更をコミットしてください。 %{link_to_autodeploy_doc}"
-    - "La branch <strong>%{branch_name}</strong> è stata creata. Per impostare un rilascio automatico scegli un template CI di Gitlab e committa le tue modifiche %{link_to_autodeploy_doc}"
-    - "O ramo <strong>%{branch_name}</strong> foi criado. Para configurar a implantação automática, seleciona um modelo de Yaml do GitLab CI e envia as tuas alterações. %{link_to_autodeploy_doc}"
-    - "Ветка <strong>%{branch_name}</strong> создана. Для настройки автоматического развертывания выберите YAML-шаблон для GitLab CI и зафиксируйте свои изменения. %{link_to_autodeploy_doc}"
-    - "已创建分支 <strong>%{branch_name}</strong> 。如需设置自动部署， 请选择合适的 GitLab CI Yaml 模板并提交更改。%{link_to_autodeploy_doc}"
-    - "Гілка <strong>%{branch_name}</strong> створена. Для настройки автоматичного розгортання виберіть GitLab CI Yaml-шаблон і закомітьте зміни. %{link_to_autodeploy_doc}"
-    - "Клонът <strong>%{branch_name}</strong> беше създаден. За да настроите автоматичното внедряване, изберете Yaml шаблон за GitLab CI и подайте промените си. %{link_to_autodeploy_doc}"
-    - "Branch <strong>%{branch_name}</strong> wurde erstellt. Um die automatische Bereitstellung einzurichten, wähle eine GitLab CI Yaml Vorlage und committe deine Änderungen. %{link_to_autodeploy_doc}"
-    - "<strong>%{branch_name}</strong> 브랜치가 생성되었습니다. 자동 배포를 설정하려면 GitLab CI Yaml 템플릿을 선택하고 변경 사항을 적용하십시오. %{link_to_autodeploy_doc}"
-    - "La branĉo <strong>%{branch_name}</strong> estis kreita. Por agordi aŭtomatan disponigadon, bonvolu elekti Yaml-ŝablonon por GitLab CI kaj enmeti viajn ŝanĝojn. %{link_to_autodeploy_doc}"
-    - "La branche <strong>%{branch_name}</strong> a été créée. Pour mettre en place le déploiement automatisé, sélectionnez un modèle de fichier YAML pour l’intégration continue (CI) de GitLab, et validez les modifications. %{link_to_autodeploy_doc}"
-    - "La rama <strong>%{branch_name}</strong> fue creada. Para configurar el auto despliegue, escoge una plantilla Yaml para GitLab CI y envía tus cambios. %{link_to_autodeploy_doc}"

lib/gitlab/i18n/po_linter.rb

@@ -5,14 +5,13 @@ module Gitlab
     class PoLinter
       include Gitlab::Utils::StrongMemoize
 
-      attr_reader :po_path, :translation_entries, :metadata_entry, :locale, :html_todolist
+      attr_reader :po_path, :translation_entries, :metadata_entry, :locale
 
       VARIABLE_REGEX = /%{\w*}|%[a-z]/.freeze
 
-      def initialize(po_path:, html_todolist:, locale: I18n.locale.to_s)
+      def initialize(po_path:, locale: I18n.locale.to_s)
         @po_path = po_path
         @locale = locale
-        @html_todolist = html_todolist
       end
 
       def errors
@@ -43,8 +42,7 @@ module Gitlab
         @translation_entries = entries.map do |entry_data|
           Gitlab::I18n::TranslationEntry.new(
             entry_data: entry_data,
-            nplurals: metadata_entry.expected_forms,
-            html_allowed: html_todolist.fetch(entry_data[:msgid], false)
+            nplurals: metadata_entry.expected_forms
           )
         end
 
@@ -97,15 +95,15 @@ module Gitlab
         common_message = 'contains < or >. Use variables to include HTML in the string, or the &lt; and &gt; codes ' \
           'for the symbols. For more info see: https://docs.gitlab.com/ee/development/i18n/externalization.html#html'
 
-        if entry.msgid_contains_potential_html? && !entry.msgid_html_allowed?
+        if entry.msgid_contains_potential_html?
           errors << common_message
         end
 
-        if entry.plural_id_contains_potential_html? && !entry.plural_id_html_allowed?
+        if entry.plural_id_contains_potential_html?
           errors << 'plural id ' + common_message
         end
 
-        if entry.translations_contain_potential_html? && !entry.translations_html_allowed?
+        if entry.translations_contain_potential_html?
           errors << 'translation ' + common_message
         end
       end

lib/gitlab/i18n/translation_entry.rb

@@ -6,12 +6,11 @@ module Gitlab
       PERCENT_REGEX = /(?:^|[^%])%(?!{\w*}|[a-z%])/.freeze
       ANGLE_BRACKET_REGEX = /[<>]/.freeze
 
-      attr_reader :nplurals, :entry_data, :html_allowed
+      attr_reader :nplurals, :entry_data
 
-      def initialize(entry_data:, nplurals:, html_allowed:)
+      def initialize(entry_data:, nplurals:)
         @entry_data = entry_data
         @nplurals = nplurals
-        @html_allowed = html_allowed
       end
 
       def msgid
@@ -97,20 +96,6 @@ module Gitlab
         all_translations.any? { |translation| contains_angle_brackets?(translation) }
       end
 
-      def msgid_html_allowed?
-        html_allowed.present?
-      end
-
-      def plural_id_html_allowed?
-        html_allowed.present? && html_allowed['plural_id'] == plural_id
-      end
-
-      def translations_html_allowed?
-        msgid_html_allowed? && html_allowed['translations'].present? && all_translations.all? do |translation|
-          html_allowed['translations'].include?(translation)
-        end
-      end
-
       private
 
       def contains_angle_brackets?(string)

lib/tasks/gettext.rake

@@ -65,10 +65,10 @@ namespace :gettext do
     linters = files.map do |file|
       locale = File.basename(File.dirname(file))
 
-      Gitlab::I18n::PoLinter.new(po_path: file, html_todolist: html_todolist, locale: locale)
+      Gitlab::I18n::PoLinter.new(po_path: file, locale: locale)
     end
 
-    linters.unshift(Gitlab::I18n::PoLinter.new(po_path: pot_file_path, html_todolist: html_todolist))
+    linters.unshift(Gitlab::I18n::PoLinter.new(po_path: pot_file_path))
 
     failed_linters = linters.select { |linter| linter.errors.any? }
 

spec/lib/gitlab/i18n/po_linter_spec.rb

@@ -6,7 +6,7 @@ require 'simple_po_parser'
 # Disabling this cop to allow for multi-language examples in comments
 # rubocop:disable Style/AsciiComments
 RSpec.describe Gitlab::I18n::PoLinter do
-  let(:linter) { described_class.new(po_path: po_path, html_todolist: {}) }
+  let(:linter) { described_class.new(po_path: po_path) }
   let(:po_path) { 'spec/fixtures/valid.po' }
 
   def fake_translation(msgid:, translation:, plural_id: nil, plurals: [])
@@ -24,8 +24,7 @@ RSpec.describe Gitlab::I18n::PoLinter do
 
     Gitlab::I18n::TranslationEntry.new(
       entry_data: data,
-      nplurals: plurals.size + 1,
-      html_allowed: nil
+      nplurals: plurals.size + 1
     )
   end
 
@@ -160,53 +159,6 @@ RSpec.describe Gitlab::I18n::PoLinter do
         ]
       end
     end
-
-    context 'when an entry contains html on the todolist' do
-      subject(:linter) { described_class.new(po_path: po_path, html_todolist: todolist) }
-
-      let(:po_path) { 'spec/fixtures/potential_html.po' }
-      let(:todolist) do
-        {
-          'String with a legitimate < use' => {
-            'plural_id' => 'String with lots of < > uses',
-            'translations' => [
-              'Translated string with a legitimate < use',
-              'Translated string with lots of < > uses'
-            ]
-          }
-        }
-      end
-
-      it 'does not present an error' do
-        message_id = 'String with a legitimate < use'
-
-        expect(errors[message_id]).to be_nil
-      end
-    end
-
-    context 'when an entry on the html todolist has changed' do
-      subject(:linter) { described_class.new(po_path: po_path, html_todolist: todolist) }
-
-      let(:po_path) { 'spec/fixtures/potential_html.po' }
-      let(:todolist) do
-        {
-          'String with a legitimate < use' => {
-            'plural_id' => 'String with lots of < > uses',
-            'translations' => [
-              'Translated string with a different legitimate < use',
-              'Translated string with lots of < > uses'
-            ]
-          }
-        }
-      end
-
-      it 'presents an error for the changed component' do
-        message_id = 'String with a legitimate < use'
-
-        expect(errors[message_id])
-          .to include a_string_starting_with('translation contains < or >.')
-      end
-    end
   end
 
   describe '#parse_po' do
@@ -276,8 +228,7 @@ RSpec.describe Gitlab::I18n::PoLinter do
 
       fake_entry = Gitlab::I18n::TranslationEntry.new(
         entry_data: { msgid: 'the singular', msgid_plural: 'the plural', 'msgstr[0]' => 'the singular' },
-        nplurals: 2,
-        html_allowed: nil
+        nplurals: 2
       )
       errors = []