i18n-tasks 0.9.29 → 0.9.34

data/lib/i18n/tasks/scanners/relative_keys.rb

@@ -12,6 +12,7 @@ module I18n
         def absolute_key(key, path, roots: config[:relative_roots], calling_method: nil)
           return key unless key.start_with?(DOT)
           fail 'roots argument is required' unless roots.present?
+
           normalized_path = File.expand_path(path)
           (root = path_root(normalized_path, roots)) ||
             fail(CommandError, "Cannot resolve relative key \"#{key}\".\n" \

data/lib/i18n/tasks/scanners/ruby_ast_scanner.rb

@@ -5,7 +5,7 @@ require 'i18n/tasks/scanners/relative_keys'
 require 'i18n/tasks/scanners/ruby_ast_call_finder'
 require 'parser/current'
 
-# rubocop:disable Metrics/AbcSize,Metrics/BlockNesting,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+# rubocop:disable Metrics/AbcSize,Metrics/BlockNesting,Metrics/PerceivedComplexity
 # TODO: make this class more readable.
 
 module I18n::Tasks::Scanners
@@ -14,11 +14,11 @@ module I18n::Tasks::Scanners
     include RelativeKeys
     include AST::Sexp
 
-    MAGIC_COMMENT_PREFIX = /\A.\s*i18n-tasks-use\s+/
-    RECEIVER_MESSAGES = [nil, AST::Node.new(:const, [nil, :I18n])].product(%i[t translate])
+    MAGIC_COMMENT_PREFIX = /\A.\s*i18n-tasks-use\s+/.freeze
+    RECEIVER_MESSAGES = [nil, AST::Node.new(:const, [nil, :I18n])].product(%i[t t! translate translate!])
 
     def initialize(**args)
-      super(args)
+      super(**args)
       @parser = ::Parser::CurrentRuby.new
       @magic_comment_parser = ::Parser::CurrentRuby.new
       @call_finder = RubyAstCallFinder.new(
@@ -71,6 +71,7 @@ module I18n::Tasks::Scanners
             scope = extract_string(scope_node.children[1],
                                    array_join_with: '.', array_flatten: true, array_reject_blank: true)
             return nil if scope.nil? && scope_node.type != :nil
+
             key = [scope, key].join('.') unless scope == ''
           end
           default_arg = if (default_arg_node = extract_hash_pair(second_arg_node, 'default'))
@@ -95,6 +96,7 @@ module I18n::Tasks::Scanners
     def extract_hash_pair(node, key)
       node.children.detect do |child|
         next unless child.type == :pair
+
         key_node = child.children[0]
         %i[sym str].include?(key_node.type) && key_node.children[0].to_s == key
       end
@@ -115,15 +117,15 @@ module I18n::Tasks::Scanners
     def extract_string(node, array_join_with: nil, array_flatten: false, array_reject_blank: false)
       if %i[sym str int].include?(node.type)
         node.children[0].to_s
-      elsif %i[true false].include?(node.type) # rubocop:disable Lint/BooleanSymbol
+      elsif %i[true false].include?(node.type)
         node.type.to_s
       elsif node.type == :nil
         ''
       elsif node.type == :array && array_join_with
         extract_array_as_string(
           node,
-          array_join_with:    array_join_with,
-          array_flatten:      array_flatten,
+          array_join_with: array_join_with,
+          array_flatten: array_flatten,
           array_reject_blank: array_reject_blank
         ).tap do |str|
           # `nil` is returned when a dynamic value is encountered in strict mode. Propagate:
@@ -149,11 +151,12 @@ module I18n::Tasks::Scanners
     # @return [String, nil] `nil` is returned only when a dynamic value is encountered in strict mode.
     def extract_array_as_string(node, array_join_with:, array_flatten: false, array_reject_blank: false)
       children_strings = node.children.map do |child|
-        if %i[sym str int true false].include?(child.type) # rubocop:disable Lint/BooleanSymbol
+        if %i[sym str int true false].include?(child.type)
           extract_string child
         else
           # ignore dynamic argument in strict mode
           return nil if config[:strict]
+
           if %i[dsym dstr].include?(child.type) || (child.type == :array && array_flatten)
             extract_string(child, array_join_with: array_join_with)
           else
@@ -180,12 +183,12 @@ module I18n::Tasks::Scanners
     # @return [Results::Occurrence]
     def range_to_occurrence(raw_key, range, default_arg: nil)
       Results::Occurrence.new(
-        path:        range.source_buffer.name,
-        pos:         range.begin_pos,
-        line_num:    range.line,
-        line_pos:    range.column,
-        line:        range.source_line,
-        raw_key:     raw_key,
+        path: range.source_buffer.name,
+        pos: range.begin_pos,
+        line_num: range.line,
+        line_pos: range.column,
+        line: range.source_line,
+        raw_key: raw_key,
         default_arg: default_arg
       )
     end
@@ -203,4 +206,4 @@ module I18n::Tasks::Scanners
     end
   end
 end
-# rubocop:enable Metrics/AbcSize,Metrics/BlockNesting,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+# rubocop:enable Metrics/AbcSize,Metrics/BlockNesting,Metrics/PerceivedComplexity

data/lib/i18n/tasks/scanners/ruby_key_literals.rb

@@ -2,7 +2,7 @@
 
 module I18n::Tasks::Scanners
   module RubyKeyLiterals
-    LITERAL_RE = /:?".+?"|:?'.+?'|:\w+/
+    LITERAL_RE = /:?".+?"|:?'.+?'|:\w+/.freeze
 
     # Match literals:
     # * String: '', "#{}"
@@ -20,8 +20,8 @@ module I18n::Tasks::Scanners
       literal
     end
 
-    VALID_KEY_CHARS = /(?:[[:word:]]|[-.?!:;À-ž])/
-    VALID_KEY_RE    = /^#{VALID_KEY_CHARS}+$/
+    VALID_KEY_CHARS = /(?:[[:word:]]|[-.?!:;À-ž])/.freeze
+    VALID_KEY_RE    = /^#{VALID_KEY_CHARS}+$/.freeze
 
     def valid_key?(key)
       key =~ VALID_KEY_RE && !key.end_with?('.')

data/lib/i18n/tasks/scanners/scanner_multiplexer.rb

@@ -9,6 +9,7 @@ module I18n::Tasks::Scanners
   class ScannerMultiplexer < Scanner
     # @param scanners [Array<Scanner>]
     def initialize(scanners:)
+      super()
       @scanners = scanners
     end
 
@@ -25,6 +26,7 @@ module I18n::Tasks::Scanners
     # @return [Array<Array<Results::KeyOccurrences>>]
     def collect_results
       return [@scanners[0].keys] if @scanners.length == 1
+
       Array.new(@scanners.length).tap do |results|
         results_mutex = Mutex.new
         @scanners.map.with_index do |scanner, i|

data/lib/i18n/tasks/split_key.rb

@@ -15,6 +15,7 @@ module I18n
         parts = []
         pos   = 0
         return [key] if max == 1
+
         key_parts(key) do |part|
           parts << part
           pos += part.length + 1
@@ -36,6 +37,7 @@ module I18n
       # dots inside braces or parenthesis are not split on
       def key_parts(key, &block)
         return enum_for(:key_parts, key) unless block
+
         nesting = PARENS
         counts  = PARENS_ZEROS # dup'd later if key contains parenthesis
         delim   = '.'

data/lib/i18n/tasks/string_interpolation.rb

@@ -6,6 +6,7 @@ module I18n::Tasks
 
     def interpolate_soft(s, t = {})
       return s unless s
+
       t.each do |k, v|
         pat = "%{#{k}}"
         s = s.gsub pat, v.to_s if s.include?(pat)

data/lib/i18n/tasks/translation.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks/translators/deepl_translator.rb'
-require 'i18n/tasks/translators/google_translator.rb'
+require 'i18n/tasks/translators/deepl_translator'
+require 'i18n/tasks/translators/google_translator'
+require 'i18n/tasks/translators/yandex_translator'
 
 module I18n::Tasks
   module Translation
     # @param [I18n::Tasks::Tree::Siblings] forest to translate to the locales of its root nodes
     # @param [String] from locale
-    # @param [:deepl, :google] backend
+    # @param [:deepl, :google, :yandex] backend
     # @return [I18n::Tasks::Tree::Siblings] translated forest
     def translate_forest(forest, from:, backend: :google)
       case backend
@@ -15,6 +16,8 @@ module I18n::Tasks
         Translators::DeeplTranslator.new(self).translate_forest(forest, from)
       when :google
         Translators::GoogleTranslator.new(self).translate_forest(forest, from)
+      when :yandex
+        Translators::YandexTranslator.new(self).translate_forest(forest, from)
       else
         fail CommandError, "invalid backend: #{backend}"
       end

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

@@ -24,6 +24,7 @@ module I18n::Tasks
       # @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
@@ -92,7 +93,7 @@ module I18n::Tasks
         end
       end
 
-      INTERPOLATION_KEY_RE = /%\{[^}]+}/
+      INTERPOLATION_KEY_RE = /%\{[^}]+}/.freeze
       UNTRANSLATABLE_STRING = 'zxzxzx'
 
       # @param [String] value
@@ -110,6 +111,7 @@ module I18n::Tasks
       # @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]

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

@@ -17,7 +17,12 @@ module I18n::Tasks::Translators
     protected
 
     def translate_values(list, from:, to:, **options)
-      DeepL.translate(list, to_deepl_compatible_locale(from), to_deepl_compatible_locale(to), options).map(&:text)
+      result = DeepL.translate(list, to_deepl_compatible_locale(from), to_deepl_compatible_locale(to), options)
+      if result.is_a?(DeepL::Resources::Text)
+        [result.text]
+      else
+        result.map(&:text)
+      end
     end
 
     def options_for_translate_values(**options)
@@ -43,7 +48,8 @@ module I18n::Tasks::Translators
     # @return [String] 'hello, <i18n>%{name}</i18n>' => 'hello, %{name}'
     def restore_interpolations(untranslated, translated)
       return translated if untranslated !~ INTERPOLATION_KEY_RE
-      translated.gsub(%r{<\/?i18n>}, '')
+
+      translated.gsub(%r{</?i18n>}, '')
     rescue StandardError => e
       raise_interpolation_error(untranslated, translated, e)
     end
@@ -62,6 +68,7 @@ module I18n::Tasks::Translators
     def configure_api_key!
       api_key = @i18n_tasks.translation_config[:deepl_api_key]
       fail ::I18n::Tasks::CommandError, I18n.t('i18n_tasks.deepl_translate.errors.no_api_key') if api_key.blank?
+
       DeepL.configure { |config| config.auth_key = api_key }
     end
   end

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

@@ -46,6 +46,7 @@ module I18n::Tasks::Translators
     # Convert 'es-ES' to 'es'
     def to_google_translate_compatible_locale(locale)
       return locale unless locale.include?('-') && !SUPPORTED_LOCALES_WITH_REGION.include?(locale)
+
       locale.split('-', 2).first
     end
 
@@ -60,6 +61,7 @@ module I18n::Tasks::Translators
           key ||= translation_config[:api_key]
         end
         fail ::I18n::Tasks::CommandError, I18n.t('i18n_tasks.google_translate.errors.no_api_key') if key.blank?
+
         key
       end
     end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'i18n/tasks/translators/base_translator'
+
+module I18n::Tasks::Translators
+  class YandexTranslator < BaseTranslator
+    def initialize(*)
+      begin
+        require 'yandex-translator'
+      rescue LoadError
+        raise ::I18n::Tasks::CommandError, "Add gem 'yandex-translator' to your Gemfile to use this command"
+      end
+      super
+    end
+
+    protected
+
+    def translate_values(list, **options)
+      list.map { |item| translator.translate(item, options) }
+    end
+
+    def options_for_translate_values(from:, to:, **options)
+      options.merge(
+        from: to_yandex_compatible_locale(from),
+        to: to_yandex_compatible_locale(to)
+      )
+    end
+
+    def options_for_html
+      { format: 'html' }
+    end
+
+    def options_for_plain
+      { format: 'plain' }
+    end
+
+    def no_results_error_message
+      I18n.t('i18n_tasks.yandex_translate.errors.no_results')
+    end
+
+    private
+
+    # Convert 'es-ES' to 'es'
+    def to_yandex_compatible_locale(locale)
+      return locale unless locale.include?('-')
+
+      locale.split('-', 2).first
+    end
+
+    def translator
+      @translator ||= Yandex::Translator.new(api_key)
+    end
+
+    def api_key
+      @api_key ||= begin
+        key = @i18n_tasks.translation_config[:yandex_api_key]
+        fail ::I18n::Tasks::CommandError, I18n.t('i18n_tasks.yandex_translate.errors.no_api_key') if key.blank?
+
+        key
+      end
+    end
+  end
+end

data/lib/i18n/tasks/used_keys.rb

@@ -18,14 +18,15 @@ module I18n::Tasks
       paths: %w[app/].freeze,
       relative_roots: %w[app/controllers app/helpers app/mailers app/presenters app/views].freeze,
       scanners: [
-        ['::I18n::Tasks::Scanners::RubyAstScanner', only: %w[*.rb]],
-        ['::I18n::Tasks::Scanners::PatternWithScopeScanner', exclude: %w[*.rb]]
+        ['::I18n::Tasks::Scanners::RubyAstScanner', { only: %w[*.rb] }],
+        ['::I18n::Tasks::Scanners::PatternWithScopeScanner', { exclude: %w[*.rb] }]
       ],
       strict: true
     }.freeze
 
     ALWAYS_EXCLUDE = %w[*.jpg *.png *.gif *.svg *.ico *.eot *.otf *.ttf *.woff *.woff2 *.pdf *.css *.sass *.scss *.less
-                        *.yml *.json *.zip *.tar.gz *.swf *.flv *.mp3 *.wav *.flac *.webm *.mp4 *.ogg *.opus].freeze
+                        *.yml *.json *.zip *.tar.gz *.swf *.flv *.mp3 *.wav *.flac *.webm *.mp4 *.ogg *.opus
+                        *.webp].freeze
 
     # Find all keys in the source and return a forest with the keys in absolute form and their occurrences.
     #
@@ -55,8 +56,8 @@ module I18n::Tasks
         keys          = keys.select { |k| k.key =~ key_filter_re }
       end
       Data::Tree::Node.new(
-        key:      'used',
-        data:     { key_filter: key_filter },
+        key: 'used',
+        data: { key_filter: key_filter },
         children: Data::Tree::Siblings.from_key_occurrences(keys)
       ).to_siblings
     end
@@ -72,10 +73,11 @@ module I18n::Tasks
             if args && args[:strict]
               fail CommandError, 'the strict option is global and cannot be applied on the scanner level'
             end
+
             ActiveSupport::Inflector.constantize(class_name).new(
-              config:               merge_scanner_configs(shared_options, args || {}),
+              config: merge_scanner_configs(shared_options, args || {}),
               file_finder_provider: caching_file_finder_provider,
-              file_reader:          caching_file_reader
+              file_reader: caching_file_reader
             )
           end.tap { |scanners| log_verbose { scanners.map { |s| "  #{s.class.name} #{s.config.inspect}" } * "\n" } }
         )
@@ -123,7 +125,7 @@ module I18n::Tasks
 
     # @return [Boolean] whether the key is potentially used in a code expression such as `t("category.#{category_key}")`
     def used_in_expr?(key)
-      !!(key =~ expr_key_re) # rubocop:disable Style/DoubleNegation
+      !!(key =~ expr_key_re)
     end
 
     private
@@ -139,12 +141,13 @@ module I18n::Tasks
     def expr_key_re(replacement: ':')
       @expr_key_re ||= begin
         # disallow patterns with no keys
-        ignore_pattern_re = /\A[\.#{replacement}]*\z/
+        ignore_pattern_re = /\A[.#{replacement}]*\z/
         patterns          = used_in_source_tree(strict: false).key_names.select do |k|
           k.end_with?('.') || k =~ /\#{/
         end.map do |k|
           pattern = "#{replace_key_exp(k, replacement)}#{replacement if k.end_with?('.')}"
           next if pattern =~ ignore_pattern_re
+
           pattern
         end.compact
         compile_key_pattern "{#{patterns * ','}}"
@@ -160,10 +163,11 @@ module I18n::Tasks
       braces  = []
       result  = []
       while (match_until = scanner.scan_until(/(?:#?\{|})/))
-        if scanner.matched == '#{'
+        case scanner.matched
+        when '#{'
           braces << scanner.matched
           result << match_until[0..-3] if braces.length == 1
-        elsif scanner.matched == '}'
+        when '}'
           prev_brace = braces.pop
           result << replacement if braces.empty? && prev_brace == '#{'
         else

data/lib/i18n/tasks/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module Tasks
-    VERSION = '0.9.29'
+    VERSION = '0.9.34'
   end
 end

data/templates/config/i18n-tasks.yml

@@ -32,7 +32,7 @@ data:
   # This data is not considered unused and is never written to.
   external:
     ## Example (replace %#= with %=):
-    # - "<%#= %x[bundle show vagrant].chomp %>/templates/locales/%{locale}.yml"
+    # - "<%#= %x[bundle info vagrant --path].chomp %>/templates/locales/%{locale}.yml"
 
   ## Specify the router (see Readme for details). Valid values: conservative_router, pattern_router, or a custom class.
   # router: conservative_router

data/templates/rspec/i18n_spec.rb

@@ -2,10 +2,11 @@
 
 require 'i18n/tasks'
 
-RSpec.describe 'I18n' do
+RSpec.describe I18n do
   let(:i18n) { I18n::Tasks::BaseTask.new }
   let(:missing_keys) { i18n.missing_keys }
   let(:unused_keys) { i18n.unused_keys }
+  let(:inconsistent_interpolations) { i18n.inconsistent_interpolations }
 
   it 'does not have missing keys' do
     expect(missing_keys).to be_empty,
@@ -21,7 +22,13 @@ RSpec.describe 'I18n' do
     non_normalized = i18n.non_normalized_paths
     error_message = "The following files need to be normalized:\n" \
                     "#{non_normalized.map { |path| "  #{path}" }.join("\n")}\n" \
-                    'Please run `i18n-tasks normalize` to fix'
+                    "Please run `i18n-tasks normalize' to fix"
     expect(non_normalized).to be_empty, error_message
   end
+
+  it 'does not have inconsistent interpolations' do
+    error_message = "#{inconsistent_interpolations.leaves.count} i18n keys have inconsistent interpolations.\n" \
+                    "Run `i18n-tasks check-consistent-interpolations' to show them"
+    expect(inconsistent_interpolations).to be_empty, error_message
+  end
 end