Add prune command (#695)

Co-authored-by: Gleb Mazovetskiy <glex.spb@gmail.com>

Author: bart-westenenk-bex

config/locales/en.yml

@@ -51,6 +51,7 @@ en:
         missing: show missing translations, optionally match a pattern
         mv: rename/merge the keys in locale data that match the given pattern
         normalize: 'normalize translation data: sort and move to the right files'
+        prune: removes keys from non-base locales that are not present in base locale
         remove_unused: remove unused keys
         rm: remove the keys in locale data that match the given pattern
         translate_missing: translate missing keys with Google Translate or DeepL Pro, optionally match
@@ -121,6 +122,15 @@ en:
           Set OpenAI API key via OPENAI_API_KEY environment variable or translation.openai_api_key
           in config/i18n-tasks.yml. Get the key at https://openai.com/.
         no_results: OpenAI returned no results.
+    prune:
+      count:
+        one: "%{count} key to prune in %{locales}."
+        other: "%{count} keys to prune in %{locales}."
+        zero: No keys to prune.
+      pruned:
+        one: "%{count} key pruned from %{locales}."
+        other: "%{count} keys pruned from %{locales}."
+      title: Pruning keys in %{locales} that are not present in %{base_locale}
     remove_unused:
       confirm:
         one: "%{count} translation will be removed from %{locales}."

config/locales/ru.yml

@@ -50,6 +50,7 @@ ru:
         missing: показать недостающие переводы
         mv: переименовать / объединить ключи, которые соответствуют заданному шаблону
         normalize: нормализовать файлы переводов (сортировка и распределение)
+        prune: удаляет ключи из небазовых локалей, которые отсутствуют в базовой локали
         remove_unused: удалить неиспользуемые ключи
         rm: удалить ключи, которые соответствуют заданному шаблону
         translate_missing: перевести недостающие переводы с Google Translate / DeepL Pro
@@ -121,6 +122,19 @@ ru:
           Установить ключ API Яндекса с помощью переменной среды OPENAI_API_KEY или translation.openai_api_key
            в config / i18n-tasks.yml. Получите ключ по адресу https://openai.com/.
         no_results: Яндекс не дал результатов.
+    prune:
+      count:
+        few: "%{count} ключа для удаления в %{locales}."
+        many: "%{count} ключей для удаления в %{locales}."
+        one: "%{count} ключ удаления в %{locales}."
+        other: "%{count} ключей для удаления в %{locales}."
+        zero: Нет ключей для удаления.
+      pruned:
+        few: "%{count} ключа удалено из %{locales}."
+        many: "%{count} ключeй удалены из %{locales}."
+        one: "%{count} ключ удалён из %{locales}."
+        other: "%{count} ключeй удалены из %{locales}."
+      title: Обрезка ключей в %{locales}, которые не присутствуют в %{base_locale}
     remove_unused:
       confirm:
         few: Переводы (%{count}) будут удалены из %{locales}.

lib/i18n/tasks/base_task.rb

@@ -19,6 +19,7 @@
 require "i18n/tasks/data"
 require "i18n/tasks/configuration"
 require "i18n/tasks/stats"
+require "i18n/tasks/prune"
 
 module I18n
   module Tasks
@@ -38,6 +39,7 @@ class BaseTask
       include Configuration
       include Data
       include Stats
+      include Prune
 
       def initialize(config_file: nil, **config)
         @config_override = config_file

lib/i18n/tasks/command/commands/prune.rb

@@ -0,0 +1,51 @@
+module I18n::Tasks
+  module Command
+    module Commands
+      module Prune
+        include ::I18n::Tasks::Command::Collection
+
+        cmd :prune, desc: t("i18n_tasks.cmd.desc.prune"), args: %i[confirm]
+        def prune(opts = {})
+          diff_forest = i18n.prunable_keys(
+            base_locale: i18n.base_locale,
+            locales: i18n.locales - [base_locale]
+          )
+
+          print_info t("i18n_tasks.prune.title", locales: locales.join(", "), base_locale: base_locale)
+
+          if diff_forest.empty?
+            print_success(t("i18n_tasks.prune.count", count: 0))
+            return
+          end
+
+          count = diff_forest.root_key_values.size
+
+          terminal_report.show_tree(diff_forest)
+          print_error(t("i18n_tasks.prune.count", count:, locales: locales.join(", ")))
+
+          # The user should confirm before we proceed with the deletion unless the force option is set
+          unless opts[:confirm] || agree(t("i18n_tasks.common.continue_q"))
+            return
+          end
+          print_success(t("i18n_tasks.prune.pruned", count:, locales: locales.join(", ")))
+
+          i18n.data.remove_by_key!(diff_forest)
+        end
+
+        private
+
+        def print_success(message)
+          log_stderr(Rainbow("✓ #{message}").green.bright)
+        end
+
+        def print_error(message)
+          log_stderr(Rainbow(message).red.bright)
+        end
+
+        def print_info(message)
+          log_stderr(message)
+        end
+      end
+    end
+  end
+end

lib/i18n/tasks/commands.rb

@@ -11,6 +11,7 @@
 require "i18n/tasks/command/commands/tree"
 require "i18n/tasks/command/commands/meta"
 require "i18n/tasks/command/commands/check_prism"
+require "i18n/tasks/command/commands/prune"
 require "i18n/tasks/command/commander"
 
 module I18n::Tasks
@@ -25,6 +26,7 @@ class Commands < Command::Commander
     include Command::Commands::Tree
     include Command::Commands::Meta
     include Command::Commands::CheckPrism
+    include Command::Commands::Prune
 
     require "highline/import"
   end

lib/i18n/tasks/prune.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module I18n::Tasks::Prune
+  def prunable_keys(base_locale:, locales:)
+    diff_forest = empty_forest
+    locales.each do |locale|
+      # Based on the docs, missing_diff_tree only returns keys that are in the second argument but not in the first
+      locale_forest =
+        missing_diff_tree(base_locale, locale).tap do |locale_forest|
+          locale_forest.mv_key!(compile_key_pattern(base_locale), locale, root: true)
+        end
+
+      diff_forest.merge!(locale_forest)
+    end
+
+    diff_forest
+  end
+end

spec/commands/prune_commands_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "Prune commands" do
+  delegate :run_cmd, to: :TestCodebase
+
+  let(:locale_data) do
+    {
+      "en" => {
+        "hello" => "Hello",
+        "en_only" => "This key exists only in English"
+      },
+      "fr" => {
+        "hello" => "Bonjour",
+        "fr_de" => "This key exists only in French and german"
+      },
+      "de" => {
+        "hello" => "Hallo",
+        "fr_de" => "This key exists only in French and german"
+      },
+      "es" => {
+        "hello" => "Hello"
+      }
+    }
+  end
+
+  let(:config) { {base_locale: "en", locales: %w[en de fr es]} }
+
+  around do |ex|
+    TestCodebase.setup(
+      "config/i18n-tasks.yml" => config.to_yaml,
+      "config/locales/en.yml" => {"en" => locale_data["en"]}.to_yaml,
+      "config/locales/de.yml" => {"de" => locale_data["de"]}.to_yaml,
+      "config/locales/fr.yml" => {"fr" => locale_data["fr"]}.to_yaml,
+      "config/locales/es.yml" => {"es" => locale_data["es"]}.to_yaml
+    )
+    TestCodebase.in_test_app_dir { ex.call }
+    TestCodebase.teardown
+  end
+
+  it "#prune" do
+    run_cmd("prune", "--confirm")
+
+    locale_data["fr"].delete("fr_de")
+    locale_data["de"].delete("fr_de")
+
+    expect(YAML.load_file("config/locales/en.yml")).to eq("en" => locale_data["en"])
+    expect(YAML.load_file("config/locales/fr.yml")).to eq("fr" => locale_data["fr"])
+    expect(YAML.load_file("config/locales/de.yml")).to eq("de" => locale_data["de"])
+    expect(YAML.load_file("config/locales/es.yml")).to eq("es" => locale_data["es"])
+  end
+end