i18n-tasks 0.6.3 → 0.7.0

data/i18n-tasks.gemspec

@@ -34,6 +34,7 @@ It can also can pre-fill missing keys, including from Google Translate, and it c
   s.add_dependency 'terminal-table'
   s.add_dependency 'highline'
   s.add_dependency 'slop', '>= 3.5.0'
+  s.add_dependency 'i18n'
   s.add_development_dependency 'axlsx', '~> 2.0'
   s.add_development_dependency 'bundler', '~> 1.3'
   s.add_development_dependency 'rake'

data/lib/i18n/tasks.rb

@@ -2,6 +2,11 @@
 # define all the modules to be able to use ::
 module I18n
   module Tasks
+
+    def self.gem_path
+      File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+    end
+
     module Data
     end
   end
@@ -19,3 +24,8 @@ require 'erubis'
 require 'i18n/tasks/version'
 require 'i18n/tasks/base_task'
 
+# Add internal locale data to i18n gem load path
+require 'i18n'
+Dir[File.join(I18n::Tasks.gem_path, 'config', 'locales', '*.yml')].each do |locale_file|
+  I18n.config.load_path << locale_file
+end

data/lib/i18n/tasks/base_task.rb

@@ -4,15 +4,18 @@ require 'i18n/tasks/split_key'
 require 'i18n/tasks/key_pattern_matching'
 require 'i18n/tasks/logging'
 require 'i18n/tasks/plural_keys'
+require 'i18n/tasks/html_keys'
 require 'i18n/tasks/used_keys'
 require 'i18n/tasks/ignore_keys'
 require 'i18n/tasks/missing_keys'
 require 'i18n/tasks/unused_keys'
 require 'i18n/tasks/google_translation'
-require 'i18n/tasks/fill_tasks'
 require 'i18n/tasks/locale_pathname'
+require 'i18n/tasks/locale_list'
+require 'i18n/tasks/string_interpolation'
 require 'i18n/tasks/data'
 require 'i18n/tasks/configuration'
+require 'i18n/tasks/stats'
 
 module I18n
   module Tasks
@@ -20,15 +23,16 @@ module I18n
       include SplitKey
       include KeyPatternMatching
       include PluralKeys
+      include HtmlKeys
       include UsedKeys
       include IgnoreKeys
       include MissingKeys
       include UnusedKeys
-      include FillTasks
       include GoogleTranslation
       include Logging
       include Configuration
       include Data
+      include Stats
 
       def initialize(config = {})
         self.config = config || {}

data/lib/i18n/tasks/command/collection.rb

@@ -0,0 +1,18 @@
+require 'i18n/tasks/command/options/common'
+require 'i18n/tasks/command/options/locales'
+require 'i18n/tasks/command/options/trees'
+
+module I18n::Tasks
+  module Command
+    module Collection
+      def self.included(base)
+        base.module_eval do
+          extend Command::DSL
+          include Command::Options::Common
+          include Command::Options::Locales
+          include Command::Options::Trees
+        end
+      end
+    end
+  end
+end

data/lib/i18n/tasks/command/commander.rb

@@ -0,0 +1,72 @@
+# coding: utf-8
+require 'i18n/tasks/slop_command'
+require 'i18n/tasks/reports/terminal'
+require 'i18n/tasks/reports/spreadsheet'
+
+module I18n::Tasks
+  module Command
+    class Commander
+      include ::I18n::Tasks::Logging
+
+      def initialize(i18n = nil)
+        @i18n = i18n
+      end
+
+      def args_with_stdin(opt)
+        sources = opt[:arguments] || []
+        sources.unshift $stdin.read unless opt[:nostdin]
+        sources
+      end
+
+      def safe_run(name, opts)
+        begin
+          coloring_was             = Term::ANSIColor.coloring?
+          Term::ANSIColor.coloring = ENV['I18N_TASKS_COLOR'] || STDOUT.isatty
+          run name, opts
+        rescue CommandError => e
+          log_error e.message
+          log_verbose e.backtrace * "\n"
+          exit 78
+        ensure
+          Term::ANSIColor.coloring = coloring_was
+        end
+      end
+
+      def run(name, opts)
+        if opts.empty?
+          log_verbose "run #{name.tr('_', '-')} without arguments"
+          send name
+        else
+          log_verbose "run #{name.tr('_', '-')} with #{opts.map { |k, v| "#{k}=#{v}" } * ' '}"
+          send name, opts
+        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 run_command(name, opts)
+          ::I18n::Tasks::Commands.new.safe_run(name, opts)
+        end
+      end
+
+      def desc(name)
+        self.class.cmds.try(:[], name).try(:desc)
+      end
+
+      def i18n
+        @i18n ||= I18n::Tasks::BaseTask.new
+      end
+
+      delegate :base_locale, :t, to: :i18n
+    end
+  end
+end

data/lib/i18n/tasks/command/commands/data.rb

@@ -0,0 +1,73 @@
+module I18n::Tasks
+  module Command
+    module Commands
+      module Data
+        include Command::Collection
+
+        cmd_opt :pattern_router, {
+            short: :p,
+            long:  :pattern_router,
+            desc:  I18n.t('i18n_tasks.cmd.args.desc.pattern_router'),
+            conf:  {argument: false, optional: true}
+        }
+
+        cmd :normalize,
+            args: '[locale ...]',
+            desc: I18n.t('i18n_tasks.cmd.desc.normalize'),
+            opt:  cmd_opts(:locales, :pattern_router)
+
+        def normalize(opt = {})
+          opt_locales! opt
+          i18n.normalize_store! opt[:locales], opt[:pattern_router]
+        end
+
+        cmd :data,
+            args: '[locale ...]',
+            desc: I18n.t('i18n_tasks.cmd.desc.data'),
+            opt:  cmd_opts(:locales, :out_format)
+
+        def data(opt = {})
+          opt_locales! opt
+          opt_output_format! opt
+          print_forest i18n.data_forest(opt[:locales]), opt
+        end
+
+        cmd :data_merge,
+            args: '[tree ...]',
+            desc: I18n.t('i18n_tasks.cmd.desc.data_merge'),
+            opt:  cmd_opts(:data_format, :nostdin)
+
+        def data_merge(opt = {})
+          opt_data_format! opt
+          forest = opt_forests_merged_stdin_args!(opt)
+          merged = i18n.data.merge!(forest)
+          print_forest merged, opt
+        end
+
+        cmd :data_write,
+            args: '[tree]',
+            desc: I18n.t('i18n_tasks.cmd.desc.data_write'),
+            opt:  cmd_opts(:data_format, :nostdin)
+
+        def data_write(opt = {})
+          opt_data_format! opt
+          forest = opt_forest_arg_or_stdin!(opt)
+          i18n.data.write forest
+          print_forest forest, opt
+        end
+
+        cmd :data_remove,
+            args: '[tree]',
+            desc: I18n.t('i18n_tasks.cmd.desc.data_remove'),
+            opt:  cmd_opts(:data_format, :nostdin)
+
+        def data_remove(opt = {})
+          opt_data_format! opt
+          removed = i18n.data.remove_by_key!(opt_forest_arg_or_stdin!(opt))
+          log_stderr 'Removed:'
+          print_forest removed, opt
+        end
+      end
+    end
+  end
+end

data/lib/i18n/tasks/command/commands/eq_base.rb

@@ -0,0 +1,20 @@
+module I18n::Tasks
+  module Command
+    module Commands
+      module EqBase
+        include Command::Collection
+
+        cmd :eq_base,
+            args: '[locale ...]',
+            desc: I18n.t('i18n_tasks.cmd.desc.eq_base'),
+            opt:  cmd_opts(:locales, :out_format)
+
+        def eq_base(opt = {})
+          opt_locales! opt
+          opt_output_format! opt
+          print_forest i18n.eq_base_keys(opt), opt, :eq_base_keys
+        end
+      end
+    end
+  end
+end

data/lib/i18n/tasks/command/commands/health.rb

@@ -0,0 +1,26 @@
+module I18n::Tasks
+  module Command
+    module Commands
+      module Health
+        include Command::Collection
+
+        cmd :health,
+            args: '[locale ...]',
+            desc: I18n.t('i18n_tasks.cmd.desc.health'),
+            opt:  cmd_opts(:locales, :out_format)
+
+        def health(opt = {})
+          opt_locales! opt
+          forest = i18n.data_forest(opt[:locales])
+          stats  = i18n.forest_stats(forest)
+          if stats[:key_count].zero?
+            raise CommandError.new I18n.t('i18n_tasks.health.no_keys_detected')
+          end
+          terminal_report.forest_stats forest, stats
+          missing opt
+          unused opt
+        end
+      end
+    end
+  end
+end

data/lib/i18n/tasks/command/commands/meta.rb

@@ -0,0 +1,35 @@
+module I18n::Tasks
+  module Command
+    module Commands
+      module Meta
+        include Command::Collection
+
+        cmd :config,
+            args: '[section ...]',
+            desc: I18n.t('i18n_tasks.cmd.desc.config')
+
+        def config(opts = {})
+          cfg = i18n.config_for_inspect
+          cfg = cfg.slice(*opts[:arguments]) if opts[:arguments]
+          cfg = cfg.to_yaml
+          cfg.sub! /\A---\n/, ''
+          cfg.gsub! /^([^\s-].+?:)/, Term::ANSIColor.cyan(Term::ANSIColor.bold('\1'))
+          puts cfg
+        end
+
+        cmd :gem_path, desc: I18n.t('i18n_tasks.cmd.desc.gem_path')
+
+        def gem_path
+          puts I18n::Tasks.gem_path
+        end
+
+        cmd :irb, desc: I18n.t('i18n_tasks.cmd.desc.irb')
+
+        def irb
+          require 'i18n/tasks/console_context'
+          ::I18n::Tasks::ConsoleContext.start
+        end
+      end
+    end
+  end
+end

data/lib/i18n/tasks/command/commands/missing.rb

@@ -0,0 +1,73 @@
+module I18n::Tasks
+  module Command
+    module Commands
+      module Missing
+        include Command::Collection
+
+        cmd_opt :missing_types, {
+            short: :t,
+            long:  :types=,
+            desc:  I18n.t('i18n_tasks.cmd.args.desc.missing_types', valid: I18n::Tasks::MissingKeys.missing_keys_types * ', '),
+            conf:  {as: Array, delimiter: /\s*[+:,]\s*/}
+        }
+
+        DEFAULT_ADD_MISSING_VALUE = '%{value_or_human_key}'
+
+        cmd :missing,
+            args: '[locale ...]',
+            desc: I18n.t('i18n_tasks.cmd.desc.missing'),
+            opt:  cmd_opts(:locales, :out_format, :missing_types)
+
+        def missing(opt = {})
+          opt_locales!(opt)
+          opt_output_format!(opt)
+          opt_missing_types!(opt)
+          print_forest i18n.missing_keys(opt), opt, :missing_keys
+        end
+
+        cmd :translate_missing,
+            args: '[locale ...]',
+            desc: I18n.t('i18n_tasks.cmd.desc.translate_missing'),
+            opt:  [cmd_opt(:locales),
+                   cmd_opt(:locale).merge(short: :f, long: :from=, desc: 'Locale to translate from (default: base)'),
+                   cmd_opt(:out_format).except(:short)]
+
+        def translate_missing(opt = {})
+          opt_locales! opt
+          opt_output_format! opt
+          from       = opt_locale! opt, :from
+          translated = (opt[:locales] - [from]).inject i18n.empty_forest do |result, locale|
+            result.merge! i18n.google_translate_forest i18n.missing_tree(locale, from), from, locale
+          end
+          i18n.data.merge! translated
+          log_stderr I18n.t('i18n_tasks.translate_missing.translated', count: translated.leaves.count)
+          print_forest translated, opt
+        end
+
+        cmd :add_missing,
+            args: '[locale ...]',
+            desc: I18n.t('i18n_tasks.cmd.desc.add_missing'),
+            opt:  cmd_opts(:locales, :out_format) <<
+                      cmd_opt(:value).merge(desc: "#{cmd_opt(:value)[:desc]}. #{I18n.t('i18n_tasks.cmd.args.default_text', value: DEFAULT_ADD_MISSING_VALUE)}")
+
+        def add_missing(opt = {})
+          opt_locales! opt
+          opt_output_format! opt
+          forest = i18n.missing_keys(opt).set_each_value!(opt[:value] || DEFAULT_ADD_MISSING_VALUE)
+          i18n.data.merge! forest
+          log_stderr I18n.t('i18n_tasks.add_missing.added', count: forest.leaves.count)
+          print_forest forest, opt
+        end
+
+        private
+
+        def opt_missing_types!(opt)
+          parse_enum_list_opt(opt[:types], I18n::Tasks::MissingKeys.missing_keys_types) do |invalid, valid|
+            I18n.t('i18n_tasks.cmd.errors.invalid_missing_type',
+                   invalid: invalid * ', ', valid: valid * ', ', count: invalid.length)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/tasks/command/commands/tree.rb

@@ -0,0 +1,92 @@
+module I18n::Tasks
+  module Command
+    module Commands
+      module Tree
+        include Command::Collection
+
+        cmd :tree_merge,
+            args: '[tree ...]',
+            desc: I18n.t('i18n_tasks.cmd.desc.tree_merge'),
+            opt:  cmd_opts(:data_format, :nostdin)
+
+        def tree_merge(opts = {})
+          print_forest opt_forests_merged_stdin_args!(opts), opts
+        end
+
+        cmd :tree_filter,
+            args: '[pattern] [tree]',
+            desc: I18n.t('i18n_tasks.cmd.desc.tree_filter'),
+            opt:  cmd_opts(:data_format, :pattern)
+
+        def tree_filter(opt = {})
+          opt_data_format! opt
+          pattern = opt_or_arg!(:pattern, opt)
+          forest  = opt_forest_arg_or_stdin!(opt)
+          unless pattern.blank?
+            pattern_re = i18n.compile_key_pattern(pattern)
+            forest     = forest.select_keys { |full_key, _node| full_key =~ pattern_re }
+          end
+          print_forest forest, opt
+        end
+
+        cmd :tree_rename_key,
+            args: '<key> <name> [tree]',
+            desc: I18n.t('i18n_tasks.cmd.desc.tree_rename_key'),
+            opt:  cmd_opts(:data_format) + [
+                cmd_opt(:pattern).merge(short: :k, long: :key=, desc: 'Full key (pattern) to rename. Required'),
+                cmd_opt(:pattern).merge(short: :n, long: :name=, desc: 'New name, interpolates original name as %{key}. Required')]
+
+        def tree_rename_key(opt = {})
+          key    = opt_or_arg! :key, opt
+          name   = opt_or_arg! :name, opt
+          opt_data_format! opt
+          forest = opt_forest_arg_or_stdin! opt
+          raise CommandError.new('pass full key to rename (-k, --key)') if key.blank?
+          raise CommandError.new('pass new name (-n, --name)') if name.blank?
+          forest.rename_each_key!(key, name)
+          print_forest forest, opt
+        end
+
+        cmd :tree_subtract,
+            args: '[tree A] [tree B ...]',
+            desc: I18n.t('i18n_tasks.cmd.desc.tree_subtract'),
+            opt:  cmd_opts(:data_format, :nostdin)
+
+        def tree_subtract(opt = {})
+          opt_data_format! opt
+          forests = opt_forests_stdin_args! opt, 2
+          forest  = forests.reduce(:subtract_by_key) || empty_forest
+          print_forest forest, opt
+        end
+
+        cmd :tree_set_value,
+            args: '[value] [tree]',
+            desc: I18n.t('i18n_tasks.cmd.desc.tree_set_value'),
+            opt:  cmd_opts(:value, :data_format, :nostdin, :pattern)
+
+        def tree_set_value(opt = {})
+          opt_data_format! opt
+          value       = opt_or_arg! :value, opt
+          forest      = opt_forest_arg_or_stdin!(opt)
+          key_pattern = opt[:pattern]
+          raise CommandError.new('pass value (-v, --value)') if value.blank?
+          forest.set_each_value!(value, key_pattern)
+          print_forest forest, opt
+        end
+
+        cmd :tree_convert,
+            args: '<tree>',
+            desc: I18n.t('i18n_tasks.cmd.desc.tree_convert'),
+            opt:  [cmd_opt(:data_format).merge(short: :f, long: :from=),
+                   cmd_opt(:out_format).merge(short: :t, long: :to=)]
+
+        def tree_convert(opt = {})
+          opt_data_format! opt, :from
+          opt_output_format! opt, :to
+          forest = opt_forest_arg_or_stdin! opt.merge(format: opt[:from])
+          print_forest forest, opt.merge(format: opt[:to])
+        end
+      end
+    end
+  end
+end