No public description

PiperOrigin-RevId: 781004395

Author: Googler

pkgs/intl_translation/CHANGELOG.md

@@ -1,6 +1,12 @@
+## 0.21.0-wip
+  * BREAKING CHANGE: Update `dart_style` to `^3.0.0`
+  * Allow analyzer `>=6.3.0 <8.0.0`
+  * Throw if the main argument in plurals and selects does not match the argument list.
+  * Fix constant evaluator.
+
 ## 0.20.1
   * Add topics to `pubspec.yaml`
-  * Update to `dart_style `2.3.7`. `bin/make_examples_const.dart` and
+  * Update to `dart_style` `2.3.7`. `bin/make_examples_const.dart` and
     `rewrite_intl_messages.dart` will now look for a surrounding
     `.dart_tool/package_config.json` file to infer the language version of the
     files updated by the script.

pkgs/intl_translation/lib/src/messages/constant_evaluator.dart

@@ -0,0 +1,106 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'package:analyzer/dart/ast/ast.dart';
+
+/// Needed to wrap `null` as a valid constant value
+class Constant<T extends Object?> {
+  final T value;
+
+  Constant(this.value);
+
+  static Constant<T>? nullable<T extends Object>(T? o) =>
+      o == null ? null : Constant(o);
+}
+
+Constant? evaluate(Expression expression) {
+  return switch (expression) {
+    AdjacentStrings() => Constant.nullable(evaluateConstString(expression)),
+    SimpleStringLiteral() => Constant(expression.value),
+    IntegerLiteral() => Constant(expression.value),
+    DoubleLiteral() => Constant(expression.value),
+    BooleanLiteral() => Constant(expression.value),
+    NullLiteral() => Constant(null),
+    SetOrMapLiteral() => evaluateConstStringMap(expression),
+    PrefixExpression() => evaluatePrefixed(expression),
+    ListLiteral() => evaluateListLiteral(expression),
+    _ => null,
+  };
+}
+
+Constant<Iterable<Object?>>? evaluateListLiteral(ListLiteral list) {
+  if (!list.isConst) {
+    return null;
+  }
+  if (list.elements.any(
+    (element) => element is! Expression,
+  )) {
+    return null;
+  }
+  final evaluatedElements = list.elements.whereType<Expression>().map(
+        (element) => evaluate(element)?.value,
+      );
+  if (evaluatedElements.any((element) => element == null)) {
+    return null;
+  }
+  return Constant(evaluatedElements);
+}
+
+Constant<num>? evaluatePrefixed(PrefixExpression expression) {
+  final operator = expression.operator;
+  if (operator.lexeme != '-') {
+    return null;
+  }
+  final constant = evaluate(expression.operand);
+  final numValue = constant?.value;
+  if (numValue is! num) {
+    return null;
+  }
+  return Constant(-1 * numValue);
+}
+
+String? evaluateConstString(Expression expression) => switch (expression) {
+      SimpleStringLiteral() => expression.value,
+      AdjacentStrings() => _checkChildren(expression.strings)?.join(),
+      _ => null,
+    };
+
+Iterable<String>? _checkChildren(Iterable<StringLiteral> strings) {
+  final constExpressions = strings.map(
+    (string) => evaluateConstString(string),
+  );
+  return constExpressions.any(
+    (string) => string == null,
+  )
+      ? null
+      : constExpressions.whereType();
+}
+
+Constant<Map>? evaluateConstStringMap(SetOrMapLiteral map) {
+  if (!map.isConst) {
+    return null;
+  }
+  if (map.elements.any(
+    (element) => element is! MapLiteralEntry,
+  )) {
+    return null;
+  }
+  final evaluatedEntries = map.elements.whereType<MapLiteralEntry>().map(
+        (literalEntry) =>
+            (evaluate(literalEntry.key), evaluate(literalEntry.value)),
+      );
+  if (evaluatedEntries
+      .any((element) => element.$1 == null || element.$2 == null)) {
+    return null;
+  }
+  var extractedValues = evaluatedEntries.map(
+    (literalEntry) => MapEntry(literalEntry.$1!.value, literalEntry.$2!.value),
+  );
+  if (extractedValues.any((element) => element.key is! String)) {
+    return null;
+  }
+  return Constant(Map<String, dynamic>.fromEntries(extractedValues.map(
+    (e) => MapEntry(e.key as String, e.value),
+  )));
+}

pkgs/intl_translation/lib/src/messages/main_message.dart

@@ -33,7 +33,7 @@ class MainMessage extends ComplexMessage {
   /// Verify that this looks like a correct Intl.message invocation.
   static void checkValidity(
     MethodInvocation node,
-    List arguments,
+    List<Expression> arguments,
     String? outerName,
     List<FormalParameter> outerArgs, {
     bool nameAndArgsGenerated = false,

pkgs/intl_translation/lib/src/messages/message.dart

@@ -35,11 +35,10 @@ library intl_message;
 import 'dart:convert';
 
 import 'package:analyzer/dart/ast/ast.dart';
-// ignore: implementation_imports
-import 'package:analyzer/src/dart/ast/constant_evaluator.dart';
 
 import 'complex_message.dart';
 import 'composite_message.dart';
+import 'constant_evaluator.dart';
 import 'literal_string_message.dart';
 import 'message_extraction_exception.dart';
 import 'variable_substitution_message.dart';
@@ -75,26 +74,6 @@ abstract class Message {
   /// The name of the top-level [MainMessage].
   String get name => parent == null ? '<unnamed>' : parent!.name;
 
-  static final _evaluator = ConstantEvaluator();
-
-  static String? _evaluateAsString(expression) {
-    var result = expression.accept(_evaluator);
-    if (result == ConstantEvaluator.NOT_A_CONSTANT || result is! String) {
-      return null;
-    } else {
-      return result;
-    }
-  }
-
-  static Map? _evaluateAsMap(Expression expression) {
-    var result = expression.accept(_evaluator);
-    if (result == ConstantEvaluator.NOT_A_CONSTANT || result is! Map) {
-      return null;
-    } else {
-      return result;
-    }
-  }
-
   /// Verify that the args argument matches the method parameters and
   /// isn't, e.g. passing string names instead of the argument values.
   static bool checkArgs(NamedExpression? args, List<String> parameterNames) {
@@ -141,7 +120,7 @@ abstract class Message {
   /// for messages with parameters.
   static void checkValidity(
     MethodInvocation node,
-    List arguments,
+    List<Expression> arguments,
     String? outerName,
     List<FormalParameter> outerArgs, {
     bool nameAndArgsGenerated = false,
@@ -165,7 +144,7 @@ abstract class Message {
           ' e.g. args: $parameterNames');
     }
 
-    var nameNamedExps = arguments
+    final nameNamedExps = arguments
         .whereType<NamedExpression>()
         .where((arg) => arg.name.label.name == 'name')
         .map((e) => e.expression);
@@ -177,7 +156,7 @@ abstract class Message {
     if (nameNamedExps.isEmpty) {
       if (!hasParameters) {
         // No name supplied, no parameters. Use the message as the name.
-        var name = _evaluateAsString(arguments[0]);
+        var name = evaluateConstString(arguments[0]);
         messageName = name;
         outerName = name;
       } else {
@@ -195,7 +174,7 @@ abstract class Message {
       }
     } else {
       // Name argument is supplied, use it.
-      var name = _evaluateAsString(nameNamedExps.first);
+      var name = evaluateConstString(nameNamedExps.first);
       messageName = name;
       givenName = name;
     }
@@ -227,7 +206,7 @@ abstract class Message {
         .map((each) => each.expression)
         .toList();
     for (var arg in values) {
-      if (_evaluateAsString(arg) == null) {
+      if (evaluateConstString(arg) == null) {
         throw MessageExtractionException(
             'Intl.message arguments must be string literals: $arg');
       }
@@ -245,8 +224,7 @@ abstract class Message {
       if (examples.isNotEmpty) {
         var example = examples.first;
         if (example is SetOrMapLiteral) {
-          var map = _evaluateAsMap(example);
-          if (map == null) {
+          if (evaluateConstStringMap(example) == null) {
             throw MessageExtractionException(
                 'Examples must be a const Map literal.');
           } else if (example.constKeyword == null) {

pkgs/intl_translation/lib/src/messages/submessages/submessage.dart

@@ -95,7 +95,14 @@ abstract class SubMessage extends ComplexMessage {
   List toJson() {
     var json = [];
     json.add(dartMessageName);
-    json.add(arguments.indexOf(mainArgument));
+    var indexOf = arguments.indexOf(mainArgument);
+    if (indexOf == -1) {
+      // This is an error as this should have been checked in
+      // lib/visitors/plural_gender_visitor.dart already.
+      throw ArgumentError('The argument `$mainArgument` could not be found in '
+          '`$arguments`.');
+    }
+    json.add(indexOf);
     for (var arg in codeAttributeNames) {
       json.add(this[arg]?.toJson());
     }

pkgs/intl_translation/lib/visitors/message_finding_visitor.dart

@@ -4,10 +4,9 @@
 
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
-// ignore: implementation_imports
-import 'package:analyzer/src/dart/ast/constant_evaluator.dart';
 
 import '../extract_messages.dart';
+import '../src/messages/constant_evaluator.dart';
 import '../src/messages/main_message.dart';
 import '../src/messages/message.dart';
 import '../src/messages/message_extraction_exception.dart';
@@ -288,10 +287,8 @@ class MessageFindingVisitor extends GeneralizingAstVisitor {
     for (var namedExpr in arguments.whereType<NamedExpression>()) {
       var name = namedExpr.name.label.name;
       var exp = namedExpr.expression;
-      var basicValue = exp.accept(ConstantEvaluator());
-      var value = basicValue == ConstantEvaluator.NOT_A_CONSTANT
-          ? exp.toString()
-          : basicValue;
+      var constant = evaluate(exp);
+      var value = constant == null ? exp.toString() : constant.value;
       setAttribute(message, name, value);
     }
     // We only rewrite messages with parameters, otherwise we use the literal

pkgs/intl_translation/lib/visitors/plural_gender_visitor.dart

@@ -137,6 +137,13 @@ class PluralAndGenderVisitor extends SimpleAstVisitor<void> {
       extraction.warnings.add(errString);
     }
 
+    if (!message.arguments.contains(message.mainArgument)) {
+      throw Exception(
+          'Argument `${message.mainArgument}` could not be found in '
+          '${message.arguments} while processing $node. The parent argument '
+          'name must match the one in the `Intl.` call.');
+    }
+
     return message;
   }
 }

pkgs/intl_translation/pubspec.yaml

@@ -1,5 +1,5 @@
 name: intl_translation
-version: 0.20.1
+version: 0.21.0-wip
 description: >-
   Contains code to deal with internationalized/localized messages,
   date and number formatting and parsing, bi-directional text, and
@@ -15,9 +15,9 @@ environment:
   sdk: ^3.0.0
 
 dependencies:
-  analyzer: ^6.3.0
+  analyzer: ">=6.3.0 <8.0.0"
   args: ^2.0.0
-  dart_style: ^2.0.0
+  dart_style: ^3.0.0
   intl: '>=0.19.0 <0.21.0'
   package_config: ^2.1.0
   path: ^1.0.0