i18n-tasks 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f361cd15dc7c4dbe60aedba3245481fb4180b91e
-  data.tar.gz: 5c1fa95a09f2cf826c12eb913145f91e2906758a
+  metadata.gz: b615d3bad6d043fd662de2ba05caba8230ab6d5a
+  data.tar.gz: 0e16ff6699e70fa0ac00aecddfe674d9e56d4352
 SHA512:
-  metadata.gz: db244b5be78460bac7f310996b389fd71296a788509700d07ae86b2f4ac68e920b70dc1293febebba07e5b7871a4c4b42c3856ec042fdbd9e64d2a13a1e71624
-  data.tar.gz: 24a7dff3fb48aa9d4b8371143669a491d079bbffc1630a97964607627293b7ae70a9576d4dda4241dbf9b11f8eea44a6f1c7b697cb3c9910f28a77a9dbd54301
+  metadata.gz: 613137fe779a345d90bafec320ed973e16823e460b2a772bf947ac4e885aae87391e311133842b9d78de69945942214a67bc92151b3e66c6e02fb622bd01e7fc
+  data.tar.gz: 9f7b694d7c4c012d19935089311b87809fbe6279e0184bd1d4b8619e10336de5afca4539c111dbd610bb8786965d890b2eaf4374bc985afb8572702f81ea1fc3

data/.travis.yml

@@ -3,8 +3,8 @@ rvm:
 - 2.1.1
 - 2.0.0
 - 1.9.3
-- jruby-head
-- rbx-2
+- jruby-1.7.13
+- rbx-2.2.10
 env:
   global:
   - TRAVIS=1

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.6.3
+
+* Strict mode added for `unused` and `remove-unused`. When passed `-s` or `--strict`, these tasks will not attempt to infer dynamic key usages, such as `t("category.#{category.key}")`.
+* Arrays are now supported as values for Google Translate [#77](https://github.com/glebm/i18n-tasks/issues/77)
+
 ## 0.6.2
 
 * New task to show locale data: `i18n-tasks data`

data/README.md

@@ -18,9 +18,20 @@ i18n-tasks can be used with any project using [i18n][i18n-gem] (default in Rails
 Add to Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.6.2'
+gem 'i18n-tasks', '~> 0.6.3'
 ```
 
+Copy default [config file](#configuration) (optional):
+
+```console
+$ cp $(i18n-tasks gem-path)/templates/config/i18n-tasks.yml config/
+```
+
+Copy [rspec test](#rspec-integration) (optional):
+
+```console
+$ cp $(i18n-tasks gem-path)/templates/rspec/i18n_spec.rb spec/
+```
 
 ## Usage
 
@@ -38,6 +49,7 @@ Available commands:
   unused              show unused translations
   eq-base             show translations equal to base value
   find                show where the keys are used in the code
+  data                show locale data
   translate-missing   translate missing keys with Google Translate
   add-missing         add missing keys to the locales
   normalize           normalize translation data: sort and move to the right files
@@ -50,6 +62,17 @@ Available commands:
 See `<command> --help` for more information on a specific command.
 ```
 
+Show tasks accept a format option, and all but `find` accept locales as arguments, e.g:
+
+```bash
+$ i18n-tasks data --help
+Usage: i18n-tasks data [options]
+    -l, --locales      Filter by locale(s), comma-separated list (en,fr) or all (default), or pass arguments without -l
+    -f, --format       Output format: terminal-table, yaml, json, keys, inspect. Default: terminal-table.
+    -h, --help         Display this help message.
+$ i18n-tasks data -fkeys en es fr
+```
+
 #### Add missing keys
 
 You can add missing values, generated from the key (for base locale) or copied from the base locale (for other locales).
@@ -98,6 +121,9 @@ i18n-tasks unused
 i18n-tasks remove-unused
 ```
 
+These tasks will infer dynamic key usage such as `t("category.\#{category.name}")` by default.
+Pass `-s` or `--strict` to disable this feature.
+
 #### Features
 
 Relative keys (`t '.title'`) and plural keys (`key.{one,many,other,...}`) are fully supported.
@@ -126,8 +152,8 @@ Inspect configuration with `i18n-tasks config`.
 
 Install the default config file with:
 
-```bash
-cp $(i18n-tasks gem-path)/templates/config/i18n-tasks.yml config/
+```console
+$ cp $(i18n-tasks gem-path)/templates/config/i18n-tasks.yml config/
 ```
 
 ### Locales
@@ -323,16 +349,16 @@ translation:
 You might want to test for missing and unused translations as part of your test suite.
 Install the spec file:
 
-```bash
-cp $(i18n-tasks gem-path)/templates/rspec/i18n_spec.rb spec/
+```console
+$ cp $(i18n-tasks gem-path)/templates/rspec/i18n_spec.rb spec/
 ```
 
 ### XLSX
 
 Export missing and unused data to XLSX:
 
-```bash
-i18n-tasks xlsx-report
+```console
+$ i18n-tasks xlsx-report
 ```
 
 ### HTML

data/lib/i18n/tasks/commands.rb

@@ -12,13 +12,16 @@ module I18n::Tasks
     OPT = {
         locale: proc {
           on '-l', :locales=,
-             'Filter by locale(s), comma-separated list (e.g. en,fr) or all (default: all), also accepted as arguments without -l',
+             'Filter by locale(s), comma-separated list (en,fr) or all (default), or pass arguments without -l',
              on_locale_opt
         },
         format: proc {
           on '-f', :format=,
              "Output format: #{VALID_TREE_FORMATS * ', '}. Default: terminal-table.",
              {default: 'terminal-table', argument: true, optional: false}
+        },
+        strict: proc {
+          on :s, :strict, %Q(Do not infer dynamic key usage such as `t("category.\#{category.name}")`)
         }
     }
     desc 'show missing translations'
@@ -36,6 +39,7 @@ module I18n::Tasks
     opts do
       instance_exec &OPT[:locale]
       instance_exec &OPT[:format]
+      instance_exec &OPT[:strict]
     end
     cmd :unused do |opt = {}|
       parse_locales! opt
@@ -118,6 +122,7 @@ module I18n::Tasks
     desc 'remove unused keys'
     opts do
       on '-l', :locales=, 'Locales to remove unused keys from (comma-separated, default: all)', on_locale_opt
+      instance_exec &OPT[:strict]
     end
     cmd :remove_unused do |opt = {}|
       parse_locales! opt

data/lib/i18n/tasks/commands_base.rb

@@ -20,8 +20,12 @@ module I18n::Tasks
       end
     end
 
+    VALID_LOCALE_RE = /\A\w[\w\-_\.]*\z/i
     def parse_locales!(opt)
       opt[:locales] = locales_opt(opt[:arguments].presence || opt[:locales]).tap do |locales|
+        locales.each do |locale|
+          raise CommandError.new("Invalid locale: #{locale}") if VALID_LOCALE_RE !~ locale
+        end
         log_verbose "locales for the command are #{locales.inspect}"
       end
     end

data/lib/i18n/tasks/google_translation.rb

@@ -17,7 +17,7 @@ module I18n::Tasks
       key_idx = {}
       list.each_with_index { |k_v, i| key_idx[k_v[0]] = i }
       list.group_by { |k_v|
-        k_v[0].end_with?('_html'.freeze)
+        !!(k_v[0] =~ /[.\-_]html\z/.freeze)
       }.map do |html, slice|
         t_opts = opts.merge(html ? {html: true} : {format: 'text'})
         fetch_google_translations slice, t_opts
@@ -26,26 +26,59 @@ module I18n::Tasks
       }
     end
 
-    INTERPOLATION_KEY_RE  = /%\{[^}]+\}/
-    UNTRANSLATABLE_STRING = 'zxzxzx'
-
     def fetch_google_translations(list, opts)
-      translated = EasyTranslate.translate(list.map { |l| l[1].gsub(INTERPOLATION_KEY_RE, UNTRANSLATABLE_STRING) }, opts)
-      if translated.blank?
-        raise CommandError.new('Google Translate returned no results. Make sure billing information is set at https://code.google.com/apis/console.')
-      end
-      translated.each_with_index { |translation, i|
-        if (original = list[i][1]) =~ INTERPOLATION_KEY_RE
-          interpolation_keys = original.scan(INTERPOLATION_KEY_RE)
-          i                  = -1
-          translation.gsub!(Regexp.new(UNTRANSLATABLE_STRING, Regexp::IGNORECASE)) { interpolation_keys[i += 1] }
+      from_values(list, EasyTranslate.translate(to_values(list), opts)).tap do |result|
+        if result.blank?
+          raise CommandError.new('Google Translate returned no results. Make sure billing information is set at https://code.google.com/apis/console.')
         end
-      }
-      list.map(&:first).zip(translated)
+      end
     end
 
     private
 
