i18n-tasks 0.2.15 → 0.2.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 217d5375c8adaf43404a25edbb7b8d1e0ace0846
-  data.tar.gz: 7cb0ada61b7e6d10f4da54c879eb8955eed92400
+  metadata.gz: f5078ec1751923ec5ebfcd79893a7bdca8ae618f
+  data.tar.gz: e29ebefde17fdbefc0408452466e5f1a19a2be71
 SHA512:
-  metadata.gz: c8a931302b28482f56cef52028280832c0a9e963c9e6c4ee28131c139db5b4e2667719f7776f192a8106b91200704ca80e8e1b5c2152a04dfa8b5410dc7c1579
-  data.tar.gz: 4e9597da0828551fcd2fb82ae0a2a21d84bf4f699137d6b16e58b4de57433554ea2f6b44a21f64841271ddc71b21b87cd1aa6458db9b5b59da24dd504c3b8ca6
+  metadata.gz: 55359af166cef34bd9c4708a0a482d5107d54d347615172b39803559355d8738e6da03901562a509ae8b6474cdda7ee6b19d4044a1978520d7cee9e9d81bfacb
+  data.tar.gz: a05eb27caad0776691685f6e70ce271084adf7ae4d71c97f1898736501ddd9b7a5a47627dd1f4623349764dd281aa6ef344aa763190ce38799d882bd565933f5

data/CHANGES.md

@@ -1,4 +1,13 @@
-## v0.2.14.
+## v0.2.16
+
+* Key search extracted into its own class, and a custom scanner can now be provided.
+* Removed support for deprecated settings
+
+## v0.2.15
+
+* More robust I18n.t call detection (detect I18n.translate and multiline calls)
+
+## v0.2.14
 
 * Google Translate fixes: preserve interpolations, set correct format based on the key (text or html).
 

data/README.md

@@ -172,6 +172,9 @@ relative_roots:
   - app/views-mobile
 ```
 
+It is also possible to use a key scanner by setting `search.scanner`.
+See [the default scanner](/lib/i18n/tasks/scanners/pattern_scanner.rb) for reference.
+
 
 ### Fine-tuning
 
@@ -224,18 +227,19 @@ This is how you can do it with rspec:
 require 'i18n/tasks'
 require 'i18n/tasks/base_task'
 
-# spec/locales_spec.rb
+# spec/i18n_keys_spec.rb
 require 'spec_helper'
-describe 'translations'  do
+describe 'translation keys'  do
   let(:i18n) { I18n::Tasks::BaseTask.new }
 
-  it 'are all used' do
-    i18n.unused_keys.should have(0).keys
+  it 'are all present' do
+    expect(i18n.untranslated_keys).to have(0).keys
   end
 
-  it 'are all present' do
-    i18n.untranslated_keys.should have(0).keys
+  it 'are all used' do
+    expect(i18n.unused_keys).to have(0).keys
   end
+
 end
 ```
 

data/lib/i18n/tasks/configuration.rb

@@ -26,33 +26,10 @@ module I18n::Tasks::Configuration
     end
   end
 
-  DEFAULT_PATTERN = /\bt(?:ranslate)?[( ]\s*(:?".+?"|:?'.+?'|:\w+)/
-  # search config
-  # @return [Hash{String => String,Hash,Array}]
-  def search_config
-    @config_sections[:search] ||= begin
-      if config.key?(:grep)
-        config[:search] ||= config.delete(:grep)
-        I18n::Tasks.warn_deprecated 'please rename "grep" key to "search" in config/i18n-tasks.yml'
-      end
-      search_config = (config[:search] || {}).with_indifferent_access
-      search_config.tap do |conf|
-        conf[:paths]   = %w(app/) if conf[:paths].blank?
-        conf[:include] = Array(conf[:include]) if conf[:include].present?
-        conf[:exclude] = Array(conf[:exclude])
-        conf[:pattern] = conf[:pattern].present? ? Regexp.new(conf[:pattern]) : DEFAULT_PATTERN
-      end
-    end
-  end
-
   def relative_roots
     @config_sections[:relative_roots] ||= config[:relative_roots].presence || %w(app/views)
   end
 
-  def relative_roots=(paths)
-    @config_sections[:relative_roots] = paths
-  end
-
   # translation config
   # @return [Hash{String => String,Hash,Array}]
   def translation_config

data/lib/i18n/tasks/data/yaml.rb

@@ -19,14 +19,9 @@ module I18n::Tasks
       end
 
       def config=(config)
-        opt = (config || {}).with_indifferent_access
-        if opt.key?(:paths)
-          opt[:read] ||= opt.delete(:paths)
-          ::I18n::Tasks.warn_deprecated 'please rename "data.paths" key to "data.read" in config/i18n-tasks.yml'
-        end
-        opt = DEFAULTS.deep_merge(opt)
-        @read   = opt[:read]
-        @write  = opt[:write].map { |x| x.is_a?(String) ? ['*', x] : x }.map { |x|
+        opt    = DEFAULTS.deep_merge((config || {}).with_indifferent_access)
+        @read  = opt[:read]
+        @write = opt[:write].map { |x| x.is_a?(String) ? ['*', x] : x }.map { |x|
           [compile_key_pattern(x[0]), x[1]]
         }
         @locale_data = {}
@@ -34,7 +29,7 @@ module I18n::Tasks
 
       # get locale tree
       def get(locale)
-        locale                        = locale.to_s
+        locale = locale.to_s
         @locale_data[locale] ||= begin
           @read.map do |path|
             Dir.glob path % {locale: locale}

data/lib/i18n/tasks/key_pattern_matching.rb

@@ -17,9 +17,6 @@ module I18n::Tasks::KeyPatternMatching
   #      :     matches a single key
   #   {a, b.c} match any in set, can use : and *, match is captured
   def compile_key_pattern(key_pattern)
-    if key_pattern.end_with? '.'
-      I18n::Tasks.warn_deprecated %Q(please change pattern "#{key_pattern}" to "#{key_pattern += '*'}" in config/i18n-tasks.yml)
-    end
     /^#{key_pattern.
         gsub(/\./, '\.').
         gsub(/\*/, '.*').
@@ -43,4 +40,4 @@ module I18n::Tasks::KeyPatternMatching
       /^(?:#{prefixes.map { |p| Regexp.escape(p) }.join('|')})/
     end
   end
-end
+end

data/lib/i18n/tasks/relative_keys.rb

@@ -1,15 +1,18 @@
-module I18n::Tasks::RelativeKeys
-
-  # @param key [String] relative i18n key (starts with a .)
-  # @param path [String] path to the file containing the key
-  # @return [String] absolute version of the key
-  def absolutize_key(key, path, roots = relative_roots)
-    # normalized path
-    path      = File.expand_path path
-    (path_root = roots.map { |path| File.expand_path path }.sort.reverse.detect { |root| path.start_with?(root + '/') }) or
-      raise "No relative key root detected for \"#{key}\" at #{path}. Please set relative_roots in config/i18n-tasks.yml (currently set to #{relative_roots})"
-    # key prefix based on path
-    prefix = path.gsub(%r(#{path_root}/|(\.[^/]+)*$), '').tr('/', '.').gsub(%r(\._), '.')
-    "#{prefix}#{key}"
+module I18n
+  module Tasks
+    module RelativeKeys
+      # @param key [String] relative i18n key (starts with a .)
+      # @param path [String] path to the file containing the key
+      # @return [String] absolute version of the key
+      def absolutize_key(key, path, roots = relative_roots)
+        # normalized path
+        path = File.expand_path path
+        (path_root = roots.map { |path| File.expand_path path }.sort.reverse.detect { |root| path.start_with?(root + '/') }) or
+            raise "No relative key root detected for \"#{key}\" at #{path}. Please set relative_roots in config/i18n-tasks.yml (currently set to #{relative_roots})"
+        # key prefix based on path
+        prefix = path.gsub(%r(#{path_root}/|(\.[^/]+)*$), '').tr('/', '.').gsub(%r(\._), '.')
+        "#{prefix}#{key}"
+      end
+    end
   end
 end

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

@@ -0,0 +1,65 @@
+require 'i18n/tasks/relative_keys'
+module I18n::Tasks::Scanners
+  class BaseScanner
+    include ::I18n::Tasks::RelativeKeys
+    attr_reader :config
+
+    def initialize(config)
+      @config = config.dup.with_indifferent_access.tap do |conf|
+        conf[:paths]   = %w(app/) if conf[:paths].blank?
+        conf[:include] = Array(conf[:include]) if conf[:include].present?
+        conf[:exclude] = Array(conf[:exclude])
+      end
+    end
+
+    # @return [Array] found key usages, absolutized and unique
+    def keys
+      @keys ||= traverse_files { |path| scan_file(path) }.flatten.uniq
+    end
+
+    # @return [String] keys used in file (unimplemented)
+    def scan_file(path)
+      raise 'Unimplemented'
+    end
+
+    # Run given block for every relevant file, according to config
+    # @return [Array] Results of block calls
+    def traverse_files
+      result = []
+      Find.find(*config[:paths]) do |path|
+        next if File.directory?(path)
+        next if config[:include] and !config[:include].any? { |glob| File.fnmatch(glob, path) }
+        next if config[:exclude].any? { |glob| File.fnmatch(glob, path) }
+        result << yield(path)
+      end
+      result
+    end
+
+    protected
+
+    def extract_key_from_match(match, path)
+      key = strip_literal(match[0])
+      key = absolutize_key(key, path) if path && key.start_with?('.')
+      key
+    end
+
+    # remove the leading colon and unwrap quotes from the key match
+    def strip_literal(literal)
+      key = literal
+      key.slice!(0) if ':' == key[0]
+      key = key[1..-2] if %w(' ").include?(key[0])
+      key
+    end
+
+    VALID_KEY_RE = /^[\w.\#{}]+$/
+
+    def valid_key?(key)
+      key =~ VALID_KEY_RE
+    end
+
+    def relative_roots
+      config[:relative_roots]
+    end
+
+  end
+end

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

@@ -0,0 +1,26 @@
+# Scans for I18n.t usages
+require 'i18n/tasks/scanners/base_scanner'
+module I18n::Tasks::Scanners
+  class PatternScanner < BaseScanner
+    LITERAL_RE = /:?".+?"|:?'.+?'|:\w+/
+    DEFAULT_PATTERN = /\bt(?:ranslate)?[( ]\s*(#{LITERAL_RE})/
+
+    # Extract i18n keys from file based on the pattern. The pattern must capture key literal.
+    # @return [String] keys found in file
+    def scan_file(path)
+      keys = []
+      File.open(path, 'rb') do |f|
+        f.read.scan(pattern) do |match|
+          key = extract_key_from_match(match, path)
+          keys << key if valid_key?(key)
+        end
+      end
+      keys
+    end
+
+    protected
+    def pattern
+      @pattern ||= config[:pattern].present? ? Regexp.new(config[:pattern]) : DEFAULT_PATTERN
+    end
+  end
+end

data/lib/i18n/tasks/source_keys.rb

@@ -1,12 +1,19 @@
 require 'find'
+require 'i18n/tasks/scanners/pattern_scanner'
 
 module I18n::Tasks::SourceKeys
-  # find all keys in the source (relative keys are returned in absolutized)
+  # find all keys in the source (relative keys are absolutized)
   # @return [Array<String>]
   def find_source_keys
-    @source_keys ||= traverse_files do |path|
-      extract_keys(path)
-    end.flatten.uniq
+    @source_keys ||= scanner.keys
+  end
+
+  def scanner
+    @scanner ||= begin
+      search_config = config[:search].with_indifferent_access
+      class_name    = search_config[:scanner] || '::I18n::Tasks::Scanners::PatternScanner'
+      class_name.constantize.new search_config.merge(relative_roots: relative_roots)
+    end
   end
 
   # whether the key is used in the source
@@ -26,42 +33,4 @@ module I18n::Tasks::SourceKeys
     @pattern_keys_prefixes ||=
         find_source_keys.select { |k| k =~ /\#{.*?}/ || k.ends_with?('.') }.map { |k| k.split(/\.?#/)[0].presence }.compact
   end
-
-  # Run given block for every relevant file, according to search_config
-  # @return [Array] Results of block calls
-  def traverse_files
-    result = []
-    Find.find(*search_config[:paths]) do |path|
-      next if File.directory?(path)
-      next if search_config[:include] and !search_config[:include].any? { |glob| File.fnmatch(glob, path) }
-      next if search_config[:exclude].any? { |glob| File.fnmatch(glob, path) }
-      result << yield(path)
-    end
-    result
-  end
-
-  # Extract i18n keys from file
-  # @return [String] keys used in file (absolutized and unique)
-  def extract_keys(path)
-    keys = []
-    File.open(path, 'rb') do |f|
-      f.read.scan(search_config[:pattern]) do |match|
-        key = parse_key(match)
-        key = absolutize_key(key, path) if key.start_with? '.'
-        if key =~ /^[\w.\#{}]+$/
-          keys << key
-        end
-      end
-    end
-    keys
-  end
-
-  private
-  # remove the leading colon and unwrap quotes from the key match
-  def parse_key(match)
-    key = match[0]
-    key.slice!(0) if ':' == key[0]
-    key = key[1..-2] if %w(' ").include?(key[0])
-    key
-  end
 end

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Tasks
-    VERSION = '0.2.15'
+    VERSION = '0.2.17'
   end
 end

data/spec/{source_keys_spec.rb → pattern_scanner_spec.rb}

@@ -1,9 +1,8 @@
 require 'spec_helper'
 
-describe 'Source keys' do
-  let!(:task) { I18n::Tasks::BaseTask.new }
-  describe 'pattern' do
-    let!(:pattern) { task.search_config[:pattern] }
+describe 'Pattern Scanner' do
+  describe 'default pattern' do
+    let!(:pattern) { I18n::Tasks::Scanners::PatternScanner::DEFAULT_PATTERN }
 
     ['t "a.b"', "t 'a.b'", 't("a.b")', "t('a.b')",
      "t('a.b', :arg => val)", "t('a.b', arg: val)",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.2.15
+  version: 0.2.17
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-07 00:00:00.000000000 Z
+date: 2014-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -213,6 +213,8 @@ files:
 - lib/i18n/tasks/reports/base.rb
 - lib/i18n/tasks/reports/spreadsheet.rb
 - lib/i18n/tasks/reports/terminal.rb
+- lib/i18n/tasks/scanners/base_scanner.rb
+- lib/i18n/tasks/scanners/pattern_scanner.rb
 - lib/i18n/tasks/source_keys.rb
 - lib/i18n/tasks/translation_data.rb
 - lib/i18n/tasks/untranslated_keys.rb
@@ -227,9 +229,9 @@ files:
 - spec/google_translate_spec.rb
 - spec/i18n_tasks_spec.rb
 - spec/key_pattern_matching_spec.rb
+- spec/pattern_scanner_spec.rb
 - spec/readme_spec.rb
 - spec/relative_keys_spec.rb
-- spec/source_keys_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
 - spec/support/i18n_tasks_output_matcher.rb
@@ -272,9 +274,9 @@ test_files:
 - spec/google_translate_spec.rb
 - spec/i18n_tasks_spec.rb
 - spec/key_pattern_matching_spec.rb
+- spec/pattern_scanner_spec.rb
 - spec/readme_spec.rb
 - spec/relative_keys_spec.rb
-- spec/source_keys_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
 - spec/support/i18n_tasks_output_matcher.rb