i18n-tasks 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 249e36d0665a2fda7758aede212244f485083b54
-  data.tar.gz: 149073894264064e8972f43833fdffb4df4d2e18
+  metadata.gz: 4d271be49ca3aee877e8799c24145bc17b9d5c33
+  data.tar.gz: df4a3e1a654c27714df1117ab5a561ef62ab762c
 SHA512:
-  metadata.gz: 772c68ce93f166f9c41886a3de694088031efb5433dd58cb8f3da032c91a3a5be3b55027d460a29f63ee2a41c7f9ad7d033a5d1abe4bb8693ea3cb175b409c3b
-  data.tar.gz: 354dd75548fc81da5eb335be15472dcf96fcd269e8c6ff077ec1c44833a10011e2aea69aecd79a8e1b93cde6a9b478ba56e6a8ca38eca89f6f431dcd202a44f9
+  metadata.gz: 50a1d85e61b5a39d649c321648596268c70123193c913918bb6ac2eeedbe11bc2bba45ce0a6106622883541e944d248f3c9b2588d977ab87f900fef70c035ea4
+  data.tar.gz: 29f950b42403e129faf1473b4d8888fbdb61569569689adbc0fee72f237f017b80ba10d28562d213e22497d95f991ad7efe060734cd36e9ad6cf83c71f5e017a

data/README.md

@@ -23,6 +23,8 @@ Relative keys (`t '.title'`) are supported too.
     devise.errors.unauthorized # ignore this key
     pagination.views.          # ignore the whole pattern (note the .)
 
+Keys listed in `.i18nignore` will also be excluded from `i18n:unused` report.
+
 For more examples see [the tests](https://github.com/glebm/i18n-tasks/blob/master/spec/i18n_tasks_spec.rb#L43-L59).
 
 Installation
@@ -30,11 +32,20 @@ Installation
 
 Simply add to Gemfile:
 
-    gem 'i18n-tasks', '~> 0.0.7'
+    gem 'i18n-tasks', '~> 0.0.8'
 
 Configuration
 -------------
 
-Currently i18n-tasks only reports / writes to locale data in `config/locales/{locale_code}.yml`. *PRs making this configurable welcome!*
+By default reports I18n reads locale data from `config/locales/{locale_code}.yml`.
+You can customize this, e.g.:
+
+    # load all config/locales/*.locale.yml and config/locales/locale.yml:
+    I18n::Tasks.get_locale_data = ->(locale) {
+      (["config/locales/#{locale}.yml"] + Dir["config/locales/*.#{locale}.yml"]).inject({}) { |hash, path|
+        hash.merge! YAML.load_file(path)
+        hash
+      }
+    }
 
   [i18n-missing-screenshot]: https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-missing.png "rake i18n:missing output screenshot"

data/lib/i18n/tasks.rb

@@ -3,6 +3,9 @@ require 'i18n/tasks/railtie'
 
 module I18n
   module Tasks
-
+    mattr_accessor :get_locale_data
+    self.get_locale_data = lambda { |locale|
+      YAML.load_file("config/locales/#{locale}.yml")
+    }
   end
 end

data/lib/i18n/tasks/base_task.rb

@@ -1,21 +1,16 @@
 # coding: utf-8
-require 'open3'
 require 'term/ansicolor'
+require 'i18n/tasks/task_helpers'
 
 module I18n
   module Tasks
     class BaseTask
       include Term::ANSIColor
-
-      def run_command(*args)
-        _in, out, _err = Open3.popen3(*args)
-        out.gets nil
-      end
+      include TaskHelpers
 
       # locale data hash, with locale name as root
       def get_locale_data(locale)
-        # todo multiple files, configuration option
-        YAML.load_file "config/locales/#{locale}.yml"
+        (@locale_data ||= {})[locale] ||= I18n::Tasks.get_locale_data.call(locale)
       end
 
       # main locale file path (for writing to)
@@ -30,7 +25,7 @@ module I18n
           used_keys = grep_out.split("\n").map { |r|
             key = r.match(/['"](.*?)['"]/)[1]
             # absolutize relative key:
-            if key.start_with?('.')
+            if key.start_with? '.'
               path = r.split(':')[0]
               # normalized path
               path = Pathname.new(File.expand_path path).relative_path_from(Pathname.new(Dir.pwd)).to_s
@@ -40,18 +35,12 @@ module I18n
             else
               key
             end
-          }.uniq.to_set
+          }.uniq
           used_keys = used_keys.reject { |k| k !~ /^[\w.\#{}]+$/ }
           exclude_patterns used_keys, ignore_patterns
         end
       end
 
-      def exclude_patterns(keys, patterns)
-        keys.reject do |k|
-          patterns.any? { |pattern| k == pattern || pattern.end_with?('.') && k.start_with?(pattern) }
-        end
-      end
-
       IGNORE_FILE = '.i18nignore'
 
       def ignore_patterns
@@ -67,26 +56,28 @@ module I18n
       end
 
       def find_source_pattern_keys
-        find_source_keys.select { |k| k =~ /\#{.*?}/ || k.ends_with?('.') }
+        @source_pattern_keys ||= find_source_keys.select { |k| k =~ /\#{.*?}/ || k.ends_with?('.') }
       end
 
       def find_source_pattern_prefixes
-        find_source_pattern_keys.map { |k| k.split(/\.?#/)[0] }
+        @source_pattern_prefixes ||= find_source_pattern_keys.map { |k| k.split(/\.?#/)[0] }
       end
 
       # traverse hash, yielding with full key and value
-      def traverse(path = '', hash, &block)
-        hash.each do |k, v|
-          if v.is_a?(Hash)
-            traverse("#{path}.#{k}", v, &block)
+      def traverse(path = '', hash)
+        q = [ [path, hash] ]
+        until q.empty?
+          path, value = q.pop
+          if value.is_a?(Hash)
+            value.each { |k, v| q << ["#{path}.#{k}", v] }
           else
-            block.call("#{path}.#{k}"[1..-1], v)
+            yield path[1..-1], value
           end
         end
       end
 
       def t(hash, key)
-        key.split('.').inject(hash) { |r, seg| r.try(:[], seg) }
+        key.split('.').inject(hash) { |r, seg| r[seg] if r }
       end
 
       def base_locale

data/lib/i18n/tasks/missing.rb

@@ -37,9 +37,10 @@ module I18n
         missing = []
 
         # missing keys (in the code but not in base locale data)
-        pattern_prefixes = find_source_pattern_prefixes
+        pattern_re = compile_start_with_re find_source_pattern_prefixes
+
         find_source_keys.each do |key|
-          if t(base[base_locale], key).blank? && !pattern_prefixes.any? { |pp| key.start_with?(pp) }
+          if t(base[base_locale], key).blank? && key !~ pattern_re
             missing << {locale: :en, type: :none, key: key}
           end
         end

data/lib/i18n/tasks/task_helpers.rb

@@ -1,9 +1,24 @@
 # coding: utf-8
-
-
+require 'open3'
 module I18n
   module Tasks
     module TaskHelpers
+      # Run command and get only stdout output
+      def run_command(*args)
+        _in, out, _err = Open3.popen3(*args)
+        out.gets nil
+      end
+
+      # compile prefix matching Regexp from the list of prefixes
+      def compile_start_with_re(prefixes)
+        /^(?:#{prefixes.map{|p| Regexp.escape(p) }.join('|')})/
+      end
 
+      # exclude @keys with prefixes matching @patterns
+      def exclude_patterns(keys, patterns)
+        pattern_re = compile_start_with_re patterns.select { |p| p.end_with?('.') }
+        (keys - patterns).reject { |k| k =~ pattern_re }
+      end
+    end
   end
 end

data/lib/i18n/tasks/unused.rb

@@ -14,11 +14,14 @@ module I18n
       end
 
       def find_unused
-        used_keys = find_source_keys
-        pattern_prefixes = find_source_pattern_prefixes
+        used_keys = find_source_keys.to_set
         r = []
+        ignore_re = compile_start_with_re ignore_patterns
+        pattern_re = compile_start_with_re find_source_pattern_prefixes
         traverse base[base_locale] do |key, value|
-          r << [key, value] if !used_keys.include?(key) && !pattern_prefixes.any? { |pp| key.start_with?(pp) }
+          unless used_keys.include?(key) || key =~ pattern_re || key =~ ignore_re
+            r << [key, value]
+          end
         end
         r
       end

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Tasks
-    VERSION = '0.0.7'
+    VERSION = '0.0.8'
   end
 end

data/spec/i18n_tasks_spec.rb

@@ -23,6 +23,7 @@ describe 'rake i18n' do
   end
 
   # --- setup ---
+  BENCH_KEYS = 3000
   before do
     gen_data = ->(v) {
       {
@@ -35,6 +36,10 @@ describe 'rake i18n' do
           'same_in_es'    => {'a' => v},
           'blank_in_es'   => {'a' => v},
           'relative'      => {'index' => {'title' => v}}
+
+      }.tap {|r|
+        gen = r["bench"] = {}
+        BENCH_KEYS.times.map { |i| gen["key#{i}"] = v }
       }
     }
 
@@ -72,6 +77,8 @@ describe 'rake i18n' do
                    end
                 end
         RUBY
+        # test that our algorithms can scale to the order of {BENCH_KEYS} keys.
+        'app/heavy.file' => BENCH_KEYS.times.map { |i| "t('bench.key#{i}') " }.join
     }
     TestCodebase.setup fs
   end

data/spec/support/i18n_tasks_output_matcher.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 RSpec::Matchers.define :be_i18n_keys do |expected|
   locale_re = /^\w{2}\b/
   extract_keys = ->(actual){

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-15 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails