i18n-tasks 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 191973eaa9d7a29ea1b149eef1ce61c2d79f8c4c
-  data.tar.gz: 8cdd8e2e5408577ce0abf3b7d78bb90c43834bd2
+  metadata.gz: 938b362fb2bb4551507b503b2230e7175eff7a97
+  data.tar.gz: 378887ed86ebbf0cffc511d4a5b6ad83627d690f
 SHA512:
-  metadata.gz: acefe02918495e2091ac389e985491eb14542f7b54f94e8301d1aa0333e814b69ddc361d796f1a898084ddd48ab1393650cc34102e71c16a1f8917d1e2d2d741
-  data.tar.gz: 53c49f375246c3dc38e7c63b9a8ed27e99cb42fc2f709557cdf63040d6d4635b7ad7cff2c165887adbba042ef44e853dc6b08110af63f947eff890dea0d67603
+  metadata.gz: 182391f6acbb385bf294cf675debfef292153309bec9beacda7b5f8d6e71b178e21d2a111d7bdf31aec843bc1ec9d7fac53fd1a2a59a098132e887c7653f9de0
+  data.tar.gz: 3f0701378d7ecea4be0f252feae1a59a3ca9f89beeb5f6e14cd0a0f9f8ca6d807bb13ced370425d612c23bfb7c76627eef5509068cf6fc2267e699596cbae2a9

data/CHANGES.md

@@ -1,3 +1,11 @@
+## v0.2.2
+
+* improved output with terminal-table (@glebm)
+
+## v0.2.1
+
+* fill tasks renamed, fix symbol key search (@glebm)
+
 ## v0.2.0
 
 * 3 more prefill tasks, including Google Translate (@glebm)

data/README.md

@@ -1,7 +1,7 @@
 # i18n-tasks [![Build Status](https://travis-ci.org/glebm/i18n-tasks.png?branch=master)](https://travis-ci.org/glebm/i18n-tasks) [![Code Climate](https://codeclimate.com/github/glebm/i18n-tasks.png)](https://codeclimate.com/github/glebm/i18n-tasks)
 
 
-Rails I18n tasks to find missing / unused translations and more. Works with slim / coffee / haml etc.
+Tasks to manage missing and unused translations in Rails.
 
 ![i18n-screenshot](https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.gif "i18n-tasks output screenshot")
 
@@ -63,7 +63,7 @@ For more examples see [the tests](/spec/i18n_tasks_spec.rb).
 Simply add to Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.2.1'
+gem 'i18n-tasks', '~> 0.2.2'
 ```
 
 ## Configuration
@@ -117,8 +117,8 @@ search:
   # explicitly exclude files (default: blank = exclude no files)
   exclude:
     - '*.js'
-  # you can override the default grep pattern:
-  pattern: "\\bt[( ]\\s*(.)((?<=\").+?(?=\")|(?<=').+?(?=')|(?<=:)\\w+\\b)"
+  # you can override the default key regex pattern:
+  pattern: "\\bt[( ]\\s*(:?\".+?\"|:?'.+?'|:\\w+)"
 ```
 
 ### Fine-tuning

data/i18n-tasks.gemspec

@@ -8,8 +8,11 @@ Gem::Specification.new do |spec|
   spec.version       = I18n::Tasks::VERSION
   spec.authors       = ['glebm']
   spec.email         = ['glex.spb@gmail.com']
-  spec.summary       = %q{Find all the missing and unused translations!}
-  spec.description   = %q{Rails I18n tasks to find missing / unused translations and more}
+  spec.summary       = %q{Tasks to manage missing and unused translations in Rails.}
+  spec.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.
+}
   spec.homepage      = 'https://github.com/glebm/i18n-tasks'
   spec.license       = 'MIT'
 
@@ -22,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport'
   spec.add_dependency 'easy_translate'
   spec.add_dependency 'term-ansicolor'
+  spec.add_dependency 'terminal-table'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec-rails'

data/lib/i18n/tasks.rb

@@ -3,6 +3,7 @@ require 'i18n/tasks/railtie'
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/string'
 require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/object/try'
 require 'term/ansicolor'
 
 module I18n

data/lib/i18n/tasks/base_task.rb

@@ -1,19 +1,24 @@
 # coding: utf-8
