i18n-tasks 0.9.16 → 0.9.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0cac577152584d62e48767e77416aa559bed589
-  data.tar.gz: 5b981968e66f977fd24c8d2d16fc840614d88146
+  metadata.gz: ebc184ed8233c7a409de36ee6fd654fa4830e2f2
+  data.tar.gz: c846f15fa5b8e278d4b0dab8b3ec021759b8f603
 SHA512:
-  metadata.gz: '09b634136cd5a68aa0f37c5b272cf55bda9880181e68c173d1247acb5c629c825317b0aea9e64f5a09387e1ae4c87813d4988c930dfa07f0d088f616b6da165d'
-  data.tar.gz: 78d5153233fd8050e9394761010fb11344bdfc84f0d2f6786a2d016026e1027938a3b625a686e004f988bb6551aad3ae677ea8584c7356a09f01266807903e48
+  metadata.gz: 558d0ee6c04e5630c48f1e1c206f37931a38c60da5ff3392042940c814bfdbbab94ca0a51840f0b963fcd6adab4c9b3e2d4b5d15ee764670a4b49cd444194242
+  data.tar.gz: 8b955b0dd45d4761a9fde64ef0baa81fa3725d51f72ce136ebbac95c0bedb88a0a8392b1029253d780bf60a33fbaf7c1beb801f6430a9311dbe4d4cfe2a6aa9d

data/README.md

@@ -24,7 +24,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.16'
+gem 'i18n-tasks', '~> 0.9.17'
 ```
 
 Copy the default [configuration file](#configuration):
@@ -39,13 +39,20 @@ Copy rspec test to test for missing and unused translations as part of the suite
 $ cp $(i18n-tasks gem-path)/templates/rspec/i18n_spec.rb spec/
 ```
 
+Or for minitest:
+
+```console
+$ cp $(i18n-tasks gem-path)/templates/minitest/i18n_test.rb test/
+```
+
 ## Usage
 
 Run `i18n-tasks` to get the list of all the tasks with short descriptions.
 
 ### Check health
 
-`i18n-tasks health` checks if any keys are missing or not used:
+`i18n-tasks health` checks if any keys are missing or not used,
+and that all the locale files are normalized (auto-formatted):
 
 ```console
 $ i18n-tasks health

data/config/locales/en.yml

@@ -29,6 +29,7 @@ en:
             %{value_or_default_or_human_key}
       desc:
         add_missing: add missing keys to locale data
+        check_normalized: verify that all translation data is normalized
         config: display i18n-tasks configuration
         data: show locale data
         data_merge: merge locale data with trees

data/config/locales/ru.yml

@@ -27,6 +27,7 @@ ru:
             %{value_or_default_or_human_key}
       desc:
         add_missing: добавить недостающие ключи к переводам
+        check_normalized: проверить, что все файлы переводов нормализованы
         config: показать конфигурацию
         data: показать данные переводов
         data_merge: добавить дерево к переводам

data/i18n-tasks.gemspec

@@ -38,7 +38,7 @@ TEXT
   s.add_dependency 'activesupport', '>= 4.0.2'
   s.add_dependency 'ast', '>= 2.1.0'
   s.add_dependency 'easy_translate', '>= 0.5.0'
-  s.add_dependency 'erubis'
+  s.add_dependency 'erubi'
   s.add_dependency 'highline', '>= 1.7.3'
   s.add_dependency 'i18n'
   s.add_dependency 'parser', '>= 2.2.3.0'

data/lib/i18n/tasks.rb

@@ -57,7 +57,7 @@ rescue LoadError => _e
   require 'active_support/core_ext/try'
 end
 require 'rainbow'
-require 'erubis'
+require 'erubi'
 
 require 'i18n/tasks/version'
 require 'i18n/tasks/base_task'

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

@@ -17,7 +17,19 @@ module I18n::Tasks
             args: %i[locales pattern_router]
 
         def normalize(opt = {})
-          i18n.normalize_store! opt[:locales], opt[:pattern_router]
+          i18n.normalize_store! locales: opt[:locales],
+                                force_pattern_router: opt[:pattern_router]
+        end
+
+        cmd :check_normalized,
+            pos: '[locale ...]',
+            desc: t('i18n_tasks.cmd.desc.check_normalized'),
+            args: %i[locales]
+
+        def check_normalized(opt)
+          non_normalized = i18n.non_normalized_paths locales: opt[:locales]
+          terminal_report.check_normalized_results(non_normalized)
+          :exit_1 unless non_normalized.empty?
         end
 
         cmd :mv,

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

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

data/lib/i18n/tasks/configuration.rb

@@ -21,7 +21,9 @@ module I18n::Tasks::Configuration # rubocop:disable Metrics/ModuleLength
 
   def file_config
     file   = CONFIG_FILES.detect { |f| File.exist?(f) }
-    config = file && YAML.load(Erubis::Eruby.new(File.read(file, encoding: 'UTF-8')).result)
+    # rubocop:disable Security/Eval
+    config = file && YAML.load(eval(Erubi::Engine.new(File.read(file, encoding: 'UTF-8')).src))
+    # rubocop:enable Security/Eval
     if config.present?
       config.with_indifferent_access.tap do |c|
         if c[:relative_roots]

data/lib/i18n/tasks/data.rb

@@ -59,16 +59,25 @@ module I18n::Tasks
       !t(key, locale).nil?
     end
 
-    # write to store, normalizing all data
-    def normalize_store!(from = nil, pattern_router = false)
-      from   = locales unless from
-      router = pattern_router ? ::I18n::Tasks::Data::Router::PatternRouter.new(data, data.config) : data.router
+    # Normalize all the locale data in the store (by writing to the store).
+    #
+    # @param [Array<String>] locales locales to normalize. Default: all.
+    # @param [Boolean] force_pattern_router Whether to use pattern router regardless of the config.
+    def normalize_store!(locales: nil, force_pattern_router: false)
+      locales = self.locales unless locales
+      router = force_pattern_router ? ::I18n::Tasks::Data::Router::PatternRouter.new(data, data.config) : data.router
       data.with_router(router) do
-        Array(from).each do |target_locale|
-          # store handles normalization
+        Array(locales).each do |target_locale|
+          # The store handles actual normalization:
           data[target_locale] = data[target_locale]
         end
       end
     end
+
+    # @param [Array<String>] locales locales to check. Default: all.
+    # @return [Array<String>] paths to data that requires normalization
+    def non_normalized_paths(locales: nil)
+      Array(locales || self.locales).flat_map { |locale| data.non_normalized_paths(locale) }
+    end
   end
 end

data/lib/i18n/tasks/data/file_formats.rb

@@ -14,6 +14,7 @@ module I18n
           adapter_op :dump, format, tree, write_config(format)
         end
 
+        # @return [Hash]
         def adapter_parse(tree, format)
           adapter_op :parse, format, tree, read_config(format)
         end
@@ -34,8 +35,14 @@ module I18n
           (config[format] || {})[:read]
         end
 
+        # @return [Hash]
         def load_file(path)
-          adapter_parse ::File.read(path, encoding: 'UTF-8'), self.class.adapter_name_for_path(path)
+          adapter_parse read_file(path), self.class.adapter_name_for_path(path)
+        end
+
+        # @return [String]
+        def read_file(path)
+          ::File.read(path, encoding: 'UTF-8')
         end
 
         def write_tree(path, tree)
@@ -43,14 +50,16 @@ module I18n
           adapter = self.class.adapter_name_for_path(path)
           content = adapter_dump(hash, adapter)
           # Ignore unchanged data
-          return if File.file?(path) &&
-                    # Comparing hashes for equality directly would ignore key order.
-                    # Round-trip through the adapter and compare the strings instead:
-                    content == adapter_dump(load_file(path), adapter)
+          return if File.file?(path) && content == read_file(path)
           ::FileUtils.mkpath(File.dirname(path))
           ::File.open(path, 'w') { |f| f.write content }
         end
 
+        def normalized?(path, tree)
+          return false unless File.file?(path)
+          read_file(path) == adapter_dump(tree.to_hash(true), self.class.adapter_name_for_path(path))
+        end
+
         module ClassMethods
           # @param pattern [String] File.fnmatch pattern
           # @param adapter [responds to parse(string)->hash and dump(hash)->string]

data/lib/i18n/tasks/data/file_system_base.rb

@@ -53,6 +53,14 @@ module I18n::Tasks
         @available_locales = nil
       end
 
+      # @param [String] locale
+      # @return [Array<String>] paths to files that are not normalized
+      def non_normalized_paths(locale)
+        router.route(locale, get(locale))
+              .reject { |path, tree_slice| normalized?(path, tree_slice) }
+              .map(&:first)
+      end
+
       def write(forest)
         forest.each { |root| set(root.key, root) }
       end

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

@@ -90,6 +90,16 @@ module I18n
           end
         end
 
+        def check_normalized_results(non_normalized)
+          if non_normalized.empty?
+            print_success 'All data is normalized'
+            return
+          end
+          log_stderr Rainbow('The following data requires normalization:').yellow
+          puts non_normalized
+          log_stderr Rainbow('Run `i18n-tasks normalize` to fix').yellow
+        end
+
         private
 
         def missing_key_info(leaf)

data/lib/i18n/tasks/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module Tasks
-    VERSION = '0.9.16'
+    VERSION = '0.9.17'
   end
 end

data/templates/minitest/i18n_test.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'i18n/tasks'
+
+class I18nTest < ActiveSupport::TestCase
+  def setup
+    @i18n = I18n::Tasks::BaseTask.new
+    @missing_keys = @i18n.missing_keys
+    @unused_keys = @i18n.unused_keys
+  end
+
+  def test_no_missing_keys
+    assert_empty @missing_keys,
+                 "Missing #{@missing_keys.leaves.count} i18n keys, run `i18n-tasks missing' to show them"
+  end
+
+  def test_no_unused_keys
+    assert_empty @unused_keys,
+                 "#{@unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused' to show them"
+  end
+
+  def test_files_are_normalized
+    non_normalized = @i18n.non_normalized_paths
+    error_message = "The following files need to be normalized:\n" \
+                    "#{non_normalized.map { |path| "  #{path}" }.join("\n")}\n" \
+                    'Please run `i18n-tasks normalize` to fix'
+    assert_empty non_normalized, error_message
+  end
+end

data/templates/rspec/i18n_spec.rb

@@ -16,4 +16,12 @@ RSpec.describe 'I18n' do
     expect(unused_keys).to be_empty,
                            "#{unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused' to show them"
   end
+
+  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" \
+                    'Please run `i18n-tasks normalize` to fix'
+    expect(non_normalized).to be_empty, error_message
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.9.16
+  version: 0.9.17
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-21 00:00:00.000000000 Z
+date: 2017-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: erubis
+  name: erubi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -328,6 +328,7 @@ files:
 - lib/i18n/tasks/used_keys.rb
 - lib/i18n/tasks/version.rb
 - templates/config/i18n-tasks.yml
+- templates/minitest/i18n_test.rb
 - templates/rspec/i18n_spec.rb
 homepage: https://github.com/glebm/i18n-tasks
 licenses: