i18n_googledocs 0.1.4

data/lib/tasks/store_translations.rake

@@ -0,0 +1,60 @@
+
+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
+  
+  # http://stackoverflow.com/questions/1357639/rails-rake-how-to-pass-in-arguments-to-a-task-with-environment
+  desc "Export all language files to CSV files (only files contained in base folder are considered, default = en)"
+  task :export_translations, [:base] => :environment do |t, args|
+    raise "'Rails' not found! Tasks can only run within a Rails application!" if !defined?(Rails)
+    
+    args.with_defaults(:base => 'en')
+
+    source_dir  = Rails.root.join('config', 'locales')
+    output_dir  = Rails.root.join('tmp')
+    locales     = I18n.available_locales
+    
+    input_files = Dir[File.join(source_dir, base_locale, '*.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,26 @@
+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