i18n-docs 0.0.4 → 0.0.7

data/README.md

@@ -1,11 +1,12 @@
+# i18n-docs
 
-# ![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.
 
-**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 use it with Google Docs, it could be used with any CSV file.
 
-Although we at use it with Google Docs, it could be used with any CSV file.
+*this gem is currently in use and tested with Rails 3.1. It probably works with other 3.x versions, but probably not 2.x at the moment.*
 
-## Features: 
+## Features:
 
 * download translations from multiple Google spreadsheets and store to YAML files
 * import/export YAML files with a Google Spreadsheet
@@ -13,27 +14,35 @@ Although we at use it with Google Docs, it could be used with any CSV file.
 
 ## Usage
 
+### Configuration
+
 Add the GEM to your Rails project:
 
     gem 'i18n-docs'
 
-The rake task `i18n:import_translations` requires following configuration file in `config/translations.yml`:
+Create a configuration file in `config/translations.yml`:
 
     files:
-      naviagion.yml: "https://docs.google.com/spreadsheet/pub?key=ab43...34f3&single=true&gid=0&output=csv"
+      navigation.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"
+      ... etc ...
+
+Finally, let Rails know what locales you will be using. Add this to `config/application.rb`:
+
+    # locals to support:
+    I18n.available_locales = [:en,:de,:it,:fr]
 
-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.
+This defines which languages and translation files to import from 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
+* `rake i18n:export_translations`
+  Export all language files to CSV files (ENV 'locale' have to set for non-'en' locales else 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
+* `rake i18n:missing_keys`
   Find and list translation keys that do not exist in all locales
 
 
@@ -41,12 +50,20 @@ Following Rake tasks are added by the GEM to your Rails project:
 
 * 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` 
+* 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 
+* 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
+
+## Todo
+
+*Pull requests welcome!*
 
+* create mocked tests that do not have to download our sample CSV files
+* automate the creation of files in config/locales
+* automate the detection of which languages are supported
+* validate use with rails 2.x, other 3.x versions
 
 ## CHANGELOG
 

data/i18n-docs.gemspec

@@ -1,19 +1,18 @@
 Gem::Specification.new do |s|
   s.name        = 'i18n-docs'
-  s.version     = '0.0.4'
-  s.date        = '2012-04-20'
+  s.version     = '0.0.7'
+  s.date        = '2013-05-10'
   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.authors     = ["Georg Kunz", "Ivan Jovanovic", "Jeremy Seitz", "Eduard Schäli", "Robin Wu", "Esteban Pastorino"]
   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('mocha', '~> 0.13.3')
   s.add_development_dependency('awesome_print')
-  
+
 end

data/lib/localch_i18n/csv_to_yaml.rb

@@ -19,7 +19,12 @@ module LocalchI18n
 
     def write_files
       @locales.each do |locale|
-        output_file_path = defined?(Rails) ? Rails.root.join('config', 'locales', locale, @output_file) : "#{locale}_#{@output_file}"
+        if defined?(Rails)
+          output_file_path = Rails.root.join('config', 'locales', locale, @output_file)
+          FileUtils.mkdir_p File.dirname(output_file_path)
+        else
+          output_file_path = "#{locale}_#{@output_file}"
+        end
         File.open(output_file_path, 'w') do |file|
           final_translation_hash = {locale => @translations[locale]}
           file.puts YAML::dump(final_translation_hash)

data/lib/localch_i18n/translations.rb

@@ -1,4 +1,4 @@
-#
+# encoding: utf-8
 # Order of method calls
 #  download_files
 #  store_translations
@@ -6,32 +6,34 @@
 #
 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 
+      @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|
+        #ensure .yml filename
+        target_file = target_file + ".yml" if target_file !~ /\.yml$/
         # download file to tmp directory
         tmp_file = File.basename(target_file).gsub('.yml', '.csv')
         tmp_file = File.join(@tmp_folder, tmp_file)
@@ -39,31 +41,32 @@ module LocalchI18n
         @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}'"
+      doc_data = open(url).read.force_encoding('UTF-8')
       File.open(destination_file, 'w') do |dst|
-        dst.write(open(url).read)
+        dst.write(doc_data)
       end
     end
-    
+
   end
 end
 

data/lib/tasks/store_translations.rake

@@ -1,57 +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')]
-    
+
+    input_files = Dir[File.join(source_dir, ENV['locale'] || '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/test/test_helper.rb

@@ -1,26 +1,29 @@
 require 'test/unit'
 require 'fileutils'
-require 'localch-i18n'
+require 'mocha/setup'
 
+require 'i18n-docs'
+
+Rails = Struct.new(:dummy)
 
 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

@@ -1,11 +1,7 @@
 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

data/test/unit/translation_file_export_test.rb

@@ -1,84 +1,81 @@
 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', 
+                            '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
+      assert_match(/^key,(en|de|,){3}$/, output)
+      assert_match(/^numbers.one,(one|eins|,){3}$/, output)
     end
-    
-    
+
+
   end
-end
+end

data/test/unit/translations_test.rb

@@ -1,39 +1,36 @@
 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") {}
@@ -41,22 +38,23 @@ module UnitTests
       @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)
+      assert File.open(expected_file).read.encoding.name == 'UTF-8'
     end
-    
+
   end
-end
+end

metadata

@@ -1,34 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: i18n-docs
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
 - Georg Kunz
 - Ivan Jovanovic
 - Jeremy Seitz
+- Eduard Schäli
+- Robin Wu
+- Esteban Pastorino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-20 00:00:00.000000000 Z
+date: 2013-05-10 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
@@ -50,17 +37,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.3
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -119,22 +106,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -754739510145724626
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -754739510145724626
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Maintain translations in Google Docs and export them to your Rails project.
 test_files: []
+has_rdoc: