bisu 1.2.3 → 1.2.4

data/lib/bisu/knowledge_base.rb

@@ -1,73 +0,0 @@
-require "net/https"
-require "xmlsimple"
-
-module Bisu
-
-  class KnowledgeBase
-    def initialize(kb)
-      raise "Bad KB format (expected Hash)"             unless kb.is_a?(Hash)
-      raise "Bad KB format (expected :languages Array)" unless kb.key?(:languages) && kb[:languages].is_a?(Array)
-      raise "Bad KB format (expected :keys Hash)"       unless kb.key?(:keys)      && kb[:keys].is_a?(Hash)
-      @kb = kb
-    end
-
-    def has_language?(language)
-      @kb[:languages].include?(language)
-    end
-
-    def localize(key, language)
-      if locals = @kb[:keys][key]
-        locals[language]
-      else
-        nil
-      end
-    end
-  end
-
-
-  class GoogleDriveKB < KnowledgeBase
-    def initialize(sheet_id, keys_column_title)
-      raw = raw_data(sheet_id)
-      kb  = parse(raw, keys_column_title)
-      super(kb)
-    end
-
-    private
-
-    def feed_data(uri, headers=nil)
-      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
-
-    def raw_data(sheet_id)
-      Logger.info("Downloading Knowledge Base...")
-      sheet = feed_data("https://spreadsheets.google.com/feeds/worksheets/#{sheet_id}/public/full")
-      feed_data(sheet["entry"][0]["link"][0]["href"])
-    end
-
-    def parse(raw_data, key)
-      Logger.info("Parsing Knowledge Base...")
-
-      remove = ["id", "updated", "category", "title", "content", "link", key]
-
-      kb_keys = {}
-      raw_data["entry"].each do |entry|
-        hash = entry.select { |d| !remove.include?(d) }
-        hash = hash.each.map { |k, v| v.first == {} ? [k, nil] : [k, v.first] }
-        kb_keys[entry[key].first] = Hash[hash]
-      end
-
-      kb = { languages: kb_keys.values.first.keys, keys: kb_keys }
-
-      Logger.info("Knowledge Base parsed successfully!")
-      Logger.info("Found #{kb[:keys].count} keys in #{kb[:languages].count} languages.")
-
-      kb
-    end
-  end
-
-end

data/lib/bisu/translator.rb

@@ -1,105 +0,0 @@
-require 'fileutils'
-
-module Bisu
-  class Translator
-    def initialize(knowledge_base, type)
-      @kb   = knowledge_base
-      @type = type.downcase.to_sym
-
-      unless [:ios, :android, :ror].include?(@type)
-        Logger.error("Unknown type #{@type}")
-        raise
-      end
-    end
-
-    def translate(language, locale, in_path, out_path, default_language=nil)
-      unless @kb.has_language?(language)
-        Logger.error("Unknown language #{language}")
-        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, locale, default_language))
-      end
-
-      out_file.flush
-      out_file.close
-      in_file.close
-
-      true
-    end
-
-    private
-
-    def open_file(file_name, method, must_exist)
-      if !File.file?(File.expand_path(file_name))
-        if must_exist
-          Logger.error("File #{file_name} not found!")
-          return nil
-        else
-          FileUtils.mkdir_p(File.dirname(file_name))
-        end
-      end
-
-      File.open(File.expand_path(file_name), method)
-    end
-
-    def localize(text, language, locale, default_language=nil)
-      t = text
-      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!")
-
-      if l = localization_params(t)
-        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
-          t = t.gsub(l[:match], process(localized))
-        end
-      end
-
-      t.scan(/\$k[^\$]+\$/) { |match| Logger.warn("Could not find translation for #{match} in #{language}") }
-      t.scan(/%{[^}]+}/) { |match| Logger.error("Could not find translation param for #{match} in #{language}") }
-
-      t
-    end
-
-    def localization_params(text)
-      return nil unless matches = text.match(/\$(k[^\$\{]+)(?:\{(.+)\})?\$/)
-
-      loc_vars = if matches[2]
-        vars = matches[2].split(",").map(&:strip)
-        vars = vars.map do |var|
-          key, value = var.split(":", 2).map(&:strip)
-          [key.to_sym, value]
-        end
-        Hash[vars]
-      end
-
-      { match:    matches[0],
-        loc_key:  matches[1],
-        loc_vars: loc_vars || {} }
-    end
-
-    def process(text)
-      if @type.eql?(:android)
-        text = text.gsub(/[']/, "\\\\\\\\'")
-        text = text.gsub("...", "…")
-        text = text.gsub("& ", "& ")
-        text = text.gsub("@", "\\\\@")
-
-      elsif @type.eql?(:ios)
-        text = text.gsub(/\"/, "\\\\\"")
-      end
-
-      text
-    end
-  end
-end

data/test/test_bisu_config.rb

@@ -1,26 +0,0 @@
-require 'minitest/autorun'
-require 'bisu/config'
-
-class BisuConfigTest < Minitest::Test
-
-  def test_parse
-    config = Bisu::Config.parse("test/support/sample_translatable.yml")
-
-    assert_equal config[:type], "BisuOS"
-    assert_equal config[:sheet_id], "abc1234567890"
-    assert_equal config[:keys_column], "key_name"
-    
-    assert_equal config[:in], [
-      "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], [
-      { 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_knowledge_base.rb

@@ -1,42 +0,0 @@
-require 'minitest/autorun'
-require 'bisu/knowledge_base'
-
-class BisuKnowledgeBaseTest < Minitest::Test
-
-  def test_parsing
-    stub_request(:get, "https://spreadsheets.google.com/feeds/worksheets/abc1234567890/public/full").to_return(
-      status: 200, body: File.read("test/support/sample_kb_public_info.html"), headers: {})
-
-    stub_request(:get, "https://spreadsheets.google.com/feeds/list/abc1234567890/od6/public/full").to_return(
-      status: 200, body: File.read("test/support/sample_kb_public_sheet.html"), headers: {})
-
-    Bisu::Logger.silent_mode = true
-
-    Bisu::GoogleDriveKB.new("abc1234567890", "key_column")
-
-    Bisu::Logger.silent_mode = false
-  end
-
-  def test_has_language?
-    kb = Bisu::KnowledgeBase.new({
-      languages: ["portuguese"],
-      keys: {}
-    })
-    
-    assert_equal kb.has_language?("kriolo"),     false
-    assert_equal kb.has_language?("portuguese"), true
-  end
-
-  def test_localize
-    key      = "kYouKnowNothingJohnSnow"
-    pt_trans = "Não sabes nada João das Neves"
-
-    kb = Bisu::KnowledgeBase.new({
-      languages: ["portuguese"],
-      keys: { key => { "portuguese" => pt_trans } }
-    })
-
-    assert_equal kb.localize(key, "kriolo"),     nil
-    assert_equal kb.localize(key, "portuguese"), pt_trans
-  end
-end

data/test/test_bisu_logger.rb

@@ -1,22 +0,0 @@
-require 'minitest/autorun'
-require 'bisu/logger'
-
-class BisuLoggerTest < Minitest::Test
-
-  def test_print_summary
-    Bisu::Logger.clean_summary
-    Bisu::Logger.silent_mode = true
-
-    1.times { Bisu::Logger.info  "info"  }
-    2.times { Bisu::Logger.warn  "warn"  }
-    3.times { Bisu::Logger.error "error" }
-
-    Bisu::Logger.silent_mode = false
-
-    sum = Bisu::Logger.summary
-
-    assert_equal sum[:info],  1
-    assert_equal sum[:warn],  2
-    assert_equal sum[:error], 3
-  end
-end

data/test/test_bisu_translator.rb

@@ -1,121 +0,0 @@
-require 'minitest/autorun'
-require 'bisu/translator'
-
-class BisuTranslatorTest < Minitest::Test
-
-  def setup
-    @lang            = "portuguese"
-    @incomplete_lang = "english"
-    @locale          = "PT-PT"
-
-    kb = Bisu::KnowledgeBase.new({
-      languages: [@lang, @missing_lang],
-      keys: {
-        "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..." },
-        "kAndroidKey3"    => { @lang => "Não sabes nada João das Neves & Pícaros" },
-        "k1ParameterKey"  => { @lang => "Não sabes nada %{name}" },
-        "k2ParametersKey" => { @lang => "Sabes %{percentage} por cento %{name}." },
-        "kAtBegin"        => { @lang => "\@hole19golf on twitter" },
-        "kAtMiddle"       => { @lang => "Find us @hole19golf on twitter" },
-      }
-    })
-
-    @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: $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}"
-    loc4 = "4: #{@locale}"
-    loc5 = "5: Não sabes nada João das Neves"
-    loc6_1 = "6.1: Não sabes nada %{name}"
-    loc6_2 = "6.2: Não sabes nada %1$s"
-    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
-      assert_equal translator.send(:localize, orig4,   @lang, @locale), loc4
-      assert_equal translator.send(:localize, orig5,   @lang, @locale), loc5
-      assert_equal translator.send(:localize, orig6_1, @lang, @locale), loc6_1
-      assert_equal translator.send(:localize, orig6_2, @lang, @locale), loc6_2
-      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
-
-  def test_ios_translate
-    assert_equal @tios.send(:localize, "1: $kIOSKey$",   @lang, @locale), "1: Não sabes nada \\\"João das Neves\\\""
-    assert_equal @tios.send(:localize, "2: $kAtBegin$",  @lang, @locale), "2: @hole19golf on twitter"
-    assert_equal @tios.send(:localize, "3: $kAtMiddle$", @lang, @locale), "3: Find us @hole19golf on twitter"
-  end
-
-  def test_android_translate
-    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"
-    assert_equal @tand.send(:localize, "4: $kAtBegin$",     @lang, @locale), "4: \\@hole19golf on twitter"
-    assert_equal @tand.send(:localize, "5: $kAtMiddle$",    @lang, @locale), "5: Find us \\@hole19golf on twitter"
-  end
-
-  def test_missing_translations
-    Bisu::Logger.clean_summary
-
-    assert_equal @tios.send(:localize, "1: $kUnknownKey$.", @lang, @locale), "1: $kUnknownKey$."
-
-    sum = Bisu::Logger.summary
-    assert_equal 1, sum[:warn]
-    assert_equal 0, sum[:error]
-  end
-
-  def test_cannot_find_translation_param
-    Bisu::Logger.clean_summary
-
-    assert_equal @tios.send(:localize, "1: $k2ParametersKey$", @lang, @locale), "1: Sabes %{percentage} por cento %{name}."
-
-    sum = Bisu::Logger.summary
-    assert_equal 0, sum[:warn]
-    assert_equal 2, sum[:error]
-  end
-end

data/test/test_helper.rb

@@ -1,3 +0,0 @@
-require 'webmock/minitest'
-
-WebMock.disable_net_connect!