i18n-tasks 0.9.0.rc1 → 0.9.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 032b4f63664580dc57f296ae0379fc282bdadf26
-  data.tar.gz: 217065770a8d92a96b8cf9009ddb7d2dc7dfea30
+  metadata.gz: d6bf06f3a6c91c128dd0f3323f4ec13f462c6378
+  data.tar.gz: 820875215de90ebc773b2abf25144fd8107fa953
 SHA512:
-  metadata.gz: f20aadc5aa981419c3b6e5641ba3f18c8012d533b54d1e7a7df4490e56b1fe8d60bb2bb8bd7422e61534ac05ec16f3983bd1f360699e1e9dcb4d262ba466b6af
-  data.tar.gz: 34f9ab86382cf2ac7c307d4106c2eb470dc270ad97b72a8d4d462d5f5116a7651aa849624623bcbb0a68d48dd25c4775fe113db560395df7196ca44bcc7a88f3
+  metadata.gz: e6b2821d3a098e3fbd371c5909d1f9858c70a2627b41f9863ece9cd5b3b2b142430dd081613d1c29dbc6ab5e72d3c9036e6fae603a6d5f8aee5d1273524f9262
+  data.tar.gz: 01841c0c2850a891620310c7a99a682c7b7afdd798701fbc44d317f6961cb600c0897d67b99263d85e80e13c94de4f4b21d9ea8500e4d0f571b0f0a6cf918d33

data/README.md

@@ -4,7 +4,7 @@
 
 i18n-tasks helps you find and manage missing and unused translations.
 
-<img width="539" height="331" src="https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.png">
+<img width="539" height="331" src="https://i.imgur.com/XZBd8l7.png">
 
 This gem analyses code statically for key usages, such as `I18n.t('some.key')`, in order to:
 
@@ -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.0.rc1'
+gem 'i18n-tasks', '~> 0.9.0.rc2'
 ```
 
 Copy the default [configuration file](#configuration):
@@ -72,7 +72,7 @@ $ i18n-tasks add-missing --help
 Usage: i18n-tasks add-missing [options] [locale ...]
     -l, --locales  Comma-separated list of locale(s) to process. Default: all. Special: base.
     -f, --format   Output format: terminal-table, yaml, json, keys, inspect. Default: terminal-table.
-    -v, --value    Value. Interpolates: %{value}, %{human_key}, %{value_or_human_key}. Default: %{value_or_human_key}.
+    -v, --value    Value. Interpolates: %{value}, %{human_key}, %{value_or_human_key}, %{key}. Default: %{value_or_human_key}.
     -h, --help     Display this help message.
 ```
 
@@ -96,7 +96,7 @@ $ i18n-tasks find 'auth.*'
 $ i18n-tasks find '{number,currency}.format.*'
 ```
 
-<img width="437" height="129" src="https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-usages.png">
+<img width="437" height="129" src="https://i.imgur.com/VxBrSfY.png">
 
 ### Remove unused keys
 
@@ -145,9 +145,11 @@ See the full list of tasks with `i18n-tasks --help`.
 
 ### Features and limitations
 
+`i18n-tasks` uses an AST scanner for `.rb` files, and a regexp-based scanner for other files, such as `.haml`.
+
 #### Relative keys
 
-`i18n-tasks` offers partial support for relative keys, such as `t '.title'`.
+`i18n-tasks` offers support for relative keys, such as `t '.title'`.
 
 ✔ Keys relative to the file path they are used in (see [relative roots configuration](#usage-search)) are supported.
 
@@ -159,23 +161,17 @@ See the full list of tasks with `i18n-tasks --help`.
 
 #### `t()` keyword arguments
 
-✔ `scope` keyword argument is supported, but only when it is the first argument.
-
-✘ `default` and other arguments are not supported.
+✔ `scope` keyword argument is fully supported by the AST scanner, and also by the Regexp scanner but only when it is the first argument.
 
-Parsing keyword arguments correctly with Regexp is difficult. This can be improved with an s-expression parser.
+✔ `default` argument can be used to pre-fill locale files (AST scanner only).
 
 #### Dynamic keys
 
-By default, unused report will detect some dynamic keys and not report them, e.g.:
-
-```ruby
-t 'category.' + category.key      # all 'category.:' keys considered used (: denotes one key segment)
-t "category.#{category.key}.name" # all 'category.:.name' keys considered used
-```
+By default, dynamic keys such as `t "cats.#{cat}.name"` are not recognized.
+I encourage you to mark these with [i18n-tasks-use hints](#fine-tuning).
 
-This will not be on by default in future versions, in favour of encouraging explicit [i18n-tasks-use hints](#fine-tuning).
-For now, you can disable dynamic key inference by passing `-s` or `--strict` to `unused` tasks.
+Alternatively, you can enable dynamic key inference by setting `search.strict` to `false` in the config. In this case,
+all the dynamic parts of the key will be considered used, e.g. `cats.tenderlove.name` would not be reported as unused.
 
 ## Configuration
 
@@ -256,7 +252,7 @@ If you have implemented a custom adapter please share it on [the wiki][wiki].
 ### Usage search
 
 See the `search` section in the [config file][config] for all available configuration options.
-An example of a custom scanner can be found here: https://github.com/glebm/i18n-tasks/issues/138#issuecomment-87255708.
+Custom scanners are easy to add, an example of one can be found [here](https://github.com/glebm/i18n-tasks/wiki/A-custom-scanner-example). 
 
 ### Fine-tuning
 
@@ -305,34 +301,7 @@ $ i18n-tasks xlsx-report
 ## Add new tasks
 
 Tasks that come with the gem are defined in [lib/i18n/tasks/command/commands](lib/i18n/tasks/command/commands).
-
-Add a custom task like the ones defined by the gem:
-
-```ruby
-# my_commands.rb
-module MyCommands
-  include ::I18n::Tasks::Command::Collection
-  cmd :my_task, desc: 'my custom task'
-  def my_task(opts = {})
-  end
-end
-```
-
-```yaml
-# config/i18n-tasks.yml
-<%
-  require './my_commands'
-  I18n::Tasks::Commands.send :include, MyCommands
-%>
-```
-
-Run with:
-
-```console
-$ i18n-tasks my-task
-```
-
-See more examples of custom tasks [on the wiki](https://github.com/glebm/i18n-tasks/wiki#custom-tasks).
+Custom tasks can be added easily, see the examples [on the wiki](https://github.com/glebm/i18n-tasks/wiki#custom-tasks).
 
 [MIT license]: /LICENSE.txt
 [travis]: https://travis-ci.org/glebm/i18n-tasks
@@ -346,5 +315,6 @@ See more examples of custom tasks [on the wiki](https://github.com/glebm/i18n-ta
 [config]: https://github.com/glebm/i18n-tasks/blob/master/templates/config/i18n-tasks.yml
 [wiki]: https://github.com/glebm/i18n-tasks/wiki "i18n-tasks wiki"
 [i18n-gem]: https://github.com/svenfuchs/i18n "svenfuchs/i18n on Github"
-[screenshot-find]: https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-usages.png "i18n-tasks find output screenshot"
+[screenshot-i18n-tasks]: https://i.imgur.com/XZBd8l7.png "i18n-tasks screenshot"
+[screenshot-find]: https://i.imgur.com/VxBrSfY.png "i18n-tasks find output screenshot"
 [adapter-example]: https://github.com/glebm/i18n-tasks/blob/master/lib/i18n/tasks/data/file_system_base.rb

data/bin/i18n-tasks

@@ -1,5 +1,9 @@
 #!/usr/bin/env ruby
 
+if ENV['I18N_TASKS_BIN_SIMPLECOV_COVERAGE']
+  require_relative '../spec/bin_simplecov_helper'
+end
+
 # prevent i18n gem warning
 require 'i18n'
 i18n_gem_config = I18n.config

data/config/locales/en.yml

@@ -1,103 +1,103 @@
----
-en:
-  i18n_tasks:
-    add_missing:
-      added:
-        one: Added %{count} key
-        other: Added %{count} keys
-    cmd:
-      args:
-        default_text: 'Default: %{value}'
-        desc:
-          confirm: Confirm automatically
-          data_format: 'Data format: %{valid_text}.'
-          key_pattern: Filter by key pattern (e.g. 'common.*')
-          key_pattern_to_rename: Full key (pattern) to rename. Required
-          locale: Locale
-          locale_to_translate_from: Locale to translate from
-          locales_filter: 'Locale(s) to process. Special: base'
-          missing_types: 'Filter by types: %{valid}'
-          new_key_name: New name, interpolates original name as %{key}. Required
-          nostdin: Do not read from stdin
-          out_format: 'Output format: %{valid_text}'
-          pattern_router: 'Use pattern router: keys moved per config data.write'
-          strict: Avoid inferring dynamic key usages such as t("cats.#{cat}.name"). Takes precedence over the
-            config setting if set.
-          value: 'Value. Interpolates: %{value}, %{human_key}, %{value_or_human_key}'
-      desc:
-        add_missing: add missing keys to locale data
-        config: display i18n-tasks configuration
-        data: show locale data
-        data_merge: merge locale data with trees
-        data_remove: remove keys present in tree from data
-        data_write: replace locale data with tree
-        eq_base: show translations equal to base value
-        find: show where keys are used in the code
-        gem_path: show path to the gem
-        health: is everything OK?
-        irb: start REPL session within i18n-tasks context
-        missing: show missing translations
-        normalize: 'normalize translation data: sort and move to the right files'
-        remove_unused: remove unused keys
-        translate_missing: translate missing keys with Google Translate
-        tree_convert: convert tree between formats
-        tree_filter: filter tree by key pattern
-        tree_merge: merge trees
-        tree_rename_key: rename tree node
-        tree_set_value: set values of keys, optionally match a pattern
-        tree_subtract: tree A minus the keys in tree B
-        tree_translate: Google Translate a tree to root locales
-        unused: show unused translations
-        xlsx_report: save missing and unused translations to an Excel file
-      encourage:
-      - Good job!
-      - Well done!
-      - Perfect!
-      enum_list_opt:
-        invalid: "%{invalid} is not in: %{valid}."
-      enum_opt:
-        invalid: "%{invalid} is not one of: %{valid}."
-      errors:
-        invalid_format: 'invalid format: %{invalid}. valid: %{valid}.'
-        invalid_locale: 'invalid locale: %{invalid}'
-        invalid_missing_type:
-          one: 'invalid type: %{invalid}. valid: %{valid}.'
-          other: 'unknown types: %{invalid}. valid: %{valid}.'
-        pass_forest: pass locale forest
-    common:
-      base_value: Base Value
-      continue_q: Continue?
-      key: Key
-      locale: Locale
-      n_more: "%{count} more"
-      type: Type
-      value: Value
-    data_stats:
-      text: has %{key_count} keys across %{locale_count} locales. On average, values are %{value_chars_avg}
-        characters long, keys have %{key_segments_avg} segments, a locale has %{per_locale_avg} keys.
-      text_single_locale: has %{key_count} keys in total. On average, values are %{value_chars_avg}
-        characters long, keys have %{key_segments_avg} segments.
-      title: Forest (%{locales})
-    google_translate:
-      errors:
-        no_api_key: Set Google API key via GOOGLE_TRANSLATE_API_KEY environment variable or translation.api_key
-          in config/i18n-tasks.yml. Get the key at https://code.google.com/apis/console.
-        no_results: 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.
-    missing:
-      details_title: Value in other locales or source
-      none: No translations are missing.
-    remove_unused:
-      confirm:
-        one: "%{count} translation will be removed from %{locales}."
-        other: "%{count} translation will be removed from %{locales}."
-      noop: No unused keys to remove
-      removed: Removed %{count} keys
-    translate_missing:
-      translated: Translated %{count} keys
-    unused:
-      none: Every translation is in use.
-    usages:
-      none: No key usages found.
+---
+en:
+  i18n_tasks:
+    add_missing:
+      added:
+        one: Added %{count} key
+        other: Added %{count} keys
+    cmd:
+      args:
+        default_text: 'Default: %{value}'
+        desc:
+          confirm: Confirm automatically
+          data_format: 'Data format: %{valid_text}.'
+          key_pattern: Filter by key pattern (e.g. 'common.*')
+          key_pattern_to_rename: Full key (pattern) to rename. Required
+          locale: Locale
+          locale_to_translate_from: Locale to translate from
+          locales_filter: 'Locale(s) to process. Special: base'
+          missing_types: 'Filter by types: %{valid}'
+          new_key_name: New name, interpolates original name as %{key}. Required
+          nostdin: Do not read from stdin
+          out_format: 'Output format: %{valid_text}'
+          pattern_router: 'Use pattern router: keys moved per config data.write'
+          strict: Avoid inferring dynamic key usages such as t("cats.#{cat}.name"). Takes precedence over the
+            config setting if set.
+          value: 'Value. Interpolates: %{value}, %{human_key}, %{key}, %{default}, %{value_or_human_key}, %{value_or_default_or_human_key}'
+      desc:
+        add_missing: add missing keys to locale data
+        config: display i18n-tasks configuration
+        data: show locale data
+        data_merge: merge locale data with trees
+        data_remove: remove keys present in tree from data
+        data_write: replace locale data with tree
+        eq_base: show translations equal to base value
+        find: show where keys are used in the code
+        gem_path: show path to the gem
+        health: is everything OK?
+        irb: start REPL session within i18n-tasks context
+        missing: show missing translations
+        normalize: 'normalize translation data: sort and move to the right files'
+        remove_unused: remove unused keys
+        translate_missing: translate missing keys with Google Translate
+        tree_convert: convert tree between formats
+        tree_filter: filter tree by key pattern
+        tree_merge: merge trees
+        tree_rename_key: rename tree node
+        tree_set_value: set values of keys, optionally match a pattern
+        tree_subtract: tree A minus the keys in tree B
+        tree_translate: Google Translate a tree to root locales
+        unused: show unused translations
+        xlsx_report: save missing and unused translations to an Excel file
+      encourage:
+      - Good job!
+      - Well done!
+      - Perfect!
+      enum_list_opt:
+        invalid: "%{invalid} is not in: %{valid}."
+      enum_opt:
+        invalid: "%{invalid} is not one of: %{valid}."
+      errors:
+        invalid_format: 'invalid format: %{invalid}. valid: %{valid}.'
+        invalid_locale: 'invalid locale: %{invalid}'
+        invalid_missing_type:
+          one: 'invalid type: %{invalid}. valid: %{valid}.'
+          other: 'unknown types: %{invalid}. valid: %{valid}.'
+        pass_forest: pass locale forest
+    common:
+      base_value: Base Value
+      continue_q: Continue?
+      key: Key
+      locale: Locale
+      n_more: "%{count} more"
+      type: Type
+      value: Value
+    data_stats:
+      text: has %{key_count} keys across %{locale_count} locales. On average, values are %{value_chars_avg}
+        characters long, keys have %{key_segments_avg} segments, a locale has %{per_locale_avg} keys.
+      text_single_locale: has %{key_count} keys in total. On average, values are %{value_chars_avg}
+        characters long, keys have %{key_segments_avg} segments.
+      title: Forest (%{locales})
+    google_translate:
+      errors:
+        no_api_key: Set Google API key via GOOGLE_TRANSLATE_API_KEY environment variable or translation.api_key
+          in config/i18n-tasks.yml. Get the key at https://code.google.com/apis/console.
+        no_results: 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.
+    missing:
+      details_title: Value in other locales or source
+      none: No translations are missing.
+    remove_unused:
+      confirm:
+        one: "%{count} translation will be removed from %{locales}."
+        other: "%{count} translation will be removed from %{locales}."
+      noop: No unused keys to remove
+      removed: Removed %{count} keys
+    translate_missing:
+      translated: Translated %{count} keys
+    unused:
+      none: Every translation is in use.
+    usages:
+      none: No key usages found.

data/config/locales/ru.yml

@@ -21,7 +21,7 @@ ru:
           out_format: "Формат вывода: %{valid_text}. %{default_text}."
           pattern_router: "Использовать pattern_router: ключи распределятся по файлам согласно data.write"
           strict: Не угадывать динамические использования ключей, например `t("category.#{category.key}")`
-          value: "Значение, интерполируется с %{value}, %{human_key}, %{value_or_human_key}"
+          value: "Значение, интерполируется с %{value}, %{human_key}, %{key}, %{default}, %{value_or_human_key}, %{value_or_default_or_human_key}"
       desc:
         add_missing: "добавить недостающие ключи к переводам"
         config: "показать конфигурацию"

data/i18n-tasks.gemspec

@@ -27,18 +27,19 @@ TEXT
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split($/)
-  s.files         -= s.files.grep(%r{^doc/img/})
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.files         -= s.files.grep(%r{^(doc/|\.|spec/)}) + %w(CHANGES.md config/i18n-tasks.yml Gemfile)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) } - %w(i18n-tasks.cmd)
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.add_dependency 'erubis'
   s.add_dependency 'activesupport', '>= 4.0.2'
   s.add_dependency 'easy_translate', '>= 0.5.0'
-  s.add_dependency 'term-ansicolor', '>= 1.3.2'
-  s.add_dependency 'terminal-table', '>= 1.5.1'
+  s.add_dependency 'erubis'
   s.add_dependency 'highline', '>= 1.7.3'
   s.add_dependency 'i18n'
+  s.add_dependency 'parser', '>= 2.2.2.6'
+  s.add_dependency 'term-ansicolor', '>= 1.3.2'
+  s.add_dependency 'terminal-table', '>= 1.5.1'
   s.add_development_dependency 'axlsx', '~> 2.0'
   s.add_development_dependency 'bundler', '~> 1.3'
   s.add_development_dependency 'rake'

data/lib/i18n/tasks/cli.rb

@@ -50,7 +50,7 @@ class I18n::Tasks::CLI
     base_task
     @commands ||= ::I18n::Tasks::Commands.cmds.dup.tap do |cmds|
       # Hash#transform_keys is only available since activesupport v4.0.0
-      cmds.keys.each { |k| cmds[k.to_s.tr('_', '-')] = cmds.delete(k) }
+      cmds.keys.each { |k| cmds[k.to_s.tr('_'.freeze, '-'.freeze)] = cmds.delete(k) }
     end
   end
 
@@ -64,7 +64,7 @@ class I18n::Tasks::CLI
     command = parse_command! argv
     options = optparse! command, argv
     parse_options! options, command, argv
-    [command.tr('-', '_'), options.update(arguments: argv)]
+    [command.tr('-'.freeze, '_'.freeze), options.update(arguments: argv)]
   end
 
   def optparse!(command, argv)
@@ -103,12 +103,14 @@ class I18n::Tasks::CLI
 
   def allow_help_arg_first!(argv)
     # allow `i18n-tasks --help command` in addition to `i18n-tasks command --help`
-    argv[0], argv[1] = argv[1], argv[0] if %w(-h --help).include?(argv[0]) && argv[1] && !argv[1].start_with?('-')
+    if %w(-h --help).include?(argv[0]) && argv[1] && !argv[1].start_with?('-'.freeze)
+      argv[0], argv[1] = argv[1], argv[0]
+    end
   end
 
   def parse_command!(argv)
     allow_help_arg_first! argv
-    if argv[0] && !argv[0].start_with?('-')
+    if argv[0] && !argv[0].start_with?('-'.freeze)
       if commands.keys.include?(argv[0])
         argv.shift
       else
@@ -162,7 +164,7 @@ class I18n::Tasks::CLI
   def parse_option(flag, val, argv, context)
     conf = flag.last.is_a?(Hash) ? flag.last : {}
     if conf[:consume_positional]
-      val = Array(val) + Array(flag.include?(Array) ? argv.flat_map { |x| x.split(',') } : argv)
+      val = Array(val) + Array(flag.include?(Array) ? argv.flat_map { |x| x.split(','.freeze) } : argv)
     end
     val = conf[:default] if val.nil? && conf.key?(:default)
     val = conf[:parser].call(val, context) if conf.key?(:parser)
@@ -170,7 +172,9 @@ class I18n::Tasks::CLI
   end
 
   def option_name(flag)
-    flag.detect { |f| f.start_with?('--') }.sub(/\A--(\[no-\])?/, '').sub(/[^\-\w].*\z/, '').to_sym
+    flag.detect { |f|
+      f.start_with?('--'.freeze)
+    }.sub(/\A--(\[no-\])?/, ''.freeze).sub(/[^\-\w].*\z/, ''.freeze).to_sym
   end
 
   def try_call(v)