i18n-tasks 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d271be49ca3aee877e8799c24145bc17b9d5c33
-  data.tar.gz: df4a3e1a654c27714df1117ab5a561ef62ab762c
+  metadata.gz: 3695a5c801e3826fc8ec81bdf35d1ce830dae4f4
+  data.tar.gz: 3f0dceded74c9f668ae316dfd72ba1c1154d713b
 SHA512:
-  metadata.gz: 50a1d85e61b5a39d649c321648596268c70123193c913918bb6ac2eeedbe11bc2bba45ce0a6106622883541e944d248f3c9b2588d977ab87f900fef70c035ea4
-  data.tar.gz: 29f950b42403e129faf1473b4d8888fbdb61569569689adbc0fee72f237f017b80ba10d28562d213e22497d95f991ad7efe060734cd36e9ad6cf83c71f5e017a
+  metadata.gz: 8f93118329d8599262d2b2443a5631b6cd6bb4adb1395b8f2e467fb70432939ffafe577b943f04eef2be6304ff274facc0454e4229becceda3b07087f55c96a0
+  data.tar.gz: 75f103be804ab756261c00dc318ea7669a3f20d92e7f4a9cb5223ba6ae60cf3af6d0b1d5d5dfc4fe8f8d9ddf05e41321f1d0e05ef3c711f24ad7af057e46b379

data/.gitignore

@@ -30,3 +30,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -1,6 +1,12 @@
 language: ruby
 rvm:
   - 2.0.0
-  - jruby-19mode # JRuby in 1.9 mode
-  - rbx-19mode
   - 1.9.3
+  - jruby
+  - rbx-19mode
+
+matrix:
+  allow_failures:
+    - rvm: jruby
+    - rvm: rbx-19mode
+

data/README.md

@@ -18,13 +18,6 @@ Use `rake -T i18n` to get the list of tasks with descriptions. There are 3 tasks
 
 Relative keys (`t '.title'`) are supported too.
 
-`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 .)
-
-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
@@ -32,18 +25,42 @@ Installation
 
 Simply add to Gemfile:
 
-    gem 'i18n-tasks', '~> 0.0.8'
+    gem 'i18n-tasks', '~> 0.1.0'
 
 Configuration
 -------------
 
+
+Tasks may incorrectly report framework i18n keys as missing. You can add `config/i18n-tasks.yml` to work around this:
+
+    # do not report these keys as missing (both on blank value and no key)
+    ignore_missing:
+      - devise.errors.unauthorized # ignore this key
+      - pagination.views.          # ignore the whole pattern (note the .)
+
+    # do not report these keys when they have the same value as the base locale version
+    ignore_eq_base:
+      all:
+        - common.ok
+      es,fr:
+        - common.brand
+
+    # do not report these keys as unused
+    ignore_unused:
+      - category.
+
+    # do not report these keys ever
+    ignore:
+      - kaminari.
+
+
 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.deep_merge! YAML.load_file(path)
         hash
       }
     }

data/lib/i18n/tasks.rb

@@ -1,5 +1,6 @@
 require 'i18n/tasks/version'
 require 'i18n/tasks/railtie'
+require 'active_support/hash_with_indifferent_access'
 
 module I18n
   module Tasks
@@ -7,5 +8,16 @@ module I18n
     self.get_locale_data = lambda { |locale|
       YAML.load_file("config/locales/#{locale}.yml")
     }
+
+    CONFIG_FILE = 'config/i18n-tasks.yml'
+    class << self
+      def config
+        @config ||= begin
+          file = File.read(CONFIG_FILE) if File.exists?(CONFIG_FILE)
+          file = YAML.load(file) if file.present?
+          HashWithIndifferentAccess.new.merge(file.presence || {})
+        end
+      end
+    end
   end
 end

data/lib/i18n/tasks/base_task.rb

@@ -36,24 +36,10 @@ module I18n
               key
             end
           }.uniq
-          used_keys = used_keys.reject { |k| k !~ /^[\w.\#{}]+$/ }
-          exclude_patterns used_keys, ignore_patterns
+          used_keys.reject { |k| k !~ /^[\w.\#{}]+$/ }
         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].try(:strip).presence
-            }.compact.uniq
-          else
-            []
-          end
-        end
-      end
 
       def find_source_pattern_keys
         @source_pattern_keys ||= find_source_keys.select { |k| k =~ /\#{.*?}/ || k.ends_with?('.') }

data/lib/i18n/tasks/missing.rb

@@ -33,16 +33,18 @@ module I18n
 
 
 
+      # get all the missing translations as list of missing keys as hashes with:
+      #  {:locale, :key, :type, and optionally :base_value}
+      #  :type — :blank, :missing, or :eq_base
+      #  :base_value — translation value in base locale if one is present
       def find_missing
-        missing = []
-
-        # missing keys (in the code but not in base locale data)
+        # dynamically generated keys in the source, e.g t("category.#{category_key}")
         pattern_re = compile_start_with_re find_source_pattern_prefixes
 
-        find_source_keys.each do |key|
-          if t(base[base_locale], key).blank? && key !~ pattern_re
-            missing << {locale: :en, type: :none, key: key}
-          end
+        # missing keys (in the code but not in base locale data)
+        keys = find_source_keys
+        missing = keys.select { |key| t(base[base_locale], key).blank? && key !~ pattern_re && key !~ ignore_pattern(:missing) }.map do |key|
+          {locale: base_locale, type: :none, key: key}
         end
 
         # missing translations (present in base locale, but untranslated in another locale )
@@ -50,9 +52,9 @@ module I18n
           trn = get_locale_data(locale)[locale]
           traverse base[base_locale] do |key, base_value|
             translated = t(trn, key)
-            if translated.blank?
+            if translated.blank? && key !~ ignore_pattern(:missing)
               missing << {locale: locale, key: key, type: :blank, base_value: base_value}
-            elsif translated == base_value
+            elsif translated == base_value && key !~ ignore_pattern(:eq_base, locale)
               missing << {locale: locale, key: key, type: :eq_base, base_value: base_value}
             end
           end

data/lib/i18n/tasks/task_helpers.rb

@@ -11,7 +11,11 @@ module I18n
 
       # compile prefix matching Regexp from the list of prefixes
       def compile_start_with_re(prefixes)
-        /^(?:#{prefixes.map{|p| Regexp.escape(p) }.join('|')})/
+        if prefixes.blank?
+          /\Z\A/ # match nothing
+        else
+          /^(?:#{prefixes.map { |p| Regexp.escape(p) }.join('|')})/
+        end
       end
 
       # exclude @keys with prefixes matching @patterns
@@ -19,6 +23,25 @@ module I18n
         pattern_re = compile_start_with_re patterns.select { |p| p.end_with?('.') }
         (keys - patterns).reject { |k| k =~ pattern_re }
       end
+
+      # type: missing, eq_base, unused
+      def ignore_pattern(type, locale = nil)
+        ((@ignore_patterns ||= HashWithIndifferentAccess.new)[type] ||= {})[locale] = begin
+          global      = config[:ignore] || []
+          type_ignore = config["ignore_#{type}"] || []
+          if type_ignore.is_a?(Array)
+            compile_start_with_re global + type_ignore
+          elsif type_ignore.is_a?(Hash)
+            p = global + (type_ignore[:all] || [])
+            type_ignore.each { |key, value| p += (value || []) if key.to_s =~ /\b#{locale}\b/ } if locale
+            compile_start_with_re p
+          end
+        end
+      end
+
+      def config
+        I18n::Tasks.config
+      end
     end
   end
 end

data/lib/i18n/tasks/unused.rb

@@ -16,7 +16,7 @@ module I18n
       def find_unused
         used_keys = find_source_keys.to_set
         r = []
-        ignore_re = compile_start_with_re ignore_patterns
+        ignore_re = ignore_pattern(:unused)
         pattern_re = compile_start_with_re find_source_pattern_prefixes
         traverse base[base_locale] do |key, value|
           unless used_keys.include?(key) || key =~ pattern_re || key =~ ignore_re

data/lib/i18n/tasks/version.rb

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

data/lib/tasks/i18n-tasks.rake

@@ -13,6 +13,10 @@ namespace :i18n do
 
   desc 'show keys with translation values identical to base'
   task :missing => :environment do
+    if File.exists?('.i18nignore')
+      STDERR.puts "!!!! Looks like you are using .i18ignore. It is no longer used in favour of config/i18n-tasks.yml.\n
+            See README.md https://github.com/glebm/i18n-tasks"
+    end
     I18n::Tasks::Missing.new.perform
   end
 

data/spec/i18n_tasks_spec.rb

@@ -32,8 +32,11 @@ describe 'rake i18n' do
           'hash_pattern'  => {'a' => v},
           'hash_pattern2' => {'a' => v},
           'unused'        => {'a' => v},
+          'ignore_unused' => {'a' => v},
           'missing_in_es' => {'a' => v},
           'same_in_es'    => {'a' => v},
+          'ignore_eq_base_all' => {'a' => v},
+          'ignore_eq_base_es' => {'a' => v},
           'blank_in_es'   => {'a' => v},
           'relative'      => {'index' => {'title' => v}}
 
@@ -47,22 +50,43 @@ describe 'rake i18n' do
     es_data                     = gen_data.('ES_TEXT').except('missing_in_es')
     es_data['same_in_es']['a']  = 'EN_TEXT'
     es_data['blank_in_es']['a'] = ''
+    es_data['ignore_eq_base_all']['a'] = 'EN_TEXT'
+    es_data['ignore_eq_base_es']['a']  = 'EN_TEXT'
 
     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
+        'config/i18n-tasks.yml' => <<-YML,
+# do not report these keys as missing:
+ignore_missing:
+  - ignored_missing_key.a # one key to ignore
+  - ignored_pattern.      # ignore the whole pattern
 
-                  ignored_pattern.      # ignore the whole pattern
-        TEXT
+# do not report these keys when they have the same value as the base locale version
+ignore_eq_base:
+  all:
+    - ignore_eq_base_all.a
+  es:
+    - ignore_eq_base_es.a
+
+# do not report these keys as unused
+ignore_unused:
+  - ignore_unused.a
+
+# do not report these keys ever
+ignore:
+  - ignore.a
+YML
         '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 'ignore.a'
                 p = t 'ignored_pattern.some_key'
+                p = t 'ignore_eq_base_all.a'
+                p = t 'ignore_eq_base_es.a'
         SLIM
         'app/views/relative/index.html.slim' => <<-SLIM,
                 p = t '.title'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -102,8 +102,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .ruby-gemset
-- .ruby-version
 - .travis.yml
 - Gemfile
 - LICENSE.txt
@@ -146,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Rails I18n tasks to find missing / unused translations and more

data/.ruby-gemset

@@ -1 +0,0 @@
-i18n-tasks

data/.ruby-version

@@ -1 +0,0 @@
-2.0.0-p195