xlocalize 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f92b8896b3c93789775661d8d918efa00504b0f
-  data.tar.gz: 29f41bf80a64c1da95806679d0b19fcc9ff1fdc0
+  metadata.gz: fc1db3d226514b4c5d809d86fd2dedcdde3723cc
+  data.tar.gz: 3b7203835f011707bf6e2a5f9211d52fba40b018
 SHA512:
-  metadata.gz: 5e503707d2265b37717c365a1c67b1ab85d1da11776a5aa5077b32ac8b792fb551f4c32f3fd16cc2a6f8bbdc20dedffcb04299f5a4c39cadc743318696dd41d6
-  data.tar.gz: 1b16f3dfc86abe85824cb3769b2362a79d1cc62edacb3da884e5178f0cd58ebfdf7475ce8a44dd23b906662a9c57422df69ec3c34a1ad673146274347d8afcee
+  metadata.gz: b9d1f17f00b1523166cabad373f60e6b8eab502f5113575c19c758335be5d05d60df2af20a8fe704abc736e6324355bbb3a4f31477da1e0a0b697e8612c80833
+  data.tar.gz: 06d71123e95960f687ad162389adf70c6fce1f692f44727ead36a74ebaa49106d1060d9dcd7e923328c94ae8a1dec01d6bc61824e2b97e13dee34b2302a63569

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+cache: bundler
+rvm: 2.0.0
+osx_image: xcode8
+git:
+  depth: 1
+before_install: gem install bundler
+install: bundle install
+script: bundle exec rspec -f d -c
+os: osx
+addons:
+  code_climate:
+    repo_token: b4206ed2b9443314c998e8909dfa31f0ed476ea5ab460b98e102cd20508ff564
+after_success:
+  - bundle exec codeclimate-test-reporter
+  

data/README.md

@@ -1,3 +1,9 @@
+[![Build Status](https://travis-ci.org/viktorasl/xlocalize.svg?branch=master)](https://travis-ci.org/viktorasl/xlocalize)
+[![Gem Version](https://badge.fury.io/rb/xlocalize.svg)](https://badge.fury.io/rb/xlocalize)
+[![Code Climate](https://codeclimate.com/github/viktorasl/xlocalize/badges/gpa.svg)](https://codeclimate.com/github/viktorasl/xlocalize)
+[![Test Coverage](https://codeclimate.com/github/viktorasl/xlocalize/badges/coverage.svg)](https://codeclimate.com/github/viktorasl/xlocalize/coverage)
+[![Inline docs](http://inch-ci.org/github/viktorasl/xlocalize.svg?branch=master)](http://inch-ci.org/github/viktorasl/xlocalize)
+
 # Xlocalize
 
 To see all commands execute:

data/lib/xlocalize/executor.rb

@@ -1,9 +1,9 @@
 require 'xlocalize/webtranslateit'
+require 'xlocalize/xliff'
 require 'colorize'
 require 'nokogiri'
 require 'plist'
 require 'yaml'
-require 'pathname'
 
 module Xlocalize
   class Executor
@@ -30,7 +30,10 @@ module Xlocalize
       end
 
       purelyze(master_lang, target, excl_prefix, project)
+      push_master_file(wti, master_lang, master_file_name)
+    end
 
+    def push_master_file(wti, master_lang, master_file_name)
       # Pushing master file to WebtranslateIt
       begin
         puts "Uploading master file to WebtranslateIt"
@@ -49,68 +52,50 @@ module Xlocalize
 
     def purelyze(locale, target, excl_prefix, project)
       locale_file_name = locale_file_name(locale)
-      target_prefix = "#{target}/"
       doc = Nokogiri::XML(open(locale_file_name))
 
-      puts "Removing all files not matching required targets"
-      doc.xpath("//xmlns:file").each { |node|
-        fname = node["original"]
-        node.remove if !fname.start_with?(target_prefix) || !fname.include?(".lproj/")
-      }
-
-      puts "Removing trans-unit's having reserverd prefix in their sources"
-      doc.xpath("//xmlns:source").each { |node|
-        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 "Removing all files not matching required targets" if $VERBOSE
+      doc.filter_not_target_files(target)
+      puts "Removing trans-unit's having reserverd prefix in their sources" if $VERBOSE
+      doc.filter_trans_units(excl_prefix)
+      puts "Filtering plurals" if $VERBOSE
+      plurals = doc.filter_plurals(project)
+      puts "Removing all files having no trans-unit elements after removal" if $VERBOSE
+      doc.filter_empty_files
 
-      puts "Writing modified XLIFF file to #{locale_file_name}"
+      puts "Writing modified XLIFF file to #{locale_file_name}" if $VERBOSE
       File.open(locale_file_name, 'w') { |f| f.write(doc.to_xml) }
-
       if !plurals.empty?
-        puts "Writing plurals to plurals YAML file"
+        puts "Writing plurals to plurals YAML file" if $VERBOSE
         File.open(plurals_file_name(locale), 'w') { |f| f.write({locale => plurals}.to_yaml) }
       end
     end
 
+    def out_list_of_translations_of_locale(wti, locale, translations)
+      puts "Downloading translations for #{locale}"
+      translations = wti.pull(locale)
+      plurals_content = translations['plurals']
+
+      out_list = [{
+        "path" => "#{locale}.xliff",
+        "content" => translations['xliff']
+      }]
+      out_list << {
+        "path" => "#{locale}_plurals.yaml",
+        "content" => plurals_content
+      } if not plurals_content.nil?
+
+      return out_list
+    end
+
     def download(wti, locales)
       begin
         locales.each do |locale|
-          puts "Downloading translations for #{locale}"
-          translations = wti.pull(locale)
-
-          File.open("#{locale}.xliff", "w") {|file|
-            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
-            }
+          out_list_of_translations_of_locale(wti, locale, translations).each do |out|
+            File.open(out["path"], "w") do |file|
+              file.write(out["content"])
+              puts "Done saving #{out['path']}.".green
+            end
           end
         end
       rescue => err
@@ -118,26 +103,26 @@ module Xlocalize
       end
     end
 
-    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
+    def filename_from_xliff_provided_filename(file_name)
+      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
-        
-        File.open(name, "w") do |file|
+      end
+      return name
+    end
+
+    def import_xliff(locale)
+      Nokogiri::XML(open("#{locale}.xliff")).xpath("//xmlns:file").each do |node|
+        File.open(filename_from_xliff_provided_filename(node["original"]), "w") do |file|
           (node > "body > trans-unit").each do |trans_unit|
             key = trans_unit["id"]
             target = (trans_unit > "target").text
@@ -148,7 +133,6 @@ module Xlocalize
             file.write "\"#{key}\" = #{target.inspect};\n\n"
           end
         end
-
       end
     end
 
@@ -172,11 +156,11 @@ module Xlocalize
     end
 
     def import(locales)
-      puts 'Importing translations'
+      puts 'Importing translations' if $VERBOSE
       locales.each do |locale|
         import_xliff(locale)
         import_plurals_if_needed(locale)
-        puts "Done #{locale}".green
+        puts "Done #{locale}".green if $VERBOSE
       end
     end
   end

data/lib/xlocalize/version.rb

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

data/lib/xlocalize/webtranslateit.rb

@@ -11,10 +11,10 @@ module Xlocalize
     attr_reader :xliff_file_id
     attr_reader :plurals_file_id
 
-    def initialize(key)
+    def initialize(key, http = Net::HTTP.new("webtranslateit.com", 443))
       @key = key
 
-      @http = Net::HTTP.new("webtranslateit.com", 443)
+      @http = http
       @http.use_ssl = true
 
       @http.request(Net::HTTP::Get.new("/api/projects/#{@key}")) {|response|
@@ -23,73 +23,69 @@ module Xlocalize
         project["project_files"].each {|file|
           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'
+          @plurals_file_id = file["id"] if file['name'] == 'plurals.yml'
         }
-        raise "Could not find master xliff file for source locale #{@source_locale}" if @xliff_file_id.nil?
       }
+      raise "Could not find master xliff file for source locale #{@source_locale}" if @xliff_file_id.nil?
+    end
+
+    def send_request(request)
+      resp = nil
+      @http.request(request) { |res|
+        if !res.code.to_i.between?(200, 300)
+          raise JSON.parse(res.body)["error"]
+        end
+        resp = res
+      }
+      return resp
+    end
+
+    def master_file_for_locale_request(file_id, file, override)
+      # /api/projects/:project_token/files/:master_project_file_id/locales/:locale_code [PUT]
+      return Net::HTTP::Put::Multipart.new("/api/projects/#{@key}/files/#{file_id}/locales/#{@source_locale}", {
+        "file" => UploadIO.new(file, "text/plain", file.path),
+        "merge" => !override,
+        "ignore_missing" => true,
+        "label" => "",
+        "low_priority" => false
+      })
     end
 
     def push_master_plurals(plurals_file, override = true)
       if @plurals_file_id.nil?
-        puts 'Creating plurals file'
+        if $VERBOSE
+          $stderr.puts 'Creating plurals file'
+        end
         # /api/projects/:project_token/files [POST]
-        request = Net::HTTP::Post::Multipart.new("/api/projects/#{@key}/files", {
+        send_request(Net::HTTP::Post::Multipart.new("/api/projects/#{@key}/files", {
           "file" => UploadIO.new(plurals_file, "text/plain", plurals_file.path),
-          "name" => "plurals.yaml",
+          "name" => "plurals.yml",
           "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
-        }
+        if $VERBOSE
+          $stderr.puts 'Updating plurals file'
+        end
+        send_request(master_file_for_locale_request(@plurals_file_id, plurals_file, override))
       end
     end
 
     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,
-        "label" => "",
-        "low_priority" => false })
-
-      @http.request(request) {|res|
-        if !res.code.to_i.between?(200, 300)
-          raise JSON.parse(res.body)["error"]
-        end
-      }
-
+      if $VERBOSE
+        $stderr.puts 'Updating xliff file'
+      end
+      send_request(master_file_for_locale_request(@xliff_file_id, file, override))
       push_master_plurals(plurals_file, override) if not plurals_file.nil?
     end
 
     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)
+      res = send_request(Net::HTTP::Get.new("/api/projects/#{@key}/files/#{@xliff_file_id}/locales/#{locale}"))
       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)
+        res = send_request(Net::HTTP::Get.new("/api/projects/#{@key}/files/#{@plurals_file_id}/locales/#{locale}"))
         data['plurals'] = res.body
       end
       return data

data/lib/xlocalize/xliff.rb

@@ -0,0 +1,48 @@
+require 'nokogiri'
+require 'pathname'
+
+module Xlocalize
+  class ::Nokogiri::XML::Document
+
+    def filter_not_target_files(target)
+      target_prefix = "#{target}/"
+      self.xpath("//xmlns:file").each { |node|
+        fname = node["original"]
+        node.remove if !fname.start_with?(target_prefix) || !fname.include?(".lproj/")
+      }
+    end
+
+    def filter_trans_units(prefix)
+      self.xpath("//xmlns:source").each { |node|
+        node.parent.remove if node.content.start_with?(prefix)
+      }
+    end
+
+    def filter_plurals(project)
+      plurals = {}
+      self.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)
+        
+        translations = {}
+        Plist::parse_xml(file_full_path).each do |key, val|
+          transl = val["value"].select { |k, _| ['zero', 'one', 'two', 'few', 'many', 'other'].include?(k) }
+          translations[key] = transl
+          sel = 'body > trans-unit[id="' << key << '"]'
+          node.css(sel).remove
+        end
+        plurals[fname_stringsdict] = translations
+      }
+      return plurals
+    end
+
+    def filter_empty_files
+      self.xpath("//xmlns:body").each { |node|
+        node.parent.remove if node.elements.count == 0
+      }
+    end
+  end
+end

data/lib/xlocalize.rb

@@ -7,11 +7,7 @@ module Xlocalize
   class XlocalizeCLI
     include Commander::Methods
 
-    def run
-      program :name, 'Xlocalize'
-      program :version, Xlocalize::VERSION
-      program :description, Xlocalize::DESCRIPTION
-
+    def define_export_cmd
       command :export do |c|
         c.syntax = 'xlocalize export [options]'
         c.description = 'Export localized strings from Xcode project'
@@ -20,7 +16,7 @@ module Xlocalize
         c.option '--target STRING', String, 'Target in the project'
         c.option '--excl_prefix STRING', String, 'Exclude strings having specified prefix'
         c.option '--master_lang STRING', String, 'Master language of the project'
-        c.action do |args, options|
+        c.action do |_, options|
           if options.project.nil? or
              options.target.nil? or
              options.excl_prefix.nil? or
@@ -32,13 +28,15 @@ module Xlocalize
           Executor.new.export_master(wti, options.project, options.target, options.excl_prefix, options.master_lang)
         end
       end
+    end
 
+    def define_download_cmd
       command :download do |c|
         c.syntax = 'xlocalize download [options]'
         c.description = 'Download localized strings from WebtranslateIt project'
         c.option '--wti_key STRING', String, 'Webtranslateit API key'
         c.option '--locales ARRAY', Array, 'Locales to download'
-        c.action do |args, options|
+        c.action do |_, options|
           if options.wti_key.nil? or
              options.locales.nil?
             raise 'Missing parameter'
@@ -47,12 +45,14 @@ module Xlocalize
           Executor.new.download(WebtranslateIt.new(options.wti_key), options.locales)
         end
       end
+    end
 
+    def define_import_cmd
       command :import do |c|
         c.syntax = 'xlocalize import [options]'
         c.description = 'Import localized strings to Xcode project'
         c.option '--locales ARRAY', Array, 'Locales to import'
-        c.action do |args, options|
+        c.action do |_, options|
           if options.locales.nil?
             raise 'Missing parameter'
           end
@@ -60,7 +60,17 @@ module Xlocalize
           Executor.new.import(options.locales)
         end
       end
+    end
+
+    def run
+      program :name, 'Xlocalize'
+      program :version, Xlocalize::VERSION
+      program :description, Xlocalize::DESCRIPTION
 
+      define_export_cmd
+      define_download_cmd
+      define_import_cmd
+      
       run!
     end
   end

data/xlocalize.gemspec

@@ -19,13 +19,14 @@ 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', '~> 1.6'
+  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'
+  spec.add_development_dependency 'simplecov', '~> 0.13'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: xlocalize
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Viktoras Laukevičius
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-17 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
@@ -95,33 +95,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: 
 email:
 - viktoras.laukevicius@yahoo.com
@@ -133,6 +147,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -145,6 +160,7 @@ files:
 - lib/xlocalize/executor.rb
 - lib/xlocalize/version.rb
 - lib/xlocalize/webtranslateit.rb
+- lib/xlocalize/xliff.rb
 - xlocalize.gemspec
 homepage: https://github.com/viktorasl/xlocalize
 licenses:
@@ -166,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Xcode localizations import/export helper tool