bisu 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3653a0a2945c287e0d77426b0701596ecbc626e7
-  data.tar.gz: c1c4ea04cedda5020ffd836589e885a482ddeef5
+  metadata.gz: 26ad7d61670e9ff3ad16fd40743a7d3d9a7543ba
+  data.tar.gz: 257a0a78ac010b9be31fbf1f4e76676189b50419
 SHA512:
-  metadata.gz: a9e3bf46581c3d02f52e1ba3820680be3dfb07190c1171ecd29d66e4ec4f3725d8b39caca86f4379e8427e8801d622577d1ec4a98a2d69a8862bcb2691820f9f
-  data.tar.gz: ecb9703fd7ef9c39b9fbaf537824554fee0acb9ada737ae0bcc3002fd76fff61cc420e29641cbbb5b40fd55d6b24512f213c033b4f1e27b5f5cefdf043ac3584
+  metadata.gz: c2e4b66ceac94f6b4d2274225af7e4780c9c6b85e64a9e38cd403aa447d54f27c078cf7683ecadd86cbd7e2089575ca12e44c296056dc5a1bac848587b9e1acf
+  data.tar.gz: 81eff7ef5103393fb0fbc7295c70a9c1dedbb9b224491e7a68d18ebdc9b0e9fee1616d080d6809a1c492f7f2d492c4294bc43c0a2d020d35ad00823ee6a3ba6d

data/README.md

@@ -60,8 +60,7 @@ Configuration
   "klGeneral_Delete" = "$kDelete$";
   "klGeneral_Cancel" = "$kCancel$";
   "klGeneral_Close"  = "$kClose$";
-
-  "klRequestName"  = "$kRequestName%{user_name: %@}$";
+  "klRequestName"    = "$kRequestName%{user_name: %@}$";
   ```
 
 1. Create a \*.translatable version for your **Android** localization files:

data/bin/bisu

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require 'bisu'
-Bisu.run
+Bisu.run(ARGV)

data/bisu.gemspec

@@ -1,7 +1,9 @@
+require_relative "lib/bisu/version"
+
 Gem::Specification.new do |s|
   s.name        = 'bisu'
-  s.version     = '1.2.0'
-  s.date        = '2015-07-01'
+  s.version     = Bisu::VERSION
+  s.date        = Bisu::VERSION_UPDATED_AT
   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/lib/bisu/translator.rb

@@ -12,7 +12,7 @@ module Bisu
       end
     end
 
-    def translate(language, locale, in_path, out_path)
+    def translate(language, locale, in_path, out_path, default_language=nil)
       unless @kb.has_language?(language)
         Logger.error("Unknown language #{language}")
         return false
@@ -24,7 +24,7 @@ module Bisu
       Logger.info("Translating #{in_path} to #{language} > #{out_path}...")
 
       in_file.each_line do |line|
-        out_file.write(localize(line, language, locale))
+        out_file.write(localize(line, language, locale, default_language))
       end
 
       out_file.flush
@@ -49,7 +49,7 @@ module Bisu
       File.open(File.expand_path(file_name), method)
     end
 
-    def localize(text, language, locale)
+    def localize(text, language, locale, default_language=nil)
       t = text
       t = t.gsub("$specialKLanguage$", language)
       t = t.gsub("$specialKLocale$", locale)
@@ -57,7 +57,7 @@ module Bisu
       t = t.gsub("$specialKComment2$", "Remember to CHANGE THE TEMPLATE and not this file!")
 
       if l = localization_params(t)
-        if localized = @kb.localize(l[:loc_key], language)
+        if localized = @kb.localize(l[:loc_key], language) || @kb.localize(l[:loc_key], default_language)
           l[:loc_vars].each do |param, value|
             localized = localized.gsub("%{#{param}}", value)
           end

data/lib/bisu/version.rb

@@ -0,0 +1,4 @@
+module Bisu
+  VERSION = '1.2.1'
+  VERSION_UPDATED_AT = '2015-07-31'
+end

data/lib/bisu.rb

@@ -2,18 +2,22 @@ require 'bisu/logger'
 require 'bisu/config'
 require 'bisu/knowledge_base'
 require 'bisu/translator'
+require 'bisu/version'
+require 'optparse'
 
 module Bisu
   extend self
 
-  def run
+  def run(opts)
+    options = command_line_options(opts)
+
     if config = Bisu::Config.parse("translatable.yml")
       kbase = Bisu::GoogleDriveKB.new(config[:sheet_id], config[:keys_column])
       translator = Bisu::Translator.new(kbase, config[:type])
 
       config[:in].each do |in_path|
         config[:out].each do |out|
-          localize(translator, out[:locale], out[:kb_language], in_path, out[:path] || config[:out_path])
+          localize(translator, out[:locale], out[:kb_language], options[:default_language], in_path, out[:path] || config[:out_path])
         end
       end
     end
@@ -23,7 +27,30 @@ module Bisu
 
   private
 
-  def localize(translator, locale, language, in_path, out_path)
+  def command_line_options(options)
+    options = {}
+
+    opts_parser = OptionParser.new do |opts|
+      opts.on("-d LANGUAGE", "--default LANGUAGE", "Language to use when there is no available translation") do |language|
+        options[:default_language] = language
+      end
+
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+
+      opts.on_tail("-v", "--version", "Show version") do
+        puts Bisu::VERSION
+        exit
+      end
+    end
+
+    opts_parser.parse!(ARGV)
+    options
+  end
+
+  def localize(translator, locale, language, default_language, in_path, out_path)
     in_name = File.basename(in_path)
     out_name = in_name.gsub(/\.translatable$/, "")
 
@@ -34,7 +61,7 @@ module Bisu
 
     out_path = out_path % { locale: locale, android_locale: locale.gsub("-", "-r"), out_name: out_name }
 
-    translator.translate(language, locale, in_path, out_path)
+    translator.translate(language, locale, in_path, out_path, default_language)
   end
 
 end

data/test/test_bisu_translator.rb

@@ -4,13 +4,15 @@ require 'bisu/translator'
 class BisuTranslatorTest < Minitest::Test
 
   def setup
-    @lang   = "portuguese"
-    @locale = "portuguese"
+    @lang            = "portuguese"
+    @incomplete_lang = "english"
+    @locale          = "PT-PT"
 
     kb = Bisu::KnowledgeBase.new({
-      languages: [@lang],
+      languages: [@lang, @missing_lang],
       keys: {
-        "kRegularKey"     => { @lang => "Não sabes nada João das Neves" },
+        "kRegularKey1"    => { @lang => "Não sabes nada João das Neves", @incomplete_lang => "You know nothing John Snow" },
+        "kRegularKey2"    => { @lang => "Não sabes isto 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..." },
@@ -23,20 +25,31 @@ class BisuTranslatorTest < Minitest::Test
     @tios = Bisu::Translator.new(kb, :ios)
     @tand = Bisu::Translator.new(kb, :android)
     @tror = Bisu::Translator.new(kb, :ror)
+
+    Bisu::Logger.silent_mode = true
+  end
+
+  def teardown
+    Bisu::Logger.silent_mode = false
   end
 
   def test_simple_translate
+    orig0 = "0: $kUnknownKey$"
     orig1 = "1: $specialKComment1$"
     orig2 = "2: $specialKComment2$"
     orig3 = "3: $specialKLanguage$"
     orig4 = "4: $specialKLocale$"
-    orig5 = "5: $kRegularKey$"
+    orig5 = "5: $kRegularKey1$"
     orig6_1 = "6.1: $k1ParameterKey$"
     orig6_2 = "6.2: $k1ParameterKey{name:%1$s}$"
     orig7_1 = "7.1: $k2ParametersKey$"
     orig7_2 = "7.2: $k2ParametersKey{percentage:%2$d, name:%1$s}$"
     orig7_3 = "7.3: $k2ParametersKey{name:%1$s, percentage:%2$d}$"
+    orig8_1 = "8.1: $kRegularKey1$"
+    orig8_2 = "8.2: $kRegularKey2$"
+    orig8_3 = "8.3: $kRegularKey2$"
 
+    loc0 = "0: $kUnknownKey$"
     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: #{@lang}"
@@ -47,8 +60,12 @@ class BisuTranslatorTest < Minitest::Test
     loc7_1 = "7.1: Sabes %{percentage} por cento %{name}."
     loc7_2 = "7.2: Sabes %2$d por cento %1$s."
     loc7_3 = "7.3: Sabes %2$d por cento %1$s."
+    loc8_1 = "8.1: You know nothing John Snow"
+    loc8_2 = "8.2: Não sabes isto João das Neves"
+    loc8_3 = "8.3: $kRegularKey2$"
 
     [@tios, @tand, @tror].each do |translator|
+      assert_equal translator.send(:localize, orig0,   @lang, @locale), loc0
       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
@@ -59,6 +76,10 @@ class BisuTranslatorTest < Minitest::Test
       assert_equal translator.send(:localize, orig7_1, @lang, @locale), loc7_1
       assert_equal translator.send(:localize, orig7_2, @lang, @locale), loc7_2
       assert_equal translator.send(:localize, orig7_3, @lang, @locale), loc7_3
+
+      assert_equal translator.send(:localize, orig8_1, @incomplete_lang, @locale, @lang), loc8_1
+      assert_equal translator.send(:localize, orig8_2, @incomplete_lang, @locale, @lang), loc8_2
+      assert_equal translator.send(:localize, orig8_3, @incomplete_lang, @locale       ), loc8_3
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bisu
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - joaoffcosta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-01 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -84,6 +84,7 @@ files:
 - lib/bisu/knowledge_base.rb
 - lib/bisu/logger.rb
 - lib/bisu/translator.rb
+- lib/bisu/version.rb
 - test/support/sample_kb_public_info.html
 - test/support/sample_kb_public_sheet.html
 - test/support/sample_translatable.yml