i18n-tasks 0.2.22 → 0.3.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 563f9b661577921d66001c94c5f6e860762bb5a6
-  data.tar.gz: 14ef151e45ddaf53c720fc91c48630465bfe05aa
+  metadata.gz: 79c771676a7ab2418350137799e74f5cfe9a84c9
+  data.tar.gz: fa7170a9f5aa0f0a557b87499c48a393ebf47a81
 SHA512:
-  metadata.gz: c253a433900be103dccdee48ecdad65053b694a0ca497f75c3acf7d1a094d4e4b6bf9c279667b391db5701c5a4e56b5b761638129e1a8016892e43927cfefb83
-  data.tar.gz: 16ad12978adba7925e0ad2851d753e3c266b07fdcfc58c44717b93c07992629343b2c56c372feb5dc09e9007eed8e96813c6349e1de72c830e59383289c0a495
+  metadata.gz: b9af27eac0d3d7e2c68154a5b21f9b1aa3bd1d29940cceced793c57fe0263346cb20c5e3a9f5faf2ecb0bc8160e561b7b566e40b5634e934782b973c4bfb451d
+  data.tar.gz: 133cf042e3d976e3e6fc8a670428c2b91743e0abfba53c58bdf5d67e6c8511b61bd97ae5c5ca5d231e81cb5a6db536e01e7ca017d8e8f4343f90d682bad8fb62

data/CHANGES.md

@@ -1,4 +1,8 @@
-## v0.2.21
+## v0.3.0 (unreleased)
+
+* i18n-tasks provides a binary instead of rake tasks now (though the tasks are still there for now).
+
+## v0.2.21..v0.2.22
 
 * `rake i18n:usages[pattern]`
 * performance regression fixes

data/Gemfile

@@ -14,4 +14,3 @@ end
 group :development do
   gem 'coveralls', require: false
 end
-

data/README.md

@@ -7,83 +7,101 @@ Tasks to manage translations in ruby applications using I18n.
 
 ## Installation
 
-Simply add to Gemfile:
+1. Add to Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.2.21'
+gem 'i18n-tasks', '~> 0.3.0'
 ```
 
-If not using Rails, require the tasks in Rakefile:
+2. Create a config file at `config/i18n-tasks.yml`:
 
-```ruby
-# Rakefile
-load 'tasks/i18n-tasks.rake'
+```yaml
+# config/i18n-tasks.yml
+base_locale: en
+locales: [es, fr]
 ```
 
 ## Usage
 
-Use `rake -T i18n` to get the list of tasks with descriptions. These are [the tasks](/lib/tasks/i18n-tasks.rake) available:
-
-There are reports for missing and unused translations:
+Run `i18n-tasks` to get the list of tasks with short descriptions.
 
 ```bash
-rake i18n:missing
-rake i18n:unused
-```
-
-To remove unused translations run:
-
-```bash
-rake i18n:remove_unused # this will print the unused report and ask for confirmation before deleting keys
+$ i18n-tasks
+Usage: i18n-tasks [command] [options]
+    -v, --version      Print the version
+    -h, --help         Display this help message.
+
+Available commands:
+
+  missing             show missing translations
+  unused              show unused translations
+  translate-missing   translate missing keys with Google Translate
+  add-missing         add missing keys to the locales
+  find                show where the keys are used in the code
+  normalize           normalize translation data: sort and move to the right files
+  remove-unused       remove unused keys
+  config              display i18n-tasks configuration
+  xlsx-report         save missing and unused translations to an Excel file
+
+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.
 
-To add the keys that are not in the base locale but detected in the source do:
+
+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:
 
 ```bash
-# add missing keys to the base locale data (I18n.default_locale)
-# values set to to the optional [argument] or key.humanize
-rake i18n:add_missing
+i18n-tasks add-missing[base]
 ```
 
 Prefill empty translations using Google Translate ([more below on the API key](#translation-config)).
 
 ```bash
-rake i18n:fill:google_translate
+i18n-tasks translate-missing
 # this task and the ones below can also accept specific locales:
-rake i18n:fill:google_translate[es+de]
+i18n-tasks translate-missing -l es,de
 ```
 
-Prefill using values from the base locale - `I8n.default_locale`:
+Sort the keys and write them to their respective files:
+
 ```bash
-rake i18n:fill:base_value
+# always happens on add-missing or translate-missing
+i18n-tasks normalize
 ```
 
-i18n-tasks sorts the keys and writes them to their respective files:
+Unused report will detect pattern translations and not report them, e.g.:
 
-```bash
-# this happens automatically on any i18n:fill:* task
-rake i18n:normalize 
+```ruby
+t 'category.' + category.key      # all 'category.*' keys are considered used
+t "category.#{category.key}.name" # all 'category.*.name' keys are considered used
 ```
 
+Relative keys (`t '.title'`) and plural keys (key.one/many/other/etc) are fully supported.
 
-`i18n:unused` will detect pattern translations and not report them, e.g.:
+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):
 
 ```ruby
-t 'category.' + category.key # category.* keys are all considered used
-t "category.#{category.key}" # also works
+# this is supported
+t :invalid, scope: [:auth, :password], attempts: 5
+# but not this
+t :invalid, attempts: 5, scope: [:auth, :password]
 ```
 
-Relative keys (`t '.title'`) and plural keys (key.one/many/other/etc) are fully supported.
-
 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`.
 
-By default, `i18n-tasks` will work with `I18n.default_locale` and `I18n.available_locales`, but you can override this:
+### 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:
 
 ```yaml
 # config/i18n-tasks.yml
@@ -91,13 +109,6 @@ base_locale: en
 locales: [es, fr]
 ```
 
-On Rails, if locales are set in the config file, you can make i18n tasks a lot faster by adding this to `Rakefile`:
-
-```ruby
-# disable loading :environment for i18n-tasks
-Rake::Task['i18n:setup'].clear_prerequisites
-```
-
 ### Storage
 
 ```yaml
@@ -143,14 +154,13 @@ data:
 Inspect all the usages with:
 
 ```bash
-rake i18n:usages
+i18n-tasks find
 # Filter by a key pattern
-rake i18n:usages[auth.*]
-# Because commas are not allowed inside rake arguments, + is used here instead
-rake i18n:usages['{number+currency}.format.*']
+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 "rake i18n:usages output screenshot")
+![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`:
@@ -222,7 +232,7 @@ ignore:
 <a name="translation-config"></a>
 ### Google Translate
 
-`rake i18n:fill:google_translate` requires a Google Translate API key, get it at [Google API Console](https://code.google.com/apis/console).
+`i18n-tasks translate-missing` requires a Google Translate API key, get it at [Google API Console](https://code.google.com/apis/console).
 Put the key in `GOOGLE_TRANSLATE_API_KEY` environment variable or in the config file.
 
 ```yaml
@@ -260,7 +270,7 @@ end
 Export missing and unused data to XLSX:
 
 ```bash
-rake i18n:spreadsheet_report
+i18n-tasks xlsx-report
 ```
 
 

data/bin/i18n-tasks

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'i18n/tasks'
+require 'i18n/tasks/commands'
+require 'slop'
+
+command = nil
+slop    = Slop.parse(help: true) do
+  on('-v', '--version', 'Print the version') {
+    puts I18n::Tasks::VERSION
+    exit
+  }
+  ::I18n::Tasks::Commands.cmds.each do |name, attr|
+    command name.tr('_', '-') do
+      description attr.desc if attr.desc
+      instance_exec(&attr.opts) if attr.opts
+      run do |opts, args|
+        command = [name, opts, args]
+      end
+    end
+  end
+end
+
+if command
+  cmd  = ::I18n::Tasks::Commands.new
+  meth = command[0]
+  if cmd.method(meth).arity == 0
+    cmd.send meth
+  else
+    opt = command[1].to_hash.merge(arguments: command[2])
+    STDERR.puts Term::ANSIColor.green "i18n-tasks: #{meth.tr('_', '-')} #{opt.reject { |k, v| v.blank? }.map { |k, v| "#{k}=#{v}" } * ' '}"
+    cmd.send meth, opt
+  end
+else
+  STDERR.puts Term::ANSIColor.red "Command unknown: #{ARGV[0]}" if ARGV[0]
+  puts slop.help
+  exit 64
+end

data/i18n-tasks.gemspec

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

data/lib/i18n/tasks/commands.rb

@@ -0,0 +1,121 @@
+require 'i18n/tasks/commands_base'
+require 'i18n/tasks/reports/terminal'
+require 'i18n/tasks/reports/spreadsheet'
+
+module I18n::Tasks
+  class Commands < CommandsBase
+    include Term::ANSIColor
+    require 'highline/import'
+
+    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: /[+:,]/
+    end
+    cmd :missing do |opt = {}|
+      opt[:locales] = locales_opt(opt[:locales])
+      terminal_report.missing_keys i18n_task.missing_keys(opt)
+    end
+
+    desc 'show unused translations'
+    cmd :unused do
+      terminal_report.unused_keys
+    end
+
+    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'
+    end
+    cmd :translate_missing do |opt = {}|
+      opt[:from] = base_locale if opt[:from].blank? || opt[:from] == 'base'
+      opt[:locales] = locales_opt(opt[:locale] || opt[:locales])
+      i18n_task.fill_missing_google_translate opt
+    end
+
+    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: /[+:,]/
+    end
+    cmd :add_missing do |opt = {}|
+      opt[:locales] = locales_opt(opt[:locale] || opt[:locales])
+      opt[:value] ||= opt.delete(:placeholder)
+      opt[:value] ||= proc { |key, locale|
+        # default to base value or key.humanize
+        locale == base_locale && t(locale, base_locale) || key.split('.').last.to_s.humanize
+      }
+      i18n_task.fill_missing_value opt
+    end
+
+    desc 'show where the keys are used in the code'
+    opts do
+      on '-p', :pattern, 'Show only keys matching pattern', argument: true, optional: false
+    end
+    cmd :find do |opt = {}|
+      opt[:filter] ||= opt.delete(:pattern) || opt[:arguments].try(:first)
+      filter = opt[:filter].is_a?(String) ? opt[:filter].tr('+', ',') : nil
+      used_keys = i18n_task.scanner.with_key_filter(filter) {
+        i18n_task.used_keys true
+      }
+      terminal_report.used_keys used_keys
+    end
+
+    desc 'normalize translation data: sort and move to the right files'
+    opts do
+      on '-l', :locales=, 'Only for specified locales', as: Array, delimiter: /[+:,]/
+    end
+    cmd :normalize do |opt = {}|
+      i18n_task.normalize_store! locales_opt(opt[:locales])
+    end
+
+    desc 'remove unused keys'
+    opts do
+      on '-l', :locales=, 'Only for specified locales', as: Array, delimiter: /[+:,]/
+    end
+    cmd :remove_unused do |opt = {}|
+      locales = locales_opt opt[:locales]
+      unused_keys = i18n_task.unused_keys
+      if unused_keys.present?
+        terminal_report.unused_keys(unused_keys)
+        unless ENV['CONFIRM']
+          exit 1 unless agree(red "All these translations will be removed in #{bold locales * ', '}#{red '.'} " + yellow('Continue? (yes/no)') + ' ')
+        end
+        i18n_task.remove_unused!(locales)
+        $stderr.puts "Removed #{unused_keys.size} keys"
+      else
+        $stderr.puts bold green 'No unused keys to remove'
+      end
+    end
+
+    desc 'display i18n-tasks configuration'
+    cmd :config do
+      puts i18n_task.config_for_inspect.to_yaml.sub(/\A---\n/, '').gsub('!ruby/hash:ActiveSupport::HashWithIndifferentAccess', '')
+    end
+
+    desc 'save missing and unused translations to an Excel file'
+    opts do
+      on :path, 'Destination path', default: 'tmp/i18n-report.xlsx'
+    end
+    cmd :xlsx_report do |opt = {}|
+      begin
+        require 'axlsx'
+      rescue LoadError
+        message = %Q(For spreadsheet report please add axlsx gem to Gemfile:\ngem 'axlsx', '~> 2.0')
+        STDERR.puts Term::ANSIColor.red Term::ANSIColor.bold message
+        exit 1
+      end
+      spreadsheet_report.save_report opt[:path]
+    end
+
+    protected
+
+    def terminal_report
+      @terminal_report ||= I18n::Tasks::Reports::Terminal.new(i18n_task)
+    end
+
+    def spreadsheet_report
+      @spreadsheet_report ||= I18n::Tasks::Reports::Spreadsheet.new(i18n_task)
+    end
+  end
+end

data/lib/i18n/tasks/commands_base.rb

@@ -0,0 +1,54 @@
+require 'ostruct'
+module I18n::Tasks
+  class CommandsBase
+    def locales_opt(value, default = nil)
+      if value.is_a?(String)
+        value = value.strip.split(/\s*\+\s*/).compact.presence
+      end
+      return i18n_task.locales if value == ['all']
+      if value.present?
+        value = value.map { |v| v == 'base' ? base_locale : v }
+        value
+      else
+        default || i18n_task.locales
+      end
+    end
+
+    class << self
+      def cmds
+        @cmds ||= {}.with_indifferent_access
+      end
+
+      def cmd(name, &block)
+        cmds[name] = OpenStruct.new(@next_def)
+        @next_def  = {}
+        define_method(name, &block)
+      end
+
+      def desc(text)
+        next_def[:desc] = text
+      end
+
+      def opts(&block)
+        next_def[:opts] = block
+      end
+
+      private
+      def next_def
+        @next_def ||= {}
+      end
+    end
+
+    def desc(name)
+      self.class.cmds.try(:[], name).try(:desc)
+    end
+
+    protected
+
+    def i18n_task
+      @i18n_task ||= I18n::Tasks::BaseTask.new
+    end
+
+    delegate :base_locale, :t, to: :i18n_task
+  end
+end

data/lib/i18n/tasks/configuration.rb

@@ -33,8 +33,46 @@ module I18n::Tasks::Configuration
   def translation_config
     @config_sections[:translation] ||= begin
       conf           = (config[:translation] || {}).with_indifferent_access
-      conf[:api_key] ||= ENV['GOOGLE_TRANSLATE_API_KEY']
+      conf[:api_key] ||= ENV['GOOGLE_TRANSLATE_API_KEY'] if ENV.key?('GOOGLE_TRANSLATE_API_KEY')
       conf
     end
   end
+
+  def search_config
+    @config_sections[:search] ||= {
+        scanner: scanner.class.name,
+        config:  scanner.config
+    }
+  end
+
+  # @return [Array<String>] all available locales
+  def locales
+    @config_sections[:locales] ||= begin
+      locales = (config[:locales] || I18n.available_locales).map(&:to_s)
+      locales = [base_locale] + locales unless locales.include?(base_locale)
+      locales
+    end
+  end
+
+  # @return [String] default i18n locale
+  def base_locale
+    @config_sections[:base_locale] ||= config[:base_locale] || I18n.default_locale.to_s
+  end
+
+  # evaluated configuration (as the app sees it)
+  def config_sections
+    # init all sections
+    base_locale
+    locales
+    data_config
+    search_config
+    relative_roots
+    translation_config
+    @config_sections
+  end
+
+  def config_for_inspect
+    # hide empty sections, stringify keys
+    Hash[config_sections.reject { |k, v| v.empty? }.map { |k, v| [k.to_s, v.respond_to?(:stringify_keys) ? v.stringify_keys : v] }]
+  end
 end