i18n-tasks 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6579b9cbd049e1fa2d48871a7ca13f7fd8ad96a4
-  data.tar.gz: eaa10ec60b66db271f1c3f25f7369d4c0ba6e36e
+  metadata.gz: 03263ddf669098e8580e4656d41e7b15d2ba5721
+  data.tar.gz: ae4bcf9dee99a2e6cb19e6ee2d52cc34b281e335
 SHA512:
-  metadata.gz: 1119961b325f1bf1f678b42304ed9669f4c8800a865f257a09817ceff1d5bfc69038ebf6ec8932e4833e90fea3b969574b2d3a0315245981a3f230793ae4665c
-  data.tar.gz: 3c69f7d4e2f8edde4dd4407f6e18085fd4d8318565bc366ec1f39288465f345466fd5da8967f9ed279d35f089f75236710f73f0a45cf41e88d9e6cfaf8eaa909
+  metadata.gz: 69aff7e4e6369e2fe1c622255bfda9290a3141eeb28be0fa368af1be3f568e1934d65ee77e66d180025bd2c9279ca4a0aff73e7135fa21b538b1a00941e26540
+  data.tar.gz: e21ca15833a7a7822ce166599863e3d6184cdc7a9535740554cf7e7b29a10e7c013cb34a3be4b54d6a8be4a5d53fb18a1038a9d3a2ce4bbeef06664e2d5f8a1e

data/CHANGES.md

@@ -1,3 +1,12 @@
+## 0.6.0
+
+* New output format options for reports: yaml, json, and inspect.
+* Templates for config and rspec.
+* Keys with values same as base locale have been moved from `missing` into a separate task, `eq-base`.
+* `missing` now also shows keys that are present in some locale but not in base locale.
+* Terminal output: no more Type column in `missing`, first code usage shown for keys missing base value.
+* `relative_roots` configuration key moved to `search.relative_roots`, deprecation warning (removed in the next minor).
+
 ## 0.5.4
 
 * ActiveSupport 3 compatibility

data/README.md

@@ -18,7 +18,7 @@ i18n-tasks can be used with any project using [i18n][i18n-gem] (default in Rails
 Add to Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.5.4'
+gem 'i18n-tasks', '~> 0.6.0'
 ```
 
 
@@ -36,14 +36,16 @@ Available commands:
 
   missing             show missing translations
   unused              show unused translations
+  eq-base             show translations equal to base value
+  find                show where the keys are used in the code
   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
-  irb                 irb session within i18n-tasks context
+  irb                 REPL session within i18n-tasks context
+  gem-path            show path to the gem
 
 See `<command> --help` for more information on a specific command.
 ```
@@ -122,11 +124,10 @@ Translation data storage, key usage search, and other [settings](#configuration)
 Configuration is read from `config/i18n-tasks.yml` or `config/i18n-tasks.yml.erb`.
 Inspect configuration with `i18n-tasks config`.
 
+Install the default config file with:
 
-You can generate a config file with:
-
-```ruby
-i18n-tasks config > config/i18n-tasks.yml
+```bash
+cp $(i18n-tasks gem-path)/templates/config/i18n-tasks.yml spec/
 ```
 
 ### Locales
@@ -239,6 +240,12 @@ search:
   paths:
     - 'app/'
     - 'vendor/'
+  # paths for relative key resolution:
+  relative_roots:
+    # default:
+    - app/views
+    # add a custom one:
+    - app/views-mobile
   # include only files matching this glob pattern (default: blank = include all files)
   include:
     - '*.rb'
@@ -254,18 +261,6 @@ search:
     - "^\\s*[#/](?!\\si18n-tasks-use)"
 ```
 
-To configure paths for relative key resolution:
-
-```yaml
-# config/i18n-tasks.yml
-# directories containing relative keys
-relative_roots:
-  # default:
-  - app/views
-  # add a custom one:
-  - app/views-mobile
-```
-
 It is also possible to use a custom key usage scanner by setting `search.scanner` to a class name.
 See this basic [pattern scanner](/lib/i18n/tasks/scanners/pattern_scanner.rb) for reference.
 
@@ -320,25 +315,12 @@ translation:
 ## RSpec integration
 
 You might want to test for missing and unused translations as part of your test suite.
-This is how you can do it with rspec:
-
-```ruby
-# spec/i18n_spec.rb:
-require 'spec_helper'
-require 'i18n/tasks'
+Install the spec file:
 
-describe 'I18n' do
-  let(:i18n) { I18n::Tasks::BaseTask.new }
-
-  it 'does not have missing keys' do
-    expect(i18n.missing_keys).to be_empty
-  end
-
-  it 'does not have unused keys' do
-    expect(i18n.unused_keys).to be_empty
-  end
-end
+```bash
+cp $(i18n-tasks gem-path)/templates/rspec/i18n_spec.rb spec/
 ```
+
 ### XLSX
 
 Export missing and unused data to XLSX:
@@ -351,6 +333,34 @@ i18n-tasks xlsx-report
 
 While i18n-tasks does not provide an HTML version of the report, you can add [one like this](https://gist.github.com/glebm/bdd3ab6d12d915f0c81b).
 
+
+## Add New Tasks
+
+Tasks that come with the gem are defined in [lib/i18n/tasks/commands.rb](lib/i18n/tasks/commands.rb).
+
+You can add a new task by re-opening the class and loading it in i18n-tasks.yml:
+
+```ruby
+# lib/i18n/tasks/my_task.rb
+I18n::Tasks::Commands.class_eval do
+  desc 'my task'
+  cmd :my_task do |opts = {}|
+    puts i18n.data[opts[:arguments].try(:first) || base_locale]
+  end
+end
+```
+
+```yaml
+# config/i18n-tasks.yml
+<% require 'i18n/tasks/my_task' %>
+```
+
+Run with:
+
+```console
+$ i18n-tasks my-task
+```
+
 [MIT license]: /LICENSE.txt
 [travis]: https://travis-ci.org/glebm/i18n-tasks
 [badge-travis]: http://img.shields.io/travis/glebm/i18n-tasks.svg

data/Rakefile

@@ -1,7 +1,7 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+RSpec::Core::RakeTask.new(:rspec)
+task :default => :rspec
 
 task :irb do
   # $: << File.expand_path('lib', __FILE__)

data/lib/i18n/tasks/base_task.rb

@@ -1,5 +1,6 @@
 # coding: utf-8
 require 'i18n/tasks/command_error'
+require 'i18n/tasks/split_key'
 require 'i18n/tasks/key_pattern_matching'
 require 'i18n/tasks/logging'
 require 'i18n/tasks/plural_keys'
@@ -16,6 +17,7 @@ require 'i18n/tasks/configuration'
 module I18n
   module Tasks
     class BaseTask
+      include SplitKey
       include KeyPatternMatching
       include PluralKeys
       include UsedKeys

data/lib/i18n/tasks/commands.rb

@@ -9,91 +9,116 @@ module I18n::Tasks
     require 'highline/import'
 
     on_locale_opt = { as: Array, delimiter: /[+:,]/, default: 'all', argument: true, optional: false }
+    OPT = {
+        locale: proc {
+          on '-l', :locales=,
+             'Filter by locale(s), comma-separated list (e.g. en,fr) or all (default: all), also accepted as arguments without -l',
+             on_locale_opt
+        },
+        format: proc {
+          on '-f', :format=,
+             'Format: terminal-table, terminal-tree, json, yaml. Default: terminal-table.',
+             {default: 'terminal-table', argument: true, optional: false}
+        }
+    }
     desc 'show missing translations'
     opts do
-      on '-l', :locales=, 'Filter by locale (default: all)', on_locale_opt
-      on '-t', :types=, 'Filter by type (types: missing_from_base, eq_base, missing_from_locale)', as: Array, delimiter: /[+:,]/
+      instance_exec &OPT[:locale]
+      instance_exec &OPT[:format]
+      on '-t', :types=, 'Filter by type (types: used, diff)', as: Array, delimiter: /[+:,]/
     end
     cmd :missing do |opt = {}|
       parse_locales! opt
-      terminal_report.missing_keys i18n_task.missing_keys(opt)
+      print_locale_tree i18n.missing_keys(opt), opt, :missing_keys
     end
 
     desc 'show unused translations'
     opts do
-      on '-l', :locales=, 'Filter by locale (default: all)', on_locale_opt
+      instance_exec &OPT[:locale]
+      instance_exec &OPT[:format]
     end
     cmd :unused do |opt = {}|
       parse_locales! opt
-      terminal_report.unused_keys i18n_task.unused_keys(opt)
+      print_locale_tree i18n.unused_keys(opt), opt, :unused_keys
+    end
+
+    desc 'show translations equal to base value'
+    opts do
+      instance_exec &OPT[:format]
+    end
+    cmd :eq_base do |opt = {}|
+      parse_locales! opt
+      print_locale_tree i18n.eq_base_keys(opt), opt, :eq_base_keys
+    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
+      instance_exec &OPT[:format]
+    end
+    cmd :find do |opt = {}|
+      opt[:filter] ||= opt.delete(:pattern) || opt[:arguments].try(:first)
+      print_locale_tree i18n.used_tree(key_filter: opt[:filter].presence, source_locations: true), opt, :used_keys
     end
 
+
     desc 'translate missing keys with Google Translate'
     opts do
-      on '-l', :locales=, 'Locales to translate (default: all)', on_locale_opt
+      on '-l', :locales=, 'Locales to translate (comma-separated, default: all)', on_locale_opt
       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'
       parse_locales! opt
-      i18n_task.fill_missing_google_translate opt
+      i18n.fill_missing_google_translate opt
     end
 
     desc 'add missing keys to the locales'
     opts do
-      on '-l', :locales=, 'Locales to add keys into (default: all)', on_locale_opt
+      on '-l', :locales=, 'Locales to add keys into (comma-separated, default: all)', on_locale_opt
       on '-p', :placeholder=, 'Value for empty keys (default: base value or key.humanize)', argument: true, optional: false
     end
     cmd :add_missing do |opt = {}|
       parse_locales! opt
       opt[:value] ||= opt.delete(:placeholder) || proc { |key, locale|
         # default to base value or key.humanize
-        locale != base_locale && t(key, base_locale) || key.split('.').last.to_s.humanize
+        locale != base_locale && t(key, base_locale) || SplitKey.split_key(key).last.to_s.humanize
       }
 
       v = opt[:value]
       if v.is_a?(String) && v.include?('%{base_value}')
-        opt[:value] = proc { |key, locale|
-          base_value = t(key, base_locale) || ''
+        opt[:value] = proc { |key, locale, node|
+          base_value = node.value || t(key, base_locale) || ''
           v % {base_value: base_value}
         }
       end
 
-      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)
-      terminal_report.used_keys i18n_task.used_tree(key_filter: opt[:filter].presence, source_locations: true)
+      i18n.fill_missing_value opt
     end
 
     desc 'normalize translation data: sort and move to the right files'
     opts do
-      on '-l', :locales=, 'Locales to normalize (default: all)', on_locale_opt
+      on '-l', :locales=, 'Locales to normalize (comma-separated, default: all)', on_locale_opt
       on '-p', :pattern_router, 'Use pattern router, regardless of config.', argument: false, optional: true
     end
     cmd :normalize do |opt = {}|
       parse_locales! opt
-      i18n_task.normalize_store! opt[:locales], opt[:pattern_router]
+      i18n.normalize_store! opt[:locales], opt[:pattern_router]
     end
 
     desc 'remove unused keys'
     opts do
-      on '-l', :locales=, 'Locales to remove unused keys from (default: all)', on_locale_opt
+      on '-l', :locales=, 'Locales to remove unused keys from (comma-separated, default: all)', on_locale_opt
     end
     cmd :remove_unused do |opt = {}|
       parse_locales! opt
-      unused_keys = i18n_task.unused_keys(opt)
+      unused_keys = i18n.unused_keys(opt)
       if unused_keys.present?
         terminal_report.unused_keys(unused_keys)
         unless ENV['CONFIRM']
           exit 1 unless agree(red "#{unused_keys.leaves.count} translations will be removed in #{bold opt[:locales] * ', '}#{red '.'} " + yellow('Continue? (yes/no)') + ' ')
         end
-        i18n_task.remove_unused!(opt[:locales])
+        i18n.remove_unused!(opt[:locales])
         $stderr.puts "Removed #{unused_keys.leaves.count} keys"
       else
         $stderr.puts bold green 'No unused keys to remove'
@@ -102,7 +127,7 @@ module I18n::Tasks
 
     desc 'display i18n-tasks configuration'
     cmd :config do
-      cfg = i18n_task.config_for_inspect.to_yaml
+      cfg = i18n.config_for_inspect.to_yaml
       cfg.sub! /\A---\n/, ''
       cfg.gsub! /^([^\s-].+?:)/, Term::ANSIColor.cyan(Term::ANSIColor.bold('\1'))
       puts cfg
@@ -129,14 +154,9 @@ module I18n::Tasks
       ::I18n::Tasks::ConsoleContext.start
     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)
+    desc 'show path to the gem'
+    cmd :gem_path do
+      puts File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..'))
     end
   end
 end

data/lib/i18n/tasks/commands_base.rb

@@ -1,21 +1,22 @@
 # coding: utf-8
 require 'ostruct'
+require 'set'
 module I18n::Tasks
   class CommandsBase
     include ::I18n::Tasks::Logging
 
-    def initialize(i18n_task = nil)
-      @i18n_task = i18n_task
+    def initialize(i18n = nil)
+      @i18n = i18n
     end
 
     def locales_opt(locales)
-      return i18n_task.locales if locales == ['all'] || locales == 'all'
+      return i18n.locales if locales == ['all'] || locales == 'all'
       if locales.present?
         locales = Array(locales).map { |v| v.strip.split(/\s*[\+,:]\s*/).compact.presence if v.is_a?(String) }.flatten
         locales = locales.map(&:presence).compact.map { |v| v == 'base' ? base_locale : v }
         locales
       else
-        i18n_task.locales
+        i18n.locales
       end
     end
 
@@ -25,6 +26,32 @@ module I18n::Tasks
       end
     end
 
+
+    VALID_TREE_FORMATS = %w(terminal-table yaml json inspect)
+
+    def print_locale_tree(tree, opt, version = :show_tree)
+      format = opt[:format] || VALID_TREE_FORMATS.first
+      raise CommandError.new("unknown format: #{format}. Valid formats are: #{VALID_TREE_FORMATS * ', '}.") unless VALID_TREE_FORMATS.include?(format)
+      case format
+        when 'terminal-table'
+          terminal_report.send(version, tree)
+        when 'inspect'
+          puts tree.inspect
+        else
+          puts i18n.data.adapter_dump tree, i18n.data.adapter_by_name(format)
+      end
+    end
+
+    protected
+
+    def terminal_report
+      @terminal_report ||= I18n::Tasks::Reports::Terminal.new(i18n)
+    end
+
+    def spreadsheet_report
+      @spreadsheet_report ||= I18n::Tasks::Reports::Spreadsheet.new(i18n)
+    end
+
     class << self
       def cmds
         @cmds ||= {}.with_indifferent_access
@@ -35,8 +62,8 @@ module I18n::Tasks
         @next_def  = {}
         define_method name do |*args|
           begin
-            coloring_was = Term::ANSIColor.coloring?
-            Term::ANSIColor.coloring = STDOUT.isatty
+            coloring_was             = Term::ANSIColor.coloring?
+            Term::ANSIColor.coloring = ENV['I18N_TASKS_COLOR'] || STDOUT.isatty
             instance_exec *args, &block
           rescue CommandError => e
             log_error e.message
@@ -65,10 +92,10 @@ module I18n::Tasks
       self.class.cmds.try(:[], name).try(:desc)
     end
 
-    def i18n_task
-      @i18n_task ||= I18n::Tasks::BaseTask.new
+    def i18n
+      @i18n ||= I18n::Tasks::BaseTask.new
     end
 
-    delegate :base_locale, :t, to: :i18n_task
+    delegate :base_locale, :t, to: :i18n
   end
 end

data/lib/i18n/tasks/configuration.rb

@@ -13,8 +13,17 @@ module I18n::Tasks::Configuration
 
   def file_config
     file = CONFIG_FILES.detect { |f| File.exists?(f) }
-    file = YAML.load(Erubis::Eruby.new(File.read(file)).result) if file
-    {}.with_indifferent_access.merge(file.presence || {})
+    config = file && YAML.load(Erubis::Eruby.new(File.read(file)).result)
+    if config.present?
+      config.with_indifferent_access.tap do |c|
+        if c[:relative_roots]
+          warn_deprecated 'config/i18n-tasks.yml has relative_roots on top level. Please move relative_roots under search.'
+          c[:search][:relative_roots] = c.delete(:relative_roots)
+        end
+      end
+    else
+      {}.with_indifferent_access
+    end
   end
 
   def config=(conf)
@@ -34,10 +43,6 @@ module I18n::Tasks::Configuration
     end
   end
 
-  def relative_roots
-    @config_sections[:relative_roots] ||= config[:relative_roots].presence || %w(app/views)
-  end
-
   # translation config
   # @return [Hash{String => String,Hash,Array}]
   def translation_config
@@ -75,21 +80,18 @@ module I18n::Tasks::Configuration
     end
   end
 
-  def non_base_locales(from = nil)
-    from ||= self.locales
-    Array(from) - [base_locale]
-  end
-
   # @return [String] default i18n locale
   def base_locale
     @config_sections[:base_locale] ||= (config[:base_locale] || 'en').to_s
   end
 
+
   def ignore_config(type = nil)
     key = type ? "ignore_#{type}" : 'ignore'
     @config_sections[key] ||= config[key]
   end
 
+  IGNORE_TYPES = [nil, :missing, :unused, :eq_base].freeze
   # evaluated configuration (as the app sees it)
   def config_sections
     # init all sections
@@ -97,9 +99,8 @@ module I18n::Tasks::Configuration
     locales
     data_config
     search_config
-    relative_roots
     translation_config
-    [nil, :missing, :unused, :eq_base].each do |ignore_type|
+    IGNORE_TYPES.each do |ignore_type|
       ignore_config ignore_type
     end
     @config_sections