i18n-migrations 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d5b7ed6e5c2a76bacd9a1d12916d0f7fbba5c0d
-  data.tar.gz: ba7a796930572af0d6fa2f6f8ff9433c1f0b9032
+  metadata.gz: 2789bfb627b7453b272680ee6eede9f6bedbfacf
+  data.tar.gz: fc625101156e0217ece5a1fe2379686e7f4401a6
 SHA512:
-  metadata.gz: 1ce65173fa1d15de262b216f589eeec8885780a329a65e03866b1066e677546e56f88c2e52b84c2e3dac9c4ccf93aa4db0ca09bf2bab8798b929500a676f63aa
-  data.tar.gz: 7dd74b2511050c59a71e679009a07997d0a11183ca17c0d1c76e40f15ea7c5afbb49406fc3cdc71272d3fcb2485a93855e52f352227087b213f7ac8758154938
+  metadata.gz: 0e74ac7d4a4e593cca6422d7be921ec73b3e3a188190bed95a097a54adafd1f9942858724a3cfc548329f6083941575f6bc3b8a598929d548908e766eb5cfa96
+  data.tar.gz: 85815a347cb2fc71bdba8ef5d0ffb711336b90c9a6d15d26d4b539487acb3c23ff73a313a408f47e2e2f0e97ee6b4374424cbe196cdf679f870eeb0cc051c8a4

data/.i18n-migrations.default.yml

@@ -16,7 +16,12 @@ google_service_account_key_path: i18n/google_drive_key.json
 
 # each locale will have a spreadsheet that translators will use to do their work, these are the links to them
 google_spreadsheets:
-  es: https://docs.google.com/spreadsheets/d/1QGCzMbTyxF2gSUpWwRKAq-mMFIgJwsOLp1lfXsSF5X0/edit
+  es: https://docs.google.com/spreadsheets/d/YOUR_SPREADSHEET_ID/edit
 
 # this is your api key to use google translate
 google_translate_api_key: [INSERT_GOOGLE_TRANSLATE_API_KEY]
+
+# put things like your product name here along with any possible mistranslations
+do_not_translate:
+  "I18n Migrations":
+    - I18n Migraciones

data/README.md

@@ -27,10 +27,40 @@ And then execute:
 Or install it yourself as:
 
     $ gem install i18n-migrations
+    
+From your project file, you'll want to run 
+
+    $ i18n-migrate setup
+    
+This will create a config file you can edit.
 
 ## Usage
 
-TODO: Write usage instructions here
+Let's imagine that your config file look like this:
+
+    migration_dir: i18n/migrate
+    locales_dir: config/locales
+    main_locale: en
+    other_locales:
+    - es
+    ..
+
+In your project file, you should then have all your english terms in ```config/locales/en.yml```
+
+To create a new locale (like es.yml):
+
+1. Translate all the terms w/ google translate
+
+    > i18n-migrate new_locale es
+    
+2. Create a spreadsheet that is world editable (for now). You'll want to add the link to it to your config file. It should look like:
+
+    | key | en | es | notes | 
+
+2. Push this to your google spreadsheet (the -f means it won't try to pull first)
+
+    > i18n-migrate push -f es
+
 
 ## Development
 

data/bin/i18n-migrate

@@ -5,6 +5,10 @@ require_relative '../lib/i18n/migrations/config'
 
 migrator = I18n::Migrations::Migrator.new
 
+def extract_option(name)
+  !!ARGV.delete(name)
+end
+
 case ARGV.shift
   when 'setup'
     puts 'Where should we create a default config file? [.]'
@@ -38,7 +42,11 @@ case ARGV.shift
     migrator.pull ARGV[0] || 'all'
 
   when 'push'
-    migrator.push ARGV[0] || 'all'
+    force = extract_option('-f')
+    migrator.push(ARGV[0] || 'all', force)
+
+  when 'validate'
+    migrator.validate(ARGV[0] || 'all')
 
   when 'new_locale'
     locale = ARGV.shift
@@ -63,7 +71,8 @@ Commands:
   rollback - Rollback to previous version.
   redo - Rollback and then migrate again.
   pull - Pull latest translation spreadsheet. 
-  push - Push to translation spreadsheet.
+  push - Push to translation spreadsheet. (-f to force, without doing a pull first)
+  validate - check all translations according to our rules and fix what we can
   new_locale - Copy your current main locale file to a new language, translating all keys.
   version - Print version of locales.
 

data/i18n-migrations.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'google_drive'
   spec.add_dependency 'activesupport'
   spec.add_dependency 'rest-client'
+  spec.add_dependency 'colorize'
 end

data/lib/i18n/migrations/config.rb

@@ -33,6 +33,10 @@ module I18n
         get_value(:google_translate_api_key)
       end
 
+      def do_not_translate
+        get_value(:do_not_translate)
+      end
+
       def read!
         yaml_file = find_config_file(CONFIG_FILE_NAME)
         unless yaml_file

data/lib/i18n/migrations/google_spreadsheet.rb

@@ -1,15 +1,14 @@
 require 'google_drive'
-require 'config'
 
 module I18n
   module Migrations
     class GoogleSpreadsheet
       attr_reader :sheet
 
-      def initialize(locale)
-        @session = GoogleDrive::Session.from_service_account_key(Config.google_service_account_key_path)
+      def initialize(locale, spreadsheet_url, key_path)
+        @session = GoogleDrive::Session.from_service_account_key(key_path)
 
-        url = Config.google_spreadsheets[locale] || raise("Can't find google spreadsheet for #{locale}")
+        url = spreadsheet_url || raise("Can't find google spreadsheet for #{locale}")
         @spreadsheet = @session.spreadsheet_by_url(url)
         @sheet = sheet_for("Sheet1")
       end

data/lib/i18n/migrations/google_translate_dictionary.rb

@@ -3,21 +3,73 @@ require 'rest-client'
 module I18n
   module Migrations
     class GoogleTranslateDictionary
-      def initialize(key, from_locale, to_locale)
-        @key, @from_locale, @to_locale = key, from_locale, to_locale
+      def initialize(from_locale, to_locale, key, do_not_translate)
+        @from_locale, @to_locale, @key, @do_not_translate = from_locale, to_locale, key, do_not_translate
       end
 
+      # returns [translated term, notes]
       def lookup(term)
-        return term if @from_locale == @to_locale
+        return [term, ''] if @from_locale == @to_locale
 
         response = RestClient.get 'https://www.googleapis.com/language/translate/v2', {
             accept: :json,
             params: { key: @key, source: @from_locale, target: @to_locale, q: term }
         }
-        JSON.parse(response.body)['data']['translations'].first['translatedText']
+        translated_term = JSON.parse(response.body)['data']['translations'].first['translatedText']
+        translated_term, errors = fix(term, translated_term)
+        unless errors.empty?
+          STDERR.puts "'#{term}' => '#{translated_term}'\n#{errors.join(', ').red}"
+        end
+        [translated_term, (errors.map{|e| "[error: #{e}]"} + ['[autotranslated]']).join("\n")]
       end
 
-      # we should validate translations based on reasonable rules
+      VARIABLE_STRING = /%\{[^\}]+\}/
+      # returns updated after term, errors
+      def fix(before, after)
+        errors = []
+
+        # do not translate
+        @do_not_translate.each do |term, bad_translations|
+          if before.include?(term) && !after.include?(term)
+            if (translation = find_included_translation(after, bad_translations))
+              after = after.gsub(translation, term)
+            else
+              errors << "missing #{term}"
+            end
+          end
+        end
+
+        # common mistakes
+        after = after.gsub('% {', '%{')
+
+        # match up variables, should have same variable in before and after
+        before_variables = before.scan(VARIABLE_STRING)
+        after_variables = after.scan(VARIABLE_STRING)
+
+        if before_variables.sort != after_variables.sort
+          missing = before_variables - after_variables
+          extra = after_variables - before_variables
+
+          # we'll try to fix if it looks easy
+          if missing.length == 1 && extra.length == 1
+            after = after.sub(extra.first, missing.first)
+          else
+            errors << "missing #{missing.join(', ')}" if missing.length > 0
+            errors << "extra #{extra.join(', ')}" if extra.length > 0
+          end
+        end
+
+        [after, errors]
+      end
+
+      private
+
+      def find_included_translation(after, bad_translations)
+        bad_translations.each do |translation|
+          return translation if after.include?(translation)
+        end
+        nil
+      end
     end
   end
 end

data/lib/i18n/migrations/migration.rb

@@ -57,8 +57,7 @@ module I18n
 
       def _add(key, term, overrides)
         assert_does_not_exist! key
-        @data[key] = overrides[@locale.to_sym] || @dictionary.lookup(term)
-        @notes[key] = "[autotranslated]"
+        assign_translation(key, term, overrides)
       end
 
       def _mv(from, to)
@@ -69,8 +68,7 @@ module I18n
 
       def _update(key, term, overrides)
         assert_exists! key
-        @data[key] = overrides[@locale.to_sym] || @dictionary.lookup(term)
-        @notes[key] = "[autotranslated]"
+        assign_translation(key, term, overrides)
       end
 
       def _rm(key)
@@ -90,6 +88,14 @@ module I18n
       def assert_does_not_exist!(key)
         raise "#{key} already exists in #{@locale}" if @data.has_key?(key)
       end
+
+      def assign_translation(key, term, overrides)
+        if overrides[@locale.to_sym]
+          @data[key] = overrides[@locale.to_sym]
+        else
+          @data[key], @notes[key] = @dictionary.lookup(term)
+        end
+      end
     end
   end
 end

data/lib/i18n/migrations/migrator.rb

@@ -2,6 +2,7 @@ require 'fileutils'
 require 'yaml'
 require 'active_support/inflector'
 require 'active_support/core_ext/object'
+require 'colorize'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'google_translate_dictionary'
@@ -55,30 +56,36 @@ end
       def pull(locale_or_all)
         each_locale(locale_or_all) do |locale|
           next if locale == config.main_locale
-          sheet = GoogleSpreadsheet.new(locale).sheet
+          sheet = get_google_spreadsheet(locale)
           pull_locale(locale, sheet)
           migrate(locale)
         end
       end
 
-      def push(locale_or_all)
+      def push(locale_or_all, force = false)
         each_locale(locale_or_all) do |locale|
           next if locale == config.main_locale
-          sheet = GoogleSpreadsheet.new(locale).sheet
-          pull_locale(locale, sheet)
-          migrate(locale)
+          sheet = get_google_spreadsheet(locale)
+          unless force
+            pull_locale(locale, sheet)
+            migrate(locale)
+          end
           push_locale(locale, sheet)
         end
       end
 
-      def new_locale(new_locale)
-        dictionary = GoogleTranslateDictionary.new(config.google_translate_api_key, config.main_locale, new_locale)
+      def new_locale(new_locale, limit = nil)
+        dictionary = new_dictionary(new_locale)
         new_data, new_notes = {}, {}
-        read_locale_data(config.main_locale).each do |key, term|
-          new_data[key] = dictionary.lookup(term)
-          new_notes[key] = '[autotranslated]'
+        count = 0
+        main_data = read_locale_data(config.main_locale)
+        main_data.each do |key, term|
+          new_data[key], new_notes[key] = dictionary.lookup(term)
           print '.'.green
+          break if limit && limit < count += 1
         end
+        new_data['VERSION'] = main_data['VERSION']
+        puts
         write_locale_data_and_notes(new_locale, new_data, new_notes)
       end
 
@@ -88,8 +95,48 @@ end
         end
       end
 
+      def validate(locale_or_all)
+        each_locale(locale_or_all) do |locale|
+          next if locale == config.main_locale
+          update_locale_info(locale) do |data, notes|
+            validate_locale(locale, data, notes)
+          end
+        end
+      end
+
       private
 
+      def validate_locale(locale, data, notes)
+        main_data = read_locale_data(config.main_locale)
+        dict = new_dictionary(locale)
+        main_data.each do |key, main_term|
+          old_term = data[key]
+          new_term, errors = dict.fix(main_term, old_term)
+          if new_term != old_term
+            data[key] = new_term
+            puts "#{"Fix".green} #{key.green}:"
+            puts "#{config.main_locale}: #{main_term}"
+            puts "#{locale} (old): #{old_term}"
+            puts "#{locale} (new): #{new_term}"
+          end
+          replace_errors_in_notes(notes, key, errors)
+          if errors.length > 0
+            puts "Error #{errors.join(', ')} #{key}"
+            puts "#{config.main_locale}: #{main_term}"
+            puts "#{locale}: #{old_term}"
+          end
+        end
+      end
+
+      def replace_errors_in_notes(all_notes, key, errors)
+        return if all_notes[key].blank? && errors.empty?
+
+        notes = all_notes[key]
+        notes = notes.present? ? notes.split("\n") : []
+        notes = notes.reject { |n| n.start_with?("[error:") }
+        all_notes[key] = (errors + notes).join("\n")
+      end
+
       def update_locale_info(locale)
         data, notes = read_locale_data_and_notes(locale)
         yield data, notes
@@ -164,7 +211,7 @@ end
       end
 
       def migrate_locale(locale, data, notes)
-        missing_versions = all_versions - locale_versions(data)
+        missing_versions = (all_versions - locale_versions(data)).sort
         if missing_versions.empty?
           puts "#{locale}: up-to-date"
           return
@@ -191,7 +238,7 @@ end
         filename = File.join(config.migration_dir, "#{version}.rb")
         require filename
         migration_class_name = version.gsub(/^\d{12}_/, '').camelcase
-        dictionary = GoogleTranslateDictionary.new(config.google_translate_api_key, config.main_locale, locale)
+        dictionary = new_dictionary(locale)
 
         migration = begin
           migration_class_name.constantize.new(locale, data, notes, dictionary, direction)
@@ -273,6 +320,16 @@ end
       def all_versions
         Dir[config.migration_dir + '/*.rb'].map { |name| File.basename(name).gsub('.rb', '') }
       end
+
+      def new_dictionary(locale)
+        GoogleTranslateDictionary.new(config.main_locale, locale, config.google_translate_api_key, config.do_not_translate)
+      end
+
+      def get_google_spreadsheet(locale)
+        GoogleSpreadsheet.new(locale,
+                              config.google_spreadsheets[locale],
+                              config.google_service_account_key_path).sheet
+      end
     end
   end
 end

data/lib/i18n/migrations/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Migrations
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-migrations
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jeremy Lightsmith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-16 00:00:00.000000000 Z
+date: 2017-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: We help you manage your locale translations with migrations, just the
   way Active Record helps you manage your db with migrations.
 email: