i18n-tasks 1.0.14 → 1.1.0

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

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks/translators/base_translator'
+require "i18n/tasks/translators/base_translator"
 
 module I18n::Tasks::Translators
   class YandexTranslator < BaseTranslator
     def initialize(*)
       begin
-        require 'yandex-translator'
+        require "yandex-translator"
       rescue LoadError
         raise ::I18n::Tasks::CommandError, "Add gem 'yandex-translator' to your Gemfile to use this command"
       end
@@ -16,7 +16,11 @@ module I18n::Tasks::Translators
     protected
 
     def translate_values(list, **options)
-      list.map { |item| translator.translate(item, options) }
+      result = list.map { |item| translator.translate(item, options) }
+
+      @progress_bar.progress += result.size
+
+      result
     end
 
     def options_for_translate_values(from:, to:, **options)
@@ -27,24 +31,24 @@ module I18n::Tasks::Translators
     end
 
     def options_for_html
-      { format: 'html' }
+      {format: "html"}
     end
 
     def options_for_plain
-      { format: 'plain' }
+      {format: "plain"}
     end
 
     def no_results_error_message
-      I18n.t('i18n_tasks.yandex_translate.errors.no_results')
+      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?('-')
+      return locale unless locale.include?("-")
 
-      locale.split('-', 2).first
+      locale.split("-", 2).first
     end
 
     def translator
@@ -54,7 +58,7 @@ module I18n::Tasks::Translators
     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?
+        fail ::I18n::Tasks::CommandError, I18n.t("i18n_tasks.yandex_translate.errors.no_api_key") if key.blank?
 
         key
       end

data/lib/i18n/tasks/unused_keys.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'set'
+require "set"
 
 module I18n
   module Tasks

data/lib/i18n/tasks/used_keys.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-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'
+require "find"
+require "i18n/tasks/scanners/pattern_with_scope_scanner"
+require "i18n/tasks/scanners/ruby_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"
 
 # Require the pattern mapper even though it's not used by i18n-tasks directly.
 # This allows the user to use it in config/i18n-tasks.yml without having to require it.
 # See https://github.com/glebm/i18n-tasks/issues/204.
-require 'i18n/tasks/scanners/pattern_mapper'
+require "i18n/tasks/scanners/pattern_mapper"
 
 module I18n::Tasks
   module UsedKeys # rubocop:disable Metrics/ModuleLength
@@ -20,17 +20,17 @@ module I18n::Tasks
       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::ErbAstScanner', { only: %w[*.html.erb] }],
-        ['::I18n::Tasks::Scanners::PatternWithScopeScanner', { exclude: %w[*.html.erb *.rb] }]
+        ["::I18n::Tasks::Scanners::RubyScanner", {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 *.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].freeze
+      *.less *.yml *.json *.zip *.tar.gz *.swf *.flv *.mp3 *.wav *.flac *.webm *.mp4 *.ogg *.opus
+      *.webp *.map *.xlsx].freeze
 
     # Find all keys in the source and return a forest with the keys in absolute form and their occurrences.
     #
@@ -40,12 +40,12 @@ module I18n::Tasks
     # @return [Data::Tree::Siblings]
     def used_tree(key_filter: nil, strict: nil, include_raw_references: false)
       src_tree = used_in_source_tree(key_filter: key_filter, strict: strict)
-      raw_refs, resolved_refs, used_refs = process_references(src_tree['used'].children)
+      raw_refs, resolved_refs, used_refs = process_references(src_tree["used"].children)
       raw_refs.leaves { |node| node.data[:ref_type] = :reference_usage }
       resolved_refs.leaves { |node| node.data[:ref_type] = :reference_usage_resolved }
       used_refs.leaves { |node| node.data[:ref_type] = :reference_usage_key }
       src_tree.tap do |result|
-        tree = result['used'].children
+        tree = result["used"].children
         tree.subtract_by_key!(raw_refs)
         tree.merge!(raw_refs) if include_raw_references
         tree.merge!(used_refs).merge!(resolved_refs)
@@ -57,11 +57,11 @@ module I18n::Tasks
                 scanner(strict: strict).keys.freeze)
       if key_filter
         key_filter_re = compile_key_pattern(key_filter)
-        keys          = keys.select { |k| k.key =~ key_filter_re }
+        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
@@ -71,11 +71,11 @@ module I18n::Tasks
         shared_options = search_config.dup
         shared_options.delete(:scanners)
         shared_options[:strict] = strict unless strict.nil?
-        log_verbose 'Scanners: '
+        log_verbose "Scanners: "
         Scanners::ScannerMultiplexer.new(
           scanners: search_config[:scanners].map do |(class_name, args)|
             if args && args[:strict]
-              fail CommandError, 'the strict option is global and cannot be applied on the scanner level'
+              fail CommandError, "the strict option is global and cannot be applied on the scanner level"
             end
 
             ActiveSupport::Inflector.constantize(class_name).new(
@@ -92,15 +92,15 @@ module I18n::Tasks
       @search_config ||= begin
         conf = (config[:search] || {}).deep_symbolize_keys
         if conf[:scanner]
-          warn_deprecated 'search.scanner is now search.scanners, an array of [ScannerClass, options]'
+          warn_deprecated "search.scanner is now search.scanners, an array of [ScannerClass, options]"
           conf[:scanners] = [[conf.delete(:scanner)]]
         end
         if conf[:ignore_lines]
-          warn_deprecated 'search.ignore_lines is no longer a global setting: pass it directly to the pattern scanner.'
+          warn_deprecated "search.ignore_lines is no longer a global setting: pass it directly to the pattern scanner."
           conf.delete(:ignore_lines)
         end
         if conf[:include]
-          warn_deprecated 'search.include is now search.only'
+          warn_deprecated "search.include is now search.only"
           conf[:only] = conf.delete(:include)
         end
         merge_scanner_configs(SEARCH_DEFAULTS, conf).freeze
@@ -142,19 +142,19 @@ module I18n::Tasks
 
     # keys in the source that end with a ., e.g. t("category.#{ cat.i18n_key }") or t("category." + category.key)
     # @param [String] replacement for interpolated values.
-    def expr_key_re(replacement: '*:')
+    def expr_key_re(replacement: "*:")
       @expr_key_re ||= begin
         # disallow patterns with no keys
         ignore_pattern_re = /\A[.#{replacement}]*\z/
-        patterns          = used_in_source_tree(strict: false).key_names.select do |k|
-          k.end_with?('.') || k =~ /\#{/
+        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?('.')}"
+          pattern = "#{replace_key_exp(k, replacement)}#{replacement if k.end_with?(".")}"
           next if pattern =~ ignore_pattern_re
 
           pattern
         end.compact
-        compile_key_pattern "{#{patterns * ','}}"
+        compile_key_pattern "{#{patterns * ","}}"
       end
     end
 
@@ -164,18 +164,18 @@ module I18n::Tasks
     # @return [String]
     def replace_key_exp(key, replacement)
       scanner = StringScanner.new(key)
-      braces  = []
-      result  = []
+      braces = []
+      result = []
       while (match_until = scanner.scan_until(/(?:#?\{|})/))
         case scanner.matched
         when '#{'
           braces << scanner.matched
           result << match_until[0..-3] if braces.length == 1
-        when '}'
+        when "}"
           prev_brace = braces.pop
           result << replacement if braces.empty? && prev_brace == '#{'
         else
-          braces << '{'
+          braces << "{"
         end
       end
       result << key[scanner.pos..] unless scanner.eos?

data/lib/i18n/tasks/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module Tasks
-    VERSION = '1.0.14'
+    VERSION = "1.1.0"
   end
 end

data/lib/i18n/tasks.rb

@@ -5,7 +5,7 @@ module I18n
   module Tasks
     class << self
       def gem_path
-        File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+        File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
       end
 
       def verbose?
@@ -47,7 +47,7 @@ module I18n
       end
     end
 
-    @verbose = !ENV['VERBOSE'].nil?
+    @verbose = !ENV["VERBOSE"].nil?
 
     module Data
     end
@@ -56,25 +56,26 @@ 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"
 
-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'
-require 'active_support/core_ext/object/try'
+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"
+require "active_support/core_ext/object/try"
 
-require 'rainbow'
-require 'erubi'
+require "ruby-progressbar"
+require "rainbow"
+require "erubi"
 
-require 'i18n/tasks/version'
-require 'i18n/tasks/base_task'
+require "i18n/tasks/version"
+require "i18n/tasks/base_task"
 
 # Add internal locale data to i18n gem load path
-require 'i18n'
+require "i18n"
 
-Dir[File.join(I18n::Tasks.gem_path, 'config', 'locales', '*.yml')].each do |locale_file|
+Dir[File.join(I18n::Tasks.gem_path, "config", "locales", "*.yml")].each do |locale_file|
   I18n.config.load_path << locale_file
 end

data/templates/config/i18n-tasks.yml

@@ -34,7 +34,7 @@ data:
     ## Example (replace %#= with %=):
     # - "<%#= %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.
+  ## Specify the router (see Readme for details). Valid values: conservative_router, pattern_router, isolating_router, or a custom class.
   # router: conservative_router
 
   yaml:
@@ -122,12 +122,24 @@ search:
 #     formality: prefer_less
 #   # OpenAI
 #   openai_api_key: "sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
-#   # openai_model: "gpt-3.5-turbo" # see https://platform.openai.com/docs/models
+#   # openai_model: "gpt-4o-mini" # see https://platform.openai.com/docs/models
+#   # openai_temperature: 0.0 # Controls randomness in responses (0.0-2.0), default: 0.0
 #   # may contain `%{from}` and `%{to}`, which will be replaced by source and target locale codes, respectively (using `Kernel.format`)
 #   # openai_system_prompt: >-
 #   #   You are a professional translator that translates content from the %{from} locale
 #   #   to the %{to} locale in an i18n locale array.
 #   #
+#   # Per-locale prompts override the default prompt for specific target locales
+#   # openai_locale_prompts:
+#   #   es: >-
+#   #     You are a professional translator specializing in Latin American Spanish.
+#   #     Translate content from the %{from} locale to the %{to} locale, using informal language
+#   #     and regional expressions common in Mexico.
+#   #   ja: >-
+#   #     You are a professional translator specializing in business Japanese.
+#   #     Translate content from the %{from} locale to the %{to} locale using formal, professional
+#   #     language appropriate for business contexts.
+#   #
 #   #   The array has a structured format and contains multiple strings. Your task is to translate
 #   #   each of these strings and create a new array with the translated strings.
 #   #

data/templates/minitest/i18n_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks'
+require "i18n/tasks"
 
 class I18nTest < ActiveSupport::TestCase
   def setup
@@ -10,13 +10,13 @@ class I18nTest < ActiveSupport::TestCase
   def test_no_missing_keys
     missing_keys = @i18n.missing_keys
     assert_empty missing_keys,
-                 "Missing #{missing_keys.leaves.count} i18n keys, run `i18n-tasks missing' to show them"
+      "Missing #{missing_keys.leaves.count} i18n keys, run `i18n-tasks missing' to show them"
   end
 
   def test_no_unused_keys
     unused_keys = @i18n.unused_keys
     assert_empty unused_keys,
-                 "#{unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused' to show them"
+      "#{unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused' to show them"
   end
 
   def test_files_are_normalized

data/templates/rspec/i18n_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks'
+require "i18n/tasks"
 
 RSpec.describe I18n do
   let(:i18n) { I18n::Tasks::BaseTask.new }
@@ -8,17 +8,17 @@ RSpec.describe I18n do
   let(:unused_keys) { i18n.unused_keys }
   let(:inconsistent_interpolations) { i18n.inconsistent_interpolations }
 
-  it 'does not have missing keys' do
+  it "does not have missing keys" do
     expect(missing_keys).to be_empty,
-                            "Missing #{missing_keys.leaves.count} i18n keys, run `i18n-tasks missing' to show them"
+      "Missing #{missing_keys.leaves.count} i18n keys, run `i18n-tasks missing' to show them"
   end
 
-  it 'does not have unused keys' do
+  it "does not have unused keys" do
     expect(unused_keys).to be_empty,
-                           "#{unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused' to show them"
+      "#{unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused' to show them"
   end
 
-  it 'files are normalized' do
+  it "files are normalized" 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" \
@@ -26,7 +26,7 @@ RSpec.describe I18n do
     expect(non_normalized).to be_empty, error_message
   end
 
-  it 'does not have inconsistent interpolations' do
+  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