missing_t 0.3.1 → 0.3.2

data/.gitignore

@@ -2,3 +2,4 @@ pkg/
 doc
 Manifest
 .bundle/*
+tmp/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    missing_t (0.3.1)
+    missing_t (0.3.2)
 
 GEM
   remote: http://rubygems.org/
@@ -18,7 +18,10 @@ GEM
       rspec (~> 2.11)
     listen (0.7.2)
     lumberjack (1.0.2)
+    metaclass (0.0.1)
     method_source (0.8.1)
+    mocha (0.13.3)
+      metaclass (~> 0.0.1)
     pry (0.9.11.4)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
@@ -43,6 +46,7 @@ DEPENDENCIES
   guard (~> 1.5.4)
   guard-rspec (~> 2.3.1)
   missing_t!
+  mocha (~> 0.13.3)
   rake (~> 10.0.3)
   rb-fsevent (~> 0.9.1)
   rspec (~> 2.12.0)

data/Guardfile

@@ -1,6 +1,6 @@
 guard 'rspec' do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
 

data/README.markdown

@@ -1,43 +1,51 @@
 # Missing T
+[![Code Climate](https://codeclimate.com/github/balinterdi/missing_t.png)](https://codeclimate.com/github/balinterdi/missing_t)
 
-Missing T provides an easy way to see which internationalized messages lack their translations in a ruby project that uses I18n (e.g Rails apps). Instead of going through the translation files manually, you just call Missing T which gives you a list of all missing translation strings. By default it searches for all languages that you have translation files for. If you given it an option it will only search for translations in that language.
+Missing T provides a quick way to see which I18n message strings lack their translations in your Ruby project.
 
 ## Installation
 
-Missing T comes packaged as a gem, so you install it via the normal procedure:
+Missing T comes packaged as a gem, you just have to add it to your Gemfile:
 
-    $ gem install missing_t
-
-Also, if you prefer to use it as a plugin to Rails project, you can simply do the following:
-
-    $ ./script/plugin install git://github.com/balinterdi/missing_t.git
+    gem 'missing_t', '~> 0.3.1'
 
 ## Running
 
 To find all the messages without translations, you have to be in your project directory and then launch missing_t in the most simple way imaginable:
 
-    $ missing_t
-
-You should see all messages that don't have translations on the screen, broken down per file, e.g:
-
-    app/views/users/new.html.erb:
-        fr.users.name
-        fr.users.city_of_residence
-        es.users.age
-
-    app/helpers/user_helper.rb:
-        fr.users.travels
-
+    $ bundle exec missing_t
+
+All messages that don't have translations will be outputted in a format directly pastable to your locale files:
+
+    fr:
+      users:
+        name:
+        city_of_residence:
+        travels:
+    es:
+      users:
+        age:
+        city_of_residence:
+      events:
+        venue: 
+        
+    
 __NOTE__ If no language code is provided, the script will determine which languages need to have translations by gathering all language codes in the localization files and assuming that if there is at least one translation defined for a language then all translations should be defined for it.
 
-If you wish to see all the lacking translations for a certain language, just provide its language code as a parameter:
+If you wish to see all missing translations for a certain language, just provide its language code as a parameter:
 
-    $ missing_t fr
+    $ bundle exec missing_t fr
+    
+In this case only missing translations in the provided language will be printed:
 
-## Epilogue
+    fr:
+      users:
+        name:
+        city_of_residence:
+        travels:
 
-That's all about it, let me know if you find any bugs or have suggestions as to what else should the script do. If you wish you can directly contact me at balint.erdi@gmail.com.
+## Epilogue
 
-[http://github.com/balinterdi/missing_t/](http://github.com/balinterdi/missing_t/)
+Released under the MIT license.
 
-Copyright (c) 2009 Balint Erdi, released under the MIT license
+2009-2013 Balint Erdi

data/bin/missing_t

@@ -20,7 +20,7 @@ def print_hash(h, level)
   end
 end
 
-missing_t = MissingT.new
+missing_t = MissingT.new(MissingT::FileReader.new)
 missing_t.parse_options(ARGV)
 missing_message_strings = missing_t.find_missing_translations(ARGV.first).values.map { |ms| hashify(ms) }
 

data/lib/missing_t.rb

@@ -4,15 +4,6 @@ require "ostruct"
 require "forwardable"
 
 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|
@@ -52,16 +43,20 @@ end
 
 class MissingT
 
-  VERSION = "0.3.1"
+  class FileReader
+    def read(file)
+      open(File.expand_path(file), "r") do |f|
+        yield f.read
+      end
+    end
+  end
+
+  VERSION = "0.3.2"
 
   include Helpers
-  extend Forwardable
-  def_delegators :@translations, :[]
 
-  # attr_reader :translations
-
-  def initialize
-    @translations = Hash.new
+  def initialize(reader)
+    @reader = reader
   end
 
   def parse_options(args)
@@ -88,57 +83,48 @@ class MissingT
     opts.parse!(args)
   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
+  def translation_keys
     locales_pathes = ["config/locales/**/*.yml", "vendor/plugins/**/config/locales/**/*yml", "vendor/plugins/**/locale/**/*yml"]
-    locales_pathes.each do |path|
+    locales_pathes.each_with_object({}) do |path, translations|
       Dir.glob(path) do |file|
-        add_translations(translations_in_file(file))
+        t = open(file) { |f| YAML.load(f.read) }
+        translations.deep_safe_merge!(t)
       end
     end
   end
 
-  def translations_in_file(yaml_file)
-    open(yaml_file) { |f| YAML.load(f.read) }
-  end
-
   def files_with_i18n_queries
     if path = @options.path
       path = path[0...-1] if path[-1..-1] == '/'
-      [ Dir.glob("#{path}/**/*.erb"), Dir.glob("#{path}/**/*.rb") ]
+      [
+        Dir.glob("#{path}/**/*.erb"),
+        Dir.glob("#{path}/**/*.haml"),
+        Dir.glob("#{path}/**/*.rb")
+      ]
     else
-      [ Dir.glob("app/**/*.erb"),
-      Dir.glob("app/**/controllers/**/*.rb"),
-      Dir.glob("app/**/helpers/**/*.rb")]
+      [
+        Dir.glob("app/**/*.erb"),
+        Dir.glob("app/**/*.haml"),
+        Dir.glob("app/**/models/**/*.rb"),
+        Dir.glob("app/**/controllers/**/*.rb"),
+        Dir.glob("app/**/helpers/**/*.rb")
+      ]
     end.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 = /[^\w]+(?:I18n\.translate|I18n\.t|translate|t)\s*\((.*?)[,\)]/
     i18n_query_no_parens_pattern = /[^\w]+(?:I18n\.translate|I18n\.t|translate|t)\s+(['"])(.*?)\1/
-    file_content = get_content_of_file_with_i18n_queries(file)
-    file_content.scan(i18n_query_pattern).map { |match| match.first.gsub(/['"\s]/, '') }.
-      concat(file_content.scan(i18n_query_no_parens_pattern).map { |match| match[1].gsub(/['"\s]/, '') })
+
+    @reader.read(file) do |content|
+      ([]).tap do |i18n_message_strings|
+        i18n_message_strings << content.scan(i18n_query_pattern).map { |match| match[0].gsub(/['"\s]/, '') }
+        i18n_message_strings << content.scan(i18n_query_no_parens_pattern).map { |match| match[1].gsub(/['"\s]/, '') }
+      end.flatten
+    end
   end
 
-  def collect_translation_queries
+  def translation_queries
     files_with_i18n_queries.each_with_object({}) do |file, queries|
       queries_in_file = extract_i18n_queries(file)
       if queries_in_file.any?
@@ -148,18 +134,17 @@ class MissingT
     #TODO: remove duplicate queries across files
   end
 
-  def has_translation?(lang, query)
-    t = translations
+  def has_translation?(keys, lang, query)
     i18n_label(lang, query).split('.').each do |segment|
-      return false unless segment =~ /#\{.*\}/ or (t.respond_to?(:key?) and t.key?(segment))
-      t = t[segment]
+      return false unless segment =~ /#\{.*\}/ or (keys.respond_to?(:key?) and keys.key?(segment))
+      keys = keys[segment]
     end
     true
   end
 
-  def get_missing_translations(queries, languages)
+  def get_missing_translations(keys, queries, languages)
     languages.each_with_object({}) do |lang, missing|
-      get_missing_translations_for_lang(queries, lang).each do |file, queries|
+      get_missing_translations_for_lang(keys, queries, lang).each do |file, queries|
         missing[file] ||= []
         missing[file].concat(queries).uniq!
       end
@@ -167,14 +152,14 @@ class MissingT
   end
 
   def find_missing_translations(lang=nil)
-    collect_translations
-    get_missing_translations(collect_translation_queries, lang ? [lang] : translations.keys)
+    ts = translation_keys
+    get_missing_translations(translation_keys, translation_queries, lang ? [lang] : ts.keys)
   end
 
   private
-    def get_missing_translations_for_lang(queries, lang)
+    def get_missing_translations_for_lang(keys, queries, lang)
       queries.map do |file, queries_in_file|
-        queries_with_no_translation = queries_in_file.select { |q| !has_translation?(lang, q) }
+        queries_with_no_translation = queries_in_file.select { |q| !has_translation?(keys, lang, q) }
         if queries_with_no_translation.empty?
           nil
         else

data/missing_t.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'guard', ['~> 1.5.4']
   gem.add_development_dependency 'guard-rspec', ['~> 2.3.1']
   gem.add_development_dependency 'rb-fsevent', ['~> 0.9.1']
+  gem.add_development_dependency 'mocha', ['~> 0.13.3']
 end

data/spec/missing_t_spec.rb

@@ -1,18 +1,20 @@
-require "rubygems"
-require "spec"
-require "mocha"
-
-require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'spec_helper'
 
 # use mocha for mocking instead of
 # Rspec's own mock framework
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   config.mock_with :mocha
 end
 
+class ContentReader
+  def read(content)
+    yield content
+  end
+end
+
 describe "MissingT" do
   before do
-    @missing_t = MissingT.new
+    @missing_t = MissingT.new(ContentReader.new)
     @es_translations =  {"es"=>
       {"zoo"=>{"elephant"=>"elefante", "bear"=>"oso", "lion"=>"leon", "bee" => "abeja"},
        "lamp"=>"lampa",
@@ -30,75 +32,7 @@ describe "MissingT" do
     @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 "the i18n query extracion" do
-    before do
-      metaclass = class << @missing_t; self; end
-      metaclass.instance_eval do
-        define_method :get_content_of_file_with_i18n_queries do |content|
-          content
-        end
-      end
-    end
-
     it "should correctly extract the I18n.t type of messages" do
       content = <<-EOS
         <div class="title_gray"><span><%= I18n.t("anetcom.member.projects.new.page_title") %></span></div>
@@ -165,7 +99,6 @@ describe "MissingT" do
     end
 
     it "should find and correctly extract a dynamic key translation message" do
-      # @missing_t.stubs(:get_content_of_file_with_i18n_queries).returns(content)
       content = %q(<div class="title_gray"><span><%= I18n.t("mycompany.welcome.#{key}") %></span></div>)
       @missing_t.extract_i18n_queries(content).should == [%q(mycompany.welcome.#{key})]
     end
@@ -175,38 +108,18 @@ describe "MissingT" do
   describe "finding missing translations" do
     before do
       @t_queries = { :fake_file => ["mother", "zoo.bee", "zoo.wasp", "pen"] }
-      @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
-
-    describe "of dynamic message strings" do
-      it "should return true if it has a translation that matches the fix parts" do
-        @missing_t.has_translation?("fr", %q(zoo.#{animal})).should == true
-      end
-
-      it "should return false if it does not have a translation that matches all the fix parts" do
-        @missing_t.has_translation?("fr", %q(household.#{animal})).should == false
-      end
+      @missing_t.stubs(:translation_keys).returns(@fr_translations.merge(@es_translations))
+      @missing_t.stubs(:translation_queries).returns(@t_queries)
     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
+    it "should correctly get missing translations for a specific language" do
+      miss_entries = @missing_t.find_missing_translations("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 = @missing_t.find_missing_translations.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")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: missing_t
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-21 00:00:00.000000000 Z
+date: 2013-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -91,6 +91,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.3
 description: Finds all the missing i18n translations in your Rails project
 email:
 - balint.erdi@gmail.com
@@ -148,7 +164,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -311353985734395445
+      hash: -840801129156003864
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -157,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -311353985734395445
+      hash: -840801129156003864
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23