transdifflation 0.0.3 → 0.0.4

data/Fudgefile

@@ -1,4 +1,5 @@
 build :default do
   yard :arguments => '-r YardREADME.md', :coverage => 100
   rspec :coverage => 100
+  # cane :max_width => 300 #still ABC complexity probs
 end

data/Gemfile

@@ -4,14 +4,16 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rails'
+gem 'ya2yaml'
 
 group :development, :test do
   gem 'fudge'
   gem 'rspec'
   gem 'yard'
+  gem 'cane'
   gem 'simplecov'
   gem 'rake'
-
+  gem 'rspec'
   gem 'rspec-rails'
   gem 'guard-sass', :require => false
   gem 'pry'

data/README.md

@@ -1,12 +1,13 @@
-# Transdifflation
+# Transdifflation [![travis-ci](https://secure.travis-ci.org/Sage/transdifflation.png)](http://travis-ci.org/#!/Sage/transdifflation)
 
-What is Transdifflation? Transdifflation is an acronym of 'Translation' and 'Diff'.  
-It compares two .yml locate files, one in your source code (target) and one in others' (gems, other projects) source code (source) and generates a beside-file with the keys you hadn't translated yet.  
-Then you can merge it. It is designed to detect changes between versions. By now, target file cannot be renamed, and it is generated in 'config/locales/' + to_locale (param in task). Names are inferred by the task params too.
+What is Transdifflation? Transdifflation is a portmanteau of 'Translation' and 'Diff'.  It helps you to manage the translation of Rails i18n strings that appear in your application and the Ruby Gems it includes.
+
+It compares two .yml locale files, one in your source code (the *target*) and one in others' (gems, other projects) source code (the *source*) and generates a beside-file with the keys you haven't translated yet.
+Then you can merge it. It is designed to detect changes between versions. For now, the target file cannot be renamed, and it is generated in 'config/locales/' + to_locale (param in task). Names are inferred by the task params.
 
 Also, it has three new rake tasks to provide information to you about missing translations between two locales, and continuous integration support.
 
-IT NEVER CHANGES YOUR SOURCE FILE, unless it doesn't exists, so it creates for you. 
+It never changes your source files (unless they don't yet exist, in which case they are created for you). 
 
 ## Installation
 
@@ -26,7 +27,7 @@ Or install it yourself as:
 
 ### How to configure your Rake tasks
 
-It needs a config file (**transdifflation.yml**) placed on your host root, or in 'config'. If not exists, a rake task is set up to generate it: ```rake transdifflation:config```. Config file looks like:
+It needs a config file (`transdifflation.yml`) placed on your host root, or in 'config'. If not exists, a rake task is set up to generate it: ```rake transdifflation:config```. Config file looks like:
 
 ```yml
 tasks:

data/lib/tasks/translation_coverage.rake

@@ -8,8 +8,7 @@ namespace :transdifflation do
     
     #Reading config  file
     search_locations = %w[config/transdifflation.yml transdifflation.yml]
-
-
+    
     file_task_config = nil
     search_locations.each do |path| #Take config file from these locations
       abs_path = File.expand_path(path, Rails.root)
@@ -31,7 +30,7 @@ namespace :transdifflation do
       I18n.backend.load_translations
 
     end
-
+    translations = I18n.backend.send(:translations)
 
     hash_from_locale = translations[from_locale]
     hash_to_locale = translations[to_locale]
@@ -44,6 +43,8 @@ namespace :transdifflation do
   task :coverage, [:from_locale, :to_locale] => [:environment] do |t, args|
 
     args.with_defaults(:from_locale => I18n.default_locale, :to_locale => I18n.locale)
+    #I18n.load_path.
+
     puts "\nChecking how much work you have left...\n"
     from_locale = args[:from_locale].to_sym
     to_locale = args[:to_locale].to_sym
@@ -52,7 +53,4 @@ namespace :transdifflation do
     differences = get_coverage_rate(from_locale, to_locale)
     puts "You have #{differences}"
   end
-
-
-
 end

data/lib/transdifflation/railtie.rb

@@ -14,7 +14,7 @@ module Transdifflation
     railtie_name :transdifflation
     rake_tasks do
       begin
-        
+
         Dir[ File.join(File.dirname(__FILE__), '../tasks/*.rake')] .each { |f| load f }  #Load static tasks
 
 
@@ -98,7 +98,7 @@ module Transdifflation
         end
 
       rescue Transdifflation::ConfigFileNotFound
-        #Generate task to set-up 
+        #Generate task to set-up
         namespace :transdifflation do
           desc "Task to set-up config file in host"
           task :setup do
@@ -111,11 +111,11 @@ module Transdifflation
 
       rescue Transdifflation::ConfigFileWithErrors => e
 
-        raise "Gem 'Transdifflation' says => #{e.message}"  
+        raise "Gem 'Transdifflation' says => #{e.message}"
 
       rescue Exception => e
 
-        raise "Gem 'Transdifflation' says => #{e.message}"  
+        raise "Gem 'Transdifflation' says => #{e.message}"
 
       end
     end

data/lib/transdifflation/transdifflation.yml

@@ -24,11 +24,11 @@
 #  }
 #
 #grouped_tasks:
-#  task_group_name: 
+#  task_group_name:
 #    - task_name1
 #    - task_name2
 #
 #ignore_paths:
-#  - /Faker-
-#  - /faker-
+#  - path-1-
+#  - /gem_name_2-
 

data/lib/transdifflation/utilities.rb

@@ -6,10 +6,10 @@ module Transdifflation
   class HashSymbolTranslator
     # Convert keys (strings) into symbols
     def symbolize(hash)
-      hash = hash.inject({}) { |memo,(k,v)| 
+      hash = hash.inject({}) { |memo,(k,v)|
           if(v.instance_of? Hash)
              v = symbolize(v)
-          end 
+          end
           memo[k.to_sym] = v
           memo
       }
@@ -17,10 +17,10 @@ module Transdifflation
     end
      # Convert keys into string
      def unsymbolize(hash)
-      hash = hash.inject({}) { |memo,(k,v)| 
+      hash = hash.inject({}) { |memo,(k,v)|
           if(v.instance_of? Hash)
              v = unsymbolize(v)
-          end 
+          end
           memo[k.to_s] = v
           memo
       }
@@ -31,6 +31,7 @@ module Transdifflation
   end
 end
 
+# monkeypatch the Hash class to convert to/from symbols
 class Hash
 
   #convert all keys in a Hash (presumily from YAML) in symbols

data/lib/transdifflation/version.rb

@@ -1,4 +1,4 @@
 module Transdifflation
   # Gem version
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/transdifflation/yaml_reader.rb

@@ -9,7 +9,9 @@ module Transdifflation
     def self.read_YAML_from_gem(gem_name, file_path_to_yaml_in_gem)
 
       #get where the gem is localized
+
       gem_SRC =`bundle show #{gem_name}`.chomp
+
       raise ArgumentError.new("Gem '#{gem_name}' not installed") if ($?.to_i != 0)  #get return code and check if is different from zero
 
       #get the file within the gem

data/lib/transdifflation.rb

@@ -9,7 +9,7 @@ require 'pry'
 # The main module for the program
 module Transdifflation
 
-  require 'transdifflation/railtie' if defined?(Rails) 
+  require 'transdifflation/railtie' if defined?(Rails)
 
   # Implements the core
   class Comparer
@@ -19,7 +19,7 @@ module Transdifflation
     #Instance variable to get if changes have been detected
     attr_reader :has_changes
 
-    def initialize()
+    def initialize
       @has_changes = false
     end
 
@@ -35,16 +35,20 @@ module Transdifflation
       from_locale ||= I18n.default_locale
       to_locale ||= I18n.locale
 
-
       yml_gem_content = YAMLReader.read_YAML_from_gem(gem_name, path_to_yaml_in_gem)
       puts "Loaded YAML content from gem '#{gem_name}', file '#{path_to_yaml_in_gem}'"
 
-
       #build the file name in our host
       filename_in_gem_SRC = File.basename( path_to_yaml_in_gem )
       host_target_filename = filename_in_gem_SRC.gsub(/-?#{from_locale}\./) do |match_s|
         match_s.sub("#{from_locale}", "#{to_locale}")
       end
+
+      #The folder is created if doesn't exist
+      if !File.directory?("config/locales/#{to_locale}")
+        FileUtils.mkdir_p(File.join(Rails.root, "config/locales/#{to_locale}"))
+      end
+
       host_target_file = File.join( Rails.root, "config/locales/#{to_locale}", "#{gem_name}.#{host_target_filename}")
 
       if(!File.file? host_target_file)
@@ -52,12 +56,9 @@ module Transdifflation
       else
         generate_diff_file(yml_gem_content, host_target_file, from_locale, to_locale)
       end
-
       @has_changes
     end
 
-
-
     # Get Diff from YAML translation locale file from filesystem and generate differences in a file on our host
     #
     # @param [String] tag_name    Tag name this file will be installed on host
@@ -74,10 +75,16 @@ module Transdifflation
       puts "Loaded YAML content from file '#{path_to_yaml_relative_from_rails_root}'"
 
       #build the file name in our host
-      filename_in_SRC = File.basename( path_to_yaml_relative_from_rails_root )
+      filename_in_SRC = File.basename(path_to_yaml_relative_from_rails_root )
       host_target_filename = filename_in_SRC.gsub(/-?#{from_locale}\./) do |match_s|
         match_s.sub("#{from_locale}", "#{to_locale}")
       end
+
+      #The folder is created if doesn't exist
+      if !File.directory?("config/locales/#{to_locale}")
+        FileUtils.mkdir_p(File.join(Rails.root, "config/locales/#{to_locale}"))
+      end
+
       host_target_file = File.join( Rails.root, "config/locales/#{to_locale}", "#{tag_name}.#{host_target_filename}")
 
       if(!File.file? host_target_file)
@@ -109,8 +116,8 @@ module Transdifflation
     # @param [Hash] hash_from_locale I18n source translation to compare
     # @param [Hash] hash_to_locale I18n target translation to compare
     # @param [String] token The string you want to compare. example: **NOT TRANSLATED**
-    def coverage_rate(hash_from_locale, hash_to_locale, token = NOT_TRANSLATED)      
-        
+    def coverage_rate(hash_from_locale, hash_to_locale, token = NOT_TRANSLATED)
+
       if hash_from_locale.nil?
         return "Translation coverage error: from_locale language not detected."
       end
@@ -118,9 +125,9 @@ module Transdifflation
       if hash_to_locale.nil?
         return "Translation coverage error: to_locale language not detected."
       end
-      
+
       if hash_from_locale.empty?
-        return "from_locale is empty, so you have everything translated"         
+        return "from_locale is empty, so you have everything translated"
       end
 
       words = 0
@@ -133,13 +140,13 @@ module Transdifflation
     end
 
 
-    # Get the number of translated keys 
+    # Get the number of translated keys
     #
     # @param [Hash] hash_from I18n source translation to compare
     # @param [Hash] hash_to I18n target translation to compare
     # @param [String] token The string you want to compare. example: **NOT TRANSLATED**
     # @param [Integer] words Number of keys (accumulated) from hash_from
-    # @param [Integer] found Number of keys (accumulated) where token is not found in hash_to 
+    # @param [Integer] found Number of keys (accumulated) where token is not found in hash_to
     def rate_from_branch(hash_from, hash_to, token, words, found)
 
       hash_from.each_pair{ |key, value|
@@ -154,12 +161,12 @@ module Transdifflation
         else
           words += 1
           if hash_to[key.to_sym]
-            found += 1 if !hash_to[key.to_sym].to_s.include?(token) 
-          end          
+            found += 1 if !hash_to[key.to_sym].to_s.include?(token)
+          end
         end
       }
       return words, found
-    end      
+    end
 
     private
 
@@ -206,17 +213,23 @@ module Transdifflation
 
         #if value is a hash, we call it recursively
         if (source_value.instance_of? Hash)
-          if(!target.has_key? (source_key_translated))
+          if(!target.has_key?(source_key_translated))
             target[source_key_translated] = Hash.new
           end
           translate_keys_in_same_yaml(source_value, target[source_key_translated], from_locale, to_locale, add_NOT_TRANSLATED) #recurrence of other hashes
         else
           #it's a leaf node
-          target[source_key_translated] = (add_NOT_TRANSLATED ? "#{NOT_TRANSLATED}#{source_value}" : "#{source_value}") if  !target.has_key? (source_key_translated)
+          target[source_key_translated] = (add_NOT_TRANSLATED ? "#{NOT_TRANSLATED}#{source_value}" : "#{source_value}") if  !target.has_key?(source_key_translated)
         end
       }
     end
 
+    # Generates a difference file from YAML hash
+    #
+    # @param [Hash]   yml_source_content           Source YAML-format hash
+    # @param [Hash]   host_target_file           Target file
+    # @param [Symbol] from_locale      Default locale in gem. Used to translate 'from'
+    # @param [Symbol] to_locale        Default locale in host. Used to translate 'to'
     def generate_diff_file(yml_source_content, host_target_file, from_locale, to_locale)
 
       existant_yml = YAMLReader.read_YAML_from_pathfile(host_target_file)
@@ -230,16 +243,13 @@ module Transdifflation
         temp_removed_diff_hash = {}
         translate_keys_in_same_yaml(removed_diff_hash, temp_removed_diff_hash, from_locale, to_locale, false)
         removed_diff_hash = temp_removed_diff_hash
-        
       end
 
-
       if( added_diff_hash.length > 0 || removed_diff_hash.length > 0 )
-
         diff_file = File.join(File.dirname(host_target_file), "#{File.basename(host_target_file)}.diff")
         diff_file_stream = File.new(diff_file, "w+:UTF-8")
         begin
-           
+
           if (added_diff_hash.length > 0)
             diff_file_stream.write("ADDED KEYS (Keys not found in your file, founded in source file) ********************\n")
             diff_file_stream.write(YAMLWriter.to_yaml(added_diff_hash))  #we can't use YAML#dump due to issues wuth Utf8 chars
@@ -256,7 +266,7 @@ module Transdifflation
         end
         puts "File #{File.basename( host_target_file )} processed >> %s" %  [ "#{File.basename( diff_file )} has the changes!"]
         @has_changes = true
-      else 
+      else
         puts "File #{File.basename( host_target_file )} processed >> No changes!"
       end
     end

data/spec/coverage_spec.rb

@@ -2,140 +2,140 @@ require 'spec_helper'
 require 'transdifflation'
 
 describe :translation_coverage do
-	describe :coverage_rate do
-		it 'should return a message when hash_from_locale is an nil hash' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = nil
-			hash_to_locale  = {}
-			token = "**NOT TRANSLATED**"
-			
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "Translation coverage error: from_locale language not detected."
-		end
-		it 'should return a message when hash_to_locale is an nil hash' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = {}
-			hash_to_locale  = nil
-			token = "**NOT TRANSLATED**"
-			
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "Translation coverage error: to_locale language not detected."
-		end
-
-		it 'should return 100% when hash_from_locale is empty' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = {}
-			hash_to_locale  = {}
-			token = "**NOT TRANSLATED**"
-			
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "from_locale is empty, so you have everything translated"
-		end
-
-		it 'should return 100% when hash_from_locale is empty, even if there is something at hash_to_locale' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = {}
-			hash_to_locale  = {:home => "hogar"}
-			token = "**NOT TRANSLATED**"
-
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "from_locale is empty, so you have everything translated"
-		end
-
-		it 'should return 0% when theres all to translate' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = {:home => "home"}
-			hash_to_locale  = {}
-			token = "**NOT TRANSLATED**"
-
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "0.00% 0/1 entries translated"
-		end
-
-		it 'should return 100% when you have everything translated (5/5)' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = { :one => "one", :two => "two", :three => "tree", :four => "four", :five => "five" }
-			hash_to_locale =   { :one => "uno", :two => "dos", :three => "tres", :four => "cuatro", :five => "cinco" }
-			token = "**NOT TRANSLATED**"
-
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "100.00% 5/5 entries translated"
-		end
-
-		it 'should return 80% when you have 8/10 terms translated' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = { :one => "one", :two => "two", :three => "tree", :four => "four", :five => "five", :six => "six", :seven => "seven", :eight => "eight", :nine => "nine", :ten => "ten" }
-			hash_to_locale =   { :one => "uno", :two => "dos", :three => "tres", :four => "cuatro", :five => "cinco", :six => "**NOT TRANSLATED** six", :seven => "**NOT TRANSLATED** seven", :eight => "ocho", :nine => "nueve", :ten => "diez" }
-			token = "**NOT TRANSLATED**"
-
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "80.00% 8/10 entries translated"
-		end
-
-
-		it 'should return 70% when you have 7/10 terms translated, but you dont have a term, even in the hash and 2 of them are not translated' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = { :one => "one", :two => "two", :three => "tree", :four => "four", :five => "five", :six => "six", :seven => "seven", :eight => "eight", :nine => "nine", :ten => "ten" }
-			hash_to_locale =   { :one => "uno", :two => "dos", :three => "tres", :four => "cuatro", :five => "cinco", :six => "**NOT TRANSLATED** six", :seven => "**NOT TRANSLATED** seven", :eight => "ocho", :nine => "nueve" }
-			token = "**NOT TRANSLATED**"
-
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "70.00% 7/10 entries translated"
-		end
-
-		it 'should return 62.50% when you have 5/8 terms translated' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = { :one => "one", :two => "two", :three => "tree", :four => "four", :five => "five", :six => "six", :seven => "seven", :eight => "eight" }
-			hash_to_locale =   { :one => "uno", :two => "**NOT TRANSLATED** two", :three => "tres", :four => "cuatro", :five => "cinco", :six => "**NOT TRANSLATED** six", :seven => "**NOT TRANSLATED** seven", :eight => "ocho"}
-			token = "**NOT TRANSLATED**"
-
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "62.50% 5/8 entries translated"
-		end
-
-		it 'should return 62.50% when you have 5/8 terms translated, having extra terms at the hash_to_locale hash' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = { :one => "one", :two => "two", :three => "tree", :four => "four", :five => "five", :six => "six", :seven => "seven", :eight => "eight" }
-			hash_to_locale =   { :one => "uno", :two => "**NOT TRANSLATED** two", :three => "tres", :four => "cuatro", :five => "cinco", :six => "**NOT TRANSLATED** six", :seven => "**NOT TRANSLATED** seven", :eight => "ocho", :puerta => "Puerta"}
-			token = "**NOT TRANSLATED**"
-
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "62.50% 5/8 entries translated"
-		end
-
-		it 'should return 100.00% in nested hash' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = { :house => "house", :street => {:street_name => "street name", :postal => "postal code"}}
-			hash_to_locale = { :house => "casa", :street => {:street_name => "Nombre de la calle", :postal => "codigo postal"}}
-			token = "**NOT TRANSLATED**"
-
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "100.00% 3/3 entries translated"
-		end
-
-		it 'should return 3 entries, 2 translations found' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = { :house => "house", :street => {:street_name => "street name", :postal => "postal code"}}
-			hash_to_locale = { :house => "casa", :street => {:street_name => "**NOT TRANSLATED** Nombre de la calle", :postal => "codigo postal"}}
-			token = "**NOT TRANSLATED**"
-
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "66.67% 2/3 entries translated"
-		end
-
-		it 'should return 0.00% in nested hash' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = { :street => {:street_name => "**NOT TRANSLATED** Nombre de la calle", :postal => "codigo postal", :number => { :one => "one", :two => "two", :three => "tree"}}}
-			hash_to_locale =   { :one => "uno"}
-			token = "**NOT TRANSLATED**"
-
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "0.00% 0/5 entries translated"
-		end
-
-		it 'should return 10.00% in nested hash' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = { :one => "one", :two => "two", :three => "tree", :four => "four", :five => "five", :six => "six", :seven => "seven", :eight => "eight", :nine => "nine", :ten => "ten", :street => {:street_name => "**NOT TRANSLATED** Nombre de la calle", :postal => "codigo postal"}}
-			hash_to_locale =   { :one => "uno"}
-			token = "**NOT TRANSLATED**"
-
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "8.33% 1/12 entries translated"
-		end
-
-		it 'should return 8.33% in nested hash with only one term' do
-			@comparer = Transdifflation::Comparer.new
-			hash_from_locale = { :one => "one", :two => "two", :three => "tree", :four => "four", :five => "five", :six => "six", :seven => "seven", :eight => "eight", :nine => "nine", :ten => "ten", :street => {:street_name => "Nombre de la calle", :postal => "codigo postal"}}
-			hash_to_locale =   { :one => "uno"}
-			token = "**NOT TRANSLATED**"
-
-			@comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "8.33% 1/12 entries translated"
-		end
-	end
+  describe :coverage_rate do
+    it 'should return a message when hash_from_locale is an nil hash' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = nil
+      hash_to_locale  = {}
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "Translation coverage error: from_locale language not detected."
+    end
+    it 'should return a message when hash_to_locale is an nil hash' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = {}
+      hash_to_locale  = nil
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "Translation coverage error: to_locale language not detected."
+    end
+
+    it 'should return 100% when hash_from_locale is empty' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = {}
+      hash_to_locale  = {}
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "from_locale is empty, so you have everything translated"
+    end
+
+    it 'should return 100% when hash_from_locale is empty, even if there is something at hash_to_locale' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = {}
+      hash_to_locale  = {:home => "hogar"}
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "from_locale is empty, so you have everything translated"
+    end
+
+    it 'should return 0% when theres all to translate' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = {:home => "home"}
+      hash_to_locale  = {}
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "0.00% 0/1 entries translated"
+    end
+
+    it 'should return 100% when you have everything translated (5/5)' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = { :one => "one", :two => "two", :three => "tree", :four => "four", :five => "five" }
+      hash_to_locale =   { :one => "uno", :two => "dos", :three => "tres", :four => "cuatro", :five => "cinco" }
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "100.00% 5/5 entries translated"
+    end
+
+    it 'should return 80% when you have 8/10 terms translated' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = { :one => "one", :two => "two", :three => "tree", :four => "four", :five => "five", :six => "six", :seven => "seven", :eight => "eight", :nine => "nine", :ten => "ten" }
+      hash_to_locale =   { :one => "uno", :two => "dos", :three => "tres", :four => "cuatro", :five => "cinco", :six => "**NOT TRANSLATED** six", :seven => "**NOT TRANSLATED** seven", :eight => "ocho", :nine => "nueve", :ten => "diez" }
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "80.00% 8/10 entries translated"
+    end
+
+
+    it 'should return 70% when you have 7/10 terms translated, but you dont have a term, even in the hash and 2 of them are not translated' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = { :one => "one", :two => "two", :three => "tree", :four => "four", :five => "five", :six => "six", :seven => "seven", :eight => "eight", :nine => "nine", :ten => "ten" }
+      hash_to_locale =   { :one => "uno", :two => "dos", :three => "tres", :four => "cuatro", :five => "cinco", :six => "**NOT TRANSLATED** six", :seven => "**NOT TRANSLATED** seven", :eight => "ocho", :nine => "nueve" }
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "70.00% 7/10 entries translated"
+    end
+
+    it 'should return 62.50% when you have 5/8 terms translated' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = { :one => "one", :two => "two", :three => "tree", :four => "four", :five => "five", :six => "six", :seven => "seven", :eight => "eight" }
+      hash_to_locale =   { :one => "uno", :two => "**NOT TRANSLATED** two", :three => "tres", :four => "cuatro", :five => "cinco", :six => "**NOT TRANSLATED** six", :seven => "**NOT TRANSLATED** seven", :eight => "ocho"}
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "62.50% 5/8 entries translated"
+    end
+
+    it 'should return 62.50% when you have 5/8 terms translated, having extra terms at the hash_to_locale hash' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = { :one => "one", :two => "two", :three => "tree", :four => "four", :five => "five", :six => "six", :seven => "seven", :eight => "eight" }
+      hash_to_locale =   { :one => "uno", :two => "**NOT TRANSLATED** two", :three => "tres", :four => "cuatro", :five => "cinco", :six => "**NOT TRANSLATED** six", :seven => "**NOT TRANSLATED** seven", :eight => "ocho", :puerta => "Puerta"}
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "62.50% 5/8 entries translated"
+    end
+
+    it 'should return 100.00% in nested hash' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = { :house => "house", :street => {:street_name => "street name", :postal => "postal code"}}
+      hash_to_locale = { :house => "casa", :street => {:street_name => "Nombre de la calle", :postal => "codigo postal"}}
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "100.00% 3/3 entries translated"
+    end
+
+    it 'should return 3 entries, 2 translations found' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = { :house => "house", :street => {:street_name => "street name", :postal => "postal code"}}
+      hash_to_locale = { :house => "casa", :street => {:street_name => "**NOT TRANSLATED** Nombre de la calle", :postal => "codigo postal"}}
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "66.67% 2/3 entries translated"
+    end
+
+    it 'should return 0.00% in nested hash' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = { :street => {:street_name => "**NOT TRANSLATED** Nombre de la calle", :postal => "codigo postal", :number => { :one => "one", :two => "two", :three => "tree"}}}
+      hash_to_locale =   { :one => "uno"}
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "0.00% 0/5 entries translated"
+    end
+
+    it 'should return 10.00% in nested hash' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = { :one => "one", :two => "two", :three => "tree", :four => "four", :five => "five", :six => "six", :seven => "seven", :eight => "eight", :nine => "nine", :ten => "ten", :street => {:street_name => "**NOT TRANSLATED** Nombre de la calle", :postal => "codigo postal"}}
+      hash_to_locale =   { :one => "uno"}
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "8.33% 1/12 entries translated"
+    end
+
+    it 'should return 8.33% in nested hash with only one term' do
+      @comparer = Transdifflation::Comparer.new
+      hash_from_locale = { :one => "one", :two => "two", :three => "tree", :four => "four", :five => "five", :six => "six", :seven => "seven", :eight => "eight", :nine => "nine", :ten => "ten", :street => {:street_name => "Nombre de la calle", :postal => "codigo postal"}}
+      hash_to_locale =   { :one => "uno"}
+      token = "**NOT TRANSLATED**"
+
+      @comparer.coverage_rate(hash_from_locale, hash_to_locale, token).should == "8.33% 1/12 entries translated"
+    end
+  end
 end

data/spec/lost_in_translation_spec.rb

@@ -3,26 +3,26 @@ require 'transdifflation'
 
 describe :lost_in_translation do
 
-	before (:each) do
-		@comparer = Transdifflation::Comparer.new
-	end
+  before (:each) do
+    @comparer = Transdifflation::Comparer.new
+  end
 
-	describe :inner_functionallity do
-		it 'should return no differences with same data' do
-			i18n = { :es => {:one_key => 'uno', :another_key => 'dos'} }
-			@comparer.get_rest_of_translation(i18n, i18n, :es, :es).should eql({})
-		end
+  describe :inner_functionallity do
+    it 'should return no differences with same data' do
+      i18n = { :es => {:one_key => 'uno', :another_key => 'dos'} }
+      @comparer.get_rest_of_translation(i18n, i18n, :es, :es).should eql({})
+    end
 
-		it 'should return differences with different data' do
-			i18n_en = { :en => {:one_key => 'one', :another_key => 'another', :another_one => 'another_one_even'} }
-			i18n_es = { :es => {:one_key => 'uno', :another_key => 'dos'} }
-			@comparer.get_rest_of_translation(i18n_en, i18n_es, :en, :es).should eql( {"es" => {"another_one" => "another_one_even" }} )
-		end
+    it 'should return differences with different data' do
+      i18n_en = { :en => {:one_key => 'one', :another_key => 'another', :another_one => 'another_one_even'} }
+      i18n_es = { :es => {:one_key => 'uno', :another_key => 'dos'} }
+      @comparer.get_rest_of_translation(i18n_en, i18n_es, :en, :es).should eql( {"es" => {"another_one" => "another_one_even" }} )
+    end
 
-		it 'should return no differences if target has more info than source' do
-			i18n_en = { :en => {:one_key => 'one', :another_key => 'another'} }
-			i18n_es = { :es => {:one_key => 'uno', :another_key => 'dos', :another_one => 'tres'} }
-			@comparer.get_rest_of_translation(i18n_en, i18n_es, :en, :es).should eql({})
-		end
-	end
+    it 'should return no differences if target has more info than source' do
+      i18n_en = { :en => {:one_key => 'one', :another_key => 'another'} }
+      i18n_es = { :es => {:one_key => 'uno', :another_key => 'dos', :another_one => 'tres'} }
+      @comparer.get_rest_of_translation(i18n_en, i18n_es, :en, :es).should eql({})
+    end
+  end
 end

data/spec/transdifflation_spec.rb

@@ -25,14 +25,12 @@ describe :get_transdifflation_from_gem do
   end
 
   it 'should call get_first_time_file if the files does not exist' do
-
-
     #We actually don't care about basename, and we want to generate a testfile in our tests
     File.stub(:basename).and_return('/dir/file_or_something')
     File.stub(:join).and_return(File.join(File.dirname(__FILE__), '/assets/testfile'))
 
     File.stub(:gsub).and_return('idontcare')
-
+    File.stub(:directory?).and_return(true)
     #File? Should return false, to simulate that the file is not created
     File.stub(:file?).and_return(false)
 
@@ -52,7 +50,7 @@ describe :get_transdifflation_from_gem do
     File.stub(:join).and_return(File.join(File.dirname(__FILE__), '/assets/testfile'))
 
     File.stub(:gsub).and_return('idontcare')
-
+    File.stub(:directory?).and_return(true)
     #File? Should return true, to simulate that the file is exists
     File.stub(:file?).and_return(true)
 
@@ -65,22 +63,17 @@ describe :get_transdifflation_from_gem do
   end
 
   it 'should translate yaml name from source locale to target locale' do
-
     @path_to_yaml_in_gem = 'config/locales/en/gem_name.en.yml'  #source file, it has to be translated, and match inner reg exp
 
     #File? Should return true, to simulate that the file is exists
     File.stub(:file?).and_return(true)
     #Finally simulate the call to generate_diff_file
     @comparer.stub(:generate_diff_file).and_return(nil)
-
-
-
-
+    File.stub(:directory?).and_return(true)
 
     #call to method
     expect { @comparer.get_transdifflation_from_gem(@gem_name, @path_to_yaml_in_gem, @from_locale, @to_locale) }.to_not raise_error
   end
-
 end
 
 describe :get_transdifflation_from_file do
@@ -104,12 +97,9 @@ describe :get_transdifflation_from_file do
 
     #We require to simulate "Rails.root"
     ::Rails.stub(:root).and_return('/rails')
-
   end
 
   it 'should call get_first_time_file if the files does not exist' do
-
-
     #We actually don't care about basename, and we want to generate a testfile in our tests
     File.stub(:basename).and_return('/dir/file_or_something')
     File.stub(:join).and_return('./spec/assets/testfile_path')
@@ -136,6 +126,7 @@ describe :get_transdifflation_from_file do
     File.stub(:gsub).and_return('idontcare')
     #File? Should return false, to simulate that the file is not created
     File.stub(:file?).and_return(true)
+    File.stub(:directory?).and_return(true)
 
     # And finally we are checking which method is being called, making them throw different exceptions
     @comparer.stub(:get_first_time_file).and_raise(ArgumentError)
@@ -145,7 +136,6 @@ describe :get_transdifflation_from_file do
   end
 
   it 'should translate yaml name from source locale to target locale' do
-
     @path_to_yaml_relative_from_rails_root = '../config/locales/en/file_name.en.yml'  #source file, it has to be translated, and match inner reg exp
 
     #File? Should return true, to simulate that the file is exists
@@ -154,12 +144,9 @@ describe :get_transdifflation_from_file do
     #Finally simulate the call to generate_diff_file
     @comparer.stub(:generate_diff_file).and_return(nil)
 
-
-
     #call to method
     expect { @comparer.get_transdifflation_from_file(@tag_name, @path_to_yaml_relative_from_rails_root, @from_locale, @to_locale) }.to_not raise_error
   end
-
 end
 
 
@@ -181,29 +168,24 @@ describe :comparer_common_methods do
 
     #YAMLReader should returnb a valid hash
     Transdifflation::YAMLReader.stub(:read_YAML_from_gem).and_return({en: {:home => "hogar"}})
-
-
     #We require to simulate "Rails.root"
     ::Rails.stub(:root).and_return('/rails')
   end
 
   it 'should generate first timefile if the files does not exist' do
 
-
     #We actually don't care about basename, and we want to generate a testfile in our tests
     File.stub(:basename).and_return('config/locales/en/gem_name.en.yml')
 
-
     #File? Should return false, to simulate that the file is not created
     File.stub(:file?).and_return(false)
 
-
     #now we must stub File.open, write and close in order to avoid fails on get_first_time_file
     mock_file = mock("File")
     mock_file.stub(:write).and_return(nil)
     mock_file.stub(:close).and_return(nil)
     File.stub(:open).and_return(mock_file)
-
+    File.stub(:directory?).and_return(true)
 
     expect {@comparer.get_transdifflation_from_gem(@gem_name, @path_to_yaml_in_gem, @from_locale, @to_locale) }.to_not raise_error
   end
@@ -222,10 +204,10 @@ describe :comparer_common_methods do
     #We require to simulate "Rails.root"
     ::Rails.should_receive(:root).and_return('/rails')
     File.stub(:gsub).and_return('idontcare')
+    File.stub(:directory?).and_return(true)
     #File? Should return false, to simulate that the file is not created
     File.stub(:file?).and_return(true)
 
-
     #YAMLReader should return TWO valid hashes
     Transdifflation::YAMLReader.stub(:read_YAML_from_pathfile).and_return( {es: {:dorothy => "Dorothy"}})
 
@@ -235,10 +217,7 @@ describe :comparer_common_methods do
     mock_file.stub(:close).and_return(nil)
     File.stub(:open).and_return(mock_file)
 
-
     expect { @comparer.get_transdifflation_from_gem(@gem_name, @path_to_yaml_in_gem, @from_locale, @to_locale) }.to_not raise_error
-
-
   end
 
   it 'should generate a clear diff_file when differences exists' do
@@ -249,10 +228,10 @@ describe :comparer_common_methods do
     #We require to simulate "Rails.root"
     ::Rails.should_receive(:root).and_return('/rails')
     File.stub(:gsub).and_return('idontcare')
+    File.stub(:directory?).and_return(true)
     #File? Should return false, to simulate that the file is not created
     File.stub(:file?).and_return(true)
 
-   
     #now we must stub File.open, write and close in order to avoid fails on get_first_time_file
     mock_file = mock("File")
     mock_file.stub(:write).and_return(nil)
@@ -261,14 +240,56 @@ describe :comparer_common_methods do
 
     #YAMLReader should return TWO valid hashes
     Transdifflation::YAMLReader.stub(:read_YAML_from_pathfile).and_return({en: {:home => "hogar"}})
+    expect { @comparer.get_transdifflation_from_gem(@gem_name, @path_to_yaml_in_gem, @from_locale, @from_locale) }.to_not raise_error
+  end
 
+  it "should create a folder in get_transdifflation_from_gem when it doesn't exist" do
+    #We actually don't care about basename, and we want to generate a testfile in our tests
+    File.stub(:basename).and_return('/dir/file_or_something')
 
-    expect { @comparer.get_transdifflation_from_gem(@gem_name, @path_to_yaml_in_gem, @from_locale, @from_locale) }.to_not raise_error
+    Transdifflation::YAMLReader.stub(:read_YAML_from_gem).and_return({en: {:home => "hogar"}})    #We require to simulate "Rails.root"
+    ::Rails.should_receive(:root).and_return('/rails')
+    File.stub(:gsub).and_return('idontcare')
 
+    File.stub(:directory?).and_return(false)
+    #File? Should return false, to simulate that the file is not created
+
+    File.stub(:join).and_return(["./spec/tempFolder"])
+    File.stub(:file?).and_return(false)
 
+    #now we must stub File.open, write and close in order to avoid fails on get_first_time_file
+    mock_file = mock("File")
+    mock_file.stub(:write).and_return(nil)
+    mock_file.stub(:close).and_return(nil)
+    File.stub(:open).and_return(mock_file)
+
+    @comparer.get_transdifflation_from_gem(@gem_name, @path_to_yaml_in_gem, @from_locale, @from_locale)
+    FileUtils.remove_dir("./spec/tempFolder").should == 0
   end
 
+  it "should create a folder in get_transdifflation_from_file when it doesn't exist" do
+    #We actually don't care about basename, and we want to generate a testfile in our tests
+    File.stub(:basename).and_return('/dir/file_or_something')
 
+    Transdifflation::YAMLReader.stub(:read_YAML_from_pathfile).and_return({en: {:home => "hogar"}})    #We require to simulate "Rails.root"
+    ::Rails.should_receive(:root).and_return('/rails')
+    File.stub(:gsub).and_return('idontcare')
+
+    File.stub(:directory?).and_return(false)
+    #File? Should return false, to simulate that the file is not created
+
+    File.stub(:join).and_return(["./spec/tempFolder"])
+    File.stub(:file?).and_return(false)
+
+    #now we must stub File.open, write and close in order to avoid fails on get_first_time_file
+    mock_file = mock("File")
+    mock_file.stub(:write).and_return(nil)
+    mock_file.stub(:close).and_return(nil)
+    File.stub(:open).and_return(mock_file)
+
+    @comparer.get_transdifflation_from_file(@gem_name, @path_to_yaml_in_gem, @from_locale, @from_locale)
+    FileUtils.remove_dir("./spec/tempFolder").should == 0
+  end
 end
 
 

data/spec/utilities_spec.rb

@@ -4,19 +4,19 @@ describe :symbolize! do
   it 'convert a key in a Hash (presumily from YAML) in symbol' do
     example_hash = { "es" => 666 }
     example_hash.symbolize!
-	example_hash.should ==  { :es => 666 }
+    example_hash.should ==  { :es => 666 }
   end
 
   it 'convert all keys in a Hash (presumily from YAML) in symbols' do
     example_hash = { "es" => 666, "lala" => "truururur" }
     example_hash.symbolize!
-	 example_hash.should ==  { :es => 666, :lala => "truururur" }
+    example_hash.should ==  { :es => 666, :lala => "truururur" }
   end
 
   it 'convert all keys in a Hash (presumily from YAML) in symbols but if there is a hash it should leave it' do
     example_hash = { :es => 666, "lala" => "truururur" }
     example_hash.symbolize!
-	 example_hash.should ==  { :es => 666, :lala => "truururur" }
+    example_hash.should ==  { :es => 666, :lala => "truururur" }
   end
 
   it 'should return something usefull on nil' do
@@ -31,4 +31,4 @@ describe :symbolize! do
     hash_translator.symbolize(example_hash)
     example_hash.should ==  { :es => 666, "lala" => "truururur", :nested => {:another => "Call for simbolize"}}
   end
-end
+end

data/spec/yaml_reader_spec.rb

@@ -26,7 +26,7 @@ describe :YAMLReader do
       File.stub(:file?).and_return(true)
       ::Rails.should_receive(:root).and_return('/rails')
 
-      
+
       expect {Transdifflation::YAMLReader.read_YAML_from_filesystem('whatever')}.to_not raise_error(ArgumentError)
     end
   end
@@ -45,8 +45,8 @@ describe :YAMLReader do
     it 'should not raise an error exception when a gem exists (rspec)' do
       a_gem = 'rspec'
       a_path = 'README.md'
-
       Transdifflation::YAMLReader.stub(:get_YAML_content_from_YAML_file).and_return(':a => 2')
+
       expect {Transdifflation::YAMLReader.read_YAML_from_gem(a_gem, a_path)}.to_not raise_error(ArgumentError)
     end
   end
@@ -73,8 +73,8 @@ describe :YAMLReader do
     it 'should return {} when there is no YAML file' do
       a_yml_path = 'bad.yml'
       YAML.stub(:load_file).and_return(false)
-      
-     Transdifflation::YAMLReader.get_YAML_content_from_YAML_file(a_yml_path).should == {}
+
+      Transdifflation::YAMLReader.get_YAML_content_from_YAML_file(a_yml_path).should == {}
     end
 
     it 'should return the YAML in case it load properly the file' do

data/spec/yaml_writer_spec.rb

@@ -15,7 +15,7 @@ describe :YAMLWriter do
 
     it 'should chomp if matches with the regex: /\?\s+/' do
       hashy = {:movie => "Avengers"}
-      Regex = "!ruby/symbol ---? \"es\"\n"   
+      Regex = "!ruby/symbol ---? \"es\"\n"
       hashy.deep_stringify_keys.stub(:send).and_return(Regex)
 
       Transdifflation::YAMLWriter.to_yaml(hashy).should be == ":\"es\""
@@ -27,7 +27,7 @@ describe :YAMLWriter do
      hashy = {:en=>{:date=>{:formats=>{:default=>"%d/%m/%Y", :short=>"%d %b"}}}}
      hashy.deep_stringify_keys.should == {:en=>{:date=>{:formats=>{:default=>"%d/%m/%Y", :short=>"%d %b"}}}}
     end
-    
+
     it 'should print all the nodes from a hash in the exact same order' do
      hashy = {:en=>{:date=>{:formats=>{:default=>"%d/%m/%Y", :short=>"%d %b"}}}}
      hashy.deep_stringify_keys.should == hashy
@@ -39,4 +39,4 @@ describe :YAMLWriter do
     end
   end
 
-end
+end

data/transdifflation.gemspec

@@ -16,7 +16,8 @@ Gem::Specification.new do |gem|
   gem.version       = Transdifflation::VERSION
 
   #Dependencies
-  gem.add_dependency 'rails', '~> 3.2.8'
+  gem.add_dependency('rails', '~> 3.2.8')
+  gem.add_dependency('ya2yaml')
 
   gem.add_development_dependency 'rspec', '>= 2.8.0'
   gem.add_development_dependency 'guard-rspec'
@@ -29,3 +30,4 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'pry'
 end
 
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transdifflation
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-19 00:00:00.000000000 Z
+date: 2012-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: ya2yaml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement