i18n-validator 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in i18n-validator.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/i18n-validate

@@ -0,0 +1,5 @@
+require 'i18n-validator'
+
+I18n::Validator::missing_locales(Dir[File.join(".", "config", "locales", "*")]).each do |key, missing_locales|
+  puts "- #{key} is missing in locale#{missing_locales.length == 1 ? "" : "s"} #{missing_locales.join(", ").gsub(/\, ([^\,]*)$/, " and \\1")}"
+end

data/i18n-validator.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "i18n-validator/version"
+
+Gem::Specification.new do |s|
+  s.name        = "i18n-validator"
+  s.version     = I18n::Validator::VERSION
+  s.authors     = ["Rene van Lieshout"]
+  s.email       = ["rene@bluerail.nl"]
+  s.homepage    = "http://www.bluerail.nl"
+  s.summary     = %q{I18n completeness validator}
+  s.description = %q{Validats your I18n completness}
+
+  s.rubyforge_project = "i18n-validator"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "i18n"
+  s.add_development_dependency "rspec"
+end

data/lib/i18n-validator.rb

@@ -0,0 +1,113 @@
+require "i18n"
+require "i18n-validator/version"
+
+module I18n
+  module Validator
+    #
+    # Presents a list of missing locale entries
+    #
+    def self.missing_locales(path)
+      I18n.load_path << path
+
+      # Fetch all keys per locale
+      keys_per_locale = Hash[I18n.available_locales.map{ |locale|
+        [
+          locale,
+          I18n.translate('.', :locale => locale).map{ |key, value|
+            self.convert_key_value_hash_to_array(key, value)
+          }.flatten.sort
+        ]
+      }]
+
+      if keys_per_locale.length <= 1
+        # there couldn't be any missing locales
+        # when we only have 1 locale...
+        []
+      else
+        # Remap Hash to use values as keys
+        locales_per_key = self.invert_key_value_hash(keys_per_locale)
+        available_locales_length = I18n.available_locales.length
+        locales_per_key.reject{ |key, locales|
+          locales.length == available_locales_length
+        }.sort{ |a,b|
+          a[0] <=> b[0]
+        }.map{ |key, locales|
+          [key, (I18n.available_locales - locales).sort{ |a,b| a.to_s <=> b.to_s }]
+        }
+      end
+    end
+
+    private
+
+    #
+    # Converts a key-value(s) Hash to a Hash with
+    # I18n-alike strings, such as:
+    #
+    # Input:
+    #
+    # en:
+    #   user:
+    #     edit:
+    #       title: Edit user details
+    #       submit_button: Save
+    # nl:
+    #   user:
+    #     edit:
+    #       title: Gebruikersgegevens bewerken
+    #
+    # Output:
+    #
+    # :en => [
+    #   "user.edit.title",
+    #   "user.edit.submit_button"
+    # ]
+    # :nl => [
+    #   "user.edit.title"
+    # ]
+    #
+    def self.convert_key_value_hash_to_array(key, value, parent_label = "")
+      if value.is_a?(Hash)
+        value.map do |subkey, subvalue|
+          convert_key_value_hash_to_array(subkey, subvalue, "#{parent_label}#{key}.")
+        end
+      else
+        "#{parent_label}#{key}"
+      end
+    end
+
+    #
+    # Remaps an Hash to use the key as value and vice versa
+    #
+    # A value which is available in multiple keys would result
+    # in a key with multiple values
+    #
+    # Example input:
+    #
+    # :en => [
+    #   "user.edit.title",
+    #   "user.edit.submit_button"
+    # ]
+    # :nl => [
+    #   "user.edit.title"
+    # ]
+    #
+    # Result:
+    #
+    # [
+    #   "user.edit.title" => [:en, :nl],
+    #   "user.edit.submit_button" => [:en]
+    # ] 
+    #
+    def self.invert_key_value_hash(keys_per_locale)
+      keys_per_locale.invert.map{ |keys, locale|
+        Hash[keys.map{ |key|
+          [key, [locale]]
+        }]
+      }.reduce{ |keys_per_locale_1, keys_per_locale_2|
+        keys_per_locale_1.merge!(keys_per_locale_2){ |key, locale_1, locale_2|
+          locale_1 + locale_2
+        }
+      }
+    end
+  end
+end

data/lib/i18n-validator/version.rb

@@ -0,0 +1,5 @@
+module I18n
+  module Validator
+    VERSION = "0.0.1"
+  end
+end

data/spec/fixtures/locales/de.yml

@@ -0,0 +1,5 @@
+de:
+  foo:
+    bar:
+      baz: Baz!
+  

data/spec/fixtures/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  foo:
+    bar:
+      baz: Baz!
+  hello:
+    world: Hello World!
+  

data/spec/fixtures/locales/nl.yml

@@ -0,0 +1,8 @@
+nl:
+  foo:
+    bar:
+      baz: Baz!
+  hello:
+    world: Hello World!
+    kitty: Hello Kitty
+

data/spec/i18n_validator_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'pp'
+
+describe I18n::Validator do
+  it "should find missing locales" do
+    missing_locales = I18n::Validator::missing_locales(Dir[File.join(File.dirname(__FILE__), "fixtures", "locales", "*")])
+
+    missing_locales.should eql([
+      ["hello.kitty", [:de, :en]],
+      ["hello.world", [:de]]
+    ])
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'i18n-validator'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: i18n-validator
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rene van Lieshout
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Validats your I18n completness
+email: 
+- rene@bluerail.nl
+executables: 
+- i18n-validate
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- bin/i18n-validate
+- i18n-validator.gemspec
+- lib/i18n-validator.rb
+- lib/i18n-validator/version.rb
+- spec/fixtures/locales/de.yml
+- spec/fixtures/locales/en.yml
+- spec/fixtures/locales/nl.yml
+- spec/i18n_validator_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.bluerail.nl
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: i18n-validator
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: I18n completeness validator
+test_files: 
+- spec/fixtures/locales/de.yml
+- spec/fixtures/locales/en.yml
+- spec/fixtures/locales/nl.yml
+- spec/i18n_validator_spec.rb
+- spec/spec_helper.rb