i18n-docs 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5dfaf572b4a18ef1c85ae6641dba030ca833fc2f
-  data.tar.gz: 85391361b7c3c7f2eea154a7aa5bed34b15e0ccb
+SHA256:
+  metadata.gz: 856b480dbfe843f57e65141e6c217c80ee30944c95131d82eec949e700b19517
+  data.tar.gz: d572f840dda955f15e2f8794d517e5226f22527779d68a7b3b83a3133faa3c05
 SHA512:
-  metadata.gz: 90bb038ed0f6651347019398af8373e8f1daf84007e70531e3aecb7a6c5f6952f9f7850078253cad119ba56cf4b92f6447e58290230ce6b218df8e079753fe32
-  data.tar.gz: 388126fd79d675b78b541c99da04c0b384eb10ad07562d59e0676320535c50e0d320fe5a530898922e76c398d9fc9086ee88570ff5900eadd19123e9c58941e5
+  metadata.gz: 218816a28ac21a8063ebcc84230d88d50ea30ee599b1c2d4292bd58e583cee9448b7ac8a51817151f5f3b856ab55b07393ebaa2ef6cbd39dc468260a0b32c769
+  data.tar.gz: 361d4054384bc505de49f635fd1532c65a396702a883de438023ef83dbb72e5dc82740f82c772ea9871d34f908ab8c9f706df9fbc9b25ab1cf1fbc39299affc5

data/.codeclimate.yml

@@ -0,0 +1,4 @@
+engines:
+  rubocop:
+    enabled: true
+    channel: rubocop-0-48

data/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    
+    strategy:
+      matrix:
+        ruby-version: [head, 3.0, 2.7, 2.6, 2.5, 2.4, 2.3]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -11,3 +11,4 @@ tmp/*
 .ruby-version
 .ruby-gemset
 rdoc/
+coverage/

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/ClassLength:
+  Exclude:
+    - 'test/**/*_test.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,50 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-07-11 14:36:42 +0200 using RuboCop version 0.48.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 8
+Metrics/AbcSize:
+  Max: 30
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 37
+
+# Offense count: 4
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 26
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# Offense count: 1
+Style/AsciiComments:
+  Exclude:
+    - 'lib/i18n_docs/missing_keys_finder.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/i18n-docs.rb'
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Style/FileName:
+  Exclude:
+    - 'lib/i18n-docs.rb'
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/i18n_docs/csv_to_yaml.rb'

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Bundler will treat runtime dependencies like base dependencies, and
 # development dependencies will be added by default to the :development group.

data/README.md

@@ -1,17 +1,30 @@
 # i18n-docs
 
+[![Build Status](https://travis-ci.org/renuo/i18n-docs.svg?branch=master)](https://travis-ci.org/renuo/i18n-docs)
+[![Code Climate](https://codeclimate.com/github/renuo/i18n-docs/badges/gpa.svg)](https://codeclimate.com/github/renuo/i18n-docs)
+[![Test Coverage](https://codeclimate.com/github/renuo/i18n-docs/badges/coverage.svg)](https://codeclimate.com/github/renuo/i18n-docs/coverage)
+[![Issue Count](https://codeclimate.com/github/renuo/i18n-docs/badges/issue_count.svg)](https://codeclimate.com/github/renuo/i18n-docs)
+[![Dependency Status](https://gemnasium.com/badges/github.com/renuo/i18n-docs.svg)](https://gemnasium.com/github.com/renuo/i18n-docs)
+
 **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.
 
 *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
 * check YAML files for missing translations (`rake i18n:find_missing_keys`)
 
+## Tests
+
+Verify the quality of this gem by checking out this repo and running:
+
+    bundle install
+    rake test
+
 ## Usage
 
 ### Configuration
@@ -99,6 +112,19 @@ Following Rake tasks are added by the GEM to your Rails project:
 ![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
 
+
+## Configuraiton
+
+You can include a set of substitions for preprocessing the CSV after downloading it and before parsing it. Here is an example that replaces non-breaking spaces with normal ones.
+
+    files:
+      navigation.yml: "https://docs.google.com/spreadsheet/pub?key=ab43...34f3&single=true&gid=0&output=csv"
+
+    substitutions:
+      - from: "\u00A0"
+        to: ' '
+
+
 ## Error Handling
 
 I case of the error `OpenSSL::SSL::SSLError: SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed` when running `rake i18n:import_translations`
@@ -115,6 +141,15 @@ Follow this: http://stackoverflow.com/questions/12562697/opensslsslsslerror-ssl-
 
 ## CHANGELOG
 
+### 0.1.1
+
+* add `substitutions` config
+
+
+### 0.1.0
+
+* usable outside of rails
+
 ### 0.0.10
 
 * rename module to be inline with the gem-name

data/Rakefile

@@ -25,4 +25,4 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-task :default => [:test]
+task default: [:test]

data/i18n-docs.gemspec

@@ -1,4 +1,4 @@
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 # Maintain your gem's version:
 require 'i18n_docs/version'
 
@@ -7,9 +7,12 @@ Gem::Specification.new do |s|
   s.name        = 'i18n-docs'
   s.version     = I18nDocs::VERSION
   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", "Krzysztof Sakwerda"]
+  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', 'Krzysztof Sakwerda']
   s.email       = 'eduard.schaeli@localsearch.ch'
   s.files       = `git ls-files`.split("\n")
   s.homepage    = 'https://github.com/local-ch/i18n-docs'
@@ -19,4 +22,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency('mocha', '~> 0.13.3')
   s.add_development_dependency('test-unit', '~> 3.1.7')
+  s.add_development_dependency('simplecov', '~> 0.16.1')
+  s.add_development_dependency('rubocop', '~> 0.48.0')
 end

data/lib/i18n-docs.rb

@@ -9,8 +9,7 @@ require 'i18n_docs/translation_file_export'
 if defined?(Rails)
   class I18nDocs::Railtie < Rails::Railtie
     rake_tasks do
-      Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+      Dir[File.join(File.dirname(__FILE__), 'tasks/*.rake')].each { |f| load f }
     end
   end
 end
-

data/lib/i18n_docs/csv_to_yaml.rb

@@ -1,7 +1,5 @@
 module I18nDocs
-
   class CsvToYaml
-
     attr_reader :input_file, :output_file, :locales, :translations
 
     def self.root_path
@@ -20,21 +18,19 @@ module I18nDocs
       end
     end
 
-
     def write_files
       @locales.each do |locale|
         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)
+          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)
@@ -47,14 +43,15 @@ module I18nDocs
 
       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)
+        unless row_hash.key?(locale)
+          raise "Locale missing for key #{key}! (locales in app: #{@locales} / locales in file: #{row_hash.keys})"
+        end
         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
+      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 == '_'
 
@@ -63,7 +60,7 @@ module I18nDocs
       leaf = keys.last
       data_hash = tree.inject(@translations[locale]) do |memo, k|
         if memo.is_a? Hash
-          if memo.has_key?(k)
+          if memo.key?(k)
             memo[k]
           else
             memo[k] = {}
@@ -79,7 +76,5 @@ module I18nDocs
 
       data_hash[leaf] = value
     end
-
   end
-
 end

data/lib/i18n_docs/missing_keys_finder.rb

@@ -1,15 +1,14 @@
-
 module I18nDocs
   class MissingKeysFinder
     def initialize(backend)
       @backend = backend
-      self.load_config
-      self.load_translations
+      load_config
+      load_translations
     end
 
     # Returns an array with all keys from all locales
     def all_keys
-      I18n.backend.send(:translations).collect do |check_locale, translations|
+      I18n.backend.send(:translations).collect do |_check_locale, translations|
         collect_keys([], translations).sort
       end.flatten.uniq
     end
@@ -20,12 +19,10 @@ module I18nDocs
 
       missing_keys = {}
       all_keys.each do |key|
-
         I18n.available_locales.each do |locale|
-
           skip = false
           ls = locale.to_s
-          if !@yaml[ls].nil?
+          unless @yaml[ls].nil?
             @yaml[ls].each do |re|
               if key.match(re)
                 skip = true
@@ -45,24 +42,26 @@ module I18nDocs
       end
 
       output_missing_keys(missing_keys)
-      return missing_keys
+      missing_keys
     end
 
+    # rubocop:disable Metrics/LineLength
     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
+      if missing_keys.any?
         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"
+        puts 'No keys are missing'
       end
     end
+    # rubocop:enable Metrics/LineLength
 
     def output_unique_key_stats(keys)
       number_of_keys = keys.size
@@ -79,13 +78,13 @@ module I18nDocs
           full_keys << new_scope.join('.')
         end
       end
-      return full_keys
+      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)
+      I18n.translate(key, raise: true)
       return true
     rescue I18n::MissingInterpolationArgument
       return true
@@ -103,10 +102,8 @@ module I18nDocs
       begin
         @yaml = YAML.load_file(File.join(Rails.root, 'config', 'ignore_missing_i18n_keys.yml'))
       rescue
-        STDERR.puts "No ignore_missing_keys.yml config file."
+        STDERR.puts 'No ignore_missing_keys.yml config file.'
       end
-
     end
-
   end
 end

data/lib/i18n_docs/translation_file_export.rb

@@ -1,6 +1,5 @@
 module I18nDocs
   class TranslationFileExport
-
     attr_accessor :translations
 
     def initialize(source_dir, source_file, output_dir, locales)
@@ -8,25 +7,23 @@ module I18nDocs
       @source_file = source_file
 
       @output_file = File.join(output_dir, source_file.gsub('.yml', '.csv'))
-      @locales = locales.map {|l| l.to_s }
+      @locales = locales.map(&:to_s)
 
       @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)
+      CSV.open(@output_file, 'wb') do |csv|
+        csv << (['key'] + @locales)
 
         @translations[main_locale].keys.each do |key|
           values = @locales.map do |locale|
@@ -35,10 +32,8 @@ module I18nDocs
           csv << values.unshift(key)
         end
       end
-
     end
 
-
     def load_translations
       @locales.each do |locale|
         translation_hash = load_language(locale)
@@ -47,7 +42,6 @@ module I18nDocs
     end
 
     def load_language(locale)
-
       puts "    #{@source_file}: load translations for '#{locale}'"
 
       input_file = File.join(@source_dir, locale, @source_file)
@@ -71,7 +65,5 @@ module I18nDocs
       end
       flat_hash
     end
-
   end
-
 end

data/lib/i18n_docs/translations.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # Order of method calls
 #  download_files
 #  store_translations
@@ -6,7 +5,6 @@
 #
 module I18nDocs
   class Translations
-
     attr_accessor :locales, :tmp_folder, :config_file, :csv_files
 
     def initialize(config_file = nil, tmp_folder = nil)
@@ -32,8 +30,8 @@ module I18nDocs
     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 I18nDocs
 
     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,10 +60,14 @@ module I18nDocs
     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

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

data/lib/tasks/store_translations.rake

@@ -1,17 +1,15 @@
 
 namespace :i18n do
-
-  desc "Find and list translation keys that do not exist in all locales"
-  task :missing_keys => :environment do
+  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
-
+  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." if !File.exist?(config_file)
+    raise "No config file 'config/translations.yml' found." unless File.exist?(config_file)
 
     tmp_dir = I18nDocs::CsvToYaml.root_path.join('tmp')
     Dir.mkdir(tmp_dir) unless Dir.exist?(tmp_dir)
@@ -20,24 +18,23 @@ namespace :i18n do
     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
+  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)
@@ -45,9 +42,8 @@ namespace :i18n do
       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/test_helper.rb

@@ -1,12 +1,15 @@
+require 'simplecov'
+SimpleCov.start
+
 require 'test/unit'
 require 'fileutils'
 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
@@ -16,11 +19,10 @@ module TestHelper
   end
 
   def create_tmp_dir
-    FileUtils::mkdir(tmp_dir) if ! File.exist?(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,9 +11,9 @@ 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 = I18nDocs::CsvToYaml.new(@input_file, @output_file, @locales)
     end
@@ -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"
@@ -141,7 +150,7 @@ module UnitTests
     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
@@ -153,10 +162,9 @@ module UnitTests
       @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
+      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,7 +12,7 @@ module UnitTests
       source_dir = fixture_path
       source_file = 'header.yml'
       output_dir = tmp_dir
-      locales = ['en', 'de']
+      locales = %w[en de]
 
       @exporter = I18nDocs::TranslationFileExport.new(source_dir, source_file, output_dir, locales)
       @output_file = File.join(output_dir, 'header.csv')
@@ -22,30 +22,28 @@ module UnitTests
       remove_tmp_dir
     end
 
-
     def test_export
       assert !File.exist?(@output_file)
       @exporter.export
-      assert File.exist?(@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

@@ -12,13 +12,13 @@ module UnitTests
       config_file = File.join(fixture_path, 'config.yml')
       @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
@@ -27,22 +27,23 @@ module UnitTests
 
     def test_download
       assert !File.exist?(@tmp_file)
-      @translations.download("https://docs.google.com/spreadsheets/d/1PbmkqamXuNyP7gnVARpeCfV8rA7WvX98dTqsQB3Wdts/pub?output=csv", @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") {}
+      @translations.csv_files = { 'dummy.yml' => @tmp_file }
+      File.open(@tmp_file, 'w') {}
       assert File.exist?(@tmp_file)
       @translations.clean_up
-      assert !File.exist?(@tmp_file), "Expected to delete file"
+      assert !File.exist?(@tmp_file), 'Expected to delete file'
     end
 
     def test_store_translations
       assert !File.exist?(@output_file)
 
-      @translations.csv_files = {@output_file => @fixture_file}
+      @translations.csv_files = { @output_file => @fixture_file }
       @translations.store_translations
 
       assert File.exist?(@output_file)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-docs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Georg Kunz
@@ -58,6 +58,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         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'
@@ -66,7 +94,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -107,8 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.5
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Maintain translations in Google Docs and export them to your Rails project.