i18n_lookup 0.2.0 → 0.3.0

data/{i18n_lookup.rb → lib/i18n_lookup.rb}

@@ -5,6 +5,8 @@ $logger = Logger.new(STDOUT)
 
 # if ENV['I18N_DEBUG'] is set to true, all keys are printed on console
 module I18nLookup
+  require 'i18n_lookup/railtie' if defined?(Rails)
+
   protected
 
   def lookup(locale, key, scope = [], options = {})

data/lib/i18n_lookup/railtie.rb

@@ -0,0 +1,13 @@
+require 'i18n_lookup'
+require 'rails'
+
+module I18nLookup
+  class Railtie < Rails::Railtie
+    railtie_name :i18n_lookup
+
+    rake_tasks do
+      load "tasks/i18n_normalize.rake"
+      load "tasks/i18n_missing_keys.rake"
+    end
+  end
+end

data/lib/tasks/i18n_missing_keys.rake

@@ -0,0 +1,116 @@
+namespace :i18n do
+  desc "Find and list translation keys that do not exist in all locales"
+  task :missing_keys => :environment do
+    finder = MissingKeysFinder.new(I18n.backend)
+    finder.find_missing_keys
+  end
+end
+
+
+class MissingKeysFinder
+
+  def initialize(backend)
+    @backend = backend
+    self.load_config
+    self.load_translations
+  end
+
+  # Returns an array with all keys from all locales
+  def all_keys
+    I18n.backend.send(:translations).collect do |check_locale, translations|
+      collect_keys([], translations).sort
+    end.flatten.uniq
+  end
+
+  def find_missing_keys
+    output_available_locales
+    output_unique_key_stats(all_keys)
+
+    missing_keys = {}
+    all_keys.each do |key|
+
+      I18n.available_locales.each do |locale|
+
+        skip = false
+        ls = locale.to_s
+        if !@yaml[ls].nil?
+          @yaml[ls].each do |re|
+            if key.match(re)
+              skip = true
+              break
+            end
+          end
+        end
+
+        if !key_exists?(key, locale) && skip == false
+          if missing_keys[key]
+            missing_keys[key] << locale
+          else
+            missing_keys[key] = [locale]
+          end
+        end
+      end
+    end
+
+    output_missing_keys(missing_keys)
+    return missing_keys
+  end
+
+  def output_available_locales
+    puts "#{I18n.available_locales.size} #{I18n.available_locales.size == 1 ? 'locale' : 'locales'} available: #{I18n.available_locales.join(', ')}"
+  end
+
+  def output_missing_keys(missing_keys)
+    puts "#{missing_keys.size} #{missing_keys.size == 1 ? 'key is missing' : 'keys are missing'} from one or more locales:"
+    missing_keys.keys.sort.each do |key|
+      puts %|'\e[1;33m#{key}\e[0;0m': Missing from #{missing_keys[key].collect(&:inspect).join(', ')}; Value: '\e[1;34m#{I18n.t(key, :locale => :en)}\e[0;0m'|
+    end
+  end
+
+  def output_unique_key_stats(keys)
+    number_of_keys = keys.size
+    puts "#{number_of_keys} #{number_of_keys == 1 ? 'unique key' : 'unique keys'} found."
+  end
+
+  def collect_keys(scope, translations)
+    full_keys = []
+    translations.to_a.each do |key, translations|
+      next if translations.nil?
+
+      new_scope = scope.dup << key
+      if translations.is_a?(Hash)
+        full_keys += collect_keys(new_scope, translations)
+      else
+        full_keys << new_scope.join('.')
+      end
+    end
+    return full_keys
+  end
+
+  # Returns true if key exists in the given locale
+  def key_exists?(key, locale)
+    I18n.locale = locale
+    I18n.translate(key, :raise => true)
+    return true
+  rescue I18n::MissingInterpolationArgument
+    return true
+  rescue I18n::MissingTranslationData
+    return false
+  end
+
+  def load_translations
+    # Make sure we’ve loaded the translations
+    I18n.backend.send(:init_translations)
+  end
+
+  def load_config
+    @yaml = {}
+    begin
+      @yaml = YAML.load_file(File.join(Rails.root, 'config', 'ignore_missing_keys.yml'))
+    rescue => e
+      STDERR.puts "No ignore_missing_keys.yml config file."
+    end
+
+  end
+
+end

data/lib/tasks/i18n_normalize.rake

@@ -0,0 +1,100 @@
+# -*- coding: utf-8 -*-
+namespace :i18n do
+  desc 'Writes current default locale translations to a normalized file and deletes unused locale files'
+  task :normalize => :environment do
+    class Hash
+      def to_hash_recursive
+        result = self.to_hash
+
+        result.each do |key, value|
+          case value
+          when Hash
+            result[key] = value.to_hash_recursive
+          when Array
+            result[key] = value.to_hash_recursive
+          end
+        end
+
+        result
+      end
+
+      def sort_by_key(recursive=false, &block)
+        self.keys.sort(&block).reduce({}) do |seed, key|
+          seed[key] = self[key]
+          if recursive && seed[key].is_a?(Hash)
+            seed[key] = seed[key].sort_by_key(true, &block)
+          end
+          seed
+        end
+      end
+    end
+
+    class Array
+      def to_hash_recursive
+        result = self
+
+        result.each_with_index do |value,i|
+          case value
+          when Hash
+            result[i] = value.to_hash_recursive
+          when Array
+            result[i] = value.to_hash_recursive
+          end
+        end
+
+        result
+      end
+    end
+
+    def current_i18n_yaml(locale)
+      default_locale_translations = I18n.backend.send(:translations)[locale].with_indifferent_access.to_hash_recursive
+      i18n_yaml = {locale.to_s => default_locale_translations}.sort_by_key(true).to_yaml
+      process = i18n_yaml.split(/\n/).reject{|e| e == ''}[1..-1]  # remove "---" from first line in yaml
+
+      # add an empty line if yaml tree level changes by 2 or more
+      tmp_ary = []
+      process.each_with_index do |line, idx|
+        tmp_ary << line
+        unless process[idx+1].nil?
+          this_line_spcs = line.match(/\A\s*/)[0].length
+          next_line_spcs = process[idx+1].match(/\A\s*/)[0].length
+          tmp_ary << '' if next_line_spcs - this_line_spcs < -2
+        end
+      end
+
+      tmp_ary * "\n"
+    end
+
+    generated_locale_yaml = {}
+
+    I18n.backend.send(:translations).keys.each do |locale|
+      generated_locale_yaml[locale] = current_i18n_yaml(locale)
+    end
+
+    # delete unused locale files
+    repo_root = %x(git rev-parse --show-toplevel).strip
+    repo_locales = I18n.load_path.dup.keep_if{|p| p.include?(repo_root)}
+    repo_locales.each do |locale_file|
+      FileUtils.rm locale_file
+      puts "removed \"#{locale_file}\""
+    end
+
+    # write normalized locale to file
+    generated_locale_yaml.keys.each do |locale|
+      fn = File.join Rails.root, 'config', 'locales', locale.to_s + '.yml'
+      f_size_before = File.exists?(fn) ? File.size(fn) : 0
+
+      File.open(fn, 'w') { |file| file.puts generated_locale_yaml[locale]}
+      f_size_after = File.size fn
+      puts "\n(re)generated #{fn}\n"
+
+      if f_size_before == 0
+        puts "\"#{fn}\" created, file size: #{f_size_after} bytes.\n"
+      elsif f_size_before != f_size_after
+        puts "\"#{fn}\" changed from #{f_size_before} to #{f_size_after} bytes.\n"
+      else
+        puts "\"#{fn}\" is still #{f_size_after} bytes.\n"
+      end
+    end
+  end
+end

metadata

@@ -2,14 +2,14 @@
 name: i18n_lookup
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Thomas Metzmacher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 2014-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -91,21 +91,24 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.0.2
   prerelease: false
-description: Prints out the I18n calls
+description: A toolset for I18n handling
 email: kontakt@thomet.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- i18n_lookup.rb
-- i18n_lookup_spec.rb
+- lib/i18n_lookup/railtie.rb
+- lib/i18n_lookup.rb
+- lib/tasks/i18n_missing_keys.rake
+- lib/tasks/i18n_normalize.rake
+- spec/i18n_lookup_spec.rb
 homepage: http://www.thomet.de/
 licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
-- .
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -125,5 +128,5 @@ signing_key:
 specification_version: 3
 summary: I18n Lookup
 test_files:
-- i18n_lookup_spec.rb
+- spec/i18n_lookup_spec.rb
 has_rdoc: