fix: should not escape strings when parsed via the "Translation Overr…

…ides" feature

slang/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.26.2
+
+- fix: should not escape strings when parsed via the "Translation Overrides" feature (#177)
+
 ## 3.26.1
 
 - fix: generate correct compatibility typedef for `Translations` class (#176)

slang/lib/api/singleton.dart

@@ -163,6 +163,7 @@ extension AppLocaleUtilsExt<E extends BaseAppLocale<E, T>,
       buildConfig: buildConfig!,
       map: digestedMap,
       handleLinks: false,
+      shouldEscapeText: false,
       localeDebug: locale.languageTag,
     );
 

slang/lib/builder/builder/translation_model_builder.dart

@@ -29,12 +29,19 @@ class TranslationModelBuilder {
   /// The map must be of type Map<String, dynamic> and all children may of type
   /// String, num, List<dynamic> or Map<String, dynamic>.
   ///
-  /// [handleLinks] can be set false to ignore links at leave them as is
+  /// [handleLinks] can be set false to ignore links and leave them as is
   /// e.g. ${_root.greet(name: name} will be ${_root.greet}
+  /// This is used for "Translation Overrides" where the links are resolved
+  /// on invocation.
+  ///
+  /// [shouldEscapeText] can be set false to ignore escaping of text nodes
+  /// e.g. "Let's go" will be "Let's go" instead of "Let\'s go".
+  /// Similar to [handleLinks], this is used for "Translation Overrides".
   static BuildModelResult build({
     required BuildModelConfig buildConfig,
     required Map<String, dynamic> map,
     bool handleLinks = true,
+    bool shouldEscapeText = true,
     required String localeDebug,
   }) {
     // flat map for leaves (TextNode, PluralNode, ContextNode)
@@ -59,6 +66,7 @@ class TranslationModelBuilder {
       keyCase: buildConfig.keyCase,
       leavesMap: leavesMap,
       contextCollection: contextCollection,
+      shouldEscapeText: shouldEscapeText,
     );
 
     // 2nd iteration: Handle parameterized linked translations
@@ -199,6 +207,7 @@ Map<String, Node> _parseMapNode({
   required CaseStyle? keyCase,
   required Map<String, LeafNode> leavesMap,
   required Map<String, ContextType> contextCollection,
+  required bool shouldEscapeText,
 }) {
   final Map<String, Node> resultNodeTree = {};
 
@@ -228,6 +237,7 @@ Map<String, Node> _parseMapNode({
               modifiers: modifiers,
               raw: value.toString(),
               comment: comment,
+              shouldEscape: shouldEscapeText,
               interpolation: config.stringInterpolation,
               paramCase: config.paramCase,
             )
@@ -237,6 +247,7 @@ Map<String, Node> _parseMapNode({
               modifiers: modifiers,
               raw: value.toString(),
               comment: comment,
+              shouldEscape: shouldEscapeText,
               interpolation: config.stringInterpolation,
               paramCase: config.paramCase,
             );
@@ -260,6 +271,7 @@ Map<String, Node> _parseMapNode({
           keyCase: config.keyCase,
           leavesMap: leavesMap,
           contextCollection: contextCollection,
+          shouldEscapeText: shouldEscapeText,
         );
 
         // finally only take their values, ignoring keys
@@ -287,6 +299,7 @@ Map<String, Node> _parseMapNode({
               : config.keyCase,
           leavesMap: leavesMap,
           contextCollection: contextCollection,
+          shouldEscapeText: shouldEscapeText,
         );
 
         final Node finalNode;
@@ -338,6 +351,7 @@ Map<String, Node> _parseMapNode({
               keyCase: config.keyCase,
               leavesMap: leavesMap,
               contextCollection: contextCollection,
+              shouldEscapeText: shouldEscapeText,
             ).cast<String, RichTextNode>();
           }
 

slang/lib/builder/builder/translation_model_list_builder.dart

@@ -11,7 +11,9 @@ class TranslationModelListBuilder {
   /// After this method call, information about the namespace is lost.
   /// It will be just a normal parent.
   static List<I18nData> build(
-      RawConfig rawConfig, TranslationMap translationMap) {
+    RawConfig rawConfig,
+    TranslationMap translationMap,
+  ) {
     final buildConfig = rawConfig.toBuildModelConfig();
 
     return translationMap.getInternalMap().entries.map((localeEntry) {

slang/lib/builder/model/node.dart

@@ -229,6 +229,7 @@ abstract class TextNode extends Node implements LeafNode {
 
   /// Several configs, persisted into node to make it easier to copy
   /// See [updateWithLinkParams]
+  final bool shouldEscape;
   final StringInterpolation interpolation;
   final CaseStyle? paramCase;
 
@@ -238,6 +239,7 @@ abstract class TextNode extends Node implements LeafNode {
     required super.modifiers,
     required super.comment,
     required this.raw,
+    required this.shouldEscape,
     required this.interpolation,
     required this.paramCase,
   });
@@ -278,12 +280,13 @@ class StringTextNode extends TextNode {
     required super.modifiers,
     required super.raw,
     required super.comment,
+    required super.shouldEscape,
     required super.interpolation,
     required super.paramCase,
     Map<String, Set<String>>? linkParamMap,
   }) {
     final parsedResult = _parseInterpolation(
-      raw: _escapeContent(raw, interpolation),
+      raw: shouldEscape ? _escapeContent(raw, interpolation) : raw,
       interpolation: interpolation,
       paramCase: paramCase,
     );
@@ -317,6 +320,7 @@ class StringTextNode extends TextNode {
       modifiers: modifiers,
       raw: raw,
       comment: comment,
+      shouldEscape: shouldEscape,
       interpolation: interpolation,
       paramCase: paramCase,
       linkParamMap: linkParamMap,
@@ -361,12 +365,13 @@ class RichTextNode extends TextNode {
     required super.modifiers,
     required super.raw,
     required super.comment,
+    required super.shouldEscape,
     required super.interpolation,
     required super.paramCase,
     Map<String, Set<String>>? linkParamMap,
   }) {
     final rawParsedResult = _parseInterpolation(
-      raw: _escapeContent(raw, interpolation),
+      raw: shouldEscape ? _escapeContent(raw, interpolation) : raw,
       interpolation: interpolation,
       paramCase: null, // param case will be applied later
     );
@@ -437,6 +442,7 @@ class RichTextNode extends TextNode {
       modifiers: modifiers,
       raw: raw,
       comment: comment,
+      shouldEscape: shouldEscape,
       interpolation: interpolation,
       paramCase: paramCase,
       linkParamMap: linkParamMap,

slang/lib/builder/utils/string_interpolation_extensions.dart

@@ -13,28 +13,38 @@ extension StringInterpolationExtensions on String {
       int startCharacterLength = 1;
       int startIndex = curr.indexOf(_DOLLAR);
       if (startIndex == -1) {
+        // no more matches
         buffer.write(curr);
         break;
       }
+
+      // Check if the $ is escaped with a preceding \
       if (startIndex >= 1 && curr[startIndex - 1] == '\\') {
-        // ignore because of preceding \
         buffer.write(curr.substring(0, startIndex)); // *do* include \
         buffer.write(_DOLLAR);
         if (startIndex + 1 < curr.length) {
-          curr = curr.substring(startIndex + startCharacterLength);
+          curr = curr.substring(startIndex + 1);
           continue;
         } else {
           break;
         }
       }
 
       if (startIndex != 0) {
-        // add prefix
+        // Add everything before the $ to the buffer
         buffer.write(curr.substring(0, startIndex));
       }
 
-      if (startIndex + 1 < curr.length && curr[startIndex + 1] == '{') {
-        startCharacterLength = 2; // it is now "${"
+      if (startIndex + 1 < curr.length) {
+        final nextCharacter = curr[startIndex + 1];
+        if (nextCharacter == '{') {
+          startCharacterLength = 2; // it is now "${"
+        } else if (nextCharacter.contains(_nonWordRegex)) {
+          // $ stands alone
+          buffer.write(_DOLLAR);
+          curr = curr.substring(startIndex + 1);
+          continue;
+        }
       }
 
       final endRegex = startCharacterLength == 1 ? _nonWordRegex : '}';

slang/test/unit/api/translation_overrides_test.dart

@@ -0,0 +1,70 @@
+import 'package:slang/api/locale.dart';
+import 'package:slang/api/singleton.dart';
+import 'package:slang/api/translation_overrides.dart';
+import 'package:slang/builder/builder/build_model_config_builder.dart';
+import 'package:slang/builder/model/raw_config.dart';
+import 'package:test/test.dart';
+
+void main() {
+  group('string', () {
+    test('Should return a plain string', () {
+      final meta = _buildMetaWithOverrides({
+        'aboutPage.title': 'About',
+      });
+      final parsed = TranslationOverrides.string(meta, 'aboutPage.title', {});
+      expect(parsed, 'About');
+    });
+
+    test('Should return a plain string without escaping', () {
+      final meta = _buildMetaWithOverrides({
+        'aboutPage.title': 'About \' \$ {arg}',
+      });
+      final parsed = TranslationOverrides.string(meta, 'aboutPage.title', {});
+      expect(parsed, 'About \' \$ {arg}');
+    });
+
+    test('Should return an interpolated string', () {
+      final meta = _buildMetaWithOverrides({
+        'aboutPage.title': r"About ${arg}",
+      });
+      final parsed = TranslationOverrides.string(meta, 'aboutPage.title', {
+        'arg': 'Page',
+      });
+      expect(parsed, 'About Page');
+    });
+
+    test('Should return an interpolated string with dollar only', () {
+      final meta = _buildMetaWithOverrides({
+        'aboutPage.title': r"About $arg",
+      });
+      final parsed = TranslationOverrides.string(meta, 'aboutPage.title', {
+        'arg': 'Page',
+      });
+      expect(parsed, 'About Page');
+    });
+  });
+}
+
+TranslationMetadata<FakeAppLocale, FakeTranslations> _buildMetaWithOverrides(
+  Map<String, dynamic> overrides,
+) {
+  final utils = _Utils();
+  return utils
+      .buildWithOverridesFromMap(
+        locale: FakeAppLocale(languageCode: 'und'),
+        isFlatMap: false,
+        map: overrides,
+      )
+      .$meta;
+}
+
+class _Utils extends BaseAppLocaleUtils<FakeAppLocale, FakeTranslations> {
+  _Utils()
+      : super(
+          baseLocale: FakeAppLocale(languageCode: 'und'),
+          locales: [FakeAppLocale(languageCode: 'und')],
+          buildConfig: _defaultConfig,
+        );
+}
+
+final _defaultConfig = RawConfig.defaultConfig.toBuildModelConfig();

slang/test/unit/utils/string_interpolation_extensions_test.dart

@@ -51,6 +51,11 @@ void main() {
       expect(input.dart(), '} X');
     });
 
+    test('dollar in the middle', () {
+      final input = r'$a $ ';
+      expect(input.dart(), r'X $ ');
+    });
+
     test('ends with dollar', () {
       final input = r'$a $';
       expect(input.dart(), r'X $');

slang/test/util/text_node_builder.dart

@@ -14,6 +14,7 @@ StringTextNode textNode(
     comment: null,
     interpolation: interpolation,
     paramCase: paramCase,
+    shouldEscape: true,
   );
 }
 
@@ -30,5 +31,6 @@ RichTextNode richTextNode(
     raw: raw,
     interpolation: interpolation,
     paramCase: paramCase,
+    shouldEscape: true,
   );
 }