i18n-verify 0.0.1 → 0.0.2

data/lib/i18n-verify/railtie.rb

@@ -0,0 +1,11 @@
+require 'i18n_verify'
+require 'rails'
+module I18nVerify
+  class Railtie < Rails::Railtie
+    railtie_name :i18n_verify
+
+    rake_tasks do
+      load "tasks/i18n_verify.rake"
+    end
+  end
+end

data/lib/i18n_verify.rb

@@ -0,0 +1,111 @@
+# the user interface is in rake tasks 
+# for more info see lib/tasks/i18n-verify.rake
+
+module I18nVerfiy
+
+  require 'i18n-verify/railtie' if defined?(Rails)
+
+  class Checker
+    def initialize(filenames = )
+      @translations = load_files(filenames)
+    end
+    
+    def find_key(match=Regexp,new(''), group_by_filename=false)
+      # select translations with matching keys
+      matching_translations = @translations.select {|t| [t[:locale],t[:key]].join('.') =~ regexp}
+
+      # print matching translations
+      if group_by_filename
+        matching_translations.group_by {|t| t[:filename]}.each_pair do |filename, translations|
+          puts "#{filename}:"
+          translations.each do |t|
+            puts " #{[t[:locale],t[:key]].join('.')}: #{t[:translation]}\n"
+          end
+        end
+      else
+        matching_translations.each do |t|
+          puts "#{t[:filename]} # #{[t[:locale],t[:key]].join('.')}: #{t[:translation]}\n"
+        end
+      end
+    end
+    
+    def is_complete?(locales_requested = [])      
+      # check each pair of locales
+      #   if the first one has keys the second one doesn't => these are the incomplete translations
+      locales = @translations.collect{|tr| tr[:locale]}.uniq
+      locales_to_check = locales_requested.empty? ? locales : (locales & locales_requested)
+
+      puts "Checking locales #{locales_to_check.inspect} out of #{locales.inspect} for completeness"
+      locales_to_check.permutation.each do |first, second|
+        first_translations = @translations.select {|translation| translation[:locale] == first}
+        second_translations = @translations.select {|translation| translation[:locale] == second}
+
+        differences = first_translations.select {|f| f if second_translations.none? {|s| f[:key]==s[:key]} }.compact
+        if differences.empty?
+          puts "#{first} => #{second}: complete\n"
+        else
+          puts "Missing from #{second} vs. #{first}:\n"
+          differences.each do |difference|
+            puts " " + [difference[:locale], difference[:key]].join('.') + " defined for #{first} in #{difference[:filename]}\n"
+          end
+        end
+      end
+    end
+    
+    def duplicates(locales_requested = [])
+      locales = @translations.collect{|tr| tr[:locale]}.uniq
+      locales_to_check = locales_requested.empty? ? locales : (locales & locales_requested)
+
+      puts "Checking locales #{locales_to_check.inspect} out of #{locales.inspect} for redundancy"
+
+      # collect and print duplicate translations
+      locales_to_check.each do |locale|
+        puts "#{locale}:"
+        translations_by_key = @translations.select {|t| t[:locale] == locale}.uniq.group_by {|t| t[:key]}
+        translations_by_key.reject {|t| t[1].count == 1}.each_pair do |key, translations|
+          puts " #{key}: #{translations.collect{|t| t[:filename]}.join(", ")}"
+        end
+      end
+    end
+    
+    protected
+    # convert translations hash to flat keys
+    # i.e. from { :de => {:new => neue, :old => alt} } to [ ['de.new', 'neue'], ['de.old', 'alte'] ]
+    # and yields a flat key and the value to the block
+    def flatten_keys(hash, prev_key=nil, &block)
+      hash.each_pair do |key, value|
+        curr_key = [prev_key, key].compact.join('.')
+        if value.is_a?(Hash)
+          flatten_keys(value, curr_key, &block)
+        else
+          yield curr_key, value
+        end
+      end
+    end
+
+    # read files and store translations (similar to i18n's internals but include filenames)
+    def load_files(filenames)
+      translations = []
+      filenames.each do |filename|
+        type = File.extname(filename).tr('.', '').downcase.to_sym
+        case type
+          when :rb
+            data = eval IO.read(filename) # , binding, filename)
+          when :yml
+            data = YAML.load_file(filename)
+          else
+            raise I18n::UnknownFileType.new(type, filename)
+        end
+        raise I18n::InvalidLocaleData.new(filename) unless data.is_a?(Hash)
+        data.each_pair do |locale, d|
+          flatten_keys(d || {}) do |flat_key, translation|
+            translations.push({ :filename => filename, :locale => locale.to_s, :key => flat_key, :translation => translation })
+          end
+        end
+      end
+      translations
+    end
+    
+  end
+  
+end

data/lib/tasks/i18_verify.rake

@@ -0,0 +1,97 @@
+namespace :i18n do
+
+  #
+  # find_key helps to find where certain (partial) keys have translations
+  #
+  # the first parameter is a regexp to look for (beware of period separators!)
+  # the second parameter is a flag if results are to be grouped by file
+  #   (the default is one match per line with filename included)
+  #
+  # Examples:
+  #   rake find_key[/models/]
+  #   rake find_key[/\.models\.attributes/,true]
+  #
+  desc "Find translation keys matching a regexp"
+  task :find_key, :regexp, :group_by_filename do |t, args|
+    require "#{::Rails.root.to_s}/config/environment.rb"
+    regexp = Regexp.new(args[:regexp] || "")
+    group_by_filename = args[:group_by_filename]
+    checker = I18nVerify:Checker.new(I18n.config.load_path)
+    checker.find_key(regexp,group_by_filename)
+  end
+
+  #
+  # is_complete helps in checking if all translations are set up in all directions
+  # that is: verifies there are no missing keys in any of the trasnlations
+  #
+  # is_complete takes a command line rake param: the list of locales to check (all pairs)
+  #   omit for all
+  #
+  # Examples:
+  #   rake i18n:is_complete
+  #   rake i18n:is_complete locales=en,de
+  #
+  desc "Checks if translations are complete or there are missing ones"
+  task :is_complete do |t, args|
+    require "#{::Rails.root.to_s}/config/environment.rb"
+    translations = load_files( I18n.config.load_path )
+    locales_requested = ENV['locales'].downcase.split(',')
+    checker = I18nVerify:Checker.new(I18n.config.load_path)
+    checker.is_complete?(locales_requested)
+  end
+
+  #
+  # duplicates helps in finding keys with multiple translations to the same locale
+  #
+  # redundancies takes a command line rake param: the list of locales to check
+  #   omit for all
+  #
+  # Examples:
+  #   rake i18n:duplicates
+  #   rake i18n:duplicates locales=en,de
+  #
+  desc "Checks if any keys are translated multiple times"
+  task :duplicates do |t, args|
+    require "#{::Rails.root.to_s}/config/environment.rb"
+    translations = load_files( I18n.config.load_path )
+    locales_requested = ENV['locales'].downcase.split(',')
+    checker = I18nVerify:Checker.new(I18n.config.load_path)
+    checker.duplicates?(locales_requested)
+  end
+
+=begin
+  # TODO: write method
+  desc "Checks translations spellings"
+  task :spelling do |t, args|
+  end
+=end
+
+  desc "Run all checks"
+  task :verify => [:is_complete, :duplicates] do
+  end
+
+end
+
+#
+# BONUS :)
+#
+namespace :yaml do
+  desc "Finds keys in yaml files; regexp to match keys; command line: rake yaml:find[config/locales/**/*.yml,/\.models\./]"
+  task :find, :filename_pattern, :regexp, :group_by_filename do |t, args|
+    filenames = Dir[args[:filename_pattern] || Rails.root.join('**', '*.{yaml,yml}').to_s]
+    regexp = Regexp.new(args[:regexp] || "")
+    group_by_filename = args[:group_by_filename]
+
+    filenames.each do |filename|
+      print filename + ":\n" if group_by_filename
+
+      File.open( filename ) do |infile|
+        yaml_hash = YAML::parse(infile).transform
+        flatten_keys( yaml_hash ) do |key, value|
+          puts "#{group_by_filename ? '' : (filename + ' #')} #{key}: #{value}\n" if key =~ regexp
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: i18n-verify
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - fastcatch
@@ -28,6 +28,9 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/i18n-verify/railtie.rb
+- lib/i18n_verify.rb
+- lib/tasks/i18_verify.rake
 - LICENSE.txt
 - README.markdown
 has_rdoc: true