i18n-tasks 0.2.10 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31bf9c531249255541d82c38054138c02805bdad
-  data.tar.gz: d58609500eff53d8ed0ddd5b5f6abb94ead03085
+  metadata.gz: e5f6e76606d7dd49f09c15b59a7cb0090cd7fde5
+  data.tar.gz: 2a926a8c845b17edb62406c48bddc805ec1bcd37
 SHA512:
-  metadata.gz: 1b18557d8e748c7fe574f60ddda988703929b32a865fe33eb96523a33c83c92c7e2ec99191f9b5653ce8c114ebebedbbe24cccbfc3d3ebf6f928d82b542debfd
-  data.tar.gz: 1c584404ba07c8ec32465cc5719709d2aa41dbff76218c3cda010b5a72ea4db42824de5af66209a0c83b2f926b2b727d9a4f1095b129c34185ac5bea16536917
+  metadata.gz: 8ecf7561e9bbd78b4a0bc3ac08b25e9b0416129acb2dbc05ff465d0dd29f9925a5efb8396b217c87e3730db57b6f62a673c67272e0340f83fcf53aff946d41e0
+  data.tar.gz: 3797630ebef48dd78885bce77e23a2ace0e9478dc2f2d54af9a1fd512896533a0d76ae6d98db23dfa064fdd03b19d745a2f13c0923b5b73df2fd0672b565b05d

data/CHANGES.md

@@ -1,4 +1,8 @@
-## v0.2.5..0.2.9
+## v0.2.1
+
+* New task: `i18n:remove_unused`
+
+## v0.2.5..0.2.10
 
 * config/i18n-tasks.yml now processed with ERB
 * can now be used with any ruby apps, not just Rails

data/README.md

@@ -14,10 +14,21 @@ There are reports for missing and unused translations:
 ```bash
 rake i18n:missing
 rake i18n:unused
-# or save both to an xlsx file:
+```
+
+You can also export missing and unused data to XLSX though there is no importer yet:
+
+```bash
+# or save both to an XLSX file:
 rake i18n:spreadsheet_report
 ```
 
+i18n-tasks can automatically remove all unused translations:
+
+```bash
+rake i18n:remove_unused
+```
+
 i18n-tasks can add missing keys to the locale data, and it can also fill untranslated values.
 
 To add the keys that are not in the base locale but detected in the source do:
@@ -179,6 +190,9 @@ ignore_unused:
 ignore_missing:
   - devise.errors.unauthorized # ignore this key
   - pagination.views.*         # ignore the whole pattern
+  # E.g to ignore all Rails number / currency keys:
+  - 'number.{format, percentage.format, precision.format, human.format, currency.format}.{strip_insignificant_zeros,significant,delimiter}'
+  - 'time.{pm,am}'
 
 # do not report these keys when they have the same value as the base locale version
 ignore_eq_base:

data/i18n-tasks.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'easy_translate'
   s.add_dependency 'term-ansicolor'
   s.add_dependency 'terminal-table'
+  s.add_dependency 'highline'
   s.add_development_dependency 'axlsx', '~> 2.0'
   s.add_development_dependency 'bundler', '~> 1.3'
   s.add_development_dependency 'rake'

data/lib/i18n/tasks/base_task.rb

@@ -32,6 +32,10 @@ module I18n
       def initialize(config = {})
         self.config = config || {}
       end
+
+      def in_task(&block)
+        instance_exec(&block)
+      end
     end
   end
 end

data/lib/i18n/tasks/data/yaml.rb

@@ -51,6 +51,7 @@ module I18n::Tasks
 
       # set locale tree
       def set(locale, value_tree)
+        locale = locale.to_s
         out = {}
         traverse value_tree do |key, value|
           route = @write.detect { |route| route[0] =~ key }
@@ -60,10 +61,10 @@ module I18n::Tasks
           (out[path] ||= []) << [key, value]
         end
         out.each do |path, data|
-          File.open(path, 'w') { |f|
-            f.write({locale.to_s => list_to_tree(data)}.to_yaml)
-          }
+          tree = { locale => list_to_tree(data) }
+          File.open(path, 'w') { |f| f.write(tree.to_yaml) }
         end
+        @locale_data[locale] = nil
       end
 
       alias []= set

data/lib/i18n/tasks/data_traversal.rb

@@ -36,6 +36,7 @@ module I18n::Tasks::DataTraversal
     end
   end
 
+  # [[key, value], ...] list to tree
   def list_to_tree(list)
     list = list.sort
     tree = {}
@@ -48,4 +49,4 @@ module I18n::Tasks::DataTraversal
     end
     tree
   end
-end
+end

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

@@ -35,12 +35,11 @@ module I18n
           end
         end
 
-        def unused_translations
-          unused = task.unused_keys
-          print_title unused_title(unused)
-          if unused.present?
+        def unused_translations(recs = task.unused_keys)
+          print_title unused_title(recs)
+          if recs.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])] }
+              t.rows = recs.map { |x| [magenta(x[0]), cyan(x[1])] }
             end
           else
             print_success 'Good job! Every translation is used!'

data/lib/i18n/tasks/unused_keys.rb

@@ -1,4 +1,5 @@
 # coding: utf-8
+require 'set'
 
 module I18n
   module Tasks
@@ -11,6 +12,16 @@ module I18n
           [key, value] unless used_key?(key)
         end.uniq
       end
+
+      def remove_unused!(locales = self.locales)
+        exclude = unused_keys.map(&:first).to_set
+        locales.each do |locale|
+          #require 'byebug'; byebug
+          data[locale] = list_to_tree traverse_map_if(data[locale]) { |key, value|
+            [key, value] unless exclude.include?(depluralize_key(locale, key))
+          }
+        end
+      end
     end
   end
-end
+end

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Tasks
-    VERSION = '0.2.10'
+    VERSION = '0.2.11'
   end
 end

data/lib/tasks/i18n-tasks.rake

@@ -6,6 +6,8 @@ require 'active_support/core_ext/module/delegation'
 require 'i18n/tasks/reports/spreadsheet'
 
 namespace :i18n do
+  require 'highline/import'
+
   task :setup do
   end
 
@@ -36,6 +38,29 @@ namespace :i18n do
     i18n_report.unused_translations
   end
 
+  desc 'add placeholder for missing values to the base locale (default: key.humanize)'
+  task :add_missing, [:placeholder] => 'i18n:setup' do |t, args|
+    i18n_tasks.add_missing! base_locale, args[:placeholder]
+  end
+
+  desc 'remove unused keys'
+  task :remove_unused, [:locales] => 'i18n:setup' do |t, args|
+    locales     = i18n_parse_locales(args[:locales]) || i18n_tasks.locales
+    unused_keys = i18n_tasks.unused_keys
+    if unused_keys.present?
+      i18n_report.unused_translations(unused_keys)
+      exit 1 unless agree(red "All these translations will be removed in #{bold locales * ', '}#{red '.'} " + yellow('Continue? (yes/no)') + ' ')
+      i18n_tasks.remove_unused!(locales)
+    else
+      STDERR.puts bold green 'No unused keys to remove'
+    end
+  end
+
+  desc 'normalize translation data: sort and move to the right files'
+  task :normalize, [:locales] => 'i18n:setup' do |t, args|
+    i18n_tasks.normalize_store! args[:locales]
+  end
+
   desc 'save missing and unused translations to an Excel file'
   task :spreadsheet_report, [:path] => 'i18n:setup' do |t, args|
     begin
@@ -49,16 +74,6 @@ namespace :i18n do
     i18n_spreadsheet_report.save_report(args[:path])
   end
 
-  desc 'normalize translation data: sort and move to the right files'
-  task :normalize, [:locales] => 'i18n:setup' do |t, args|
-    i18n_tasks.normalize_store! args[:locales]
-  end
-
-  desc 'add placeholder for missing values to the base locale (default: key.humanize)'
-  task :add_missing, [:placeholder] => 'i18n:setup' do |t, args|
-    i18n_tasks.add_missing! base_locale, args[:placeholder]
-  end
-
   desc 'fill translations with values'
   namespace :fill do
 

data/spec/i18n_tasks_spec.rb

@@ -15,10 +15,31 @@ describe 'rake i18n' do
   end
 
   describe 'unused' do
+    let(:expected_unused_keys) { %w(unused.a unused.numeric unused.plural) }
+
     it 'detects unused' do
       TestCodebase.capture_stderr do
         out = TestCodebase.rake_result('i18n:unused')
-        out.should be_i18n_keys %w(unused.a unused.numeric unused.plural)
+        out.should be_i18n_keys expected_unused_keys
+      end
+    end
+
+    it 'removes unused' do
+      TestCodebase.in_test_app_dir do
+        t = I18n::Tasks::BaseTask.new
+
+        expected_unused_keys.each do |key|
+          t.t(t.data[:en], key).should be_present
+          t.t(t.data[:es], key).should be_present
+        end
+
+        t.remove_unused!(t.locales)
+
+        # or save both to an xlsx file:
+        expected_unused_keys.each do |key|
+          t.t(t.data[:en], key).should be_nil
+          t.t(t.data[:es], key).should be_nil
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-03 00:00:00.000000000 Z
+date: 2013-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -94,6 +94,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  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: axlsx
   requirement: !ruby/object:Gem::Requirement