balinterdi-missing_t 0.1.0

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('missing_t', '0.1.0') do |p|
+  p.description    = "See all the missing I18n translations in your Rails project"
+  p.url            = "http://github.com/balinterdi/missing_t"
+  p.author         = "Balint Erdi"
+  p.email          = "balint.erdi@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/bin/missing_t

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+
+require 'missing_t'
+
+MissingT.new.find_missing_translations(ARGV[0]).each do |file, queries|
+  puts
+  puts "#{file}:"
+  puts
+  queries.each { |q| puts "    #{q}" }
+end
+
+

data/lib/missing_t.rb

@@ -0,0 +1,171 @@
+require "yaml"
+require "forwardable"
+require "pp"
+require "ruby-debug"
+
+class Hash
+  def has_nested_key?(key)
+    h = self
+    key.to_s.split('.').each do |segment|
+      return false unless h.key?(segment)
+      h = h[segment]
+    end
+    true
+  end
+
+  # idea snatched from deep_merge in Rails source code
+  def deep_safe_merge(other_hash)
+    self.merge(other_hash) do |key, oldval, newval|
+      oldval = oldval.to_hash if oldval.respond_to?(:to_hash)
+      newval = newval.to_hash if newval.respond_to?(:to_hash)
+      if oldval.class.to_s == 'Hash'
+        if newval.class.to_s == 'Hash'
+          oldval.deep_safe_merge(newval)
+        else
+          oldval
+        end
+      else
+        newval
+      end
+    end
+  end
+
+  def deep_safe_merge!(other_hash)
+    replace(deep_safe_merge(other_hash))
+  end
+
+end
+
+class MissingT
+  extend Forwardable
+  def_delegators :@translations, :[]
+
+  # attr_reader :translations
+
+  def initialize
+    @translations = Hash.new
+  end
+
+  # NOTE: this method is needed
+  # because attr_reader :translations
+  # does not seem to be stubbable
+  def translations
+    @translations
+  end
+
+  def add_translations(trs)
+    translations.deep_safe_merge!(trs)
+  end
+
+  def collect_translations
+    locales_pathes = ["config/locales/**/*.yml", "vendor/plugins/**/config/locales/**/*yml", "vendor/plugins/**/locale/**/*yml"]
+    locales_pathes.each do |path|
+      Dir.glob(path) do |file|
+        add_translations(translations_in_file(file))
+      end
+    end
+  end
+
+  def hashify(strings)
+    h = Hash.new
+    strings.map { |s| s.split('.') }.
+      each do |segmented_string|
+        root = h
+        segmented_string.each do |segment|
+          root[segment] ||= {}
+          root = root[segment]
+        end
+      end
+    h
+  end
+
+  def translations_in_file(yaml_file)
+    open(yaml_file) { |f| YAML.load(f.read) }
+  end
+
+  def files_with_i18n_queries
+    [ Dir.glob("app/**/*.erb"),
+    Dir.glob("app/**/controllers/**/*.rb"),
+    Dir.glob("app/**/helpers/**/*.rb")].flatten
+  end
+
+  def get_content_of_file_with_i18n_queries(file)
+    f = open(File.expand_path(file), "r")
+    content = f.read()
+    f.close()
+    content
+  end
+
+  def extract_i18n_queries(file)
+    i18n_query_pattern = /I18n\.(?:translate|t)\s*\((.*?)[,\)]/
+    get_content_of_file_with_i18n_queries(file).
+      scan(i18n_query_pattern).map { |match| match.first.gsub(/[^\w\.]/, '') }
+  end
+
+  def collect_translation_queries
+    queries = {}
+    files_with_i18n_queries.each do |file|
+      queries_in_file = extract_i18n_queries(file)
+      unless queries_in_file.empty?
+        queries[file] = queries_in_file
+      end
+    end
+    queries
+    #TODO: remove duplicate queries across files
+  end
+
+  def has_translation?(lang, query)
+    t = translations
+    i18n_label(lang, query).split('.').each do |segment|
+      return false unless (t.respond_to?(:key?) and t.key?(segment))
+      t = t[segment]
+    end
+    true
+  end
+
+  def get_missing_translations(queries, lang=nil)
+    missing = {}
+    languages = lang.nil? ? translations.keys : [lang]
+    languages.each do |l|
+      get_missing_translations_for_lang(queries, l).each do |file, qs|
+        missing[file] ||= []
+        missing[file].concat(qs).uniq!
+      end
+    end
+    missing
+  end
+
+  def find_missing_translations(lang=nil)
+    collect_translations
+    get_missing_translations(collect_translation_queries, lang)
+  end
+
+  private
+    def get_missing_translations_for_lang(queries, lang)
+      queries.map do |file, queries_in_file|
+        queries_with_no_translation = queries_in_file.select { |q| !has_translation?(lang, q) }
+        if queries_with_no_translation.empty?
+          nil
+        else
+          [file, queries_with_no_translation.map { |q| i18n_label(lang, q) }]
+        end
+      end.compact
+
+    end
+
+    def i18n_label(lang, query)
+      "#{lang}.#{query}"
+    end
+
+end
+
+if __FILE__ == $0
+  # puts "ARGV[1] = #{ARGV[0]}"
+  # pp MissingT.new.find_missing_translations(ARGV[0]).values.inject(0) { |sum, qs| sum + qs.length }
+  MissingT.new.find_missing_translations(ARGV[0]).each do |file, queries|
+    puts
+    puts "#{file}:"
+    puts
+    queries.each { |q| puts "    #{q}" }
+  end
+end

data/missing_t.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{missing_t}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Balint Erdi"]
+  s.date = %q{2009-03-03}
+  s.default_executable = %q{missing_t}
+  s.description = %q{See all the missing I18n translations in your Rails project}
+  s.email = %q{balint.erdi@gmail.com}
+  s.executables = ["missing_t"]
+  s.extra_rdoc_files = ["bin/missing_t", "lib/missing_t.rb", "README.rdoc", "tasks/missing_t.rake"]
+  s.files = ["bin/missing_t", "lib/missing_t.rb", "Manifest", "Rakefile", "README.rdoc", "spec/missing_t_spec.rb", "spec/spec_helper.rb", "tasks/missing_t.rake", "missing_t.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/balinterdi/missing_t}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Missing_t", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{missing_t}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{See all the missing I18n translations in your Rails project}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/missing_t_spec.rb

@@ -0,0 +1,140 @@
+require "rubygems"
+require "ruby-debug"
+require "spec"
+require "mocha"
+require "pp"
+
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe "MissingT" do
+  before do
+    @missing_t = MissingT.new
+    @es_translations =  {"es"=>
+      {"zoo"=>{"elephant"=>"elefante", "bear"=>"oso", "lion"=>"leon", "bee" => "abeja"},
+       "lamp"=>"lampa",
+       "book"=>"libro",
+       "handkerchief"=>"panuelo",
+       "pen" => "boli"}}
+    @fr_translations =  {"fr"=>
+      {"zoo"=>{"elephant"=>"elephant", "bear"=>"ours", "lion"=>"lion", "wasp" => "guepe"},
+       "lamp"=>"lampe",
+       "book"=>"livre",
+       "handkerchief"=>"mouchoir",
+       "mother" => "mere"}}
+
+    @other_es_translations = { "es" => {"zoo" => {}}}
+    @yet_other_es_translations = { "es" => {"zoo" => {"monkey" => "mono", "horse" => "caballo"}}}
+  end
+
+  describe "adding translations" do
+    before do
+      @missing_t.add_translations(@es_translations)
+    end
+
+    it "should pick up the new translations" do
+      @missing_t.translations.should == @es_translations
+    end
+
+    it "should correctly merge different translations" do
+      @missing_t.add_translations(@fr_translations)
+      @missing_t["fr"]["zoo"].should have_key("wasp")
+      @missing_t["fr"].should have_key("mother")
+      @missing_t["es"]["zoo"].should have_key("bee")
+    end
+
+    it "should not overwrite translations keys" do
+      @missing_t.add_translations(@other_es_translations)
+      @missing_t["es"]["zoo"].should have_key("bear")
+      @missing_t["es"]["zoo"].should have_key("bee")
+    end
+
+    it "should add the new translations even if they contain keys already in the translations hash" do
+      @missing_t.add_translations(@yet_other_es_translations)
+      @missing_t["es"]["zoo"].should have_key("monkey")
+      @missing_t["es"]["zoo"].should have_key("bear")
+    end
+
+  end
+
+  describe "hashification" do
+    before do
+      queries = ["zoo.bee", "zoo.departments.food", "zoo.departments.qa", "lamp", "mother", "mother.maiden_name"]
+      @queries_hash = @missing_t.hashify(queries)
+      @h = { "fr" => { "book" => "livre", "zoo" => {"elephant" => "elephant"} } }
+    end
+
+    it "should find a nested key and return it" do
+      @h.should have_nested_key('fr.zoo.elephant')
+      @h.should have_nested_key('fr.book')
+    end
+
+    it "should return false when it does not have a nested key" do
+      @h.should_not have_nested_key('fr.zoo.seal')
+      @h.should_not have_nested_key('xxx')
+    end
+
+    it "an empty hash should not have any nested keys" do
+      {}.should_not have_nested_key(:puppy)
+    end
+
+    it "should turn strings to hash keys along their separators (dots)" do
+      ["zoo", "lamp", "mother"].all? { |k| @queries_hash.key?(k) }.should == true
+      ["bee", "departments"].all? { |k| @queries_hash["zoo"].key?(k) }.should == true
+      @queries_hash["zoo"]["departments"].should have_key("food")
+      @queries_hash["zoo"]["departments"].should have_key("qa")
+    end
+  end
+
+  describe "extracting i18n queries" do
+    before do
+      content = <<-EOS
+        <div class="title_gray"><span><%= I18n.t("anetcom.member.projects.new.page_title") %></span></div>
+        <%= submit_tag I18n.t('anetcom.member.projects.new.create_project'), :class => 'button' %>
+        <%= link_to I18n.t("tog_headlines.admin.publish"), publish_admin_headlines_story_path(story), :class => 'button' %>
+        :html => {:title => I18n.t("tog_social.sharing.share_with", :name => shared.name)} 
+      EOS
+      $stubba = Mocha::Central.new
+      @missing_t.stubs(:get_content_of_file_with_i18n_queries).returns(content)
+    end
+
+    it "should extract the I18n queries correctly when do" do
+      i18n_queries = @missing_t.extract_i18n_queries(nil)
+      i18n_queries.should == ["anetcom.member.projects.new.page_title", "anetcom.member.projects.new.create_project", "tog_headlines.admin.publish", "tog_social.sharing.share_with"]
+    end
+
+  end
+
+  describe "finding missing translations" do
+    before do
+      @t_queries = { :fake_file => ["mother", "zoo.bee", "zoo.wasp", "pen"] }
+      $stubba = Mocha::Central.new
+      @missing_t.stubs(:translations).returns(@fr_translations.merge(@es_translations))
+      # @missing_t.stubs(:collect_translation_queries).returns(@t_queries)
+    end
+
+    it "should return true if it has a translation given in the I18n form" do
+      @missing_t.has_translation?("fr", "zoo.wasp").should == true
+      @missing_t.has_translation?("es", "pen").should == true
+    end
+
+    it "should return false if it does not have a translation given in the I18n form" do
+      @missing_t.has_translation?("fr", "zoo.bee").should == false
+      @missing_t.has_translation?("es", "mother").should == false
+    end
+
+    it "should correctly get missing translations for a spec. language" do
+      miss_entries = @missing_t.get_missing_translations(@t_queries, "fr").map{ |e| e[1] }.flatten
+      miss_entries.should include("fr.pen")
+      miss_entries.should include("fr.zoo.bee")
+    end
+
+    it "should correctly get missing translations" do
+      miss_entries = @missing_t.get_missing_translations(@t_queries).map{ |e| e[1] }.flatten
+      miss_entries.should include("fr.zoo.bee")
+      miss_entries.should include("fr.pen")
+      miss_entries.should include("es.zoo.wasp")
+      miss_entries.should include("es.mother")
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "missing_t")

data/tasks/missing_t.rake

@@ -0,0 +1,6 @@
+require 'spec/rake/spectask'
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*spec.rb']
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: balinterdi-missing_t
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Balint Erdi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-03 00:00:00 -08:00
+default_executable: missing_t
+dependencies: []
+
+description: See all the missing I18n translations in your Rails project
+email: balint.erdi@gmail.com
+executables: 
+- missing_t
+extensions: []
+
+extra_rdoc_files: 
+- bin/missing_t
+- lib/missing_t.rb
+- README.rdoc
+- tasks/missing_t.rake
+files: 
+- bin/missing_t
+- lib/missing_t.rb
+- Manifest
+- Rakefile
+- README.rdoc
+- spec/missing_t_spec.rb
+- spec/spec_helper.rb
+- tasks/missing_t.rake
+- missing_t.gemspec
+has_rdoc: true
+homepage: http://github.com/balinterdi/missing_t
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Missing_t
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: missing_t
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: See all the missing I18n translations in your Rails project
+test_files: []
+