i18n_kit 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "nokogiri"
+gem "ya2yaml"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.4.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ya2yaml (0.30)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  nokogiri
+  rcov
+  rspec (~> 2.3.0)
+  ya2yaml

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 funkensturm.
+
+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.textile

@@ -0,0 +1,145 @@
+h2. I18nKit
+
+You can import XML files that were exported using Excel, or standard i18n hierarchical YML files. Both will be normalized as I18nKit::Document objects so that they can be compared with each other. You need implement the comparison method yourself, however. I18nKit only provides the Iterator.
+
+h3. Importing
+
+Say you have an Excel file like this
+
+<pre>
+  1   | key                       | english        | swedish      | german           | comments |
+  2   | customer.invoice.create   | Create invoice | Skapa intyg  | Rechnung anlegen |          |
+  3   | customer.invoice.delete   | Delete invoice | Radera intyg | Rechnung löschen | Wow...   |
+</pre>
+
+and you export it as XML. Then you can import it with I18nKit like this:
+
+<pre>
+  require 'i18n_kit'
+  documents = I18nKit::Importer::ExcelXML.new('my_export.xml').parse
+  
+  # Or use the shortcut:
+  documents = I18nKit.import_excel("'my_export.xml')
+</pre>
+
+you could also pass the file as a String:
+
+<pre>
+  documents = I18nKit::Importer::ExcelXML.new(File.read('my_export.xml')).parse
+</pre>
+
+The first row will be used to identify the locale language. Note that there are more options for how to import Excel files depending on whether there is a headline or not. Or whether you want to import only the first X columns, like so:
+
+<pre>
+  importer = I18nKit::Importer::ExcelXML.new(XML_PATH, :ignore_headline => true, :locales => [:sv, :en, :fi])
+</pre>
+
+That will ignore the last column (comments) and use "sv" instead of "swedish", for example.
+
+At any rate, @documents@ will hold an Array of @I18nKit::Document@ objects. Each representing one language. You might want to give them names so that you can compare them better later:
+
+<pre>
+  documents[0] = 'Excel: English'
+  documents[1] = 'Excel: Swedish'
+  documents[2] = 'Excel: German'
+  
+  # Note: By default they're called :excel_en, :excel_sv, etc...
+</pre>
+
+Now let's import a YML file from your Rails project:
+
+<pre>
+  more_documents         = I18nKit::Importer::YAML.new('config/locales/fi.yml').parse
+  more_documents[0].name = 'My Rails App: Finnish'
+  
+  # Or just use the shortcut:
+  I18nKit.import_yaml("config/locales/fi.yml")
+  
+  # Note: The default document name is: :yaml_fi
+</pre>
+
+What can you do with a @I18nKit::Document@ entity? If you used the Excel import, then you have e.g. these instance methods:
+
+<pre>
+  document.name            =>  'Excel: German'
+  document.locale          =>  'de'
+  document.to_flat_hash    =>  { 'customer.invoice.create' => 'Rechnung anlegen', 
+                                 'customer.invoice.delete' => 'Rechnung löschen' }
+  document.keys            =>  ['customer.invoice.create', 'customer.invoice.delete']
+</pre>
+
+You can do the same with files imported from YML, but additionally you have:
+
+<pre>
+  document.to_hierarchical_hash   =>  { 'customer' => { 'invoice' => { 'create' => 'Rechnung anlegen', etc... } } }
+  document.to_i18n_hash           =>  { 'de' => { 'customer' => { 'invoice' => { etc... } } }
+  
+  # You can even access and update values directly:
+  
+  document['customer.invoice.create'] => 'Rechnung anlegen'
+  document['customer.invoice.create'] = 'New Value'
+  
+  document.write_i18n_file('path/to/output_file.yml')
+</pre>
+
+As you may notice, the whole idea is to update a Rails app according to a Excel file that is out-of-sync. In the future there could be lots more handy features, but for now, you can perform some good deal of tasks a lot easier than manually. For instance, you could quickly compare two YML I18n files with each other and automate some synchronization.
+
+@I18nKit:Comparer@ will compare each @I18nKit::Document@ with each document:
+
+<pre>
+  # Loading an Excel file and a YML file
+  documents = ::I18nKit::Importer::ExcelXML.new(XML_PATH, :ignore_headline => true, :locales => [:sv, :en, :fi]).parse + 
+              ::I18nKit::Importer::YAML.new(YML_FI_HIERARCHICAL_PATH).parse
+              
+  # Giving the Documents smart names
+  documents[0].name = 'First'
+  documents[1].name = 'Second'
+  documents[2].name = 'Third'
+  documents[3].name = 'Fourth'
+  
+  # Load the comparer
+  comparer = I18nKit::Comparer.new(documents)
+  
+  # Iterate the comparison
+  comparer.documents_to_compare.each do |left, right|
+    puts "#{left.name} <=> #{right.name}"
+  end
+</pre>
+
+will output:
+
+<pre>
+  First  <=> Second
+  First  <=> Third
+  First  <=> Fourth
+  Second <=> Third
+  Second <=> Fourth
+  Third  <=> Fourth
+</pre>
+
+You can also access individual documents by their name by using [] on the Comparer:
+
+<pre>
+  comparer[:excel_sv].keys.each do |key|
+    if comparer[:yaml_sv].has_key?(key)
+      # Do something because :excel_sv has a key that also exists in :yaml_sv
+    end
+  end
+</pre>
+
+Of course you can then compare them as you wish and merge them in some specific way (depending on your needs).
+
+h3. Development
+
+Fork the i18n_kit project from Github and run the tests with
+
+<pre>
+  bundle install
+  rake spec
+</pre>
+
+h4. Copyright
+
+External library in @lib/yamlator.rb@: YAMLator by Henrik Nyh "http://henrik.nyh.se":http://henrik.nyh.se 2010-02-03 under the MIT license.
+
+All other files are as well free for all under the MIT license. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "i18n_kit"
+  gem.homepage = "http://github.com/funkensturm/i18n_kit"
+  gem.license = "MIT"
+  gem.summary = %Q{A small tool to import I18n files from Excel and YML and compare them}
+  gem.description = %Q{You can import XML files that were exported using Excel, or standard i18n hierarchical YML files. Both will be normalized as I18nKit::Document objects so that they can be compared with each other. You need implement the comparison method yourself, however. I18nKit only provides the Iterator. )}
+  gem.email = "commanda.keen@gmail.com"
+  gem.authors = ["funkensturm."]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "i18n_kit #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/i18n_kit.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{i18n_kit}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["funkensturm."]
+  s.date = %q{2011-06-07}
+  s.description = %q{You can import XML files that were exported using Excel, or standard i18n hierarchical YML files. Both will be normalized as I18nKit::Document objects so that they can be compared with each other. You need implement the comparison method yourself, however. I18nKit only provides the Iterator. )}
+  s.email = %q{commanda.keen@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.textile"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.textile",
+    "Rakefile",
+    "VERSION",
+    "i18n_kit.gemspec",
+    "lib/i18n_kit.rb",
+    "lib/i18n_kit/comparer.rb",
+    "lib/i18n_kit/document.rb",
+    "lib/i18n_kit/importer.rb",
+    "lib/i18n_kit/importer/excel_xml.rb",
+    "lib/i18n_kit/importer/yaml.rb",
+    "lib/yamlator.rb",
+    "spec/assets/excel_export.xml",
+    "spec/assets/fi_hierarchical.yml",
+    "spec/compare_spec.rb",
+    "spec/document_spec.rb",
+    "spec/importer_excel_xml_spec.rb",
+    "spec/importer_yml_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/funkensturm/i18n_kit}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.3}
+  s.summary = %q{A small tool to import I18n files from Excel and YML and compare them}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<ya2yaml>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<ya2yaml>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<ya2yaml>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/i18n_kit/comparer.rb

@@ -0,0 +1,41 @@
+require 'i18n_kit/importer'
+require 'i18n_kit/document'
+require 'yamlator'
+
+module I18nKit
+  class Comparer
+    attr_accessor :documents
+
+    def initialize(documents)
+      @documents = documents
+    end
+
+    def [](document_name)
+      @documents.each { |doc| return doc if doc.name == document_name }
+      nil
+    end
+
+    def compare
+      documents_to_compare.each do |left, right|
+        #puts "#{left.name} <=> #{right.name}"
+      end
+    end
+
+    def documents_to_compare(&block)
+      docs = @documents.dup
+      pairs = []
+      while base = docs.shift do
+        docs.each do |doc|
+          #break if doc == docs.last
+          if block_given?
+            yield(base, doc)
+          else
+            pairs << [base, doc]
+          end
+        end
+      end
+      pairs
+    end
+
+  end
+end

data/lib/i18n_kit/document.rb

@@ -0,0 +1,100 @@
+require "ya2yaml"  # Dumps with unescaped UTF-8.
+require 'pp'
+
+module I18nKit
+  class Document
+    attr_accessor :locale, :name
+    
+    def initialize(opts={})
+      @name = opts.fetch(:name, :undefined)
+      # Each Document can only have one locale
+      @locale = opts.fetch(:locale, :undefined)
+      # This is the hierarchical format that is commonly used in standard I18n
+      # Note that the root node (i.e. 'en') is *not* supposed to be included
+      @hash = opts.fetch(:hash, {})
+      # This is a flattened version of the hierarchical hash
+      # There is again no locale at the beginning of the keys (i.e. 'one.two' instead of 'en.one.two')
+      @flat_hash = if opts.has_key?(:flat_hash)
+        opts[:flat_hash]
+      else
+        {}
+      end
+      self
+    end
+    
+    def []=(key, value)
+      yamlator = YAMLator.new(@hash)
+      yamlator[key] = value
+      @hash = yamlator.hash
+      @flat_hash = {}
+    end
+    
+    def [](chain)
+      to_flat_hash[chain]
+    end
+    
+    def has_key?(key)
+      to_flat_hash.has_key?(key)
+    end
+    
+    def keys
+      to_flat_hash.keys
+    end
+
+    def values
+      to_flat_hash.values
+    end
+    
+    # Without locale name as root
+    def to_hierarchical_hash
+      @hash
+    end
+    
+    # With locale name as root
+    def to_i18n_hash
+      { @locale => @hash }
+    end
+    
+    def to_i18n_yaml
+      to_i18n_hash.ya2yaml
+    end
+    
+    def write_i18n_file(path)
+      File.open(path, 'w') do |file|
+        file.write to_i18n_yaml
+      end
+    end
+    
+    def to_flat_hash
+      # On demand flattening
+      populate_flat_hash(@hash) if @flat_hash.size == 0 and @hash.size > 1
+      @flat_hash
+    end
+    
+    def to_flat_yaml
+      to_flat_hash.ya2yaml
+    end
+    
+    def to_s
+      @name
+    end
+    
+    protected
+    
+    def populate_flat_hash(data, root=[])
+      data.each do |key, value|
+        if value.is_a?(Hash)
+          new_root = root + [key]
+          populate_flat_hash(value, new_root)
+        else
+          data.each do |k, v|
+            flat_key = [root] + [k]
+            @flat_hash[flat_key.join('.')] = v
+          end
+          return
+        end
+      end
+    end
+    
+  end
+end

data/lib/i18n_kit/importer/excel_xml.rb

@@ -0,0 +1,63 @@
+require 'i18n_kit/document'
+require 'nokogiri'
+
+module I18nKit
+  module Importer
+    class ExcelXML
+      attr_accessor :locales, :nokodoc, :ignore_headline
+      attr_reader :path_or_string, :hash
+      
+      def initialize(path_or_string, opts={})
+        @path_or_string = path_or_string
+        @locales = opts.fetch(:locales, [])
+        @ignore_headline = opts.fetch(:ignore_headline, false)
+        @nokodoc = if File.file?(@path_or_string)
+          Nokogiri::XML(File.open(@path_or_string))
+        else
+          Nokogiri::XML(@path_or_string)
+        end
+        @result = {}
+        self
+      end
+      
+      # This method uses Nokogiri to parse the XML data
+      def parse
+        # First, we're loading all Rows of the sheet
+        @nokodoc.css('Row').each_with_index do |row, row_index|
+          # In each row, we load the columns (i.e. row cells)
+          columns = row.css('Cell > Data') 
+          # We skip empty rows (i.e. rows with no or just one column)
+          next unless columns.size > 1
+          # The first row might be a header column containing the names of the columns
+          # In case the locales are unknown and we're in the header row, let's derive the locales from this header row
+          next if @ignore_headline && row_index == 0
+          if @locales == [] && row_index == 0
+            # Going through the cells of the header row
+            columns.each_with_index do |column, column_index|
+              # The first column is expected to contain the key, all others we interpret as locale name
+              @locales << column.text.to_sym unless column_index == 0
+            end
+          else
+            # This is every row except the header row
+            # The key is expected to be in the first column
+            key = columns[0].text
+            # Now let's read the translations for this key. I.e. all columns except the first one
+            locales.each_with_index do |locale, locale_index|
+              locale = locale.to_s
+              @result[locale] ||= {}
+              @result[locale][key] = (columns[locale_index+1] == nil ? '' : columns[locale_index+1].text)
+            end
+          end
+        end
+
+        documents = []
+        @result.each { |locale, hash|
+          documents << ::I18nKit::Document.new(:locale => locale, :flat_hash => hash)
+          documents.last.name = "excel_#{locale}".to_sym
+        }
+        documents
+      end
+      
+    end
+  end
+end

data/lib/i18n_kit/importer/yaml.rb

@@ -0,0 +1,24 @@
+require 'i18n_kit/document'
+require 'yaml'
+
+module I18nKit
+  module Importer
+    class YAML
+      attr_reader :hash, :locale
+      
+      def initialize(path_or_string, opts={})
+        raw = File.file?(path_or_string) ? File.read(path_or_string) : path_or_string
+        @hash = ::YAML.load(raw)
+        @locale = @hash.keys.first
+        @name = "yaml_#{@locale}".to_sym
+        @hash = @hash.values.first # Removing the root node
+        self
+      end
+      
+      def parse
+        [::I18nKit::Document.new :locale => @locale, :hash => @hash, :name => @name]
+      end
+      
+    end
+  end
+end

data/lib/i18n_kit/importer.rb

@@ -0,0 +1,14 @@
+require 'i18n_kit/importer/excel_xml'
+require 'i18n_kit/importer/yaml'
+
+module I18nKit
+  
+  def self.import_excel(*args)
+    Importer::ExcelXML.new(*args).parse
+  end
+  
+  def self.import_yaml(*args)
+    Importer::YAML.new(*args).parse
+  end
+  
+end

data/lib/i18n_kit.rb

@@ -0,0 +1,5 @@
+# "External" dependencies
+require 'yamlator'
+
+# Loading all files in the subdirectory `i18n_kit´
+Dir[File.join(File.dirname(__FILE__), 'i18n_kit', '*.rb')].sort.each { |path| require "i18n_kit/#{File.basename(path, '.rb')}" }

data/lib/yamlator.rb

@@ -0,0 +1,60 @@
+# YAMLator by Henrik Nyh <http://henrik.nyh.se> 2010-02-03 under the MIT license.
+# Helps you update Rails i18n YAML files programmatically, to be used e.g. for
+# editor extraction tools.
+
+$KCODE = 'u'
+
+require "yaml"
+require "rubygems"
+require "ya2yaml"  # Dumps with unescaped UTF-8.
+
+class YAMLator
+  attr_reader :hash
+
+  def initialize(hash)
+    #@data = File.file?(path_or_string) ? File.read(path_or_string) : path_or_string
+    @hash = hash
+  end
+
+  def to_yaml
+    #[preamble, yaml].join
+    yaml
+  end
+
+  def []=(key, value)
+    chain = key.split('.')
+    this_hash = @hash
+    chain.each_with_index do |part, index|
+      is_last = index==chain.length-1
+      key_this_far = chain[0..index].join('.')
+
+      case this_hash[part]
+      when Hash
+        raise("trying to add a string to a hash key in use: #{key_this_far.inspect}") if is_last
+      # Uncomment the following two lines if you would like to prevent overwriting existing keys
+      #when String
+      #  raise("trying to add to a string key in use: #{key_this_far.inspect}")
+      else
+        this_hash[part] = is_last ? value : {}
+      end
+      this_hash = this_hash[part]
+    end
+    value
+  end
+
+private
+
+  # Comments and blank lines in the beginning of the file.
+  def preamble
+    #@data[/\A(\s*(#.*?)?\n)+/]
+  end
+
+  def yaml
+    @hash.ya2yaml
+  end
+  
+end
+
+#y = YAMLator.new(DATA)
+#y['sv.some.foo.bar.baz'] = "boink"
+#puts y.to_yaml

data/spec/assets/excel_export.xml

@@ -0,0 +1,190 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?mso-application progid="Excel.Sheet"?>
+
+<Workbook xmlns:c="urn:schemas-microsoft-com:office:component:spreadsheet" xmlns:html="http://www.w3.org/TR/REC-html40" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:schemas-microsoft-com:office:spreadsheet" xmlns:x2="http://schemas.microsoft.com/office/excel/2003/xml" xmlns:ss="urn:schemas-microsoft-com:office:spreadsheet" xmlns:x="urn:schemas-microsoft-com:office:excel">
+
+  <OfficeDocumentSettings xmlns="urn:schemas-microsoft-com:office:office">
+    <Colors>
+      <Color>
+        <Index>3</Index>
+        <RGB>#c0c0c0</RGB>
+      </Color>
+      <Color>
+        <Index>4</Index>
+        <RGB>#dd0806</RGB>
+      </Color>
+      <Color>
+        <Index>5</Index>
+        <RGB>#ff0000</RGB>
+      </Color>
+    </Colors>
+  </OfficeDocumentSettings>
+    
+  <ExcelWorkbook xmlns="urn:schemas-microsoft-com:office:excel">
+    <WindowHeight>9000</WindowHeight>
+    <WindowWidth>13860</WindowWidth>
+    <WindowTopX>240</WindowTopX>
+    <WindowTopY>75</WindowTopY>
+    <ProtectStructure>False</ProtectStructure>
+    <ProtectWindows>False</ProtectWindows>
+  </ExcelWorkbook>
+  
+  <Styles>
+    <Style ss:ID="Default" ss:Name="Default">
+      <Font ss:FontName="Arial1"/>
+    </Style>
+    <Style ss:ID="Result" ss:Name="Result">
+      <Font ss:Bold="1" ss:FontName="Arial1" ss:Italic="1" ss:Underline="Single"/>
+    </Style>
+    <Style ss:ID="Result2" ss:Name="Result2">
+      <Font ss:Bold="1" ss:FontName="Arial1" ss:Italic="1" ss:Underline="Single"/>
+      <NumberFormat ss:Format="Currency"/>
+    </Style>
+    <Style ss:ID="Heading" ss:Name="Heading">
+      <Font ss:Bold="1" ss:FontName="Arial1" ss:Italic="1" ss:Size="16"/>
+    </Style>
+    <Style ss:ID="Heading1" ss:Name="Heading1">
+      <Alignment ss:Rotate="90"/>
+      <Font ss:Bold="1" ss:FontName="Arial1" ss:Italic="1" ss:Size="16"/>
+    </Style>
+    <Style ss:ID="co1"/>
+    <Style ss:ID="co2"/>
+    <Style ss:ID="co3"/>
+    <Style ss:ID="co4"/>
+    <Style ss:ID="co5"/>
+    <Style ss:ID="ta1"/>
+    <Style ss:ID="ce1">
+      <Font ss:Bold="1" ss:FontName="Arial2" ss:Size="10"/>
+      <NumberFormat ss:Format="General"/>
+    </Style>
+    <Style ss:ID="ce2">
+      <Font ss:FontName="Arial1" ss:Size="10"/>
+      <NumberFormat ss:Format="General"/>
+    </Style>
+    <Style ss:ID="ce3">
+      <Alignment ss:Vertical="Automatic" ss:WrapText="1" ss:Indent="0" ss:Rotate="0"/>
+      <Font ss:Bold="1" ss:FontName="Arial2" ss:Size="10"/>
+      <NumberFormat ss:Format="General"/>
+    </Style>
+    <Style ss:ID="ce4">
+      <Alignment ss:Vertical="Automatic" ss:WrapText="1" ss:Indent="0" ss:Rotate="0"/>
+      <Font ss:FontName="Arial1" ss:Size="10"/>
+      <NumberFormat ss:Format="General"/>
+    </Style>
+    <Style ss:ID="ce5">
+      <Alignment ss:Vertical="Automatic" ss:WrapText="1" ss:Indent="0" ss:Rotate="0"/>
+    </Style>
+    <Style ss:ID="ce6">
+      <Alignment ss:Vertical="Automatic" ss:WrapText="1" ss:Indent="0" ss:Rotate="0"/>
+      <Font ss:Color="#dd0806" ss:FontName="Arial1" ss:Size="10"/>
+      <NumberFormat ss:Format="General"/>
+    </Style>
+    <Style ss:ID="ce7">
+      <Font ss:Bold="1" ss:Color="#dd0806" ss:FontName="Arial1" ss:Size="10"/>
+      <NumberFormat ss:Format="General"/>
+    </Style>
+    <Style ss:ID="ce8">
+      <Font ss:Color="#dd0806" ss:FontName="Arial1" ss:Size="10"/>
+    </Style>
+    <Style ss:ID="ce9">
+      <Font ss:Color="#dd0806" ss:FontName="Arial1" ss:Size="10"/>
+      <NumberFormat ss:Format="General"/>
+    </Style>
+    <Style ss:ID="ta_extref"/>
+    <Style ss:ID="T1">
+      <Font ss:Color="#dd0806" ss:FontName="Arial1" ss:Size="10" ss:VerticalAlign="Subscript"/>
+    </Style>
+    <Style ss:ID="T2">
+      <Font ss:FontName="Arial1" ss:Size="10" ss:VerticalAlign="Subscript"/>
+    </Style>
+    <Style ss:ID="T3">
+      <Font ss:FontName="Times New Roman" ss:Size="12" ss:VerticalAlign="Subscript"/>
+    </Style>
+  </Styles>
+  
+  <ss:Worksheet ss:Name="Translations">
+
+    <Table ss:StyleID="ta1">
+      <Column ss:Width="232.1568"/>
+      <Column ss:Width="232.1568"/>
+      <Column ss:Width="199.8144"/>
+      <Column ss:Width="285.8472"/>
+      <Column ss:Width="171.1008"/>
+      <Column ss:Span="1018" ss:Width="63.8352"/>
+    
+      <Row ss:Height="11.988">
+        <Cell ss:StyleID="ce1">
+          <Data ss:Type="String">nyckel</Data>
+        </Cell>
+        <Cell ss:StyleID="ce3">
+          <Data ss:Type="String">svenska</Data>
+        </Cell>
+        <Cell ss:StyleID="ce3">
+          <Data ss:Type="String">engelska</Data>
+        </Cell>
+        <Cell ss:StyleID="ce3">
+          <Data ss:Type="String">finska</Data>
+        </Cell>
+        <Cell ss:StyleID="ce7">
+          <Data ss:Type="String">GM Kommentar</Data>
+        </Cell>
+        <Cell ss:Index="1024"/>
+      </Row>
+        
+      <Row ss:Height="11.988">
+        <Cell ss:StyleID="ce2">
+          <Data ss:Type="String">base_helper.all</Data>
+        </Cell>
+        <Cell ss:StyleID="ce4">
+          <Data ss:Type="String">Alla</Data>
+        </Cell>
+        <Cell ss:StyleID="ce4">
+          <Data ss:Type="String">All</Data>
+        </Cell>
+        <Cell ss:StyleID="ce4">
+          <Data ss:Type="String">Kaikki</Data>
+        </Cell>
+        <Cell ss:Index="1024"/>
+      </Row>
+      
+      <Row ss:Height="11.988">
+        <Cell ss:StyleID="ce2">
+          <Data ss:Type="String">base_helper.time_left</Data>
+        </Cell>
+        <Cell ss:StyleID="ce4">
+          <Data ss:Type="String">%{time} kvar</Data>
+        </Cell>
+        <Cell ss:StyleID="ce4">
+          <Data ss:Type="String">%{time} left</Data>
+        </Cell>
+        <Cell ss:StyleID="ce4">
+          <Data ss:Type="String">%{time} jäljellä</Data>
+        </Cell>
+        <Cell ss:Index="1024"/>
+      </Row>
+
+      <Row ss:Height="11.988">
+        <Cell ss:StyleID="ce2">
+          <Data ss:Type="String">support.select.prompt</Data>
+        </Cell>
+        <Cell ss:StyleID="ce4">
+          <Data ss:Type="String">Välj</Data>
+        </Cell>
+        <Cell ss:StyleID="ce4">
+          <Data ss:Type="String">Please select</Data>
+        </Cell>
+        <Cell ss:StyleID="ce4">
+          <Data ss:Type="String">Valitse</Data>
+        </Cell>
+        <Cell ss:StyleID="ce4">
+          <Data ss:Type="String">This is a comment</Data>
+        </Cell>
+        <Cell ss:Index="1024"/>
+      </Row>
+
+    </Table>
+
+    <x:WorksheetOptions/>
+
+  </ss:Worksheet>
+</Workbook>

data/spec/assets/fi_hierarchical.yml

@@ -0,0 +1,22 @@
+fi:
+  activerecord:
+    attributes:
+      account:
+        account_type: "Pankkitilin tyyppi"
+        number: Tilinumero
+      auction:
+        estimate: Lähtöhinta
+        estimate_upper: "Lähtöhinta alkaen"
+        reserve_price: Pohjahinta
+  percentage_fee:
+    manual_unspecified: ~
+    percent_thereafter: "%{percent} sen jälkeen"
+    percent_to_limit: "%{percent} - %{limit}"
+  seller_invoice:
+    description_with_vat: "Toimeksiantolaskelma #%{ocr}"
+    description_without_vat: "Toimeksiantolaskelma (ilman alv) #%{ocr}"
+  shared:
+    actions:
+      add: Lisää
+      log_in: "Kirjaudu sisään"
+      order: Tilaa

data/spec/compare_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'pp'
+
+describe "I18nKit Comparer Test" do
+
+  it "should know which documents to compare to one another" do
+    one = I18nKit::Document.new
+    two = I18nKit::Document.new
+    three = I18nKit::Document.new
+    four = I18nKit::Document.new
+    array = [one, two, three, four]
+    comparer = I18nKit::Comparer.new array
+    comparer.documents.should == array
+    comparer.documents_to_compare.should == [[one, two], [one, three], [one, four], [two, three], [two, four], [three, four]]
+  end
+
+  it "should compare" do
+    documents = ::I18nKit::Importer::ExcelXML.new(XML_PATH, :ignore_headline => true, :locales => [:sv, :en, :fi]).parse + 
+                ::I18nKit::Importer::YAML.new(YML_FI_HIERARCHICAL_PATH).parse
+    documents[0].name = 'First'
+    documents[1].name = 'Second'
+    documents[2].name = 'Third'
+    documents[3].name = 'Fourth'
+    comparer = I18nKit::Comparer.new(documents)
+    # TODO: test automated comparison in the future :)
+    # comparer.compare
+  end
+  
+end

data/spec/document_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'pp'
+
+describe "I18nKit Document Test" do
+
+  it "should store an hierarchical hash" do
+    document = ::I18nKit::Importer::YAML.new(YML_FI_HIERARCHICAL_PATH).parse.first
+    document.to_hierarchical_hash.should == YAML.load(File.read(YML_FI_HIERARCHICAL_PATH)).values.first
+  end
+  
+  it "should flatten a hierarchical hash" do
+    document = ::I18nKit::Importer::YAML.new(YML_FI_HIERARCHICAL_PATH).parse.first
+    document.to_flat_hash.should == YML_FI_FLAT
+  end
+  
+  it "should spill out a yaml file without locale as root node" do
+    document = ::I18nKit::Importer::YAML.new(YML_FI_HIERARCHICAL_PATH).parse.first
+    YAML.load(document.to_flat_yaml).should == YML_FI_FLAT # Hard to test because Hashes are unordered when exported to YML
+  end
+  
+  it "should export proper i18n yaml files" do
+    document = ::I18nKit::Importer::YAML.new(YML_FI_HIERARCHICAL_PATH).parse.first
+    document.to_i18n_hash.should == YAML.load(File.read(YML_FI_HIERARCHICAL_PATH))
+  end
+  
+  it "should replace a value for a given chain" do
+    document = ::I18nKit::Importer::YAML.new(YML_FI_HIERARCHICAL_PATH).parse.first
+    document['activerecord.attributes.account.number'] = 'New Value'
+    document.to_i18n_hash['fi']['activerecord']['attributes']['account']['number'].should == 'New Value'
+  end
+  
+end

data/spec/importer_excel_xml_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "I18nKit ExcelXML Importer Test" do
+  
+  it "should import a file at a given path and load it with Nokogiri" do
+    importer = ::I18nKit::Importer::ExcelXML.new(XML_PATH)
+    importer.path_or_string.should == XML_PATH
+    importer.nokodoc.should be_an_instance_of Nokogiri::XML::Document
+    importer.nokodoc.children.size.should be > 0
+  end
+  
+  it "should import a String and load it with Nokogiri" do
+    importer = ::I18nKit::Importer::ExcelXML.new File.read(XML_PATH)
+    importer.path_or_string.should == File.read(XML_PATH)
+    importer.nokodoc.should be_an_instance_of Nokogiri::XML::Document
+    importer.nokodoc.children.size.should be > 0
+  end
+  
+  it "should know how to parse an .xml file" do
+    documents = ::I18nKit::Importer::ExcelXML.new(XML_PATH).parse
+    documents.should be_an_instance_of Array
+    documents.each do |doc|
+      doc.should be_an_instance_of I18nKit::Document
+      case doc.locale
+        when 'svenska'
+          doc.to_flat_hash.should == XML_HASH_SV
+        when "engelska"
+          doc.to_flat_hash.should == XML_HASH_EN
+        when "finska"
+          doc.to_flat_hash.should == XML_HASH_FI
+        when "GM Kommentar"
+          doc.to_flat_hash.should == XML_HASH_COMMENTS
+        else
+          flunk 'There is one translation too much'
+      end
+    end
+  end
+  
+  it "should know how to parse an .xml file with manually defined column names" do
+    importer = ::I18nKit::Importer::ExcelXML.new(XML_PATH, :ignore_headline => true, :locales => [:sv, :en, :fi, :comment])
+    documents = importer.parse
+    documents.should be_an_instance_of Array
+    documents.each do |doc|
+      doc.should be_an_instance_of I18nKit::Document
+      case doc.locale
+        when "sv"
+          doc.to_flat_hash.should == XML_HASH_SV
+        when "en"
+          doc.to_flat_hash.should == XML_HASH_EN
+        when "fi"
+          doc.to_flat_hash.should == XML_HASH_FI
+        when "comment"
+          doc.to_flat_hash.should == XML_HASH_COMMENTS
+        else
+          flunk 'There is one translation too much'
+      end
+    end
+  end
+  
+  it "should know how to parse an .xml file with a subset of manually defined column names" do
+    importer = ::I18nKit::Importer::ExcelXML.new(XML_PATH, :ignore_headline => true, :locales => [:sv, :en, :fi])
+    documents = importer.parse
+    documents.should be_an_instance_of Array
+    documents.each do |doc|
+      doc.should be_an_instance_of I18nKit::Document
+      case doc.locale
+        when "sv"
+          doc.to_flat_hash.should == XML_HASH_SV
+        when "en"
+          doc.to_flat_hash.should == XML_HASH_EN
+        when "fi"
+          doc.to_flat_hash.should == XML_HASH_FI
+        else
+          flunk 'There is one translation too much'
+      end
+    end
+  end
+  
+end
+

data/spec/importer_yml_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "I18nKit Importer Test" do
+  
+  it "should identify the locale of a standard Rails i18n yml file" do
+    documents = ::I18nKit::Importer::YAML.new(YML_FI_HIERARCHICAL_PATH).parse
+    documents.should be_an_instance_of Array
+    documents.size.should == 1
+    documents.first.should be_an_instance_of I18nKit::Document
+    documents.first.locale.should == 'fi'
+  end
+  
+  it "should chop of the root of imported yaml files" do
+    importer = ::I18nKit::Importer::YAML.new(YML_FI_HIERARCHICAL_PATH)
+    hierarchical_hash = YAML.load(File.read(YML_FI_HIERARCHICAL_PATH)).values.first
+    importer.hash.should == hierarchical_hash
+    importer.parse.first.to_hierarchical_hash.should == hierarchical_hash
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'i18n_kit'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+XML_PATH = File.join(File.dirname(__FILE__), 'assets', 'excel_export.xml')
+
+XML_HASH_FI = { "support.select.prompt" => "Valitse",
+                "base_helper.time_left" => "%{time} j\303\244ljell\303\244",
+                "base_helper.all" => "Kaikki" }
+
+XML_HASH_SV = { "support.select.prompt" => "V\303\244lj",
+                "base_helper.time_left" => "%{time} kvar",
+                "base_helper.all" => "Alla" }
+
+XML_HASH_EN = { "support.select.prompt" => "Please select",
+                "base_helper.time_left" => "%{time} left",
+                "base_helper.all" => "All" }
+
+XML_HASH_COMMENTS = { "support.select.prompt" => "This is a comment",
+                      "base_helper.time_left" => "",
+                      "base_helper.all" => "" }
+
+YML_FI_HIERARCHICAL_PATH = File.join(File.dirname(__FILE__), 'assets', 'fi_hierarchical.yml')
+
+YML_FI_FLAT = { "activerecord.attributes.account.account_type" => "Pankkitilin tyyppi",
+                "activerecord.attributes.account.number" => "Tilinumero",
+                "activerecord.attributes.auction.estimate" => "L\303\244ht\303\266hinta",
+                "activerecord.attributes.auction.estimate_upper" => "L\303\244ht\303\266hinta alkaen",
+                "activerecord.attributes.auction.reserve_price" => "Pohjahinta",
+                "percentage_fee.manual_unspecified" => nil,
+                "percentage_fee.percent_thereafter" => "%{percent} sen j\303\244lkeen",
+                "percentage_fee.percent_to_limit" => "%{percent} - %{limit}",
+                "seller_invoice.description_without_vat" => "Toimeksiantolaskelma (ilman alv) #%{ocr}",
+                "seller_invoice.description_with_vat" => "Toimeksiantolaskelma #%{ocr}",
+                "shared.actions.add" => "Lis\303\244\303\244",
+                "shared.actions.order" => "Tilaa",
+                "shared.actions.log_in" => "Kirjaudu sis\303\244\303\244n" }
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification 
+name: i18n_kit
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- funkensturm.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-07 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: nokogiri
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: ya2yaml
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  name: rspec
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  name: jeweler
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id006
+description: You can import XML files that were exported using Excel, or standard i18n hierarchical YML files. Both will be normalized as I18nKit::Document objects so that they can be compared with each other. You need implement the comparison method yourself, however. I18nKit only provides the Iterator. )
+email: commanda.keen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.textile
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.textile
+- Rakefile
+- VERSION
+- i18n_kit.gemspec
+- lib/i18n_kit.rb
+- lib/i18n_kit/comparer.rb
+- lib/i18n_kit/document.rb
+- lib/i18n_kit/importer.rb
+- lib/i18n_kit/importer/excel_xml.rb
+- lib/i18n_kit/importer/yaml.rb
+- lib/yamlator.rb
+- spec/assets/excel_export.xml
+- spec/assets/fi_hierarchical.yml
+- spec/compare_spec.rb
+- spec/document_spec.rb
+- spec/importer_excel_xml_spec.rb
+- spec/importer_yml_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/funkensturm/i18n_kit
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: A small tool to import I18n files from Excel and YML and compare them
+test_files: []
+