i18n-tasks 0.3.0.rc1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79c771676a7ab2418350137799e74f5cfe9a84c9
-  data.tar.gz: fa7170a9f5aa0f0a557b87499c48a393ebf47a81
+  metadata.gz: aa70f1185066cd61c8e5caf67517f50a157e8edd
+  data.tar.gz: bf73f9deb48f10a6c7731fe74cb7f4fcd0da1e7c
 SHA512:
-  metadata.gz: b9af27eac0d3d7e2c68154a5b21f9b1aa3bd1d29940cceced793c57fe0263346cb20c5e3a9f5faf2ecb0bc8160e561b7b566e40b5634e934782b973c4bfb451d
-  data.tar.gz: 133cf042e3d976e3e6fc8a670428c2b91743e0abfba53c58bdf5d67e6c8511b61bd97ae5c5ca5d231e81cb5a6db536e01e7ca017d8e8f4343f90d682bad8fb62
+  metadata.gz: 452232becc66b4aabbb8e17af2fabe95b2ceb0004e7a461fb73a58bb2b24d323d2222c8b45d44da7d8090ab14ac62bce8cb76de88e46ee811860cab0c3668f89
+  data.tar.gz: b4c51a6b8a07fb81ceea48dcbd6ddbf0396d3f7027fd6e5ef5a53ed17cf81ed2b74dbb333bb760594db933a8604c0c9c2e6b49abe55584cad026537998e92e4f

data/CHANGES.md

@@ -1,4 +1,4 @@
-## v0.3.0 (unreleased)
+## v0.3.0
 
 * i18n-tasks provides a binary instead of rake tasks now (though the tasks are still there for now).
 

data/README.md

@@ -3,23 +3,23 @@
 
 Tasks to manage translations in ruby applications using I18n.
 
-![i18n-screenshot](https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.gif "i18n-tasks output screenshot")
+![i18n-screenshot](https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.png "i18n-tasks output screenshot")
 
 ## Installation
 
 1. Add to Gemfile:
 
-```ruby
-gem 'i18n-tasks', '~> 0.3.0'
-```
+  ```ruby
+  gem 'i18n-tasks', '~> 0.3.0'
+  ```
 
 2. Create a config file at `config/i18n-tasks.yml`:
 
-```yaml
-# config/i18n-tasks.yml
-base_locale: en
-locales: [es, fr]
-```
+  ```yaml
+  # config/i18n-tasks.yml
+  base_locale: en
+  locales: [es, fr]
+  ```
 
 ## Usage
 
@@ -46,39 +46,49 @@ Available commands:
 See `<command> --help` for more information on a specific command.
 ```
 
-There are reports for missing and unused translations.
-i18n-tasks can add missing keys to the locale data, and it can also fill untranslated values.
+There are reports for `missing` and `unused` translations:
+
+```bash
+i18n-tasks missing
+i18n-tasks unused
+```
 
+Add missing values, generated from the key (for base locale) or copied from the base locale (for other locales).
 
-Whenever you can pass locales as arguments, you can use special values `base` and `all`.
-Add placeholders for missing keys to the base locale only:
+To add missing values to the base locale only:
 
 ```bash
-i18n-tasks add-missing[base]
+# locales argument always accepts `base` and `all` as special values
+i18n-tasks add-missing -l base
 ```
 
-Prefill empty translations using Google Translate ([more below on the API key](#translation-config)).
+Translate missing values with Google Translate ([more below on the API key](#translation-config)).
 
 ```bash
 i18n-tasks translate-missing
-# this task and the ones below can also accept specific locales:
-i18n-tasks translate-missing -l es,de
+# accepts from and locales options:
+i18n-tasks translate-missing -f base -l es,fr
 ```
 
-Sort the keys and write them to their respective files:
+Sort the keys and write them to their respective files with `normalize`.
+This always happens on `add-missing` and `translate-missing`.
 
 ```bash
-# always happens on add-missing or translate-missing
 i18n-tasks normalize
 ```
 
-Unused report will detect pattern translations and not report them, e.g.:
+See exactly where the keys are used with `find`:
 
-```ruby
-t 'category.' + category.key      # all 'category.*' keys are considered used
-t "category.#{category.key}.name" # all 'category.*.name' keys are considered used
+```bash
+# Show all usages of all keys
+i18n-tasks find
+# Filter by a key pattern
+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")
+
 Relative keys (`t '.title'`) and plural keys (key.one/many/other/etc) are fully supported.
 
 Scope argument is supported, but only when it is the first keyword argument ([this](/lib/i18n/tasks/scanners/pattern_with_scope_scanner.rb) can be improved):
@@ -90,16 +100,23 @@ t :invalid, scope: [:auth, :password], attempts: 5
 t :invalid, attempts: 5, scope: [:auth, :password]
 ```
 
+Unused report will detect pattern translations and not report them, e.g.:
+
+```ruby
+t 'category.' + category.key      # all 'category.*' keys are considered used
+t "category.#{category.key}.name" # all 'category.*.name' keys are considered used
+```
+
 Translation data storage, key usage search, and other [settings](#configuration) are compatible with Rails by default.
 
 ## Configuration
 
 Configuration is read from `config/i18n-tasks.yml` or `config/i18n-tasks.yml.erb`.
-See current configuration with `i18n-tasks config`.
+Inspect configuration with `i18n-tasks config`.
 
 ### Locales
 
-By default, `i18n-tasks` will read `I18n.default_locale` and `I18n.available_locales`.
+By default, i18n-tasks will read `I18n.default_locale` and `I18n.available_locales`.
 However, i18n-tasks does not load application environment by default,
 so it is recommended to set locale settings explicitly:
 
@@ -111,10 +128,12 @@ locales: [es, fr]
 
 ### Storage
 
+The default data adapter supports YAML and JSON files.
+
 ```yaml
 # i18n data storage
 data:
-  # The default file adapter supports YAML and JSON files. You can provide a custom class name here.
+  # file_system is the default adapter, you can provide a custom class name here:
   adapter: file_system
   # a list of file globs to read from per-locale
   read: 
@@ -130,7 +149,7 @@ data:
     - 'config/locales/%{locale}.yml' # path is short for ['*', path]
 ```
 
-Key matching syntax:
+#### Key pattern syntax
 
 | syntax       | description                                               |
 |:------------:|:----------------------------------------------------------|
@@ -151,17 +170,6 @@ data:
 
 ### Usage search
 
-Inspect all the usages with:
-
-```bash
-i18n-tasks find
-# Filter by a key pattern
-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")
-
 
 Configure usage search in `config/i18n-tasks.yml`:
 
@@ -196,7 +204,7 @@ relative_roots:
 ```
 
 It is also possible to use a custom key usage scanner by setting `search.scanner` to a class name.
-See [the default pattern scanner](/lib/i18n/tasks/scanners/pattern_scanner.rb) for reference.
+See this basic [pattern scanner](/lib/i18n/tasks/scanners/pattern_scanner.rb) for reference.
 
 
 ### Fine-tuning

data/i18n-tasks.gemspec

@@ -24,7 +24,6 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.add_dependency 'rake'
   s.add_dependency 'erubis'
   s.add_dependency 'activesupport'
   s.add_dependency 'easy_translate', '>= 0.4.0'

data/lib/i18n/tasks/commands.rb

@@ -9,8 +9,8 @@ module I18n::Tasks
 
     desc 'show missing translations'
     opts do
-      on '-l', :locales=, 'Filter by locale', as: Array, delimiter: /[+:,]/, default: 'all'
-      on '-t', :types, 'Filter by type (types: missing_from_base, eq_base, missing_from_locale)', as: Array, delimiter: /[+:,]/
+      on '-l', :locales=, 'Filter by locale', as: Array, delimiter: /[+:,]/, default: 'all', argument: true, optional: false
+      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[:locales])
@@ -24,8 +24,8 @@ module I18n::Tasks
 
     desc 'translate missing keys with Google Translate'
     opts do
-      on '-l', :locales, 'Only specified locales', as: Array, delimiter: /[+:,]/
-      on '-f', :from, 'Locale to translate from (default: base)', default: 'base'
+      on '-l', :locales, 'Only specified locales', as: Array, delimiter: /[+:,]/, default: 'all', argument: true, optional: false
+      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'
@@ -35,8 +35,8 @@ module I18n::Tasks
 
     desc 'add missing keys to the locales'
     opts do
-      on '-p', :placeholder, 'Value for empty keys (default: base value or key.humanize)'
-      on '-l', :locales, 'Only for specified locales', as: Array, delimiter: /[+:,]/
+      on '-p', :placeholder, 'Value for empty keys (default: base value or key.humanize)', argument: true, optional: false
+      on '-l', :locales, 'Only for specified locales', as: Array, delimiter: /[+:,]/, default: 'all', argument: true, optional: false
     end
     cmd :add_missing do |opt = {}|
       opt[:locales] = locales_opt(opt[:locale] || opt[:locales])
@@ -63,7 +63,7 @@ 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: /[+:,]/
+      on '-l', :locales=, 'Only for specified locales', as: Array, delimiter: /[+:,]/, default: 'all', argument: true, optional: false
     end
     cmd :normalize do |opt = {}|
       i18n_task.normalize_store! locales_opt(opt[:locales])
@@ -71,7 +71,7 @@ module I18n::Tasks
 
     desc 'remove unused keys'
     opts do
-      on '-l', :locales=, 'Only for specified locales', as: Array, delimiter: /[+:,]/
+      on '-l', :locales=, 'Only for specified locales', as: Array, delimiter: /[+:,]/, default: 'all', argument: true, optional: false
     end
     cmd :remove_unused do |opt = {}|
       locales = locales_opt opt[:locales]

data/lib/i18n/tasks/commands_base.rb

@@ -43,8 +43,6 @@ module I18n::Tasks
       self.class.cmds.try(:[], name).try(:desc)
     end
 
-    protected
-
     def i18n_task
       @i18n_task ||= I18n::Tasks::BaseTask.new
     end

data/lib/i18n/tasks/missing_keys.rb

@@ -6,11 +6,11 @@ module I18n::Tasks
       locales = non_base_locales(opts[:locales])
       type    = opts[:type]
       unless type
-        types = opts[:types] || missing_keys_types
+        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 == :missing_from_base
+      if type.to_s == 'missing_from_base'
         keys_missing_from_base
       else
         locales.map { |locale| send("keys_#{type}", locale) }.reduce(:+) || KeyGroup.new([])

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

@@ -57,6 +57,7 @@ module I18n
 
         def unused_keys(keys = task.unused_keys)
           print_title unused_title(keys)
+          keys.sort_by_attr!(key: :asc)
           if keys.present?
             print_table headings: [bold(magenta('i18n Key')), bold(cyan("Base value (#{base_locale})"))] do |t|
               t.rows = keys.map { |k| [magenta(k.key), cyan(k.value)] }

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Tasks
-    VERSION = '0.3.0.rc1'
+    VERSION = '0.3.0'
   end
 end

data/spec/fixtures/config/i18n-tasks.yml

@@ -1,3 +1,6 @@
+base_locale: en
+locales: [es]
+
 # i18n data storage
 data:
   # The default file adapter supports YAML and JSON files. You can provide a class name here.

data/spec/i18n_tasks_spec.rb

@@ -1,12 +1,19 @@
 # coding: utf-8
 require 'spec_helper'
+require 'i18n/tasks/commands'
 require 'fileutils'
 
-describe 'rake i18n' do
+describe 'i18n-tasks' do
+  def run_cmd(name, *args, &block)
+    TestCodebase.in_test_app_dir do
+      capture_stdout { ::I18n::Tasks::Commands.new.send(name, *args, &block) }
+    end
+  end
+
   describe 'missing' do
     it 'detects missing or identical' do
       capture_stderr do
-        expect(TestCodebase.rake_result('i18n:missing')).to be_i18n_keys %w(
+        expect(run_cmd :missing).to be_i18n_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
@@ -16,16 +23,16 @@ describe 'rake i18n' do
     end
   end
 
+  let(:expected_unused_keys) { %w(unused.a unused.numeric unused.plural) }
   describe 'unused' do
-    let(:expected_unused_keys) { %w(unused.a unused.numeric unused.plural) }
-
     it 'detects unused' do
       capture_stderr do
-        out = TestCodebase.rake_result('i18n:unused')
-        expect(out).to be_i18n_keys expected_unused_keys
+        expect(run_cmd :unused).to be_i18n_keys expected_unused_keys
       end
     end
+  end
 
+  describe 'remove_unused' do
     it 'removes unused' do
       TestCodebase.in_test_app_dir do
         t = I18n::Tasks::BaseTask.new
@@ -35,7 +42,7 @@ describe 'rake i18n' do
         end
         ENV['CONFIRM'] = '1'
         capture_stderr {
-          TestCodebase.rake_result('i18n:remove_unused')
+          run_cmd :remove_unused
         }
         t.data.reload
         expected_unused_keys.each do |key|
@@ -50,16 +57,16 @@ describe 'rake i18n' do
     it 'moves keys to the corresponding files as per data.write' do
       TestCodebase.in_test_app_dir {
         expect(File).to_not exist 'config/locales/devise.en.yml'
-        TestCodebase.rake_result('i18n:normalize')
+        run_cmd :normalize
         expect(YAML.load_file('config/locales/devise.en.yml')['en']['devise']['a']).to eq 'EN_TEXT'
       }
     end
   end
 
-  describe 'spreadsheet report' do
+  describe 'xlsx_report' do
     it 'saves' do
       TestCodebase.in_test_app_dir {
-        capture_stderr { TestCodebase.rake_result('i18n:spreadsheet_report') }
+        capture_stderr { run_cmd :xlsx_report }
         expect(File).to exist 'tmp/i18n-report.xlsx'
         FileUtils.cp('tmp/i18n-report.xlsx', '..')
       }
@@ -68,21 +75,21 @@ describe 'rake i18n' do
   end
 
   describe 'add_missing' do
-    it 'placeholder' do
+    it 'default placeholder' do
       TestCodebase.in_test_app_dir {
         expect(YAML.load_file('config/locales/en.yml')['en']['used_but_missing']).to be_nil
       }
-      TestCodebase.rake_result('i18n:add_missing:placeholder', 'base')
+      run_cmd :add_missing, locales: 'base'
       TestCodebase.in_test_app_dir {
         expect(YAML.load_file('config/locales/en.yml')['en']['used_but_missing']['a']).to eq 'A'
       }
     end
 
-    it 'placeholder[VALUE]' do
+    it 'placeholder: value' do
       TestCodebase.in_test_app_dir {
         expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']).to be_nil
       }
-      TestCodebase.rake_result('i18n:add_missing:placeholder', 'all', 'TRME')
+      run_cmd :add_missing, locales: 'all', placeholder: 'TRME'
       TestCodebase.in_test_app_dir {
         expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']['a']).to eq 'TRME'
         # does not touch existing, but moves to the right file:
@@ -91,18 +98,18 @@ describe 'rake i18n' do
     end
   end
 
-  describe 'tasks_config' do
+  describe 'config' do
     it 'prints config' do
-      expect(YAML.load(TestCodebase.rake_result('i18n:tasks_config'))).to(
+      expect(YAML.load(run_cmd :config)).to(
           eq TestCodebase.in_test_app_dir { I18n::Tasks::BaseTask.new.config_for_inspect }
       )
     end
   end
 
-  describe 'usages' do
+  describe 'find' do
     it 'prints usages' do
       capture_stderr do
-        expect(TestCodebase.rake_result('i18n:usages', 'used.*')).to eq(<<-TXT)
+        expect(run_cmd :find, arguments: ['used.*']).to eq(<<-TXT)
 used.a 2
   app/views/usages.html.slim:1 p = t 'used.a'
   app/views/usages.html.slim:2 b = t 'used.a'

data/spec/spec_helper.rb

@@ -11,9 +11,6 @@ $: << File.expand_path('../lib', __FILE__)
 require 'i18n/tasks'
 require 'rake'
 
-Rake.load_rakefile 'tasks/i18n-tasks.rake'
-Rake.load_rakefile 'support/test_codebase_env.rake'
-
 require 'term/ansicolor'
 Term::ANSIColor::coloring = false
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.3.0.rc1
+  version: 0.3.0
 platform: ruby
 authors:
 - glebm
@@ -10,20 +10,6 @@ bindir: bin
 cert_chain: []
 date: 2014-02-27 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  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: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -212,6 +198,7 @@ files:
 - README.md
 - Rakefile
 - bin/i18n-tasks
+- doc/img/i18n-tasks.png
 - i18n-tasks.gemspec
 - lib/i18n/tasks.rb
 - lib/i18n/tasks/base_task.rb
@@ -235,7 +222,6 @@ files:
 - lib/i18n/tasks/key_pattern_matching.rb
 - lib/i18n/tasks/missing_keys.rb
 - lib/i18n/tasks/plural_keys.rb
-- lib/i18n/tasks/railtie.rb
 - lib/i18n/tasks/relative_keys.rb
 - lib/i18n/tasks/reports/base.rb
 - lib/i18n/tasks/reports/spreadsheet.rb
@@ -247,7 +233,6 @@ files:
 - lib/i18n/tasks/unused_keys.rb
 - lib/i18n/tasks/used_keys.rb
 - lib/i18n/tasks/version.rb
-- lib/tasks/i18n-tasks.rake
 - spec/file_system_data_spec.rb
 - spec/fixtures/app/assets/javascripts/application.js
 - spec/fixtures/app/controllers/events_controller.rb
@@ -268,7 +253,6 @@ files:
 - spec/support/i18n_tasks_output_matcher.rb
 - spec/support/key_pattern_matcher.rb
 - spec/support/test_codebase.rb
-- spec/support/test_codebase_env.rake
 - spec/used_keys_spec.rb
 homepage: https://github.com/glebm/i18n-tasks
 licenses:
@@ -286,9 +270,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.14
@@ -317,6 +301,5 @@ test_files:
 - spec/support/i18n_tasks_output_matcher.rb
 - spec/support/key_pattern_matcher.rb
 - spec/support/test_codebase.rb
-- spec/support/test_codebase_env.rake
 - spec/used_keys_spec.rb
 has_rdoc: 

data/lib/i18n/tasks/railtie.rb

@@ -1,12 +0,0 @@
-module I18n
-  module Tasks
-    class Railtie < ::Rails::Railtie
-      rake_tasks do
-        load 'tasks/i18n-tasks.rake'
-        namespace :i18n do
-          task :setup => 'environment'
-        end
-      end
-    end
-  end
-end

data/lib/tasks/i18n-tasks.rake

@@ -1,79 +0,0 @@
-require 'i18n/tasks'
-require 'i18n/tasks/commands'
-
-cmd = I18n::Tasks::Commands.new
-
-namespace :i18n do
-  task :setup do
-  end
-
-  desc cmd.desc :missing
-  task :missing, [:locales] => 'i18n:setup' do |t, args|
-    cmd.missing locales: args[:locales]
-  end
-
-  namespace :missing do
-    desc 'keys present in code but not existing in base locale data'
-    task :missing_from_base => 'i18n:setup' do
-      cmd.missing type: :missing_from_base
-    end
-
-    desc 'keys present but with value same as in base locale'
-    task :eq_base, [:locales] => 'i18n:setup' do |t, args|
-      cmd.missing type: :eq_base, locales: args[:locales]
-    end
-
-    desc 'keys that exist in base locale but are blank in passed locales'
-    task :missing_from_locale, [:locales] => 'i18n:setup' do |t, args|
-      cmd.missing type: :missing_from_locale, locales: args[:locales]
-    end
-  end
-
-  desc cmd.desc :show_unused
-  task :unused => 'i18n:setup' do
-    cmd.unused
-  end
-
-  desc cmd.desc :remove_unused
-  task :remove_unused, [:locales] => 'i18n:setup' do |t, args|
-    cmd.remove_unused
-  end
-
-  desc cmd.desc :usages
-  task :usages, [:filter] => 'i18n:setup' do |t, args|
-    cmd.find filter: args[:filter]
-  end
-
-  desc cmd.desc :normalize
-  task :normalize, [:locales] => 'i18n:setup' do |t, args|
-    cmd.normalize locales: args[:locales]
-  end
-
-  namespace :add_missing do
-    desc 'add Google Translated values for untranslated keys to locales (default: all non-base)'
-    task :translate, [:locales] => 'i18n:setup' do |t, args|
-      cmd.translate locales: args[:locales]
-    end
-
-    desc 'copy base locale values for all untranslated keys to locales (default: all non-base)'
-    task :placeholder, [:locales, :placeholder] => 'i18n:setup' do |t, args|
-      cmd.add_missing locale: args[:locales], placeholder: args[:placeholder]
-    end
-
-    desc 'add values for missing and untranslated keys to locales (default: all)'
-    task :empty_string, [:locales] => 'i18n:setup' do |t, args|
-      cmd.add_missing locales: args[:locales], placeholder: ''
-    end
-  end
-
-  desc cmd.desc(:config)
-  task :tasks_config => 'i18n:setup' do
-    cmd.config
-  end
-
-  desc cmd.desc :save_spreadsheet
-  task :spreadsheet_report, [:path] => 'i18n:setup' do |t, args|
-    cmd.xlsx_report path: args[:path]
-  end
-end
-

data/spec/support/test_codebase_env.rake

@@ -1,10 +0,0 @@
-task :environment do
-  Thread.exclusive do
-    I18n.default_locale    = 'en'
-    I18n.available_locales = %w(en es)
-  end
-end
-
-namespace :i18n do
-  task :setup => 'environment'
-end