i18n-docs 0.0.3

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+.rake_tasks~
+doc/yardoc
+.yardoc
+tmp/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in localch.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,8 @@
+Copyright (c) 2012 Local.ch AG
+
+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,69 @@
+
+# ![local.ch](http://www.local.ch/favicon.ico) local.ch i18n helpers
+
+**i18n-docs** is a ruby gem that helps you to keep translations stored in Google Docs. This makes it easier for translators and project members to coordinate changes and updates. In addition, the standard features of Google Docs are super handy for this process: revision tracking, authorization, publishing, etc. 
+
+Although we at use it with Google Docs, it could be used with any CSV file.
+
+## Features: 
+
+* download translations from multiple Google spreadsheets and store to YAML files
+* import/export YAML files with a Google Spreadsheet
+* check YAML files for missing translations (`rake i18n:find_missing_keys`)
+
+## Usage
+
+Add the GEM to your Rails project:
+
+    gem 'i18n-docs'
+
+The rake task `i18n:import_translations` requires following configuration file in `config/translations.yml`:
+
+    files:
+      naviagion.yml: "https://docs.google.com/spreadsheet/pub?key=ab43...34f3&single=true&gid=0&output=csv"
+      forms.yml: "https://docs.google.com/spreadsheet/pub?key=0Ap...XveWc&single=true&gid=0&output=csv"
+
+This defines which translations files should be created by exporting a Google Spreadsheet. The content of the Spreadsheet URL is stored to a file called e.g. `example1.yml` within folders `config/locales/en` and all other detected locales.
+
+### Rake Tasks
+
+Following Rake tasks are added by the GEM to your Rails project:
+
+* rake i18n:export_translations
+  Export all language files to CSV files (only files contained in 'en' folder are considered)
+* rake i18n:import_translations
+  Download translations from Google Spreadsheet and save them to YAML files.
+* rake i18n:missing_keys
+  Find and list translation keys that do not exist in all locales
+
+
+## Setup at Google Docs
+
+* At Google Docs, create a new spreadsheet for your translations. The first column is the translation key, the other columns are the languages:
+![screenshot](http://dl.dropbox.com/u/385855/Screenshots/bamr.png)
+* use option `File -> Publish To the Web` 
+![screenshot](http://dl.dropbox.com/u/385855/Screenshots/2-lp.png)
+* use **get a link** to generate a unique url that points to the CSV spreadsheet
+![screenshot](http://dl.dropbox.com/u/385855/Screenshots/oom_.png)
+* From now on you should only update translations in Google Docs and run `rake i18n:import_translations` in the application to get changes. You can also export your 
+
+
+## CHANGELOG
+
+### 0.0.4
+
+Update docs, license. Push to Rubygems.org.
+
+### 0.0.3
+
+* Open sourced: changed name and description.
+
+### 0.0.2
+
+* removed loading of `awesome_print` from the rake task. It was breaking
+  download
+
+### Credits/License
+
+This gem is sponsored by [local.ch](http://www.local.ch/). It is licensed under the [MIT license](http://en.wikipedia.org/wiki/MIT_License). If you're a ruby developer and want to work with us in Switzerland, please check out our [jobs page](http://local-ch.github.com/).
+

data/Rakefile

@@ -0,0 +1,17 @@
+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 'bundler/gem_tasks'
+require 'localch-i18n'
+
+task :default => [:test]
+
+# Load tasks
+Dir.glob('tasks/**/*.rake').each { |r| Rake.application.add_import r }

data/i18n-docs.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = 'i18n-docs'
+  s.version     = '0.0.3'
+  s.date        = '2012-04-20'
+  s.summary     = "Maintain translations in Google Docs and export them to your Rails project."
+  s.description = "GEM providing helper scripts to manage i18n translations in Google Docs. Features: check YAML files for missing translations; export YAML files to CSV; download translations from multiple Google spreadsheets and store to YAML files"
+  s.authors     = ["Georg Kunz", "Ivan Jovanovic", "Jeremy Seitz"]
+  s.email       = 'jeremy.seitz@local.ch'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'https://github.com/local-ch/i18n-docs'
+
+  # dependencies
+  s.add_dependency('bundler')
+  s.add_dependency('rake')
+  
+  s.add_development_dependency('mocha')
+  s.add_development_dependency('awesome_print')
+  
+end

data/lib/localch-i18n.rb

@@ -0,0 +1,22 @@
+# require 'rake'
+
+# load rake tasks in case GEM is included within rails project
+
+require 'csv'
+require 'yaml'
+require 'open-uri'
+require 'localch_i18n/missing_keys_finder'
+require 'localch_i18n/csv_to_yaml'
+require 'localch_i18n/translations'
+require 'localch_i18n/translation_file_export'
+
+
+
+if defined?(Rails)
+  class LocalchI18nTask < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+    end
+  end
+end
+

data/lib/localch_i18n/csv_to_yaml.rb

@@ -0,0 +1,68 @@
+module LocalchI18n
+
+  class CsvToYaml
+
+    attr_reader :input_file, :output_file, :locales, :translations
+
+    def initialize(input_file, output_file, locales = [])
+      @input_file = input_file
+      @output_file = File.basename(output_file)
+      @locales = locales.map(&:to_s)
+
+      # init translation hash
+      @translations = {}
+      @locales.each do |locale|
+        @translations[locale] = {}
+      end
+    end
+
+
+    def write_files
+      @locales.each do |locale|
+        output_file_path = defined?(Rails) ? Rails.root.join('config', 'locales', locale, @output_file) : "#{locale}_#{@output_file}"
+        File.open(output_file_path, 'w') do |file|
+          final_translation_hash = {locale => @translations[locale]}
+          file.puts YAML::dump(final_translation_hash)
+        end
+        puts "File '#{@output_file}' for language '#{locale}' written to disc (#{output_file_path})"
+      end
+    end
+
+
+    def process
+      CSV.foreach(@input_file, headers: true) do |row|
+        process_row(row.to_hash)
+      end
+    end
+
+    def process_row(row_hash)
+      key = row_hash.delete('key')
+
+      key_elements = key.split('.')
+      @locales.each do |locale|
+        raise "Locale missing for key #{key}! (locales in app: #{@locales} / locales in file: #{row_hash.keys.to_s})" if !row_hash.has_key?(locale)
+        store_translation(key_elements, locale, row_hash[locale])
+      end
+    end
+
+
+    def store_translation(keys, locale, value)
+      return nil if value.nil?    # we don't store keys that don't have a valid value
+      # Google Spreadsheet does not export empty strings and therefore we use '_' as a replacement char.
+      value = '' if value == '_'
+
+      tree = keys[0...-1]
+      leaf = keys.last
+      data_hash = tree.inject(@translations[locale]) do |memo, k|
+        if memo.has_key?(k)
+          memo[k]
+        else
+          memo[k] = {}
+        end
+      end
+      data_hash[leaf] = value
+    end
+
+  end
+
+end

data/lib/localch_i18n/missing_keys_finder.rb

@@ -0,0 +1,112 @@
+
+module LocalchI18n
+  class MissingKeysFinder
+    def initialize(backend)
+      @backend = backend
+      self.load_config
+      self.load_translations
+    end
+
+    # Returns an array with all keys from all locales
+    def all_keys
+      I18n.backend.send(:translations).collect do |check_locale, translations|
+        collect_keys([], translations).sort
+      end.flatten.uniq
+    end
+
+    def find_missing_keys
+      output_available_locales
+      output_unique_key_stats(all_keys)
+
+      missing_keys = {}
+      all_keys.each do |key|
+
+        I18n.available_locales.each do |locale|
+
+          skip = false
+          ls = locale.to_s
+          if !@yaml[ls].nil?
+            @yaml[ls].each do |re|
+              if key.match(re)
+                skip = true
+                break
+              end
+            end
+          end
+
+          if !key_exists?(key, locale) && skip == false
+            if missing_keys[key]
+              missing_keys[key] << locale
+            else
+              missing_keys[key] = [locale]
+            end
+          end
+        end
+      end
+
+      output_missing_keys(missing_keys)
+      return missing_keys
+    end
+
+    def output_available_locales
+      puts "#{I18n.available_locales.size} #{I18n.available_locales.size == 1 ? 'locale' : 'locales'} available: #{I18n.available_locales.join(', ')}"
+    end
+
+    def output_missing_keys(missing_keys)
+      if missing_keys.size > 0
+        puts "#{missing_keys.size} #{missing_keys.size == 1 ? 'key is missing' : 'keys are missing'} from one or more locales:"
+        missing_keys.keys.sort.each do |key|
+          puts "'#{key}': Missing from #{missing_keys[key].collect(&:inspect).join(', ')}"
+        end
+        puts "\nERROR: #{missing_keys.size} #{missing_keys.size == 1 ? 'key is missing' : 'keys are missing'} from one or more locales."
+      else
+        puts "No keys are missing"
+      end
+    end
+
+    def output_unique_key_stats(keys)
+      number_of_keys = keys.size
+      puts "#{number_of_keys} #{number_of_keys == 1 ? 'unique key' : 'unique keys'} found."
+    end
+
+    def collect_keys(scope, translations)
+      full_keys = []
+      translations.to_a.each do |key, translations|
+        new_scope = scope.dup << key
+        if translations.is_a?(Hash)
+          full_keys += collect_keys(new_scope, translations)
+        else
+          full_keys << new_scope.join('.')
+        end
+      end
+      return full_keys
+    end
+
+    # Returns true if key exists in the given locale
+    def key_exists?(key, locale)
+      I18n.locale = locale
+      I18n.translate(key, :raise => true)
+      return true
+    rescue I18n::MissingInterpolationArgument
+      return true
+    rescue I18n::MissingTranslationData
+      return false
+    end
+
+    def load_translations
+      # Make sure we’ve loaded the translations
+      I18n.backend.send(:init_translations)
+    end
+
+    def load_config
+      @yaml = {}
+      begin
+        @yaml = YAML.load_file(File.join(Rails.root, 'config', 'ignore_missing_i18n_keys.yml'))
+      rescue => e
+        STDERR.puts "No ignore_missing_keys.yml config file."
+      end
+
+    end
+
+  end
+end

data/lib/localch_i18n/translation_file_export.rb

@@ -0,0 +1,77 @@
+module LocalchI18n
+  class TranslationFileExport
+    
+    attr_accessor :translations
+    
+    def initialize(source_dir, source_file, output_dir, locales)
+      @source_dir = source_dir
+      @source_file = source_file
+      
+      @output_file = File.join(output_dir, source_file.gsub('.yml', '.csv'))
+      @locales = locales.map {|l| l.to_s.downcase }
+      
+      @translations = {}
+    end
+    
+    
+    def export
+      load_translations
+      write_to_csv
+    end
+    
+    
+    def write_to_csv
+      main_locale = @locales.include?('en') ? 'en' : @locales.first
+      
+      puts "    #{@source_file}: write CSV to '#{@output_file}' \n\n"
+      
+      CSV.open(@output_file, "wb") do |csv|
+        csv << (["key"] + @locales)
+        
+        @translations[main_locale].keys.each do |key|
+          values = @locales.map do |locale|
+            @translations[locale][key]
+          end
+          csv << values.unshift(key)
+        end
+      end
+      
+    end
+    
+    
+    def load_translations
+      @locales.each do |locale|
+        translation_hash = load_language(locale)
+        @translations[locale] = flatten_translations_hash(translation_hash)
+      end
+    end
+    
+    def load_language(locale)
+      
+      puts "    #{@source_file}: load translations for '#{locale}'"
+      
+      input_file = File.join(@source_dir, locale, @source_file)
+      translations = {}
+      translations = YAML.load_file(input_file) if File.exists?(input_file)
+      translations[locale]
+    end
+    
+    def flatten_translations_hash(translations, parent_key = [])
+      flat_hash = {}
+      
+      translations.each do |key, t|
+        current_key = parent_key.dup << key
+        if t.is_a?(Hash)
+          # descend
+          flat_hash.merge!(flatten_translations_hash(t, current_key))
+        else
+          # leaf -> store as value for key
+          flat_hash[current_key.join('.')] = t
+        end
+      end
+      flat_hash
+    end
+    
+  end
+  
+end

data/lib/localch_i18n/translations.rb

@@ -0,0 +1,70 @@
+#
+# Order of method calls
+#  download_files
+#  store_translations
+#  clean_up
+#
+module LocalchI18n
+  class Translations
+    
+    attr_accessor :locales, :tmp_folder, :config_file, :csv_files
+    
+    def initialize(config_file = nil, tmp_folder = nil)
+      @config_file = config_file 
+      @tmp_folder  = tmp_folder
+      
+      @csv_files = {}
+      
+      load_config
+      load_locales
+    end
+    
+    def load_locales
+      @locales = []
+      @locales = I18n.available_locales if defined?(I18n)
+    end
+    
+    def load_config
+      @settings = {}
+      @settings = YAML.load_file(config_file) if File.exists?(config_file)
+    end
+    
+    def download_files
+      files = @settings['files']
+      files.each do |target_file, url|
+        # download file to tmp directory
+        tmp_file = File.basename(target_file).gsub('.yml', '.csv')
+        tmp_file = File.join(@tmp_folder, tmp_file)
+        download(url, tmp_file)
+        @csv_files[target_file] = tmp_file
+      end
+    end
+    
+    def store_translations
+      @csv_files.each do |target_file, csv_file|
+        converter = CsvToYaml.new(csv_file, target_file, @locales)
+        converter.process
+        converter.write_files
+      end
+      
+      @csv_files
+    end
+    
+    def clean_up
+      # remove all tmp files
+      @csv_files.each do |target_file, csv_file|
+        File.unlink(csv_file)
+      end
+    end
+    
+    def download(url, destination_file)
+      puts "Download '#{url}' to '#{destination_file}'"
+      File.open(destination_file, 'w') do |dst|
+        dst.write(open(url).read)
+      end
+    end
+    
+  end
+end
+
+

data/lib/tasks/store_translations.rake

@@ -0,0 +1,57 @@
+
+namespace :i18n do
+  
+  desc "Find and list translation keys that do not exist in all locales"
+  task :missing_keys => :environment do
+    finder = LocalchI18n::MissingKeysFinder.new(I18n.backend)
+    finder.find_missing_keys
+  end
+  
+  desc "Download translations from Google Spreadsheet and save them to YAML files."
+  task :import_translations => :environment do
+    raise "'Rails' not found! Tasks can only run within a Rails application!" if !defined?(Rails)
+    
+    config_file = Rails.root.join('config', 'translations.yml')
+    raise "No config file 'config/translations.yml' found." if !File.exists?(config_file)
+    
+    tmp_dir = Rails.root.join('tmp')
+    
+    translations = LocalchI18n::Translations.new(config_file, tmp_dir)
+    translations.download_files
+    translations.store_translations
+    translations.clean_up
+    
+  end
+  
+  desc "Export all language files to CSV files (only files contained in en folder are considered)"
+  task :export_translations => :environment do
+    raise "'Rails' not found! Tasks can only run within a Rails application!" if !defined?(Rails)
+    
+    source_dir  = Rails.root.join('config', 'locales')
+    output_dir  = Rails.root.join('tmp')
+    locales     = I18n.available_locales
+    
+    input_files = Dir[File.join(source_dir, 'en', '*.yml')]
+    
+    puts ""
+    puts "  Detected locales: #{locales}"
+    puts "  Detected files:"
+    input_files.each {|f| puts "    * #{File.basename(f)}" }
+    
+    puts ""
+    puts "  Start exporting files:"
+    
+    input_files.each do |file|
+      file = File.basename(file)
+      exporter = LocalchI18n::TranslationFileExport.new(source_dir, file, output_dir, locales)
+      exporter.export
+    end
+    
+    puts ""
+    puts "  CSV files can be removed safely after uploading them manually to Google Spreadsheet."
+    puts ""
+  end
+  
+end
+
+

data/tasks/test.rake

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+# Test::Unit Tests
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+

data/test/fixtures/config.yml

@@ -0,0 +1,9 @@
+#
+# Configure all spreadsheets you want to import:
+#
+# files:
+#   first.yml: http://www.google.com/spreadsheet/first.csv
+#   second.yml: http://www.google.com/spreadsheet/second.csv
+#
+files:
+  download.yml: "https://docs.google.com/spreadsheet/pub?key=0ApnemdIdiDXedEpiVFR1RkdWMDhnTTgtdzRJMWZMLUE&single=true&gid=0&output=csv"

data/test/fixtures/de/header.yml

@@ -0,0 +1,8 @@
+de:
+    header:
+        search: Finden
+        phonebook: Telefonbuch
+        the_yellow_pages: Die Gelben Seiten
+        property: Immobilien
+        map: Karte
+    copyright: (c) local.ch

data/test/fixtures/en/header.yml

@@ -0,0 +1,8 @@
+en:
+    header:
+        search: Find
+        phonebook: Phone Book
+        the_yellow_pages: The Yellow Pages
+        property: Property
+        map: Map
+    copyright: (c) local.ch

data/test/fixtures/minimal.csv

@@ -0,0 +1,24 @@
+key,en,de
+tel.browse_access_title,Largest cities,Grösste Städte
+tel.browse_all_link,» Look-up all cities (A-Z),» Alle Orte A-Z
+tel.extended.area_field_teaser,"",""
+tel.extended.area_label,"Region, Canton","Region, Kanton"
+tel.extended.city_field_teaser,"",""
+tel.extended.city_label,"City, ZIP","Ort, PLZ"
+tel.extended.company_field_teaser,"e.g. doctor, farmer","z.B. pizzaiolo, doktor"
+tel.extended.company_label,Occupation,Beruf
+tel.extended.name_field_teaser,"e.g. smith, phil*","z.B. meier, hans*"
+tel.extended.name_label,"Name, First name","Name, Vorname"
+tel.extended.phone_field_teaser,"",""
+tel.extended.phone_label,Phone,Telefon
+tel.extended.street_field_teaser,"",""
+tel.extended.street_label,Street,Strasse
+tel.homepage.meta.description,The official phone book for Switzerland by Swisscom Directories with over 6 million listings of private people and businesses in your vicinity.,Firmen und Privatpersonen in Ihrer Nähe einfach finden.
+tel.homepage.meta.keywords,"phone book, city, Switzerland, directory, address, white pages","Telefonbuch, Schweiz, aktuell, Directories, Adresse"
+tel.homepage.meta.title,Switzerland's official Phone Book by local.ch,Offizielles Telefonbuch der Schweiz von local.ch
+tel.search_button,Find It,Finden
+tel.search_for_people,Find names or numbers,Namen oder Nummern finden
+tel.what_field_teaser,"e.g. Smith, Bar Odeon or 044 308 68 68","z.B. Müller, Bar Odeon oder 044 308 68 68"
+tel.what_label,Who?,Wer?
+tel.where_field_teaser,"e.g. Bern, 8004 or Hauptstrasse","z.B. Luzern, 5700 oder Bergstrasse"
+tel.where_label,Where?,Wo?

data/test/fixtures/test.csv

@@ -0,0 +1,24 @@
+key,en,de,fr,it
+tel.browse_access_title,Largest cities,Grösste Städte,Villes Principales,Città principali
+tel.browse_all_link,» Look-up all cities (A-Z),» Alle Orte A-Z,» Toutes les localités (A-Z),» Tutte le località A-Z
+tel.extended.area_field_teaser,"","","",""
+tel.extended.area_label,"Region, Canton","Region, Kanton","Région, Canton","Regione, Cantone"
+tel.extended.city_field_teaser,"","","",""
+tel.extended.city_label,"City, ZIP","Ort, PLZ","Localité, NPA","Località, Codice postale"
+tel.extended.company_field_teaser,"e.g. doctor, farmer","z.B. pizzaiolo, doktor","par ex. médecin, agriculteur","per es. medico, agricoltore"
+tel.extended.company_label,Occupation,Beruf,Profession,Professione
+tel.extended.name_field_teaser,"e.g. smith, phil*","z.B. meier, hans*","par ex. berdoz, jean*","per es. rossi, robert*"
+tel.extended.name_label,"Name, First name","Name, Vorname","Nom, Prénom","Cognome, Nome"
+tel.extended.phone_field_teaser,"","","",""
+tel.extended.phone_label,Phone,Telefon,Téléphone,Telefono
+tel.extended.street_field_teaser,"","","",""
+tel.extended.street_label,Street,Strasse,Rue,Via
+tel.homepage.meta.description,The official phone book for Switzerland by Swisscom Directories with over 6 million listings of private people and businesses in your vicinity.,Firmen und Privatpersonen in Ihrer Nähe einfach finden.,Trouver simplement des entreprise et des personnes dans vos alentours.,Trovare con facilità privati ed aziende a voi vicine.
+tel.homepage.meta.keywords,"phone book, city, Switzerland, directory, address, white pages","Telefonbuch, Schweiz, aktuell, Directories, Adresse","annuaire, Suisse, actuel, Directories, adresse","Elenco telefonico, Svizzera, attualità, Directories, indirizzo"
+tel.homepage.meta.title,Switzerland's official Phone Book by local.ch,Offizielles Telefonbuch der Schweiz von local.ch,Annuaire téléphonique officiel sur local.ch,L’elenco telefonico della Svizzera su local.ch
+tel.search_button,Find It,Finden,Trouver,Trovare
+tel.search_for_people,Find names or numbers,Namen oder Nummern finden,Trouver un nom ou un numéro,Trova nomi e numeri
+tel.what_field_teaser,"e.g. Smith, Bar Odeon or 044 308 68 68","z.B. Müller, Bar Odeon oder 044 308 68 68","par ex. Favre, Bar Cuba ou 044 308 68 68","per es. Rossi, Bar Incontro o 044 308 68 68"
+tel.what_label,Who?,Wer?,Quoi ?,Cosa?
+tel.where_field_teaser,"e.g. Bern, 8004 or Hauptstrasse","z.B. Luzern, 5700 oder Bergstrasse","par ex. Neuchâtel, 1630 ou rue de Tivoli","per es. Locarno, 6900 o via Molinazzo"
+tel.where_label,Where?,Wo?,Où ?,Dove?

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+require 'test/unit'
+require 'fileutils'
+require 'localch-i18n'
+
+
+module TestHelper
+  
+  def fixture_path
+    File.join(File.expand_path(File.dirname(__FILE__)), 'fixtures')
+  end
+  
+  def tmp_dir
+    File.join(fixture_path, 'tmp')
+  end
+  
+  def create_tmp_dir
+    FileUtils::mkdir(tmp_dir) if ! File.exists?(tmp_dir)
+  end
+  
+  def remove_tmp_dir
+    FileUtils::rmtree(tmp_dir)
+  end
+  
+end
+
+
+

data/test/unit/csv_to_yaml_test.rb

@@ -0,0 +1,137 @@
+require 'test_helper'
+require 'mocha'
+require 'awesome_print'
+
+# run test: ruby -I test/ -I lib/ test/unit/csv_to_yaml_test.rb
+
+Rails = Struct.new(:dummy)
+
+module UnitTests
+
+  class CsvToYamlTest < Test::Unit::TestCase
+    include TestHelper
+
+    def setup
+      create_tmp_dir
+
+      @input_file  = File.join(fixture_path, 'minimal.csv')
+      @output_file = File.join(tmp_dir, 'test.yml')
+      @locales = ['de', 'en']
+
+      Rails.stubs(:root).returns(stub(:join => @output_file))
+
+      @csv_to_yaml = LocalchI18n::CsvToYaml.new(@input_file, @output_file, @locales)
+    end
+
+    def teardown
+      remove_tmp_dir
+    end
+
+    def test_process_row
+      row1 = {'key' => 'homepage.meta.title', 'en' => 'Phonebook of Switzerland', 'de' => 'Telefonbuch der Schweiz'}
+      row2 = {'key' => 'homepage.welcome', 'en' => 'Welcome', 'de' => 'Willkommen'}
+      @csv_to_yaml.process_row(row1)
+      @csv_to_yaml.process_row(row2)
+
+      translations = @csv_to_yaml.translations
+      assert_equal 'Telefonbuch der Schweiz', translations['de']['homepage']['meta']['title']
+      assert_equal 'Willkommen', translations['de']['homepage']['welcome']
+      assert_equal 'Phonebook of Switzerland', translations['en']['homepage']['meta']['title']
+      assert_equal 'Welcome', translations['en']['homepage']['welcome']
+    end
+
+    def test_row_containing_non_locale_columns
+      row = {'key' => 'homepage.title', 'en' => "We are the Phonebook", 'de' => 'Test DE', 'comment' => "Test comment"}
+      @csv_to_yaml.process_row(row)
+
+      translations = @csv_to_yaml.translations
+      assert_equal 'We are the Phonebook', translations['en']['homepage']['title']
+    end
+
+
+    def test_empty_string_replacement_value
+      # As Google Spreadsheet does not export empty cells we use '_' as a fake whitespace which
+      # we replace with an empty string during CVS2YAML conversion.
+      row = {'key' => 'homepage.meta.title', 'en' => 'Phonebook of Switzerland', 'de' => '_'}
+      @csv_to_yaml.process_row(row)
+
+      translations = @csv_to_yaml.translations
+      assert_equal '', translations['de']['homepage']['meta']['title']
+      assert_equal 'Phonebook of Switzerland', translations['en']['homepage']['meta']['title']
+    end
+
+
+    def test_empty_string_value
+      row = {'key' => 'homepage.meta.title', 'en' => 'Phonebook of Switzerland', 'de' => ''}
+      @csv_to_yaml.process_row(row)
+
+      translations = @csv_to_yaml.translations
+      assert_equal '', translations['de']['homepage']['meta']['title']
+      assert_equal 'Phonebook of Switzerland', translations['en']['homepage']['meta']['title']
+    end
+
+
+    def test_space_value
+      row = {'key' => 'homepage.meta.title', 'en' => 'Phonebook of Switzerland', 'de' => ' '}
+      @csv_to_yaml.process_row(row)
+
+      translations = @csv_to_yaml.translations
+      assert_equal ' ', translations['de']['homepage']['meta']['title']
+      assert_equal 'Phonebook of Switzerland', translations['en']['homepage']['meta']['title']
+    end
+
+    def test_nil_value
+      row = {'key' => 'homepage.meta.title', 'en' => 'Phonebook of Switzerland', 'de' => nil}
+      @csv_to_yaml.process_row(row)
+
+      translations = @csv_to_yaml.translations
+      assert_equal({}, translations['de'])
+      assert_equal 'Phonebook of Switzerland', translations['en']['homepage']['meta']['title']
+    end
+
+
+    def test_nil_value_deep_structure
+      row1 = {'key' => 'homepage.meta.title', 'en' => 'Phonebook of Switzerland', 'de' => nil}
+      row2 = {'key' => 'homepage.welcome', 'en' => 'Welcome', 'de' => 'Willkommen'}
+      @csv_to_yaml.process_row(row1)
+      @csv_to_yaml.process_row(row2)
+
+      translations = @csv_to_yaml.translations
+      assert_nil translations['de']['meta']
+      assert_equal 'Willkommen', translations['de']['homepage']['welcome']
+      assert_equal 'Phonebook of Switzerland', translations['en']['homepage']['meta']['title']
+    end
+
+
+    def test_store_translations
+      keys = ['homepage', 'meta', 'title']
+      @csv_to_yaml.store_translation(keys, 'de', 'Telefonbuch der Schweiz')
+
+      translations = @csv_to_yaml.translations
+      assert_equal 'Telefonbuch der Schweiz', translations['de']['homepage']['meta']['title']
+    end
+
+    def test_process
+      @locales.each do |locale|
+        assert_empty @csv_to_yaml.translations[locale], "expected translation hash for locale '#{locale}' to be empty"
+      end
+
+      @csv_to_yaml.process
+
+      @locales.each do |locale|
+        assert @csv_to_yaml.translations[locale]['tel']['extended']['company_label']
+        assert @csv_to_yaml.translations[locale]['tel']['extended']['company_label'].is_a?(String)
+        assert @csv_to_yaml.translations[locale]['tel']['search_button']
+        assert @csv_to_yaml.translations[locale]['tel']['search_button'].is_a?(String)
+      end
+    end
+
+    def test_write_files
+      assert !File.exists?(@output_file)
+      @csv_to_yaml.process
+      @csv_to_yaml.write_files
+      assert File.exists?(@output_file)
+    end
+
+  end
+end

data/test/unit/translation_file_export_test.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+require 'mocha'
+
+require 'awesome_print'
+
+# run test: ruby -I test/ -I lib/ test/unit/locale_builder_test.rb
+
+module UnitTests
+  class TranslationFileExportTest < Test::Unit::TestCase
+    include TestHelper
+    
+    def setup
+      create_tmp_dir
+      
+      source_dir = fixture_path
+      source_file = 'header.yml'
+      output_dir = tmp_dir
+      locales = ['en', 'de']
+      
+      @exporter = LocalchI18n::TranslationFileExport.new(source_dir, source_file, output_dir, locales)
+      @output_file = File.join(output_dir, 'header.csv')
+    end
+    
+    def teardown
+      remove_tmp_dir
+    end
+    
+    
+    def test_export
+      assert !File.exists?(@output_file)
+      @exporter.export
+      assert File.exists?(@output_file), "Expected to have a CSV file written"
+    end
+    
+    def dtest_load_language
+      translations = @exporter.load_language('de')
+      
+      assert translations, "Expected to return a hash with translations"
+      assert_equal translations['header']['search'], "Finden"
+    end
+    
+    def dtest_flatten_translations_hash
+      translation_hash = {'a' => {
+                            'I' => '1', 
+                            'II' => '2', 
+                            'III' => {
+                              'Z' => '3'
+                            }
+                          }, 
+                          'b' => '4'
+                         }
+      
+      flat = @exporter.flatten_translations_hash(translation_hash, [])
+      assert_equal '1', flat['a.I']
+      assert_equal '2', flat['a.II']
+      assert_equal '3', flat['a.III.Z']
+      assert_equal '4', flat['b']
+    end
+    
+    def dtest_load_translations
+      assert_empty @exporter.translations
+      @exporter.load_translations
+      
+      assert @exporter.translations['de']
+      assert @exporter.translations['en']
+      assert_equal 'Finden', @exporter.translations['de']['header.search']
+      assert_equal 'Telefonbuch', @exporter.translations['de']['header.phonebook']
+      assert_equal '(c) local.ch', @exporter.translations['de']['copyright']
+    end
+    
+    def dtest_write_to_csv
+      @exporter.translations = {'de' => {'numbers.one' => 'eins'},
+                                'en' => {'numbers.one' => 'one'}}
+      
+      @exporter.write_to_csv
+      
+      output = File.read(@output_file)
+      assert_match /^key,(en|de|,){3}$/, output
+      assert_match /^numbers.one,(one|eins|,){3}$/, output
+    end
+    
+    
+  end
+end

data/test/unit/translations_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+require 'mocha'
+
+# run test: ruby -I test/ -I lib/ test/unit/locale_builder_test.rb
+
+Rails = Struct.new(:dummy)
+
+module UnitTests
+  class TranslationsTest < Test::Unit::TestCase
+    include TestHelper
+    
+    def setup
+      create_tmp_dir
+      
+      config_file = File.join(fixture_path, 'config.yml')
+      @translations = LocalchI18n::Translations.new(config_file, tmp_dir)
+      @translations.tmp_folder = tmp_dir
+      @translations.locales = ['de', 'en']
+      
+      @fixture_file = File.join(fixture_path, 'minimal.csv')
+      @tmp_file = File.join(tmp_dir, 'downloaded.csv')
+      @output_file = File.join(tmp_dir, 'test.yml')
+      
+      Rails.stubs(:root).returns(stub(:join => @output_file))
+    end
+    
+    def teardown
+      remove_tmp_dir
+    end
+    
+    def test_download
+      assert !File.exists?(@tmp_file)
+      @translations.download("https://docs.google.com/spreadsheet/pub?key=0ApnemdIdiDXedEpiVFR1RkdWMDhnTTgtdzRJMWZMLUE&single=true&gid=0&output=csv", @tmp_file)
+      assert File.exists?(@tmp_file), "Expected to have downloaded Google Spreadsheet to '#{@tmp_file}'"
+    end
+    
+    def test_cleanup
+      @translations.csv_files = {'dummy.yml' => @tmp_file}
+      File.open(@tmp_file, "w") {}
+      assert File.exists?(@tmp_file)
+      @translations.clean_up
+      assert !File.exists?(@tmp_file), "Expected to delete file"
+    end
+    
+    def test_store_translations
+      assert !File.exists?(@output_file)
+      
+      @translations.csv_files = {@output_file => @fixture_file}
+      @translations.store_translations
+      
+      assert File.exists?(@output_file)
+    end
+    
+    def test_download_files
+      expected_file = File.join(tmp_dir, 'download.csv')
+      assert !File.exists?(expected_file)
+      @translations.download_files
+      assert File.exists?(expected_file)
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: i18n-docs
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Georg Kunz
+- Ivan Jovanovic
+- Jeremy Seitz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: mocha
+  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: awesome_print
+  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: ! 'GEM providing helper scripts to manage i18n translations in Google
+  Docs. Features: check YAML files for missing translations; export YAML files to
+  CSV; download translations from multiple Google spreadsheets and store to YAML files'
+email: jeremy.seitz@local.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- i18n-docs.gemspec
+- lib/localch-i18n.rb
+- lib/localch_i18n/csv_to_yaml.rb
+- lib/localch_i18n/missing_keys_finder.rb
+- lib/localch_i18n/translation_file_export.rb
+- lib/localch_i18n/translations.rb
+- lib/tasks/store_translations.rake
+- tasks/test.rake
+- test/fixtures/config.yml
+- test/fixtures/de/header.yml
+- test/fixtures/en/header.yml
+- test/fixtures/minimal.csv
+- test/fixtures/test.csv
+- test/test_helper.rb
+- test/unit/csv_to_yaml_test.rb
+- test/unit/translation_file_export_test.rb
+- test/unit/translations_test.rb
+homepage: https://github.com/local-ch/i18n-docs
+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'
+      segments:
+      - 0
+      hash: 2117717396188885452
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2117717396188885452
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Maintain translations in Google Docs and export them to your Rails project.
+test_files: []