Merge pull request #47 from clickcaramel/feat/306-update-translations-if-descr-changed

[Polyglot] Run translation process from scratch for a text when context comment is changed #306

Author: bleshik

README.md

@@ -274,6 +274,21 @@ Just add your translation to the desired localization file. If Polyglot encounte
 
 But please note that if you have [premium](https://polyglot.rocks/#pricing) plan and you added your translation before AI-translation - you won't get our manual translation. If you want to replace your translation with the manual one, just delete the line with it from the localization file. The next time you run Polyglot, it will process this line as usual.
 
+### How I can limit the translation length?
+
+You can use `// polyglot:max_length:<number>` comment before the line. As an argument, specify the maximum length of the translation in characters. For example:
+
+```bash
+// polyglot:max_length:15
+"Saved successfully" = "Saved successfully";
+```
+
+AI will take this into account when translating, but there is no guarantee that it will fulfill the condition. The human will try to translate with the condition in mind. If he does not succeed, he will leave a comment along with the translation option as to why it is not possible. You will see the comment at the end of the translation line:
+
+```bash
+"CUSTOM_STRING" = "Personnalisé"; // translator comment: "Condition is too hard"
+```
+
 We hope this helps! If you have any other questions, please do not hesitate to ask.
 
 ## License

bin/polyglot

@@ -101,6 +101,8 @@ tenant_token="$1"
 
 declare -A translations &>/dev/null;
 declare -A translators_comments &>/dev/null;
+declare -A descriptions &>/dev/null;
+declare -A desired_max_lengths &>/dev/null;
 if [ $? -eq 0 ]; then
     set_translation() {
         translations[`echo $1_$2_$3`]="$4"
@@ -110,13 +112,29 @@ if [ $? -eq 0 ]; then
         fi
     }
 
+    set_description() {
+        descriptions["$1"]="$2"
+    }
+
+    set_desired_max_len() {
+        desired_max_lengths["$1"]="$2"
+    }
+
     get_translation() {
         echo ${translations[`echo $1_$2_$3`]}
     }
 
     get_translator_comment() {
         echo ${translators_comments[`echo $1_$2`]}
     }
+
+    get_description() {
+        echo ${descriptions["$1"]}
+    }
+
+    get_desired_max_len() {
+        echo ${desired_max_lengths["$1"]}
+    }
 else
     warning "Your Bash version does not support associative arrays, indexing will be slow, we recommend updating your Bash to the newer version."
     translation_key() {
@@ -132,6 +150,16 @@ else
         fi
     }
 
+    set_description() {
+        md5key="`calc_md5 \"$1\"`"
+        printf -v "descriptions__${md5key}" %s "$2"
+    }
+
+    set_desired_max_len() {
+        md5key="`calc_md5 \"$1\"`"
+        printf -v "desired_max_lengths__${md5key}" %s "$2"
+    }
+
     get_translation() {
         n="$1_translations__`translation_key \"$2\" \"$3\"`"
         echo ${!n}
@@ -141,6 +169,16 @@ else
         n="translators_comments__`translation_key \"$1\" \"$2\"`"
         echo ${!n}
     }
+
+    get_description() {
+        n="descriptions__`calc_md5 \"$1\"`"
+        echo ${!n}
+    }
+
+    get_desired_max_len() {
+        n="desired_max_lengths__`calc_md5 \"$1\"`"
+        echo ${!n}
+    }
 fi
 
 BASEDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
@@ -198,6 +236,10 @@ escape_for_sed() {
     echo "$1" | sed -e 's/\\/\\\\/g; s/\//\\\//g; s/&/\\\&/g'
 }
 
+restart_translation_info() {
+    echo `info "Seems like $1 is changed for '$2' so we're starting translations from scratch for this string."`
+}
+
 escape_for_grep() {
     sed 's/[][\.|$(){}?+*^]/&/g' <<< "$*"
 }
@@ -208,7 +250,7 @@ escape_line_breaks() {
 
 response_to_js_map() {
     fixed_response=`echo "$1" | sed -e "s/$escaped_quote/$quote_placeholder/g"`
-    echo "$fixed_response" | jq -r 'del(.[].description?) | map( { (.stringId|tostring): .translations } ) | add | del(.[].stringId)'
+    echo "$fixed_response" | jq -r 'map( { (.stringId|tostring): (.translations + {description: .description, desiredMaxLength: .desiredMaxLength}) } ) | add | del(.[].stringId)'
 }
 
 calc_md5() {
@@ -234,10 +276,14 @@ fill_translations_map() {
 
     while read item ; do
         id="`echo $item | jq -r '.key'`"
+        description="`echo $item | jq -r '.value.description? // empty'`"
+        max_len="`echo $item | jq -r '.value.desiredMaxLength? // empty'`"
+        set_description "$id" "$description"
+        set_desired_max_len "$id" $max_len
         while IFS="~" read -r key value comment
         do
             set_translation "$1" "$id" "$key" "$value" "$comment"
-        done < <(escape_line_breaks "$item" | jq -rc '.value|to_entries|map("\(.key)~\(.value.value)~\(.value.translatorComment)") | .[]' | sed -e "s/$quote_placeholder/$escaped_quote/g")
+        done < <(escape_line_breaks "$item" | jq -rc '.value|del(.description, .desiredMaxLength)|to_entries|map("\(.key)~\(.value.value)~\(.value.translatorComment?)") | .[]' | sed -e "s/$quote_placeholder/$escaped_quote/g")
 
     done < <(escape_line_breaks "$data")
 }
@@ -373,7 +419,6 @@ main() {
     [ -f "$prev_translations_file" ] || echo "{}" > "$prev_translations_file"
 
     info "Downloading translations from the server"
-
     api_response=$(curl -H "Accept: application/json" -H "Authorization: Bearer $tenant_token" -L "$api_url/products/$product_id/strings?manual=true" -s)
 
     case `echo $api_response | jq -r '.message?'` in
@@ -514,11 +559,24 @@ main() {
             base_value=`echo "$base_value" | sed -e 's/;[ 	]*\/\/.*/;/' -e 's/\"//' -e 's/\";$/;/'`
             base_value=`echo ${base_value//;}`
             manual_translation=`get_translation 'manual' "$id" "$language"`
-            saved_base_value=`get_translation 'manual' "$id" "en"`
-            if [ -n "$manual_translation" ] && [ "$saved_base_value" != "$base_value" ] ; then
-                info "Seems like English string is changed for '$id' so we're starting translations from scratch for this string."
-                manual_translation=""
+
+            if [ -n "$manual_translation" ]; then
+                saved_base_value=`get_translation 'manual' "$id" "en"`
+                prev_description=`get_description "$id"`
+                prev_desired_max_len=`get_desired_max_len "$id"`
+
+                if [ "$saved_base_value" != "$base_value" ]; then
+                    restart_translation_info 'source string' "$id"
+                    manual_translation=''
+                elif [ "$prev_description" != "$description" ]; then
+                    restart_translation_info 'description' "$id"
+                    manual_translation=''
+                elif [ "$prev_desired_max_len" != "$desired_max_length" ]; then
+                    restart_translation_info 'max-length' "$id"
+                    manual_translation=''
+                fi
             fi
+
             old_record="\"$id\" = "
             escaped_old_record=`escape_for_grep "$old_record"`
             disabled_translation="`(echo $line ; grep \"$escaped_old_record\" $file) | grep "polyglot:disable:this"`"

tests/translate.spec.sh

@@ -203,6 +203,7 @@ test_base_is_not_included() {
 
 test_translate_equal_strings_when_equal_line_count() {
     clear_db "$product_id"
+    echo "$initial_data" > "$translations_path/en.lproj/$file_name"
     # x2 launch for getting manual_translations_changed == false
     output=`$script $tenant_token -p ../$app_name`
     output=`$script $tenant_token -p ../$app_name`
@@ -263,5 +264,32 @@ test_translate_string_with_spec_chars() {
     echo '"with_spec_chars" = "string with\nspecial\n \"chars\", now";' > $path
     output=`$script $tenant_token -p ../$app_name`
     translation=`grep 'with_spec_chars' $translations_path/de.lproj/$file_name | cut -d '=' -f 2`
-    assert_multiple ' "Zeichenkette mit\nspeziellen\n \"Zeichen\", jetzt";' ' "Zeichenkette mit\nspeziellem\n \"Zeichen\", jetzt";' ' "Seil mit\nspeziell\n \"Zeichen\", jetzt";' ' "Seil mit\nspeziellen\n \"Zeichen\", jetzt";' "$translation"
+    assert_multiple ' "Zeichenkette mit\nbesonderen\n \"Zeichen\", jetzt";' ' "Zeichenkette mit\nspeziellen\n \"Zeichen\", jetzt";' ' "Zeichenkette mit\nspeziellem\n \"Zeichen\", jetzt";' ' "Seil mit\nspeziell\n \"Zeichen\", jetzt";' ' "Seil mit\nspeziellen\n \"Zeichen\", jetzt";' "$translation"
+}
+
+test_restart_translation_if_descr_changed() {
+    curl -X PUT -H "Content-Type: application/json" -H "Accept: application/json" -H "Authorization: Bearer $tenant_token" -L "$api_url/products/$product_id/strings/fork" -d "{ \"translations\": { \"en\": \"fork\", \"fr\": \"fourche\", \"de\": \"gabel\" }, \"description\": \"working with the Github repository\" }" -s >> /dev/null
+    path="$translations_path/en.lproj/$file_name";
+    str_with_comment='// cutlery
+"fork" = "fork";'
+    echo "$str_with_comment" > $path
+    output=`$script $tenant_token -p ../$app_name`
+    translation=`grep 'fork' $translations_path/fr.lproj/$file_name | cut -d '=' -f 2`
+    description=`curl -H "Accept: application/json" -H "Authorization: Bearer $tenant_token" -L "$api_url/products/$product_id/strings/fork" -s | jq -r '.description'`
+    assert_equals ' "fourchette";' "$translation"
+    assert_equals 'cutlery' "$description"
+}
+
+test_restart_translation_if_max_len_changed() {
+    str_id='change_max_len_str'
+    curl -X PUT -H "Content-Type: application/json" -H "Accept: application/json" -H "Authorization: Bearer $tenant_token" -L "$api_url/products/$product_id/strings/$str_id" -d "{ \"translations\": { \"en\": \"Not enough memory on your device\", \"fr\": \"Mémoire insuffisante sur votre appareil\", \"de\": \"Nicht genügend Speicher auf Ihrem Gerät\" }, \"desiredMaxLength\": 30 }" -s >> /dev/null
+    path="$translations_path/en.lproj/$file_name";
+    str_with_max_len="// polyglot:max_length:15
+\"$str_id\" = \"Not enough memory on your device\";"
+    echo "$str_with_max_len" > $path
+    output=`$script $tenant_token -p ../$app_name`
+    translation=`grep "$str_id" $translations_path/de.lproj/$file_name | cut -d '=' -f 2`
+    max_len=`curl -H "Accept: application/json" -H "Authorization: Bearer $tenant_token" -L "$api_url/products/$product_id/strings/$str_id" -s | jq -r '.desiredMaxLength'`
+    assert_multiple ' "Nicht genug Speicher.";' ' "Nicht genug Speicher";' ' "Zu wenig Speicher";' "$translation"
+    assert_equals 15 $max_len
 }