i18n-tasks 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fba31809b28d7db5c2f2febad005236e8e4b7e1b
-  data.tar.gz: 0b3f032893745205af5368c017fe092fea521b26
+  metadata.gz: c8589f7427df05f3f7b0800308e70ae540e37de5
+  data.tar.gz: 188dde3f2e967792815f620e501c7a4e1fb21762
 SHA512:
-  metadata.gz: ca884fd7cd3f02830003fb4fe8e13586fa162c22b328a17c39f0655e08005e03073ac193b6d57c50e3edb619b93bfc316eef873a761fb4bbdaac2d16d05c6375
-  data.tar.gz: 3ebcfa3023b2b5c6cb83181382a51253ffca5ce2ed476d9167495da31d19358ed8db3b8bd2401b522295f64312bdad9f51f5884a1de17145474eb3a45458d538
+  metadata.gz: 052729b13dda5b45fe78dbbab9ea4bfb46c98d057927d8ca9b772b4c254ea9f4342940ddf60a37e10e8fb8ea62345cc73b891cc654cf28cc8cb25128d58ccec3
+  data.tar.gz: 63b64036166715e0b07644a022028f4a77c2b7932fa0722f1e39503b790d1a3174e21d7a1dfab1ebe8e62d5e2c3eaa0d8dc674e671fb87ac8ca0eda05f7e9d3f

data/.travis.yml

@@ -3,12 +3,4 @@ rvm:
   - 2.0.0
   - 1.9.3
   - jruby
-  - jruby-head
   - rbx-19mode
-
-matrix:
-  allow_failures:
-    - rvm: jruby
-    - rvm: jruby-head
-    - rvm: rbx-19mode
-

data/CHANGES.md

@@ -1,3 +1,7 @@
+## v0.1.8
+
+* improved search: no longer uses grep, more robust detection (@natano)
+
 ## v0.1.7
 
 * ability to route prefill output via data.write config (@glebm)

data/README.md

@@ -3,7 +3,9 @@
 
 Rails I18n tasks to find missing / unused translations and more. Works with slim / coffee / haml etc.
 
-![i18n-missing-screenshot](https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.png "rake i18n:missing output screenshot")
+![i18n-screenshot](https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.png "i18n-tasks output screenshot")
+
+## Usage
 
 Use `rake -T i18n` to get the list of tasks with descriptions. There are 3 tasks available at the moment:
 
@@ -29,15 +31,12 @@ For more examples see [the tests](/spec/i18n_tasks_spec.rb).
 Simply add to Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.1.0'
+gem 'i18n-tasks', '~> 0.1.7'
 ```
 
-`grep` is required. You likely have it already on Linux / Mac / BSD, Windows users will need to [install](http://gnuwin32.sourceforge.net/packages/grep.htm) and make sure it's available in `PATH`.
-
-
 ## Configuration
 
-Configuration is read from `i18n-tasks/config.yml`.
+Configuration is read from `config/i18n-tasks.yml`.
 
 ### Storage
 
@@ -75,8 +74,10 @@ search:
     - '*.html.*'
     - '*.text.*'
   # explicitly exclude files (default: blank = exclude no files)
-  exclude: '*.js'
-  # search uses grep under the hood
+  exclude:
+    - '*.js'
+  # you can override the default grep pattern:
+  pattern: '\bt[( ]\s*(.)((?<=").+?(?=")|(?<=').+?(?=')|(?<=:)\w+\b)'
 ```
 
 ### Fine-tuning

data/i18n-tasks.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rails'
   spec.add_dependency 'rake'
+  spec.add_dependency 'activesupport'
   spec.add_dependency 'term-ansicolor'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

data/lib/i18n/tasks/data_traversal.rb

@@ -27,11 +27,7 @@ module I18n::Tasks::DataTraversal
     list.each do |key, value|
       key_segments = key.to_s.split('.')
       node = key_segments[0..-2].inject(tree) do |r, segment|
-        if r.key?(segment)
-          r[segment]
-        else
-          r[segment] = {}
-        end
+        r[segment] ||= {}
       end
       node[key_segments.last] = value
     end

data/lib/i18n/tasks/output/terminal.rb

@@ -8,7 +8,7 @@ module I18n
         def missing(missing)
           print_title "Missing keys and translations (#{missing.length})"
           if missing.present?
-            $stderr.puts "#{bold 'Legend:'} #{on_red '✗'} key missing, #{yellow bold '∅'} translation blank, #{blue bold '='} value equal to base locale, #{cyan 'value in base locale'}"
+            $stderr.puts "#{bold 'Legend:'} #{red '✗'} key missing, #{yellow bold '∅'} translation blank, #{blue bold '='} value equal to base locale, #{cyan 'value in base locale'}"
             key_col_width = missing.map { |x| x[:key] }.max_by(&:length).length + 2
             missing.each { |m| print_missing_translation m, key_col_width: key_col_width }
           else
@@ -47,14 +47,11 @@ module I18n
         def print_missing_translation(m, opts)
           locale, key, base_value, status_text = m[:locale], m[:key], m[:base_value].to_s.try(:strip), " #{STATUS_TEXTS[m[:type]]}"
 
-          long = base_value.length > 50
-
-          key = magenta "#{key}#{':' if long}".ljust(opts[:key_col_width])
-          base_value = "\n#{indent(base_value, 13)}\n" if long
+          key = magenta "#{key}".ljust(opts[:key_col_width])
           s   = if m[:type] == :none
                   "#{red bold locale.ljust(4)} #{status_text} #{key}"
                 else
-                  "#{bold locale.ljust(4)} #{status_text} #{key} #{cyan base_value}"
+                  "#{bold locale.ljust(4)} #{status_text} #{key} #{cyan base_value.strip.gsub("\n", ' ')}"
                 end
           puts s
         end

data/lib/i18n/tasks/prefill.rb

@@ -2,10 +2,9 @@ require 'i18n/tasks/base_task'
 
 module I18n
   module Tasks
+    # Prefill values from base locale data
     class Prefill < BaseTask
-      # todo refactor to allow configuring output targets
       def perform
-        # Will also rewrite en, good for ordering
         I18n.available_locales.map(&:to_s).each do |target_locale|
           data[target_locale] = data[base_locale].deep_merge(data[target_locale])
         end

data/lib/i18n/tasks/source_keys.rb

@@ -1,22 +1,12 @@
-require 'open3'
+require 'find'
+
 module I18n::Tasks::SourceKeys
   # find all keys in the source (relative keys are returned in absolutized)
   # @return [Array<String>]
   def find_source_keys
-    @source_keys ||= begin
-      if (grep_out = run_grep)
-        grep_out.split("\n").map { |r|
-          key = r.match(/['"](.*?)['"]/)[1]
-          if key.start_with? '.'
-            absolutize_key key, r.split(':')[0]
-          else
-            key
-          end
-        }.uniq.reject { |k| k !~ /^[\w.\#{}]+$/ }
-      else
-        []
-      end
-    end
+    @source_keys ||= traverse_files do |path|
+      extract_keys(path)
+    end.flatten.uniq
   end
 
   # whether the key is used in the source
@@ -41,8 +31,8 @@ module I18n::Tasks::SourceKeys
 
   # grep config, also from config/i18n-tasks.yml
   # @return [Hash{String => String,Hash,Array}]
-  def grep_config
-    @grep_config ||= begin
+  def search_config
+    @search_config ||= begin
       if config.key?(:grep)
         config[:search] ||= config.delete(:grep)
         warn_deprecated 'please rename "grep" key to "search" in config/i18n-tasks.yml'
@@ -50,30 +40,42 @@ module I18n::Tasks::SourceKeys
       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]) : /\bt[( ]\s*(.)((?<=").+?(?=")|(?<=').+?(?=')|(?<=:)\w+\b)/
       end
     end
   end
 
-  # Run grep searching for source keys and return grep output
-  # @return [String] output of the grep command
-  def run_grep
-    args = ['grep', '-HoRI']
-    [:include, :exclude].each do |opt|
-      next unless (val = grep_config[opt]).present?
-      args += Array(val).map { |v| "--#{opt}=#{v}" }
+  # 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
-    args += [%q{\\bt(\\?\\s*['"]\\([^'"]*\\)['"]}, *grep_config[:paths]]
-    args.compact!
-    run_command *args
+    result
   end
 
-
-  # Run command and get only stdout output
-  # @return [String] output
-  # @raise [RuntimeError] if grep returns with exit code other than 0
-  def run_command(*args)
-    o, e, s = Open3.capture3(*args)
-    raise "#{args[0]} failed with status #{s.exitstatus} (stderr: #{e})" unless s.success?
-    o
+  # Extract i18n keys from file
+  # @return [String] list of unique, absolut keys
+  def extract_keys(path)
+    keys = []
+    File.open(path, 'rb') do |f|
+      while (line = f.gets)
+        line.scan(search_config[:pattern]) do |t, key|
+          if key.start_with? '.'
+            key = absolutize_key(key, path)
+          elsif t == ':'
+            key = absolutize_key(".#{key}", path)
+          end
+          keys << key
+        end
+      end
+    end
+    keys.select { |k| k =~ /^[\w.\#{}]+$/ }
   end
-end
+end

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Tasks
-    VERSION = '0.1.7'
+    VERSION = '0.1.8'
   end
 end

data/spec/fixtures/app/views/index.html.slim

@@ -10,3 +10,4 @@ p = t 'ignore_eq_base_es.a'
 p = t 'numeric.a'
 p = t 'plural.a', count: 2
 p = t 'devise.a'
+p = t :missing_symbol_key

data/spec/i18n_tasks_spec.rb

@@ -5,8 +5,8 @@ describe 'rake i18n' do
   describe 'missing' do
     it 'detects missing or identical' do
       TestCodebase.capture_stderr do
-        TestCodebase.rake_result('i18n:missing').should be_i18n_keys %w(en.used_but_missing.a es.missing_in_es.a es.blank_in_es.a es.same_in_es.a)
-      end.should =~ /Missing keys and translations \(4\)/
+        TestCodebase.rake_result('i18n:missing').should be_i18n_keys %w(en.used_but_missing.a en.index.missing_symbol_key es.missing_in_es.a es.blank_in_es.a es.same_in_es.a)
+      end.should =~ /Missing keys and translations \(5\)/
     end
   end
 

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-20 00:00:00.000000000 Z
+date: 2013-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -122,7 +122,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- doc/img/i18n-missing.png
 - doc/img/i18n-tasks.png
 - i18n-tasks.gemspec
 - lib/i18n/tasks.rb