i18n-tasks 0.9.34 → 0.9.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5477cbdf1fb14c575eaad7221cac570147acfcde877fa5960dcdfd958d76d270
-  data.tar.gz: b40dbef296c01aa2c047b8ae2f6ef3567f8643b35895516a8fde281f225e6daa
+  metadata.gz: 8ac03642fdf45424834ce7e968e70af9d602c5d5721eda666dbd38635adcf542
+  data.tar.gz: 793b43903d97f1dccead925e5128142886708b279f55f04bcd62c6b349bddead
 SHA512:
-  metadata.gz: f732fc9479ba13cd3acb1c7222401f873ace5a8db1ef248712c1ea4dbdb9d05a7fdc5da5bb3600c7c799c64b7f21b1586518b1feec508a0ad36d211110b07b3e
-  data.tar.gz: f05241d9bd75bbecb1cb992882d84c4e9826c00c66b66263e7203603e19c9a188e96ea7f4e4131160e23216265df675f4519d190263cf14de59384bd2e62c88d
+  metadata.gz: 538b6490808142df807dcfa623e6907dd408dc9346e37b2ecbba2257350fa6dcf91b66f8b1f9338cc24fbd7f138ee5c20a7875633c26c9c06ac06dbb87e7e67a
+  data.tar.gz: f7570702d3599d229236ffd3841b33776b3bef50875b12c515b5bc3e63ace2ef2f86fd3058e957959e196c90ace5dc539a5b328a203f0e9f4460b26f3b751778

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.34'
+gem 'i18n-tasks', '~> 0.9.35'
 ```
 
 Copy the default [configuration file](#configuration):
@@ -212,7 +212,7 @@ $ i18n-tasks missing -f yaml fr | i18n-tasks tree-set-value 'TRME %{value}' | i1
 $ i18n-tasks unused -f yaml | i18n-tasks data-remove
 ```
 
-Remove all keys in `fr` but not `en` from `fr`:
+Remove all keys from `fr` that do not exist in `en`. Do not change `en`:
 ```console
 $ i18n-tasks missing -t diff -f yaml en | i18n-tasks tree-mv en fr | i18n-tasks data-remove
 ```
@@ -405,7 +405,9 @@ translation:
 ```yaml
 # config/i18n-tasks.yml
 translation:
-  deepl_api_key: <Deep Pro API key>
+  deepl_api_key: <DeepL Pro API key>
+  deepl_host: <optional>
+  deepl_version: <optional>
 ```
 
 <a name="yandex-translation-config"></a>

data/config/locales/en.yml

@@ -11,6 +11,7 @@ en:
         desc:
           all_locales: Do not expect key patterns to start with a locale, instead apply them to all
             locales implicitly.
+          config: Override config location
           confirm: Confirm automatically
           data_format: 'Data format: %{valid_text}.'
           keep_order: Keep the order of the keys

data/lib/i18n/tasks/base_task.rb

@@ -39,7 +39,8 @@ module I18n
       include Data
       include Stats
 
-      def initialize(config = {})
+      def initialize(config = {}, config_file: nil)
+        @config_override = config_file
         self.config = config || {}
       end
 

data/lib/i18n/tasks/cli.rb

@@ -34,7 +34,18 @@ class I18n::Tasks::CLI
   end
 
   def run(argv)
-    I18n.with_locale(base_task.internal_locale) do
+    argv.each_with_index do |arg, i|
+      if ["--config", "-c"].include?(arg)
+        if File.exist?(argv[i+1])
+          @config_file = argv[i+1]
+          break
+        else
+          error "Config file doesn't exist: #{argv[i+1]}", 128
+        end
+      end
+    end
+
+    I18n.with_locale(base_task(config_file: @config_file).internal_locale) do
       name, *options = parse!(argv.dup)
       context.run(name, *options)
     end
@@ -52,8 +63,8 @@ class I18n::Tasks::CLI
 
   private
 
-  def base_task
-    @base_task ||= I18n::Tasks::BaseTask.new
+  def base_task(config_file: nil)
+    @base_task ||= I18n::Tasks::BaseTask.new(config_file: config_file)
   end
 
   def parse!(argv)

data/lib/i18n/tasks/command/commands/health.rb

@@ -9,7 +9,7 @@ module I18n::Tasks
         cmd :health,
             pos: '[locale ...]',
             desc: t('i18n_tasks.cmd.desc.health'),
-            args: %i[locales out_format]
+            args: %i[locales out_format config]
 
         def health(opt = {})
           forest = i18n.data_forest(opt[:locales])

data/lib/i18n/tasks/command/options/common.rb

@@ -28,6 +28,12 @@ module I18n::Tasks
             '--value VALUE',
             t('i18n_tasks.cmd.args.desc.value')
 
+        arg :config,
+            '-c',
+            '--config FILE',
+            t('i18n_tasks.cmd.args.desc.config')
+
+
         def arg_or_pos!(key, opts)
           opts[key] ||= opts[:arguments].try(:shift)
         end

data/lib/i18n/tasks/configuration.rb

@@ -20,7 +20,7 @@ module I18n::Tasks::Configuration # rubocop:disable Metrics/ModuleLength
   ].freeze
 
   def file_config
-    file   = CONFIG_FILES.detect { |f| File.exist?(f) }
+    file   = @config_override || CONFIG_FILES.detect { |f| File.exist?(f) }
     # rubocop:disable Security/Eval
     config = file && YAML.load(eval(Erubi::Engine.new(File.read(file, encoding: 'UTF-8')).src))
     # rubocop:enable Security/Eval
@@ -59,6 +59,8 @@ module I18n::Tasks::Configuration # rubocop:disable Metrics/ModuleLength
       conf = (config[:translation] || {}).with_indifferent_access
       conf[:google_translate_api_key] = ENV['GOOGLE_TRANSLATE_API_KEY'] if ENV.key?('GOOGLE_TRANSLATE_API_KEY')
       conf[:deepl_api_key] = ENV['DEEPL_AUTH_KEY'] if ENV.key?('DEEPL_AUTH_KEY')
+      conf[:deepl_host] = ENV['DEEPL_HOST'] if ENV.key?('DEEPL_HOST')
+      conf[:deepl_version] = ENV['DEEPL_VERSION'] if ENV.key?('DEEPL_VERSION')
       conf[:yandex_api_key] = ENV['YANDEX_API_KEY'] if ENV.key?('YANDEX_API_KEY')
       conf
     end

data/lib/i18n/tasks/missing_keys.rb

@@ -65,6 +65,7 @@ module I18n::Tasks
         plural_nodes data[locale] do |node|
           children = node.children
           present_keys = Set.new(children.map { |c| c.key.to_sym })
+          next if ignore_key?(node.full_key(root: false), :missing)
           next if present_keys.superset?(required_keys)
 
           tree[node.full_key] = node.derive(

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

@@ -9,7 +9,9 @@ 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?
 
@@ -18,7 +20,12 @@ module I18n
             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
@@ -31,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/translators/base_translator.rb

@@ -94,7 +94,7 @@ module I18n::Tasks
       end
 
       INTERPOLATION_KEY_RE = /%\{[^}]+}/.freeze
-      UNTRANSLATABLE_STRING = 'zxzxzx'
+      UNTRANSLATABLE_STRING = 'X__'
 
       # @param [String] value
       # @return [String] 'hello, %{name}' => 'hello, <round-trippable string>'

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

@@ -67,9 +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/used_keys.rb

@@ -16,6 +16,7 @@ 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] }],
@@ -24,7 +25,7 @@ module I18n::Tasks
       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
 
@@ -105,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|

data/lib/i18n/tasks/version.rb

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

data/templates/config/i18n-tasks.yml

@@ -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.34
+  version: 0.9.35
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport