i18n-tasks 0.7.13 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f23b45a33ecdc2b1ff1ce24733bbfc7561e64462
-  data.tar.gz: 4b09900b186afbf6ee67276cca45847f0d8e15f5
+  metadata.gz: 4ffa593b45f4a5d40746da85f93879fffce47423
+  data.tar.gz: 689a92c8047df2b9b56638e2a9f3b9c46c43e115
 SHA512:
-  metadata.gz: 8b1cca5e5a2f5ede2defb56fe16bf9f15ba1546c2b610ebaeb282538611a800ad93f8cfb7521b13888cbecda2ca73e2718e2624250f989ffd0a7ad7350a557cf
-  data.tar.gz: d42a79921370c760f5fc557c9344d47e921580abf198fb00e19138474825b609f80104965eb7fc753de3ecacbf01a5e46390e8898e44c5a71c6806b2524c24ba
+  metadata.gz: 6d988d11c0b8690cb5596845a61b818eb9aa0702c6b84075c65b99a9fe0670c2435dfdc746d1cb5b92fb1f6929e9fc73b9bf7e8e8c76ab199a7c2517bfda782d
+  data.tar.gz: b071f96e5d5b912c95848ea6b363185b26a216fc968ae9657e1d28950b753f0933b9fc9c8f29e105a1ff2e8a4a324fc706ed33e53128c9074411980830628d2f

data/CHANGES.md

@@ -1,3 +1,14 @@
+## 0.8.0
+
+* Parse command line arguments with `optparse`. Remove dependency on Slop.
+  Simplified commands DSL: options are mostly passed directly to optparse.
+* `search.relative_roots` default changed from from `%w(app/views)` to
+  `%w(app/views app/controllers app/helpers app/presenters)`.
+* `add-missing` now adds keys detected in source to all locales (previously just base) [#134](https://github.com/glebm/i18n-tasks/issues/134).
+* The default spec template no long requires `spec_helper` by default [Daniel Levenson](https://github.com/dleve123) [#135](https://github.com/glebm/i18n-tasks/pull/135).
+* `search.exclude` now appends to and not overrides the default exclude list. More extensions excluded by default:
+  *.css, *.sass, *.scss, *.less, *.yml, and *.json. [#137](https://github.com/glebm/i18n-tasks/issues/137).
+
 ## 0.7.13
 
 * Fix relative keys when controller name consists of more than one word by [Yuji Nakayama](https://github.com/yujinakayama) [#132](https://github.com/glebm/i18n-tasks/pull/132).

data/Gemfile

@@ -3,9 +3,11 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in i18n-tasks.gemspec
 gemspec
 
-group :development do
-  gem 'byebug', platforms: [:mri_21, :mri_22], require: false
-  gem 'rubinius-debugger', platform: :rbx, require: false
+unless ENV['TRAVIS']
+  group :development do
+    gem 'byebug', platforms: [:mri_21, :mri_22], require: false
+    gem 'rubinius-debugger', platform: :rbx, require: false
+  end
 end
 
 gem 'codeclimate-test-reporter', group: :test, require: nil

data/README.md

@@ -22,7 +22,7 @@ i18n-tasks can be used with any project using the ruby [i18n gem][i18n-gem] (def
 Add it to the Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.7.13'
+gem 'i18n-tasks', '~> 0.8.0'
 ```
 
 Copy default [configuration file](#configuration) (optional):
@@ -177,7 +177,7 @@ For now, you can disable dynamic key inference by passing `-s` or `--strict` to
 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:
+Install the [default config file][config] with:
 
 ```console
 $ cp $(i18n-tasks gem-path)/templates/config/i18n-tasks.yml config/
@@ -188,60 +188,16 @@ Settings are compatible with Rails by default.
 ### Locales
 
 By default, `base_locale` is set to `en` and `locales` are inferred from the paths to data files.
-You can override these in the config:
-
-```yaml
-# config/i18n-tasks.yml
-base_locale: en
-locales: [es, fr] # This includes base_locale by default
-```
-
-`internal_locale` controls the language i18n-tasks reports in. Locales available are `en` and `ru` (pull request to add more!).
-
-```yaml
-internal_locale: en
-```
+You can override these in the [config][config].
 
 ### Storage
 
 The default data adapter supports YAML and JSON files.
 
-```yaml
-# config/i18n-tasks.yml
-data:
-  # configure YAML / JSON serializer options
-  # passed directly to load / dump / parse / serialize.
-  yaml:
-    write:
-      # do not wrap lines at 80 characters (override default)
-      line_width: -1
-```
-
 #### Multiple locale files
 
-Use `data` options to work with locale data spread over multiple files.
-
-`data.read` accepts a list of file globs to read from per-locale:
-
-```
-# config/i18n-tasks.yml
-data:
-  read:
-    # read from namespaced files, e.g. simple_form.en.yml
-    - 'config/locales/*.%{locale}.yml'
-    # read from a gem (config is parsed with ERB first, then YAML)
-    - "<%= %x[bundle show vagrant].chomp %>/templates/locales/%{locale}.yml"
-    # default
-    - 'config/locales/%{locale}.yml'
-```
-
-#### Key pattern syntax
-
-| syntax       | description                                               |
-|:------------:|:----------------------------------------------------------|
-|      `*`     | matches everything                                        |
-|      `:`     | matches a single key                                      |
-|   `{a, b.c}` | match any in set, can use `:` and `*`, match is captured  |
+i18n-tasks can manage multiple translation files and read translations from other gems.
+To find out more the `data` options in the [config][config].
 
 For writing to locale files i18n-tasks provides 2 options.
 
@@ -266,7 +222,7 @@ data:
 
 Conservative router keeps the keys where they are found, or infers the path from base locale.
 If the key is completely new, conservative router will fall back to pattern router behaviour.
-Conservative router is the default router.
+Conservative router is the **default** router.
 
 ```
 data:
@@ -276,55 +232,26 @@ data:
     - 'config/locales/%{locale}.yml'
 ```
 
-#### Custom adapters
-
-If you store data somewhere but in the filesystem, e.g. in the database or mongodb, you can implement a custom adapter.
-Implement [a handful of methods][adapter-example], then set `data.adapter` to the class name; the rest of the `data` config is passed to the initializer.
+##### Key pattern syntax
 
-```yaml
-# config/i18n-tasks.yml
-data:
-  # file_system is the default adapter, you can provide a custom class name here:
-  adapter: file_system
-```
+A special syntax similar to file glob patterns is used throughout i18n-tasks to match translation keys:
 
-### Usage search
+| syntax       | description                                               |
+|:------------:|:----------------------------------------------------------|
+|      `*`     | matches everything                                        |
+|      `:`     | matches a single key                                      |
+|   `{a, b.c}` | match any in set, can use `:` and `*`, match is captured  |
 
 
-Configure usage search in `config/i18n-tasks.yml`:
+#### Custom adapters
 
-```yaml
-# config/i18n-tasks.yml
-# i18n usage search in source
-search:
-  # search these directories (relative to your Rails.root directory, default: 'app/')
-  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'
-    - '*.html.*'
-    - '*.text.*'
-  # explicitly exclude files (default: exclude common binary files)
-  exclude:
-    - '*.js'
-  # you can override the default key regex pattern:
-  pattern: "\\bt[( ]\\s*(:?\".+?\"|:?'.+?'|:\\w+)"
-  # comments are ignored by default
-  ignore_lines:
-    - "^\\s*[#/](?!\\si18n-tasks-use)"
-```
+If you store data somewhere but in the filesystem, e.g. in the database or mongodb, you can implement a custom adapter.
+If you have implemented a custom adapter please share it on [the wiki][wiki].
 
-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.
+### Usage search
 
+See the `search` section in the [config file][config] for all available configuration options.
+An example of a custom scanner can be found here: https://github.com/glebm/i18n-tasks/issues/138#issuecomment-87255708.
 
 ### Fine-tuning
 
@@ -335,33 +262,8 @@ Add hints to static analysis with magic comment hints (lines starting with `(#|/
 User.model_name.human
 ```
 
-You can also explicitly ignore keys appearing in locale files:
-
-```yaml
-# config/i18n-tasks.yml
-# do not report these keys as unused
-ignore_unused:
-  - category.*.db_name
-
-# do not report these keys as missing (both on blank value and no key)
-ignore_missing:
-  - devise.errors.unauthorized # ignore this key
-  - pagination.views.*         # ignore the whole pattern
-  # E.g to ignore all Rails number / currency keys:
-  - 'number.{format, percentage.format, precision.format, human.format, currency.format}.{strip_insignificant_zeros,significant,delimiter}'
-  - 'time.{pm,am}'
-
-# do not report these keys when they have the same value as the base locale version
-ignore_eq_base:
-  all:
-    - common.ok
-  es,fr:
-    - common.brand
-
-# do not report these keys ever
-ignore:
-  - kaminari.*
-```
+You can also explicitly ignore keys appearing in locale files via `ignore*` settings.
+See the [config file][config] to find out more.
 
 <a name="translation-config"></a>
 ### Google Translate
@@ -383,7 +285,7 @@ translation:
   api_key: <Google Translate API key>
 ```
 
-## Interactive Console
+## Interactive console
 
 `i18n-tasks irb` starts an IRB session in i18n-tasks context. Type `guide` for more information.
 
@@ -395,12 +297,7 @@ Export missing and unused data to XLSX:
 $ i18n-tasks xlsx-report
 ```
 
-### HTML
-
-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
+## Add new tasks
 
 Tasks that come with the gem are defined in [lib/i18n/tasks/command/commands](lib/i18n/tasks/command/commands).
 
@@ -430,6 +327,8 @@ Run with:
 $ i18n-tasks my-task
 ```
 
+See more examples of custom tasks [on the wiki](https://github.com/glebm/i18n-tasks/wiki#custom-tasks).
+
 [MIT license]: /LICENSE.txt
 [travis]: https://travis-ci.org/glebm/i18n-tasks
 [badge-travis]: http://img.shields.io/travis/glebm/i18n-tasks.svg
@@ -439,6 +338,8 @@ $ i18n-tasks my-task
 [badge-gemnasium]: https://gemnasium.com/glebm/i18n-tasks.svg
 [code-climate]: https://codeclimate.com/github/glebm/i18n-tasks
 [badge-code-climate]: http://img.shields.io/codeclimate/github/glebm/i18n-tasks.svg
+[config]: https://github.com/glebm/i18n-tasks/blob/master/templates/config/i18n-tasks.yml
+[wiki]: https://github.com/glebm/i18n-tasks/wiki "i18n-tasks wiki"
 [i18n-gem]: https://github.com/svenfuchs/i18n "svenfuchs/i18n on Github"
 [screenshot-find]: https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-usages.png "i18n-tasks find output screenshot"
 [adapter-example]: https://github.com/glebm/i18n-tasks/blob/master/lib/i18n/tasks/data/file_system_base.rb

data/bin/i18n-tasks

@@ -8,49 +8,6 @@ if i18n_gem_config.respond_to?(:enforce_available_locales=) && i18n_gem_config.e
   i18n_gem_config.enforce_available_locales = true
 end
 
-require 'i18n/tasks'
-require 'i18n/tasks/commands'
-require 'slop'
+require 'i18n/tasks/cli'
 
-err = proc { |message, exit_code|
-  if $stderr.isatty
-    $stderr.puts Term::ANSIColor.yellow('i18n-tasks: ' + message)
-  else
-    $stderr.puts message
-  end
-  exit exit_code
-}
-
-begin
-  ran       = false
-  commander = ::I18n::Tasks::Commands
-  instance  = commander.new
-  instance.set_internal_locale!
-  slop_adapter = ::I18n::Tasks::SlopCommand
-  args         = ARGV.dup
-  args         = ['--help'] if args.empty?
-  Slop.parse(args, help: true) do
-    on('-v', '--version', 'Print the version') {
-      puts I18n::Tasks::VERSION
-      exit
-    }
-    commander.cmds.each do |name, attr|
-      slop_dsl = slop_adapter.slop_command(name, attr) { |_name, opts|
-        begin
-          ran = true
-          instance.safe_run name, opts
-        rescue Errno::EPIPE
-          # ignore Errno::EPIPE which is throw when pipe breaks, e.g.:
-          # i18n-tasks missing | head
-          exit 1
-        end
-      }
-      instance_exec(&slop_dsl)
-    end
-  end
-rescue Slop::Error => e
-  err.call(e.message, 64)
-end
-
-
-err.call("Command unknown: #{args[0]}", 64) if !ran && args[0]
+I18n::Tasks::CLI.start(ARGV)

data/config/locales/en.yml

@@ -7,20 +7,19 @@ en:
         other: Added %{count} keys
     cmd:
       args:
-        default_all: 'Default: all'
         default_text: 'Default: %{value}'
         desc:
           confirm: Confirm automatically
-          data_format: 'Data format: %{valid_text}. %{default_text}.'
+          data_format: 'Data format: %{valid_text}.'
           key_pattern: Filter by key pattern (e.g. 'common.*')
           key_pattern_to_rename: Full key (pattern) to rename. Required
-          locale: 'Locale. Default: base'
-          locale_to_translate_from: 'Locale to translate from (default: base)'
-          locales_filter: 'Comma-separated list of locale(s) to process. Default: all. Special: base.'
-          missing_types: 'Filter by types: %{valid}. Default: all'
+          locale: Locale
+          locale_to_translate_from: Locale to translate from
+          locales_filter: "Locale(s) to process. Special: base"
+          missing_types: 'Filter by types: %{valid}'
           new_key_name: New name, interpolates original name as %{key}. Required
           nostdin: Do not read from stdin
-          out_format: 'Output format: %{valid_text}. %{default_text}.'
+          out_format: 'Output format: %{valid_text}'
           pattern_router: 'Use pattern router: keys moved per config data.write'
           strict: Do not infer dynamic key usage such as `t("category.\#{category.name}")`
           value: 'Value. Interpolates: %{value}, %{human_key}, %{value_or_human_key}'
@@ -54,18 +53,16 @@ en:
       - Well done!
       - Perfect!
       enum_list_opt:
-        desc: 'Comma-separated list of: %{valid_text}. %{default_text}'
         invalid: "%{invalid} is not in: %{valid}."
       enum_opt:
-        desc: "%{valid_text}. %{default_text}"
         invalid: "%{invalid} is not one of: %{valid}."
       errors:
-        invalid_format: 'Unknown format %{invalid}. Valid: %{valid}.'
-        invalid_locale: Invalid locale %{invalid}
+        invalid_format: 'invalid format: %{invalid}. valid: %{valid}.'
+        invalid_locale: 'invalid locale: %{invalid}'
         invalid_missing_type:
-          one: 'Unknown type %{invalid}. Valid: %{valid}.'
-          other: 'Unknown types: %{invalid}. Valid: %{valid}.'
-        pass_forest: Pass locale forest
+          one: 'invalid type: %{invalid}. valid: %{valid}.'
+          other: 'unknown types: %{invalid}. valid: %{valid}.'
+        pass_forest: pass locale forest
     common:
       base_value: Base Value
       continue_q: Continue?

data/config/locales/ru.yml

@@ -5,7 +5,6 @@ ru:
       added: "Добавлены ключи (%{count})"
     cmd:
       args:
-        default_all: "По умолчанию: все"
         default_text: "По умолчанию: %{value}"
         desc:
           confirm: "Подтвердить автоматом"
@@ -53,10 +52,8 @@ ru:
       - "Отлично!"
       - "Прекрасно!"
       enum_list_opt:
-        desc: "Разделенных запятыми список: %{valid_text}. %{default_text}"
         invalid: "%{invalid} не в: %{valid}."
       enum_opt:
-        desc: "%{valid_text}. %{default_text}"
         invalid: "%{invalid} не является одним из: %{valid}."
       errors:
         invalid_format: "Неизвестный формат %{invalid}. Форматы: %{valid}."

data/i18n-tasks.gemspec

@@ -39,7 +39,6 @@ TEXT
   s.add_dependency 'term-ansicolor'
   s.add_dependency 'terminal-table'
   s.add_dependency 'highline'
-  s.add_dependency 'slop', '~> 3.5'
   s.add_dependency 'i18n'
   s.add_development_dependency 'axlsx', '~> 2.0'
   s.add_development_dependency 'bundler', '~> 1.3'

data/lib/i18n/tasks.rb

@@ -2,11 +2,22 @@
 # define all the modules to be able to use ::
 module I18n
   module Tasks
+    class << self
+      def gem_path
+        File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+      end
 
-    def self.gem_path
-      File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+      def verbose?
+        @verbose
+      end
+
+      def verbose=(value)
+        @verbose = value
+      end
     end
 
+    @verbose = !!ENV['VERBOSE']
+
     module Data
     end
   end
@@ -15,6 +26,7 @@ end
 
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/string'
+require 'active_support/core_ext/array/access'
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/object/try'
 require 'active_support/core_ext/object/blank'

data/lib/i18n/tasks/cli.rb

@@ -0,0 +1,195 @@
+require 'i18n/tasks'
+require 'i18n/tasks/commands'
+require 'optparse'
+
+class I18n::Tasks::CLI
+  include ::I18n::Tasks::Logging
+
+  def self.start(argv)
+    new.start(argv)
+  end
+
+  def initialize
+  end
+
+  def start(argv)
+    auto_output_coloring do
+      begin
+        run(argv)
+      rescue OptionParser::ParseError => e
+        error e.message, 64
+      rescue I18n::Tasks::CommandError => e
+        begin
+          error e.message, 78
+        ensure
+          log_verbose e.backtrace * "\n"
+        end
+      rescue Errno::EPIPE
+        # ignore Errno::EPIPE which is throw when pipe breaks, e.g.:
+        # i18n-tasks missing | head
+        exit 1
+      end
+    end
+  rescue ExecutionError => e
+    exit e.exit_code
+  end
+
+  def run(argv)
+    name, *options = parse!(argv.dup)
+    context.run(name, *options)
+  end
+
+  def context
+    @context ||= ::I18n::Tasks::Commands.new.tap(&:set_internal_locale!)
+  end
+
+  def commands
+    @commands ||= ::I18n::Tasks::Commands.cmds.transform_keys { |k| k.to_s.tr('_', '-') }
+  end
+
+  private
+
+  def parse!(argv)
+    command = parse_command! argv
+    options = optparse! command, argv
+    parse_options! options, command, argv
+    [command.tr('-', '_'), options.update(arguments: argv)]
+  end
+
+  def optparse!(command, argv)
+    if command
+      optparse_command!(command, argv)
+    else
+      optparse_no_command!(argv)
+    end
+  end
+
+  def optparse_command!(command, argv)
+    cmd_conf = commands[command]
+    flags    = cmd_conf[:args].dup
+    options  = {}
+    OptionParser.new("Usage: #{program_name} #{command} [options] #{cmd_conf[:pos]}".strip) do |op|
+      flags.each do |flag|
+        op.on(*optparse_args(flag)) { |v| options[option_name(flag)] = v }
+      end
+      verbose_option op
+      help_option op
+    end.parse!(argv)
+    options
+  end
+
+  def optparse_no_command!(argv)
+    argv << '--help' if argv.empty?
+    OptionParser.new("Usage: #{program_name} [command] [options]") do |op|
+      op.on('-v', '--version', 'Print the version') do
+        puts I18n::Tasks::VERSION
+        exit
+      end
+      help_option op
+      commands_summary op
+    end.parse!(argv)
+  end
+
+  def allow_help_arg_first!(argv)
+    # allow `i18n-tasks --help command` in addition to `i18n-tasks command --help`
+    argv[0], argv[1] = argv[1], argv[0] if %w(-h --help).include?(argv[0]) && argv[1] && !argv[1].start_with?('-')
+  end
+
+  def parse_command!(argv)
+    allow_help_arg_first! argv
+    if argv[0] && !argv[0].start_with?('-')
+      if commands.keys.include?(argv[0])
+        argv.shift
+      else
+        error "unknown command: #{argv[0]}", 64
+      end
+    end
+  end
+
+  def verbose_option(op)
+    op.on('--verbose', 'Verbose output') {
+      ::I18n::Tasks.verbose = true
+    }
+  end
+
+  def help_option(op)
+    op.on('-h', '--help', 'Show this message') do
+      $stderr.puts op
+      exit
+    end
+  end
+
+  # @param [OptionParser] op
+  def commands_summary(op)
+    op.separator ''
+    op.separator 'Available commands:'
+    op.separator ''
+    commands.each do |cmd, cmd_conf|
+      op.separator "    #{cmd.ljust(op.summary_width + 1, ' ')}#{try_call cmd_conf[:desc]}"
+    end
+    op.separator ''
+    op.separator 'See `i18n-tasks <command> --help` for more information on a specific command.'
+  end
+
+  def optparse_args(flag)
+    args = flag.dup
+    args.map! { |v| try_call v }
+    conf = args.extract_options!
+    if conf.key?(:default)
+      args[-1] = "#{args[-1]}. #{I18n.t('i18n_tasks.cmd.args.default_text', value: conf[:default])}"
+    end
+    args
+  end
+
+  def parse_options!(options, command, argv)
+    commands[command][:args].each do |flag|
+      name          = option_name flag
+      options[name] = parse_option flag, options[name], argv, self.context
+    end
+  end
+
+  def parse_option(flag, val, argv, context)
+    conf = flag.last.is_a?(Hash) ? flag.last : {}
+    if conf[:consume_positional]
+      val = Array(val) + Array(flag.include?(Array) ? argv.flat_map { |x| x.split(',') } : argv)
+    end
+    val = conf[:default] if val.nil? && conf.key?(:default)
+    val = conf[:parser].call(val, context) if conf.key?(:parser)
+    val
+  end
+
+  def option_name(flag)
+    flag.detect { |f| f.start_with?('--') }.sub(/\A--/, '').sub(/[^\-\w].*\z/, '').to_sym
+  end
+
+  def try_call(v)
+    if v.respond_to? :call
+      v.call
+    else
+      v
+    end
+  end
+
+  def error(message, exit_code)
+    log_error message
+    fail ExecutionError.new(message, exit_code)
+  end
+
+  class ExecutionError < Exception
+    attr_reader :exit_code
+
+    def initialize(message, exit_code)
+      super(message)
+      @exit_code = exit_code
+    end
+  end
+
+  def auto_output_coloring(coloring = ENV['I18N_TASKS_COLOR'] || STDOUT.isatty)
+    coloring_was             = Term::ANSIColor.coloring?
+    Term::ANSIColor.coloring = coloring
+    yield
+  ensure
+    Term::ANSIColor.coloring = coloring_was
+  end
+
+end