bisu 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27aa9e1bc6a0eb2218bc99a5d06f1bebc63c9db5
-  data.tar.gz: 8ff3ce596fbfce168e2296082cd34b59c1dc9f4e
+  metadata.gz: e490a4eb1f3f5aa61b9dc20f112f7ab1715114db
+  data.tar.gz: ad057133b9eb8fc9abc73442030e4a89a4126e41
 SHA512:
-  metadata.gz: 61c5974e3619d06838df1856a4ce4e1cb758adc68de07ce987127725e91c59f04e6d1757e108b08434c25dc18a01aaf8809e8e45bbcc783610b797af617492c9
-  data.tar.gz: 7d242608af60a2bb3fe75ee11dcb68edbe9e81b99da62a5c5595b22b67af5e88ebaa0f253b34d4d612dda9351647e208627e67021a9560b3803651a779a8d373
+  metadata.gz: fb9fddca4965aa22d9cc3101f9cb407aa994ee9fc55c476b1cdd685cfe68391dd7a96f7b8f39ad4d0a5f173fd5165eb664812cba18fa8b9c489c6f8fb76b56e3
+  data.tar.gz: 035ad2f3bd974d9d38564074095d6046174a442fc99e954b29c9d295b893648a9e7869130bd17adc1774e002ccba846320c92b8d70b9e190a2bea367d7aff520

data/README.md

@@ -27,7 +27,7 @@ Configuration
 1. Create in your **iOS/Android** app project base folder a translatable.yml:
 
   ```
-  type: <iOS/Android>
+  type: <iOS/Android/RoR>
   
   sheet_id: <GOOGLE-DRIVE-SHEET-ID>
   keys_column: <GOOGLE-DRIVE-KEY-COLUMN-TITLE>
@@ -36,11 +36,13 @@ Configuration
     - path/to/1st/file.translatable
     - path/to/2nd/file.translatable
   
+  out_path: path/to/%{locale}.lproj/%{out_name}
   out:
-    - language: english
-      folder:   path/to/en.lproj/
-    - language: korean
-      folder:   path/to/ko.lproj/
+    - locale:   en
+      language: english
+      path:     default_path/%{out_name}
+    - locale:   ko
+      language: korean
   ```
 
 1. Create a \*.translatable version for your **iOS** localization files:
@@ -49,7 +51,7 @@ Configuration
   // $specialKComment1$
   // $specialKComment2$
   
-  // $specialKLanguage$
+  // Locale: $specialKLocale$; Language used: $specialKLanguage$
   
   /***********
   *  General
@@ -67,7 +69,7 @@ Configuration
   
   <!-- $specialKComment1$ -->
   <!-- $specialKComment2$ -->
-  <!-- $specialKLanguage$ -->
+  <!-- Locale: $specialKLocale$; Language used: $specialKLanguage$ -->
   
   <resources>
       <string name="delete">$kDelete$</string>
@@ -75,3 +77,13 @@ Configuration
       <string name="close">$kClose$</string>
   </resources>
   ```
+  
+1. Create a \*.translatable version for your **RoR** localization files:
+
+  ```
+  $specialKLocale$:
+    resources:
+      delete: $kDelete$
+      cancel: $kCancel$
+      close: $kClose$
+  ```

data/bisu.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'bisu'
-  s.version     = '1.0.2'
-  s.date        = '2015-02-25'
+  s.version     = '1.1.0'
+  s.date        = '2015-07-01'
   s.summary     = 'A localization automation service'
   s.description = 'Bisu manages your app iOS and Android localization files for you. No more copy+paste induced errors!'
   s.authors     = ['joaoffcosta']

data/generic.translatable.yml

@@ -0,0 +1,27 @@
+# supported types are iOS/Android/RoR
+type: iOS
+
+sheet_id: knownledge-base-sheet-id
+keys_column: column-with-translation-keys
+
+in:
+  - path/to/file/to/1.ext.translatable
+  - path/to/file/to/2.ext.translatable
+  - path/to/file/to/3.ext.translatable
+
+# you may define a generic out_path common for all files
+# or a more specific one in out:path
+#
+# when generating the out path you can use two variables:
+# - locale:   replaced by the out:locale
+# - out_name: replaced by the input file name without .translatable
+
+out_path: path/to/final-%{locale}/%{out_name}
+out:
+  - locale: en
+    kb_language: english
+    path: path/to/default/%{out_name}
+  - locale: pt
+    kb_language: portuguese
+  - locale: pt-PT
+    kb_language: portuguese

data/lib/bisu/knowledge_base.rb

@@ -38,6 +38,7 @@ module Bisu
       uri = URI.parse(uri)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       data = http.get(uri.path, headers)
       XmlSimple.xml_in(data.body, 'KeyAttr' => 'name')
     end

data/lib/bisu/translator.rb

@@ -6,34 +6,25 @@ module Bisu
       @kb   = knowledge_base
       @type = type.downcase.to_sym
 
-      unless [:ios, :android].include?(@type)
+      unless [:ios, :android, :ror].include?(@type)
         Logger.error("Unknown type #{@type}")
         raise
       end
     end
 
-    def translate(language, in_path, out_folder)
+    def translate(language, locale, in_path, out_path)
       unless @kb.has_language?(language)
         Logger.error("Unknown language #{language}")
         return false
       end
 
-      in_name  = File.basename(in_path)
-      out_name = in_name.gsub(/\.translatable$/, "")
-      out_path = "#{out_folder}#{out_name}"
-      
-      unless in_name.match /\.translatable$/
-        Logger.error("Expected .translatable file. Got '#{in_name}'")
-        return false
-      end
-
       return false unless in_file  = open_file(in_path,  "r", true)
       return false unless out_file = open_file(out_path, "w", false)
 
       Logger.info("Translating #{in_path} to #{language} > #{out_path}...")
 
       in_file.each_line do |line|
-        out_file.write(localize(line, language))
+        out_file.write(localize(line, language, locale))
       end
 
       out_file.flush
@@ -58,9 +49,10 @@ module Bisu
       File.open(File.expand_path(file_name), method)
     end
 
-    def localize(text, language)
+    def localize(text, language, locale)
       t = text
-      t = t.gsub("$specialKLanguage$", language.upcase)
+      t = t.gsub("$specialKLanguage$", language)
+      t = t.gsub("$specialKLocale$", locale)
       t = t.gsub("$specialKComment1$", "This file was automatically generated based on a translation template.")
       t = t.gsub("$specialKComment2$", "Remember to CHANGE THE TEMPLATE and not this file!")
 
@@ -86,6 +78,8 @@ module Bisu
       elsif @type.eql?(:ios)
         text = text.gsub(/\"/, "\\\\\"")
       end
+      
+      text
     end
   end
 end

data/lib/bisu.rb

@@ -4,18 +4,37 @@ require 'bisu/knowledge_base'
 require 'bisu/translator'
 
 module Bisu
-  def self.run
+  extend self
+
+  def run
     if config = Bisu::Config.parse("translatable.yml")
       kbase = Bisu::GoogleDriveKB.new(config[:sheet_id], config[:keys_column])
-      trans = Bisu::Translator.new(kbase, config[:type])
+      translator = Bisu::Translator.new(kbase, config[:type])
 
       config[:in].each do |in_path|
         config[:out].each do |out|
-          trans.translate(out[:language], in_path, out[:folder])
+          localize(translator, out[:locale], out[:kb_language], in_path, out[:path] || config[:out_path])
         end
       end
     end
 
     Bisu::Logger.print_summary
   end
+
+  private
+
+  def localize(translator, locale, language, in_path, out_path)
+    in_name = File.basename(in_path)
+    out_name = in_name.gsub(/\.translatable$/, "")
+
+    unless in_name.match /\.translatable$/
+      Logger.error("Expected .translatable file. Got '#{in_name}'")
+      return false
+    end
+
+    out_path = out_path % { locale: locale, out_name: out_name }
+
+    translator.translate(language, locale, in_path, out_path)
+  end
+
 end

data/test/support/sample_translatable.yml

@@ -1,14 +1,18 @@
-type: iOS
+type: BisuOS
 
 sheet_id: abc1234567890
 keys_column: key_name
 
 in:
-  - folder/file_1.translatable
-  - folder/file_2.translatable
+  - path/to/file/to/1.ext.translatable
+  - path/to/file/to/2.ext.translatable
 
+out_path: path/to/final-%{locale}/%{out_name}
 out:
-  - language: english
-    folder:   hole19/en.lproj/
-  - language: portuguese
-    folder:   hole19/pt.lproj/
+  - locale: en
+    kb_language: english
+    path: path/to/default/%{out_name}
+  - locale: pt
+    kb_language: portuguese
+  - locale: pt-PT
+    kb_language: portuguese

data/test/test_bisu_config.rb

@@ -6,18 +6,21 @@ class BisuConfigTest < Minitest::Test
   def test_parse
     config = Bisu::Config.parse("test/support/sample_translatable.yml")
 
-    assert_equal config[:type], "iOS"
+    assert_equal config[:type], "BisuOS"
     assert_equal config[:sheet_id], "abc1234567890"
     assert_equal config[:keys_column], "key_name"
     
     assert_equal config[:in], [
-      "folder/file_1.translatable",
-      "folder/file_2.translatable"
+      "path/to/file/to/1.ext.translatable",
+      "path/to/file/to/2.ext.translatable"
     ]
     
+    assert_equal config[:out_path], "path/to/final-%{locale}/%{out_name}"
+
     assert_equal config[:out], [
-      { language: "english", folder: "hole19/en.lproj/" },
-      { language: "portuguese", folder:   "hole19/pt.lproj/" }
+      { locale: "en",    kb_language: "english", path: "path/to/default/%{out_name}" },
+      { locale: "pt",    kb_language: "portuguese" },
+      { locale: "pt-PT", kb_language: "portuguese" }
     ]
   end
 end

data/test/test_bisu_translator.rb

@@ -4,50 +4,54 @@ require 'bisu/translator'
 class BisuTranslatorTest < Minitest::Test
 
   def setup
+    @lang   = "portuguese"
+    @locale = "portuguese"
+
     kb = Bisu::KnowledgeBase.new({
-      languages: ["PT"],
+      languages: [@lang],
       keys: {
-        "kRegularKey"  => { "PT" => "Não sabes nada João das Neves" },
-        "kIOSKey"      => { "PT" => "Não sabes nada \"João das Neves\"" },
-        "kAndroidKey1" => { "PT" => "Não sabes nada 'João das Neves'" },
-        "kAndroidKey2" => { "PT" => "Não sabes nada João das Neves..." },
-        "kAndroidKey3" => { "PT" => "Não sabes nada João das Neves & Pícaros" },
+        "kRegularKey"  => { @lang => "Não sabes nada João das Neves" },
+        "kIOSKey"      => { @lang => "Não sabes nada \"João das Neves\"" },
+        "kAndroidKey1" => { @lang => "Não sabes nada 'João das Neves'" },
+        "kAndroidKey2" => { @lang => "Não sabes nada João das Neves..." },
+        "kAndroidKey3" => { @lang => "Não sabes nada João das Neves & Pícaros" },
       }
     })
 
     @tios = Bisu::Translator.new(kb, :ios)
     @tand = Bisu::Translator.new(kb, :android)
+    @tror = Bisu::Translator.new(kb, :ror)
   end
 
   def test_simple_translate
     orig1 = "1: $specialKComment1$"
     orig2 = "2: $specialKComment2$"
     orig3 = "3: $specialKLanguage$"
-    orig4 = "4: $kRegularKey$"
+    orig4 = "4: $specialKLocale$"
+    orig5 = "5: $kRegularKey$"
 
     loc1 = "1: This file was automatically generated based on a translation template."
     loc2 = "2: Remember to CHANGE THE TEMPLATE and not this file!"
-    loc3 = "3: PT"
-    loc4 = "4: Não sabes nada João das Neves"
-
-    assert_equal @tios.send(:localize, orig1, "PT"), loc1
-    assert_equal @tios.send(:localize, orig2, "PT"), loc2
-    assert_equal @tios.send(:localize, orig3, "PT"), loc3
-    assert_equal @tios.send(:localize, orig4, "PT"), loc4
-
-    assert_equal @tand.send(:localize, orig1, "PT"), loc1
-    assert_equal @tand.send(:localize, orig2, "PT"), loc2
-    assert_equal @tand.send(:localize, orig3, "PT"), loc3
-    assert_equal @tand.send(:localize, orig4, "PT"), loc4
+    loc3 = "3: #{@lang}"
+    loc4 = "4: #{@locale}"
+    loc5 = "5: Não sabes nada João das Neves"
+
+    [@tios, @tand, @tror].each do |translator|
+      assert_equal translator.send(:localize, orig1, @lang, @locale), loc1
+      assert_equal translator.send(:localize, orig2, @lang, @locale), loc2
+      assert_equal translator.send(:localize, orig3, @lang, @locale), loc3
+      assert_equal translator.send(:localize, orig4, @lang, @locale), loc4
+      assert_equal translator.send(:localize, orig5, @lang, @locale), loc5
+    end
   end
 
   def test_ios_translate
-    assert_equal @tios.send(:localize, "1: $kIOSKey$", "PT"), "1: Não sabes nada \\\"João das Neves\\\""
+    assert_equal @tios.send(:localize, "1: $kIOSKey$", @lang, @locale), "1: Não sabes nada \\\"João das Neves\\\""
   end
 
   def test_android_translate
-    assert_equal @tand.send(:localize, "1: $kAndroidKey1$", "PT"), "1: Não sabes nada \\'João das Neves\\'"
-    assert_equal @tand.send(:localize, "2: $kAndroidKey2$", "PT"), "2: Não sabes nada João das Neves…"
-    assert_equal @tand.send(:localize, "3: $kAndroidKey3$", "PT"), "3: Não sabes nada João das Neves &amp; Pícaros"
+    assert_equal @tand.send(:localize, "1: $kAndroidKey1$", @lang, @locale), "1: Não sabes nada \\'João das Neves\\'"
+    assert_equal @tand.send(:localize, "2: $kAndroidKey2$", @lang, @locale), "2: Não sabes nada João das Neves…"
+    assert_equal @tand.send(:localize, "3: $kAndroidKey3$", @lang, @locale), "3: Não sabes nada João das Neves &amp; Pícaros"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bisu
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - joaoffcosta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-25 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -78,6 +78,7 @@ files:
 - Rakefile
 - bin/bisu
 - bisu.gemspec
+- generic.translatable.yml
 - lib/bisu.rb
 - lib/bisu/config.rb
 - lib/bisu/knowledge_base.rb