i18n-tasks 0.3.10 → 0.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 601f3e2a8ac21ec9d8f83aa71f5723623b109f69
-  data.tar.gz: 5a9396e63a232357fd63d1d260a80ddfd274dea4
+  metadata.gz: 84ba1f92ba2da94773501e168515c76c3c6c21ab
+  data.tar.gz: 5d72ea2de6df682ab6f57b8f76d051f6d8b0f3e8
 SHA512:
-  metadata.gz: 80187dee2d375fbe01e79313c6d7bd24927c91da51c52b102661f7b13378547c16743b571c0ebdb7fd3d29d35777db48900ce66f5d23108069d6f06f0510ac7b
-  data.tar.gz: fe57c3b82c6d24c3d43c3203a184b21d99a04ec639d142aee38b1f336587d74308937ea9a7a33ac8a8a9b1d16296e83bf58e46749bbbbfb453a715cf0087924e
+  metadata.gz: 46efbb3c38b02738ee34069bc4d9384603485f5f0aeba4227139596ce7bd383cb5c9b9b2f98ddadacd9c1c28bec47170e137f02856d2b4de56a7d724ab853a76
+  data.tar.gz: a8b7a4968b32960205152674040c913e4032d999ee90f2b48e789593c1f81cfef3264c5f747d34608246548dd9fbbaafb94e7b01f8b825849515f7cf802956b7

data/CHANGES.md

@@ -1,12 +1,16 @@
-## 0.3.9
+## 0.3.11
 
-* Fix regression: Remove ActiveSupport::HashWithIndifferentAccess from locale data output
+* Improve plural key handling
 
 ## 0.3.10
 
 * New (de)serialization options in config
 * `add-missing` placeholder argument can now use %{base_value}.
 
+## 0.3.9
+
+* Fix regression: Remove ActiveSupport::HashWithIndifferentAccess from locale data output
+
 ## 0.3.8
 
 * Fix activesupport ~3.x compatibility issue (#45).

data/README.md

@@ -49,6 +49,8 @@ Available commands:
 See `<command> --help` for more information on a specific command.
 ```
 
+#### Add missing keys
+
 You can add missing values, generated from the key (for base locale) or copied from the base locale (for other locales).
 To add missing values to the base locale only:
 
@@ -59,6 +61,8 @@ i18n-tasks add-missing base
 i18n-tasks add-missing -p 'PLEASE-TRANSLATE %{base_value}' fr
 ```
 
+#### Google Translate missing keys
+
 Translate missing values with Google Translate ([more below on the API key](#translation-config)).
 
 ```bash
@@ -67,37 +71,38 @@ i18n-tasks translate-missing
 i18n-tasks translate-missing --from base es fr
 ```
 
-Sort the keys and write them to their respective files with `normalize`.
-This always happens on `add-missing` and `translate-missing`.
+Sort the keys and write them to their respective files with `i18n-tasks normalize`.
+This always happens on `i18n-tasks add-missing` and `i18n-tasks translate-missing`.
 
 ```bash
 i18n-tasks normalize
 ```
 
-See exactly where the keys are used with `find`:
+#### Find usages
+
+See where the keys are used with `i18n-tasks find`:
 
 ```bash
-# Show all usages of all keys
-i18n-tasks find
-# Filter by a key pattern
+i18n-tasks find common.help
 i18n-tasks find 'auth.*'
 i18n-tasks find '{number,currency}.format.*'
 ```
 
 ![i18n-screenshot][screenshot-find]
 
-Relative keys (`t '.title'`) and plural keys (key.one/many/other/etc) are fully supported.
+#### Features
 
-Scope argument is supported, but only when it is the first keyword argument ([this](/lib/i18n/tasks/scanners/pattern_with_scope_scanner.rb) can be improved):
+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)):
 
-```ruby
-# this is supported
-t :invalid, scope: [:auth, :password], attempts: 5
-# but not this
-t :invalid, attempts: 5, scope: [:auth, :password]
-```
+    ```ruby
+    # this is supported
+    t :invalid, scope: [:auth, :password], attempts: 5
+    # but not this
+    t :invalid, attempts: 5, scope: [:auth, :password]
+    ```
 
-Unused report will detect pattern translations and not report them, e.g.:
+Unused report will detect certain dynamic key forms and not report them, e.g.:
 
 ```ruby
 t 'category.' + category.key      # all 'category.*' keys are considered used
@@ -128,27 +133,38 @@ The default data adapter supports YAML and JSON files.
 
 ```yaml
 # config/i18n-tasks.yml
-# i18n data storage
 data:
-  # file_system is the default adapter, you can provide a custom class name here:
-  adapter: file_system
+  # configure YAML / JSON serializer options
+  # passed directly to load / dump / parse / serialize.
+  yaml:
+    write:
+      # do not wrap lines at 80 characters (override default)
+      line_width: -1
+```
+
+#### Multiple locale files
+
+Use `data.read` and `data.write` options to work with locale data spread over multiple files.
+
+```
+# config/i18n-tasks.yml
+data:
   # a list of file globs to read from per-locale
-  read: 
-    # default:
-    - 'config/locales/%{locale}.yml'
-    # to also read from namespaced files, e.g. simple_form.en.yml:
+  read:
+    # read from namespaced files, e.g. simple_form.en.yml
     - 'config/locales/*.%{locale}.yml'
+    # read from a gem (config is parsed with ERB first, then YAML)
+    - "<%= %x[bundle show vagrant].chomp %>/templates/locales/%{locale}.yml"
+    # default
+    - 'config/locales/%{locale}.yml'
   # a list of {key pattern => file} routes, matched top to bottom
   write:
-    # save all devise keys in it's own file (per locale):
-    - ['devise.*', 'config/locales/devise.%{locale}.yml']
-    # default catch-all:
-    - 'config/locales/%{locale}.yml' # path is short for ['*', path]
-  # configure YAML / JSON serializer options (when using the default adapter)
-  yaml:
-    write:
-      # do not wrap lines at 80 characters (default)
-      line_width: -1
+    # write models.* and views.* keys to the respective files
+    - ['{models,views}.*', 'config/locales/\1.%{locale}.yml']
+    # or, write every top-level key namespace to its own file
+    - ['{:}.*', 'config/locales/\1.%{locale}.yml']
+    # default, sugar for ['*', path]
+    - 'config/locales/%{locale}.yml'
 ```
 
 #### Key pattern syntax
@@ -159,16 +175,16 @@ data:
 |      `:`     | matches a single key                                      |
 |   `{a, b.c}` | match any in set, can use `:` and `*`, match is captured  |
 
-Example:
+#### Custom adapters
+
+If you store data somewhere but in the filesystem, e.g. in the database or mongodb, you can implement a custom adapter.
+Implement [a handful of methods][adapter-example], then set `data.adapter` to the class name; the rest of the `data` config is passed to the initializer.
 
 ```yaml
 # config/i18n-tasks.yml
 data:
-  write:
-    # store sorcery and simple_form keys in the respective files:
-    - ['{sorcery,simple_form}.*', 'config/locales/\1.%{locale}.yml']
-    # write every key namespace to its own file:
-    - ['{:}.*', 'config/locales/\1.%{locale}.yml']
+  # file_system is the default adapter, you can provide a custom class name here:
+  adapter: file_system
 ```
 
 ### Usage search
@@ -308,3 +324,4 @@ This was originally developed for [Zuigo](http://zuigo.com/), a platform to orga
 [badge-code-climate]: http://img.shields.io/codeclimate/github/glebm/i18n-tasks.svg
 [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"
+[adapter-example]: https://github.com/glebm/i18n-tasks/blob/master/lib/i18n/tasks/data/file_system_base.rb

data/lib/i18n/tasks/data/locale_tree.rb

@@ -69,7 +69,7 @@ module I18n::Tasks
         end
 
         def list_to_tree_data(list)
-          key_values = list.sort
+          key_values = list.sort_by(&:first)
           tree_data  = {}
           key_values.each do |key, value|
             key_segments            = key.to_s.split('.')

data/lib/i18n/tasks/missing_keys.rb

@@ -42,8 +42,10 @@ module I18n::Tasks
       @keys_missing_from_locale         ||= {}
       @keys_missing_from_locale[locale] ||= begin
         keys = data[base_locale].traverse_map_if { |key, base_value|
-          key if !ignore_key?(key, :missing) && !key_value?(key, locale) && !key_value?(depluralize_key(key), locale)
-        }
+          next if ignore_key?(key, :missing)
+          key = depluralize_key(key, locale)
+          key if !key_value?(key, locale)
+        }.uniq
         KeyGroup.new keys, type: :missing_from_locale, locale: locale
       end
     end

data/lib/i18n/tasks/plural_keys.rb

@@ -4,11 +4,11 @@ module I18n::Tasks::PluralKeys
   # @param [String] key i18n key
   # @param [String] locale to pull key data from
   # @return the base form if the key is a specific plural form (e.g. apple for apple.many), and the key as passed otherwise
-  def depluralize_key(locale = base_locale, key)
+  def depluralize_key(key, locale = base_locale)
     return key if key !~ PLURAL_KEY_RE || t(key, locale).is_a?(Hash)
     parent_key      = key.split('.')[0..-2] * '.'
-    plural_versions = t(parent_key, locale)
-    if plural_versions.is_a?(Hash) && plural_versions.all? { |k, v| ".#{k}" =~ PLURAL_KEY_RE && !v.is_a?(Hash) }
+    plural_versions = t(parent_key, locale) || (locale != base_locale && t(parent_key, base_locale))
+    if plural_versions.is_a?(Hash) && plural_versions.all? { |k, v| !v.is_a?(Hash) && ".#{k}" =~ PLURAL_KEY_RE }
       parent_key
     else
       key

data/lib/i18n/tasks/unused_keys.rb

@@ -10,7 +10,7 @@ module I18n
         @unused_keys[locale] ||= begin
           keys = data[locale].traverse_map_if { |key, value|
             next if used_in_expr?(key) || ignore_key?(key, :unused)
-            key = depluralize_key(locale, key)
+            key = depluralize_key(key, locale)
             [key, value] unless used_key?(key)
           }.uniq
           KeyGroup.new keys, locale: locale, type: :unused
@@ -22,7 +22,7 @@ module I18n
         unused  = unused_keys
         locales.each do |locale|
           used_key_values = data[locale].traverse_map_if { |key, value|
-            [key, value] unless unused.include?(depluralize_key(locale, key))
+            [key, value] unless unused.include?(depluralize_key(key, locale))
           }
           data[locale] = used_key_values
         end

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Tasks
-    VERSION = '0.3.10'
+    VERSION = '0.3.11'
   end
 end

data/spec/fixtures/app/views/index.html.slim

@@ -12,6 +12,8 @@ p = t 'ignore_eq_base_all.a'
 p = t 'ignore_eq_base_es.a'
 p = t 'numeric.a'
 p = t 'plural.a', count: 2
+p = t 'missing_in_es_plural_1.a', count: 2
+p = t 'missing_in_es_plural_2.a', count: 2
 p = t 'devise.a'
 p = t :missing_symbol_key
 p #{t :"missing_symbol.key_two"} #{t :'missing_symbol.key_three'}

data/spec/i18n_tasks_spec.rb

@@ -11,7 +11,8 @@ describe 'i18n-tasks' do
       %w( en.used_but_missing.key en.relative.index.missing
           es.missing_in_es.a es.blank_in_es.a es.same_in_es.a
           en.hash.pattern_missing.a en.hash.pattern_missing.b
-          en.missing_symbol_key en.missing_symbol.key_two en.missing_symbol.key_three )
+          en.missing_symbol_key en.missing_symbol.key_two en.missing_symbol.key_three
+          es.missing_in_es_plural_1.a es.missing_in_es_plural_2.a)
     }
     it 'detects missing or identical' do
       capture_stderr do
@@ -93,6 +94,7 @@ describe 'i18n-tasks' do
       run_cmd :add_missing, locales: 'es'
       in_test_app_dir {
         expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']['a']).to eq 'EN_TEXT'
+        expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es_plural_1']['a']['one']).to eq 'EN_TEXT'
       }
     end
 
@@ -155,6 +157,8 @@ TXT
         'unused'              => {'a' => v, 'numeric' => v_num, 'plural' => {'one' => v, 'other' => v}},
         'ignore_unused'       => {'a' => v},
         'missing_in_es'       => {'a' => v},
+        'missing_in_es_plural_1' => { 'a' => {'one' => v, 'other' => v}},
+        'missing_in_es_plural_2' => { 'a' => {'one' => v, 'other' => v}},
         'same_in_es'          => {'a' => v},
         'ignore_eq_base_all'  => {'a' => v},
         'ignore_eq_base_es'   => {'a' => v},
@@ -179,7 +183,8 @@ TXT
     }
 
     en_data = gen_data.('EN_TEXT')
-    es_data = gen_data.('ES_TEXT').except('missing_in_es')
+    es_data = gen_data.('ES_TEXT').except(
+        'missing_in_es', 'missing_in_es_plural_1', 'missing_in_es_plural_2')
     es_data['same_in_es']['a']  = 'EN_TEXT'
     es_data['blank_in_es']['a'] = ''
     es_data['ignore_eq_base_all']['a'] = 'EN_TEXT'

data/spec/plural_keys_spec.rb

@@ -33,7 +33,7 @@ describe 'Plural keys' do
     end
 
     def depluralize(key)
-      task.depluralize_key('en', key)
+      task.depluralize_key(key, 'en')
     end
   end
 

data/spec/support/i18n_tasks_output_matcher.rb

@@ -26,7 +26,7 @@ RSpec::Matchers.define :be_i18n_keys do |expected|
   end
 
   match do |actual|
-    extract_keys(actual).should =~ expected
+    extract_keys(actual).sort.should == expected.sort
   end
 
   failure_message_for_should do |actual|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.3.11
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-13 00:00:00.000000000 Z
+date: 2014-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis