i18n-tasks 0.3.9 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aeddb130b04e94eb44c9a80da3746896933e2272
-  data.tar.gz: 17f53cf4fe0015cfd6edf18613d7253ea2d61952
+  metadata.gz: 601f3e2a8ac21ec9d8f83aa71f5723623b109f69
+  data.tar.gz: 5a9396e63a232357fd63d1d260a80ddfd274dea4
 SHA512:
-  metadata.gz: 690d937228ea48e53dbc4bb690b04af94e39b1c9d843e163f00f3a96b2377d86727f4e0e2bb277fb9d49677371fe5f17fb1feeb2a88f569d9a20f1acb3534901
-  data.tar.gz: ce79dd5249253f465be6fd14f7a0af74b5d44fbea2e61027a4b4e290fc90ee2838830cebdfe2106d55e1ce9fb646aaae6c3ba5cc5bcbe69d2c206d914830074d
+  metadata.gz: 80187dee2d375fbe01e79313c6d7bd24927c91da51c52b102661f7b13378547c16743b571c0ebdb7fd3d29d35777db48900ce66f5d23108069d6f06f0510ac7b
+  data.tar.gz: fe57c3b82c6d24c3d43c3203a184b21d99a04ec639d142aee38b1f336587d74308937ea9a7a33ac8a8a9b1d16296e83bf58e46749bbbbfb453a715cf0087924e

data/CHANGES.md

@@ -2,6 +2,11 @@
 
 * Fix regression: Remove ActiveSupport::HashWithIndifferentAccess from locale data output
 
+## 0.3.10
+
+* New (de)serialization options in config
+* `add-missing` placeholder argument can now use %{base_value}.
+
 ## 0.3.8
 
 * Fix activesupport ~3.x compatibility issue (#45).

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 platform :rbx do
   gem 'rubysl', '~> 2.0'
   gem 'rubysl-mutex_m', '~> 2.0'
+  gem 'psych'
   group :development do
     gem 'racc'
   end

data/README.md

@@ -1,4 +1,4 @@
-# i18n-tasks [![Build Status][badge-travis]][travis] [![Coverage Status][badge-coveralls]][coveralls] [![Code Climate][badge-code-climate]][code-climate] [![Flattr this][badge-flattr]][flattr]
+# i18n-tasks [![Build Status][badge-travis]][travis] [![Coverage Status][badge-coveralls]][coveralls] [![Code Climate][badge-code-climate]][code-climate] [![Gemnasium][badge-gemnasium]][gemnasium]
 
 i18n-tasks finds and manages missing and unused translations in your application.
 
@@ -7,7 +7,7 @@ If you use a key that does not exist, this will only blow up at runtime. Keys le
 in the resource files and introduce unnecessary overhead on the translators. Translation files can quickly turn to disarray.
 
 i18n-tasks improves this by using static analysis. It scans calls such as `I18n.t('some.key')` and provides reports on key usage, missing, and unused keys.
-It can also can pre-fill missing keys, including from Google Translate, and it can remove unused keys as well.
+It can also pre-fill missing keys, including from Google Translate, and it can remove unused keys as well.
 
 i18n-tasks can be used with any project using [i18n][i18n-gem] (default in Rails), or similar, even if it isn't ruby.
 
@@ -18,7 +18,7 @@ i18n-tasks can be used with any project using [i18n][i18n-gem] (default in Rails
 Add to Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.3.7'
+gem 'i18n-tasks', '~> 0.3.10'
 ```
 
 i18n-tasks does not load or execute any of the application's code but performs static-only analysic.
@@ -55,6 +55,8 @@ To add missing values to the base locale only:
 ```bash
 # most task accept locales as first argument. `base` and `all` are special
 i18n-tasks add-missing base
+# add-missing accepts a placeholder argument, with optional base_value interpolation
+i18n-tasks add-missing -p 'PLEASE-TRANSLATE %{base_value}' fr
 ```
 
 Translate missing values with Google Translate ([more below on the API key](#translation-config)).
@@ -142,6 +144,11 @@ data:
     - ['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
 ```
 
 #### Key pattern syntax
@@ -254,23 +261,23 @@ You might want to test for missing and unused translations as part of your test
 This is how you can do it with rspec:
 
 ```ruby
-# spec/i18n_keys_spec.rb:
+# spec/i18n_spec.rb:
 require 'spec_helper'
-
 require 'i18n/tasks'
 
-describe 'Translation keys'  do
+describe 'I18n' do
   let(:i18n) { I18n::Tasks::BaseTask.new }
 
-  it 'are all present' do
-    expect(i18n.missing_keys).to have(0).keys
+  it 'does not have missing keys' do
+    count = i18n.missing_keys.count
+    fail "There are #{count} missing i18n keys! Run 'i18n-tasks missing' for more details." unless count.zero?
   end
 
-  it 'are all used' do
-    expect(i18n.unused_keys).to have(0).keys
+  it 'does not have unused keys' do
+    count = i18n.unused_keys.count
+    fail "There are #{count} unused i18n keys! Run 'i18n-tasks unused' for more details." unless count.zero?
   end
 end
-
 ```
 
 ## XLSX
@@ -292,12 +299,12 @@ This was originally developed for [Zuigo](http://zuigo.com/), a platform to orga
 
 [MIT license]: /LICENSE.txt
 [travis]: https://travis-ci.org/glebm/i18n-tasks
-[badge-travis]: https://travis-ci.org/glebm/i18n-tasks.png?branch=master
+[badge-travis]: http://img.shields.io/travis/glebm/i18n-tasks.svg
 [coveralls]: https://coveralls.io/r/glebm/i18n-tasks?branch=master
-[badge-coveralls]: https://coveralls.io/repos/glebm/i18n-tasks/badge.png?branch=master
+[badge-coveralls]: http://img.shields.io/coveralls/glebm/i18n-tasks.svg
+[gemnasium]: https://gemnasium.com/glebm/i18n-tasks
+[badge-gemnasium]: https://gemnasium.com/glebm/i18n-tasks.svg
 [code-climate]: https://codeclimate.com/github/glebm/i18n-tasks
-[badge-code-climate]: https://codeclimate.com/github/glebm/i18n-tasks.png
-[badge-flattr]: https://api.flattr.com/button/flattr-badge-large.png
-[flattr]: https://flattr.com/submit/auto?user_id=glebm&url=https%3A%2F%2Fgithub.com%2Fglebm%2Fi18n-tasks
+[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"

data/bin/i18n-tasks

@@ -4,21 +4,30 @@ require 'i18n/tasks'
 require 'i18n/tasks/commands'
 require 'slop'
 
+err = proc { |message, exit_code|
+  STDERR.puts Term::ANSIColor.yellow('i18n-tasks: ' + message)
+  exit exit_code
+}
+
 command = nil
-slop    = Slop.parse(help: true) do
-  on('-v', '--version', 'Print the version') {
-    puts I18n::Tasks::VERSION
-    exit
-  }
-  ::I18n::Tasks::Commands.cmds.each do |name, attr|
-    command name.tr('_', '-') do
-      description attr.desc if attr.desc
-      instance_exec(&attr.opts) if attr.opts
-      run do |opts, args|
-        command = [name, opts, args]
+begin
+  slop = Slop.parse(help: true) do
+    on('-v', '--version', 'Print the version') {
+      puts I18n::Tasks::VERSION
+      exit
+    }
+    ::I18n::Tasks::Commands.cmds.each do |name, attr|
+      command name.tr('_', '-') do
+        description attr.desc if attr.desc
+        instance_exec(&attr.opts) if attr.opts
+        run do |opts, args|
+          command = [name, opts, args]
+        end
       end
     end
   end
+rescue Slop::Error => e
+  err.call(e.message, 64)
 end
 
 if command
@@ -40,7 +49,5 @@ if command
     # i18n-tasks missing | head
   end
 else
-  STDERR.puts Term::ANSIColor.red "Command unknown: #{ARGV[0]}" if ARGV[0]
-  puts slop.help
-  exit 64
+  err.call("Command unknown: #{ARGV[0]}", 64) if ARGV[0]
 end

data/lib/i18n/tasks/commands.rb

@@ -11,7 +11,7 @@ module I18n::Tasks
     desc 'show missing translations'
     opts do
       on '-l', :locales=, 'Filter by locale (default: all)', on_locale_opt
-      on '-t', :types, 'Filter by type (types: missing_from_base, eq_base, missing_from_locale)', as: Array, delimiter: /[+:,]/, argument: true, optional: false
+      on '-t', :types=, 'Filter by type (types: missing_from_base, eq_base, missing_from_locale)', as: Array, delimiter: /[+:,]/
     end
     cmd :missing do |opt = {}|
       parse_locales! opt
@@ -25,8 +25,8 @@ module I18n::Tasks
 
     desc 'translate missing keys with Google Translate'
     opts do
-      on '-l', :locales, 'Locales to translate (default: all)', on_locale_opt
-      on '-f', :from, 'Locale to translate from (default: base)', default: 'base', argument: true, optional: false
+      on '-l', :locales=, 'Locales to translate (default: all)', on_locale_opt
+      on '-f', :from=, 'Locale to translate from (default: base)', default: 'base', argument: true, optional: false
     end
     cmd :translate_missing do |opt = {}|
       opt[:from] = base_locale if opt[:from].blank? || opt[:from] == 'base'
@@ -36,21 +36,30 @@ module I18n::Tasks
 
     desc 'add missing keys to the locales'
     opts do
-      on '-l', :locales, 'Locales to add keys into (default: all)', on_locale_opt
-      on '-p', :placeholder, 'Value for empty keys (default: base value or key.humanize)', argument: true, optional: false
+      on '-l', :locales=, 'Locales to add keys into (default: all)', on_locale_opt
+      on '-p', :placeholder=, 'Value for empty keys (default: base value or key.humanize)', argument: true, optional: false
     end
     cmd :add_missing do |opt = {}|
       parse_locales! opt
       opt[:value] ||= opt.delete(:placeholder) || proc { |key, locale|
         # default to base value or key.humanize
-        locale == base_locale && t(locale, base_locale) || key.split('.').last.to_s.humanize
+        locale != base_locale && t(key, base_locale) || key.split('.').last.to_s.humanize
       }
+
+      v = opt[:value]
+      if v.is_a?(String) && v.include?('%{base_value}')
+        opt[:value] = proc { |key, locale|
+          base_value = t(key, base_locale) || ''
+          v % {base_value: base_value}
+        }
+      end
+
       i18n_task.fill_missing_value opt
     end
 
     desc 'show where the keys are used in the code'
     opts do
-      on '-p', :pattern, 'Show only keys matching pattern', argument: true, optional: false
+      on '-p', :pattern=, 'Show only keys matching pattern', argument: true, optional: false
     end
     cmd :find do |opt = {}|
       opt[:filter] ||= opt.delete(:pattern) || opt[:arguments].try(:first)
@@ -95,7 +104,7 @@ module I18n::Tasks
 
     desc 'save missing and unused translations to an Excel file'
     opts do
-      on :path, 'Destination path', default: 'tmp/i18n-report.xlsx'
+      on :path=, 'Destination path', default: 'tmp/i18n-report.xlsx'
     end
     cmd :xlsx_report do |opt = {}|
       begin

data/lib/i18n/tasks/data/adapter/json_adapter.rb

@@ -7,13 +7,13 @@ module I18n::Tasks
         extend self
 
         # @return [Hash] locale tree
-        def parse(str)
-          JSON.parse(str)
+        def parse(str, opts)
+          JSON.parse(str, opts || {})
         end
 
         # @return [String]
-        def dump(tree)
-          JSON.generate(tree)
+        def dump(tree, opts)
+          JSON.generate(tree, opts || {})
         end
 
       end

data/lib/i18n/tasks/data/adapter/yaml_adapter.rb

@@ -6,13 +6,13 @@ module I18n::Tasks
         extend self
 
         # @return [Hash] locale tree
-        def parse(str)
-          YAML.load(str)
+        def parse(str, options)
+          YAML.load(str, options || {})
         end
 
         # @return [String]
-        def dump(tree)
-          tree.to_yaml
+        def dump(tree, options)
+          tree.to_yaml(options || {})
         end
 
       end

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

@@ -12,29 +12,31 @@ module I18n
 
         protected
 
-        def load_file(file)
-          adapter_for(file).parse(
-              ::File.read(file)
-          )
+        def load_file(path)
+          adapter_name, adapter_pattern, adapter = adapter_for(path)
+          adapter_options = (config[adapter_name] || {})[:read]
+          adapter.parse(::File.read(path), adapter_options)
         end
 
         def write_tree(path, tree)
           ::File.open(path, 'w') { |f|
-            f.write(adapter_for(path).dump(tree.to_hash))
+            adapter_name, adapter_pattern, adapter = adapter_for(path)
+            adapter_options = (config[adapter_name] || {})[:write]
+            f.write(adapter.dump(tree.to_hash, adapter_options))
           }
         end
 
         module ClassMethods
           # @param pattern [String] File.fnmatch pattern
           # @param adapter [responds to parse(string)->hash and dump(hash)->string]
-          def register_adapter(pattern, adapter)
-            (@fn_patterns ||= {})[pattern] = adapter
+          def register_adapter(name, pattern, adapter)
+            (@fn_patterns ||= []) << [name, pattern, adapter]
           end
 
           def adapter_for(path)
-            @fn_patterns.detect { |pattern, adapter|
+            @fn_patterns.detect { |(name, pattern, adapter)|
               ::File.fnmatch(pattern, path)
-            }[1] or raise "Adapter not found for #{path}. Registered adapters: #{@fn_patterns.inspect}"
+            } or raise "Adapter not found for #{path}. Registered adapters: #{@fn_patterns.inspect}"
           end
         end
       end

data/lib/i18n/tasks/data/file_system.rb

@@ -5,8 +5,8 @@ require 'i18n/tasks/data/adapter/yaml_adapter'
 module I18n::Tasks
   module Data
     class FileSystem < FileSystemBase
-      register_adapter '*.yml', Adapter::YamlAdapter
-      register_adapter '*.json', Adapter::JsonAdapter
+      register_adapter :yaml, '*.yml', Adapter::YamlAdapter
+      register_adapter :json, '*.json', Adapter::JsonAdapter
     end
   end
 end

data/lib/i18n/tasks/version.rb

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

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

@@ -1,7 +1,7 @@
 p #{t('ca.a')} #{t 'ca.b'} #{t "ca.c"}
 p #{t 'ca.d'} #{t 'ca.f', i: 'world'} #{t 'ca.e', i: 'world'}
 p #{t 'missing_in_es.a'} #{t 'same_in_es.a'} #{t 'blank_in_es.a'}
-p = t 'used_but_missing.a'
+p = t 'used_but_missing.key'
 p = t 'x', scope: 'scoped'
 p = t 'x', scope: [:very, :scoped]
 p = t 'x', scope: [:scoped, code]

data/spec/fixtures/config/i18n-tasks.yml

@@ -14,6 +14,9 @@ data:
     - ['devise.*', 'config/locales/devise.%{locale}.yml']
     # default catch-all (same as ['*', 'config/locales/%{locale}.yml'])
     - 'config/locales/%{locale}.yml'
+  yaml:
+    write:
+      line_width: -1
 
 # i18n usage search in source
 search:

data/spec/i18n_tasks_spec.rb

@@ -8,7 +8,7 @@ describe 'i18n-tasks' do
 
   describe 'missing' do
     let (:expected_missing_keys) {
-      %w( en.used_but_missing.a en.relative.index.missing
+      %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 )
@@ -76,13 +76,23 @@ describe 'i18n-tasks' do
   end
 
   describe 'add_missing' do
-    it 'default placeholder' do
+    it 'default placeholder: key.humanize for base_locale' do
       in_test_app_dir {
         expect(YAML.load_file('config/locales/en.yml')['en']['used_but_missing']).to be_nil
       }
       run_cmd :add_missing, locales: 'base'
       in_test_app_dir {
-        expect(YAML.load_file('config/locales/en.yml')['en']['used_but_missing']['a']).to eq 'A'
+        expect(YAML.load_file('config/locales/en.yml')['en']['used_but_missing']['key']).to eq 'Key'
+      }
+    end
+
+    it 'default placeholder: base_value for non-base locale' do
+      in_test_app_dir {
+        expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']).to be_nil
+      }
+      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'
       }
     end
 
@@ -97,6 +107,16 @@ describe 'i18n-tasks' do
         expect(YAML.load_file('config/locales/devise.es.yml')['es']['devise']['a']).to eq 'ES_TEXT'
       }
     end
+
+    it 'placeholder: value with base_value' do
+      in_test_app_dir {
+        expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']).to be_nil
+      }
+      run_cmd :add_missing, locales: 'all', placeholder: 'TRME %{base_value}'
+      in_test_app_dir {
+        expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']['a']).to eq 'TRME EN_TEXT'
+      }
+    end
   end
 
   describe 'config' do

metadata

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