i18n-tasks 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9ffd7cede573f8a4cee0a811d80345a6e8ebb37
-  data.tar.gz: 813300ebfe3b65e3d624c6c67636121f8d874603
+  metadata.gz: a588b5fcc4c85ab519a9cf45074cbc8d5f77511e
+  data.tar.gz: b9d6327dfce3a34fe6c5621cc3075c121533786b
 SHA512:
-  metadata.gz: e205fafc63991aae11c9a7506886b235fe2c5dd612402ebb12de0c9c9954887b97a426a8dbbcb8122251c56c65281516fff37e677b9def315d9975de6f39b8d4
-  data.tar.gz: 0991e4295a36944f8545ee25259307f20c239b87d1e968515c1e55895fcf252f52666272f4a1b6e09bb9e2c1b137d24f30fe5ad83ac9480859e1c8cf0bc7ae35
+  metadata.gz: 345f4b4255b47573f1ab42d02414bae76223d9c7e6978106701ccc325417aa5203275863b6f8b927a572ebfd64d1d07241a79932a7b53f65c3d34a780e90b535
+  data.tar.gz: 8a612fad25cf93919596ffba6f1fe9d07a80f91b52267872ac6d85bd1c4f21fce36b89141725f0051cd1aa3a525e86fd30ff8e74c37a199edfc7c06e3b9cb7fc

data/README.md

@@ -16,6 +16,12 @@ Use `rake -T i18n` to get the list of tasks with descriptions. There are 3 tasks
     t 'category.' + category.key # 'category.arts_and_crafts' considered used
     t "category.#{category.key}" # also works
 
+`i18n:missing` may incorrectly show framework i18n keys as missing, to work around this use `.i18nignore` file in project root:
+
+   devise.errors.unauthorized # ignore this key
+   pagination.views.          # ignore the whole pattern (note the .)
+
+
 For more examples see [the tests](https://github.com/glebm/i18n-tasks/blob/master/spec/i18n_tasks_spec.rb#L43-L59).
 
 Installation
@@ -23,7 +29,7 @@ Installation
 
 Simply add to Gemfile:
 
-    gem 'i18n-tasks', '~> 0.0.3'
+    gem 'i18n-tasks', '~> 0.0.5'
 
 Configuration
 -------------

data/lib/i18n/tasks/base_task.rb

@@ -1,9 +1,87 @@
-require 'i18n/tasks/task_helpers'
+require 'open3'
+require 'term/ansicolor'
 
 module I18n
   module Tasks
     class BaseTask
-      include TaskHelpers
+      include Term::ANSIColor
+
+      def run_command(*args)
+        _in, out, _err = Open3.popen3(*args)
+        out.gets nil
+      end
+
+      # 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"
+      end
+
+      # main locale file path (for writing to)
+      def locale_file_path(locale)
+        "config/locales/#{locale}.yml"
+      end
+
+      # find all keys in the source
+      def find_source_keys
+        @source_keys ||= begin
+          grep_out  = run_command 'grep', '-horI', %q{\\bt(\\?\\s*['"]\\([^'"]*\\)['"]}, 'app/'
+          used_keys = grep_out.split("\n").map { |r| r.match(/['"](.*?)['"]/)[1] }.uniq.to_set
+          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
+        @ignored_patterns ||= begin
+          if File.exists?(IGNORE_FILE)
+            File.read(IGNORE_FILE).split("\n").map {|k|
+              k.split('#')[0].strip.presence
+            }.compact.uniq
+          else
+            []
+          end
+        end
+      end
+
+      def find_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] }
+      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)
+          else
+            block.call("#{path}.#{k}"[1..-1], v)
+          end
+        end
+      end
+
+      def t(hash, key)
+        key.split('.').inject(hash) { |r, seg| r.try(:[], seg) }
+      end
+
+      def base_locale
+        I18n.default_locale.to_s
+      end
+
+      def base
+        @base ||= get_locale_data(base_locale)
+      end
     end
   end
 end

data/lib/i18n/tasks/missing.rb

@@ -9,10 +9,12 @@ module I18n
       def perform
         missing = find_missing
         STDERR.puts bold cyan("= #{DESC} (#{missing.length}) =")
+        STDERR.puts cyan(" This task may report framework i18n keys as missing (use .i18nignore if that happens)")
+        STDERR.puts cyan " Legend:\t#{red '✗'} - key is missing\t#{yellow bold '∅'} - translation is blank\t#{yellow bold '='} - value same as base locale"
         status_texts = {
-            none: red("✗ #{bold 'none'}".ljust(19)),
-            blank: yellow(bold '∅ blank'.ljust(11)),
-            eq_base: yellow(bold "= #{base_locale.ljust(9)}")
+            none: red("✗".ljust(6)),
+            blank: yellow(bold '∅'.ljust(6)),
+            eq_base: yellow(bold "=".ljust(6))
         }
 
         missing.sort_by { |m| m[:type] }.reverse_each do |m|

data/lib/i18n/tasks/task_helpers.rb

@@ -1,65 +1,9 @@
 # coding: utf-8
-require 'open3'
-require 'term/ansicolor'
+
 
 module I18n
   module Tasks
     module TaskHelpers
-      include Term::ANSIColor
-      def run_command(*args)
-        _in, out, _err = Open3.popen3(*args)
-        out.gets nil
-      end
-
-      # 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"
-      end
-
-      # main locale file path (for writing to)
-      def locale_file_path(locale)
-        "config/locales/#{locale}.yml"
-      end
-
-      # find all keys in the source
-      def find_source_keys
-        @source_keys ||= begin
-          grep_out = run_command 'grep', '-horI', %q{\\bt(\\?\\s*['"]\\([^'"]*\\)['"]}, 'app/'
-          used_keys = grep_out.split("\n").map { |r| r.match(/['"](.*?)['"]/)[1] }.uniq.to_set
-        end
-      end
-
-      def find_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] }
-      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)
-          else
-            block.call("#{path}.#{k}"[1..-1], v)
-          end
-        end
-      end
-
-      def t(hash, key)
-        key.split('.').inject(hash) { |r, seg| r.try(:[], seg) }
-      end
-
-      def base_locale
-        I18n.default_locale.to_s
-      end
 
-      def base
-        @base ||= get_locale_data(base_locale)
-      end
-    end
   end
 end

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Tasks
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

data/spec/i18n_tasks_spec.rb

@@ -45,11 +45,17 @@ describe 'rake i18n' do
     fs = {
         'config/locales/en.yml'     => {'en' => en_data}.to_yaml,
         'config/locales/es.yml'     => {'es' => es_data}.to_yaml,
+        '.i18nignore' => <<-TEXT,
+        ignored_missing_key.a # one key to ignore
+        ignored_pattern.      # ignore the whole pattern
+        TEXT
         'app/views/index.html.slim' => <<-SLIM,
         p \#{t('ca.a')} \#{t 'ca.b'} \#{t "ca.c"}
         p \#{t 'ca.d'} \#{t 'ca.f', i: 'world'} \#{t 'ca.e', i: 'world'}
         p \#{t 'missing_in_es.a'} \#{t 'same_in_es.a'} \#{t 'blank_in_es.a'}
         p = t 'used_but_missing.a'
+        p = t 'ignored_missing_key.a'
+        p = t 'ignored_pattern.some_key'
         SLIM
         'app/controllers/events_controller.slim' => <<-RUBY,
         class EventsController < ApplicationController

metadata

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