i18n-tasks 0.9.31 → 0.9.35

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

@@ -26,6 +26,7 @@ module I18n::Tasks::Scanners
       if scope
         scope_parts = extract_literal_or_array_of_literals(scope)
         return nil if scope_parts.nil? || scope_parts.empty?
+
         "#{scope_parts.join('.')}.#{key}"
       else
         key unless match[0] =~ /\A\w/
@@ -61,7 +62,7 @@ module I18n::Tasks::Scanners
 
     # extract literal or array of literals
     # returns nil on any other input
-    # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength,Metrics/PerceivedComplexity
     def extract_literal_or_array_of_literals(s)
       literals = []
       braces_stack = []
@@ -78,6 +79,7 @@ module I18n::Tasks::Scanners
       s.each_char.with_index do |c, i|
         if c == '['
           return nil unless braces_stack.empty?
+
           braces_stack.push(i)
         elsif c == ']'
           break
@@ -93,6 +95,6 @@ module I18n::Tasks::Scanners
       consume_literal.call unless acc.empty?
       literals
     end
-    # rubocop:enable Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength,Metrics/PerceivedComplexity
   end
 end

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

@@ -9,15 +9,23 @@ module I18n
         # @param roots [Array<String>] paths to relative roots
         # @param calling_method [#call, Symbol, String, false, nil]
         # @return [String] absolute version of the key
-        def absolute_key(key, path, roots: config[:relative_roots], calling_method: nil)
+        def absolute_key(key, path, roots: config[:relative_roots],
+                         exclude_method_name_paths: config[:exclude_method_name_paths],
+                         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" \
                                 "Set search.relative_roots in config/i18n-tasks.yml (currently #{roots.inspect})")
           normalized_path.sub!(root, '')
-          "#{prefix(normalized_path, calling_method: calling_method)}#{key}"
+
+          if (exclude_method_name_paths || []).map { |p| expand_path(p) }.include?(root)
+            "#{prefix(normalized_path)}#{key}"
+          else
+            "#{prefix(normalized_path, calling_method: calling_method)}#{key}"
+          end
         end
 
         private
@@ -30,12 +38,19 @@ module I18n
         # @return [String] the closest ancestor root for path, with a trailing {File::SEPARATOR}.
         def path_root(path, roots)
           roots.map do |p|
-            File.expand_path(p) + File::SEPARATOR
+            expand_path(p)
           end.sort.reverse_each.detect do |root|
             path.start_with?(root)
           end
         end
 
+        # Expand a path and add a trailing {File::SEPARATOR}
+        # @param [String] path relative path
+        # @return [String] absolute path, with a trailing {File::SEPARATOR}.
+        def expand_path(path)
+          File.expand_path(path) + File::SEPARATOR
+        end
+
         # @param normalized_path [String] path/relative/to/a/root
         # @param calling_method [#call, Symbol, String, false, nil]
         def prefix(normalized_path, calling_method: nil)

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,7 +14,7 @@ module I18n::Tasks::Scanners
     include RelativeKeys
     include AST::Sexp
 
-    MAGIC_COMMENT_PREFIX = /\A.\s*i18n-tasks-use\s+/
+    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)
@@ -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,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks/translators/deepl_translator.rb'
-require 'i18n/tasks/translators/google_translator.rb'
-require 'i18n/tasks/translators/yandex_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

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,8 +93,8 @@ module I18n::Tasks
         end
       end
 
-      INTERPOLATION_KEY_RE = /%\{[^}]+}/
-      UNTRANSLATABLE_STRING = 'zxzxzx'
+      INTERPOLATION_KEY_RE = /%\{[^}]+}/.freeze
+      UNTRANSLATABLE_STRING = 'X__'
 
       # @param [String] value
       # @return [String] 'hello, %{name}' => 'hello, <round-trippable string>'
@@ -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
@@ -61,8 +67,15 @@ module I18n::Tasks::Translators
 
     def configure_api_key!
       api_key = @i18n_tasks.translation_config[:deepl_api_key]
+      host = @i18n_tasks.translation_config[:deepl_host]
+      version = @i18n_tasks.translation_config[:deepl_version]
       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 }
+
+      DeepL.configure { |config|
+        config.auth_key = api_key
+        config.host = host unless host.blank?
+        config.version = version unless version.blank?
+      }
     end
   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

@@ -43,6 +43,7 @@ module I18n::Tasks::Translators
     # Convert 'es-ES' to 'es'
     def to_yandex_compatible_locale(locale)
       return locale unless locale.include?('-')
+
       locale.split('-', 2).first
     end
 
@@ -54,6 +55,7 @@ module I18n::Tasks::Translators
       @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

data/lib/i18n/tasks/used_keys.rb

@@ -16,16 +16,18 @@ module I18n::Tasks
   module UsedKeys # rubocop:disable Metrics/ModuleLength
     SEARCH_DEFAULTS = {
       paths: %w[app/].freeze,
+      relative_exclude_method_name_paths: [],
       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
+    ALWAYS_EXCLUDE = %w[*.jpg *.jpeg *.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
+                        *.webp].freeze
 
     # Find all keys in the source and return a forest with the keys in absolute form and their occurrences.
     #
@@ -55,8 +57,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 +74,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" } }
         )
@@ -103,7 +106,7 @@ module I18n::Tasks
 
     def merge_scanner_configs(a, b)
       a.deep_merge(b).tap do |c|
-        %i[scanners paths relative_roots].each do |key|
+        %i[scanners paths relative_exclude_method_name_paths relative_roots].each do |key|
           c[key] = a[key] if b[key].blank?
         end
         %i[exclude].each do |key|
@@ -123,7 +126,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 +142,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 +164,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.31'
+    VERSION = '0.9.35'
   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
@@ -64,6 +64,13 @@ search:
   #   - app/presenters
   #   - app/views
 
+  ## Directories where method names which should not be part of a relative key resolution.
+  # By default, if a relative translation is used inside a method, the name of the method will be considered part of the resolved key.
+  # Directories listed here will not consider the name of the method part of the resolved key
+  #
+  # relative_exclude_method_name_paths:
+  #  -
+
   ## Files or `File.fnmatch` patterns to exclude from search. Some files are always excluded regardless of this setting:
   ##   %w(*.jpg *.png *.gif *.svg *.ico *.eot *.otf *.ttf *.woff *.woff2 *.pdf *.css *.sass *.scss *.less *.yml *.json)
   exclude:
@@ -90,6 +97,8 @@ search:
 #   # DeepL Pro Translate
 #   # Get an API key and subscription at https://www.deepl.com/pro to use DeepL Pro
 #   deepl_api_key: "48E92789-57A3-466A-9959-1A1A1A1A1A1A"
+#   # deepl_host: "https://api.deepl.com"
+#   # deepl_version: "v2"
 
 ## Do not consider these keys missing:
 # ignore_missing:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.9.31
+  version: 0.9.35
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-10 00:00:00.000000000 Z
+date: 2021-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -210,14 +210,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 1.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -404,16 +404,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+  - - "<"
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Manage localization and translation with the awesome power of static analysis