i18n-tasks 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4807ae41e4ea2c7274b08bc55c2a2286a6e601d5
-  data.tar.gz: bdc921c3485e004c0e395a79afde8a5cfcfa888c
+  metadata.gz: d0229b3a4c2b8749a457c6b71e412a80802a6aa3
+  data.tar.gz: e43c66b6e67ef86dd28fcb7d7c9875c4578c9b84
 SHA512:
-  metadata.gz: 3b58817464f4c4878f822606dda7ae226b33f53b6542b938a272864d1d4a92806a72d81f4d16571e8176e04687784861a7c541f1ac0e92b6ce055ed46a93b8da
-  data.tar.gz: 276c9a94d0575d383ea163a8e20d56b26248cf0c16da4caa2efd53f7530ed4632f3f264e9dcf747013db063cd19c984cd218cb60829ace938f79b6c97db7130f
+  metadata.gz: d370ab448ca1126486d67e810b9dab6f20ea07b5145c297a3fdbc15bf03fc6c3118434d93803b9b7ba9147b57b36f30b9582ab7af27d6d31172fe79d84157737
+  data.tar.gz: 0f1a783ca1d8ca7024d26f9506fc814ac6eff22ddb1141f4730567e73730c287e192a216ad5f4971d399d0df664ade82a8cf72301a1486e1cffff15b4a254bf9

data/README.md

@@ -24,7 +24,7 @@ i18n-tasks can be used with any project using the ruby [i18n gem][i18n-gem] (def
 Add i18n-tasks to the Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.9.4'
+gem 'i18n-tasks', '~> 0.9.5'
 ```
 
 Copy the default [configuration file](#configuration):
@@ -278,6 +278,12 @@ User.model_name.human
 ```
 
 You can also explicitly ignore keys appearing in locale files via `ignore*` settings.
+
+If you have helper methods that generate translation keys, such as a `page_title` method that returns `t '.page_title'`,
+or a `Spree.t(key)` method that returns `t "spree.#{key}"`, use the built-in `PatternMapper` to map these.
+
+For more complex cases, you can implement a [custom scanner][custom-scanner-docs].
+
 See the [config file][config] to find out more.
 
 <a name="translation-config"></a>
@@ -332,3 +338,4 @@ Custom tasks can be added easily, see the examples [on the wiki](https://github.
 [screenshot-i18n-tasks]: https://i.imgur.com/XZBd8l7.png "i18n-tasks screenshot"
 [screenshot-find]: https://i.imgur.com/VxBrSfY.png "i18n-tasks find output screenshot"
 [adapter-example]: https://github.com/glebm/i18n-tasks/blob/master/lib/i18n/tasks/data/file_system_base.rb
+[custom-scanner-docs]: https://github.com/glebm/i18n-tasks/wiki/A-custom-scanner-example

data/lib/i18n/tasks/cli.rb

@@ -14,23 +14,25 @@ class I18n::Tasks::CLI
   end
 
   def start(argv)
-    auto_output_coloring do
-      begin
-        if run(argv) == :exit_1
-          exit 1
-        end
-      rescue OptionParser::ParseError => e
-        error e.message, 64
-      rescue I18n::Tasks::CommandError => e
+    I18n.with_locale(base_task.internal_locale) do
+      auto_output_coloring do
         begin
-          error e.message, 78
-        ensure
-          log_verbose e.backtrace * "\n"
+          if run(argv) == :exit_1
+            exit 1
+          end
+        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
-      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
@@ -43,7 +45,7 @@ class I18n::Tasks::CLI
   end
 
   def context
-    @context ||= ::I18n::Tasks::Commands.new(base_task).tap(&:set_internal_locale!)
+    @context ||= ::I18n::Tasks::Commands.new(base_task)
   end
 
   def commands

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

@@ -27,10 +27,6 @@ module I18n::Tasks
         end
       end
 
-      def set_internal_locale!
-        I18n.locale = i18n.internal_locale
-      end
-
       protected
 
       def terminal_report

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

@@ -45,21 +45,23 @@ module I18n::Tasks
         cmd :add_missing,
             pos:  '[locale ...]',
             desc: t('i18n_tasks.cmd.desc.add_missing'),
-            args: [:locales, :out_format, arg(:value) + [{default: '%{value_or_default_or_human_key}'}]]
+            args: [:locales, :out_format, arg(:value) + [{default: '%{value_or_default_or_human_key}'}],
+                   ['--nil-value', 'Set value to nil. Takes precedence over the value argument.']]
 
         def add_missing(opt = {})
           added   = i18n.empty_forest
           locales = (opt[:locales] || i18n.locales)
+          value   = opt[:'nil-value'] ? nil : opt[:value]
           if locales[0] == i18n.base_locale
             # Merge base locale first, as this may affect the value for the other locales
             forest = i18n.missing_keys({locales: [locales[0]]}.update(opt.slice(:types, :base_locale))).
-                set_each_value!(opt[:value])
+                set_each_value!(value)
             i18n.data.merge! forest
             added.merge! forest
             locales = locales[1..-1]
           end
           forest = i18n.missing_keys({locales: locales}.update(opt.slice(:types, :base_locale))).
-              set_each_value!(opt[:value])
+              set_each_value!(value)
           i18n.data.merge! forest
           added.merge! forest
           log_stderr t('i18n_tasks.add_missing.added', count: added.leaves.count)

data/lib/i18n/tasks/scanners/pattern_mapper.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+require 'i18n/tasks/scanners/file_scanner'
+require 'i18n/tasks/scanners/relative_keys'
+require 'i18n/tasks/scanners/occurrence_from_position'
+require 'i18n/tasks/scanners/ruby_key_literals'
+
+module I18n::Tasks::Scanners
+  # Maps the provided patterns to keys.
+  class PatternMapper < FileScanner
+    include I18n::Tasks::Scanners::RelativeKeys
+    include I18n::Tasks::Scanners::OccurrenceFromPosition
+    include I18n::Tasks::Scanners::RubyKeyLiterals
+
+    # @param patterns [Array<[String, String]> the list of pattern-key pairs
+    #   the patterns follow the regular expression syntax, with a syntax addition for matching
+    #   string/symbol literals: you can include %{key} in the pattern, and it will be converted to
+    #   a named capture group, capturing ruby strings and symbols, that can then be used in the key:
+    #
+    #       patterns: [['Spree\.t[( ]\s*%{key}', 'spree.%{key}']]
+    #
+    #   All of the named capture groups are interpolated into the key with %{group_name} interpolations.
+    #
+    def initialize(config:, **args)
+      super
+      @patterns = configure_patterns(config[:patterns] || [])
+    end
+
+    protected
+
+    # @return [Array<[absolute key, Results::Occurrence]>]
+    def scan_file(path)
+      text = read_file(path)
+      @patterns.flat_map do |pattern, key|
+        result = []
+        text.scan(pattern) do |_|
+          match    = Regexp.last_match
+          matches  = Hash[match.names.map(&:to_sym).zip(match.captures)]
+          if matches.key?(:key)
+            matches[:key] = strip_literal(matches[:key])
+            next unless valid_key?(matches[:key])
+          end
+          result << [absolute_key(key % matches, path),
+           occurrence_from_position(path, text, match.offset(0).first)]
+        end
+        result
+      end
+    end
+
+    private
+
+    KEY_GROUP = "(?<key>#{LITERAL_RE})"
+
+    def configure_patterns(patterns)
+      patterns.map do |(pattern, key)|
+        [pattern.is_a?(Regexp) ? pattern : Regexp.new(pattern % {key: KEY_GROUP}), key]
+      end
+    end
+  end
+end

data/lib/i18n/tasks/scanners/pattern_scanner.rb

@@ -2,12 +2,14 @@
 require 'i18n/tasks/scanners/file_scanner'
 require 'i18n/tasks/scanners/relative_keys'
 require 'i18n/tasks/scanners/occurrence_from_position'
+require 'i18n/tasks/scanners/ruby_key_literals'
 
 module I18n::Tasks::Scanners
   # Scan for I18n.t usages using a simple regular expression.
   class PatternScanner < FileScanner
     include RelativeKeys
     include OccurrenceFromPosition
+    include RubyKeyLiterals
 
     def initialize(**args)
       super
@@ -50,26 +52,13 @@ module I18n::Tasks::Scanners
       re && re =~ line
     end
 
-    # remove the leading colon and unwrap quotes from the key match
-    # @param literal [String] e.g: "key", 'key', or :key.
-    # @return [String] key
-    def strip_literal(literal)
-      key = literal
-      key = key[1..-1] if ':'.freeze == key[0]
-      key = key[1..-2] if QUOTES.include?(key[0])
-      key
-    end
-
-    QUOTES              = ["'".freeze, '"'.freeze].freeze
-    VALID_KEY_CHARS     = /(?:[[:word:]]|[-.?!;À-ž])/
-    VALID_KEY_RE_STRICT = /^#{VALID_KEY_CHARS}+$/
-    VALID_KEY_RE        = /^(#{VALID_KEY_CHARS}|[:\#{@}\[\]])+$/
+    VALID_KEY_RE_DYNAMIC = /^(#{VALID_KEY_CHARS}|[:\#{@}\[\]])+$/
 
     def valid_key?(key)
       if @config[:strict]
-        key =~ VALID_KEY_RE_STRICT && !key.end_with?('.')
+        super(key)
       else
-        key =~ VALID_KEY_RE
+        key =~ VALID_KEY_RE_DYNAMIC
       end
     end
 
@@ -87,13 +76,6 @@ module I18n::Tasks::Scanners
       /(?<=^|[^\w'\-.]|[^\w'\-]I18n\.|I18n\.)t(?:ranslate)?/
     end
 
-    # Match literals:
-    # * String: '', "#{}"
-    # * Symbol: :sym, :'', :"#{}"
-    def literal_re
-      /:?".+?"|:?'.+?'|:\w+/
-    end
-
     def default_pattern
       # capture only the first argument
       /

data/lib/i18n/tasks/scanners/ruby_key_literals.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module I18n::Tasks::Scanners
+  module RubyKeyLiterals
+    LITERAL_RE = /:?".+?"|:?'.+?'|:\w+/
+
+    # Match literals:
+    # * String: '', "#{}"
+    # * Symbol: :sym, :'', :"#{}"
+    def literal_re
+      LITERAL_RE
+    end
+
+    # remove the leading colon and unwrap quotes from the key match
+    # @param literal [String] e.g: "key", 'key', or :key.
+    # @return [String] key
+    def strip_literal(literal)
+      literal = literal[1..-1] if ':' == literal[0]
+      literal = literal[1..-2] if "'" == literal[0] || '"' == literal[0]
+      literal
+    end
+
+    VALID_KEY_CHARS = /(?:[[:word:]]|[-.?!;À-ž])/
+    VALID_KEY_RE    = /^#{VALID_KEY_CHARS}+$/
+
+    def valid_key?(key)
+      key =~ VALID_KEY_RE && !key.end_with?('.')
+    end
+  end
+end

data/lib/i18n/tasks/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module I18n
   module Tasks
-    VERSION = '0.9.4'
+    VERSION = '0.9.5'
   end
 end

data/templates/config/i18n-tasks.yml

@@ -105,3 +105,16 @@ search:
 ## Ignore these keys completely:
 # ignore:
 #  - kaminari.*
+
+## Sometimes, it isn't possible for i18n-tasks to match the key correctly,
+## e.g. in case of a relative key defined in a helper method.
+## In these cases you can use the built-in PatternMapper to map patterns to keys, e.g.:
+#
+# <%#= I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
+#        only: %w(*.html.haml *.html.slim),
+#        patterns: [['= title\b', '.page_title']] %>
+#
+# The PatternMapper can also match key literals via a special %{key} interpolation, e.g.:
+#
+# <%#= I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
+#        patterns: [['\bSpree\.t[( ]\s*%{key}', 'spree.%{key}']] %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-06 00:00:00.000000000 Z
+date: 2016-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -281,6 +281,7 @@ files:
 - lib/i18n/tasks/scanners/files/file_finder.rb
 - lib/i18n/tasks/scanners/files/file_reader.rb
 - lib/i18n/tasks/scanners/occurrence_from_position.rb
+- lib/i18n/tasks/scanners/pattern_mapper.rb
 - lib/i18n/tasks/scanners/pattern_scanner.rb
 - lib/i18n/tasks/scanners/pattern_with_scope_scanner.rb
 - lib/i18n/tasks/scanners/relative_keys.rb
@@ -288,6 +289,7 @@ files:
 - lib/i18n/tasks/scanners/results/occurrence.rb
 - lib/i18n/tasks/scanners/ruby_ast_call_finder.rb
 - lib/i18n/tasks/scanners/ruby_ast_scanner.rb
+- lib/i18n/tasks/scanners/ruby_key_literals.rb
 - lib/i18n/tasks/scanners/scanner.rb
 - lib/i18n/tasks/scanners/scanner_multiplexer.rb
 - lib/i18n/tasks/split_key.rb