i18n-verify 0.0.3 → 0.0.4

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/Gemfile.lock

@@ -0,0 +1,13 @@
+PATH
+  remote: .
+  specs:
+    i18n-verify (0.0.4)
+
+GEM
+  specs:
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  i18n-verify!

data/{README.markdown → README.md}

@@ -6,13 +6,15 @@ This is a set of tools that make your life easier if you have lots of translatio
 Installation
 ============
 
-You normally would want to install this gem as stand-alons (i.e. not throu environment.rb / Gemfile) because it is not to be called from the application but as a command line utility.
+To use the utils in Rails 2.x, add to your `environment.rb`:
 
-Install it by:
+    config.gem "i18n-verify"
 
-    gem install i18n-verify
-    
-If you do want to include it in your environment.rb or Gemfile just insert the standard line (perhaps in the :development group in Gemfile; and don't forget to run `bundle install`.
+If using Rails 3.x, add to your Gemfile (perhaps in the :development group)
+
+    gem "i18n-verify"
+
+and run 'bundle install'.
 
 Usage
 =====

data/Rakefile

@@ -0,0 +1,31 @@
+begin
+  require "bundler"
+  Bundler.setup
+rescue LoadError
+  $stderr.puts "You need to have Bundler installed to be able build this gem."
+end
+
+gemspec = eval(File.read(Dir["*.gemspec"].first))
+
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc "Build gem locally"
+task :build => :gemspec do
+  system "gem build #{gemspec.name}.gemspec"
+  FileUtils.mkdir_p "pkg"
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", "pkg"
+end
+
+desc "Install gem locally"
+task :install => :build do
+  system "gem install pkg/#{gemspec.name}-#{gemspec.version}"
+end
+
+desc "Clean automatically generated files"
+task :clean do
+  FileUtils.rm_rf "pkg"
+end

data/i18n-verify.gemspec

@@ -0,0 +1,31 @@
+# coding: UTF-8
+
+Gem::Specification.new do |s|
+  s.name              = "i18n-verify"
+  s.homepage          = "http://github.com/fastcatch/i18n-verify"
+  s.version           = "0.0.4"
+  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}
+  s.email             = "axz10@cwru.edu"
+  s.authors           = ["fastcatch"]
+  # s.rubyforge_project = s.name
+
+  # s.required_rubygems_version = ">= 1.3.6"
+  
+  # If you have runtime dependencies, add them here
+  # s.add_runtime_dependency "other", "~> 1.2"
+  
+  # If you have development dependencies, add them here
+  # s.add_development_dependency "another", "= 0.9"
+
+  # The list of files to be contained in the gem
+  s.files         = `git ls-files`.split("\n")
+  # s.executables   = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  # s.extensions    = `git ls-files ext/extconf.rb`.split("\n")
+  
+  s.require_path = 'lib'
+
+  # For C extensions
+  # s.extensions = "ext/extconf.rb"
+end

data/lib/i18n-verify/railtie.rb

@@ -0,0 +1,7 @@
+module I18nVerify
+  class I18nVerifyRailtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/verify.rake"
+    end
+  end
+end

data/lib/i18n-verify/support.rb

@@ -0,0 +1,109 @@
+module I18nVerify
+  class Checker
+    def initialize(filenames)
+      @translations = load_files(filenames)
+    end
+    
+    def find_key(regexp=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)
+
+      if locales_to_check.size <= 1
+        puts "Need at least two locales; found #{locales_to_check.size}: #{locales_to_check.join(',')}"
+      else
+        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
+    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|
+        # 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 })
+          end
+        end
+      end
+      translations
+    end
+    
+  end
+end

data/lib/i18n-verify.rb

@@ -0,0 +1,2 @@
+require 'i18n-verify/railtie' # if defined?(Rails)
+require 'i18n-verify/support'

data/lib/tasks/verify.rake

@@ -16,7 +16,7 @@ namespace :i18n do
     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 = I18nVerify::Checker.new(I18n.config.load_path)
     checker.find_key(regexp,group_by_filename)
   end
 
@@ -34,9 +34,8 @@ namespace :i18n do
   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)
+    locales_requested = (ENV['locales'] || "").downcase.split(',')
+    checker = I18nVerify::Checker.new(I18n.config.load_path)
     checker.is_complete?(locales_requested)
   end
 
@@ -53,10 +52,9 @@ namespace :i18n do
   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)
+    locales_requested = (ENV['locales'] || "").downcase.split(',')
+    checker = I18nVerify::Checker.new(I18n.config.load_path)
+    checker.duplicates(locales_requested)
   end
 
 =begin

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: i18n-verify
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - fastcatch
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-11 00:00:00 +02:00
+date: 2011-07-19 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -28,15 +28,21 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- i18n-verify.gemspec
+- lib/i18n-verify.rb
+- lib/i18n-verify/railtie.rb
+- lib/i18n-verify/support.rb
 - lib/tasks/verify.rake
-- lib/verify/railtie.rb
-- lib/verify.rb
-- LICENSE.txt
-- README.markdown
 has_rdoc: true
 homepage: http://github.com/fastcatch/i18n-verify
-licenses: 
-- MIT
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 

data/lib/verify/railtie.rb

@@ -1,9 +0,0 @@
-require 'verify'
-
-module Verify
-  class VerifyRailtie < Rails::Railtie
-    rake_tasks do
-      load "tasks/verify.rake"
-    end
-  end
-end

data/lib/verify.rb

@@ -1,2 +0,0 @@
-puts "Loading verify..."
-require 'verify/railtie' if defined?(Rails)