i18n-docs 0.0.9 → 0.1.1

data/lib/{localch_i18n → i18n_docs}/translations.rb

@@ -1,12 +1,10 @@
-# encoding: utf-8
 # Order of method calls
 #  download_files
 #  store_translations
 #  clean_up
 #
-module LocalchI18n
+module I18nDocs
   class Translations
-
     attr_accessor :locales, :tmp_folder, :config_file, :csv_files
 
     def initialize(config_file = nil, tmp_folder = nil)
@@ -26,14 +24,14 @@ module LocalchI18n
 
     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
       files = @settings['files']
       files.each do |target_file, url|
-        #ensure .yml filename
-        target_file = target_file + ".yml" if target_file !~ /\.yml$/
+        # ensure .yml filename
+        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)
@@ -54,7 +52,7 @@ module LocalchI18n
 
     def clean_up
       # remove all tmp files
-      @csv_files.each do |target_file, csv_file|
+      @csv_files.each do |_target_file, csv_file|
         File.unlink(csv_file)
       end
     end
@@ -62,12 +60,14 @@ module LocalchI18n
     def download(url, destination_file)
       puts "Download '#{url}' to '#{destination_file}'"
       doc_data = open(url).read.force_encoding('UTF-8')
+      if (subs = @settings['substitutions'])
+        subs.each do |sub|
+          doc_data.gsub! sub['from'], sub['to']
+        end
+      end
       File.open(destination_file, 'w') do |dst|
         dst.write(doc_data)
       end
     end
-
   end
 end
-
-

data/lib/i18n_docs/version.rb

@@ -0,0 +1,3 @@
+module I18nDocs
+  VERSION = '0.1.1'.freeze
+end

data/lib/tasks/store_translations.rake

@@ -1,58 +1,49 @@
 
 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)
+  desc 'Find and list translation keys that do not exist in all locales'
+  task missing_keys: :environment do
+    finder = I18nDocs::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)
+  desc 'Download translations from Google Spreadsheet and save them to YAML files.'
+  task import_translations: :environment do
+    config_file = I18nDocs::CsvToYaml.root_path.join('config', 'translations.yml')
+    raise "No config file 'config/translations.yml' found." unless 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 = LocalchI18n::Translations.new(config_file, tmp_dir)
+    translations = I18nDocs::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')
+  desc 'Export all language files to CSV files (only files contained in en folder are considered)'
+  task export_translations: :environment do
+    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')]
 
-    puts ""
+    puts ''
     puts "  Detected locales: #{locales}"
-    puts "  Detected files:"
-    input_files.each {|f| puts "    * #{File.basename(f)}" }
+    puts '  Detected files:'
+    input_files.each { |f| puts "    * #{File.basename(f)}" }
 
-    puts ""
-    puts "  Start exporting files:"
+    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 = I18nDocs::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 ""
+    puts ''
+    puts '  CSV files can be removed safely after uploading them manually to Google Spreadsheet.'
+    puts ''
   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

@@ -1,3 +1,6 @@
+require 'simplecov'
+SimpleCov.start
+
 require 'test/unit'
 require 'fileutils'
 require 'mocha/setup'
@@ -7,7 +10,6 @@ require 'i18n-docs'
 Rails = Struct.new(:dummy)
 
 module TestHelper
-
   def fixture_path
     File.join(File.expand_path(File.dirname(__FILE__)), 'fixtures')
   end
@@ -17,14 +19,10 @@ module TestHelper
   end
 
   def create_tmp_dir
-    FileUtils::mkdir(tmp_dir) if ! File.exists?(tmp_dir)
+    FileUtils.mkdir(tmp_dir) unless File.exist?(tmp_dir)
   end
 
   def remove_tmp_dir
-    FileUtils::rmtree(tmp_dir)
+    FileUtils.rmtree(tmp_dir)
   end
-
 end
-
-
-

data/test/unit/csv_to_yaml_test.rb

@@ -3,7 +3,6 @@ require 'test_helper'
 # run test: ruby -I test/ -I lib/ test/unit/csv_to_yaml_test.rb
 
 module UnitTests
-
   class CsvToYamlTest < Test::Unit::TestCase
     include TestHelper
 
@@ -12,11 +11,11 @@ module UnitTests
 
       @input_file  = File.join(fixture_path, 'minimal.csv')
       @output_file = File.join(tmp_dir, 'test.yml')
-      @locales = ['de', 'en']
+      @locales = %w[de en]
 
-      Rails.stubs(:root).returns(stub(:join => @output_file))
+      Rails.stubs(:root).returns(stub(join: @output_file))
 
-      @csv_to_yaml = LocalchI18n::CsvToYaml.new(@input_file, @output_file, @locales)
+      @csv_to_yaml = I18nDocs::CsvToYaml.new(@input_file, @output_file, @locales)
     end
 
     def teardown
@@ -24,8 +23,8 @@ module UnitTests
     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'}
+      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)
 
@@ -37,8 +36,8 @@ module UnitTests
     end
 
     def test_empty_row
-      row1 = {'key' => 'homepage.meta.title', 'en' => 'Phonebook of Switzerland', 'de' => 'Telefonbuch der Schweiz'}
-      row2 = {'key' => nil, 'en' => 'Welcome', 'de' => 'Willkommen'}
+      row1 = { 'key' => 'homepage.meta.title', 'en' => 'Phonebook of Switzerland', 'de' => 'Telefonbuch der Schweiz' }
+      row2 = { 'key' => nil, 'en' => 'Welcome', 'de' => 'Willkommen' }
       @csv_to_yaml.process_row(row1)
       @csv_to_yaml.process_row(row2)
 
@@ -48,18 +47,18 @@ module UnitTests
     end
 
     def test_row_containing_non_locale_columns
-      row = {'key' => 'homepage.title', 'en' => "We are the Phonebook", 'de' => 'Test DE', 'comment' => "Test comment"}
+      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' => '_'}
+      row = { 'key' => 'homepage.meta.title', 'en' => 'Phonebook of Switzerland', 'de' => '_' }
       @csv_to_yaml.process_row(row)
 
       translations = @csv_to_yaml.translations
@@ -67,9 +66,8 @@ module UnitTests
       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' => ''}
+      row = { 'key' => 'homepage.meta.title', 'en' => 'Phonebook of Switzerland', 'de' => '' }
       @csv_to_yaml.process_row(row)
 
       translations = @csv_to_yaml.translations
@@ -77,9 +75,8 @@ module UnitTests
       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' => ' '}
+      row = { 'key' => 'homepage.meta.title', 'en' => 'Phonebook of Switzerland', 'de' => ' ' }
       @csv_to_yaml.process_row(row)
 
       translations = @csv_to_yaml.translations
@@ -88,7 +85,7 @@ module UnitTests
     end
 
     def test_nil_value
-      row = {'key' => 'homepage.meta.title', 'en' => 'Phonebook of Switzerland', 'de' => nil}
+      row = { 'key' => 'homepage.meta.title', 'en' => 'Phonebook of Switzerland', 'de' => nil }
       @csv_to_yaml.process_row(row)
 
       translations = @csv_to_yaml.translations
@@ -96,10 +93,9 @@ module UnitTests
       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'}
+      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)
 
@@ -109,15 +105,28 @@ module UnitTests
       assert_equal 'Phonebook of Switzerland', translations['en']['homepage']['meta']['title']
     end
 
+    def test_row_for_missing_locale_key
+      row = { 'key' => 'homepage.meta.title', 'en' => 'Phonebook of Switzerland' }
+      assert_raise RuntimeError.new('Locale missing for key homepage.meta.title! (locales in app: ["de", "en"] / locales in file: ["en"])') do
+        @csv_to_yaml.process_row(row)
+      end
+    end
 
     def test_store_translations
-      keys = ['homepage', 'meta', 'title']
+      keys = %w[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_store_translations_with_faulty_locale
+      keys = %w[homepage meta title]
+      assert_raise RuntimeError.new("Error around key 'homepage.meta.title': Expected nil to be a Hash") do
+        @csv_to_yaml.store_translation(keys, 'zz', 'Telefonbuch der Schweiz')
+      end
+    end
+
     def test_process
       @locales.each do |locale|
         assert_empty @csv_to_yaml.translations[locale], "expected translation hash for locale '#{locale}' to be empty"
@@ -134,14 +143,14 @@ 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
-      row = {'key' => 'has. space', 'en' => 'yes', 'de' => 'ja'}
+      row = { 'key' => 'has. space', 'en' => 'yes', 'de' => 'ja' }
       @csv_to_yaml.process_row(row)
 
       translations = @csv_to_yaml.translations
@@ -149,5 +158,13 @@ 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 RuntimeError.new("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

@@ -12,9 +12,9 @@ module UnitTests
       source_dir = fixture_path
       source_file = 'header.yml'
       output_dir = tmp_dir
-      locales = ['en', 'de']
+      locales = %w[en de]
 
-      @exporter = LocalchI18n::TranslationFileExport.new(source_dir, source_file, output_dir, locales)
+      @exporter = I18nDocs::TranslationFileExport.new(source_dir, source_file, output_dir, locales)
       @output_file = File.join(output_dir, 'header.csv')
     end
 
@@ -22,30 +22,28 @@ module UnitTests
       remove_tmp_dir
     end
 
-
     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
       translations = @exporter.load_language('de')
 
-      assert translations, "Expected to return a hash with translations"
-      assert_equal translations['header']['search'], "Finden"
+      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'
-                         }
+      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']
@@ -66,8 +64,8 @@ module UnitTests
     end
 
     def dtest_write_to_csv
-      @exporter.translations = {'de' => {'numbers.one' => 'eins'},
-                                'en' => {'numbers.one' => 'one'}}
+      @exporter.translations = { 'de' => { 'numbers.one' => 'eins' },
+                                 'en' => { 'numbers.one' => 'one' } }
 
       @exporter.write_to_csv
 
@@ -75,7 +73,5 @@ module UnitTests
       assert_match(/^key,(en|de|,){3}$/, output)
       assert_match(/^numbers.one,(one|eins|,){3}$/, output)
     end
-
-
   end
 end

data/test/unit/translations_test.rb

@@ -10,15 +10,15 @@ module UnitTests
       create_tmp_dir
 
       config_file = File.join(fixture_path, 'config.yml')
-      @translations = LocalchI18n::Translations.new(config_file, tmp_dir)
+      @translations = I18nDocs::Translations.new(config_file, tmp_dir)
       @translations.tmp_folder = tmp_dir
-      @translations.locales = ['de', 'en']
+      @translations.locales = %w[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))
+      Rails.stubs(:root).returns(stub(join: @output_file))
     end
 
     def teardown
@@ -26,35 +26,35 @@ 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)
+      sheet_url = 'https://docs.google.com/spreadsheets/d/1PbmkqamXuNyP7gnVARpeCfV8rA7WvX98dTqsQB3Wdts/pub?output=csv'
+      @translations.download(sheet_url, @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)
+      @translations.csv_files = { 'dummy.yml' => @tmp_file }
+      File.open(@tmp_file, 'w') {}
+      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.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
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-docs
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.1
 platform: ruby
 authors:
 - Georg Kunz
@@ -10,6 +10,7 @@ authors:
 - Eduard Schäli
 - Robin Wunderlin
 - Esteban Pastorino
+- Krzysztof Sakwerda
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -44,44 +45,76 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.13.3
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.7
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.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
+email: eduard.schaeli@localsearch.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
 - i18n-docs.gemspec
 - lib/i18n-docs.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/localch_i18n/version.rb
+- lib/i18n_docs/csv_to_yaml.rb
+- lib/i18n_docs/missing_keys_finder.rb
+- lib/i18n_docs/translation_file_export.rb
+- lib/i18n_docs/translations.rb
+- lib/i18n_docs/version.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/error.csv
 - test/fixtures/minimal.csv
 - test/fixtures/test.csv
 - test/test_helper.rb
@@ -106,8 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Maintain translations in Google Docs and export them to your Rails project.

data/lib/localch_i18n/version.rb

@@ -1,3 +0,0 @@
-module LocalchI18n
-  VERSION = '0.0.9'
-end

data/tasks/test.rake

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