xlocalize 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab478e509c23afe6342a33614fa8178181b96bd4
-  data.tar.gz: eb06d69ff88c064ac6d7edd571f4f2c233235845
+  metadata.gz: 792155074986084e3e7e83a6eb58336bb00c5534
+  data.tar.gz: 7a2d092e9300a12d26c88493813ea5dee23268c3
 SHA512:
-  metadata.gz: 358137228061035959ff6a38fb12bffa575355d59f6a936d30449feeb0296d12911223271791c90275d2c4bb19df559492d3cbea737411ce89457d1b98f2a229
-  data.tar.gz: 0d681b7ddd8da25f7a27db4038abd733f4e18b931e44c8b63bef826e017369a29630dd25a71628b966cec7e5fc480b1c8198ff7925bb97e79c40fddfeb22ca31
+  metadata.gz: 736409b41ba7b868a91c953c8d12e1aa663c9b973a16ba13e165911659533df17d277f0556687ce13d8acd78f7152429a3bee59e309b822ddbe70e1cb9601441
+  data.tar.gz: 34b303e10d3990a19101b1da6d4fa8561bf00a7f64b62fa4f4f1a45c6136e1539fb2ca468c00b938d36d4260645a200b7d24af56d46371d1d6babf18a03d0910

data/.gitignore

@@ -8,3 +8,17 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+# iOS specific ignores, used in sample projects inside the repo
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata/
+*.moved-aside
+*.xccheckout
+*.xcscmblueprint

data/lib/xlocalize/executor.rb

@@ -1,10 +1,17 @@
 require 'xlocalize/webtranslateit'
 require 'colorize'
 require 'nokogiri'
+require 'plist'
+require 'yaml'
+require 'pathname'
 
 module Xlocalize
   class Executor
 
+    def plurals_file_name(locale)
+      return locale_file_name(locale) << '_plurals.yml'
+    end
+
     def locale_file_name(locale)
       return "#{locale}.xliff"
     end
@@ -12,22 +19,34 @@ module Xlocalize
     def export_master(wti, project, target, excl_prefix, master_lang)
       master_file_name = locale_file_name(master_lang)
       
-      system "xcodebuild -exportLocalizations -localizationPath ./ -project #{project}"
-      purelyze(master_file_name, target, excl_prefix)
+      # hacky way to finish xcodebuild -exportLocalizations script, because
+      # since Xcode7.3 & OS X Sierra script hangs even though it produces
+      # xliff output
+      # http://www.openradar.me/25857436
+      File.delete(master_file_name) if File.exist?(master_file_name)
+      system "xcodebuild -exportLocalizations -localizationPath ./ -project #{project} & sleep 0"
+      while !File.exist?(master_file_name) do
+        sleep(1)
+      end
+
+      purelyze(master_lang, target, excl_prefix, project)
 
       # Pushing master file to WebtranslateIt
       begin
         puts "Uploading master file to WebtranslateIt"
-        File.open(master_file_name, "r") {|file|
-          wti.push_master(file)
-          puts "Done.".green
-        }
+        file = File.open(master_file_name, 'r')
+        plurals_file = File.open(plurals_file_name(master_lang), 'r')
+        wti.push_master(file, plurals_file)
+        puts "Done.".green
       rescue => err
         puts err.to_s.red
+      ensure
+        file.close unless file.nil?
       end if !wti.nil?
     end
 
-    def purelyze(locale_file_name, target, excl_prefix)
+    def purelyze(locale, target, excl_prefix, project)
+      locale_file_name = locale_file_name(locale)
       target_prefix = "#{target}/"
       doc = Nokogiri::XML(open(locale_file_name))
 
@@ -42,62 +61,120 @@ module Xlocalize
         node.parent.remove if node.content.start_with?(excl_prefix)
       }
 
+      puts "Filtering plurals"
+      plurals = {}
+      doc.xpath("//xmlns:file").each { |node|
+        fname = node["original"]
+        next if !fname.end_with?(".strings")
+        fname_stringsdict = fname << 'dict'
+        file_full_path = Pathname.new(project).split.first.to_s  << '/' << fname_stringsdict
+        next if !File.exist?(file_full_path)
+
+        Plist::parse_xml(file_full_path).each do |key, val|
+          values = val["value"]
+          transl = values.select { |k, v| ['zero', 'one', 'few', 'other'].include?(k) }
+          plurals[fname_stringsdict] = {key => transl}
+          sel = 'body > trans-unit[id="' << key << '"]'
+          node.css(sel).remove
+        end
+      }
+
       puts "Removing all files having no trans-unit elements after removal"
       doc.xpath("//xmlns:body").each { |node|
         node.parent.remove if node.elements.count == 0
       }
 
       puts "Writing modified XLIFF file to #{locale_file_name}"
-      File.open(locale_file_name, "w") {|file| file.write(doc.to_xml) }
+      File.open(locale_file_name, 'w') { |f| f.write(doc.to_xml) }
+
+      if !plurals.empty?
+        puts "Writing plurals to plurals YAML file"
+        File.open(plurals_file_name(locale), 'w') { |f| f.write({locale => plurals}.to_yaml) }
+      end
     end
 
     def download(wti, locales)
       begin
         locales.each do |locale|
-          puts "Downloading localized file for #{locale} translation"
+          puts "Downloading translations for #{locale}"
+          translations = wti.pull(locale)
+
           File.open("#{locale}.xliff", "w") {|file|
-            wti.pull(file, locale)
-            puts "Done.".green
+            file.write(translations['xliff'])
+            puts "Done saving xliff.".green
           }
+
+          if !translations['plurals'].nil?
+            File.open("#{locale}_plurals.yaml", "w") {|file|
+              file.write(translations['plurals'])
+              puts "Done saving plurals.".green
+            }
+          end
         end
       rescue => err
         puts err.to_s.red
       end
     end
 
-    def import(locales)
-      locales.each do |locale|
-        doc = Nokogiri::XML(open("#{locale}.xliff"))
-
-        doc.xpath("//xmlns:file").each { |node|
-          file_name = node["original"]
-          parts = file_name.split('/')
-          name = ""
-          parts.each_with_index {|part, idx|
-            name += "/" if idx > 0
-            if part.end_with?(".lproj")
-              name += "#{locale}.lproj"
-            elsif idx+1 == parts.count
-              # TODO: join all parts till the last '.'
-              name += "#{part.split('.')[0]}.strings"
-            else
-              name += part
-            end
-          }
-          
-          File.open(name, "w") {|file|
-            (node > "body > trans-unit").each {|trans_unit|
-              key = trans_unit["id"]
-              target = (trans_unit > "target").text
-              note = (trans_unit > "note").text
-              note = "(No Commment)" if note.length <= 0
-              
-              file.write "/* #{note} */\n"
-              file.write "\"#{key}\" = #{target.inspect};\n\n"
-            }
+    def import_xliff(locale)
+      doc = Nokogiri::XML(open("#{locale}.xliff"))
+
+      doc.xpath("//xmlns:file").each do |node|
+        file_name = node["original"]
+        parts = file_name.split('/')
+        name = ""
+        parts.each_with_index do |part, idx|
+          name += "/" if idx > 0
+          if part.end_with?(".lproj")
+            name += "#{locale}.lproj"
+          elsif idx+1 == parts.count
+            # TODO: join all parts till the last '.'
+            name += "#{part.split('.')[0]}.strings"
+          else
+            name += part
+          end
+        end
+        
+        File.open(name, "w") do |file|
+          (node > "body > trans-unit").each do |trans_unit|
+            key = trans_unit["id"]
+            target = (trans_unit > "target").text
+            note = (trans_unit > "note").text
+            note = "(No Commment)" if note.length <= 0
+            
+            file.write "/* #{note} */\n"
+            file.write "\"#{key}\" = #{target.inspect};\n\n"
+          end
+        end
+
+      end
+    end
+
+    def import_plurals_if_needed(locale)
+      plurals_fname = "#{locale}_plurals.yaml"
+      return if !File.exist?(plurals_fname)
+      plurals_yml = YAML.load_file(plurals_fname)
+      plurals_yml[locale].each do |fname, trans_units|
+        content = {}
+        trans_units.each do |key, vals|
+          content[key] = {
+            "NSStringLocalizedFormatKey" => "%\#@value@",
+            "value" => vals.merge({
+              "NSStringFormatSpecTypeKey" => "NSStringPluralRuleType",
+              "NSStringFormatValueTypeKey" => "d"
+            })
           }
+        end
+        File.open(fname, 'w') { |f| f.write content.to_plist }
+      end
+    end
 
-        }
+    def import(locales)
+      puts 'Importing translations'
+      locales.each do |locale|
+        import_xliff(locale)
+        import_plurals_if_needed(locale)
+        puts "Done #{locale}".green
       end
     end
   end

data/lib/xlocalize/version.rb

@@ -1,4 +1,4 @@
 module Xlocalize
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
   DESCRIPTION = "Xcode localizations import/export helper tool"
 end

data/lib/xlocalize/webtranslateit.rb

@@ -6,7 +6,10 @@ module Xlocalize
   class WebtranslateIt
 
     attr_reader :http
-    attr_reader :key, :source_locale, :master_file_id
+    attr_reader :key, :source_locale
+
+    attr_reader :xliff_file_id
+    attr_reader :plurals_file_id
 
     def initialize(key)
       @key = key
@@ -18,17 +21,18 @@ module Xlocalize
         project = JSON.parse(response.body)["project"]
         @source_locale = project["source_locale"]["code"]
         project["project_files"].each {|file|
-          if file["locale_code"] == @source_locale
-            @master_file_id = file["id"]
-            break
-          end
+          next if file["locale_code"] != @source_locale
+          @xliff_file_id = file["id"] if file['name'].end_with? '.xliff'
+          @plurals_file_id = file["id"] if file['name'] == 'plurals.yaml'
         }
-        raise "Could not find master file for source locale #{@source_locale}" if @master_file_id.nil?
+        raise "Could not find master xliff file for source locale #{@source_locale}" if @xliff_file_id.nil?
       }
     end
 
-    def push_master(file, override = true)
-      request = Net::HTTP::Put::Multipart.new("/api/projects/#{@key}/files/#{@master_file_id}/locales/#{@source_locale}", {
+    def push_master(file, plurals_file, override = true)
+      puts 'Updating xliff file'
+      # uploding master xliff file
+      request = Net::HTTP::Put::Multipart.new("/api/projects/#{@key}/files/#{@xliff_file_id}/locales/#{@source_locale}", {
         "file" => UploadIO.new(file, "text/plain", file.path),
         "merge" => !override,
         "ignore_missing" => true,
@@ -40,12 +44,51 @@ module Xlocalize
           raise JSON.parse(res.body)["error"]
         end
       }
+
+      if @plurals_file_id.nil?
+        puts 'Creating plurals file'
+        # /api/projects/:project_token/files [POST]
+        request = Net::HTTP::Post::Multipart.new("/api/projects/#{@key}/files", {
+          "file" => UploadIO.new(plurals_file, "text/plain", plurals_file.path),
+          "name" => "plurals.yaml",
+          "low_priority" => false
+        })
+        @http.request(request) { |res|
+          if !res.code.to_i.between?(200, 300)
+            raise JSON.parse(res.body)["error"]
+          end
+        }
+      else
+        puts 'Updating plurals file'
+        # /api/projects/:project_token/files/:master_project_file_id/locales/:locale_code [PUT]
+        request = Net::HTTP::Put::Multipart.new("/api/projects/#{@key}/files/#{@plurals_file_id}/locales/#{@source_locale}", {
+          "file" => UploadIO.new(plurals_file, "text/plain", plurals_file.path),
+          "merge" => !override,
+          "ignore_missing" => true,
+          "label" => "",
+          "low_priority" => false
+        })
+        @http.request(request) { |res|
+          if !res.code.to_i.between?(200, 300)
+            raise JSON.parse(res.body)["error"]
+          end
+        }
+      end
     end
 
-    def pull(file, locale)
-      http.request(Net::HTTP::Get.new("/api/projects/#{@key}/files/#{master_file_id}/locales/#{locale}")) {|response|
-        file.write(response.body)
-      }
+    def pull(locale)
+      # downloading master xliff file
+      data = {}
+      res = http.request(Net::HTTP::Get.new("/api/projects/#{@key}/files/#{@xliff_file_id}/locales/#{locale}"))
+      raise JSON.parse(res.body)["error"] if !res.code.to_i.between?(200, 300)
+      data['xliff'] = res.body
+      # downloading master plurals file
+      if !@plurals_file_id.nil?
+        res = http.request(Net::HTTP::Get.new("/api/projects/#{@key}/files/#{@plurals_file_id}/locales/#{locale}"))
+        raise JSON.parse(res.body)["error"] if !res.code.to_i.between?(200, 300)
+        data['plurals'] = res.body
+      end
+      return data
     end
 
   end

data/xlocalize.gemspec

@@ -19,10 +19,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'nokogiri'
-  spec.add_runtime_dependency 'commander'
-  spec.add_runtime_dependency 'colorize', '~> 0'
-  
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6'
+  spec.add_runtime_dependency 'commander', '~> 4.4'
+  spec.add_runtime_dependency 'colorize', '~> 0.8'
+  spec.add_runtime_dependency 'plist', '~> 3.2'
+  spec.add_runtime_dependency 'multipart-post', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
 end

metadata

@@ -1,57 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: xlocalize
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Viktoras Laukevičius
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-13 00:00:00.000000000 Z
+date: 2017-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 description: 
 email:
 - viktoras.laukevicius@yahoo.com