i18n-tasks 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a78b228c86e2754c4974f8312f0b8ae895c7418
-  data.tar.gz: c5e9356a3f3758bd1dd4a82c401460982698f479
+  metadata.gz: 68c94e2f16413ec396e24e366c2d22107423e5e4
+  data.tar.gz: 16680455229c39bbfd63b57e6ebeac977041ff98
 SHA512:
-  metadata.gz: 43bd0d3d15ce89ab8addc91f44b2661e51163eb61ae4200ba7f7afbbbd64c91f1b0acd07164a71391d4ff1e84a0d9264a314a118c529611c97feb95f01bac4ad
-  data.tar.gz: 3a8f419113d5ce08bec4e9a92fa2e75aa7d8ecca0de4b4f4d017c315cb97aa89c547c1435b1bb5394f8491cd025902beced940e56f27329f1392adba328809f6
+  metadata.gz: a5410cf4b6b5c92058a751fbde9302b8a0fb5c65e3d640e296b6148364ceba9e93eb4299ea07c84c911d7c616129115d3220c042c6e7d56af2bf20cc9d21e06e
+  data.tar.gz: fff053a40cc87b6c183930cda9b3db27849b94969cfaf32bec104bdf89015e3764d8eb6ca6997fba2c76d51ad994dae2d38302f57a353c281b6281e414bf61af

data/CHANGES.md

@@ -1,3 +1,7 @@
+## v0.3.3..v0.3.4
+
+* Bugfixes
+
 ## v0.3.2
 
 * Tasks that accept locales now accept them as the first argument(s)

data/README.md

@@ -1,12 +1,11 @@
-# i18n-tasks [![Build Status](https://travis-ci.org/glebm/i18n-tasks.png?branch=master)](https://travis-ci.org/glebm/i18n-tasks) [![Coverage Status](https://coveralls.io/repos/glebm/i18n-tasks/badge.png?branch=master)](https://coveralls.io/r/glebm/i18n-tasks?branch=master) [![Code Climate](https://codeclimate.com/github/glebm/i18n-tasks.png)](https://codeclimate.com/github/glebm/i18n-tasks) [![Flattr this](https://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=glebm&url=https%3A%2F%2Fgithub.com%2Fglebm%2Fi18n-tasks)
-
-The default model of i18n key management in frameworks such as Rails is broken.
+# i18n-tasks [![Build Status][badge-travis]][travis] [![Coverage Status][badge-coveralls]][coveralls] [![Code Climate][badge-code-climate]][code-climate] [![Flattr this][badge-flattr]][flattr]
 
+The basic approach to i18n key management in frameworks such as Rails is far from perfect.
 If you use a key that does not exist, this will only blow up at runtime. Keys left over from removed code accumulate
-in the resource files, introducing unnecessary overhead on the translators.
-Translation files can quickly turn to disarray.
+in the resource files, introducing unnecessary overhead on the translators. Translation files can quickly turn to disarray.
 
-i18n-tasks improves this by using static analysis.
+i18n-tasks improves this by using static analysis. It provides tasks to find and manage missing and unused translations.
+This information is inferred based on the keys the gem detects used with calls such as `I18n.t` when scanning the code.
 
 <img width="534" height="288" src="https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.png">
 
@@ -23,7 +22,7 @@ i18n-tasks improves this by using static analysis.
   ```yaml
   # config/i18n-tasks.yml
   base_locale: en
-  locales: [es, fr]
+  locales: [es, fr] # This includes base_locale by default
   ```
 
 ## Usage
@@ -84,7 +83,7 @@ i18n-tasks find 'auth.*'
 i18n-tasks find '{number,currency}.format.*'
 ```
 
-![i18n-screenshot](https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-usages.png "i18n-tasks find output screenshot")
+![i18n-screenshot][screenshot-find]
 
 Relative keys (`t '.title'`) and plural keys (key.one/many/other/etc) are fully supported.
 
@@ -120,7 +119,7 @@ so it is recommended to set locale settings explicitly:
 ```yaml
 # config/i18n-tasks.yml
 base_locale: en
-locales: [es, fr]
+locales: [es, fr] # This includes base_locale by default
 ```
 
 ### Storage
@@ -287,4 +286,13 @@ While i18n-tasks does not provide an HTML version of the report, you can add [on
 
 This was originally developed for [Zuigo](http://zuigo.com/), a platform to organize and discover events.
 
-[MIT license](/LICENSE.txt)
+[MIT license]: /LICENSE.txt
+[travis]: https://travis-ci.org/glebm/i18n-tasks
+[badge-travis]: https://travis-ci.org/glebm/i18n-tasks.png?branch=master
+[coveralls]: https://coveralls.io/r/glebm/i18n-tasks?branch=master
+[badge-coveralls]: https://coveralls.io/repos/glebm/i18n-tasks/badge.png?branch=master
+[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
+[screenshot-find]: https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-usages.png "i18n-tasks find output screenshot"

data/bin/i18n-tasks

@@ -24,14 +24,20 @@ end
 if command
   cmd  = ::I18n::Tasks::Commands.new
   meth = command[0]
-  if cmd.method(meth).arity == 0
+  opts = command[1].to_hash.reject{ |k, v| v.nil? }
+  args = command[2]
+
+  if opts.empty? && args.empty?
+    if ENV['VERBOSE']
+      STDERR.puts Term::ANSIColor.green "i18n-tasks: run #{meth.tr('_', '-')} without arguments"
+    end
     cmd.send meth
   else
-    opt = command[1].to_hash.merge(arguments: command[2])
+    opts = opts.merge(arguments: args) unless args.empty?
     if ENV['VERBOSE']
-      STDERR.puts Term::ANSIColor.green "i18n-tasks: #{meth.tr('_', '-')} #{opt.reject { |k, v| v.blank? }.map { |k, v| "#{k}=#{v}" } * ' '}"
+      STDERR.puts Term::ANSIColor.green "i18n-tasks: run #{meth.tr('_', '-')} with #{opts.map { |k, v| "#{k}=#{v}" } * ' '}"
     end
-    cmd.send meth, opt
+    cmd.send meth, opts
   end
 else
   STDERR.puts Term::ANSIColor.red "Command unknown: #{ARGV[0]}" if ARGV[0]

data/i18n-tasks.gemspec

@@ -8,10 +8,15 @@ Gem::Specification.new do |s|
   s.version       = I18n::Tasks::VERSION
   s.authors       = ['glebm']
   s.email         = ['glex.spb@gmail.com']
-  s.summary       = %q{Tasks to manage missing and unused translations in ruby applications using I18n.}
+  s.summary       = %q{Manage translations in ruby applications with the awesome power of static analysis — Edit}
   s.description   = %q{
-    rake tasks to find unused and missing translations, normalize locale files,
-    and prefill missing keys. Supports relative and plural keys and Google Translate.
+The basic approach to i18n key management in frameworks such as Rails has many flaws.
+
+If you use a key that does not exist, this will only blow up at runtime. Keys left over from removed code accumulate
+in the resource files, introducing unnecessary overhead on the translators.
+Translation files can quickly turn to disarray.
+
+i18n-tasks solves this problem with static analysis.
 }
   s.homepage      = 'https://github.com/glebm/i18n-tasks'
   if s.respond_to?(:metadata=)

data/lib/i18n/tasks/commands.rb

@@ -7,13 +7,14 @@ module I18n::Tasks
     include Term::ANSIColor
     require 'highline/import'
 
+    on_locale_opt = { as: Array, delimiter: /[+:,]/, default: 'all', argument: true, optional: false }
     desc 'show missing translations'
     opts do
-      on '-l', :locales=, 'Filter by locale', as: Array, delimiter: /[+:,]/, default: 'all', argument: true, optional: false
+      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
     end
     cmd :missing do |opt = {}|
-      opt[:locales] = locales_opt(opt[:arguments] || opt[:locales])
+      opt[:locales] = locales_opt_or_args(opt)
       terminal_report.missing_keys i18n_task.missing_keys(opt)
     end
 
@@ -24,22 +25,22 @@ module I18n::Tasks
 
     desc 'translate missing keys with Google Translate'
     opts do
-      on '-l', :locales, 'Only specified locales', as: Array, delimiter: /[+:,]/, default: 'all', 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'
-      opt[:locales] = locales_opt(opt[:arguments] || opt[:locales])
+      opt[:locales] = locales_opt_or_args(opt)
       i18n_task.fill_missing_google_translate opt
     end
 
     desc 'add missing keys to the locales'
     opts do
-      on '-l', :locales, 'Only for specified locales', as: Array, delimiter: /[+:,]/, default: 'all', 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 = {}|
-      opt[:locales] = locales_opt(opt[:arguments] || opt[:locales])
+      opt[:locales] = locales_opt_or_args(opt)
       opt[:value] ||= opt.delete(:placeholder)
       opt[:value] ||= proc { |key, locale|
         # default to base value or key.humanize
@@ -63,18 +64,18 @@ module I18n::Tasks
 
     desc 'normalize translation data: sort and move to the right files'
     opts do
-      on '-l', :locales=, 'Only for specified locales', as: Array, delimiter: /[+:,]/, default: 'all', argument: true, optional: false
+      on '-l', :locales=, 'Locales to normalize (default: all)', on_locale_opt
     end
     cmd :normalize do |opt = {}|
-      i18n_task.normalize_store! locales_opt(opt[:arguments] || opt[:locales])
+      i18n_task.normalize_store! locales_opt_or_args(opt)
     end
 
     desc 'remove unused keys'
     opts do
-      on '-l', :locales=, 'Only for specified locales', as: Array, delimiter: /[+:,]/, default: 'all', argument: true, optional: false
+      on '-l', :locales=, 'Locales to remove unused keys from (default: all)', on_locale_opt
     end
     cmd :remove_unused do |opt = {}|
-      locales = locales_opt(opt[:arguments] || opt[:locales])
+      locales = locales_opt_or_args(opt)
       unused_keys = i18n_task.unused_keys
       if unused_keys.present?
         terminal_report.unused_keys(unused_keys)

data/lib/i18n/tasks/commands_base.rb

@@ -12,6 +12,14 @@ module I18n::Tasks
       end
     end
 
+    def locales_opt_or_args(opt)
+      locales_opt(opt[:arguments].presence || opt[:locales]).tap do |locales|
+        if ENV['VERBOSE']
+          STDERR.puts Term::ANSIColor.green "i18n-tasks: locales are #{locales.inspect}"
+        end
+      end
+    end
+
     class << self
       def cmds
         @cmds ||= {}.with_indifferent_access

data/lib/i18n/tasks/configuration.rb

@@ -45,12 +45,15 @@ module I18n::Tasks::Configuration
     }
   end
 
-  # @return [Array<String>] all available locales
+  # @return [Array<String>] all available locales, base_locale is always first
   def locales
     @config_sections[:locales] ||= begin
       locales = (config[:locales] || I18n.available_locales).map(&:to_s)
-      locales = [base_locale] + locales unless locales.include?(base_locale)
-      locales
+      if locales.include?(base_locale)
+        [base_locale] + (locales - [base_locale])
+      else
+        [base_locale] + locales
+      end
     end
   end
 

data/lib/i18n/tasks/missing_keys.rb

@@ -3,18 +3,22 @@ module I18n::Tasks
     # @param [:missing_from_base, :missing_from_locale, :eq_base] type (default nil)
     # @return [KeyGroup]
     def missing_keys(opts = {})
-      locales = non_base_locales(opts[:locales])
+      locales = Array(opts[:locales]).presence || self.locales
       type    = opts[:type]
       unless type
         types = opts[:types].presence || missing_keys_types
         opts  = opts.except(:types).merge(locales: locales)
         return types.map { |t| missing_keys(opts.merge(type: t)) }.reduce(:+)
       end
+
       if type.to_s == 'missing_from_base'
-        keys_missing_from_base
+        keys = keys_missing_from_base if locales.include?(base_locale)
       else
-        locales.map { |locale| send("keys_#{type}", locale) }.reduce(:+) || KeyGroup.new([])
+        keys = non_base_locales(locales).map { |locale|
+          send("keys_#{type}", locale)
+        }.reduce(:+)
       end
+      keys || KeyGroup.new([])
     end
 
     def missing_keys_types

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Tasks
-    VERSION = '0.3.3'
+    VERSION = '0.3.4'
   end
 end

data/spec/i18n_tasks_spec.rb

@@ -11,14 +11,19 @@ describe 'i18n-tasks' do
   end
 
   describe 'missing' do
-    it 'detects missing or identical' do
-      capture_stderr do
-        expect(run_cmd :missing).to be_i18n_keys %w(
-          en.used_but_missing.a en.relative.index.missing
+    let (:expected_missing_keys) {
+      %w( en.used_but_missing.a 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 )
+    }
+    it 'detects missing or identical' do
+      capture_stderr do
+        expect(run_cmd :missing).to be_i18n_keys expected_missing_keys
+        es_keys = expected_missing_keys.grep(/^es\./)
+        # locale argument
+        expect(run_cmd :missing, locales: %w(es)).to be_i18n_keys es_keys
+        expect(run_cmd :missing, arguments: %w(es)).to be_i18n_keys es_keys
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-27 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -180,8 +180,13 @@ dependencies:
         version: '0'
 description: |2
 
-      rake tasks to find unused and missing translations, normalize locale files,
-      and prefill missing keys. Supports relative and plural keys and Google Translate.
+  The basic approach to i18n key management in frameworks such as Rails has many flaws.
+
+  If you use a key that does not exist, this will only blow up at runtime. Keys left over from removed code accumulate
+  in the resource files, introducing unnecessary overhead on the translators.
+  Translation files can quickly turn to disarray.
+
+  i18n-tasks solves this problem with static analysis.
 email:
 - glex.spb@gmail.com
 executables:
@@ -277,8 +282,8 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: Tasks to manage missing and unused translations in ruby applications using
-  I18n.
+summary: Manage translations in ruby applications with the awesome power of static
+  analysis — Edit
 test_files:
 - spec/file_system_data_spec.rb
 - spec/fixtures/app/assets/javascripts/application.js