+require 'i18n/tasks/configuration'
 require 'i18n/tasks/key_pattern_matching'
 require 'i18n/tasks/relative_keys'
 require 'i18n/tasks/plural_keys'
 require 'i18n/tasks/source_keys'
 require 'i18n/tasks/translation_data'
-require 'i18n/tasks/translation'
 require 'i18n/tasks/ignore_keys'
 require 'i18n/tasks/missing_keys'
 require 'i18n/tasks/untranslated_keys'
 require 'i18n/tasks/unused_keys'
+require 'i18n/tasks/google_translation'
+require 'i18n/tasks/fill_tasks'
 
 module I18n
   module Tasks
     class BaseTask
+      include Configuration
       include KeyPatternMatching
+      include IgnoreKeys
+      include DataTraversal
       include RelativeKeys
       include PluralKeys
       include SourceKeys
@@ -21,19 +26,8 @@ module I18n
       include UntranslatedKeys
       include UnusedKeys
       include TranslationData
-      include Translation
-      include IgnoreKeys
-
-      # i18n-tasks config (defaults + config/i18n-tasks.yml)
-      # @return [Hash{String => String,Hash,Array}]
-      def config
-        I18n::Tasks.config
-      end
-
-      def warn_deprecated(message)
-        I18n::Tasks.warn_deprecated(message)
-      end
-
+      include FillTasks
+      include GoogleTranslation
     end
   end
 end

data/lib/i18n/tasks/configuration.rb

@@ -0,0 +1,38 @@
+module I18n::Tasks::Configuration
+  extend ActiveSupport::Concern
+
+  # i18n-tasks config (defaults + config/i18n-tasks.yml)
+  # @return [Hash{String => String,Hash,Array}]
+  def config
+    @config ||= I18n::Tasks.config
+  end
+
+  DEFAULT_PATTERN = /\bt[( ]\s*(:?".+?"|:?'.+?'|:\w+)/
+  # search config
+  # @return [Hash{String => String,Hash,Array}]
+  def search_config
+    @search_config ||= begin
+      if config.key?(:grep)
+        config[:search] ||= config.delete(:grep)
+        I18n::Tasks.warn_deprecated 'please rename "grep" key to "search" in config/i18n-tasks.yml'
+      end
+      search_config = (config[:search] || {}).with_indifferent_access
+      search_config.tap do |conf|
+        conf[:paths] = %w(app/) if conf[:paths].blank?
+        conf[:include] = Array(conf[:include]) if conf[:include].present?
+        conf[:exclude] = Array(conf[:exclude])
+        conf[:pattern] = conf[:pattern].present? ? Regexp.new(conf[:pattern]) : DEFAULT_PATTERN
+      end
+    end
+  end
+
+  # translation config
+  # @return [Hash{String => String,Hash,Array}]
+  def translation_config
+    @translation_config ||= begin
+      conf           = (config[:translation] ||= {}).with_indifferent_access
+      conf[:api_key] ||= ENV['GOOGLE_TRANSLATE_API_KEY']
+      conf
+    end
+  end
+end

data/lib/i18n/tasks/data_traversal.rb

@@ -2,11 +2,16 @@ module I18n::Tasks::DataTraversal
   # translation of the key found in the passed hash or nil
   # @return [String,nil]
   def t(hash = data[base_locale], key)
+    if hash.is_a?(String)
+      # has is a locale
+      raise ArgumentError.new("invalid locale: #{hash}") if hash =~ /\W/
+      hash = data[hash]
+    end
     key.split('.').inject(hash) { |r, seg| r[seg] if r }
   end
 
-  # traverse => flat_map
-  def traverse_flat_map(hash)
+  # traverse => map if yield(k, v)
+  def traverse_map_if(hash)
     list = []
     traverse hash do |k, v|
       mapped = yield(k, v)

data/lib/i18n/tasks/fill_tasks.rb

@@ -0,0 +1,54 @@
+module I18n::Tasks::FillTasks
+  def add_missing!(locale = base_locale, placeholder = nil)
+    normalize_store! locale
+    set_blank_values! locale, locale == base_locale do |keys|
+      keys.map { |key|
+        placeholder || key.split('.').last.to_s.humanize
+      }
+    end
+  end
+
+  def fill_with_blanks!(locales = nil)
+    locales = non_base_locales(locales)
+    add_missing! base_locale, ''
+    normalize_store! locales
+    locales.each do |locale|
+      add_missing! locale, ''
+    end
+  end
+
+  def fill_with_google_translate!(locales = nil)
+    normalize_store! base_locale
+    locales = non_base_locales(locales)
+    normalize_store! locales
+    locales.each do |locale|
+      set_blank_values! locale do |blank_keys|
+        google_translate blank_keys.map { |k| t(k) }, to: locale, from: base_locale
+      end
+    end
+  end
+
+  def fill_with_base_values!(locales = nil)
+    normalize_store! base_locale
+    locales = non_base_locales(locales)
+    normalize_store! locales
+    locales.each do |locale|
+      set_blank_values! locale do |blank_keys|
+        blank_keys.map { |k| t(k) }
+      end
+    end
+  end
+
+  # fill blank values with values from passed block
+  # @param [String] locale
+  # @param [true, false] include_missing Include keys present in source but missing from base locale
+  def set_blank_values!(locale = base_locale, include_missing = (locale == base_locale), &fill_with)
+    blank_keys = traverse_map_if(data[base_locale]) { |key, value|
+      key if !key_value?(key, locale) && !ignore_key?(key, :missing)
+    }
+    blank_keys += keys_missing_from_base if include_missing
+
+    list         = blank_keys.uniq.zip fill_with.call(blank_keys)
+    data[locale] = data[locale].deep_merge(list_to_tree(list))
+  end
+end

data/lib/i18n/tasks/{translation.rb → google_translation.rb}

@@ -1,6 +1,6 @@
 require 'easy_translate'
 
-module I18n::Tasks::Translation
+module I18n::Tasks::GoogleTranslation
   def google_translate(strings, opts)
     return [] if strings.empty?
     opts = opts.dup
@@ -9,12 +9,4 @@ module I18n::Tasks::Translation
     end
     EasyTranslate.translate strings, opts
   end
-
-  def translation_config
-    @translation_config ||= begin
-      conf           = (config[:translation] ||= {}).with_indifferent_access
-      conf[:api_key] ||= ENV['GOOGLE_TRANSLATE_API_KEY']
-      conf
-    end
-  end
 end

data/lib/i18n/tasks/ignore_keys.rb

@@ -1,6 +1,7 @@
 module I18n::Tasks::IgnoreKeys
-  # whether to ignore the key. ignore_type one of :missing, :eq_base, :blank, :unused.
-  # will apply global ignore rules as well
+  # whether to ignore the key
+  # will also apply global ignore rules
+  # @param [:missing, :eq_base, :blank, :unused] ignore_type
   def ignore_key?(key, ignore_type, locale = nil)
     key =~ ignore_pattern(ignore_type, locale)
   end

data/lib/i18n/tasks/key_pattern_matching.rb

@@ -14,7 +14,7 @@ module I18n::Tasks::KeyPatternMatching
   # convert key.* to key\..*
   def key_pattern_to_re(key_pattern)
     if key_pattern.end_with? '.'
-      warn_deprecated %Q(please change pattern "#{key_pattern}" to "#{key_pattern += '*'}" in config/i18n-tasks.yml)
+      I18n::Tasks.warn_deprecated %Q(please change pattern "#{key_pattern}" to "#{key_pattern += '*'}" in config/i18n-tasks.yml)
     end
     /^#{key_pattern.
         gsub(/\./, '\.').

data/lib/i18n/tasks/missing_keys.rb

@@ -1,33 +1,23 @@
 module I18n::Tasks::MissingKeys
-  # missing keys, i.e. key that are in the code but are not in the base locale data
-  # @return Array{Hash}
-  def keys_missing_base_value
+  # @return Array missing keys, i.e. key that are in the code but are not in the base locale data
+  def keys_missing_from_base
     find_source_keys.reject { |key|
       key_value?(key, base_locale) || pattern_key?(key) || ignore_key?(key, :missing)
-    }.map { |key| {locale: base_locale, type: :none, key: key} }
+    }
   end
 
-  # present in base locale, but untranslated in another locale
-  # @return Array{Hash}
-  def keys_missing_translation(locale)
-    trn = data[locale]
-    r   = []
-    traverse data[base_locale] do |key, base_value|
-      value_in_locale = t(trn, key)
-      if value_in_locale.blank? && !ignore_key?(key, :missing)
-        r << {locale: locale, key: key, type: :blank, base_value: base_value}
-      elsif value_in_locale == base_value && !ignore_key?(key, :eq_base, locale)
-        r << {locale: locale, key: key, type: :eq_base, base_value: base_value}
-      end
+  # @return Array keys missing value (but present in base)
+  def keys_missing_value(locale)
+    traverse_map_if data[base_locale] do |key, base_value|
+      key if !key_value?(key, locale) && !ignore_key?(key, :missing)
     end
-    r
   end
 
-  # sort first by locale, then by type
-  # @return Array{Hash}
-  def sort_keys(keys)
-    keys.sort { |a, b|
-      (l = a[:locale] <=> b[:locale]).zero? ? a[:type] <=> b[:type] : l
-    }
+  # @return Array keys missing value (but present in base)
+  def keys_where_value_eq_base(locale)
+    traverse_map_if data[base_locale] do |key, base_value|
+      key if base_value == t(locale, key) && !ignore_key?(key, :eq_base, locale)
+    end
   end
+
 end

data/lib/i18n/tasks/plural_keys.rb

@@ -1,13 +1,13 @@
 module I18n::Tasks::PluralKeys
   PLURAL_KEY_RE = /\.(?:zero|one|two|few|many|other)$/
 
-  # @param key [String] i18n key
-  # @param data [Hash{String => String,Hash}] locale data
+  # @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(key, data)
-    return key if key !~ PLURAL_KEY_RE || t(data, key).is_a?(Hash)
+  def depluralize_key(locale = base_locale, key)
+    return key if key !~ PLURAL_KEY_RE || t(locale, key).is_a?(Hash)
     parent_key      = key.split('.')[0..-2] * '.'
-    plural_versions = t(data, parent_key)
+    plural_versions = t(locale, parent_key)
     if plural_versions.is_a?(Hash) && plural_versions.all? { |k, v| ".#{k}" =~ PLURAL_KEY_RE && !v.is_a?(Hash) }
       parent_key
     else

data/lib/i18n/tasks/railtie.rb

@@ -3,7 +3,7 @@ module I18n
   module Tasks
     class Railtie < ::Rails::Railtie
       rake_tasks {
-        load "tasks/i18n-tasks.rake"
+        load 'tasks/i18n-tasks.rake'
       }
     end
   end

data/lib/i18n/tasks/reports/terminal.rb

@@ -0,0 +1,86 @@
+# coding: utf-8
+require 'terminal-table'
+module I18n
+  module Tasks
+    module Reports
+      class Terminal
+        include Term::ANSIColor
+
+        def initialize
+          @task = I18n::Tasks::BaseTask.new
+        end
+
+        attr_reader :task
+
+        def missing_translations
+          recs = task.untranslated_keys
+          print_title "Missing keys and translations (#{recs.length})"
+          if recs.present?
+            type_sym  = {
+                :none    => red('✗'),
+                :blank   => yellow('∅'),
+                :eq_base => bold(blue('='))
+            }
+            type_desc = {
+                :none    => 'key missing',
+                :blank   => 'translation blank',
+                :eq_base => 'value same as base value'
+            }
+            $stderr.puts "#{bold 'Types:'} #{type_desc.keys.map { |k| "#{type_sym[k]} #{type_desc[k]}" } * ', '}"
+            print_table headings: [magenta(bold('Locale')), bold('Type'), magenta('i18n Key'), bold(cyan "Base value (#{base_locale})")] do |t|
+              t.rows = recs.map { |rec|
+                if rec[:type] == :none
+                  locale     = magenta bold rec[:locale]
+                  base_value = ''
+                else
+                  locale     = magenta rec[:locale]
+                  base_value = cyan rec[:base_value].try(:strip) || ''
+                end
+                [{:value => locale, :alignment => :center },
+                 {:value => type_sym[rec[:type]], :alignment => :center },
+                 magenta(rec[:key]),
+                 base_value]
+              }
+            end
+          else
+            print_success 'Good job! No translations missing!'
+          end
+        end
+
+        def unused_translations
+          unused = task.unused_keys
+          print_title "Unused i18n keys (#{unused.length})"
+          if unused.present?
+            print_table headings: [bold(magenta('i18n Key')), cyan("Base value (#{base_locale})")] do |t|
+              t.rows = unused.map { |x| [magenta(x[0]), cyan(x[1])] }
+            end
+          else
+            print_success 'Good job! Every translation is used!'
+          end
+        end
+
+        private
+
+        extend Term::ANSIColor
+
+        def print_title(title)
+          $stderr.puts "#{bold cyan title.strip} #{dark "|"} #{bold "i18n-tasks v#{I18n::Tasks::VERSION}"}"
+        end
+
+        def print_success(message)
+          $stderr.puts(bold green message)
+        end
+
+        private
+        def indent(txt, n = 2)
+          spaces = ' ' * n
+          txt.gsub /^/, spaces
+        end
+
+        def print_table(opts, &block)
+          puts ::Terminal::Table.new(opts, &block)
+        end
+      end
+    end
+  end
+end

data/lib/i18n/tasks/source_keys.rb

@@ -1,8 +1,6 @@
 require 'find'
 
 module I18n::Tasks::SourceKeys
-  DEFAULT_PATTERN = /\bt[( ]\s*(:?".+?"|:?'.+?'|:\w+)/
-
   # find all keys in the source (relative keys are returned in absolutized)
   # @return [Array<String>]
   def find_source_keys
@@ -29,24 +27,6 @@ module I18n::Tasks::SourceKeys
         find_source_keys.select { |k| k =~ /\#{.*?}/ || k.ends_with?('.') }.map { |k| k.split(/\.?#/)[0].presence }.compact
   end
 
-  # grep config, also from config/i18n-tasks.yml
-  # @return [Hash{String => String,Hash,Array}]
-  def search_config
-    @search_config ||= begin
-      if config.key?(:grep)
-        config[:search] ||= config.delete(:grep)
-        warn_deprecated 'please rename "grep" key to "search" in config/i18n-tasks.yml'
-      end
-      search_config = (config[:search] || {}).with_indifferent_access
-      search_config.tap do |conf|
-        conf[:paths] = %w(app/) if conf[:paths].blank?
-        conf[:include] = Array(conf[:include]) if conf[:include].present?
-        conf[:exclude] = Array(conf[:exclude])
-        conf[:pattern] ||= conf[:pattern].present? ? Regexp.new(conf[:pattern]) : DEFAULT_PATTERN
-      end
-    end
-  end
-
   # Run given block for every relevant file, according to search_config
   # @return [Array] Results of block calls
   def traverse_files

data/lib/i18n/tasks/translation_data.rb

@@ -1,8 +1,6 @@
-require 'i18n/tasks/data_traversal'
 require 'i18n/tasks/data/yaml'
 
 module I18n::Tasks::TranslationData
-  include I18n::Tasks::DataTraversal
 
   # I18n data provider
   # @see I18n::Tasks::Data::Yaml
@@ -21,39 +19,27 @@ module I18n::Tasks::TranslationData
     t(data[locale], key).present?
   end
 
+  # @return [Array<String>] all available locales
+  def locales
+    config[:locales] ||= I18n.available_locales.map(&:to_s)
+  end
+
   # @return [String] default i18n locale
   def base_locale
     config[:base_locale] ||= I18n.default_locale.to_s
   end
 
-  # @return [Array<String>] all available locales
-  def locales
-    config[:locales] ||= I18n.available_locales.map(&:to_s)
+  def non_base_locales(from = nil)
+    from = self.locales unless from.present?
+    Array(from) - [base_locale]
   end
 
   # write to store, normalizing all data
-  def normalize_store!(locales = self.locales)
-    Array(locales).each do |target_locale|
+  def normalize_store!(from = nil)
+    from = self.locales unless from.present?
+    Array(from).each do |target_locale|
       # the store itself handles normalization
       data[target_locale] = data[target_locale]
     end
   end
-
-  # fill missing / blank keys with values from passed block
-  def fill_blanks!(locale = base_locale, &fill_with)
-    blank_keys =
-        if locale == base_locale
-          # for base locale "blank" is: present in source but not in the base locale.
-          keys_missing_base_value.map { |e| e[:key] } +
-              traverse_flat_map(data[base_locale]) { |key, value|
-                key if value.to_s.blank? && !ignore_key?(key, :missing) }
-        else
-          # for other locales "blank" is: present in base but not in the locale itself.
-          traverse_flat_map(data[base_locale]) { |key|
-            key if !key_value?(key, locale) && !ignore_key?(key, :missing) }
-        end
-
-    list         = blank_keys.uniq.zip fill_with.call(blank_keys)
-    data[locale] = data[locale].deep_merge(list_to_tree(list))
-  end
 end

data/lib/i18n/tasks/untranslated_keys.rb

@@ -6,7 +6,20 @@ module I18n::Tasks::UntranslatedKeys
   # :base_value — translation value in base locale if one is present
   # @return [Array<Hash{Symbol => String,Symbol,nil}>]
   def untranslated_keys
-    other_locales = locales - [base_locale]
-    sort_keys keys_missing_base_value + other_locales.map { |locale| keys_missing_translation(locale) }.flatten(1)
+    keys = keys_missing_from_base.map { |key| {locale: base_locale, key: key, type: :none} } +
+        non_base_locales.map { |locale|
+          keys_missing_value(locale).map { |key| {locale: locale, key: key, type: :blank, base_value: t(base_locale, key)}} + keys_where_value_eq_base(locale).map { |key|
+            {locale: locale, key: key, type: :eq_base, base_value: t(base_locale, key)}
+          }
+        }.flatten
+    sort_keys keys
+  end
+
+  # sort first by locale, then by type
+  # @return Array{Hash}
+  def sort_keys(keys)
+    keys.sort { |a, b|
+      (l = a[:locale] <=> b[:locale]).zero? ? a[:type] <=> b[:type] : l
+    }
   end
 end

data/lib/i18n/tasks/unused_keys.rb

@@ -4,15 +4,12 @@ module I18n
   module Tasks
     module UnusedKeys
       # @return [Array<[String, String]>] all the unused translations as an array of [key, value] pairs
-      def unused_keys
-        r = []
-        d = self.data[base_locale]
-        traverse d do |key, value|
+      def unused_keys(locale = base_locale)
+        traverse_map_if data[locale] do |key, value|
           next if pattern_key?(key) || ignore_key?(key, :unused)
-          key = depluralize_key(key, d)
-          r << [key, value] unless used_key?(key)
-        end
-        r.uniq
+          key = depluralize_key(locale, key)
+          [key, value] unless used_key?(key)
+        end.uniq
       end
     end
   end

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Tasks
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

data/lib/tasks/i18n-tasks.rake

@@ -1,95 +1,72 @@
 require 'set'
 require 'i18n/tasks/base_task'
-require 'i18n/tasks/output/terminal'
+require 'i18n/tasks/reports/terminal'
+require 'active_support/core_ext/module/delegation'
 
 namespace :i18n do
   desc 'show missing translations'
   task :missing => 'i18n:setup' do
-    term_output.missing i18n_tasks.untranslated_keys
+    report.missing_translations
   end
 
   desc 'show unused translations'
   task :unused => 'i18n:setup' do
-    term_output.unused i18n_tasks.unused_keys
+    report.unused_translations
   end
 
   desc 'normalize translation data: sort and move to the right files'
-  task :normalize => 'i18n:setup' do
-    normalize_store!
+  task :normalize, [:locales] => 'i18n:setup' do |t, args|
+    i18n_tasks.normalize_store! args[:locales]
   end
 
   desc 'add <key: placeholder || key.humanize> to the base locale'
   task :add_missing, [:placeholder] => 'i18n:setup' do |t, args|
-    normalize_store!
-    i18n_tasks.fill_blanks!(base_locale) { |keys|
-      keys.map { |key|
-        args[:placeholder] || key.split('.').last.to_s.humanize
-      }
-    }
+    i18n_tasks.add_missing! base_locale, args[:placeholder]
   end
 
-
   desc 'fill translations with values'
   namespace :fill do
 
     desc 'add <key: ""> to each locale'
     task :blanks, [:locales] => 'i18n:setup' do |t, args|
-      normalize_store!
-      [base_locale, *non_base_locales].each do |locale|
-        fill_blanks!(locale) { |blank_keys| blank_keys.map { '' } }
-      end
+      i18n_tasks.fill_with_blanks! parse_locales args[:locales]
     end
 
     desc 'add <key: Google Translated value> to each non-base locale, uses env GOOGLE_TRANSLATE_API_KEY'
     task :google_translate, [:locales] => 'i18n:setup' do |t, args|
-      normalize_store!
-      non_base_locales(args).each do |locale|
-        fill_blanks!(locale) { |blank_keys|
-          i18n_tasks.google_translate blank_keys.map { |k| t(k) }, to: locale, from: base_locale
-        }
-      end
+      i18n_tasks.fill_with_google_translate! parse_locales args[:locales]
     end
 
     desc 'add <key: base value> to each non-base locale'
     task :base_value, [:locales] => 'i18n:setup' do |t, args|
-      normalize_store!
-      non_base_locales(args).each do |locale|
-        fill_blanks!(locale) { |blank_keys| blank_keys.map { |k| t(k) } }
-      end
+      i18n_tasks.fill_with_base_values! parse_locales args[:locales]
     end
   end
 
   task 'i18n:setup' => :environment do
     if File.exists?('.i18nignore')
-      STDERR.puts 'Looks like you are using .i18ignore. It is no longer used in favour of config/i18n-tasks.yml.'
-      STDERR.puts 'See README.md https://github.com/glebm/i18n-tasks'
+      I18n::Tasks.warn_deprecated "Looks like you are using .i18ignore. It is no longer used in favour of config/i18n-tasks.yml.\n
+See README.md https://github.com/glebm/i18n-tasks"
     end
   end
 
   module I18n::Tasks::RakeHelpers
-    extend ActiveSupport::Concern
-
-    included do
-      delegate :t, :locales, :base_locale, :normalize_store!, :fill_blanks!, to: :i18n_tasks
+    include Term::ANSIColor
 
-      def i18n_tasks
-        @i18n_tasks ||= I18n::Tasks::BaseTask.new
-      end
+    delegate :base_locale, to: :i18n_tasks
 
-      def term_output
-        @term_output ||= I18n::Tasks::Output::Terminal.new
-      end
+    def i18n_tasks
+      @i18n_tasks ||= I18n::Tasks::BaseTask.new
+    end
 
-      def non_base_locales(args = nil)
-        locales_or_all(args) - [base_locale]
-      end
+    def report
+      @report ||= I18n::Tasks::Reports::Terminal.new
+    end
 
-      def locales_or_all(args = nil)
-        args[:locales] ? args[:locales].strip.split(/\s*\+\s*/) : locales
-      end
+    def parse_locales(arg = nil)
+      arg.try(:strip).try(:split, /\s*\+\s*/).try(:compact)
     end
   end
-
   include I18n::Tasks::RakeHelpers
-  include Term::ANSIColor
 end
+

data/spec/i18n_tasks_spec.rb

@@ -17,7 +17,8 @@ describe 'rake i18n' do
   describe 'unused' do
     it 'detects unused' do
       TestCodebase.capture_stderr do
-        TestCodebase.rake_result('i18n:unused').should be_i18n_keys %w(unused.a unused.numeric unused.plural)
+        out = TestCodebase.rake_result('i18n:unused')
+        out.should be_i18n_keys %w(unused.a unused.numeric unused.plural)
       end.should =~ /Unused i18n keys \(3\)/
     end
   end

data/spec/support/i18n_tasks_output_matcher.rb

@@ -5,9 +5,12 @@ RSpec::Matchers.define :be_i18n_keys do |expected|
   end
   
   def extract_keys(actual)
-    actual = actual.split("\n").map(&:presence).compact.map { |row|
-      row.gsub(/\s+/, ' ').strip.split(' ').map(&:presence).compact
+    actual = actual.split("\n").map(&:presence).compact
+    actual = actual[3..-2] if actual[0] = /^\s*[+-]+\s*$/
+    actual = actual.map { |row|
+      row.gsub(/(?:\s|^)\|(?:\s|$)/, ' ').gsub(/\s+/, ' ').strip.split(' ').map(&:presence).compact
     }
+    return [] if actual.empty?
     if actual[0][1] =~ /[✗∅=]/
       locale_col = 0
       key_col    = 2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-23 00:00:00.000000000 Z
+date: 2013-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +136,10 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Rails I18n tasks to find missing / unused translations and more
+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.
 email:
 - glex.spb@gmail.com
 executables: []
@@ -140,17 +157,19 @@ files:
 - i18n-tasks.gemspec
 - lib/i18n/tasks.rb
 - lib/i18n/tasks/base_task.rb
+- lib/i18n/tasks/configuration.rb
 - lib/i18n/tasks/data/yaml.rb
 - lib/i18n/tasks/data_traversal.rb
+- lib/i18n/tasks/fill_tasks.rb
+- lib/i18n/tasks/google_translation.rb
 - lib/i18n/tasks/ignore_keys.rb
 - lib/i18n/tasks/key_pattern_matching.rb
 - lib/i18n/tasks/missing_keys.rb
-- lib/i18n/tasks/output/terminal.rb
 - lib/i18n/tasks/plural_keys.rb
 - lib/i18n/tasks/railtie.rb
 - lib/i18n/tasks/relative_keys.rb
+- lib/i18n/tasks/reports/terminal.rb
 - lib/i18n/tasks/source_keys.rb
-- lib/i18n/tasks/translation.rb
 - lib/i18n/tasks/translation_data.rb
 - lib/i18n/tasks/untranslated_keys.rb
 - lib/i18n/tasks/unused_keys.rb
@@ -192,7 +211,7 @@ rubyforge_project:
 rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
-summary: Find all the missing and unused translations!
+summary: Tasks to manage missing and unused translations in Rails.
 test_files:
 - spec/fixtures/app/assets/javascripts/application.js
 - spec/fixtures/app/controllers/events_controller.rb

data/lib/i18n/tasks/output/terminal.rb

@@ -1,67 +0,0 @@
-# coding: utf-8
-module I18n
-  module Tasks
-    module Output
-      class Terminal
-        include Term::ANSIColor
-
-        def missing(missing)
-          print_title "Missing keys and translations (#{missing.length})"
-          if missing.present?
-            $stderr.puts "#{bold 'Legend:'} #{red '✗'} key missing, #{yellow bold '∅'} translation blank, #{blue bold '='} value equal to base locale, #{cyan 'value in base locale'}"
-            key_col_width = missing.map { |x| x[:key] }.max_by(&:length).length + 2
-            missing.each { |m| print_missing_translation m, key_col_width: key_col_width }
-          else
-            print_success 'Good job! No translations missing!'
-          end
-        end
-
-        def unused(unused)
-          print_title "Unused i18n keys (#{unused.length})"
-          if unused.present?
-            key_col_width = unused.max_by { |x| x[0].length }[0].length + 2
-            unused.each { |(key, value)| puts "#{magenta key.ljust(key_col_width)}#{cyan value.to_s.strip}" }
-          else
-            print_success 'Good job! Every translation is used!'
-          end
-        end
-
-        private
-
-        extend Term::ANSIColor
-
-        def print_title(title)
-          $stderr.puts "#{bold cyan title.strip} #{dark "|"} #{bold "i18n-tasks v#{I18n::Tasks::VERSION}"}"
-        end
-
-        def print_success(message)
-          $stderr.puts(bold green message)
-        end
-
-
-        def print_missing_translation(m, opts)
-          status_texts = {
-              none:    red("✗".ljust(6)),
-              blank:   yellow(bold '∅'.ljust(6)),
-              eq_base: blue(bold "=".ljust(6))
-          }
-          locale, key, base_value, status_text = m[:locale], m[:key], m[:base_value].to_s.try(:strip), " #{status_texts[m[:type]]}"
-
-          key = magenta "#{key}".ljust(opts[:key_col_width])
-          s   = if m[:type] == :none
-                  "#{red bold locale.ljust(4)} #{status_text} #{key}"
-                else
-                  "#{bold locale.ljust(4)} #{status_text} #{key} #{cyan base_value.strip.gsub("\n", ' ')}"
-                end
-          puts s
-        end
-
-        private
-        def indent(txt, n = 2)
-          spaces = ' ' * n
-          txt.gsub /^/, spaces
-        end
-      end
-    end
-  end
-end