+    def to_values(list)
+      list.map { |l| dump_value l[1] }.flatten
+    end
+
+    def from_values(list, translated_values)
+      keys                = list.map(&:first)
+      untranslated_values = list.map(&:last)
+      keys.zip parse_value(untranslated_values, translated_values.to_enum)
+    end
+
+    def dump_value(value)
+      if value.is_a?(Array)
+        # dump recursively
+        value.map { |v| dump_value v }
+      else
+        replace_interpolations value
+      end
+    end
+
+    def parse_value(untranslated, each_translated)
+      if untranslated.is_a?(Array)
+        # implode array
+        untranslated.map { |from| parse_value(from, each_translated) }
+      else
+        value = each_translated.next
+        restore_interpolations untranslated, value
+      end
+    end
+
+    INTERPOLATION_KEY_RE  = /%\{[^}]+\}/.freeze
+    UNTRANSLATABLE_STRING = 'zxzxzx'.freeze
+
+    # 'hello, %{name}' => 'hello, <round-trippable string>'
+    def replace_interpolations(value)
+      value.gsub INTERPOLATION_KEY_RE, UNTRANSLATABLE_STRING
+    end
+
+    def restore_interpolations(untranslated, translated)
+      return translated if untranslated !~ INTERPOLATION_KEY_RE
+      each_value = untranslated.scan(INTERPOLATION_KEY_RE).to_enum
+      translated.gsub(Regexp.new(UNTRANSLATABLE_STRING, Regexp::IGNORECASE)) { each_value.next }
+    end
+
     def warn_missing_api_key
       $stderr.puts Term::ANSIColor.red Term::ANSIColor.yellow 'Set Google API key via GOOGLE_TRANSLATE_API_KEY environmnet variable or translation.api_key in config/i18n-tasks.yml.
 Get the key at https://code.google.com/apis/console.'

data/lib/i18n/tasks/missing_keys.rb

@@ -67,8 +67,8 @@ module I18n::Tasks
 
     # keys used in the code missing translations in locale
     def missing_used_tree(locale)
-      used_tree.select_keys { |key, _node|
-        !key_expression?(key) && locale_key_missing?(locale, key)
+      used_tree(strict: true).select_keys { |key, _node|
+        locale_key_missing?(locale, key)
       }.set_root_key(locale, type: :missing_used)
     end
 

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

@@ -37,9 +37,9 @@ module I18n::Tasks::Scanners
     end
 
     # @return [Array<{key,data:{source_locations:[]}}]
-    def keys
+    def keys(opts = {})
       keys = traverse_files { |path|
-        scan_file(path)
+        scan_file(path, opts)
       }.reduce(:+) || []
       keys.group_by(&:first).map { |key, key_loc|
         [key, data: {source_locations: key_loc.map { |(k, attr)| attr[:data] }}]
@@ -53,7 +53,7 @@ module I18n::Tasks::Scanners
     end
 
     # @return [Array<Key>] keys found in file
-    def scan_file(path, *args)
+    def scan_file(path, opts = {})
       raise 'Unimplemented'
     end
 
@@ -116,9 +116,15 @@ module I18n::Tasks::Scanners
     end
 
     VALID_KEY_RE = /^[-\w.\#{}]+$/
-
-    def valid_key?(key)
-      key =~ VALID_KEY_RE && !(@key_filter && @key_filter_pattern !~ key)
+    VALID_KEY_RE_STRICT = /^[-\w.]+$/
+
+    def valid_key?(key, strict = false)
+      return false if @key_filter && @key_filter_pattern !~ key
+      if strict
+        key =~ VALID_KEY_RE_STRICT && !key.end_with?('.')
+      else
+        key =~ VALID_KEY_RE
+      end
     end
 
     def relative_roots

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

@@ -7,12 +7,14 @@ module I18n::Tasks::Scanners
   class PatternScanner < BaseScanner
     # Extract i18n keys from file based on the pattern which must capture the key literal.
     # @return [Array<Key>] keys found in file
-    def scan_file(path, text = read_file(path))
+    def scan_file(path, opts = {})
       keys = []
+      strict = !!opts[:strict]
+      text = opts[:text] || read_file(path)
       text.scan(pattern) do |match|
         src_pos = Regexp.last_match.offset(0).first
         key     = match_to_key(match, path)
-        next unless valid_key?(key)
+        next unless valid_key?(key, strict)
         location = src_location(path, text, src_pos)
         unless exclude_line?(location[:line])
           keys << [key, data: location]

data/lib/i18n/tasks/unused_keys.rb

@@ -6,13 +6,15 @@ module I18n
     module UnusedKeys
       def unused_keys(opts = {})
         locales = Array(opts[:locales]).presence || self.locales
-        locales.map { |locale| unused_tree locale }.compact.reduce(:merge!)
+        locales.map { |locale| unused_tree locale, opts[:strict] }.compact.reduce(:merge!)
       end
 
-      def unused_tree(locale = base_locale)
+      # @param [String] locale
+      # @param [Boolean] strict if true, do not match dynamic keys
+      def unused_tree(locale = base_locale, strict = false)
         collapse_plural_nodes! data[locale].select_keys { |key, _node|
           !ignore_key?(key, :unused) &&
-              !used_in_expr?(key) &&
+              (strict || !used_in_expr?(key)) &&
               !used_key?(depluralize_key(key, locale))
         }
       end

data/lib/i18n/tasks/used_keys.rb

@@ -7,10 +7,11 @@ module I18n::Tasks
 
     # find all keys in the source (relative keys are absolutized)
     # @option opts [String] :key_filter
+    # @option opts [Boolean] :strict if true dynamic keys are excluded (e.g. `t("category.#{category.key}")`)
     # @return [Array<String>]
     def used_tree(opts = {})
       return scanner.with_key_filter(opts[:key_filter]) { used_tree(opts.except(:key_filter)) } if opts[:key_filter]
-      key_attrs = scanner.keys
+      key_attrs = scanner.keys(opts.slice(:strict))
       Data::Tree::Node.new(
           key: 'used',
           data: {key_filter: scanner.key_filter},
@@ -26,13 +27,17 @@ module I18n::Tasks
       end
     end
 
-    def used_key_names
-      @used_key_names ||= used_tree.key_names
+    def used_key_names(strict = false)
+      if strict
+        @used_key_names ||= used_tree(strict: true).key_names
+      else
+        @used_key_names ||= used_tree.key_names
+      end
     end
 
     # whether the key is used in the source
-    def used_key?(key)
-      used_key_names.include?(key)
+    def used_key?(key, strict = false)
+      used_key_names(strict).include?(key)
     end
 
     # @return whether the key is potentially used in a code expression such as:

data/lib/i18n/tasks/version.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 module I18n
   module Tasks
-    VERSION = '0.6.2'
+    VERSION = '0.6.3'
   end
 end

data/spec/google_translate_spec.rb

@@ -6,8 +6,9 @@ describe 'Google Translation' do
   include I18n::Tasks::GoogleTranslation
 
   tests = [
-      text_test = ['a', "Hello - %{user} O'neill!", "Hola - %{user} O'neill!"],
-      html_test = ['a_html', "Hello - <b>%{user} O'neill</b>", "Hola - <b>%{user} O'neill</b>"]
+      text_test = ['key', "Hello - %{user} O'neill!", "Hola - %{user} O'neill!"],
+      html_test = ['html-key.html', "Hello - <b>%{user} O'neill</b>", "Hola - <b>%{user} O'neill</b>"],
+      array_test = ['array-key', ['Hello.', 'Goodbye.'], ['Hola.', 'Adiós.']]
   ]
 
 
@@ -16,7 +17,7 @@ describe 'Google Translation' do
       delegate :i18n_cmd, :i18n_task, :in_test_app_dir, to: :TestCodebase
 
       context 'API' do
-        it 'works' do
+        it "works with #{tests.map(&:first)}" do
           # Just one test with all the cases to lower the Google bill
           translations = google_translate(
               tests.map { |t| t[0..1] }, from: :en, to: :es, key: ENV['GOOGLE_TRANSLATE_API_KEY'])

data/spec/i18n_tasks_spec.rb

@@ -38,12 +38,19 @@ describe 'i18n-tasks' do
   end
 
   let(:expected_unused_keys) { %w(unused.a unused.numeric unused.plural).map { |k| %w(en es).map { |l| "#{l}.#{k}" } }.reduce(:+) }
+  let(:expected_unused_keys_strict) { expected_unused_keys + %w(hash.pattern.a hash.pattern2.a).map { |k| %w(en es).map { |l| "#{l}.#{k}" } }.reduce(:+) }
   describe 'unused' do
     it 'detects unused' do
       capture_stderr do
         expect(run_cmd :unused).to be_i18n_keys expected_unused_keys
       end
     end
+
+    it 'detects unused (--strict)' do
+      capture_stderr do
+        expect(run_cmd :unused, strict: true).to be_i18n_keys expected_unused_keys_strict
+      end
+    end
   end
 
   describe 'remove_unused' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2014-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis