Updates to messages (#762)

* Updates to messages

* Format

* Change carbs name

* Regenerate example

* Rev versions

* Changes as per review

* Remove unused file

pkgs/intl4x/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.7.1
+
+- Export plural rules.
+
 ## 0.7.0
 
 - Add conformance testing workflow.

pkgs/intl4x/lib/intl4x.dart

@@ -24,6 +24,7 @@ import 'src/plural_rules/plural_rules_impl.dart';
 import 'src/plural_rules/plural_rules_options.dart';
 
 export 'src/locale/locale.dart';
+export 'src/plural_rules/plural_rules.dart';
 
 typedef Icu4xKey = String;
 

pkgs/intl4x/pubspec.yaml

@@ -1,7 +1,7 @@
 name: intl4x
 description: >-
   A lightweight modular library for internationalization (i18n) functionality.
-version: 0.7.0
+version: 0.7.1
 repository: https://github.com/dart-lang/i18n/tree/main/pkgs/intl4x
 platforms: ## TODO: Add native platforms once ICU4X is integrated.
   web:

pkgs/messages/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.0
+
+- Remove `IntlObject` interface.
+- Introduce `PluralRules` to retrieve the correct message for plurals.
+
 ## 0.1.1
 
 - Update README.

pkgs/messages/example_json/bin/example.dart

@@ -7,13 +7,10 @@
 import 'dart:io';
 
 import 'package:example_json/testarbctx2.g.dart';
-import 'package:messages/package_intl_object.dart';
 
 Future<void> main(List<String> arguments) async {
-  final messages = AboutPageMessages(
-    (String id) async => File(id).readAsString(),
-    const OldIntlObject(),
-  );
+  final messages =
+      AboutPageMessages((String id) async => File(id).readAsString());
   // final index = AboutPageMessagesEnum.aboutMessage;
 
   await messages.loadLocale('en');

pkgs/messages/example_json/lib/testarb.g.dart

@@ -1,41 +1,37 @@
-// Generated by package:messages_builder
+// Generated by package:messages_builder.
 
+import 'package:intl4x/intl4x.dart';
 import 'package:messages/messages_json.dart';
 
 class HomePageMessages {
-  HomePageMessages(
-    this._fileLoader,
-    this.intlObject,
-  );
+  HomePageMessages(this._fileLoader);
 
   final Future<String> Function(String id) _fileLoader;
 
   String _currentLocale = 'en';
 
   final Map<String, MessageList> _messages = {};
 
-  static const carbs = {
+  static const _dataFiles = {
     'de': ('lib/testarb_de.json', 'hbDN1MhX'),
     'en': ('lib/testarb.json', 'dr9Md951')
   };
 
-  IntlObject intlObject;
-
   String get currentLocale => _currentLocale;
 
   MessageList get _currentMessages => _messages[currentLocale]!;
 
-  static Iterable<String> get knownLocales => carbs.keys;
+  static Iterable<String> get knownLocales => _dataFiles.keys;
 
   Future<void> loadLocale(String locale) async {
     if (!_messages.containsKey(locale)) {
-      final info = carbs[locale];
+      final info = _dataFiles[locale];
       final carb = info?.$1;
       if (carb == null) {
         throw ArgumentError('Locale $locale is not in $knownLocales');
       }
       final data = await _fileLoader(carb);
-      final messageList = MessageListJson.fromString(data, intlObject);
+      final messageList = MessageListJson.fromString(data, pluralSelector);
       if (messageList.preamble.hash != info?.$2) {
         throw ArgumentError('''
               Messages file for locale $locale has different hash "${messageList.preamble.hash}" than generated code "${info?.$2}".''');
@@ -46,11 +42,31 @@ class HomePageMessages {
   }
 
   void loadAllLocales() {
-    for (var locale in knownLocales) {
+    for (final locale in knownLocales) {
       loadLocale(locale);
     }
   }
 
+  Message pluralSelector(
+    num howMany, {
+    required Message other,
+    Message? few,
+    Message? many,
+    Map<int, Message>? numberCases,
+    Map<int, Message>? wordCases,
+  }) {
+    Message getCase(int i) => numberCases?[i] ?? wordCases?[i] ?? other;
+    return switch (
+        Intl(locale: Locale.parse(currentLocale)).plural().select(howMany)) {
+      PluralCategory.zero => getCase(0),
+      PluralCategory.one => getCase(1),
+      PluralCategory.two => getCase(2),
+      PluralCategory.few => few ?? other,
+      PluralCategory.many => many ?? other,
+      PluralCategory.other => other,
+    };
+  }
+
   String helloAndWelcome(
     String firstName,
     String lastName,

pkgs/messages/example_json/lib/testarb.json

@@ -1 +1 @@
-[0,"en","dr9Md951",0,null,["Welcome  von !",[8,0],[13,1]],["Welcome  von !",[8,0],[13,1]],[6,"test ",[3,0,["test  new messages",[5,0]],[2,"No new messages",4,"One new message",5,"Two new Messages"]]],[6,"test ",[4,0,"Two new Messages",{"male":"No new messages","female":"One new message"}]]]
+[0,"en","dr9Md951",0,null,["Welcome  von !",[8,0],[13,1]],["Welcome  von !",[8,0],[13,1]],[6,"test ",[3,0,["test  new messages",[5,0]],[0,"No new messages",1,"One new message","w2","Two new Messages"]]],[6,"test ",[4,0,"Two new Messages",{"male":"No new messages","female":"One new message"}]]]

pkgs/messages/example_json/lib/testarb_de.json

@@ -1 +1 @@
-[0,"de","hbDN1MhX",0,null,["Willkommen  von ",[11,0],[16,1]],["Willkommen  von  2",[11,0],[16,1]],[6,"testde ",[3,0,["test  new messages",[5,0]],[2,"No new messages",4,"One new message",5,"Two new Messages"]]],"testdse is just a simple message"]
+[0,"de","hbDN1MhX",0,null,["Willkommen  von ",[11,0],[16,1]],["Willkommen  von  2",[11,0],[16,1]],[6,"testde ",[3,0,["test  new messages",[5,0]],[0,"No new messages",1,"One new message","w2","Two new Messages"]]],"testdse is just a simple message"]

pkgs/messages/example_json/lib/testarbctx2.g.dart

@@ -1,41 +1,37 @@
-// Generated by package:messages_builder
+// Generated by package:messages_builder.
 
+import 'package:intl4x/intl4x.dart';
 import 'package:messages/messages_json.dart';
 
 class AboutPageMessages {
-  AboutPageMessages(
-    this._fileLoader,
-    this.intlObject,
-  );
+  AboutPageMessages(this._fileLoader);
 
   final Future<String> Function(String id) _fileLoader;
 
   String _currentLocale = 'en';
 
   final Map<String, MessageList> _messages = {};
 
-  static const carbs = {
+  static const _dataFiles = {
     'fr': ('lib/testarbctx2_fr.json', 'EyPjEJJU'),
     'en': ('lib/testarbctx2.json', 'QrwRSsOy')
   };
 
-  IntlObject intlObject;
-
   String get currentLocale => _currentLocale;
 
   MessageList get _currentMessages => _messages[currentLocale]!;
 
-  static Iterable<String> get knownLocales => carbs.keys;
+  static Iterable<String> get knownLocales => _dataFiles.keys;
 
   Future<void> loadLocale(String locale) async {
     if (!_messages.containsKey(locale)) {
-      final info = carbs[locale];
+      final info = _dataFiles[locale];
       final carb = info?.$1;
       if (carb == null) {
         throw ArgumentError('Locale $locale is not in $knownLocales');
       }
       final data = await _fileLoader(carb);
-      final messageList = MessageListJson.fromString(data, intlObject);
+      final messageList = MessageListJson.fromString(data, pluralSelector);
       if (messageList.preamble.hash != info?.$2) {
         throw ArgumentError('''
               Messages file for locale $locale has different hash "${messageList.preamble.hash}" than generated code "${info?.$2}".''');
@@ -46,11 +42,31 @@ class AboutPageMessages {
   }
 
   void loadAllLocales() {
-    for (var locale in knownLocales) {
+    for (final locale in knownLocales) {
       loadLocale(locale);
     }
   }
 
+  Message pluralSelector(
+    num howMany, {
+    required Message other,
+    Message? few,
+    Message? many,
+    Map<int, Message>? numberCases,
+    Map<int, Message>? wordCases,
+  }) {
+    Message getCase(int i) => numberCases?[i] ?? wordCases?[i] ?? other;
+    return switch (
+        Intl(locale: Locale.parse(currentLocale)).plural().select(howMany)) {
+      PluralCategory.zero => getCase(0),
+      PluralCategory.one => getCase(1),
+      PluralCategory.two => getCase(2),
+      PluralCategory.few => few ?? other,
+      PluralCategory.many => many ?? other,
+      PluralCategory.other => other,
+    };
+  }
+
   String aboutMessage(String websitename) =>
       _currentMessages.generateStringAtIndex(0, [websitename]);
 

pkgs/messages/example_json/lib/testarbctx2.json

@@ -1 +1 @@
-[0,"en","QrwRSsOy",0,null,["About ",[6,0]],["Welcome  von  <",[8,0],[13,1]],[6,"test ",[3,0,["test  new messages",[5,0]],[2,"No new messages",4,"One new message",5,"Two new Messages"]]],[6,"test ",[4,0,"Two new Messages",{"male":"No new messages","female":"One new message"}]],"other"]
+[0,"en","QrwRSsOy",0,null,["About ",[6,0]],["Welcome  von  <",[8,0],[13,1]],[6,"test ",[3,0,["test  new messages",[5,0]],[0,"No new messages",1,"One new message","w2","Two new Messages"]]],[6,"test ",[4,0,"Two new Messages",{"male":"No new messages","female":"One new message"}]],"other"]

pkgs/messages/example_json/lib/testarbctx2_fr.json

@@ -1 +1 @@
-[0,"fr","EyPjEJJU",0,null,["Sur ",[4,0]],["Welcome  von  <",[8,0],[13,1]],[6,"test ",[3,0,["test  new messages",[5,0]],[2,"No new messages",4,"One new message",5,"Two new Messages"]]],[6,"test ",[4,0,"Two new Messages",{"male":"No new messages","female":"One new message"}]],"other"]
+[0,"fr","EyPjEJJU",0,null,["Sur ",[4,0]],["Welcome  von  <",[8,0],[13,1]],[6,"test ",[3,0,["test  new messages",[5,0]],[0,"No new messages",1,"One new message","w2","Two new Messages"]]],[6,"test ",[4,0,"Two new Messages",{"male":"No new messages","female":"One new message"}]],"other"]

pkgs/messages/example_json/pubspec.yaml

@@ -6,6 +6,7 @@ environment:
   sdk: ^3.0.0
 
 dependencies:
+  intl4x: ^0.7.0
   messages:
     path: ../
 
@@ -25,3 +26,4 @@ package_options:
     generateMethods: true
     generateFindById: false
     generateFindBy: integer
+    pluralSelector: intl4x

pkgs/messages/example_json/pubspec_overrides.yaml

@@ -3,3 +3,5 @@ dependency_overrides:
     path: ../
   messages_serializer:
     path: ../../messages_serializer
+  intl4x:
+    path: ../../intl4x

pkgs/messages/lib/messages.dart

@@ -3,6 +3,4 @@
 // BSD-style license that can be found in the LICENSE file.
 
 export 'src/deserializer/deserializer.dart';
-export 'src/intl_object.dart' show IntlObject;
-export 'src/intl_style_lookup.dart' show Intl;
 export 'src/message_format.dart';

pkgs/messages/lib/src/deserializer/deserializer.dart

@@ -2,9 +2,9 @@
 // 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 '../intl_object.dart';
 import '../message_format.dart';
+import '../plural_selector.dart';
 
 abstract class Deserializer<T extends MessageList> {
-  T deserialize(IntlObject intl);
+  T deserialize(PluralSelector selector);
 }