i18n-verify 0.0.4 → 0.0.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    i18n-verify (0.0.4)
+    i18n-verify (0.0.5)
 
 GEM
   specs:

data/README.md

@@ -24,6 +24,7 @@ i18n-verify is a set of rake tasks:
 * `rake i18n:find_key` for finding keys
 * `rake i18n:is_complete` for checking if translations are complete
 * `rake i18n:duplicates` for finding keys with more than one translation for any given locale
+* `rake i18n:spell` for checking translation misspellings
 
 All of them will automatically pick up translation files configured for i18n (both yml and rb).
 
@@ -73,11 +74,27 @@ Examples:
 * `rake i18n:duplicates`
 * `rake i18n:duplicates locales=en`
 
+i18n:spell
+----------
+
+It checks for translation misspellings.
+
+    rake i18n:spell [locales=<list>]
+
+`locales` defaults to all and should be a comma separated list with no spaces.
+
+Please note that spelling requires aspell to be installed with all the dictionaries spelling is requested for.
+
+Examples:
+
+* `rake i18n:spell`
+* `rake i18n:spell locales=en,fr`
+
 To do
 =====
 
-* Add spell checking support
 * Write tests (tests for rake tasks, that is!)
+* More intelligent handling of spelling errors with a dictionary for accepted exceptions
 * ...
 
 Contributing to i18n-verify
@@ -94,4 +111,4 @@ Contributing to i18n-verify
 Copyright
 =========
 
-Copyright (c) 2011 fastcatch. See LICENSE.txt for further details.
+Copyright (c) 2011 fastcatch. See the LICENSE file for further details.

data/Rakefile

@@ -29,3 +29,8 @@ desc "Clean automatically generated files"
 task :clean do
   FileUtils.rm_rf "pkg"
 end
+
+desc "Push to rubygems"
+task :push do
+  system "gem push pkg/#{gemspec.name}-#{gemspec.version}.gem"
+end

data/i18n-verify.gemspec

@@ -3,7 +3,7 @@
 Gem::Specification.new do |s|
   s.name              = "i18n-verify"
   s.homepage          = "http://github.com/fastcatch/i18n-verify"
-  s.version           = "0.0.4"
+  s.version           = "0.0.5"
   s.platform          = Gem::Platform::RUBY
   s.summary           = %Q{Tools to verify your Ruby on Rails localizations}
   s.description       = %Q{It helps you find keys, undefined translations, duplicate keys, and more}

data/lib/i18n-verify/support.rb

@@ -1,7 +1,57 @@
 module I18nVerify
+
+  class Translations < Array
+    def initialize(filenames)
+    # read files and store translations (similar to i18n's internals but include filenames)
+      filenames.each do |filename|
+        # puts "Loading: #{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|
+            self.push({ :filename => filename, :locale => locale.to_s, :key => flat_key, :translation => translation })
+          end
+        end
+      end
+    end
+    
+    def select(*args, &block)
+      if block_given?
+        super &block
+      else
+        options = args.extract_options!
+        super {|h| options.all?{|key,value| h[key] == value} }
+      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
+    
+  end
+  
   class Checker
     def initialize(filenames)
-      @translations = load_files(filenames)
+      @translations = Translations.new(filenames)
     end
     
     def find_key(regexp=Regexp.new(''), group_by_filename=false)
@@ -66,43 +116,33 @@ module I18nVerify
       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
+    def spell(locales_requested = [])
+      locales = @translations.collect{|tr| tr[:locale]}.uniq
+      locales_to_check = locales_requested.empty? ? locales : (locales & locales_requested)
 
-    # read files and store translations (similar to i18n's internals but include filenames)
-    def load_files(filenames)
-      translations = []
-      filenames.each do |filename|
-        # puts "Loading: #{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 })
+      puts "Checking spelling in locales #{locales_to_check.inspect} out of #{locales.inspect}"
+      
+      # take each translation in turn and check spelling
+      @translations.each do |translation|
+        next unless locales_to_check.include? translation[:locale]    # skip if in a locale not to be checked
+        
+        text = translation[:translation]
+        next unless text.is_a? String     # skip if not a string (perhaps an array?)
+        text.gsub!(/%\{[^}]*\}/, "")      # remove translation params
+        
+        # make aspell check the spelling
+        result = %x[echo "#{text}" |  aspell -a --ignore-case --lang="#{translation[:locale]}" --dont-suggest]
+
+        # process result
+        # aspell returns lines in the format of '# <word> <position>' for each misspelled word
+        result.lines do |line|
+          parts = line.split(" ")
+          if parts[0]=='#'      # misspelling found
+            # print: misspelled word | file | (full) key | position
+            puts "#{parts[1]} | #{translation[:filename]} | #{[translation[:locale],translation[:key]].join('.')} | #{parts[2]}"
           end
         end
       end
-      translations
     end
     
   end

data/lib/tasks/verify.rake

@@ -1,95 +1,108 @@
-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"
-    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"
-    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
+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"
+    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
+  #
+  # duplicates 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"
+    locales_requested = (ENV['locales'] || "").downcase.split(',')
+    checker = I18nVerify::Checker.new(I18n.config.load_path)
+    checker.duplicates(locales_requested)
+  end
+
+  #
+  # spell helps checking translation spelling
+  #
+  # note: it requires aspell and the proper dictionaries installed
+  #
+  # spell takes a command line rake param: the list of locales to check
+  #   omit for all
+  #
+  # Examples:
+  #   rake i18n:spell
+  #   rake i18n:spell locales=en,de
+  #
+  desc "Checks translations for spelling errors"
+  task :spell do |t, args|
+    require "#{::Rails.root.to_s}/config/environment.rb"
+    locales_requested = (ENV['locales'] || "").downcase.split(',')
+    checker = I18nVerify::Checker.new(I18n.config.load_path)
+    checker.spell(locales_requested)
+  end
+
+  desc "Run all checks"
+  task :verify => [:is_complete, :duplicates, :spell] 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: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - fastcatch
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-19 00:00:00 +02:00
+date: 2011-07-20 00:00:00 +02:00
 default_executable: 
 dependencies: []