i18n-tasks 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4c2dfceb8ce78b38a271f5b2ee5afda329cd15d
-  data.tar.gz: 89936d161a3e2b826164658bb64b7816dbda0a6a
+  metadata.gz: 191973eaa9d7a29ea1b149eef1ce61c2d79f8c4c
+  data.tar.gz: 8cdd8e2e5408577ce0abf3b7d78bb90c43834bd2
 SHA512:
-  metadata.gz: ed3cec3d3aadfac2f0d30b8b707cb8b5f46dfd1e063c283546be4222644757906c736aeceb4860c5a31319a6a799acf7056d444acda15d99d94ca4389e30c3f0
-  data.tar.gz: 2781e4bf20a94badc077233c21e9d4fa0fe9a2dda74e76ff05429e4833b13bc265868528fb8d9d9c8fce07a32161ca70d7acac5c2b00981ee640dd6e061dbbb8
+  metadata.gz: acefe02918495e2091ac389e985491eb14542f7b54f94e8301d1aa0333e814b69ddc361d796f1a898084ddd48ab1393650cc34102e71c16a1f8917d1e2d2d741
+  data.tar.gz: 53c49f375246c3dc38e7c63b9a8ed27e99cb42fc2f709557cdf63040d6d4635b7ad7cff2c165887adbba042ef44e853dc6b08110af63f947eff890dea0d67603

data/.travis.yml

@@ -3,4 +3,7 @@ rvm:
   - 2.0.0
   - 1.9.3
   - jruby
-  - rbx
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: rbx-19mode

data/README.md

@@ -3,23 +3,50 @@
 
 Rails I18n tasks to find missing / unused translations and more. Works with slim / coffee / haml etc.
 
-![i18n-screenshot](https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.png "i18n-tasks output screenshot")
+![i18n-screenshot](https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.gif "i18n-tasks output screenshot")
 
 ## Usage
 
 Use `rake -T i18n` to get the list of tasks with descriptions. These are [the tasks](/lib/tasks/i18n-tasks.rake) available:
 
-  Rake Task                                      | Summary
- :---------------------------------------------- |:------------------------------------------------------------------
-  i18n:missing                                        | Show missing translations.
-  i18n:unused                                         | Show unused translations.
-  i18n:normalize                                      | Normalize translation data: sort by name and file.
-  i18n:fill:add_missing *[value = key.humanize]*      | Add missing `key: value` to base locale.
-  i18n:fill:with_base   *[locales = all - base]*      | Add missing `key: base value` to each non-base locale.
-  i18n:fill:with_google *[locales = all - base]*      | Add missing `key: Google Translated value` to each non-base locale.
-  i18n:fill:with_blanks *[locales = all]*             | Add `key: ''` for missing keys to each locale.
-    
-The `i18n:unused` task will detect pattern translations and not report them, e.g.:
+There are reports for missing and unused translations:
+```bash
+rake i18n:missing 
+rake i18n:unused
+```
+
+To add the keys that are not in the base locale data but detected in the source do:
+```bash
+# add missing keys to the base locale data (I18n.default_locale)
+# values set to key.humanize
+rake i18n:add_missing
+# or set all values to the task argument
+rake i18n:add_missing[OhNoesMissing]
+```
+
+Prefill empty translations using Google Translate:
+```bash
+rake i18n:fill:google_translate
+# this task and the ones below can also accept specific locales:
+rake i18n:fill:google_translate[es+de]
+```
+Prefill using values from the base locale - `I8n.default_locale`:
+```bash
+rake i18n:fill:base_value
+```
+Add just blank yaml keys - `key: ''` for all missing and untranslated keys:
+```bash
+rake i18n:fill:blanks
+```
+
+i18n-tasks sorts the keys and writes them to their respective files:
+```bash
+# this happens automatically on any i18n:fill:* task
+rake i18n:normalize 
+```
+
+
+`i18n:unused` will detect pattern translations and not report them, e.g.:
 
 ```ruby
 t 'category.' + category.key # 'category.arts_and_crafts' considered used
@@ -36,7 +63,7 @@ For more examples see [the tests](/spec/i18n_tasks_spec.rb).
 Simply add to Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.2.0'
+gem 'i18n-tasks', '~> 0.2.1'
 ```
 
 ## Configuration

data/lib/i18n/tasks/source_keys.rb

@@ -1,6 +1,8 @@
 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
@@ -27,8 +29,6 @@ module I18n::Tasks::SourceKeys
         find_source_keys.select { |k| k =~ /\#{.*?}/ || k.ends_with?('.') }.map { |k| k.split(/\.?#/)[0].presence }.compact
   end
 
-  protected
-
   # grep config, also from config/i18n-tasks.yml
   # @return [Hash{String => String,Hash,Array}]
   def search_config
@@ -42,7 +42,7 @@ module I18n::Tasks::SourceKeys
         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]) : /\bt[( ]\s*(.)((?<=").+?(?=")|(?<=').+?(?=')|(?<=:)\w+\b)/
+        conf[:pattern] ||= conf[:pattern].present? ? Regexp.new(conf[:pattern]) : DEFAULT_PATTERN
       end
     end
   end
@@ -66,10 +66,9 @@ module I18n::Tasks::SourceKeys
     keys = []
     File.open(path, 'rb') do |f|
       while (line = f.gets)
-        line.scan(search_config[:pattern]) do |t, key|
-          if key.start_with? '.'
-            key = absolutize_key(key, path)
-          end
+        line.scan(search_config[:pattern]) do |match|
+          key = parse_key(match)
+          key = absolutize_key(key, path) if key.start_with? '.'
           if key =~ /^[\w.\#{}]+$/
             keys << key
           end
@@ -78,4 +77,12 @@ module I18n::Tasks::SourceKeys
     end
     keys
   end
+
+  private
+  def parse_key(match)
+    key = match[0]
+    key.slice!(0) if ':' == key[0]
+    key = key[1..-2] if %w(' ").include?(key[0])
+    key
+  end
 end

data/lib/i18n/tasks/version.rb

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

data/lib/tasks/i18n-tasks.rake

@@ -18,21 +18,22 @@ namespace :i18n do
     normalize_store!
   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
+      }
+    }
+  end
+
+
   desc 'fill translations with values'
   namespace :fill do
 
-    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
-        }
-      }
-    end
-
     desc 'add <key: ""> to each locale'
-    task :with_blanks, [:locales] => 'i18n:setup' do |t, args|
+    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 { '' } }
@@ -40,7 +41,7 @@ namespace :i18n do
     end
 
     desc 'add <key: Google Translated value> to each non-base locale, uses env GOOGLE_TRANSLATE_API_KEY'
-    task :with_google, [:locales] => 'i18n:setup' do |t, args|
+    task :google_translate, [:locales] => 'i18n:setup' do |t, args|
       normalize_store!
       non_base_locales(args).each do |locale|
         fill_blanks!(locale) { |blank_keys|
@@ -50,7 +51,7 @@ namespace :i18n do
     end
 
     desc 'add <key: base value> to each non-base locale'
-    task :with_base, [:locales] => 'i18n:setup' do |t, args|
+    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) } }

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

@@ -11,3 +11,4 @@ p = t 'numeric.a'
 p = t 'plural.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

@@ -6,10 +6,11 @@ describe 'rake i18n' do
     it 'detects missing or identical' do
       TestCodebase.capture_stderr do
         TestCodebase.rake_result('i18n:missing').should be_i18n_keys %w(
-          en.used_but_missing.a en.missing_symbol_key en.relative.index.missing
+          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.missing_symbol_key en.missing_symbol.key_two en.missing_symbol.key_three
         )
-      end.should =~ /Missing keys and translations \(6\)/
+      end.should =~ /Missing keys and translations \(8\)/
     end
   end
 
@@ -32,9 +33,15 @@ describe 'rake i18n' do
   end
 
   describe 'fill:' do
-    it 'with_base' do
+    it 'add missing' do
+      TestCodebase.in_test_app_dir { YAML.load_file('config/locales/en.yml')['en']['used_but_missing'].should be_nil }
+      TestCodebase.rake_result('i18n:add_missing')
+      TestCodebase.in_test_app_dir { YAML.load_file('config/locales/en.yml')['en']['used_but_missing']['a'].should == 'A' }
+    end
+
+    it 'base_value' do
       TestCodebase.in_test_app_dir { YAML.load_file('config/locales/es.yml')['es']['missing_in_es'].should be_nil }
-      TestCodebase.rake_result('i18n:fill:with_base')
+      TestCodebase.rake_result('i18n:fill:base_value')
       TestCodebase.in_test_app_dir {
         YAML.load_file('config/locales/es.yml')['es']['missing_in_es']['a'].should == 'EN_TEXT'
         YAML.load_file('config/locales/devise.en.yml')['en']['devise']['a'].should == 'EN_TEXT'

data/spec/source_keys_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'Source keys' do
+  let!(:task) { I18n::Tasks::BaseTask.new }
+  describe 'pattern' do
+    let!(:pattern) { task.search_config[:pattern] }
+
+    ['t "a.b"', "t 'a.b'", 't("a.b")', "t('a.b')",
+     "t('a.b', :arg => val)", "t('a.b', arg: val)",
+     "t :a_b", "t :'a.b'", 't :"a.b"', "t(:ab)", "t(:'a.b')", 't(:"a.b")'].each do |s|
+      it "matches #{s}" do
+        pattern.should match s
+      end
+    end
+
+    ["t \"a.b'", "t a.b"].each do |s|
+      it "does not match #{s}" do
+        pattern.should_not match s
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - glebm
@@ -136,7 +136,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- doc/img/i18n-tasks.png
+- doc/img/i18n-tasks.gif
 - i18n-tasks.gemspec
 - lib/i18n/tasks.rb
 - lib/i18n/tasks/base_task.rb
@@ -163,6 +163,7 @@ files:
 - spec/fixtures/config/i18n-tasks.yml
 - spec/i18n_tasks_spec.rb
 - spec/readme_spec.rb
+- spec/source_keys_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
 - spec/support/i18n_tasks_output_matcher.rb
@@ -200,6 +201,7 @@ test_files:
 - spec/fixtures/config/i18n-tasks.yml
 - spec/i18n_tasks_spec.rb
 - spec/readme_spec.rb
+- spec/source_keys_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
 - spec/support/i18n_tasks_output_matcher.rb