bisu 1.7.3 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f756232e9a77ac32c288ccc91508e366298210b27ed117d538448691ac83df5
-  data.tar.gz: 76e19d872d0f68b1b3ade068f35fdf4036267384af1f9aec787fcd43847ef9a7
+  metadata.gz: 2db1130663e6afdca1e4d1b22d34c5863db2f120cee81c1c802d69999b1c094b
+  data.tar.gz: 6f0cfd04fd34bb489055eaa0211aa74691f50f32c5fb13d8b7a1559c68a0f25a
 SHA512:
-  metadata.gz: 82a626c2049aa774803b6faf02ae8909b31bf8273bebdc563f8015d89317edaeeac1560e35422574db39ef9b5eaa451774b77b9ff123f151cd9abbd2e3753110
-  data.tar.gz: e4e40200a30462f873f83228396658888a88a8898171f50e362799ae28cfeaa506292eb8437a6a8aea7cf7b3cc571e763998d90eb82eb6a3066f38b8ad1c86ff
+  metadata.gz: b2d8325f651a93ca9bc2edb7108af31ebc5d1e3d5e954c8a8890a1a7985d2afababe15166ca4d909984a0be453d6f6ad8965eb44b4e1588bd970bc0e3d9669af
+  data.tar.gz: 67699cebd837fc150ae54b433fb3386d79617211ff988b64bca73d681cd8daaeb6202c1e84280d1cfcf39a906c0930272c9f5f237f8d1eb187d856b0494570af

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 All notable changes to this project will be documented in this file.
 `Bisu` adheres to [Semantic Versioning](http://semver.org/).
 
+## [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
 

data/README.md

@@ -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
   ```
 

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
 
@@ -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/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 }
           }
         } }
       }

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|
@@ -44,6 +44,16 @@ module Bisu
       t
     end
 
+    def localize_key(key, ordered_languages)
+      ordered_languages.each do |language|
+        if localized = @dict.localize(language, key)
+          return localized
+        end
+      end
+
+      nil
+    end
+
     private
 
     def to_localize(text)

data/lib/bisu/version.rb

@@ -1,4 +1,4 @@
 module Bisu
-  VERSION = '1.7.3'
-  VERSION_UPDATED_AT = '2020-03-09'
+  VERSION = '1.8.0'
+  VERSION_UPDATED_AT = '2020-04-30'
 end

data/spec/fixtures/sample.translatable.yml

@@ -15,4 +15,5 @@ languages:
   - locale: en
     language: english
   - locale: en-US
-    language: english
+    language: english-us
+    fallback_language: english

data/spec/lib/bisu/config_spec.rb

@@ -22,7 +22,7 @@ describe Bisu::Config do
       { locale: "en-US",      language: "english"    },
       { locale: "pt",         language: "portuguese" },
       { locale: "pt-PT",      language: "portuguese" },
-      { locale: "pt-Batatas", language: "portuguese" }
+      { locale: "pt-Batatas", language: "portuguese-bt", fallback_language: "portuguese" }
     ]
   } }
 
@@ -75,14 +75,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

@@ -19,6 +19,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,8 +33,8 @@ 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)
+    def translates(text, fallbacks: [], to:, lang: nil)
+      translation = localizer.localize(text, lang || language, locale, fallbacks)
       expect(translation).to eq to
     end
 
@@ -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}") }

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.3
+  version: 1.8.0
 platform: ruby
 authors:
 - joaoffcosta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2020-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml