transdifflation 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Fudgefile

@@ -0,0 +1,4 @@
+build :default do
+  yard :arguments => '-r YardREADME.md', :coverage => 100
+  rspec :coverage => 96
+end

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in transdifflation.gemspec
+gemspec
+
+gem 'rails'
+
+group :development, :test do
+  gem 'fudge', :git => 'git@github.com:Sage/fudge.git'
+  gem 'rspec'
+  gem 'yard'
+  gem 'simplecov'
+
+  gem 'rspec-rails'
+  gem 'guard-sass', :require => false
+  gem 'pry'
+  gem "guard-rspec"
+  gem 'rb-fsevent', :require => false
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sage
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# 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.
+
+IT NEVER CHANGES YOUR SOURCE FILE, unless it doesn't exists, so it creates for you. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'transdifflation'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transdifflation
+
+## Usage
+
+It needs a config file (**transdifflation.yml**) placed on your host root, or in 'lib/tasks'. Config file looks like:
+
+```yml
+tasks:
+  task_name1: {
+    desc: 'Get diff translation from file config/locales/en.yml gem gem_name',
+    type: gem,
+    params: {
+      gem_name: 'gem_name',
+      path_in_gem: 'config/locales/en.yml',
+      from_locale: 'en',
+      to_locale: 'es'
+    }
+  }
+  task_name2: {
+    desc: 'Get diff translation from file config/locales/en.yml file in file_path',
+    type: file,
+    params: {
+      tag_name: 'tag_for_file',
+      file_path_from_rails_root: '../another_project/config/locales/en.yml',
+      from_locale: 'en',
+      to_locale: 'fr'
+    }
+  }
+grouped_tasks:
+  task_group_name: 
+    - task_name1
+    - task_name2
+```
+
+These nodes generates rake tasks. There are two types of tasks:
+
+*   type **gem**: When it rans, it checks where the gem 'gem_name' is installed, and looks inside the gem for the file located in 'path_in_gem'. It uses from_locale and to_locale to translate names and keys inside yaml.
+
+*   type **file**: When it rans, it looks for the file in 'file_path_from_rails_root' is installed. It uses from_locale and to_locale to translate names and keys inside yaml. Tag_name is used to name target file in our host.
+
+Execute ```rake transdifflation:config``` to determine sucess of config file.
+
+Also, you can create grouped tasks in a node called 'grouped_taks'. Task **all** is automatially generated.  
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/lib/transdifflation/exceptions.rb

@@ -0,0 +1,11 @@
+module Transdifflation
+
+  # Used when no config file is found for Transdifflation
+  class ConfigFileNotFound < ::StandardError ; end
+
+  # Used when the Transdifflation config file is in error
+  class ConfigFileWithErrors < ::StandardError ; end
+
+
+end
+

data/lib/transdifflation/railtie.rb

@@ -0,0 +1,117 @@
+require 'transdifflation'
+require 'rails'
+
+module Transdifflation
+
+  # Adds behaviours to Rails
+  class Railtie < Rails::Railtie
+    search_locations = %w[config/transdifflation.yml transdifflation.yml]
+
+    railtie_name :transdifflation
+    rake_tasks do
+      begin
+
+        file_task_config = nil
+        search_locations.each do |path| #Take config file from these locations
+          abs_path = File.expand_path(path, Rails.root)
+          if(File.exists?(abs_path))
+            file_task_config = abs_path
+            break
+          end
+        end
+
+        raise Transdifflation::ConfigFileNotFound if file_task_config.nil?
+
+        tasks_config =  YAML.load_file(file_task_config)
+        tasks_config.symbolize!
+
+        raise Transdifflation::ConfigFileWithErrors, "Transdifflation config file has no parent 'tasks' node" if tasks_config[:tasks].nil?
+
+        #Individual tasks
+        task_all = []
+        tasks_config[:tasks].each_pair do |key, value|
+
+          task_name = key.to_s
+          task_desc = value[:desc].to_s
+
+          raise Transdifflation::ConfigFileWithErrors, "Transdifflation task #{task_name}: has no type defined" if value[:type].nil?
+
+          raise Transdifflation::ConfigFileWithErrors, "Transdifflation task #{task_name}: type defined unknown (%s)" % [value[:type]] if !['gem', 'file'].include?(value[:type])
+          task_type = value[:type] == 'gem'? :gem : :file
+
+          raise Transdifflation::ConfigFileWithErrors, "Transdifflation task #{task_name}: has no params defined" if value[:params].nil?
+          params = value[:params]
+          raise Transdifflation::ConfigFileWithErrors, "Transdifflation task #{task_name}: param 'gem_name' is not defined" if params[:gem_name].nil? && task_type == :gem
+          raise Transdifflation::ConfigFileWithErrors, "Transdifflation task #{task_name}: param 'path_in_gem' is not defined" if params[:path_in_gem].nil? && task_type == :gem
+          raise Transdifflation::ConfigFileWithErrors, "Transdifflation task #{task_name}: param 'tag_name' is not defined" if params[:tag_name].nil? && task_type == :file
+          raise Transdifflation::ConfigFileWithErrors, "Transdifflation task #{task_name}: param 'file_path' is not defined" if params[:file_path_from_rails_root].nil? && task_type == :file
+
+          if(task_type == :gem)
+
+            namespace :transdifflation do
+              desc task_desc
+              task task_name do
+                puts "\nExecuting #{task_name} ************************** "
+                comparer = Transdifflation::Comparer.new
+                comparer.get_transdifflation_from_gem(params[:gem_name], params[:path_in_gem], params[:from_locale],  params[:to_locale])
+              end
+            end
+
+          else
+
+            namespace :transdifflation do
+              desc task_desc
+              task task_name do
+                puts "\nExecuting #{task_name} ************************** "
+                comparer = Transdifflation::Comparer.new
+                comparer.get_transdifflation_from_file(params[:tag_name], params[:file_path_from_rails_root], params[:from_locale],  params[:to_locale])
+              end
+            end
+          end
+          task_all.push (task_name)
+        end
+
+        #Grouped tasks
+        tasks_config[:grouped_tasks].each_pair do |key, value|
+
+          value.map! do |item|
+            item.to_sym
+          end
+
+          namespace :transdifflation do
+            desc "Task #{key} (Grouped Task)"
+            task key => value
+          end
+        end
+
+        #All tasks
+        namespace :transdifflation do
+          desc "All tasks"
+          task :all => task_all
+        end
+
+      rescue Transdifflation::ConfigFileNotFound
+       
+        #Generate task to set-up 
+        namespace :transdifflation do
+          desc "Task to set-up config file in host"
+          task :setup do
+              destination_file = File.expand_path('config/transdifflation.yml', Rails.root)
+              destination_path = File.dirname(destination_file)
+              Transdifflation::Comparer.generate_config_example_file destination_file
+              puts "\nCopied a transdifflation.yml example into '#{destination_path}'"
+          end
+        end
+
+      rescue Transdifflation::ConfigFileWithErrors => e
+
+        raise "Gem 'Transdifflation' says => #{e.message}"  
+
+      rescue Exception => e
+
+        raise "Gem 'Transdifflation' says => #{e.message}"  
+
+      end
+    end
+  end
+end

data/lib/transdifflation/transdifflation.yml

@@ -0,0 +1,33 @@
+
+#Example generating your config file:
+
+#tasks:
+#  task_name1: {
+#    desc: 'Get diff translation from file config/locales/en.yml gem gem_name',
+#    type: gem,
+#    params: {
+#      gem_name: 'gem_name',
+#      path_in_gem: 'config/locales/en.yml',
+#      from_locale: 'en',
+#      to_locale: 'es'
+#    }
+#  }
+#  task_name2: {
+#    desc: 'Get diff translation from file config/locales/en.yml file in file_path',
+#    type: file,
+#    params: {
+#      tag_name: 'tag_for_file',
+#      file_path_from_rails_root: '../another_project/config/locales/en.yml',
+#      from_locale: 'en',
+#      to_locale: 'fr'
+#    }
+#  }
+#
+#grouped_tasks:
+#  task_group_name: 
+#    - task_name1
+#    - task_name2
+#
+
+
+

data/lib/transdifflation/utilities.rb

@@ -0,0 +1,31 @@
+
+
+module Transdifflation
+
+  #Class used to convert all keys in a hash (included sub-hashes) in symbols
+  class HashSymbolTranslator
+    # Convert keys
+    def symbolize(hash)
+      hash = hash.inject({}) { |memo,(k,v)| 
+          if(v.instance_of? Hash)
+             v = symbolize(v)
+          end 
+          memo[k.to_sym] = v
+          memo
+      }
+      hash
+    end
+  end
+end
+
+class Hash
+
+  #convert all keys in a Hash (presumily from YAML) in symbols
+  def symbolize!
+    symbolizer = Transdifflation::HashSymbolTranslator.new
+    new_self = symbolizer.symbolize(self)
+    self.clear
+    self.merge!(new_self)
+  end
+
+end

data/lib/transdifflation/version.rb

@@ -0,0 +1,4 @@
+module Transdifflation
+  # Gem version
+  VERSION = "0.0.1"
+end

data/lib/transdifflation/yaml_reader.rb

@@ -0,0 +1,65 @@
+module Transdifflation
+  # Reads YAML from the specified source
+  class YAMLReader
+
+    # Get YAML content from a gem
+    #
+    # @param [String] gem_name                 Installed gem's name
+    # @param [String] file_path_to_yaml_in_gem Path of the file inside gem's source code
+    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
+      yaml_file_in_gem_SRC = File.join( gem_SRC, file_path_to_yaml_in_gem )
+      raise ArgumentError.new("File '#{file_path_to_yaml_in_gem}' does not exists in gem '#{gem_name}'") if (!File.file?(yaml_file_in_gem_SRC))
+
+      #read the yml content file
+      get_YAML_content_from_YAML_file(yaml_file_in_gem_SRC)
+     
+    end
+
+    # Get YAML content from a file in filesystem
+    #
+    # @param [String] path_to_yaml_relative_from_rails_root  Tag name this file will be intalled on host
+    def self.read_YAML_from_filesystem(path_to_yaml_relative_from_rails_root)
+
+      #get the file
+      yaml_file_path = File.realpath(path_to_yaml_relative_from_rails_root, Rails.root)
+      yaml_file_name = File.basename( yaml_file_path )
+      raise ArgumentError.new("File '#{yaml_file_name}' does not exists in path '#{yaml_file_path}'") if (!File.file?(yaml_file_path))
+
+      #read the yml content file
+      get_YAML_content_from_YAML_file(yaml_file_path)
+     
+    end
+
+    # Get YAML content from a file in filesystem
+    #
+    # @param [String] path_to_yaml  Tag name this file will be intalled on host
+    def self.read_YAML_from_pathfile(path_to_yaml)
+
+      #get the file
+      yaml_file_name = File.basename( path_to_yaml )
+      raise ArgumentError.new("File '#{yaml_file_name}' does not exists in path '#{path_to_yaml}'") if (!File.file?(path_to_yaml))
+
+      #read the yml content file
+      get_YAML_content_from_YAML_file(path_to_yaml)     
+    end
+
+    private
+
+    def self.get_YAML_content_from_YAML_file(yml_path_file)
+
+      #read the yml content file
+      yml_source_content = YAML.load_file(yml_path_file)
+      yml_source_content = {} if (yml_source_content == false)
+
+      #return
+      yml_source_content
+
+    end
+  end
+end

data/lib/transdifflation/yaml_writer.rb

@@ -0,0 +1,28 @@
+module Transdifflation
+
+  # Writes YAML
+  class YAMLWriter
+
+    #Method used to prettify generated YAML
+    def self.to_yaml(hash)
+      method = hash.respond_to?(:ya2yaml) ? :ya2yaml : :to_yaml
+      string = hash.deep_stringify_keys.send(method)
+      yaml_string = string.gsub("!ruby/symbol ", ":").sub("---","")
+      yaml_string = yaml_string.gsub(/(\?) "([\w\s\\]+)"\n/) do |match|
+        match.sub(/\?\s+/, "").chomp
+      end
+      yaml_string = yaml_string.split("\n").map(&:rstrip).join("\n").strip
+    end
+  end
+end
+
+#Method used to prettify generated YAML. Expands Hash class
+class Hash
+  # Convert keys into strings recursively
+  def deep_stringify_keys
+    new_hash = {}
+    self.each do |key, value|
+      new_hash.merge!(key.to_s => (value.is_a?(Hash) ? value.deep_stringify_keys : value))
+    end
+  end
+end

data/lib/transdifflation.rb

@@ -0,0 +1,248 @@
+require 'transdifflation/version'
+require 'transdifflation/yaml_reader'
+require 'transdifflation/yaml_writer'
+require 'transdifflation/exceptions'
+require 'transdifflation/utilities'
+
+# The main module for the program
+module Transdifflation
+
+  require 'transdifflation/railtie' if defined?(Rails) 
+
+  # Implements the core
+  class Comparer
+
+    #const string added to keys not translated
+    NOT_TRANSLATED = "**NOT_TRANSLATED** "
+    #Instance variable to get if changes have been detected
+    attr_reader :has_changes
+
+    def initialize()
+      @has_changes = false
+    end
+
+    # Get Diff from YAML translation locale file from a gem and generate differences in a file on our host
+    #
+    # @param [String] gem_name    Installed gem's name
+    # @param [String] path_to_yaml_in_gem Path of the file inside gem's source code
+    # @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 get_transdifflation_from_gem(gem_name, path_to_yaml_in_gem, from_locale=:en, to_locale=:es )
+
+      #default values in optional params
+      from_locale ||= :en
+      to_locale ||= :es   #sorry, this gem was developed in Spain :)
+
+      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
+      host_target_file = File.join( Rails.root, "config/locales/#{to_locale}", "#{gem_name}.#{host_target_filename}")
+
+      if(!File.file? host_target_file)
+        get_first_time_file(yml_gem_content, host_target_file, from_locale, to_locale)
+      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
+    # @param [String] path_to_yaml_relative_from_rails_root Path to the file in system, relative from Rails.root
+    # @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 get_transdifflation_from_file(tag_name, path_to_yaml_relative_from_rails_root, from_locale=:en, to_locale=:es )
+
+      #default values in optional params
+      from_locale ||= :en
+      to_locale ||= :es   #sorry, this gem was developed in Spain :)
+
+      yml_source_content = YAMLReader.read_YAML_from_pathfile(path_to_yaml_relative_from_rails_root)
+      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 )
+      host_target_filename = filename_in_SRC.gsub(/-?#{from_locale}\./) do |match_s|
+        match_s.sub("#{from_locale}", "#{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)
+        get_first_time_file(yml_source_content, host_target_file, from_locale, to_locale)
+      else
+        generate_diff_file(yml_source_content, host_target_file, from_locale, to_locale)
+      end
+
+      @has_changes
+    end
+
+
+
+
+
+
+    private
+
+    # Build the initial translation file
+    #
+    # @param [String] yml_source_content  Content to translate
+    # @param [String] host_target_file    The filename to create
+    # @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 get_first_time_file(yml_source_content, host_target_file, from_locale, to_locale)
+
+      puts "Target translation file '#{host_target_file}' not found, generating it for the first time"
+
+      #create a file
+      host_target_file_stream = File.open(host_target_file, "a+:UTF-8")
+
+      begin
+
+        translated_yaml = {}
+        #translate from source yaml content, to target existant yml
+        translate_keys_in_same_yaml(yml_source_content, translated_yaml, from_locale, to_locale)
+
+        host_target_file_stream.write(YAMLWriter.to_yaml(translated_yaml))
+        @has_changes = true
+      ensure
+
+        host_target_file_stream.close
+      end
+
+    end
+
+
+    # Recursively translate hash from YAML file
+    #
+    # @param [Hash]   source      Hash from origin YAML file
+    # @param [Hash]   target      Hash from target YAML file
+    # @param [Symbol] from_locale Locale used to translate 'from'
+    # @param [Symbol] to_locale   Locale used to translate 'to'
+    # @param [Boolean] add_NOT_TRANSLATED   Boolean to set if it should add "**NOT_TRANSLATED** " to value (default = true)
+    def translate_keys_in_same_yaml(source, target, from_locale, to_locale, add_NOT_TRANSLATED=true)
+
+      source.each_pair { |source_key, source_value|
+
+        key_is_symbol = source_key.instance_of? Symbol
+
+        source_key_translated = source_key.to_s.sub(/^#{from_locale}$/, "#{to_locale}")
+        source_key_translated = source_key_translated.to_sym if key_is_symbol
+
+        #if value is a hash, we call it recursively
+        if (source_value.instance_of? Hash)
+
+          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)
+        end
+      }
+    end
+
+    def generate_diff_file(yml_source_content, host_target_file, from_locale, to_locale)
+
+      existant_yml = YAMLReader.read_YAML_from_pathfile(host_target_file)
+      added_diff_hash, removed_diff_hash = Hash.new, Hash.new
+
+      generate_added_diff(yml_source_content, existant_yml, added_diff_hash, Array.new, from_locale, to_locale)
+      generate_added_diff(existant_yml, yml_source_content, removed_diff_hash, Array.new,  to_locale, from_locale, false)
+
+      if (removed_diff_hash.length > 0)
+        #we have to reprocess hash to show user what happened
+        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
+          end
+
+          if (removed_diff_hash.length > 0)
+            diff_file_stream.write("\n\n") if (added_diff_hash.length > 0)
+            diff_file_stream.write("REMOVED KEYS (Keys not found in source file, founded in your file) ********************\n")
+            diff_file_stream.write(YAMLWriter.to_yaml(removed_diff_hash))  #we can't use YAML#dump due to issues wuth Utf8 chars
+          end
+
+        ensure
+          diff_file_stream.close
+        end
+        puts "File #{File.basename( host_target_file )} processed >> %s" %  [ "#{File.basename( diff_file )} has the changes!"]
+        @has_changes = true
+      else 
+        puts "File #{File.basename( host_target_file )} processed >> No changes!"
+      end
+    end
+
+
+    # Recursively generate difference hash from YAML file
+    #
+    # @param [Hash]   source           Hash from origin YAML file
+    # @param [Hash]   target           Hash from target YAML file
+    # @param [Hash]   added_diff_hash  Hash containing differences; at the first time, it should be empty
+    # @param [Array]  key_trace_passed Array containing trace of the key generated, recursively. At the first time, it should be empty
+    # @param [Symbol] from_locale      Default locale in gem. Used to translate 'from'
+    # @param [Symbol] to_locale        Default locale in host. Used to translate 'to'
+    # @param [Boolean] add_NOT_TRANSLATED   Boolean to set if it should add "**NOT_TRANSLATED** " to value (default = true)
+    # @return [Hash] the resulting hash translated
+    def generate_added_diff(source, target, added_diff_hash, key_trace_passed, from_locale, to_locale, add_NOT_TRANSLATED=true)
+
+      source.each_pair { |source_key, source_value|
+        key_trace = key_trace_passed.dup #each pair should have a clear copy of the same array
+        key_is_symbol = source_key.instance_of? Symbol
+        source_key_translated = source_key.to_s.sub(/^#{from_locale}$/, "#{to_locale}")
+        source_key_translated = source_key_translated.to_sym if key_is_symbol
+
+        #if value is a hash, we call it recursively
+        if (source_value.instance_of? Hash)
+          key_trace.push source_key_translated #add the key to the trace to be generated if necessary
+          target[source_key_translated] = Hash.new if(!target.has_key? (source_key_translated))  #to continue trace, otherwise, node will not exist in next iteration
+          generate_added_diff(source_value, target[source_key_translated], added_diff_hash, key_trace, from_locale, to_locale) #recursively call
+        else #it's a leaf node
+
+          if !target.has_key? (source_key_translated)
+            added_diff_hash_positioned = added_diff_hash #pointer to added_diff_hash
+            key_trace.each do |key|  #add the keys if necessary on the accurate level
+              added_diff_hash_positioned [key] = Hash.new if(!added_diff_hash_positioned.has_key? key )
+              added_diff_hash_positioned = added_diff_hash_positioned [key] #and position pointer to next level
+            end
+            added_diff_hash_positioned[source_key_translated] = (add_NOT_TRANSLATED ? "#{NOT_TRANSLATED}#{source_value}" : "#{source_value}")    #add the inexistant key
+          end
+        end
+      }
+    end
+
+   
+
+
+
+    def self.generate_config_example_file(path)
+      FileUtils.copy(File.expand_path('./transdifflation/transdifflation.yml', File.dirname( __FILE__ )), path)
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'simplecov'
+SimpleCov.start do
+  add_filter "spec/"
+end
+
+require 'transdifflation/version'
+require 'transdifflation/yaml_reader'
+require 'transdifflation/yaml_writer'
+require 'transdifflation/exceptions'
+require 'transdifflation/utilities'
+require 'yaml'
+
+
+RSpec.configure do |config|
+  # some (optional) config here
+
+end

data/spec/transdifflation_spec.rb

@@ -0,0 +1,20 @@
+# require 'spec_helper'
+# require 'transdifflation' 
+
+#describe :get_transdifflation_from_gem do
+#  it 'convert a key in a Hash (presumily from YAML) in symbol' do
+#    gem_name = 'rake'
+#    path_to_yaml_in_gem = '.'
+#    from_locale= :en
+#    to_locale = :es
+#    Transdifflation::Comparer 
+#  end
+#  xit 'another test' do
+
+
+# end
+
+
+
+
+# end

data/spec/utilities_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+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 }
+  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" }
+  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" }
+  end
+
+  it 'should return something usefull on nil' do
+    example_hash = Hash.new
+    example_hash.symbolize!
+	example_hash.should ==  {}
+  end
+end

data/spec/yaml_reader_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+
+describe :YAMLReader do
+
+  before(:each) do
+    unless defined?(::Rails)
+      @mocked_rails_class = true
+      class ::Rails
+      end
+    end
+  end
+  describe :read_YAML_from_filesystem do
+    it 'should raise an error exception when read_YAML_from_filesystem get nil as an argument' do
+      File.stub(:basename).and_return(nil)
+      File.stub(:realpath).and_return('/')
+      ::Rails.should_receive(:root).and_return('/rails')
+
+      expect {Transdifflation::YAMLReader.read_YAML_from_filesystem('whatever')}.to raise_error(ArgumentError)
+    end
+
+    it 'should not raise an error if the file exists at read_YAML_from_filesystem' do
+      File.stub(:basename).and_return(nil)
+      File.stub(:realpath).and_return('/')
+      # Stubbing File to make it exist
+      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
+
+  describe :read_YAML_from_gem do
+    it 'should raise an error exception when a gem does not exist' do
+      File.stub(:join).and_return(nil)
+      File.stub(:file?).and_return(true)
+
+      a_gem = 'one_random_gem'
+      a_path = './'
+
+      expect {Transdifflation::YAMLReader.read_YAML_from_gem(a_gem, a_path)}.to raise_error(ArgumentError)
+    end
+
+    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
+
+  describe :read_YAML_from_pathfile do
+    it 'should raise an error exception when a path does not exist' do
+      File.stub(:file?).and_return(false)
+      a_path = './'
+
+      expect {Transdifflation::YAMLReader.read_YAML_from_pathfile(a_path)}.to raise_error(ArgumentError)
+    end
+
+    it 'should not raise an error exception when a path exists (rspec)' do
+      File.stub(:basename).and_return(nil)
+      File.stub(:file?).and_return(true)
+      a_path = 'README.md'
+
+      Transdifflation::YAMLReader.stub(:get_YAML_content_from_YAML_file).and_return(':a => 2')
+      expect {Transdifflation::YAMLReader.read_YAML_from_pathfile(a_path)}.to_not raise_error(ArgumentError)
+    end
+  end
+
+  describe :get_YAML_content_from_YAML_file 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 == {}
+    end
+
+    it 'should return the YAML in case it load properly the file' do
+      a_yml_path = 'good.yml'
+      YAML.stub(:load_file).and_return(['badger', 'elephant', 'tiger'])
+
+      Transdifflation::YAMLReader.get_YAML_content_from_YAML_file(a_yml_path).should == ['badger', 'elephant', 'tiger']
+    end
+  end
+
+end

data/spec/yaml_writer_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+
+describe :YAMLWriter do
+  describe :to_yaml do
+    it 'should convert to ya2yaml format an input hash' do
+      hashy = {:en=>{:date=>{:formats=>{:default=>"%d/%m/%Y", :short=>"%d %b"}}}}
+      Transdifflation::YAMLWriter.to_yaml(hashy).should be == ":en:\n  :date:\n    :formats:\n      :default: ! '%d/%m/%Y'\n      :short: ! '%d %b'"
+    end
+
+    it 'should convert to ya2yaml format with just one term' do
+      hashy = {:movie => "Avengers"}
+      Transdifflation::YAMLWriter.to_yaml(hashy).should be == ":movie: Avengers"
+    end
+  end
+
+  describe :deep_stringify_keys do
+    it 'should not change anything printing the hash exactly how it is' 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
+    end
+  end
+
+end

data/transdifflation.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/transdifflation/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Steve Belicha & Javier Mey"]
+  gem.email         = ["steve.belicha@sage.com; javier.mey@sage.com"]
+  gem.description   = %q{Compares yml locate files with yours and generate diff files to maintain gems or adjacent projects }
+  gem.summary       = %q{Compares yml locate files with yours and generate diff files to maintain gems or adjacent projects}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "transdifflation"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.1"
+
+  #Dependencies
+  gem.add_dependency 'rails', '~> 3.2.8'
+
+  gem.add_development_dependency 'rspec', '>= 2.8.0'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'redcarpet'
+  gem.add_development_dependency 'RedCloth'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'rb-inotify'
+  gem.add_development_dependency 'libnotify'
+  gem.add_development_dependency 'pry'
+end
+

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification
+name: transdifflation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Steve Belicha & Javier Mey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: libnotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Compares yml locate files with yours and generate diff files to maintain
+  gems or adjacent projects '
+email:
+- steve.belicha@sage.com; javier.mey@sage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Fudgefile
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/transdifflation.rb
+- lib/transdifflation/exceptions.rb
+- lib/transdifflation/railtie.rb
+- lib/transdifflation/transdifflation.yml
+- lib/transdifflation/utilities.rb
+- lib/transdifflation/version.rb
+- lib/transdifflation/yaml_reader.rb
+- lib/transdifflation/yaml_writer.rb
+- spec/spec_helper.rb
+- spec/transdifflation_spec.rb
+- spec/utilities_spec.rb
+- spec/yaml_reader_spec.rb
+- spec/yaml_writer_spec.rb
+- transdifflation.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Compares yml locate files with yours and generate diff files to maintain
+  gems or adjacent projects
+test_files:
+- spec/spec_helper.rb
+- spec/transdifflation_spec.rb
+- spec/utilities_spec.rb
+- spec/yaml_reader_spec.rb
+- spec/yaml_writer_spec.rb
+has_rdoc: