fix: Select options in Flutter ARB translation languages not working when using CDN (crowdin#45)

Author: FlutterOd

example/lib/l10n/text_en.arb

@@ -35,5 +35,13 @@
         "format": "compactLong"
       }
     }
+  },
+  "roamingChoice": "{choice, select, month{_For 1 month} unlimited{_Unlimited} deactivate{_Deactivate} other {}}",
+  "@roamingChoice": {
+    "placeholders": {
+      "choice": {
+        "type": "String"
+      }
+    }
   }
 }

lib/src/common/gen_l10n_types.dart

@@ -367,29 +367,27 @@ class Message {
         placeholders = _placeholders(
             templateBundle.resources, resourceId, isResourceAttributeRequired),
         messages = <LocaleInfo, String?>{},
-        parsedMessages = <LocaleInfo, Node?>{},
         _pluralMatch =
-            _pluralRE.firstMatch(_value(templateBundle.resources, resourceId));
-
-  // {
-  //   // Filenames for error handling.
-  //   // final Map<LocaleInfo, String> filenames = <LocaleInfo, String>{};
-  //   // Collect all translations from allBundles and parse them.
-  //   for (final AppResourceBundle bundle in allBundles.bundles) {
-  //     // filenames[bundle.locale] = bundle.file.basename;
-  //     final String? translation = bundle.translationFor(resourceId);
-  //     messages[bundle.locale] = translation;
-  //     parsedMessages[bundle.locale] = translation == null ? null : Parser(
-  //         resourceId,
-  //         bundle.file.basename,
-  //         translation,
-  //         useEscaping: useEscaping,
-  //         // logger: logger
-  //     ).parse();
-  //   }
-  //   // Infer the placeholders
-  //   _inferPlaceholders(filenames);
-  // }
+            _pluralRE.firstMatch(_value(templateBundle.resources, resourceId)),
+        parsedMessages = <LocaleInfo, Node?>{} {
+    // Filenames for error handling.
+    final Map<LocaleInfo, String> filenames = <LocaleInfo, String>{};
+    // Collect all translations from allBundles and parse them.
+    // for (final AppResourceBundle bundle in allBundles.bundles) {
+    // filenames[bundle.locale] = bundle.file.basename;
+    final String? translation = templateBundle.translationFor(resourceId);
+    messages[templateBundle.locale] = translation;
+    parsedMessages[templateBundle.locale] = translation == null
+        ? null
+        : Parser(
+            resourceId,
+            'OTA data',
+            translation,
+            useEscaping: useEscaping,
+          ).parse();
+    // Infer the placeholders
+    _inferPlaceholders(filenames);
+  }
 
   final String resourceId;
   final String value;
@@ -506,6 +504,45 @@ class Message {
       }),
     );
   }
+
+// Using parsed translations, attempt to infer types of placeholders used by plurals and selects.
+// For undeclared placeholders, create a new placeholder.
+  void _inferPlaceholders(Map<LocaleInfo, String> filenames) {
+    // We keep the undeclared placeholders separate so that we can sort them alphabetically afterwards.
+    final Map<String, Placeholder> undeclaredPlaceholders =
+        <String, Placeholder>{};
+    // Helper for getting placeholder by name.
+    Placeholder? getPlaceholder(String name) =>
+        placeholders[name] ?? undeclaredPlaceholders[name];
+    for (final LocaleInfo locale in parsedMessages.keys) {
+      if (parsedMessages[locale] == null) {
+        continue;
+      }
+      final List<Node> traversalStack = <Node>[parsedMessages[locale]!];
+      while (traversalStack.isNotEmpty) {
+        final Node node = traversalStack.removeLast();
+        if (<ST>[
+          ST.placeholderExpr,
+          ST.pluralExpr,
+          ST.selectExpr,
+        ].contains(node.type)) {
+          final String identifier = node.children[1].value!;
+          Placeholder? placeholder = getPlaceholder(identifier);
+          if (placeholder == null) {
+            placeholder =
+                Placeholder(resourceId, identifier, <String, Object?>{});
+            undeclaredPlaceholders[identifier] = placeholder;
+          }
+          if (node.type == ST.pluralExpr) {
+            placeholder.isPlural = true;
+          } else if (node.type == ST.selectExpr) {
+            placeholder.isSelect = true;
+          }
+        }
+        traversalStack.addAll(node.children);
+      }
+    }
+  }
 }
 
 // Represents the contents of one ARB file.

lib/src/crowdin_extractor.dart

@@ -1,7 +1,9 @@
 import 'package:flutter/foundation.dart';
 import 'package:intl/intl.dart' as intl;
+import 'package:crowdin_sdk/src/common/message_parser.dart';
 
 import 'common/gen_l10n_types.dart';
+import 'common/localizations_utils.dart';
 
 ///finds message parameters
 class Extractor {
@@ -49,6 +51,9 @@ class Extractor {
           placeholder: placeholder,
           placeholderValue: value,
         );
+      } else if (placeholder.isSelect) {
+        result = _findSelection(message, locale, value);
+        return result;
       } else {
         result = value.toString();
       }
@@ -57,6 +62,20 @@ class Extractor {
     return buffer;
   }
 
+  String _findSelection(Message message, String locale, String select) {
+    final node =
+        message.parsedMessages[LocaleInfo.fromString(locale)]?.children[0];
+
+    final Node selectParts = node!.children[5];
+    final Node selectedPart = selectParts.children.firstWhere(
+        (element) => element.children[0].value == select,
+        orElse: () => selectParts.children
+            .firstWhere((element) => element.children[0].value == 'other'));
+    final String selectedValue =
+        selectedPart.children[2].children[0].value ?? 'other';
+    return selectedValue;
+  }
+
   String _findNumberPlaceholder({
     required Map<String, dynamic> optionals,
     required Placeholder placeholder,

test/crowdin_extractor_test.dart

@@ -118,4 +118,25 @@ void main() {
       expect(result, "Counter: $counterValue");
     });
   });
+
+  group('CrowdinFormatter select tests', () {
+    Extractor extractor = Extractor();
+    Message message = Message(AppResourceBundle(testArb), 'select_test', false);
+
+    test('should return proper values for selections', () {
+      var result1 = extractor
+          .findPlaceholders('en', message, message.value, {'choice': 'first'});
+      expect(result1, 'First selection');
+
+      var result2 = extractor
+          .findPlaceholders('en', message, message.value, {'choice': 'second'});
+      expect(result2, 'Second selection');
+    });
+
+    test('should return "other" value for not existing selection', () {
+      var result = extractor.findPlaceholders(
+          'en', message, message.value, {'choice': 'not existing choice'});
+      expect(result, 'No selection chosen');
+    });
+  });
 }

test/crowdin_generator_test.dart

@@ -10,8 +10,14 @@ void main() {
   group('findPlaceholders test', () {
     test('should return list of translation keys', () {
       var keys = CrowdinGenerator.getKeys(testArb);
-      expect(
-          keys, ['example', 'hello', 'nThings', 'variable_nThings', 'counter']);
+      expect(keys, [
+        'example',
+        'hello',
+        'nThings',
+        'variable_nThings',
+        'counter',
+        'select_test',
+      ]);
     });
 
     test('should return list of method parameters', () {

test/test_arb.dart

@@ -32,6 +32,13 @@ var testArb = {
     "placeholders": {
       "value": {"type": "int", "format": "compactLong"}
     }
+  },
+  "select_test":
+      "{choice, select, first{First selection} second{Second selection} other{No selection chosen}}",
+  "@select_test": {
+    "placeholders": {
+      "choice": {"type": "String"}
+    }
   }
 };
 
@@ -60,5 +67,5 @@ var testPreviewArb = {
     "placeholders": {
       "value": {"type": "int", "format": "compactLong"}
     }
-  }
+  },
 };