transync 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c6fb462e97a836b1fd3aab65f2cc82fef40a3b9
-  data.tar.gz: 3a7dae00ef26bd34d28311599dcf06c5fe5b233e
+  metadata.gz: 14ddaefea87d79fa54969295284ba7f048567d7b
+  data.tar.gz: 5f4e9e49694aafeab4a66ae6b850ff23c62c9d14
 SHA512:
-  metadata.gz: 1742efaff0fcd8e34d72376cc58049eb59a7348046f30186e2f48dd3151309aa2f428bd62c0779b000fc87f28a194557af1c60659774606fb572a6309dd89b04
-  data.tar.gz: 4fb9c221031ac7e94136f798abc317904f1d63293be877aeebc5f78733f8317a5bd2def9d94029bd1d3190ce6cb3f4d7f8c8a04f8bddad7371e0182ce3b4ce37
+  metadata.gz: cc8ee6a94f7ba1628db70c53760deaaa7b947c3dbdff2cdff73abdf07db01de8b8a035eba617a8fca8d1877239650305bfcd36d89e5e74d8f77fb7cc57f63b93
+  data.tar.gz: ed6b943d8c8564142d3654234110ee3431585f1c21272d5206736d2a31c455796081344bd15cf6d9cda6a34c5dab49edfcff23ad2641f1e7f062638fac309aaa

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p195
+2.0.0-p247

data/README.md

@@ -1,31 +1,42 @@
 # Install
 
-    gem install transync
+```bash
+gem install transync
+```
 
-You need settings file needs to be named `settings.yml`. For example see `settings.SAMPLE.yml`.
+You need settings file to be named `settings.yml` and to be in same directory from which we are running `transync` command.
+For example see `settings.SAMPLE.yml`.
 
-### Example
+### Process
 
-    transync x2g path/to/your/xliff/files
-    transync g2x path/to/your/xliff/files
+- Create new Google Doc Spreadsheet
+- Copy it's `key` from URL to `settings.yml`
+- Set all the languages and `xliff` you want to sync in `settings.yml` (look at `settings.SAMPLE.yml`).
+- set `XLIFF_FILES_PATH` to set path where are your `xliff` files. In project do it with relative path so others can use it.
+- run these commands respectively
 
-### Example for testing within this gem
+### Running order
 
-    rake install && transync x2g test/fixtures
+```
+transync test   # test if all keys are set for all the languages: no output means that no key is missing
+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.
 
-# Assumptions:
+# After init was made you have these two to sync between gdoc and xliff
+transync x2g
+transync g2x
+```
 
-You have xliff files in one directory, named like: common.en.xliff where common is name of the file and also google doc
-spreadsheet tab. en is language and you have google doc with structure where first row is key, language 1, language 2
+### Development on this gem
 
-# Config
-
-Google doc
-https://docs.google.com/a/astina.ch/spreadsheet/ccc?key=0ApAHdLDpSUFudHhuWU9vQ0ZPaWNoV3VxU045cXhHLWc#gid=3
-key = 0ApAHdLDpSUFudHhuWU9vQ0ZPaWNoV3VxU045cXhHLWc
+```
+rake install && transync test
+```
 
+# Assumptions:
 
-GDOC_KEY = 0ApAHdLDpSUFudHhuWU9vQ0ZPaWNoV3VxU045cXhHLWc
+You have xliff files in one directory, named like: common.en.xliff where common is name of the file and also google doc
+spreadsheet tab. en is language and you have google doc with structure where first row is key, language 1, language 2
 
 # Features
 
@@ -38,7 +49,3 @@ Gem docs available at http://gimite.net/doc/google-drive-ruby
 # Known issues
 
 It won't add keys as it should if not all languages are set in settings.yml
-
-# TODO
-
-- support for yaml files

data/bin/transync

@@ -1,2 +1,4 @@
+#!/usr/bin/env ruby
+
 require 'transync'
-Transync.run ARGV[0], ARGV[1]
+Transync.run ARGV[0]

data/lib/transync/gdoc_trans/gdoc_trans.rb

@@ -1,5 +1,18 @@
-# TODO move also to yml file
 module GdocTrans
-  WORKSHEET_COLUMNS = { key: 1, en: 2, de: 3 }
+  WORKSHEET_COLUMNS = { key: 1 }
   START_ROW = 2
+
+  CONFIG = YAML.load(File.open('settings.yml'))
+
+  # populate languages dynamically from settings.yml
+  CONFIG['LANGUAGES'].each_with_index do |language, index|
+    key = language
+    value = index + 2 #
+
+    WORKSHEET_COLUMNS[key.to_sym] = value
+  end
+
+  # Result of WORKSHEET_COLUMNS should be something like this
+  # depends on LANGUAGES set in settings.yml
+  # WORKSHEET_COLUMNS = { key: 1, en: 2, de: 3 }
 end

data/lib/transync/sync/gdoc_2_xliff_main.rb

@@ -6,19 +6,18 @@ require_relative 'gdoc_to_xliff'
 require_relative 'sync_util'
 
 class Gdoc2XliffMain
-  include SyncUtil
   attr_reader :path, :config
 
   def initialize(path)
     @path = path
-    @config = YAML.load(File.open('settings.yml'))
+    @config = GdocTrans::CONFIG
   end
 
   def run
     logger = Logger.new('.transync_log/gdoc2xliff.log', 'monthly')
 
     @config['FILES'].each do |file|
-      xliff_translations = check_and_get_xliff_files(@config['LANGUAGES'], path, file)
+      xliff_translations = SyncUtil::check_and_get_xliff_files(@config['LANGUAGES'], path, file)
       gdoc_trans_reader = GdocTransReader.new(@config['GDOC'], file)
 
       @config['LANGUAGES'].each do |language|

data/lib/transync/sync/init.rb

@@ -0,0 +1,39 @@
+require 'yaml'
+require 'logger'
+require_relative '../gdoc_trans/gdoc_trans_writer'
+require_relative 'xliff_to_gdoc'
+
+class Init
+  attr_reader :path, :config
+
+  def initialize(path)
+    @path = path
+    @config = GdocTrans::CONFIG
+    @gdoc_access = @config['GDOC']
+  end
+
+  def run
+    # first we want to add all the files to spreadsheet as worksheets (tabs)
+    # add_worksheet(title, max_rows = 100, max_cols = 20)
+    session = GoogleDrive.login(@gdoc_access['email'], @gdoc_access['password'])
+    spreadsheet = session.spreadsheet_by_key(@gdoc_access['key'])
+
+    @config['FILES'].each do |file|
+      worksheet = spreadsheet.add_worksheet(file)
+      p "Adding #{file} worksheet to spreadsheet with first row (key and languages)"
+
+      worksheet[1, 1] = 'Key'
+      @config['LANGUAGES'].each_with_index do |language, index|
+        worksheet[1, index + 2] = language.upcase
+      end
+      worksheet.save
+    end
+
+    # now sync all our keys and translations to gdoc
+    # this won't work if local files are not 'clean'.
+    # to make them clean run test and update first!
+    x2g = Xliff2GdocMain.new(path)
+    x2g.run
+  end
+
+end

data/lib/transync/sync/sync_util.rb

@@ -2,19 +2,23 @@ require_relative '../xliff_trans/xliff_trans_reader'
 
 module SyncUtil
 
-  def check_and_get_xliff_files(languages, path, file)
+  def self.check_and_get_xliff_files(languages, path, file, create = false)
     xliff_translations = []
+    added = false
 
     languages.each do |language|
       xliff_reader = XliffTransReader.new(path, file, language, languages)
-      if xliff_reader.valid?
+      if xliff_reader.valid?(create)
         xliff_translations << xliff_reader.get_translations
       else
-        abort('Fix your Xliff translations first!')
+        added = true if create
+        abort('Fix your Xliff translations first!') unless create
       end
     end
 
+    p 'Missing translations were added!' if create and added
+
     xliff_translations
   end
 
-end
+end

data/lib/transync/sync/xliff_2_gdoc_main.rb

@@ -6,19 +6,18 @@ require_relative 'xliff_to_gdoc'
 require_relative 'sync_util'
 
 class Xliff2GdocMain
-  include SyncUtil
   attr_reader :path, :config
 
   def initialize(path)
     @path = path
-    @config = YAML.load(File.open('settings.yml'))
+    @config = GdocTrans::CONFIG
   end
 
   def run
     logger = Logger.new('.transync_log/xliff2gdoc.log', 'monthly')
 
     @config['FILES'].each do |file|
-      xliff_translations = check_and_get_xliff_files(@config['LANGUAGES'], path, file)
+      xliff_translations = SyncUtil::check_and_get_xliff_files(@config['LANGUAGES'], path, file)
 
       gdoc_trans_reader = GdocTransReader.new(@config['GDOC'], file)
       gdoc_trans_writer = GdocTransWriter.new(gdoc_trans_reader.worksheet)

data/lib/transync/version.rb

@@ -1,3 +1,3 @@
 module Transync
-  VERSION = "0.0.1"
+  VERSION = '0.1.0'
 end

data/lib/transync/xliff_trans/xliff_trans_reader.rb

@@ -31,7 +31,11 @@ class XliffTransReader
   end
 
   # will go through each and find if any xliff is missing keys for translations
-  def valid?
+  def valid?(create = false)
+    missing = 0
+
+    all_translations_for_language = {language: nil, translations: []}
+
     self.get_translations[:translations].each do |x_trans|
       self.languages.each do |key_lang|
         next if key_lang == language
@@ -39,14 +43,28 @@ class XliffTransReader
         xliff_reader = XliffTransReader.new(self.dir, self.file, key_lang, self.languages)
         xliff_lang = xliff_reader.get_translations[:translations]
         xliff_lang_value = xliff_lang.detect{ |xt| xt[:key] == x_trans[:key] }
+
+        all_translations_for_language[:language] = key_lang
+
         if xliff_lang_value.nil?
-          p "#{file}.#{key_lang} is missing translation for key '#{x_trans[:key]}'"
-          return false
+          p "#{file}.#{key_lang} is missing translation for key '#{x_trans[:key]}'" unless create
+          return false unless create
+
+          p "#{missing + 1}. #{file}.#{key_lang} was missing translation for key '#{x_trans[:key]}'."
+          all_translations_for_language[:translations] << { key: x_trans[:key],  value: 'Missing translation' }
+          missing += 1
+        else
+          all_translations_for_language[:translations] << xliff_lang_value
         end
       end
     end
 
-    true
+    if missing > 0 and create
+      xliff_trans_writer = XliffTransWriter.new(dir, file, all_translations_for_language)
+      xliff_trans_writer.save
+    end
+
+    missing == 0
   end
 
   # Reading from source tags in xliff

data/lib/transync/xliff_trans/xliff_trans_writer.rb

@@ -42,4 +42,4 @@ private
     "#{path}/#{file}.#{language}.xliff"
   end
 
-end
+end

data/lib/transync.rb

@@ -1,10 +1,13 @@
 require_relative 'transync/sync/xliff_2_gdoc_main'
 require_relative 'transync/sync/gdoc_2_xliff_main'
+require_relative 'transync/sync/init'
+require_relative 'transync/sync/sync_util'
 
 module Transync
 
-  def self.run(mode, path)
+  def self.run(mode)
     FileUtils.mkdir('.transync_log') unless Dir.exist?('.transync_log')
+    path = GdocTrans::CONFIG['XLIFF_FILES_PATH']
 
     if mode == 'x2g'
       x2g = Xliff2GdocMain.new(path)
@@ -15,6 +18,23 @@ module Transync
       g2x = Gdoc2XliffMain.new(path)
       g2x.run
     end
+
+    if mode == 'init'
+      init = Init.new(path)
+      init.run
+    end
+
+    if mode == 'test'
+      GdocTrans::CONFIG['FILES'].each do |file|
+        SyncUtil::check_and_get_xliff_files(GdocTrans::CONFIG['LANGUAGES'], path, file)
+      end
+    end
+
+    if mode == 'update'
+      GdocTrans::CONFIG['FILES'].each do |file|
+        SyncUtil::check_and_get_xliff_files(GdocTrans::CONFIG['LANGUAGES'], path, file, true)
+      end
+    end
   end
 
 end

data/settings.SAMPLE.yml

@@ -5,15 +5,11 @@ GDOC:
   email: "user@example.com"
   password: "secret"
 
+XLIFF_FILES_PATH: test/fixtures
+
 FILES: # xliff files <=> gdoc tabs
-  - "cockpit"
-  - "common"
-  - "desktop"
-  - "error-msg"
-  - "FOSUserBundle"
-  - "home"
-  - "learn"
-  - "validators"
+#  - "messages"
+#  - "validators"
   - "test"
 
 LANGUAGES:

data/test/fixtures/test.de.xliff

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">
+    <file source-language="de" datatype="plaintext" original="file.ext">
+        <body>
+            <trans-unit id="title">
+                <source>title</source>
+                <target>Titel</target>
+            </trans-unit>
+            <trans-unit id="round">
+                <source>round</source>
+                <target>Rund</target>
+            </trans-unit>
+            <trans-unit id="end_test">
+                <source>end_test</source>
+                <target>End-Test</target>
+            </trans-unit>
+        </body>
+    </file>
+</xliff>

data/test/fixtures/test.en.xliff

@@ -4,39 +4,15 @@
         <body>
             <trans-unit id="title">
                 <source>title</source>
-                <target>TEST</target>
+                <target>Title</target>
             </trans-unit>
             <trans-unit id="round">
                 <source>round</source>
-                <target>Attempt</target>
+                <target>Round</target>
             </trans-unit>
             <trans-unit id="end_test">
                 <source>end_test</source>
-                <target>END TEST</target>
-            </trans-unit>
-            <trans-unit id="statistics.summary">
-                <source>statistics.summary</source>
-                <target>Summary of this session</target>
-            </trans-unit>
-            <trans-unit id="statistics.time.spent">
-                <source>statistics.time.spent</source>
-                <target>Time Spent</target>
-            </trans-unit>
-            <trans-unit id="statistics.time.left">
-                <source>statistics.time.left</source>
-                <target>Time Left</target>
-            </trans-unit>
-            <trans-unit id="time.up">
-                <source>time.up</source>
-                <target>Your time is up</target>
-            </trans-unit>
-            <trans-unit id="last_card_title">
-                <source>last_card_title</source>
-                <target>Click END TEST button to save your results.</target>
-            </trans-unit>
-            <trans-unit id="repeat">
-                <source>repeat</source>
-                <target>Repeat</target>
+                <target>End test</target>
             </trans-unit>
         </body>
     </file>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transync
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - zigomir
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-26 00:00:00.000000000 Z
+date: 2013-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google_drive
@@ -87,6 +87,7 @@ files:
 - lib/transync/gdoc_trans/gdoc_trans_writer.rb
 - lib/transync/sync/gdoc_2_xliff_main.rb
 - lib/transync/sync/gdoc_to_xliff.rb
+- lib/transync/sync/init.rb
 - lib/transync/sync/sync_util.rb
 - lib/transync/sync/xliff_2_gdoc_main.rb
 - lib/transync/sync/xliff_to_gdoc.rb
@@ -94,6 +95,7 @@ files:
 - lib/transync/xliff_trans/xliff_trans_reader.rb
 - lib/transync/xliff_trans/xliff_trans_writer.rb
 - settings.SAMPLE.yml
+- test/fixtures/test.de.xliff
 - test/fixtures/test.en.xliff
 - transync.gemspec
 homepage: ''
@@ -116,9 +118,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Synchronize XLIFF translations with Google Drive document
 test_files:
+- test/fixtures/test.de.xliff
 - test/fixtures/test.en.xliff
+has_rdoc: