i18n-docs 0.0.10 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 652380c1ce699595e1e8f178caae06c4f8b5d838
-  data.tar.gz: f1bd46979506ce45acbfe438b8b8aaea5f78d75a
+  metadata.gz: 5dfaf572b4a18ef1c85ae6641dba030ca833fc2f
+  data.tar.gz: 85391361b7c3c7f2eea154a7aa5bed34b15e0ccb
 SHA512:
-  metadata.gz: cead59ccf41276601dfe75f336e7211ea1d71bac1b460f3518633d4d04da8de91befe70294d16dc76cc015076b2e07766ba36eb104f4809402f2f3c6d781db8d
-  data.tar.gz: ea99aa588c362abf09714aa18e375d0c057e011317c86c05c6e9fc481c984935777b20717551cebf300080f5e0265651679b5e13b583a879d716a292420958df
+  metadata.gz: 90bb038ed0f6651347019398af8373e8f1daf84007e70531e3aecb7a6c5f6952f9f7850078253cad119ba56cf4b92f6447e58290230ce6b218df8e079753fe32
+  data.tar.gz: 388126fd79d675b78b541c99da04c0b384eb10ad07562d59e0676320535c50e0d320fe5a530898922e76c398d9fc9086ee88570ff5900eadd19123e9c58941e5

data/README.md

@@ -16,7 +16,7 @@ Although we use it with Google Docs, it could be used with any CSV file.
 
 ### Configuration
 
-Add the GEM to your Rails project:
+Add the GEM to your project:
 
     gem 'i18n-docs'
 
@@ -27,6 +27,8 @@ Create a configuration file in `config/translations.yml`:
       forms.yml: "https://docs.google.com/spreadsheet/pub?key=0Ap...XveWc&single=true&gid=0&output=csv"
       ... etc ...
 
+#### Rails
+
 Finally, let Rails know what locales you will be using. Add this to `config/application.rb`:
 
     module Web
@@ -40,6 +42,41 @@ Finally, let Rails know what locales you will be using. Add this to `config/appl
 
 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.
 
+#### Non Rails
+
+Load rake tasks in your `Rakefile`:
+
+```ruby
+require 'i18n-docs'
+
+spec = Gem::Specification.find_by_name 'i18n-docs'
+load "#{spec.gem_dir}/lib/tasks/store_translations.rake"
+```
+
+Create `environment` task in your `Rakefile`:
+
+```ruby
+task :environment do
+  ...
+end
+
+```
+
+The minimal scope of this task is to set up `I18n.available_locales`.
+
+Translations will be stored under `config/locales` in project root directory.
+Don't forget to setup `I18n` accordingly:
+
+```ruby
+I18n.load_path = Dir[File.join(MyProject.root, 'config', 'locales', '**', '*.yml')]
+```
+
+And to load them:
+
+```ruby
+I18n.backend.load_translations
+```
+
 ### Rake Tasks
 
 Following Rake tasks are added by the GEM to your Rails project:
@@ -116,4 +153,3 @@ Follow this: http://stackoverflow.com/questions/12562697/opensslsslsslerror-ssl-
 ### 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/i18n-docs.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   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", "Eduard Schäli", "Robin Wunderlin", "Esteban Pastorino"]
-  s.email       = 'jeremy.seitz@local.ch'
+  s.authors     = ["Georg Kunz", "Ivan Jovanovic", "Jeremy Seitz", "Eduard Schäli", "Robin Wunderlin", "Esteban Pastorino", "Krzysztof Sakwerda"]
+  s.email       = 'eduard.schaeli@localsearch.ch'
   s.files       = `git ls-files`.split("\n")
   s.homepage    = 'https://github.com/local-ch/i18n-docs'
 
@@ -18,4 +18,5 @@ Gem::Specification.new do |s|
   s.add_dependency('rake')
 
   s.add_development_dependency('mocha', '~> 0.13.3')
+  s.add_development_dependency('test-unit', '~> 3.1.7')
 end

data/lib/i18n_docs/csv_to_yaml.rb

@@ -4,6 +4,10 @@ module I18nDocs
 
     attr_reader :input_file, :output_file, :locales, :translations
 
+    def self.root_path
+      @root_path ||= defined?(Rails) ? Rails.root : Pathname.new(Dir.pwd)
+    end
+
     def initialize(input_file, output_file, locales = [])
       @input_file = input_file
       @output_file = File.basename(output_file)
@@ -19,12 +23,9 @@ module I18nDocs
 
     def write_files
       @locales.each do |locale|
-        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
+        output_file_path = self.class.root_path.join('config', 'locales', locale, @output_file)
+        FileUtils.mkdir_p File.dirname(output_file_path)
+
         File.open(output_file_path, 'w') do |file|
           final_translation_hash = {locale => @translations[locale]}
           file.puts YAML::dump(final_translation_hash)
@@ -71,6 +72,11 @@ module I18nDocs
           raise "Error around key '#{keys.join '.'}': Expected #{memo.inspect} to be a Hash"
         end
       end
+
+      if data_hash.is_a? String
+        raise "Error around key '#{keys.join '.'}': Expected #{data_hash.inspect} to be a Hash"
+      end
+
       data_hash[leaf] = value
     end
 

data/lib/i18n_docs/missing_keys_finder.rb

@@ -71,10 +71,10 @@ module I18nDocs
 
     def collect_keys(scope, translations)
       full_keys = []
-      translations.to_a.each do |key, translations|
+      translations.to_a.each do |key, translation|
         new_scope = scope.dup << key
-        if translations.is_a?(Hash)
-          full_keys += collect_keys(new_scope, translations)
+        if translation.is_a?(Hash)
+          full_keys += collect_keys(new_scope, translation)
         else
           full_keys << new_scope.join('.')
         end
@@ -102,7 +102,7 @@ module I18nDocs
       @yaml = {}
       begin
         @yaml = YAML.load_file(File.join(Rails.root, 'config', 'ignore_missing_i18n_keys.yml'))
-      rescue => e
+      rescue
         STDERR.puts "No ignore_missing_keys.yml config file."
       end
 

data/lib/i18n_docs/translation_file_export.rb

@@ -52,7 +52,7 @@ module I18nDocs
 
       input_file = File.join(@source_dir, locale, @source_file)
       translations = {}
-      translations = YAML.load_file(input_file) if File.exists?(input_file)
+      translations = YAML.load_file(input_file) if File.exist?(input_file)
       translations[locale]
     end
 

data/lib/i18n_docs/translations.rb

@@ -26,7 +26,7 @@ module I18nDocs
 
     def load_config
       @settings = {}
-      @settings = YAML.load_file(config_file) if File.exists?(config_file)
+      @settings = YAML.load_file(config_file) if File.exist?(config_file)
     end
 
     def download_files
@@ -69,5 +69,3 @@ module I18nDocs
 
   end
 end
-
-

data/lib/i18n_docs/version.rb

@@ -1,3 +1,3 @@
 module I18nDocs
-  VERSION = '0.0.10'
+  VERSION = '0.1.0'
 end

data/lib/tasks/store_translations.rake

@@ -9,12 +9,11 @@ namespace :i18n do
 
   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)
+    config_file = I18nDocs::CsvToYaml.root_path.join('config', 'translations.yml')
+    raise "No config file 'config/translations.yml' found." if !File.exist?(config_file)
 
-    tmp_dir = Rails.root.join('tmp')
+    tmp_dir = I18nDocs::CsvToYaml.root_path.join('tmp')
     Dir.mkdir(tmp_dir) unless Dir.exist?(tmp_dir)
 
     translations = I18nDocs::Translations.new(config_file, tmp_dir)
@@ -26,10 +25,8 @@ namespace :i18n do
 
   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')
+    source_dir  = I18nDocs::CsvToYaml.root_path.join('config', 'locales')
+    output_dir  = I18nDocs::CsvToYaml.root_path.join('tmp')
     locales     = I18n.available_locales
 
     input_files = Dir[File.join(source_dir, ENV['locale'] || 'en', '*.yml')]
@@ -54,5 +51,3 @@ namespace :i18n do
   end
 
 end
-
-

data/test/fixtures/config.yml

@@ -6,4 +6,4 @@
 #   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"
+  download.yml: "https://docs.google.com/spreadsheets/d/1PbmkqamXuNyP7gnVARpeCfV8rA7WvX98dTqsQB3Wdts/pub?output=csv"

data/test/fixtures/error.csv

@@ -0,0 +1,3 @@
+key,en,de
+top_level.key,Value1,Value2
+top_level.key.another_key,Value3,Value4

data/test/test_helper.rb

@@ -16,7 +16,7 @@ module TestHelper
   end
 
   def create_tmp_dir
-    FileUtils::mkdir(tmp_dir) if ! File.exists?(tmp_dir)
+    FileUtils::mkdir(tmp_dir) if ! File.exist?(tmp_dir)
   end
 
   def remove_tmp_dir
@@ -24,6 +24,3 @@ module TestHelper
   end
 
 end
-
-
-

data/test/unit/csv_to_yaml_test.rb

@@ -134,10 +134,10 @@ module UnitTests
     end
 
     def test_write_files
-      assert !File.exists?(@output_file)
+      assert !File.exist?(@output_file)
       @csv_to_yaml.process
       @csv_to_yaml.write_files
-      assert File.exists?(@output_file)
+      assert File.exist?(@output_file)
     end
 
     def test_key_has_spaces
@@ -149,5 +149,14 @@ module UnitTests
       assert_equal 'yes', translations['en']['has']['space']
     end
 
+    def test_wrong_csv_format_error_message
+      @input_file  = File.join(fixture_path, 'error.csv')
+      @csv_to_yaml = I18nDocs::CsvToYaml.new(@input_file, @output_file, @locales)
+
+      assert_raise "Error around key 'top_level.key.another_key': Expected \"Value2\" to be a Hash" do
+        @csv_to_yaml.process
+      end
+    end
+
   end
 end

data/test/unit/translation_file_export_test.rb

@@ -24,9 +24,9 @@ module UnitTests
 
 
     def test_export
-      assert !File.exists?(@output_file)
+      assert !File.exist?(@output_file)
       @exporter.export
-      assert File.exists?(@output_file), "Expected to have a CSV file written"
+      assert File.exist?(@output_file), "Expected to have a CSV file written"
     end
 
     def dtest_load_language

data/test/unit/translations_test.rb

@@ -26,33 +26,33 @@ module UnitTests
     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}'"
+      assert !File.exist?(@tmp_file)
+      @translations.download("https://docs.google.com/spreadsheets/d/1PbmkqamXuNyP7gnVARpeCfV8rA7WvX98dTqsQB3Wdts/pub?output=csv", @tmp_file)
+      assert File.exist?(@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)
+      assert File.exist?(@tmp_file)
       @translations.clean_up
-      assert !File.exists?(@tmp_file), "Expected to delete file"
+      assert !File.exist?(@tmp_file), "Expected to delete file"
     end
 
     def test_store_translations
-      assert !File.exists?(@output_file)
+      assert !File.exist?(@output_file)
 
       @translations.csv_files = {@output_file => @fixture_file}
       @translations.store_translations
 
-      assert File.exists?(@output_file)
+      assert File.exist?(@output_file)
     end
 
     def test_download_files
       expected_file = File.join(tmp_dir, 'download.csv')
-      assert !File.exists?(expected_file)
+      assert !File.exist?(expected_file)
       @translations.download_files
-      assert File.exists?(expected_file)
+      assert File.exist?(expected_file)
       assert File.open(expected_file).read.encoding.name == 'UTF-8'
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-docs
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.0
 platform: ruby
 authors:
 - Georg Kunz
@@ -10,6 +10,7 @@ authors:
 - Eduard Schäli
 - Robin Wunderlin
 - Esteban Pastorino
+- Krzysztof Sakwerda
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -43,10 +44,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.3
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.7
 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
+email: eduard.schaeli@localsearch.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -67,6 +82,7 @@ files:
 - test/fixtures/config.yml
 - test/fixtures/de/header.yml
 - test/fixtures/en/header.yml
+- test/fixtures/error.csv
 - test/fixtures/minimal.csv
 - test/fixtures/test.csv
 - test/test_helper.rb
@@ -92,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.5
 signing_key: 
 specification_version: 4
 summary: Maintain translations in Google Docs and export them to your Rails project.