transync 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bfe245154c8aada3e726245189aecbfcebe3896
-  data.tar.gz: de3cd22e1225c0c2afde1535b786f01cf9c99751
+  metadata.gz: 34601981f1aed44be61c45090e3c7568a4f64768
+  data.tar.gz: 257f29d8a4f7e8a4bfce328a38c0ada09bbcae4d
 SHA512:
-  metadata.gz: 8bb9cf85059b1a42ac17182f3ffa03a81bf701a758ef6d7ac5fd8d680ba37a4fac8ee6fcc121d6e861a1baea21d4a3c503b5f9db5567460fc9d2c1a34ce7e72c
-  data.tar.gz: e46fbeb05285725e066193912aff6e6f8ce72007fae10c88a90cb429663303696e88163193617763c86506f80f6fd02ce1fabb5aafaa63e9822d6db0f15cdbf9
+  metadata.gz: 031fdec0240aa2a3a45e8b9808444715d533d82e0b586c94a0a201fffbfe83a7dfaf5fe39015dee18a29a7805bef9a7d0b67863b19bc2523bdd1732fdb30b303
+  data.tar.gz: d803d0a53df7ef47f4d724d9aef9ad2d2a50f27e72f6bce259be67cf2fce289422323622f0c49679529308a908203f0c58aca6ca5031c682a2a95f63a809967e

data/README.md

@@ -29,9 +29,9 @@ for direction from Gdoc to xliff.
 ### Running order
 
 ```
-transync test   # test if all keys are set for all the languages: no output means that no key is missing
+transync test   # test if all keys are set for all the languages. Also tests if everything in sync with GDoc
 transync update # will test and add all the missing keys that are not presented for a particular language
-transync init   # will sync all translations with Google spreadsheet. You need to run update command first, to ensure no keys are missing.
+transync init   # will sync all translations with Google spreadsheet. You need to run update command first, to ensure no keys are missing
 
 # After init was made you have these two to sync between gdoc and xliff
 transync x2g
@@ -41,9 +41,13 @@ transync g2x
 ### Gem development
 
 ```
-rake install && transync x2g|g2x test
 ruby g2x_spec.rb
 ruby x2g_spec.rb
 ```
 
-When running with `test` as second argument, changes won't be written to files or spreadsheet.
+## TODO
+
+- use ruby's 2.0 named parameters (more clear method calls)
+- better tests (move out network dependency -> maybe try VCR)
+- add to travis / code climate
+- don't allow empty keys?

data/bin/transync

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'transync'
-Transync.run ARGV[0], ARGV[1]
+
+FileUtils.mkdir('.transync_log') unless Dir.exist?('.transync_log')
+Transync.run ARGV[0]

data/lib/transync.rb

@@ -1,35 +1,16 @@
 require_relative 'transync/sync/translation_sync'
 require_relative 'transync/sync/init'
 require_relative 'transync/sync/sync_util'
+require_relative 'transync/runner'
 
 module Transync
 
-  def self.run(mode, test = nil)
-    FileUtils.mkdir('.transync_log') unless Dir.exist?('.transync_log')
-    path = TransyncConfig::CONFIG['XLIFF_FILES_PATH']
-
+  def self.run(mode)
     if mode == 'x2g' or mode == 'g2x'
-      sync = TranslationSync.new(path, mode)
-      sync.run(mode, test)
-    end
-
-    if mode == 'init'
-      init = Init.new(path)
-      init.run
-    end
-
-    if mode == 'test'
-      TransyncConfig::CONFIG['FILES'].each do |file|
-        xliff_files = XliffTransReader.new(path, file, TransyncConfig::CONFIG['LANGUAGES'])
-        p "#{file} have all the keys for all languages." if xliff_files.valid?
-      end
-    end
-
-    if mode == 'update'
-      TransyncConfig::CONFIG['FILES'].each do |file|
-        xliff_files = XliffTransReader.new(path, file, TransyncConfig::CONFIG['LANGUAGES'])
-        xliff_files.fill_with_missing_keys
-      end
+      Transync::Runner.sync(mode)
+    else
+      # will send message to (call) init, test, update
+      Transync::Runner.send(mode)
     end
   end
 

data/lib/transync/gdoc_trans/gdoc_trans_writer.rb

@@ -1,4 +1,5 @@
 require 'google_drive'
+require 'colorize'
 
 class GdocTransWriter
 
@@ -9,7 +10,7 @@ class GdocTransWriter
   def write(trans_hash)
     language    = trans_hash[:language]
     lang_column = get_language_column_index(language)
-    abort("Language (#{language}) not found in worksheet (#{@worksheet.title})!") if lang_column == 0
+    abort("\u{2717} Language (#{language}) not found in worksheet '#{@worksheet.title}'!".colorize(:red)) if lang_column == 0
 
     row = 2
 

data/lib/transync/runner.rb

@@ -0,0 +1,54 @@
+require 'colorize'
+
+module Transync
+
+  # 2713 = unicode check mark
+  # 2717 = unicode cross mark
+  module Runner
+
+    PATH = TransyncConfig::CONFIG['XLIFF_FILES_PATH']
+
+    def self.sync(mode)
+      sync = TranslationSync.new(PATH, mode)
+      sync.run(mode)
+    end
+
+    def self.init
+      init = Init.new(PATH)
+      init.run
+    end
+
+    def self.test
+      TransyncConfig::CONFIG['FILES'].each do |file|
+        xliff_files = XliffTransReader.new(PATH, file, TransyncConfig::CONFIG['LANGUAGES'])
+        puts "\u{2713} '#{file}' have all the keys for all languages in XLIFF files.".colorize(:green) if xliff_files.valid?
+
+        TransyncConfig::CONFIG['LANGUAGES'].each do |language|
+          trans_sync = TranslationSync.new(PATH, 'test', file)
+
+          if trans_sync.diff(language).keys.length == 0
+            puts "\u{2713} '#{file}' is in sync for '#{language}' language with GDoc.".colorize(:green)
+          else
+            puts "\u{2717} '#{file}' is NOT in sync for '#{language}' language with GDoc. See diff!".colorize(:red)
+          end
+        end
+
+        puts '----------'
+      end
+    end
+
+    def self.update
+      TransyncConfig::CONFIG['FILES'].each do |file|
+        xliff_files = XliffTransReader.new(PATH, file, TransyncConfig::CONFIG['LANGUAGES'])
+        clean = xliff_files.fill_with_missing_keys
+
+        if clean
+          puts "\u{2713} '#{file}' already have all the keys in all the XLIFF files".colorize(:green)
+        else
+          puts "\u{2717} '#{file}' already DID NOT have all the keys in all the XLIFF files. But they were added automatically for you.".colorize(:red)
+        end
+      end
+    end
+
+  end
+end

data/lib/transync/sync/sync_util.rb

@@ -8,17 +8,17 @@ module SyncUtil
     SyncUtil.log_and_puts(msg)
   end
 
-  def self.info_diff(file, language, diff)
-    msg = "#{file} (#{language})"
-    if diff.empty?
-      msg += ' already has same keys and values'
-    else
-      msg = build_diff_print(diff, msg)
+  def self.info_diff(file, language, diff, diff_only = nil)
+    msg = ''
+
+    unless diff.empty?
+      msg = "#{file} (#{language})\n" if not diff_only
+      msg = build_diff_print(diff, msg, diff_only)
     end
     SyncUtil.log_and_puts(msg)
   end
 
-  def self.build_diff_print(diff, msg)
+  def self.build_diff_print(diff, msg, diff_only = nil)
     begin
       # get longest key and value
       max_key_length = diff.keys.max { |a, b| a.length <=> b.length }.length
@@ -28,15 +28,26 @@ module SyncUtil
       max_val_length = 0
     end
 
+    newline = ''
     diff.keys.each do |key|
-      operation = diff[key][1].nil? ? 'Adding' : 'Changing'
-      msg += "\n  #{operation.ljust(8)} - #{key.ljust(max_key_length)}: '#{diff[key][1].to_s.ljust(max_val_length)}' => '#{diff[key][0]}' "
+      change_mark = ' => '
+      operation = diff[key][1].nil? ? 'adding' : 'changing'
+      ljust = 8
+
+      if diff_only
+        operation = 'diff'
+        change_mark = ' <=> '
+        ljust = 4
+      end
+
+      msg += "#{newline}[#{operation.ljust(ljust)}] #{key.ljust(max_key_length)}: '#{diff[key][1].to_s.ljust(max_val_length)}'#{change_mark}'#{diff[key][0]}' "
+      newline = "\n"
     end
     msg
   end
 
   def self.log_and_puts(msg)
-    puts msg
+    puts msg unless msg.length == 0
     @logger.info msg
   end
 

data/lib/transync/sync/translation_sync.rb

@@ -12,7 +12,7 @@ class TranslationSync
     SyncUtil.create_logger(direction)
   end
 
-  def run(direction, test)
+  def run(direction)
     @config['FILES'].each do |file|
       xliff_files = XliffTransReader.new(@path, file, @config['LANGUAGES'])
       abort('Fix your Xliff translations by hand or run transync update!') unless xliff_files.valid?
@@ -21,8 +21,6 @@ class TranslationSync
         trans_sync = TranslationSync.new(@path, direction, file)
         trans_hash = trans_sync.sync(language, direction)
 
-        next if test == 'test' # if testing don't write to files or google doc
-
         if direction == 'x2g'
           gdoc_trans_reader = GdocTransReader.new(file)
           gdoc_trans_writer = GdocTransWriter.new(gdoc_trans_reader.worksheet)
@@ -56,4 +54,16 @@ class TranslationSync
     {file: @file, language: language, translations: merged_translations}
   end
 
+  def diff(language)
+    gdoc_trans_reader  = GdocTransReader.new(@file)
+    xliff_trans_reader = XliffTransReader.new(@path, @file, nil)
+
+    g_trans_hash = gdoc_trans_reader.translations(language)
+    x_trans_hash = xliff_trans_reader.translations(language)
+
+    diff = x_trans_hash[:translations].diff(g_trans_hash[:translations])
+    SyncUtil.info_diff(@file, language, diff, true)
+    diff
+  end
+
 end

data/lib/transync/version.rb

@@ -1,3 +1,3 @@
 module Transync
-  VERSION = '1.0.4'
+  VERSION = '1.1.0'
 end

data/lib/transync/xliff_trans/xliff_trans_reader.rb

@@ -44,6 +44,7 @@ class XliffTransReader
     missing_translation_text = TransyncConfig::CONFIG['MISSING_TRANSLATION_TEXT'] || '#MISSING-TRANS#'
     all_translations_for_language = {file: file, language: nil, translations: {}}
     added = false
+    clean = true
 
     check_all do |lang_a, lang_b, xliff_lang_value, x_trans_key, translations_lang_b, last| # x_trans_key comes from lang_a translations
       all_translations_for_language[:language] = lang_b
@@ -53,6 +54,7 @@ class XliffTransReader
           "was missing translation for key '#{x_trans_key}' => setting value: '#{missing_translation_text} - #{x_trans_key}'"
         all_translations_for_language[:translations][x_trans_key] = "#{missing_translation_text} - #{x_trans_key}"
         added = true
+        clean = false
       else
         all_translations_for_language[:translations][x_trans_key] = xliff_lang_value
       end
@@ -69,6 +71,9 @@ class XliffTransReader
         added = false
       end
     end
+
+    # return if any key was added
+    clean
   end
 
   def check_all

data/transync.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'google_drive'
   spec.add_runtime_dependency 'builder'
+  spec.add_runtime_dependency 'colorize'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transync
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - zigomir
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-14 00:00:00.000000000 Z
+date: 2013-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google_drive
@@ -38,6 +38,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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -85,6 +99,7 @@ files:
 - lib/transync.rb
 - lib/transync/gdoc_trans/gdoc_trans_reader.rb
 - lib/transync/gdoc_trans/gdoc_trans_writer.rb
+- lib/transync/runner.rb
 - lib/transync/sync/init.rb
 - lib/transync/sync/sync_util.rb
 - lib/transync/sync/translation_sync.rb