i18n-migrations 2.0.0 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 155eb3f6fe33497d8988ba301c6535df404f0d02c59cfaac034a77a169508d62
-  data.tar.gz: 04a5b6dcc152e3ad7b7b88bc898acae8fc2fed122947a3ae1609edcdb6023e64
+  metadata.gz: 2f7ee2c5ac86c602a98d44d88d9beb2b56f5982521bfd0d4d786d40b0cf5a0ab
+  data.tar.gz: 0a0104497bb427863c9b882ed4012d4987df4505aa31e940dcb95825db3553ea
 SHA512:
-  metadata.gz: 324c96c71807c3fb331a25742f84d82242a0c3ea0bd12f0df7cebe9a6bdd5e0261d7830cfd843e0debe50475a948347603a6a23d93efd2d610b054d251ecc782
-  data.tar.gz: cb47a3ffd0fc1eae8a5b1b2e6996857c1b092f705112252818c9cb3d939246bc5711fa1357ef20e32c4243091fd59793544a7cd52c0cd295d9aca5a859585d58
+  metadata.gz: 9e424e65f15509548832954508ecf5f691be5d8375c5b22c6d026ee6e245aedf740913cfbc194efd05da112bb8fc540c973ceb1fe58ae91f21a0d69f826fc93e
+  data.tar.gz: 0dcea94acec54b24bf839a0173f43cf67c7ce440ac9ad696bb08a553bc22ef408f90189fc4491567576ae6fe9afc1c389dddb7296d58e4bcaa430ed377b2acdc

data/README.md

@@ -47,20 +47,10 @@ Let's imagine that your config file look like this:
 
 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
+You can:
 
+* [Create a new locale](https://github.com/transparentclassroom/i18n-migrations/wiki/Create-a-new-locale-(language))
+* [Add a migration](https://github.com/transparentclassroom/i18n-migrations/wiki/Add-a-migration)
 
 ## Development
 
@@ -71,8 +61,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/i18n-migrations/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Make sure tests are passing (`rake`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request
 

data/bin/i18n-migrate

@@ -10,59 +10,60 @@ def extract_option(name)
   !!ARGV.delete(name)
 end
 
-case ARGV.shift
-when 'setup'
-  puts 'Where should we create a default config file? [.]'
-  dir = gets.chomp
-  dir = dir == '' ? '.' : dir
-  file = I18n::Migrations::Config.copy_default_config_file(dir)
-
-  puts 'You will need to configure this file before you can get going.'
-  puts File.expand_path(file)
-
-when 'new'
-  name = ARGV.shift
-  if name
-    migrator.new_migration name
-  else
-    STDERR.puts 'Usage: im new [name]'
-    exit 1
-  end
-
-when 'migrate'
-  migrator.migrate(ARGV[0] || 'all')
-
-when 'rollback'
-  migrator.rollback(ARGV[0] || 'all')
-
-when 'redo'
-  migrator.rollback(ARGV[0] || 'all')
-  migrator.migrate(ARGV[0] || 'all')
-
-when 'pull'
-  migrator.pull(ARGV[0] || 'all')
+begin
+  case ARGV.shift
+  when 'setup'
+    puts 'Where should we create a default config file? [.]'
+    dir = gets.chomp
+    dir = dir == '' ? '.' : dir
+    file = I18n::Migrations::Config.copy_default_config_file(dir)
+
+    puts 'You will need to configure this file before you can get going.'
+    puts File.expand_path(file)
+
+  when 'new'
+    name = ARGV.shift
+    if name
+      migrator.new_migration name
+    else
+      STDERR.puts 'Usage: im new [name]'
+      exit 1
+    end
+
+  when 'migrate'
+    migrator.migrate(ARGV[0] || 'all')
+
+  when 'rollback'
+    migrator.rollback(ARGV[0] || 'all')
+
+  when 'redo'
+    migrator.rollback(ARGV[0] || 'all')
+    migrator.migrate(ARGV[0] || 'all')
+
+  when 'pull'
+    migrator.pull(ARGV[0] || 'all')
+
+  when 'push'
+    force = extract_option('-f')
+    migrator.push(ARGV[0] || 'all', force)
+
+  when 'validate'
+    migrator.validate(ARGV[0] || 'all')
+
+  when 'new_locale'
+    locale = ARGV.shift
+    if locale
+      migrator.new_locale(locale)
+    else
+      STDERR.puts 'Usage: im new_locale [name]'
+      exit 1
+    end
+
+  when 'version'
+    migrator.version
 
-when 'push'
-  force = extract_option('-f')
-  migrator.push(ARGV[0] || 'all', force)
-
-when 'validate'
-  migrator.validate(ARGV[0] || 'all')
-
-when 'new_locale'
-  locale = ARGV.shift
-  if locale
-    migrator.new_locale(locale)
   else
-    STDERR.puts 'Usage: im new_locale [name]'
-    exit 1
-  end
-
-when 'version'
-  migrator.version
-
-else
-  puts <<-USAGE
+    puts <<-USAGE
 Usage: i18n-migrate [command]
 
 Commands:
@@ -78,5 +79,9 @@ Commands:
   version - Print version of locales.
 
 i18n-migrations version #{I18n::Migrations::VERSION}
-  USAGE
+    USAGE
+  end
+rescue Exception
+  puts "Error\n#{$!.message}".red
+  exit 1
 end

data/lib/i18n/migrations/backends/crowd_translate_backend.rb

@@ -20,11 +20,6 @@ module I18n
             force_push(locale)
           end
 
-          # do this just once
-          unless @migrations_synced
-            sync_migrations(locale.migrations)
-            @migrations_synced = true
-          end
           pull(locale)
         end
 
@@ -58,9 +53,7 @@ module I18n
               begin
                 client.put_migration(version: version, ruby_file: migrations.get_migration(version: version))
               rescue
-                puts "There was an error updating migration:".red
-                puts "  #{migrations.migration_file(version: version)}".bold
-                raise
+                raise CrowdTranslateError, "... while updating migration: #{migrations.migration_file(version: version)}\n#{$!.message}"
               end
             end
           end

data/lib/i18n/migrations/backends/crowd_translate_client.rb

@@ -4,16 +4,16 @@ require 'active_support/core_ext/object'
 module I18n
   module Migrations
     module Backends
+      class CrowdTranslateError < StandardError
+      end
+
       class CrowdTranslateClient
         def initialize
           token = ENV['CROWD_TRANSLATE_API_TOKEN']
           raise("You must define CROWD_TRANSLATE_API_TOKEN in order to talk to Crowd Translate") unless token.present?
 
-          server = ENV['CROWD_TRANSLATE_SERVER'] || 'https://crowd-translate.herokuapp.com'
-          @faraday = Faraday.new(
-            url: "#{server}/api/v1",
-            headers: { 'X-CrowdTranslateApiToken' => token },
-          )
+          @server = ENV['CROWD_TRANSLATE_SERVER'] || 'https://crowd-translate.herokuapp.com'
+          @faraday = Faraday.new(url: base_url, headers: { 'X-CrowdTranslateApiToken' => token })
         end
 
         def get_locale_file(locale_code)
@@ -37,26 +37,34 @@ module I18n
 
         def get(path)
           puts "GET #{path}".bold
-          parse_response @faraday.get path
+          parse_response 'GET', path, @faraday.get(path)
         end
 
         def put(path, params = {})
           puts "PUT #{path} #{params.to_s[0..50]}#{'...' if params.to_s.length > 50}".bold
-          parse_response @faraday.put path, params
+          parse_response 'PUT', path, @faraday.put(path, params)
         end
 
-        def parse_response(response)
+        def parse_response(method, path, response)
           if response.success?
             response.body
           else
-            error = begin
-                      JSON.parse(response.body)['error']
-                    rescue
-                      response.body
+            error = if response.status == 503
+                      'Server timed out - your request may have succeed, check the server for more details'
+                    else
+                      begin
+                        JSON.parse(response.body)['error']
+                      rescue
+                        response.body
+                      end
                     end
-            raise error
+            raise CrowdTranslateError, "... while calling #{method} #{File.join(base_url, path)}\n#{error}"
           end
         end
+
+        def base_url
+          "#{@server}/api/v1"
+        end
       end
     end
   end

data/lib/i18n/migrations/backends/google_spreadsheets_backend.rb

@@ -34,6 +34,10 @@ module I18n
                                 @config.google_service_account_key_path).sheet
         end
 
+        def sync_migrations(migrations)
+          # nothing to do here in this backend
+        end
+
         def pull_from_sheet(sheet, locale)
           puts "Pulling #{locale.name}"
           data = {}

data/lib/i18n/migrations/locale.rb

@@ -212,7 +212,7 @@ module I18n
       end
 
       def parse_yaml(string)
-        YAML.load(string)
+        YAML.load(string) || {}
       end
 
       # flattens new_hash and adds it to hash

data/lib/i18n/migrations/metadata.rb

@@ -20,7 +20,9 @@ class Metadata
   end
 
   def delete(key)
+    metadatum = self[key]
     @hash.delete(key)
+    metadatum
   end
 
   def to_h

data/lib/i18n/migrations/migration_factory.rb

@@ -27,15 +27,15 @@ module I18n
         raise("Can't parse version: #{version}") unless version =~ /^(\d{12})_(.*)/
         migration_class_name = "#{$2.camelcase}#{$1}"
 
-        translations = Translations.new(data: data, metadata: metadata)
+        translations = Translations.new(locale_code: locale, data: data, metadata: metadata)
         migration = begin
-          migration_class_name.constantize.new(locale_code: locale,
-                                               translations: translations,
-                                               dictionary: dictionary,
-                                               direction: direction)
-        rescue
-          raise "Couldn't load migration #{migration_class_name} in #{filename}"
-        end
+                      migration_class_name.constantize.new(locale_code: locale,
+                                                           translations: translations,
+                                                           dictionary: dictionary,
+                                                           direction: direction)
+                    rescue
+                      raise "Couldn't load migration #{migration_class_name} in #{filename}"
+                    end
 
         migration.change
       end
@@ -44,8 +44,8 @@ module I18n
       # data = all keys -> all translations in this locale
       # metadata = some keys -> metadata about the translation in this locale
       class Translations
-        def initialize(data:, metadata:)
-          @data, @metadata = data, metadata
+        def initialize(locale_code:, data:, metadata:)
+          @locale_code, @data, @metadata = locale_code, data, metadata
         end
 
         def get_term(key)
@@ -63,6 +63,17 @@ module I18n
           @metadata[key].errors = errors
           @metadata[key].notes = nil
           @metadata[key].autotranslated = autotranslated
+          if errors.present?
+            puts [
+                   "=" * 100,
+                   "#{@locale_code}: #{key}",
+                   value,
+                   errors.map { |e| "Error: #{e}".red }.join("\n"),
+                   "=" * 100,
+                 ].compact.join("\n")
+            # puts ["Error with #{@locale_code}: #{key}: \n  #{errors.join("\n  ")}".red,
+            #       value].compact.join("\n")
+          end
         end
 
         def delete_term(key)

data/lib/i18n/migrations/migrator.rb

@@ -72,12 +72,13 @@ end
 
       def pull(locale_or_all)
         each_locale(locale_or_all) do |locale|
-          next if locale.main_locale?
+          # next if locale.main_locale?
           backend.pull(locale)
         end
       end
 
       def push(locale_or_all, force = false)
+        backend.sync_migrations(new_migrations)
         each_locale(locale_or_all, concurrency: config.push_concurrency) do |locale|
           backend.push(locale, force: force)
           wait
@@ -103,9 +104,23 @@ end
         end
       end
 
+      private def report_locale_on_error(locale, &block)
+        begin
+          block.call locale
+        rescue Backends::CrowdTranslateError
+          puts "Error\n... while working with #{locale.name}\n#{$!.message}".red
+          # we want a readable error for our users, and the error happened in an external system,
+          # so don't give them a stack trace
+        rescue
+          puts "Error\n... while working with #{locale.name}\n#{$!.message}".red
+          raise
+        end
+      end
+
       private def each_locale(name = 'all',
-                              async: config.google_spreadsheet?,
-                              concurrency: config.concurrency)
+                              async: true,
+                              concurrency: config.concurrency,
+                              &block)
         locale_names = name == 'all' ? all_locale_names : [name]
 
         if async
@@ -113,13 +128,13 @@ end
           locale_names.each_slice(concurrency) do |some_locale_names|
             threads = some_locale_names.map do |l|
               locale = locale_for(l)
-              Thread.new { yield locale }
+              Thread.new { report_locale_on_error(locale, &block) }
             end
             threads.each(&:join)
           end
         else
           locale_names.each do |l|
-            yield locale_for(l)
+            report_locale_on_error(locale_for(l), &block)
           end
         end
       end

data/lib/i18n/migrations/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Migrations
-    VERSION = "2.0.0"
+    VERSION = "2.0.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-migrations
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.5
 platform: ruby
 authors:
 - Jeremy Lightsmith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler