bisu 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 668059c0670a554d5a7ab95f88ab90133a0d367eaa7e08bba2c2c5a9d5ed36cb
-  data.tar.gz: fb276b9ef26e4941fb3264a366fbe9cc8404d0c296441afe5b294df652444e6d
+  metadata.gz: 899c9d0280deaab7991aa96efb8826d43e257e065c0330cbfe1d09a4fa0958a9
+  data.tar.gz: c81b5482f9d18af6b208f6bb3b57555063a7f1089fb3c926e53746c1d40f944a
 SHA512:
-  metadata.gz: 2250bd0fd198197e78a399be3c519c97ef0700564932feb4de4821573cf5a886fd056d5992180f9d18691145dbc55a9bbffc4bfc44993d1e9d34643954c2b529
-  data.tar.gz: 81e01705e4a8a3e4144b2d64f11d6f04c60d0a75fc50d05b1781b43cfb15f87351c3dab66092ae0b51507760046677efee7bc67c2f9cd7087823884a802318aa
+  metadata.gz: 868664d115f452bb84ee3e4ac7be0b4da6347e502ca80369a2c358d4cdf5fb244e3be61b04491dc3388c1ac1cd80a61a6b1b9ece50180504283351fc392ec279
+  data.tar.gz: eb74b6d8c230c0d5a584a3af88234b3517b2ae442113ff81e71cfc6ff57058eb16dab631360051f8cc66d9daa28934fcb5d62404c30af0d6cdce06f21f3453f7

data/CHANGELOG.md

@@ -4,7 +4,15 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+## [2.2.0](https://github.com/hole19/bisu/releases/tag/v2.2.0)
 
+#### Fixed
+- Escape double quotes (") on Android localization
+
+## [2.1.0](https://github.com/hole19/bisu/releases/tag/v2.1.0)
+
+#### Fixed
+- Fixes handling of % character on iOS localization
 
 ## [2.0.0](https://github.com/hole19/bisu/releases/tag/v2.0.0)
 Released on 2023/12/07

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bisu (1.10.2)
+    bisu (2.2.0)
       colorize
       rubyzip (>= 2.0.0)
       safe_yaml (>= 1.0.0)

data/README.md

@@ -105,7 +105,7 @@ Setup your configuration file
     file_name: <ONE-SKY-FILE-NAME>
   ```
 
-Create translation templates
+Create translatable file templates
 -----
 
 Create a \*.translatable version for your platform specific localization files:
@@ -114,19 +114,10 @@ Create a \*.translatable version for your platform specific localization files:
 *example: Localizable.strings.translatable*
 
   ```
-  // $specialKComment1$
-  // $specialKComment2$
-
-  // Locale: $specialKLocale$; Language used: $specialKLanguage$
-
-  /***********
-  *  General
-  ************/
-
-  "klGeneral_Delete" = "$kDelete$";
-  "klGeneral_Cancel" = "$kCancel$";
-  "klGeneral_Close"  = "$kClose$";
-  "klRequestName"    = "$kRequestName{user_name: %@}$";
+  "delete" = "$general.delete$";
+  "cancel" = "$general.cancel$";
+  "close" = "$general.close$";
+  "requestName" = "$request.name{user_name: %@}$";
   ```
 
 ##### Android
@@ -135,15 +126,11 @@ Create a \*.translatable version for your platform specific localization files:
   ```
   <?xml version="1.0" encoding="utf-8"?>
 
-  <!-- $specialKComment1$ -->
-  <!-- $specialKComment2$ -->
-  <!-- Locale: $specialKLocale$; Language used: $specialKLanguage$ -->
-
   <resources>
-      <string name="delete">$kDelete$</string>
-      <string name="cancel">$kCancel$</string>
-      <string name="close">$kClose$</string>
-      <string name="request_name">$kRequestName{user_name: %s}$</string>
+      <string name="delete">$general.delete$</string>
+      <string name="cancel">$general.cancel$</string>
+      <string name="close">$general.close$</string>
+      <string name="request_name">$request.name{user_name: %s}$</string>
   </resources>
   ```
 
@@ -153,9 +140,37 @@ Create a \*.translatable version for your platform specific localization files:
   ```
   $specialKLocale$:
     resources:
-      delete: $kDelete$
-      cancel: $kCancel$
-      close: $kClose$
+      delete: $general.delete$
+      cancel: $general.cancel$
+      close: $general.close$
     messages:
-      request_name: $kRequestName$
+      request_name: $request.name$
   ```
+
+### Translatable options
+
+#### Parameters
+
+Given a key with params such as "Missing ${attribute} value"
+- `$some-key-with-params{param: %s}$`: `Missing $s value`
+- `$some-key-with-params//ignore-params$`: `Missing ${attribute} value`
+
+#### Formated strings (special characters)
+
+##### "%" character (iOS only)
+
+When it should be localized as given such as "Perfect: 100 (%)"
+- `$some-key-with-percentage$`: `Perfect: 100%`
+
+When it should be localized as a formated string such as "Perfect: %{percentage} (%)"
+- `$some-key-with-percentage{percentage: %d}//formatted-string$`: `Perfect: %d (%%)` (note the double `%`)
+
+#### Locale (useful for Rails localization files)
+
+- `$specialKLocale$`: the respective locale of this file
+- `$specialKLanguage$`: the respective language on the translation platform
+
+#### Special comments
+
+- `$specialKComment1$`: `This file was automatically generated based on a translation template.`
+- `$specialKComment2$`: `Remember to CHANGE THE TEMPLATE and not this file!`

data/lib/bisu/localizer.rb

@@ -19,7 +19,7 @@ module Bisu
 
       to_localize(t).map do |l|
         if localized = localize_key(l[:key], [language] + fallback_languages)
-          localized = process(localized)
+          localized = process(localized, l[:is_formatted_string])
 
           l[:params].each do |param, value|
             if localized.match("%{#{param}}")
@@ -33,8 +33,8 @@ module Bisu
             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}") }
