i18n-tasks 0.9.22 → 0.9.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84b3720d5321c4996a0cebe6b17a734445434d5aa549ebcc6771c09e1856bf6b
-  data.tar.gz: d966fc1e803e5cf34fe1dc61ddd37a10f56f5457b2749142511a38fb377e38ba
+  metadata.gz: 8b90d77c0efd6c17b2b659fd19de47f5e6f2a8352f5d0eede4fa0525d481f2ac
+  data.tar.gz: 15f983188ee4dc5124823f318d947842d89f3df78890452d62092abdb0ea4836
 SHA512:
-  metadata.gz: 2f90d7edb7ca9f661d0d5f8d36f25a19c14d58fdac1a540389f1b3e19c01e12835df8d1478619b8a45bddb42fd4852c91ea59b4a92c0f66ed696432202b331a9
-  data.tar.gz: 1407da83477f63875c56708aef038ac96d005897e5457b990bcc195d8738dbe1a857490939c2e7530cdb41380374c5291a3b55892cd80442af6ad3eda695a197
+  metadata.gz: c5c4c4f9210a7e25dec136bac40fda0575afff686aeb58614f2b2f4bafdd8b9e2f18bd4bf4b9b99b94409a6a34340ee0be009d6fad85361b691e8f6ff5d1266a
+  data.tar.gz: bb6d10a390f885e884861caf5c669c29239566e613554a17fd263cd8e89d3bdeb64fc554e7cd61d6ced403568a736dfa15bce159206cd65e0af84d19a5078fc2

data/README.md

@@ -22,7 +22,7 @@ i18n-tasks can be used with any project using the ruby [i18n gem][i18n-gem] (def
 Add i18n-tasks to the Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.9.22'
+gem 'i18n-tasks', '~> 0.9.23'
 ```
 
 Copy the default [configuration file](#configuration):

data/lib/i18n/tasks/base_task.rb

@@ -11,8 +11,7 @@ require 'i18n/tasks/used_keys'
 require 'i18n/tasks/ignore_keys'
 require 'i18n/tasks/missing_keys'
 require 'i18n/tasks/unused_keys'
-require 'i18n/tasks/deepl_translation'
-require 'i18n/tasks/google_translation'
+require 'i18n/tasks/translation'
 require 'i18n/tasks/locale_pathname'
 require 'i18n/tasks/locale_list'
 require 'i18n/tasks/string_interpolation'
@@ -32,8 +31,7 @@ module I18n
       include IgnoreKeys
       include MissingKeys
       include UnusedKeys
-      include DeeplTranslation
-      include GoogleTranslation
+      include Translation
       include Logging
       include Configuration
       include Data

data/lib/i18n/tasks/translation.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'i18n/tasks/translators/deepl_translator.rb'
+require 'i18n/tasks/translators/google_translator.rb'
+
+module I18n::Tasks
+  module Translation
+    # @param [I18n::Tasks::Tree::Siblings] forest to translate to the locales of its root nodes
+    # @param [String] from locale
+    # @return [I18n::Tasks::Tree::Siblings] translated forest
+    def deepl_translate_forest(forest, from)
+      Translators::DeeplTranslator.new(self).translate_forest(forest, from)
+    end
+
+    # @param [I18n::Tasks::Tree::Siblings] forest to translate to the locales of its root nodes
+    # @param [String] from locale
+    # @return [I18n::Tasks::Tree::Siblings] translated forest
+    def google_translate_forest(forest, from)
+      Translators::GoogleTranslator.new(self).translate_forest(forest, from)
+    end
+  end
+end

data/lib/i18n/tasks/translators/base_translator.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module I18n::Tasks
+  module Translators
+    class BaseTranslator
+      # @param [I18n::Tasks::BaseTask] i18n_tasks
+      def initialize(i18n_tasks)
+        @i18n_tasks = i18n_tasks
+      end
+
+      # @param [I18n::Tasks::Tree::Siblings] forest to translate to the locales of its root nodes
+      # @param [String] from locale
+      # @return [I18n::Tasks::Tree::Siblings] translated forest
+      def translate_forest(forest, from)
+        forest.inject @i18n_tasks.empty_forest do |result, root|
+          translated = translate_pairs(root.key_values(root: true), to: root.key, from: from)
+          result.merge! Data::Tree::Siblings.from_flat_pairs(translated)
+        end
+      end
+
+      protected
+
+      # @param [Array<[String, Object]>] list of key-value pairs
+      # @return [Array<[String, Object]>] translated list
+      def translate_pairs(list, opts)
+        return [] if list.empty?
+        opts = opts.dup
+        key_pos = list.each_with_index.inject({}) { |idx, ((k, _v), i)| idx.update(k => i) }
+        # copy reference keys as is, instead of translating
+        reference_key_vals = list.select { |_k, v| v.is_a? Symbol } || []
+        list -= reference_key_vals
+        result = list.group_by { |k_v| @i18n_tasks.html_key? k_v[0], opts[:from] }.map do |is_html, list_slice|
+          fetch_translations list_slice, opts.merge(is_html ? options_for_html : options_for_plain)
+        end.reduce(:+) || []
+        result.concat(reference_key_vals)
+        result.sort! { |a, b| key_pos[a[0]] <=> key_pos[b[0]] }
+        result
+      end
+
+      # @param [Array<[String, Object]>] list of key-value pairs
+      # @return [Array<[String, Object]>] translated list
+      def fetch_translations(list, opts)
+        from_values(list, translate_values(to_values(list), **options_for_translate_values(**opts))).tap do |result|
+          fail CommandError, no_results_error_message if result.blank?
+        end
+      end
+
+      # @param [Array<[String, Object]>] list of key-value pairs
+      # @return [Array<String>] values for translation extracted from list
+      def to_values(list)
+        list.map { |l| dump_value l[1] }.flatten.compact
+      end
+
+      # @param [Array<[String, Object]>] list
+      # @param [Array<String>] translated_values
+      # @return [Array<[String, Object]>] translated key-value pairs
+      def from_values(list, translated_values)
+        keys = list.map(&:first)
+        untranslated_values = list.map(&:last)
+        keys.zip parse_value(untranslated_values, translated_values.to_enum)
+      end
+
+      # Prepare value for translation.
+      # @return [String, Array<String, nil>, nil] value for Google Translate or nil for non-string values
+      def dump_value(value)
+        case value
+        when Array
+          # dump recursively
+          value.map { |v| dump_value v }
+        when String
+          replace_interpolations value
+        end
+      end
+
+      # Parse translated value from the each_translated enumerator
+      # @param [Object] untranslated
+      # @param [Enumerator] each_translated
+      # @return [Object] final translated value
+      def parse_value(untranslated, each_translated)
+        case untranslated
+        when Array
+          # implode array
+          untranslated.map { |from| parse_value(from, each_translated) }
+        when String
+          restore_interpolations untranslated, each_translated.next
+        else
+          untranslated
+        end
+      end
+
+      INTERPOLATION_KEY_RE = /%\{[^}]+}/
+      UNTRANSLATABLE_STRING = 'zxzxzx'
+
+      # @param [String] value
+      # @return [String] 'hello, %{name}' => 'hello, <round-trippable string>'
+      def replace_interpolations(value)
+        i = -1
+        value.gsub INTERPOLATION_KEY_RE do
+          i += 1
+          "#{UNTRANSLATABLE_STRING}#{i}"
+        end
+      end
+
+      # @param [String] untranslated
+      # @param [String] translated
+      # @return [String] 'hello, <round-trippable string>' => 'hello, %{name}'
+      def restore_interpolations(untranslated, translated)
+        return translated if untranslated !~ INTERPOLATION_KEY_RE
+        values = untranslated.scan(INTERPOLATION_KEY_RE)
+        translated.gsub(/#{Regexp.escape(UNTRANSLATABLE_STRING)}\d+/i) do |m|
+          values[m[UNTRANSLATABLE_STRING.length..-1].to_i]
+        end
+      rescue StandardError => e
+        raise_interpolation_error(untranslated, translated, e)
+      end
+
+      def raise_interpolation_error(untranslated, translated, e)
+        fail CommandError.new(e, <<-TEXT.strip)
+Error when restoring interpolations:
+  original: "#{untranslated}"
+  response: "#{translated}"
+  error: #{e.message} (#{e.class.name})
+        TEXT
+      end
+
+      # @param [Array<String>] list
+      # @param [Hash] options
+      # @return [Array<String>]
+      # @abstract
+      def translate_values(list, **options); end
+
+      # @param [Hash] options
+      # @return [Hash]
+      # @abstract
+      def options_for_translate_values(options); end
+
+      # @return [Hash]
+      # @abstract
+      def options_for_html; end
+
+      # @return [Hash]
+      # @abstract
+      def options_for_plain; end
+
+      # @return [String]
+      # @abstract
+      def no_results_error_message; end
+    end
+  end
+end

data/lib/i18n/tasks/{deepl_translation.rb → translators/deepl_translator.rb}

@@ -1,27 +1,19 @@
 # frozen_string_literal: true
 
 require 'deepl'
-require 'i18n/tasks/html_keys'
-require 'i18n/tasks/base_translator'
-
-module I18n::Tasks
-  module DeeplTranslation
-    # @param [I18n::Tasks::Tree::Siblings] forest to translate to the locales of its root nodes
-    # @param [String] from locale
-    # @return [I18n::Tasks::Tree::Siblings] translated forest
-    def deepl_translate_forest(forest, from)
-      DeeplTranslator.new(self).translate_forest(forest, from)
-    end
-  end
+require 'i18n/tasks/translators/base_translator'
 
+module I18n::Tasks::Translators
   class DeeplTranslator < BaseTranslator
     def initialize(*)
       super
       configure_api_key!
     end
 
+    protected
+
     def translate_values(list, from:, to:, **options)
-      DeepL.translate(list, from, to, options).map(&:text)
+      DeepL.translate(list, to_deepl_compatible_locale(from), to_deepl_compatible_locale(to), options).map(&:text)
     end
 
     def options_for_translate_values(**options)
@@ -58,6 +50,11 @@ module I18n::Tasks
 
     private
 
+    # Convert 'es-ES' to 'ES'
+    def to_deepl_compatible_locale(locale)
+      locale.to_s.split('-', 2).first.upcase
+    end
+
     def configure_api_key!
       api_key = @i18n_tasks.translation_config[:deepl_api_key]
       fail CommandError, I18n.t('i18n_tasks.deepl_translate.errors.no_api_key') if api_key.blank?

data/lib/i18n/tasks/{google_translation.rb → translators/google_translator.rb}

@@ -1,21 +1,11 @@
 # frozen_string_literal: true
 
 require 'easy_translate'
-require 'i18n/tasks/html_keys'
-require 'i18n/tasks/base_translator'
-
-module I18n::Tasks
-  module GoogleTranslation
-    # @param [I18n::Tasks::Tree::Siblings] forest to translate to the locales of its root nodes
-    # @param [String] from locale
-    # @return [I18n::Tasks::Tree::Siblings] translated forest
-    def google_translate_forest(forest, from)
-      GoogleTranslator.new(self).translate_forest(forest, from)
-    end
-  end
+require 'i18n/tasks/translators/base_translator'
 
+module I18n::Tasks::Translators
   class GoogleTranslator < BaseTranslator
-    SUPPORTED_LOCALES_WITH_REGION = %w[zh-CN zh-TW].freeze
+    protected
 
     def translate_values(list, **options)
       EasyTranslate.translate(list, options)
@@ -43,6 +33,8 @@ module I18n::Tasks
 
     private
 
+    SUPPORTED_LOCALES_WITH_REGION = %w[zh-CN zh-TW].freeze
+
     # Convert 'es-ES' to 'es'
     def to_google_translate_compatible_locale(locale)
       return locale unless locale.include?('-') && !SUPPORTED_LOCALES_WITH_REGION.include?(locale)

data/lib/i18n/tasks/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module Tasks
-    VERSION = '0.9.22'
+    VERSION = '0.9.23'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.9.22
+  version: 0.9.23
 platform: ruby
 authors:
 - glebm
@@ -276,7 +276,6 @@ files:
 - i18n-tasks.gemspec
 - lib/i18n/tasks.rb
 - lib/i18n/tasks/base_task.rb
-- lib/i18n/tasks/base_translator.rb
 - lib/i18n/tasks/cli.rb
 - lib/i18n/tasks/command/collection.rb
 - lib/i18n/tasks/command/commander.rb
@@ -310,8 +309,6 @@ files:
 - lib/i18n/tasks/data/tree/nodes.rb
 - lib/i18n/tasks/data/tree/siblings.rb
 - lib/i18n/tasks/data/tree/traversal.rb
-- lib/i18n/tasks/deepl_translation.rb
-- lib/i18n/tasks/google_translation.rb
 - lib/i18n/tasks/html_keys.rb
 - lib/i18n/tasks/ignore_keys.rb
 - lib/i18n/tasks/key_pattern_matching.rb
@@ -346,6 +343,10 @@ files:
 - lib/i18n/tasks/split_key.rb
 - lib/i18n/tasks/stats.rb
 - lib/i18n/tasks/string_interpolation.rb
+- lib/i18n/tasks/translation.rb
+- lib/i18n/tasks/translators/base_translator.rb
+- lib/i18n/tasks/translators/deepl_translator.rb
+- lib/i18n/tasks/translators/google_translator.rb
 - lib/i18n/tasks/unused_keys.rb
 - lib/i18n/tasks/used_keys.rb
 - lib/i18n/tasks/version.rb

data/lib/i18n/tasks/base_translator.rb

@@ -1,148 +0,0 @@
-# frozen_string_literal: true
-
-module I18n::Tasks
-  class BaseTranslator
-    # @param [I18n::Tasks::BaseTask] i18n_tasks
-    def initialize(i18n_tasks)
-      @i18n_tasks = i18n_tasks
-    end
-
-    # @param [I18n::Tasks::Tree::Siblings] forest to translate to the locales of its root nodes
-    # @param [String] from locale
-    # @return [I18n::Tasks::Tree::Siblings] translated forest
-    def translate_forest(forest, from)
-      forest.inject @i18n_tasks.empty_forest do |result, root|
-        translated = translate_pairs(root.key_values(root: true), to: root.key, from: from)
-        result.merge! Data::Tree::Siblings.from_flat_pairs(translated)
-      end
-    end
-
-    protected
-
-    # @param [Array<[String, Object]>] list of key-value pairs
-    # @return [Array<[String, Object]>] translated list
-    def translate_pairs(list, opts)
-      return [] if list.empty?
-      opts = opts.dup
-      key_pos = list.each_with_index.inject({}) { |idx, ((k, _v), i)| idx.update(k => i) }
-      # copy reference keys as is, instead of translating
-      reference_key_vals = list.select { |_k, v| v.is_a? Symbol } || []
-      list -= reference_key_vals
-      result = list.group_by { |k_v| @i18n_tasks.html_key? k_v[0], opts[:from] }.map do |is_html, list_slice|
-        fetch_translations list_slice, opts.merge(is_html ? options_for_html : options_for_plain)
-      end.reduce(:+) || []
-      result.concat(reference_key_vals)
-      result.sort! { |a, b| key_pos[a[0]] <=> key_pos[b[0]] }
-      result
-    end
-
-    # @param [Array<[String, Object]>] list of key-value pairs
-    # @return [Array<[String, Object]>] translated list
-    def fetch_translations(list, opts)
-      from_values(list, translate_values(to_values(list), **options_for_translate_values(**opts))).tap do |result|
-        fail CommandError, no_results_error_message if result.blank?
-      end
-    end
-
-    # @param [Array<[String, Object]>] list of key-value pairs
-    # @return [Array<String>] values for translation extracted from list
-    def to_values(list)
-      list.map { |l| dump_value l[1] }.flatten.compact
-    end
-
-    # @param [Array<[String, Object]>] list
-    # @param [Array<String>] translated_values
-    # @return [Array<[String, Object]>] translated key-value pairs
-    def from_values(list, translated_values)
-      keys                = list.map(&:first)
-      untranslated_values = list.map(&:last)
-      keys.zip parse_value(untranslated_values, translated_values.to_enum)
-    end
-
-    # Prepare value for translation.
-    # @return [String, Array<String, nil>, nil] value for Google Translate or nil for non-string values
-    def dump_value(value)
-      case value
-      when Array
-        # dump recursively
-        value.map { |v| dump_value v }
-      when String
-        replace_interpolations value
-      end
-    end
-
-    # Parse translated value from the each_translated enumerator
-    # @param [Object] untranslated
-    # @param [Enumerator] each_translated
-    # @return [Object] final translated value
-    def parse_value(untranslated, each_translated)
-      case untranslated
-      when Array
-        # implode array
-        untranslated.map { |from| parse_value(from, each_translated) }
-      when String
-        restore_interpolations untranslated, each_translated.next
-      else
-        untranslated
-      end
-    end
-
-    INTERPOLATION_KEY_RE  = /%\{[^}]+}/
-    UNTRANSLATABLE_STRING = 'zxzxzx'
-
-    # @param [String] value
-    # @return [String] 'hello, %{name}' => 'hello, <round-trippable string>'
-    def replace_interpolations(value)
-      i = -1
-      value.gsub INTERPOLATION_KEY_RE do
-        i += 1
-        "#{UNTRANSLATABLE_STRING}#{i}"
-      end
-    end
-
-    # @param [String] untranslated
-    # @param [String] translated
-    # @return [String] 'hello, <round-trippable string>' => 'hello, %{name}'
-    def restore_interpolations(untranslated, translated)
-      return translated if untranslated !~ INTERPOLATION_KEY_RE
-      values = untranslated.scan(INTERPOLATION_KEY_RE)
-      translated.gsub(/#{Regexp.escape(UNTRANSLATABLE_STRING)}\d+/i) do |m|
-        values[m[UNTRANSLATABLE_STRING.length..-1].to_i]
-      end
-    rescue StandardError => e
-      raise_interpolation_error(untranslated, translated, e)
-    end
-
-    def raise_interpolation_error(untranslated, translated, e)
-      fail CommandError.new(e, <<-TEXT.strip)
-Error when restoring interpolations:
-  original: "#{untranslated}"
-  response: "#{translated}"
-  error: #{e.message} (#{e.class.name})
-      TEXT
-    end
-
-    # @param [Array<String>] list
-    # @param [Hash] options
-    # @return [Array<String>]
-    # @abstract
-    def translate_values(list, **options); end
-
-    # @param [Hash] options
-    # @return [Hash]
-    # @abstract
-    def options_for_translate_values(options); end
-
-    # @return [Hash]
-    # @abstract
-    def options_for_html; end
-
-    # @return [Hash]
-    # @abstract
-    def options_for_plain; end
-
-    # @return [String]
-    # @abstract
-    def no_results_error_message; end
-  end
-end