bisu 1.7.2 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de4d41b8e81de051cee161b99f77b0e6e81fe7cdb878191beb46a9427db39db5
-  data.tar.gz: f840f4d92ebc448ad43e298dcb95f3223c323a81f9441a1967689b278a501282
+  metadata.gz: a1a7abda3e27e23715ea0f2fb7b3e4bcb916c7a12b7eb691f5a5e3e8e1288a5c
+  data.tar.gz: 9a82418e8e0783d4d78783f895a95749a011defaa39332bb6732816d6222454a
 SHA512:
-  metadata.gz: dc08b4b71b33d3db13a04302905d1846b190aa7e9febbf5eea69a97da4d2147be3ae97c270f2d658b9c2d7b1f598e8cdeb32daba762927cd508164b3a305d9c0
-  data.tar.gz: ad976c7db6db95a592d9306e90e9c9051276cb2bc3dab784e97bef92d947386445c7f0d315b589df29e60833ac665039c4445d3d178dc1b21a30da6acb59892b
+  metadata.gz: 6c5d8bdcc8bf58bed26a44d949a9094c20382b9853b562c63165e6211b76cb9aa4c2f70db7e0577bf94358a9d83b4b64d8c8d1dbabadc8e2e7da056c01fce5b1
+  data.tar.gz: 508e86e0a9c4db4f3e7d5e691d9d5e4bf42656de4fcd52f0acd42acbb92836dc84d928aae9125466622cbde55a3a6a9f31482f3853aa805c890ac87451c1ee15

data/.rspec

@@ -1,5 +1,4 @@
 --color
 --format documentation
 --profile
---drb
 --require spec_helper

data/.ruby-version

@@ -1 +1 @@
-2.5.0
+2.7.3

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 All notable changes to this project will be documented in this file.
 `Bisu` adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.9.0](https://github.com/hole19/bisu/releases/tag/v1.9.0)
+Released on 2021/05/21
+
+#### Added
+- Adds a new option to surpress missing params when that's intentional: add "//ignore-params" to the end of the translation key
+
+## [1.8.0](https://github.com/hole19/bisu/releases/tag/v1.8.0)
+Released on 2020/04/30
+
+#### Added
+- Adds a new option: allows a single translation to have a specific fallback language (example: "es-MX" fallback to "es")
+
+## [1.7.3](https://github.com/hole19/bisu/releases/tag/v1.7.3)
+Released on 2020/03/09
+
+#### Added
+- Correctly handles percentage sign on iOS platform
+
 ## [1.7.2](https://github.com/hole19/bisu/releases/tag/v1.7.2)
 Released on 2020/03/09
 

data/Gemfile

@@ -1,9 +1,8 @@
 source 'https://rubygems.org'
-ruby '2.5.0'
+ruby '2.7.3'
 
 gem 'safe_yaml',  '~> 1.0'
 gem 'colorize',   '~> 0.7'
-gem 'xml-simple', '~> 1.1'
 
 group :test do
   gem 'rake'

data/Gemfile.lock

@@ -1,37 +1,38 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     colorize (0.8.1)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
     hashdiff (1.0.1)
-    public_suffix (4.0.3)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    public_suffix (4.0.6)
+    rake (13.0.3)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
+      rspec-support (~> 3.10.0)
     rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.9.1)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     safe_yaml (1.0.5)
     webmock (1.24.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
-    xml-simple (1.1.5)
+    xml-simple (1.1.8)
 
 PLATFORMS
   ruby
@@ -46,7 +47,7 @@ DEPENDENCIES
   xml-simple (~> 1.1)
 
 RUBY VERSION
-   ruby 2.5.0p0
+   ruby 2.7.3p183
 
 BUNDLED WITH
-   1.17.2
+   2.1.4

data/README.md

@@ -24,7 +24,7 @@ Usage
 1. Run: `bisu`
 1. That's it!*
 
-*given that someone already configured Bisu
+\*_given that someone already configured Bisu_
 
 Setup your configuration file
 -----
@@ -45,11 +45,12 @@ Setup your configuration file
       out: path/to/2nd-%{locale}/strings.xml
 
   languages:
-    - locale:   en
-      language: en
-    - locale:   en-US
-      language: en
-    - locale:   pt
+    - locale: en
+      language: en # the language as it appears in the dictionary
+    - locale: en-US
+      language: en-us
+      fallback_language: en
+    - locale: pt
       language: pt
   ```
 
@@ -65,14 +66,14 @@ Setup your configuration file
 
 1. First ["Publish to the web"](https://www.google.com/search?q=google+sheets+publish+to+web) your Google Sheet
 1. Share only the sheet that contains the translations
+1. Make sure you CSV format
 1. First column should contain the translation keys
 1. First row should contain the locale for each language
 
   ```
   dictionary:
     type: google_sheet
-    sheet_id: <GOOGLE-DRIVE-SHEET-ID>
-    keys_column: <GOOGLE-DRIVE-KEY-COLUMN-TITLE>
+    url: <GOOGLE-DRIVE-SHEET-CSV-URL>
   ```
 
 ##### OneSky integration:

data/bisu.gemspec

@@ -18,7 +18,4 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'safe_yaml',  '~> 1.0'
   s.add_runtime_dependency 'colorize',   '~> 0.7'
-  s.add_runtime_dependency 'xml-simple', '~> 1.1'
-
-  s.add_development_dependency 'webmock', '~> 1.20'
 end

data/generic.translatable.yml

@@ -3,8 +3,7 @@ type: iOS
 
 dictionary:
   type: google_sheet
-  sheet_id: <GOOGLE-DRIVE-SHEET-ID>
-  keys_column: <GOOGLE-DRIVE-KEY-COLUMN-TITLE>
+  url: <GOOGLE-DRIVE-SHEET-CSV-URL>
 
 translate:
   - in: path/to/1st/file.translatable

data/lib/bisu/config.rb

@@ -27,7 +27,7 @@ module Bisu
       @hash[:translate].each do |t|
         @hash[:languages].each do |l|
           downcase_locale = l[:locale].downcase.gsub("-", "_").gsub(" ", "_")
-          yield(t[:in], (t[:"out_#{downcase_locale}"] || t[:out]) % l, l[:language], l[:locale])
+          yield(t[:in], (t[:"out_#{downcase_locale}"] || t[:out]) % l, l[:locale], l[:language], l[:fallback_language])
         end
       end
     end
@@ -50,7 +50,8 @@ module Bisu
         languages: { type: Array, elements: {
           type: Hash, elements: {
             locale: { type: String },
-            language: { type: String }
+            language: { type: String },
+            fallback_language: { type: String, optional: true }
           }
         } }
       }
@@ -60,9 +61,8 @@ module Bisu
       type: Hash,
       elements: {
         type: { type: String },
-        sheet_id: { type: String },
-        keys_column: { type: String }
-      }
+        url: { type: String },
+      },
     }
 
     ONE_SKY_STRUCT = {
@@ -71,15 +71,15 @@ module Bisu
         api_key: { type: String },
         api_secret: { type: String },
         project_id: { type: Integer },
-        file_name: { type: String }
-      }
+        file_name: { type: String },
+      },
     }
 
     URL_STRUCT = {
       type: Hash,
       elements: {
-        url: { type: String }
-      }
+        url: { type: String },
+      },
     }
 
     DICTIONARY_STRUCT = {

data/lib/bisu/localizer.rb

@@ -10,7 +10,7 @@ module Bisu
       end
     end
 
-    def localize(text, language, locale, fallback_language=nil)
+    def localize(text, language, locale, fallback_languages=[])
       t = text
       t = t.gsub("$specialKLanguage$", language)
       t = t.gsub("$specialKLocale$", locale)
@@ -18,7 +18,7 @@ module Bisu
       t = t.gsub("$specialKComment2$", "Remember to CHANGE THE TEMPLATE and not this file!")
 
       to_localize(t).map do |l|
-        if localized = @dict.localize(language, l[:key]) || @dict.localize(fallback_language, l[:key])
+        if localized = localize_key(l[:key], [language] + fallback_languages)
           localized = process(localized)
 
           l[:params].each do |param, value|
@@ -32,22 +32,32 @@ module Bisu
           unless t.gsub!(l[:match], localized)
             Logger.warn("Could not find translation for #{l[:match]} in #{language}")
           end
+
+          unless @type.eql?(:ror) || l[:ignore_param_warn] == true
+            localized.scan(/%{[^}]+}/) { |match| Logger.error("Could not find translation param for #{match} in #{language}") }
+          end
         else
           Logger.warn("Could not find translation for #{l[:match]} in #{language}")
         end
       end
 
-      unless @type.eql?(:ror)
-        t.scan(/%{[^}]+}/) { |match| Logger.error("Could not find translation param for #{match} in #{language}") }
+      t
+    end
+
+    def localize_key(key, ordered_languages)
+      ordered_languages.each do |language|
+        if localized = @dict.localize(language, key)
+          return localized
+        end
       end
 
-      t
+      nil
     end
 
     private
 
     def to_localize(text)
-      all_matches = text.to_enum(:scan, /\$([^\$\{]+)(?:\{(.+)\})?\$/).map { Regexp.last_match }
+      all_matches = text.to_enum(:scan, /\$([^\$\{\/]+)(?:\{(.+)\})?(\/\/ignore-params)?\$/).map { Regexp.last_match }
       all_matches.map do |match|
         params = if match[2]
           params = match[2].split(",").map(&:strip).map do |param|
@@ -57,9 +67,12 @@ module Bisu
           Hash[params]
         end
 
-        { match:  match[0],
+        {
+          match:  match[0],
           key:    match[1],
-          params: params || {} }
+          params: params || {},
+          ignore_param_warn: text.include?("//ignore-params")
+        }
       end
     end
 
@@ -75,6 +88,7 @@ module Bisu
 
       elsif @type.eql?(:ios)
         text = text.gsub(/\"/, "\\\\\"")
+        text = text.gsub(/%(?!{)/, "%%")
       end
 
       text

data/lib/bisu/source/google_sheet.rb

@@ -1,64 +1,60 @@
 require "net/https"
-require "xmlsimple"
+require "csv"
 
 module Bisu
   module Source
     class GoogleSheet
-      def initialize(sheet_id, keys_column)
-        @sheet_id = sheet_id
-        @key_column = keys_column
+      def initialize(url)
+        @url = url
       end
 
       def to_i18
-        raw = raw_data(@sheet_id)
+        Logger.info("Downloading Google Sheet from #{@url}...")
 
-        Logger.info("Downloading dictionary from Google Sheet...")
+        csv = get_csv(@url)
 
-        non_language_columns = ["id", "updated", "category", "title", "content", "link", @key_column]
+        hash = {}
 
-        kb = {}
-        raw["entry"].each do |entry|
-          unless (key = entry[@key_column]) && key = key.first
-            raise "Bisu::Source::GoogleSheet: Cannot find key column '#{@key_column}'"
-          end
+        languages = csv.headers[1..]
+        languages.each { |lang| hash[lang] = {} }
 
-          entry.select { |c| !non_language_columns.include?(c) }.each do |lang, texts|
-            kb[lang] ||= {}
-            kb[lang][key] = texts.first unless texts.first == {}
+        csv.each do |row|
+          languages.each do |lang|
+            hash[lang][row["key"]] = row[lang] unless row[lang].nil?
           end
         end
 
         Logger.info("Google Sheet parsed successfully!")
-        Logger.info("Found #{kb.count} languages.")
+        Logger.info("Found #{languages.count} languages.")
 
-        kb
+        hash
       end
 
       private
 
-      def xml_data(uri, headers=nil)
-        uri = URI.parse(uri)
+      def get_csv(url)
+        data = get(url)
+
+        begin
+          CSV.parse(data, headers: true)
+        rescue StandardError => e
+          raise "Bisu::Source::GoogleSheet: Cannot parse. Expected CSV at #{url}: #{e}"
+        end
+      end
+
+      def get(url)
+        uri = URI(url)
+
         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)
 
-        unless data.code.to_i == 200
-          raise "Bisu::Source::GoogleSheet: Cannot access sheet at #{uri} - HTTP #{data.code}"
-        end
+        request = Net::HTTP::Get.new(uri.request_uri)
+        response = http.request(request)
 
-        begin
-          XmlSimple.xml_in(data.body, 'KeyAttr' => 'name')
-        rescue
-          raise "Bisu::Source::GoogleSheet: Cannot parse. Expected XML at #{uri}"
-        end
-      end
+        raise "Bisu::Source::GoogleSheet: Http Error #{response.body}" if response.code.to_i >= 400
 
-      def raw_data(sheet_id)
-        Logger.info("Downloading Google Sheet...")
-        sheet = xml_data("https://spreadsheets.google.com/feeds/worksheets/#{sheet_id}/public/full")
-        url   = sheet["entry"][0]["link"][0]["href"]
-        xml_data(url)
+        response.body
       end
     end
   end

data/lib/bisu/version.rb

@@ -1,4 +1,4 @@
 module Bisu
-  VERSION = '1.7.2'
-  VERSION_UPDATED_AT = '2020-03-09'
+  VERSION = '1.10.0'
+  VERSION_UPDATED_AT = '2021-08-30'
 end

data/lib/bisu.rb

@@ -23,13 +23,15 @@ module Bisu
       dictionary   = dictionary_for(config: config.dictionary, options: options)
       localizer    = Bisu::Localizer.new(dictionary, config.type)
 
-      config.localize_files do |in_path, out_path, language, locale|
+      config.localize_files do |in_path, out_path, locale, language, fallback_language|
         unless dictionary.has_language?(language)
           Logger.error("Unknown language #{language}")
           return false
         end
 
-        localize_file(localizer, locale, language, options[:default_language], in_path, out_path)
+        fallback_languages = ([fallback_language] + [options[:default_language]]).compact
+
+        localize_file(localizer, locale, language, fallback_languages, in_path, out_path)
       end
     end
 
@@ -57,7 +59,7 @@ module Bisu
     source =
       case config[:type]
       when "google_sheet"
-        Bisu::Source::GoogleSheet.new(config[:sheet_id], config[:keys_column])
+        Bisu::Source::GoogleSheet.new(config[:url])
       when "one_sky"
         Bisu::Source::OneSky.new(config[:api_key], config[:api_secret], config[:project_id], config[:file_name])
       when "url"
@@ -131,14 +133,14 @@ module Bisu
     File.open(File.expand_path(file_name), method)
   end
 
-  def localize_file(localizer, locale, language, default_language, in_path, out_path)
+  def localize_file(localizer, locale, language, fallback_languages, in_path, out_path)
     Logger.info("Translating #{in_path} to #{language} > #{out_path}...")
 
     return false unless in_file  = open_file(in_path,  "r", true)
     return false unless out_file = open_file(out_path, "w", false)
 
     in_file.each_line do |line|
-      out_file.write(localizer.localize(line, language, locale, default_language))
+      out_file.write(localizer.localize(line, language, locale, fallback_languages))
     end
 
     out_file.flush

data/spec/fixtures/sample.translatable.yml

@@ -2,8 +2,7 @@ type: iOS
 
 dictionary:
   type: google_sheet
-  sheet_id: sheet-id
-  keys_column: keys-column
+  url: sheet-public-url
 
 translate:
   - in: hole19/Localizable.strings.translatable
@@ -15,4 +14,5 @@ languages:
   - locale: en
     language: english
   - locale: en-US
-    language: english
+    language: english-us
+    fallback_language: english

data/spec/fixtures/sample_google_response.csv

@@ -0,0 +1,4 @@
+key,en,ja,fr,de,ko
+kConnectFacebook,Connect with Facebook,フェイスブックへ接続,Connexion par Facebook,Mit Facebook verbinden,페이스북으로 접속
+kNoNoNoMr,"No, no, no. Mr %{name} not here",,,,
+kTwitterServer,,,,,트위터 서버연결 실패. \n잠시 후 재시도.

data/spec/lib/bisu/config_spec.rb

@@ -4,25 +4,24 @@ describe Bisu::Config do
   let(:hash) { {
     type: "BisuOS",
     dictionary: {
-      type:         "google_sheet",
-      sheet_id:     "abc1234567890",
-      keys_column:  "key_name"
+      type: "google_sheet",
+      url: "https://abc1234567890",
     },
     translate: [
-      { in:        "path/to/file/to/1.ext.translatable",
-        out:       "path/to/final-%{locale}/1.ext",
+      { in: "path/to/file/to/1.ext.translatable",
+        out: "path/to/final-%{locale}/1.ext",
         out_en_us: "path/to/default/1.ext"
       },
-      { in:        "path/to/file/to/2.ext.translatable",
-        out:       "path/to/final-%{locale}/2.ext",
+      { in: "path/to/file/to/2.ext.translatable",
+        out: "path/to/final-%{locale}/2.ext",
         out_en_us: "path/to/default/2.ext"
       },
     ],
     languages: [
-      { locale: "en-US",      language: "english"    },
-      { locale: "pt",         language: "portuguese" },
-      { locale: "pt-PT",      language: "portuguese" },
-      { locale: "pt-Batatas", language: "portuguese" }
+      { locale: "en-US", language: "english"    },
+      { locale: "pt", language: "portuguese" },
+      { locale: "pt-PT", language: "portuguese" },
+      { locale: "pt-Batatas", language: "portuguese-bt", fallback_language: "portuguese" }
     ]
   } }
 
@@ -37,16 +36,16 @@ describe Bisu::Config do
   describe "#dictionary" do
     subject(:dictionary) { config.dictionary }
 
-    it { should eq({ type: "google_sheet", sheet_id: "abc1234567890", keys_column: "key_name" }) }
+    it { should eq({ type: "google_sheet", url: "https://abc1234567890" }) }
 
     context "when given a OneSky type dictionary" do
       before do
         hash[:dictionary] = {
-          type:       "one_sky",
-          api_key:    "as387oavh48",
+          type: "one_sky",
+          api_key: "as387oavh48",
           api_secret: "bp0s5avo8a59",
           project_id: 328742,
-          file_name:  "file.json"
+          file_name: "file.json"
         }
       end
 
@@ -57,7 +56,7 @@ describe Bisu::Config do
       before do
         hash[:dictionary] = {
           type: "url",
-          url:  "a_url"
+          url: "a_url"
         }
       end
 
@@ -75,14 +74,14 @@ describe Bisu::Config do
       expect { |b|
         config.localize_files(&b)
       }.to yield_successive_args(
-        ["path/to/file/to/1.ext.translatable", "path/to/default/1.ext",          "english",    "en-US"     ],
-        ["path/to/file/to/1.ext.translatable", "path/to/final-pt/1.ext",         "portuguese", "pt"        ],
-        ["path/to/file/to/1.ext.translatable", "path/to/final-pt-PT/1.ext",      "portuguese", "pt-PT"     ],
-        ["path/to/file/to/1.ext.translatable", "path/to/final-pt-Batatas/1.ext", "portuguese", "pt-Batatas"],
-        ["path/to/file/to/2.ext.translatable", "path/to/default/2.ext",          "english",    "en-US"     ],
-        ["path/to/file/to/2.ext.translatable", "path/to/final-pt/2.ext",         "portuguese", "pt"        ],
-        ["path/to/file/to/2.ext.translatable", "path/to/final-pt-PT/2.ext",      "portuguese", "pt-PT"     ],
-        ["path/to/file/to/2.ext.translatable", "path/to/final-pt-Batatas/2.ext", "portuguese", "pt-Batatas"]
+        ["path/to/file/to/1.ext.translatable", "path/to/default/1.ext",          "en-US",      "english",       nil         ],
+        ["path/to/file/to/1.ext.translatable", "path/to/final-pt/1.ext",         "pt",         "portuguese",    nil         ],
+        ["path/to/file/to/1.ext.translatable", "path/to/final-pt-PT/1.ext",      "pt-PT",      "portuguese",    nil         ],
+        ["path/to/file/to/1.ext.translatable", "path/to/final-pt-Batatas/1.ext", "pt-Batatas", "portuguese-bt", "portuguese"],
+        ["path/to/file/to/2.ext.translatable", "path/to/default/2.ext",          "en-US",      "english",       nil         ],
+        ["path/to/file/to/2.ext.translatable", "path/to/final-pt/2.ext",         "pt",         "portuguese",    nil         ],
+        ["path/to/file/to/2.ext.translatable", "path/to/final-pt-PT/2.ext",      "pt-PT",      "portuguese",    nil         ],
+        ["path/to/file/to/2.ext.translatable", "path/to/final-pt-Batatas/2.ext", "pt-Batatas", "portuguese-bt", "portuguese"]
       )
     end
   end

data/spec/lib/bisu/localizer_spec.rb

@@ -1,4 +1,9 @@
 describe Bisu::Localizer do
+  def translates(text, fallbacks: [], to:, lang: nil)
+    translation = localizer.localize(text, lang || language, locale, fallbacks)
+    expect(translation).to eq to
+  end
+
   let(:language) { "Portuguese" }
   let(:locale)   { "pt-PT" }
 
@@ -19,6 +24,9 @@ describe Bisu::Localizer do
       "kAtSign"          => "\@johnsnow sabes alguma coisa?",
       "kPercentage"      => "Sabes 0% João das Neves."
     },
+    "Spanish" => {
+      "kMissingTransKey" => "Sabes poco John Snow"
+    },
     "English" => {
       "kMissingTransKey" => "You know little John Snow"
     }
@@ -30,11 +38,6 @@ describe Bisu::Localizer do
   shared_examples_for "a localizer" do
     it { expect { localizer }.not_to raise_error }
 
-    def translates(text, fallback: nil, to:, lang: nil)
-      translation = localizer.localize(text, lang || language, locale, fallback)
-      expect(translation).to eq to
-    end
-
     it { translates("a line with no key", to: "a line with no key") }
 
     it { translates("this special key: $specialKComment1$", to: "this special key: This file was automatically generated based on a translation template.") }
@@ -46,7 +49,8 @@ describe Bisu::Localizer do
     it { translates("this key: $kTranslationKey$", to: "this key: Não sabes nada João das Neves", lang: "portuguese") }
     it { translates("this unknown key: $kUnknownKey$", to: "this unknown key: $kUnknownKey$") }
     it { translates("this key with missing translations: $kMissingTransKey$", to: "this key with missing translations: $kMissingTransKey$") }
-    it { translates("this key with missing translations: $kMissingTransKey$", fallback: "English", to: "this key with missing translations: You know little John Snow") }
+    it { translates("this key with missing translations: $kMissingTransKey$", fallbacks: ["English"], to: "this key with missing translations: You know little John Snow") }
+    it { translates("this key with missing translations: $kMissingTransKey$", fallbacks: ["Spanish", "English"], to: "this key with missing translations: Sabes poco John Snow") }
     it { translates("these 2 keys: $kTranslationKey$, $kTranslationKey2$", to: "these 2 keys: Não sabes nada João das Neves, Naaada!") }
 
     it { translates("1 parameter: $k1ParameterKey$",                         to: "1 parameter: Não sabes nada %{name}") }
@@ -83,7 +87,7 @@ describe Bisu::Localizer do
        .and not_change { Bisu::Logger.summary[:error] }
     end
 
-    it "throws an error when missing key parameters (expect on ruby on rails)" do
+    it "throws a error when missing key parameters (expect on ruby on rails)" do
       if type == :ror
         expect {
           localizer.localize("$k1ParameterKey$", language, locale)
@@ -110,6 +114,17 @@ describe Bisu::Localizer do
       }.to not_change { Bisu::Logger.summary[:warn] }
        .and change { Bisu::Logger.summary[:error] }.by(1)
     end
+
+    # non localizable text with params
+
+    it "does not try to translate params outside $$" do
+      translates("%{some_text}", to: "%{some_text}")
+
+      expect {
+        localizer.localize("%{some_text}", language, locale)
+      }.to not_change { Bisu::Logger.summary[:warn] }
+       .and not_change { Bisu::Logger.summary[:error] }
+    end
   end
 
   let(:type_dependent_defaults) { {
@@ -125,10 +140,38 @@ describe Bisu::Localizer do
     let(:type) { :ios }
 
     let(:expected) { type_dependent_defaults.merge(
-      double_quoted: "Não sabes nada \\\"João das Neves\\\""
+      double_quoted: "Não sabes nada \\\"João das Neves\\\"",
+      percentage: "Sabes 0%% João das Neves."
     ) }
 
     it_behaves_like "a localizer"
+
+    context "when a parameter replacemnt was not defined" do
+      let(:line) { "1 parameter: $k1ParameterKey$" }
+      let(:expected) { "1 parameter: Não sabes nada %{name}" }
+
+      it { translates(line, to: expected) }
+
+      it "returns an error" do
+        expect {
+          localizer.localize(line, language, locale)
+        }.to not_change { Bisu::Logger.summary[:warn] }
+         .and change { Bisu::Logger.summary[:error] }.by(1)
+      end
+
+      context "when passing //ignore-params" do
+        let(:line) { "1 parameter: $k1ParameterKey//ignore-params$" }
+
+        it { translates(line, to: expected) }
+
+        it "does not return an error" do
+          expect {
+            localizer.localize(line, language, locale)
+          }.to not_change { Bisu::Logger.summary[:warn] }
+           .and not_change { Bisu::Logger.summary[:error] }
+        end
+      end
+    end
   end
 
   describe "of type Android" do

data/spec/lib/bisu/source/google_sheet_spec.rb

@@ -1,68 +1,43 @@
 describe Bisu::Source::GoogleSheet do
-  subject(:to_i18) { Bisu::Source::GoogleSheet.new(sheet_id, key_column).to_i18 }
+  subject(:to_i18) { Bisu::Source::GoogleSheet.new(url).to_i18 }
 
-  let(:sheet_id) { "abc1234567890" }
-  let(:url_info)  { "https://spreadsheets.google.com/feeds/worksheets/#{sheet_id}/public/full" }
-  let(:url_sheet) { "https://spreadsheets.google.com/feeds/list/#{sheet_id}/od6/public/full" }
+  let(:url) { "https://docs.google.com/spreadsheets/d/e/2PACX-1vTm6yu_zfbxKizC-PvUE1HVFCsplmiyz0s0qLSIGeokA7KtS3BgtqaA79CsfYfPsXH6xzUaP8HDTcj8/pub?gid=0&single=true&output=csv" }
+  let(:response) { File.read("spec/fixtures/sample_google_response.csv") }
 
-  let(:key_column) { "key_column" }
-
-  context "when given a valid sheet" do
-    let(:file_info)  { File.read("spec/fixtures/sample_kb_public_info.html") }
-    let(:file_sheet) { File.read("spec/fixtures/sample_kb_public_sheet.html") }
-
-    before do
-      stub_request(:get, url_info).to_return(:status => 200, :body => file_info, :headers => {})
-      stub_request(:get, url_sheet).to_return(:status => 200, :body => file_sheet, :headers => {})
-    end
-
-    it do
-      expect { to_i18 }.not_to raise_error
-    end
-
-    it "returns an hash in i18 format" do
-      expect(to_i18).to eq({
-        "english"    => { "kConnectFacebook" => "Connect with Facebook",  "kConnectEmail" => "Connect with Email" },
-        "german"     => { "kConnectFacebook" => "Mit Facebook verbinden", "kConnectEmail" => "Mit E-Mail verbinden" },
-        "portuguese" => { "kConnectFacebook" => "Registar com Facebook",  "kConnectEmail" => "Registar com Email" },
-        "spanish"    => { "kConnectFacebook" => "Conéctate con Facebook", "kConnectEmail" => "Conéctate con Email" },
-        "french"     => { "kConnectFacebook" => "Connecter Facebook" },
-        "dutch"      => { "kConnectFacebook" => "Facebook Verbinden",     "kConnectEmail" => "Email Verbinden" },
-        "korean"     => { "kConnectFacebook" => "페이스북으로 접속",           "kConnectEmail" => "이메일로 접속" },
-        "japanese"   => { "kConnectFacebook" => "フェイスブックへ接続",      "kConnectEmail" => "電子メールアカウントに接続" }
-     })
-    end
+  def stub_url(status:, response:)
+    stub_request(:get, url).
+      to_return(:status => status, :body => response, :headers => {})
+  end
 
-    context "but the key column is not present in the first sheet" do
-      let(:key_column) { "expecting_another_key_column" }
+  before { stub_url(status: 200, response: response) }
 
-      it do
-        expect { to_i18 }.to raise_error /Cannot find key column/
-      end
-    end
+  it do
+    expect { to_i18 }.not_to raise_error
   end
 
-  context "when given an inexistent sheet" do
-    before { stub_request(:get, url_info).to_return(:status => 400, :body => "Not Found", :headers => {}) }
-
-    it do
-      expect { to_i18 }.to raise_error /Cannot access sheet/
-    end
+  it "returns an hash in i18 format" do
+    expect(to_i18).to eq({
+      "en" => { "kConnectFacebook" => "Connect with Facebook", "kNoNoNoMr" => "No, no, no. Mr %{name} not here" },
+      "ja" => { "kConnectFacebook" => "フェイスブックへ接続" },
+      "fr" => { "kConnectFacebook" => "Connexion par Facebook" },
+      "de" => { "kConnectFacebook" => "Mit Facebook verbinden" },
+      "ko" => { "kConnectFacebook" => "페이스북으로 접속", "kTwitterServer" => "트위터 서버연결 실패. \\n잠시 후 재시도." }
+   })
   end
 
-  context "when given a private sheet" do
-    before { stub_request(:get, url_info).to_return(:status => 302, :body => "<HTML></HTML>", :headers => {}) }
+  context "when given an inexistent sheet" do
+    before { stub_url(status: 400, response: "Not Found") }
 
     it do
-      expect { to_i18 }.to raise_error /Cannot access sheet/
+      expect { to_i18 }.to raise_error /Http Error/
     end
   end
 
-  context "when url content is not XML" do
-    before { stub_request(:get, url_info).to_return(:status => 200, :body => "This is not XML; { this: \"is json\" }", :headers => {}) }
+  context "when url content is not CSV" do
+    before { stub_url(status: 200, response: "{\"asdsa\": \"This is a json\"}") }
 
     it do
-      expect { to_i18 }.to raise_error /Cannot parse. Expected XML/
+      expect { to_i18 }.to raise_error /Cannot parse. Expected CSV/
     end
   end
 end

data/spec/lib/bisu_spec.rb

@@ -7,7 +7,8 @@ describe Bisu do
     before do
       allow(Bisu).to receive(:open_file).and_return(file)
       allow_any_instance_of(Bisu::Source::GoogleSheet).to receive(:to_i18).and_return({
-        "english" => { "kKey" => "Value" }
+        "english" => { "kKey" => "Value" },
+        "english-us" => { "kKey" => "Value" }
       })
       allow(Bisu).to receive(:localize_file)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bisu
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.10.0
 platform: ruby
 authors:
 - joaoffcosta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -38,34 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: xml-simple
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.20'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.20'
 description: Bisu manages your app iOS and Android localization files for you. No
   more copy+paste induced errors!
 email: joaostacosta@gmail.com
@@ -97,9 +69,8 @@ files:
 - lib/bisu/source/url.rb
 - lib/bisu/version.rb
 - spec/fixtures/sample.translatable.yml
+- spec/fixtures/sample_google_response.csv
 - spec/fixtures/sample_json_response.json
-- spec/fixtures/sample_kb_public_info.html
-- spec/fixtures/sample_kb_public_sheet.html
 - spec/fixtures/sample_one_sky_response.json
 - spec/fixtures/sample_one_sky_response_with_bug.json
 - spec/lib/bisu/config_spec.rb
@@ -131,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A localization automation service

data/spec/fixtures/sample_kb_public_info.html

@@ -1 +0,0 @@
-<?xml version='1.0' encoding='UTF-8'?><feed xmlns='http://www.w3.org/2005/Atom' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/' xmlns:gs='http://schemas.google.com/spreadsheets/2006'><id>https://spreadsheets.google.com/feeds/worksheets/abc1234567890/public/full</id><updated>2015-02-09T18:59:53.874Z</updated><category scheme='http://schemas.google.com/spreadsheets/2006' term='http://schemas.google.com/spreadsheets/2006#worksheet'/><title type='text'>H19: Translation Knowledge Base</title><link rel='alternate' type='application/atom+xml' href='https://docs.google.com/spreadsheets/d/abc1234567890/pubhtml'/><link rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml' href='https://spreadsheets.google.com/feeds/worksheets/abc1234567890/public/full'/><link rel='http://schemas.google.com/g/2005#post' type='application/atom+xml' href='https://spreadsheets.google.com/feeds/worksheets/abc1234567890/public/full'/><link rel='self' type='application/atom+xml' href='https://spreadsheets.google.com/feeds/worksheets/abc1234567890/public/full'/><author><name>anthony.douglas</name><email>anthony.douglas@hole19golf.com</email></author><openSearch:totalResults>1</openSearch:totalResults><openSearch:startIndex>1</openSearch:startIndex><entry><id>https://spreadsheets.google.com/feeds/worksheets/abc1234567890/public/full/od6</id><updated>2015-02-09T18:59:53.874Z</updated><category scheme='http://schemas.google.com/spreadsheets/2006' term='http://schemas.google.com/spreadsheets/2006#worksheet'/><title type='text'>Translations</title><content type='text'>Translations</content><link rel='http://schemas.google.com/spreadsheets/2006#listfeed' type='application/atom+xml' href='https://spreadsheets.google.com/feeds/list/abc1234567890/od6/public/full'/><link rel='http://schemas.google.com/spreadsheets/2006#cellsfeed' type='application/atom+xml' href='https://spreadsheets.google.com/feeds/cells/abc1234567890/od6/public/full'/><link rel='http://schemas.google.com/visualization/2008#visualizationApi' type='application/atom+xml' href='https://docs.google.com/spreadsheets/d/abc1234567890/gviz/tq?gid=0&amp;pub=1'/><link rel='http://schemas.google.com/spreadsheets/2006#exportcsv' type='text/csv' href='https://docs.google.com/spreadsheets/d/abc1234567890/export?gid=0&amp;format=csv'/><link rel='self' type='application/atom+xml' href='https://spreadsheets.google.com/feeds/worksheets/abc1234567890/public/full/od6'/><gs:colCount>25</gs:colCount><gs:rowCount>665</gs:rowCount></entry></feed>

data/spec/fixtures/sample_kb_public_sheet.html

@@ -1 +0,0 @@
-<?xml version='1.0' encoding='UTF-8'?><feed xmlns='http://www.w3.org/2005/Atom' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/' xmlns:gsx='http://schemas.google.com/spreadsheets/2006/extended'><id>https://spreadsheets.google.com/feeds/list/abc1234567890/od6/public/full</id><updated>2015-02-09T18:59:53.874Z</updated><category scheme='http://schemas.google.com/spreadsheets/2006' term='http://schemas.google.com/spreadsheets/2006#list'/><title type='text'>Translations</title><link rel='alternate' type='application/atom+xml' href='https://docs.google.com/spreadsheets/d/abc1234567890/pubhtml'/><link rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml' href='https://spreadsheets.google.com/feeds/list/abc1234567890/od6/public/full'/><link rel='http://schemas.google.com/g/2005#post' type='application/atom+xml' href='https://spreadsheets.google.com/feeds/list/abc1234567890/od6/public/full'/><link rel='self' type='application/atom+xml' href='https://spreadsheets.google.com/feeds/list/abc1234567890/od6/public/full'/><author><name>anthony.douglas</name><email>anthony.douglas@hole19golf.com</email></author><openSearch:totalResults>664</openSearch:totalResults><openSearch:startIndex>1</openSearch:startIndex><entry><id>https://spreadsheets.google.com/feeds/list/abc1234567890/od6/public/full/cokwr</id><updated>2015-02-09T18:59:53.874Z</updated><category scheme='http://schemas.google.com/spreadsheets/2006' term='http://schemas.google.com/spreadsheets/2006#list'/><title type='text'>kConnectFacebook</title><content type='text'>english: Connect with Facebook, german: Mit Facebook verbinden, portuguese: Registar com Facebook, spanish: Conéctate con Facebook, french: Connecter Facebook, dutch: Facebook Verbinden, korean: 페이스북으로 접속, japanese: フェイスブックへ接続, key_column_2: kConnectFacebook</content><link rel='self' type='application/atom+xml' href='https://spreadsheets.google.com/feeds/list/abc1234567890/od6/public/full/cokwr'/><gsx:key_column>kConnectFacebook</gsx:key_column><gsx:english>Connect with Facebook</gsx:english><gsx:german>Mit Facebook verbinden</gsx:german><gsx:portuguese>Registar com Facebook</gsx:portuguese><gsx:spanish>Conéctate con Facebook</gsx:spanish><gsx:french>Connecter Facebook</gsx:french><gsx:dutch>Facebook Verbinden</gsx:dutch><gsx:korean>페이스북으로 접속</gsx:korean><gsx:japanese>フェイスブックへ接続</gsx:japanese></entry><entry><id>https://spreadsheets.google.com/feeds/list/abc1234567890/od6/public/full/cpzh4</id><updated>2015-02-09T18:59:53.874Z</updated><category scheme='http://schemas.google.com/spreadsheets/2006' term='http://schemas.google.com/spreadsheets/2006#list'/><title type='text'>kConnectEmail</title><content type='text'>english: Connect with Email, german: Mit E-Mail verbinden, portuguese: Registar com Email, spanish: Conéctate con Email, dutch: Email Verbinden, korean: 이메일로 접속, japanese: 電子メールアカウントに接続, key_column_2: kConnectEmail</content><link rel='self' type='application/atom+xml' href='https://spreadsheets.google.com/feeds/list/abc1234567890/od6/public/full/cpzh4'/><gsx:key_column>kConnectEmail</gsx:key_column><gsx:english>Connect with Email</gsx:english><gsx:german>Mit E-Mail verbinden</gsx:german><gsx:portuguese>Registar com Email</gsx:portuguese><gsx:spanish>Conéctate con Email</gsx:spanish><gsx:french></gsx:french><gsx:dutch>Email Verbinden</gsx:dutch><gsx:korean>이메일로 접속</gsx:korean><gsx:japanese>電子メールアカウントに接続</gsx:japanese></entry></feed>