i18n-tasks 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ace77283059f5ec38fb4cf6eb85d51fa72ee175f
-  data.tar.gz: 2a9dc502ce2169a6c0e31a100346ff8ce8602c95
+  metadata.gz: a0d5a6d44abbe13489dbf413f1fe2934f96ac3ec
+  data.tar.gz: b73c633dbb50493e77f248a4d019473d38920c6e
 SHA512:
-  metadata.gz: fbb5e12fdd92b788e8f88fd755195bc7d6040e22221b7d7087d16e5d011bfae89109a6fe425fbcdab4d264955ddcd5c2877f17e66ebd663396f48aa3faeabead
-  data.tar.gz: bcf27a97b3fee099d9c1826f69e892060518e0fcc4d84ae89f64a4f638300e9faa4b6504396ddfe558153a1f689ecb21f6b683c581789354772dc38da275c662
+  metadata.gz: 33f1b9a719ad5a1127be44b0513aa9e0f2cd46598c2d855c46be9fbb9e488164c4eacddbd0d7ef0da28e4db7ffd922162770d8dbe883acdb45cf5d8d44dfb28b
+  data.tar.gz: 625b026add3aa686380a485df1f1db04ab450092eac690d793eb0293f237752c823702164ec13e662a3d7e4d5717a0dd840bfebe41d65f796f97abacd58bef12

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.7.4
+
+* Fix `add-missing --help`
+* Fix a minor issue with `health` #88(https://github.com/glebm/i18n-tasks/issues/88)
+
 ## 0.7.3
 
 * New task `translate-tree`

data/README.md

@@ -25,7 +25,7 @@ i18n-tasks can be used with any project using [i18n][i18n-gem] (default in Rails
 Add to Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.7.3'
+gem 'i18n-tasks', '~> 0.7.4'
 ```
 
 Copy default [configuration file](#configuration) (optional):
@@ -46,7 +46,7 @@ Run `i18n-tasks` to get the list of all the tasks with short descriptions.
 
 ### Check health
 
-`i18n-tasks health` will tell you any keys are missing or not used:
+`i18n-tasks health` checks if any keys are missing or not used:
 
 ```console
 $ i18n-tasks health
@@ -60,26 +60,23 @@ Add missing keys with placeholders (base value or humanized key):
 $ i18n-tasks add-missing
 ```
 
-Most tasks also accept arguments:
+This and other tasks accept arguments:
 
 ```console
 $ i18n-tasks add-missing -v 'TRME %{value}' fr
-$ 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}
-    -h, --help         Display this help message.
 ```
 
-`i18n-tasks` also provides low-level composable tasks for fine-grained locale data manipulation. The above is equivalent to:
+Pass `--help` for more information:
 
 ```console
-$ i18n-tasks missing -fyaml fr | i18n-tasks tree-set-value 'TRME %{value}' | i18n-tasks data-merge
+$ 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}.
+    -h, --help     Display this help message.
 ```
 
-See command help for more information.
-
 ### Google Translate missing keys
 
 Translate missing values with Google Translate ([more below on the API key](#translation-config)).
@@ -109,15 +106,9 @@ $ i18n-tasks unused
 $ i18n-tasks remove-unused
 ```
 
-These tasks will infer dynamic key usage such as `t("category.\#{category.name}")` by default.
+These tasks will infer [dynamic keys](#dynamic-keys) such as `t("category.\#{category.name}")` by default.
 Pass `-s` or `--strict` to disable this feature.
 
-`i18n-tasks remove-unused` is roughly equivalent to:
-
-```bash
-$ i18n-tasks unused -fyaml | i18n-tasks data-remove
-```
-
 ### Normalize data
 
 Sort the keys:
@@ -132,26 +123,57 @@ Sort the keys, and move them to the respective files as defined by (`config.writ
 $ i18n-tasks normalize -p
 ```
 
-### Features
+### Compose tasks
 
-Relative keys (`t '.title'`) and plural keys (`key.{one,many,other,...}`) are fully supported.
-Scope argument is supported, but only when it is the first keyword argument ([improvements welcome](/lib/i18n/tasks/scanners/pattern_with_scope_scanner.rb)):
+`i18n-tasks` also provides composable tasks for reading, writing and manipulating locale data.
 
-```ruby
-# this is supported
-t :invalid, scope: [:auth, :password], attempts: 5
-# but not this
-t :invalid, attempts: 5, scope: [:auth, :password]
+For example, `add-missing` implemented with `missing`, `tree-set-value` and `data-merge`:
+
+```console
+$ i18n-tasks missing -fyaml fr | i18n-tasks tree-set-value 'TRME %{value}' | i18n-tasks data-merge
+```
+
+Another example, `remove-unused` implemented with `unused` and `data-remove`:
+
+```bash
+$ i18n-tasks unused -fyaml | i18n-tasks data-remove
 ```
 
-Unused report will detect certain dynamic key forms and not report them, e.g.:
+See the full list of tasks with `i18n-tasks --help`.
+
+### Features and limitations
+
+#### Relative keys
+
+`i18n-tasks` offers partial 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.
+
+✘ Keys relative to `controller.action_name` in Rails controllers are not supported.
+
+#### Plural keys
+
+✔ Plural keys, such as `key.{one,many,other,...}` are fully supported.
+
+#### `t()` keyword arguments
+
+✔ `scope` keyword argument is supported, but only when it is the first argument.
+
+✘ `default` and other arguments are not supported.
+
+Parsing keyword arguments correctly with Regexp is difficult. This can be improved with an s-expression parser.
+
+#### 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 are considered used
-t "category.#{category.key}.name" # all 'category.*.name' keys are considered used
+t 'category.' + category.key      # all 'category.:' keys considered used (: denotes one key segment)
+t "category.#{category.key}.name" # all 'category.:.name' keys considered used
 ```
 
-Translation data storage, key usage search, and other [settings](#configuration) are compatible with Rails by default.
+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.
 
 ## Configuration
 
@@ -164,6 +186,8 @@ Install the default config file with:
 $ cp $(i18n-tasks gem-path)/templates/config/i18n-tasks.yml config/
 ```
 
+Settings are compatible with Rails by default.
+
 ### Locales
 
 By default, `base_locale` is set to `en` and `locales` are inferred from the paths to data files.
@@ -389,8 +413,8 @@ Add a custom task like the ones defined by the gem:
 # my_commands.rb
 class MyCommands
   include ::I18n::Tasks::Command::Collection
-  cmd :my_command, desc: 'my custom command'
-  def my_command(opts = {})
+  cmd :my_task, desc: 'my custom task'
+  def my_task(opts = {})
   end
 end
 ```

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

@@ -38,7 +38,7 @@ module I18n::Tasks
             args: '[locale ...]',
             desc: proc { I18n.t('i18n_tasks.cmd.desc.add_missing') },
             opt:  cmd_opts(:locales, :out_format) <<
-                      cmd_opt(:value).merge(desc: "#{cmd_opt(:value)[:desc]}. #{I18n.t('i18n_tasks.cmd.args.default_text', value: DEFAULT_ADD_MISSING_VALUE)}")
+                      cmd_opt(:value).merge(desc: proc { "#{cmd_opt(:value)[:desc].call}. #{I18n.t('i18n_tasks.cmd.args.default_text', value: DEFAULT_ADD_MISSING_VALUE)}" })
 
         def add_missing(opt = {})
           forest = i18n.missing_keys(opt).set_each_value!(opt[:value] || DEFAULT_ADD_MISSING_VALUE)

data/lib/i18n/tasks/slop_command.rb

@@ -3,9 +3,10 @@ module I18n::Tasks::SlopCommand
 
   def slop_command(name, attr, &block)
     proc {
-      command name.tr('_', '-') do
+      cmd_name = name.tr('_', '-')
+      command cmd_name do
         args = attr[:args]
-        banner "Usage: i18n-tasks #{name} [options] #{args}" if args.present?
+        banner "Usage: i18n-tasks #{cmd_name} [options] #{args}" if args.present?
         desc = attr[:desc]
         desc = desc.call if desc.respond_to?(:call)
         description desc if desc

data/lib/i18n/tasks/stats.rb

@@ -12,7 +12,7 @@ module I18n::Tasks
             locale_count:     locale_count,
             per_locale_avg:   forest.inject(0) { |sum, f| sum + f.leaves.count } / locale_count,
             key_segments_avg: '%.1f' % (forest.leaves.inject(0) { |sum, node| sum + node.walk_to_root.count - 1 } / key_count.to_f),
-            value_chars_avg:  forest.leaves.inject(0) { |sum, node| sum + node.value.length } / key_count
+            value_chars_avg:  forest.leaves.inject(0) { |sum, node| sum + node.value.to_s.length } / key_count
         }
       end
     end

data/lib/i18n/tasks/version.rb

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

metadata

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