i18n-tasks 0.7.13 → 0.8.0

data/lib/i18n/tasks/scanners/relative_keys.rb

@@ -11,7 +11,7 @@ module I18n
           path_root(normalized_path, roots) or
             raise CommandError.new(
               "Error scanning #{normalized_path}: cannot resolve relative key
-              \"#{key}\".\nSet relative_roots in config/i18n-tasks.yml
+              \"#{key}\".\nSet search.relative_roots in config/i18n-tasks.yml
               (currently #{relative_roots.inspect})"
             )
 

data/lib/i18n/tasks/version.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 module I18n
   module Tasks
-    VERSION = '0.7.13'
+    VERSION = '0.8.0'
   end
 end

data/spec/commands/data_commands_spec.rb

@@ -20,19 +20,19 @@ describe 'Data commands' do
   end
 
   it '#data' do
-    expect(JSON.parse(run_cmd :data, format: 'json', locales: 'en')).to eq(en_data)
+    expect(JSON.parse(run_cmd 'data', '-fjson', '-len')).to eq(en_data)
   end
 
   it '#data-merge' do
-    expect(JSON.parse(run_cmd :data_merge, format: 'json', arguments: [en_data_2.to_json], nostdin: true)).to eq(en_data.deep_merge en_data_2)
+    expect(JSON.parse(run_cmd 'data-merge', '-fjson', '-S', en_data_2.to_json)).to eq(en_data.deep_merge en_data_2)
   end
 
   it '#data-write' do
-    expect(JSON.parse(run_cmd :data_write, format: 'json', arguments: [en_data_2.to_json])).to eq(en_data_2)
+    expect(JSON.parse(run_cmd 'data-write', '-fjson', '-S', en_data_2.to_json)).to eq(en_data_2)
   end
 
   it '#data-remove' do
     to_remove = {'en' => {'common' => {'hello' => ''}}}
-    expect(JSON.parse(run_cmd :data_remove, format: 'json', arguments: [to_remove.to_json])).to eq('en' => {'common' => en_data['en']['common'] })
+    expect(JSON.parse(run_cmd 'data-remove', '-fjson', '-S', to_remove.to_json)).to eq('en' => {'common' => en_data['en']['common'] })
   end
 end

data/spec/commands/tree_commands_spec.rb

@@ -13,7 +13,7 @@ describe 'Tree commands' do
   context 'tree-merge' do
     trees = [{'a' => '1', 'b' => '2'}, {'a' => '-1', 'c' => '3'}]
     it trees.map(&:to_json).join(', ') do
-      merged = JSON.parse run_cmd(:tree_merge, format: 'json', arguments: trees.map(&:to_json), nostdin: true)
+      merged = JSON.parse run_cmd('tree-merge', '-fjson', '-S', *trees.map(&:to_json))
       expect(merged).to eq trees.reduce(:merge)
     end
   end
@@ -22,7 +22,7 @@ describe 'Tree commands' do
     forest  = {'a' => '1', 'b' => '2', 'c' => {'a' => '3'}}
     pattern = '{a,c.*}'
     it "-p #{pattern.inspect} #{forest.to_json}" do
-      selected = JSON.parse run_cmd(:tree_filter, format: 'json', pattern: pattern, arguments: [forest.to_json])
+      selected = JSON.parse run_cmd('tree-filter', '-fjson', '-p', pattern, forest.to_json)
       expect(selected).to eq(forest.except('b'))
     end
   end
@@ -30,7 +30,7 @@ describe 'Tree commands' do
   context 'tree-subtract' do
     trees = [{'a' => '1', 'b' => '2'}, {'a' => '-1', 'c' => '3'}]
     it trees.map(&:to_json).join(' - ') do
-      subtracted = JSON.parse run_cmd(:tree_subtract, format: 'json', arguments: trees.map(&:to_json), nostdin: true)
+      subtracted = JSON.parse run_cmd('tree-subtract', '-fjson', '-S', *trees.map(&:to_json))
       expected = {'b' => '2'}
       expect(subtracted).to eq expected
     end
@@ -42,7 +42,7 @@ describe 'Tree commands' do
     end
 
     def rename_key(from, to)
-      JSON.parse run_cmd(:tree_rename_key, key: from, name: to, format: 'json', arguments: [forest.to_json])
+      JSON.parse run_cmd('tree-rename-key', '-fjson', '-k', from, '-n', to, forest.to_json)
     end
 
     it 'renames root node' do
@@ -62,7 +62,7 @@ describe 'Tree commands' do
     end
 
     it 'converts to keys' do
-      keys = run_cmd(:tree_convert, from: 'json', to: 'keys', arguments: [forest.to_json]).split("\n")
+      keys = run_cmd('tree-convert', '-fjson', '-tkeys', forest.to_json).split("\n")
       expect(keys.sort).to eq(['a.b.a', 'x'].sort)
     end
   end

data/spec/google_translate_spec.rb

@@ -15,7 +15,7 @@ describe 'Google Translation' do
 
   if ENV['GOOGLE_TRANSLATE_API_KEY']
     describe 'real world test' do
-      delegate :i18n_cmd, :i18n_task, :in_test_app_dir, to: :TestCodebase
+      delegate :i18n_task, :in_test_app_dir, :run_cmd, to: :TestCodebase
 
       context '#google_translate_list' do
         it "works with #{tests.map(&:first)}" do
@@ -36,7 +36,6 @@ describe 'Google Translation' do
 
       context 'command' do
         let(:task) { i18n_task }
-        let(:cmd) { i18n_cmd(task) }
 
         it 'works' do
           in_test_app_dir do
@@ -56,7 +55,7 @@ describe 'Google Translation' do
                 }
             })
 
-            cmd.run :translate_missing
+            run_cmd 'translate-missing'
             expect(task.t('common.hello', 'es')).to eq(text_test[2])
             expect(task.t('common.hello_html', 'es')).to eq(html_test[2])
             expect(task.t('common.array_key', 'es')).to eq(array_test[2])

data/spec/i18n_spec.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'i18n/tasks'
 
 describe 'I18n' do

data/spec/i18n_tasks_spec.rb

@@ -1,16 +1,38 @@
 # coding: utf-8
 require 'spec_helper'
 require 'fileutils'
+require 'open3'
 
+# Integration tests
 describe 'i18n-tasks' do
-  delegate :run_cmd, :i18n_task, :in_test_app_dir, :i18n_cmd, to: :TestCodebase
+  delegate :run_cmd, :run_cmd_capture_stderr, :i18n_task, :in_test_app_dir, to: :TestCodebase
+
+  describe 'bin/i18n-tasks' do
+    it 'shows help when invoked with no arguments, shows version on --version' do
+      # These bin/i18n-tasks tests are executed in parallel for performance
+      [
+          proc {
+            out, err, status = Open3.capture3('bin/i18n-tasks')
+            expect(status).to be_success
+            expect(out).to be_empty
+            expect(err).to start_with('Usage: i18n-tasks [command] [options]')
+            expect(err).to include('Available commands', 'add-missing')
+          },
+          proc {
+            expect(%x[bin/i18n-tasks --version].chomp).to eq(I18n::Tasks::VERSION)
+          }
+      ].map { |test| Thread.start(&test) }.each(&:join)
+    end
+  end
+
+  # Tests execute i18n-tasks using I18n::Tasks::CLI directly, via #run_cmd(task, *arguments).
+  # This avoid launching a process for each command.
 
   describe 'health' do
     it 'outputs stats' do
       t     = i18n_task
-      stats = in_test_app_dir { t.forest_stats(t.data_forest t.locales) }
-      out   = in_test_app_dir { capture_stderr { capture_stdout { i18n_cmd.run(:health) } } }
-      stats.values.each do |v|
+      out   = run_cmd_capture_stderr('health')
+      in_test_app_dir { t.forest_stats(t.data_forest t.locales) }.values.each do |v|
         expect(out).to include(v.to_s)
       end
     end
@@ -38,16 +60,16 @@ describe 'i18n-tasks' do
     }
     it 'detects missing' do
       es_keys = expected_missing_keys.grep(/^es\./)
-      expect(run_cmd :missing).to be_i18n_keys expected_missing_keys
+      expect(run_cmd 'missing').to be_i18n_keys expected_missing_keys
       # 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
+      expect(run_cmd 'missing', '-les').to be_i18n_keys es_keys
+      expect(run_cmd 'missing', 'es').to be_i18n_keys es_keys
     end
   end
 
   describe 'eq_base' do
-    it 'detects eq_base' do
-      expect(run_cmd :eq_base).to be_i18n_keys %w(es.same_in_es.a)
+    it 'detects eq-base' do
+      expect(run_cmd 'eq-base').to be_i18n_keys %w(es.same_in_es.a)
     end
   end
 
@@ -65,11 +87,11 @@ describe 'i18n-tasks' do
 
   describe 'unused' do
     it 'detects unused' do
-      expect(run_cmd :unused).to be_i18n_keys expected_unused_keys
+      expect(run_cmd 'unused').to be_i18n_keys expected_unused_keys
     end
 
     it 'detects unused (--strict)' do
-      expect(run_cmd :unused, strict: true).to be_i18n_keys expected_unused_keys_strict
+      expect(run_cmd 'unused', '--strict').to be_i18n_keys expected_unused_keys_strict
     end
   end
 
@@ -83,7 +105,7 @@ describe 'i18n-tasks' do
           expect(t.key_value?(key, :es)).to be true
         end
         ENV['CONFIRM'] = '1'
-        run_cmd :remove_unused
+        run_cmd 'remove-unused'
         t.data.reload
         unused.each do |key|
           expect(t.key_value?(key, :en)).to be false
@@ -96,7 +118,7 @@ describe 'i18n-tasks' do
   describe 'normalize' do
     it 'sorts the keys' do
       in_test_app_dir do
-        run_cmd :normalize
+        run_cmd 'normalize'
         en_yml_data = i18n_task.data.reload['en'].select_keys { |_k, node|
           node.data[:path] == 'config/locales/en.yml'
         }
@@ -112,7 +134,7 @@ describe 'i18n-tasks' do
     it 'moves keys to the corresponding files as per data.write' do
       in_test_app_dir {
         expect(File).to_not exist 'config/locales/devise.en.yml'
-        run_cmd :normalize, pattern_router: true
+        run_cmd 'normalize', '--pattern_router'
         expect(YAML.load_file('config/locales/devise.en.yml')['en']['devise']['a']).to eq 'EN_TEXT'
       }
     end
@@ -121,7 +143,7 @@ describe 'i18n-tasks' do
   describe 'xlsx_report' do
     it 'saves' do
       in_test_app_dir {
-        run_cmd :xlsx_report
+        run_cmd 'xlsx-report'
         expect(File).to exist 'tmp/i18n-report.xlsx'
         FileUtils.cp('tmp/i18n-report.xlsx', '..')
       }
@@ -134,7 +156,7 @@ describe 'i18n-tasks' 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'
+      run_cmd 'add-missing', 'base'
       in_test_app_dir {
         expect(YAML.load_file('config/locales/en.yml')['en']['used_but_missing']['key']).to eq I18n.t('i18n_tasks.common.key')
         expect(YAML.load_file('config/locales/en.yml')['en']['present_in_es_but_not_en']['a']).to eq 'ES_TEXT'
@@ -145,7 +167,7 @@ describe 'i18n-tasks' 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'
+      run_cmd 'add-missing', 'es'
       in_test_app_dir {
         expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']['a']).to eq 'EN_TEXT'
         expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es_plural_1']['a']['one']).to eq 'EN_TEXT'
@@ -156,8 +178,8 @@ describe 'i18n-tasks' do
       in_test_app_dir {
         expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']).to be_nil
       }
-      run_cmd :normalize, pattern_router: true
-      run_cmd :add_missing, locales: 'all', value: 'TRME'
+      run_cmd 'normalize', '--pattern_router'
+      run_cmd 'add-missing', '-v', 'TRME'
       in_test_app_dir {
         expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']['a']).to eq 'TRME'
         expect(YAML.load_file('config/locales/devise.es.yml')['es']['devise']['a']).to eq 'ES_TEXT'
@@ -169,7 +191,7 @@ describe 'i18n-tasks' 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', value: 'TRME %{value}'
+      run_cmd 'add-missing', '-v', 'TRME %{value}'
       in_test_app_dir {
         expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']['a']).to eq 'TRME EN_TEXT'
         expect(YAML.load_file('config/locales/en.yml')['en']['present_in_es_but_not_en']['a']).to eq 'TRME ES_TEXT'
@@ -179,7 +201,7 @@ describe 'i18n-tasks' do
 
   describe 'config' do
     it 'prints config' do
-      expect(YAML.load(Term::ANSIColor.uncolor(run_cmd :config))).to(
+      expect(YAML.load(Term::ANSIColor.uncolor(run_cmd 'config'))).to(
           eq(in_test_app_dir { i18n_task.config_for_inspect })
       )
     end
@@ -187,7 +209,7 @@ describe 'i18n-tasks' do
 
   describe 'find' do
     it 'prints usages' do
-      result = Term::ANSIColor.uncolor(run_cmd :find, arguments: ['used.*'])
+      result = Term::ANSIColor.uncolor(run_cmd 'find', 'used.*')
       expect(result).to eq(<<-TXT)
 used.a 2
   app/views/usages.html.slim:1 p = t 'used.a'
@@ -196,7 +218,6 @@ used.a 2
     end
   end
 
-
   # --- setup ---
   BENCH_KEYS = ENV['BENCH_KEYS'].to_i
   before(:each) do

data/spec/readme_spec.rb

@@ -1,5 +1,5 @@
 # coding: utf-8
-require 'spec_helper'
+
 describe 'README.md' do
   let(:readme) { File.read('README.md', encoding: 'UTF-8') }
   it 'has valid YAML in ```yaml blocks' do

data/spec/support/test_codebase.rb

@@ -3,6 +3,7 @@ require 'fileutils'
 require 'yaml'
 require_relative 'capture_std'
 require 'i18n/tasks/commands'
+require 'i18n/tasks/cli'
 
 module TestCodebase
   include CaptureStd
@@ -10,19 +11,29 @@ module TestCodebase
   AT = 'tmp/test_codebase'
 
   def i18n_task(*args)
-    TestCodebase.in_test_app_dir do
+    in_test_app_dir do
       ::I18n::Tasks::BaseTask.new(*args)
     end
   end
 
-  def i18n_cmd(*args)
-    TestCodebase.in_test_app_dir do
-      ::I18n::Tasks::Commands.new(*args)
-    end
+  def run_cmd(name, *args)
+    capture_stdout { capture_stderr { in_test_app_dir {
+      run_cli(name, *args)
+    } } }
+  end
+
+  def run_cmd_capture_stderr(name, *args)
+    capture_stderr { capture_stdout { in_test_app_dir {
+      run_cli(name, *args)
+    } } }
+  end
+
+  def run_cli(name, *args)
+    i18n_cli.run([name, *args])
   end
 
-  def run_cmd(name, *args, &block)
-    in_test_app_dir { capture_stdout { capture_stderr { i18n_cmd.run(name, *args, &block) } } }
+  def i18n_cli
+    in_test_app_dir { ::I18n::Tasks::CLI.new }
   end
 
   def setup(files = {})
@@ -47,13 +58,13 @@ module TestCodebase
     }
   end
 
-  def in_test_app_dir(&block)
-    return block.call if @in_dir
+  def in_test_app_dir
+    return yield if @in_dir
     begin
       pwd = Dir.pwd
       Dir.chdir AT
       @in_dir = true
-      block.call
+      yield
     ensure
       Dir.chdir pwd
       @in_dir = false

data/templates/config/i18n-tasks.yml

@@ -1,75 +1,87 @@
-# i18n-tasks finds and manages missing and unused translations https://github.com/glebm/i18n-tasks
+# i18n-tasks finds and manages missing and unused translations: https://github.com/glebm/i18n-tasks
 
+# The "main" locale.
 base_locale: en
-## i18n-tasks detects locales automatically from the existing locale files
-## uncomment to set locales explicitly
-# locales: [en, es, fr]
+## All available locales are inferred from the data by default. Alternatively, specify them explicitly:
+# locales: [es, fr]
+## Reporting locale, default: en. Available: en, ru.
+# internal_locale: en
 
-## i18n-tasks report locale, default: en, available: en, ru
-# internal_locale: ru
-
-# Read and write locale data
+# Read and write translations.
 data:
-  ## by default, translation data are read from the file system, or you can provide a custom data adapter
+  ## Translations are read from the file system. Supported format: YAML, JSON.
+  ## Provide a custom adapter:
   # adapter: I18n::Tasks::Data::FileSystem
 
-  # Locale files to read from
+  # Locale files or `File.find` patterns where translations are read from:
   read:
-    - config/locales/%{locale}.yml
-    # - config/locales/*.%{locale}.yml
+    ## Default:
+    # - config/locales/%{locale}.yml
+    ## More files:
     # - config/locales/**/*.%{locale}.yml
+    ## Another gem:
+    # - "<%= %x[bundle show vagrant].chomp %>/templates/locales/%{locale}.yml"
 
-  # key => file routes, matched top to bottom
+  # Locale files to write new keys to, based on a list of key pattern => file rules. Matched from top to bottom:
+  # `i18n-tasks normalize -p` will force move the keys according to these rules
   write:
-    ## E.g., write devise and simple form keys to their respective files
+    ## For example, write devise and simple form keys to their respective files:
     # - ['{devise, simple_form}.*', 'config/locales/\1.%{locale}.yml']
-    # Catch-all
-    - config/locales/%{locale}.yml
-    # `i18n-tasks normalize -p` will force move the keys according to these rules
+    ## Catch-all default:
+    # - config/locales/%{locale}.yml
+
+  ## Specify the router (see Readme for details). Valid values: conservative_router, pattern_router, or a custom class.
+  # router: convervative_router
 
-  # YAML / JSON serializer options, passed to load / dump / parse / serialize
   yaml:
     write:
       # do not wrap lines at 80 characters
       line_width: -1
-  json:
-    write:
-      # pretty print JSON
-      indent: '  '
-      space: ' '
-      object_nl: "\n"
-      array_nl: "\n"
+
+  ## Pretty-print JSON:
+  # json:
+  #
+  #   write:
+  #     indent: '  '
+  #     space: ' '
+  #     object_nl: "\n"
+  #     array_nl: "\n"
 
 # Find translate calls
 search:
-  ## Default scanner finds t() and I18n.t() calls
-  # scanner: I18n::Tasks::Scanners::PatternWithScopeScanner
-
-  ## Paths to search in, passed to File.find
-  paths:
-    - app/
+  ## Paths or `File.find` patterns to search in:
+  # paths:
+  #  - app/
 
-  ## Root for resolving relative keys (default)
+  ## Root directories for relative keys resolution.
   # relative_roots:
   #   - app/views
+  #   - app/controllers
+  #   - app/helpers
+  #   - app/presenters
 
-  ## File.fnmatch patterns to exclude from search (default)
-  # exclude: ["*.jpg", "*.png", "*.gif", "*.svg", "*.ico", "*.eot", "*.ttf", "*.woff", "*.pdf"]
+  ## Files or `File.fnmatch` patterns to exclude from search. Some files are always excluded regardless of this setting:
+  ##   %w(*.jpg *.png *.gif *.svg *.ico *.eot *.ttf *.woff *.woff2 *.pdf *.css *.sass *.scss *.less *.yml *.json)
+  # exclude: []
 
-  ## Or, File.fnmatch patterns to include
+  ## Alternatively, the only files or `File.fnmatch patterns` to search in `paths`:
+  ## If specified, this settings takes priority over `exclude`, but `exclude` still applies.
   # include: ["*.rb", "*.html.slim"]
 
+  ## Default scanner finds t() and I18n.t() calls.
+  # scanner: I18n::Tasks::Scanners::PatternWithScopeScanner
+
 ## Google Translate
 # translation:
 #   # Get an API key and set billing info at https://code.google.com/apis/console to use Google Translate
 #   api_key: "AbC-dEf5"
 
-## Consider these keys not missing
+## Do not consider these keys missing:
 # ignore_missing:
 # - 'errors.messages.{accepted,blank,invalid,too_short,too_long}'
 # - '{devise,simple_form}.*'
 
-## Consider these keys used
+## Consider these keys used:
 # ignore_unused:
 # - 'activerecord.attributes.*'
 # - '{devise,kaminari,will_paginate}.*'
@@ -77,13 +89,13 @@ search:
 # - 'simple_form.{placeholders,hints,labels}.*'
 # - 'simple_form.{error_notification,required}.:'
 
-## Exclude these keys from `i18n-tasks eq-base' report
+## Exclude these keys from the `i18n-tasks eq-base' report:
 # ignore_eq_base:
 #   all:
 #     - common.ok
 #   fr,es:
 #     - common.brand
 
-## Exclude these keys from all of the reports
+## Ignore these keys completely:
 # ignore:
 #  - kaminari.*