i18n-tasks 0.9.25 → 0.9.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c701c96d03c3226bb8c9a6e2bed8477c7846645ee384a93c569c090cfe9b76ae
-  data.tar.gz: 5209c23392064c0d0a15cc61f2a82d0a08294e58afd7b1466b433295ae861e98
+  metadata.gz: c5c06b9d6d4187eda97fce4acb55c31c8c01534814e8770ed64d3f0f052dbb26
+  data.tar.gz: ec0198e22e8c9b55fd87f386467cb94400a400263405efc42fc5d3696c610e21
 SHA512:
-  metadata.gz: 4a573608dff03c12f15920a84ed5c01d2377c593e43ed1cf27c0f9a1951b75fa4211be678b1ad150df7a129365f09a77e398c45d6260c87213f62985dbad58d9
-  data.tar.gz: 9bf7f845ef28e04b87bbbdc9b0e293ef7187b808ce7a7b690434441a725d6b61ef74759f77e26d5df756d49220f04ff6d0a716581cda040979c41d2d1d374b4c
+  metadata.gz: 89296743377a8207fa571d82c23c1ec36e71b8209f2f949cf8d541ea0ef4db87b1f69e5c28796ee6ebeeddad1c352a2d1b2f14bf685593e828c715dc74a24b18
+  data.tar.gz: b66aaea9115ee5015e9696d562666dbcfeae6f770f4e8558e59257557e9d138249639bdf6a9b9e73ee1acadb88b1ae386f0d1dde1e7b655ff816f15e0a229fc9

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.25'
+gem 'i18n-tasks', '~> 0.9.26'
 ```
 
 Copy the default [configuration file](#configuration):

data/config/locales/en.yml

@@ -33,6 +33,7 @@ en:
             %{value_or_default_or_human_key}
       desc:
         add_missing: add missing keys to locale data
+        check_consistent_interpolations: verify that all translations use correct interpolation variables
         check_normalized: verify that all translation data is normalized
         config: display i18n-tasks configuration
         data: show locale data
@@ -102,6 +103,8 @@ en:
           Google Translate returned no results. Make sure billing information is set at https://code.google.com/apis/console.
     health:
       no_keys_detected: No keys detected. Check data.read in config/i18n-tasks.yml.
+    inconsistent_interpolations:
+      none: No inconsistent interpolations found.
     missing:
       details_title: Value in other locales or source
       none: No translations are missing.

data/config/locales/ru.yml

@@ -9,7 +9,7 @@ ru:
         desc:
           all_locales: Не ожидать, что маски ключа начинаются с локали. Применять маски ко всем локалям.
           confirm: Подтвердить автоматом
-          data_format: 'Формат данных: %{valid_text}. %{default_text}.'
+          data_format: 'Формат данных: %{valid_text}.'
           keep_order: Keep the order of the keys
           key_pattern: Маска ключа (например, common.*)
           key_pattern_to_rename: Полный ключ (шаблон) для переименования. Необходимый параметр.
@@ -21,7 +21,7 @@ ru:
           missing_types: 'Типы недостающих переводов: %{valid}. По умолчанию: все'
           new_key_name: Новое имя, интерполирует оригинальное название как %{key}. Необходимый параметр.
           nostdin: Не читать дерево из стандартного ввода
-          out_format: 'Формат вывода: %{valid_text}. %{default_text}.'
+          out_format: 'Формат вывода: %{valid_text}.'
           pattern_router: 'Использовать pattern_router: ключи распределятся по файлам согласно data.write'
           strict: Не угадывать динамические использования ключей, например `t("category.#{category.key}")`
           translation_backend: Движок перевода (google или deepl)
@@ -30,6 +30,8 @@ ru:
             %{value_or_default_or_human_key}
       desc:
         add_missing: добавить недостающие ключи к переводам
+        check_consistent_interpolations: убедитесь, что во всех переводах используются правильные
+          интерполяционные переменные
         check_normalized: проверить, что все файлы переводов нормализованы
         config: показать конфигурацию
         data: показать данные переводов
@@ -99,12 +101,14 @@ ru:
           в https://code.google.com/apis/console.
     health:
       no_keys_detected: Ключи не обнаружены. Проверьте data.read в config/i18n-tasks.yml.
+    inconsistent_interpolations:
+      none: Не найдено несогласованных интерполяций.
     missing:
       details_title: На других языках или в коде
       none: Всё переведено.
     remove_unused:
       confirm:
-        one: Один перевод будут удалён из %{locales}.
+        one: "%{count} перевод будут удалён из %{locales}."
         other: Переводы (%{count}) будут удалены из %{locales}.
       noop: Нет неиспользуемых ключей
       removed: Удалены ключи (%{count})

data/lib/i18n/tasks/base_task.rb

@@ -10,6 +10,7 @@ require 'i18n/tasks/html_keys'
 require 'i18n/tasks/used_keys'
 require 'i18n/tasks/ignore_keys'
 require 'i18n/tasks/missing_keys'
+require 'i18n/tasks/interpolations'
 require 'i18n/tasks/unused_keys'
 require 'i18n/tasks/translation'
 require 'i18n/tasks/locale_pathname'
@@ -30,6 +31,7 @@ module I18n
       include UsedKeys
       include IgnoreKeys
       include MissingKeys
+      include Interpolations
       include UnusedKeys
       include Translation
       include Logging

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

@@ -12,7 +12,9 @@ module I18n::Tasks
             args: %i[locales out_format]
 
         def eq_base(opt = {})
-          print_forest i18n.eq_base_keys(opt), opt, :eq_base_keys
+          forest = i18n.eq_base_keys(opt)
+          print_forest forest, opt, :eq_base_keys
+          :exit_1 unless forest.empty?
         end
       end
     end

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

@@ -16,7 +16,12 @@ module I18n::Tasks
           stats  = i18n.forest_stats(forest)
           fail CommandError, t('i18n_tasks.health.no_keys_detected') if stats[:key_count].zero?
           terminal_report.forest_stats forest, stats
-          [missing(opt), unused(opt), check_normalized(opt)].detect { |result| result == :exit_1 }
+          [
+            missing(opt),
+            unused(opt),
+            check_consistent_interpolations(opt),
+            check_normalized(opt)
+          ].detect { |result| result == :exit_1 }
         end
       end
     end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module I18n::Tasks
+  module Command
+    module Commands
+      module Interpolations
+        include Command::Collection
+
+        cmd :check_consistent_interpolations,
+            pos: '[locale ...]',
+            desc: t('i18n_tasks.cmd.desc.check_consistent_interpolations'),
+            args: %i[locales out_format]
+
+        def check_consistent_interpolations(opt = {})
+          forest = i18n.inconsistent_interpolations(opt.slice(:locales, :base_locale))
+          print_forest forest, opt, :inconsistent_interpolations
+          :exit_1 unless forest.empty?
+        end
+      end
+    end
+  end
+end

data/lib/i18n/tasks/commands.rb

@@ -5,6 +5,7 @@ require 'i18n/tasks/command/collection'
 require 'i18n/tasks/command/commands/health'
 require 'i18n/tasks/command/commands/missing'
 require 'i18n/tasks/command/commands/usages'
+require 'i18n/tasks/command/commands/interpolations'
 require 'i18n/tasks/command/commands/eq_base'
 require 'i18n/tasks/command/commands/data'
 require 'i18n/tasks/command/commands/tree'
@@ -17,6 +18,7 @@ module I18n::Tasks
     include Command::Commands::Health
     include Command::Commands::Missing
     include Command::Commands::Usages
+    include Command::Commands::Interpolations
     include Command::Commands::EqBase
     include Command::Commands::Data
     include Command::Commands::Tree

data/lib/i18n/tasks/concurrent/cached_value.rb

@@ -18,10 +18,42 @@ module I18n::Tasks::Concurrent
 
     # @return [Object] Result of the computation.
     def get
-      return @result unless @result == NULL
+      return get_result_volatile unless get_result_volatile == NULL
       @mutex.synchronize do
-        @result = @computation.call
+        next unless get_result_volatile == NULL
+        set_result_volatile @computation.call
+        @computation = nil
       end
+      get_result_volatile
     end
+
+    private
+
+    # Ruby instance variable volatility is currently unspecified:
+    # https://bugs.ruby-lang.org/issues/11539
+    #
+    # Below are the implementations for major ruby engines, based on concurrent-ruby.
+    # rubocop:disable Lint/DuplicateMethods,Naming/AccessorMethodName
+    case RUBY_ENGINE
+    when 'rbx'
+      def get_result_volatile
+        Rubinius.memory_barrier
+        @result
+      end
+
+      def set_result_volatile(value)
+        @result = value
+        Rubinius.memory_barrier
+      end
+    else
+      def get_result_volatile
+        @result
+      end
+
+      def set_result_volatile(value)
+        @result = value
+      end
+    end
+    # rubocop:enable Lint/DuplicateMethods,Naming/AccessorMethodName
   end
 end

data/lib/i18n/tasks/interpolations.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module I18n::Tasks
+  module Interpolations
+    VARIABLE_REGEX = /%{[^}]+}/
+
+    def inconsistent_interpolations(locales: nil, base_locale: nil) # rubocop:disable Metrics/AbcSize
+      locales ||= self.locales
+      base_locale ||= self.base_locale
+      result = empty_forest
+
+      data[base_locale].key_values.each do |key, value|
+        next if !value.is_a?(String) || ignore_key?(key, :inconsistent_interpolations)
+        base_vars = Set.new(value.scan(VARIABLE_REGEX))
+        (locales - [base_locale]).each do |current_locale|
+          node = data[current_locale].first.children[key]
+          next unless node&.value&.is_a?(String)
+          vars = node.value.scan(VARIABLE_REGEX)
+          unless vars.size == base_vars.size && vars.all? { |v| base_vars.include?(v) }
+            result.merge!(node.walk_to_root.reduce(nil) { |c, p| [p.derive(children: c)] })
+          end
+        end
+      end
+
+      result.each { |root| root.data[:type] = :inconsistent_interpolations }
+      result
+    end
+  end
+end

data/lib/i18n/tasks/reports/base.rb

@@ -21,6 +21,10 @@ module I18n::Tasks::Reports
       "Missing translations (#{forest.leaves.count || '∅'})"
     end
 
+    def inconsistent_interpolations_title(forest)
+      "Inconsistent interpolations (#{forest.leaves.count || '∅'})"
+    end
+
     def unused_title(key_values)
       "Unused keys (#{key_values.count || '∅'})"
     end

data/lib/i18n/tasks/reports/terminal.rb

@@ -25,6 +25,15 @@ module I18n
           end
         end
 
+        def inconsistent_interpolations(forest = task.inconsistent_interpolations)
+          if forest.present?
+            print_title inconsistent_interpolations_title(forest)
+            show_tree(forest)
+          else
+            print_success I18n.t('i18n_tasks.inconsistent_interpolations.none')
+          end
+        end
+
         def icon(type)
           glyph = missing_type_info(type)[:glyph]
           { missing_used: Rainbow(glyph).red, missing_diff: Rainbow(glyph).yellow }[type]

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

@@ -61,7 +61,7 @@ module I18n::Tasks::Translators
 
     def configure_api_key!
       api_key = @i18n_tasks.translation_config[:deepl_api_key]
-      fail CommandError, I18n.t('i18n_tasks.deepl_translate.errors.no_api_key') if api_key.blank?
+      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

@@ -59,7 +59,7 @@ module I18n::Tasks::Translators
           )
           key ||= translation_config[:api_key]
         end
-        fail CommandError, I18n.t('i18n_tasks.google_translate.errors.no_api_key') if key.blank?
+        fail ::I18n::Tasks::CommandError, I18n.t('i18n_tasks.google_translate.errors.no_api_key') if key.blank?
         key
       end
     end

data/lib/i18n/tasks/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module Tasks
-    VERSION = '0.9.25'
+    VERSION = '0.9.26'
   end
 end

data/templates/config/i18n-tasks.yml

@@ -111,6 +111,10 @@ search:
 #   fr,es:
 #     - common.brand
 
+## Exclude these keys from the `i18n-tasks check-consistent-interpolations` report:
+# ignore_inconsistent_interpolations:
+# - 'activerecord.attributes.*'
+
 ## Ignore these keys completely:
 # ignore:
 #  - kaminari.*

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.9.25
+  version: 0.9.26
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-18 00:00:00.000000000 Z
+date: 2018-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -282,6 +282,7 @@ files:
 - lib/i18n/tasks/command/commands/data.rb
 - lib/i18n/tasks/command/commands/eq_base.rb
 - lib/i18n/tasks/command/commands/health.rb
+- lib/i18n/tasks/command/commands/interpolations.rb
 - lib/i18n/tasks/command/commands/meta.rb
 - lib/i18n/tasks/command/commands/missing.rb
 - lib/i18n/tasks/command/commands/tree.rb
@@ -312,6 +313,7 @@ files:
 - lib/i18n/tasks/data/tree/traversal.rb
 - lib/i18n/tasks/html_keys.rb
 - lib/i18n/tasks/ignore_keys.rb
+- lib/i18n/tasks/interpolations.rb
 - lib/i18n/tasks/key_pattern_matching.rb
 - lib/i18n/tasks/locale_list.rb
 - lib/i18n/tasks/locale_pathname.rb