+          unless @type.eql?(:ror) || l[:ignore_params] == true
+            localized.scan(/%{[^}]+}/) { |match| Logger.error("Could not find translation param for #{match} for #{l[:key]} in #{language}") }
           end
         else
           Logger.warn("Could not find translation for #{l[:match]} in #{language}")
@@ -57,7 +57,7 @@ module Bisu
     private
 
     def to_localize(text)
-      all_matches = text.to_enum(:scan, /\$([^\$\{\/]+)(?:\{(.+)\})?(\/\/ignore-params)?\$/).map { Regexp.last_match }
+      all_matches = text.to_enum(:scan, /\$([^\$\{\/]+)(?:\{(.+)\})?(\/\/[A-Za-z-]+)*\$/).map { Regexp.last_match }
       all_matches.map do |match|
         params = if match[2]
           params = match[2].split(",").map(&:strip).map do |param|
@@ -71,16 +71,18 @@ module Bisu
           match:  match[0],
           key:    match[1],
           params: params || {},
-          ignore_param_warn: text.include?("//ignore-params")
+          ignore_params: text.include?("//ignore-params"),
+          is_formatted_string: text.include?("//formatted-string"),
         }
       end
     end
 
-    def process(text)
+    def process(text, is_formatted_string)
       text = text.gsub("\n", "\\n")
 
       if @type.eql?(:android)
         text = text.gsub(/[']/, "\\\\\\\\'")
+        text = text.gsub(/\"/, "\\\\\"")
         text = text.gsub("...", "…")
         text = text.gsub("& ", "& ")
         text = text.gsub("@", "\\\\@")
@@ -88,7 +90,7 @@ module Bisu
 
       elsif @type.eql?(:ios)
         text = text.gsub(/\"/, "\\\\\"")
-        text = text.gsub(/%(?!{)/, "%%")
+        text = text.gsub(/%(?!{)/, "%%") if is_formatted_string
       end
 
       text

data/lib/bisu/version.rb

@@ -1,4 +1,4 @@
 module Bisu
-  VERSION = '2.0.0'
-  VERSION_UPDATED_AT = '2023-12-07'
+  VERSION = '2.2.0'
+  VERSION_UPDATED_AT = '2024-02-23'
 end

data/spec/lib/bisu/localizer_spec.rb

@@ -66,10 +66,11 @@ describe Bisu::Localizer do
 
     it { translates("$kDoubleQuoted$", to: expected[:double_quoted]) }
     it { translates("$kSingleQuoted$", to: expected[:single_quoted]) }
-    it { translates("$kEllipsis$",     to: expected[:ellipsis]) }
-    it { translates("$kAmpersand$",    to: expected[:ampersand]) }
-    it { translates("$kAtSign$",       to: expected[:at_sign]) }
-    it { translates("$kPercentage$",   to: expected[:percentage]) }
+    it { translates("$kEllipsis$", to: expected[:ellipsis]) }
+    it { translates("$kAmpersand$", to: expected[:ampersand]) }
+    it { translates("$kAtSign$", to: expected[:at_sign]) }
+    it { translates("$kPercentage$", to: expected[:percentage]) }
+    it { translates("$kPercentage//formatted-string$", to: expected[:percentage_formatted]) }
 
     # error handling
 
@@ -130,10 +131,11 @@ describe Bisu::Localizer do
   let(:type_dependent_defaults) { {
     double_quoted: keys[language]["kDoubleQuoted"],
     single_quoted: keys[language]["kSingleQuoted"],
-    ellipsis:      keys[language]["kEllipsis"],
-    ampersand:     keys[language]["kAmpersand"],
-    at_sign:       keys[language]["kAtSign"],
-    percentage:    keys[language]["kPercentage"]
+    ellipsis: keys[language]["kEllipsis"],
+    ampersand: keys[language]["kAmpersand"],
+    at_sign: keys[language]["kAtSign"],
+    percentage: keys[language]["kPercentage"],
+    percentage_formatted: keys[language]["kPercentage"],
   } }
 
   describe "of type iOS" do
@@ -141,7 +143,8 @@ describe Bisu::Localizer do
 
     let(:expected) { type_dependent_defaults.merge(
       double_quoted: "Não sabes nada \\\"João das Neves\\\"",
-      percentage: "Sabes 0%% João das Neves."
+      percentage: "Sabes 0% João das Neves.",
+      percentage_formatted: "Sabes 0%% João das Neves.",
     ) }
 
     it_behaves_like "a localizer"
@@ -179,10 +182,12 @@ describe Bisu::Localizer do
 
     let(:expected) { type_dependent_defaults.merge(
       single_quoted: "Não sabes nada \\'João das Neves\\'",
+      double_quoted: "Não sabes nada \\\"João das Neves\\\"",
       ellipsis: "Não sabes nada João das Neves…",
       ampersand: "Não sabes nada João das Neves & Pícaros",
       at_sign: "\\@johnsnow sabes alguma coisa?",
-      percentage: "Sabes 0\\%% João das Neves."
+      percentage: "Sabes 0\\%% João das Neves.",
+      percentage_formatted: "Sabes 0\\%% João das Neves.",
     ) }
 
     it_behaves_like "a localizer"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bisu
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - joaoffcosta
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-07 00:00:00.000000000 Z
+date: 2024-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml