i18n-tasks 0.9.33 → 1.0.12

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,11 +15,12 @@ module I18n
         parts = []
         pos   = 0
         return [key] if max == 1
+
         key_parts(key) do |part|
           parts << part
           pos += part.length + 1
           if parts.length + 1 >= max
-            parts << key[pos..-1] unless pos == key.length
+            parts << key[pos..] unless pos == key.length
             break
           end
         end
@@ -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,9 +111,10 @@ 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]
+          values[m[UNTRANSLATABLE_STRING.length..].to_i]
         end
       rescue StandardError => e
         raise_interpolation_error(untranslated, translated, e)

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

@@ -48,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
@@ -66,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 do |config|
+        config.auth_key = api_key
+        config.host = host unless host.blank?
+        config.version = version unless version.blank?
+      end
     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

@@ -3,6 +3,7 @@
 require 'find'
 require 'i18n/tasks/scanners/pattern_with_scope_scanner'
 require 'i18n/tasks/scanners/ruby_ast_scanner'
+require 'i18n/tasks/scanners/erb_ast_scanner'
 require 'i18n/tasks/scanners/scanner_multiplexer'
 require 'i18n/tasks/scanners/files/caching_file_finder_provider'
 require 'i18n/tasks/scanners/files/caching_file_reader'
@@ -16,17 +17,20 @@ 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::ErbAstScanner', { only: %w[*.erb] }],
+        ['::I18n::Tasks::Scanners::PatternWithScopeScanner', { exclude: %w[*.erb *.rb] }]
       ],
+      ast_matchers: [],
       strict: true
     }.freeze
 
-    ALWAYS_EXCLUDE = %w[*.jpg *.png *.gif *.svg *.ico *.eot *.otf *.ttf *.woff *.woff2 *.pdf *.css *.sass *.scss *.less
+    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
+                        *.webp *.map *.xlsx].freeze
 
     # Find all keys in the source and return a forest with the keys in absolute form and their occurrences.
     #
@@ -56,8 +60,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
@@ -73,10 +77,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" } }
         )
@@ -104,7 +109,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|
@@ -124,7 +129,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
@@ -140,12 +145,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 * ','}}"
@@ -161,17 +167,18 @@ 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
           braces << '{'
         end
       end
-      result << key[scanner.pos..-1] unless scanner.eos?
+      result << key[scanner.pos..] unless scanner.eos?
       result.join
     end
   end

data/lib/i18n/tasks/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module Tasks
-    VERSION = '0.9.33'
+    VERSION = '1.0.12'
   end
 end

data/lib/i18n/tasks.rb

@@ -34,6 +34,17 @@ module I18n
         ::I18n::Tasks::Commands.send :include, commands_module
         self
       end
+
+      # Add AST-matcher to i18n-tasks
+      #
+      # @param matcher_class_name
+      # @return self
+      def add_ast_matcher(matcher_class_name)
+        matchers = I18n::Tasks::Configuration::DEFAULTS[:search][:ast_matchers]
+        matchers << matcher_class_name
+        matchers.uniq!
+        self
+      end
     end
 
     @verbose = !ENV['VERBOSE'].nil?
@@ -43,19 +54,18 @@ module I18n
   end
 end
 
+# Per https://github.com/rails/rails/commit/0181f0edd57a2149278bd59c3519233ca1e0a413#commitcomment-60940992
+# 'active_support' must be required first even if we only use parts of it.
+require 'active_support'
+
 require 'active_support/inflector'
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/array/access'
 require 'active_support/core_ext/array/extract_options'
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/object/blank'
-begin
-  # activesupport >= 3
-  require 'active_support/core_ext/object/try'
-rescue LoadError => _e
-  # activesupport ~> 2.3.2
-  require 'active_support/core_ext/try'
-end
+require 'active_support/core_ext/object/try'
+
 require 'rainbow'
 require 'erubi'
 

data/templates/config/i18n-tasks.yml

@@ -64,12 +64,21 @@ 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)
+  ##   *.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 *.map *.xlsx
   exclude:
     - app/assets/images
     - app/assets/fonts
     - app/assets/videos
+    - app/assets/builds
 
   ## Alternatively, the only files or `File.fnmatch patterns` to search in `paths`:
   ## If specified, this settings takes priority over `exclude`, but `exclude` still applies.
@@ -78,6 +87,15 @@ search:
   ## If `strict` is `false`, guess usages such as t("categories.#{category}.title"). The default is `true`.
   # strict: true
 
+  ## Allows adding ast_matchers for finding translations using the AST-scanners
+  ## The available matchers are:
+  ## - RailsModelMatcher
+  ##     Matches ActiveRecord translations like
+  ##     User.human_attribute_name(:email) and User.model_name.human
+  ##
+  ## To implement your own, please see `I18n::Tasks::Scanners::AstMatchers::BaseMatcher`.
+  <%# I18n::Tasks.add_ast_matcher('I18n::Tasks::Scanners::AstMatchers::RailsModelMatcher') %>
+
   ## Multiple scanners can be used. Their results are merged.
   ## The options specified above are passed down to each scanner. Per-scanner options can be specified as well.
   ## See this example of a custom scanner: https://github.com/glebm/i18n-tasks/wiki/A-custom-scanner-example
@@ -90,6 +108,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.33
+  version: 1.0.12
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-21 00:00:00.000000000 Z
+date: 2022-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: better_html
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: erubi
   requirement: !ruby/object:Gem::Requirement
@@ -143,12 +163,15 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.5.1
 - !ruby/object:Gem::Dependency
-  name: axlsx
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -156,26 +179,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: overcommit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 0.58.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 0.58.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -210,14 +230,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 1.27.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 1.27.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -357,12 +377,18 @@ files:
 - lib/i18n/tasks/references.rb
 - lib/i18n/tasks/reports/base.rb
 - lib/i18n/tasks/reports/terminal.rb
+- lib/i18n/tasks/scanners/ast_matchers/base_matcher.rb
+- lib/i18n/tasks/scanners/ast_matchers/message_receivers_matcher.rb
+- lib/i18n/tasks/scanners/ast_matchers/rails_model_matcher.rb
+- lib/i18n/tasks/scanners/erb_ast_processor.rb
+- lib/i18n/tasks/scanners/erb_ast_scanner.rb
 - lib/i18n/tasks/scanners/file_scanner.rb
 - lib/i18n/tasks/scanners/files/caching_file_finder.rb
 - lib/i18n/tasks/scanners/files/caching_file_finder_provider.rb
 - lib/i18n/tasks/scanners/files/caching_file_reader.rb
 - lib/i18n/tasks/scanners/files/file_finder.rb
 - lib/i18n/tasks/scanners/files/file_reader.rb
+- lib/i18n/tasks/scanners/local_ruby_parser.rb
 - lib/i18n/tasks/scanners/occurrence_from_position.rb
 - lib/i18n/tasks/scanners/pattern_mapper.rb
 - lib/i18n/tasks/scanners/pattern_scanner.rb
@@ -394,11 +420,14 @@ licenses:
 - MIT
 metadata:
   issue_tracker: https://github.com/glebm/i18n-tasks
+  rubygems_mfa_required: 'true'
 post_install_message: |
   # Install default configuration:
   cp $(bundle exec i18n-tasks gem-path)/templates/config/i18n-tasks.yml config/
   # Add an RSpec for missing and unused keys:
   cp $(bundle exec i18n-tasks gem-path)/templates/rspec/i18n_spec.rb spec/
+  # Or for minitest:
+  cp $(bundle exec i18n-tasks gem-path)/templates/minitest/i18n_test.rb test/
 rdoc_options: []
 require_paths:
 - lib
@@ -406,7 +435,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4.0'