Add collation from ICU4X

.github/workflows/health.yaml

@@ -3,10 +3,17 @@ on:
   pull_request:
     branches: [ main ]
     types: [opened, synchronize, reopened, labeled, unlabeled]
+
 jobs:
   health:
     uses: dart-lang/ecosystem/.github/workflows/health.yaml@main
     with:
       coverage_web: true
+      checkout_submodules: true
+      experiments: native-assets
+      sdk: dev
+      ignore_license: "**.g.dart,pkgs/intl_translation/example/lib/generated/**,pkgs/intl_translation/test/generate_localized/**,pkgs/intl_translation/test/two_components/**"
+      ignore_coverage: "**.g.dart"
+      ignore_packages: "submodules"
     permissions:
       pull-requests: write

.github/workflows/intl4x.yml

@@ -18,30 +18,37 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+
+    env:
+      ICU4X_BUILD_MODE: fetch
+
     defaults:
       run:
         working-directory: pkgs/intl4x
     strategy:
       matrix:
         sdk: [stable, dev] # {pkgs.versions}
         include:
-          - sdk: stable
+          - sdk: dev
             run-tests: true
     steps:
       - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9
+        with:
+          submodules: true
+
       - uses: dart-lang/setup-dart@b64355ae6ca0b5d484f0106a033dd1388965d06d
         with:
           sdk: ${{matrix.sdk}}
 
-      - run: dart pub get
+      - run: dart --enable-experiment=native-assets pub get
 
-      - run: dart analyze --fatal-infos
+      - run: dart --enable-experiment=native-assets analyze --fatal-infos
 
-      - run: dart format --output=none --set-exit-if-changed .
+      - run: dart --enable-experiment=native-assets format --output=none --set-exit-if-changed .
         if: ${{matrix.run-tests}}
 
-      - run: dart test
+      - run: dart --enable-experiment=native-assets test
         if: ${{matrix.run-tests}}
 
-      - run: dart test -p chrome
+      - run: dart --enable-experiment=native-assets test -p chrome
         if: ${{matrix.run-tests}}

.github/workflows/publish.yaml

@@ -14,3 +14,4 @@ jobs:
     uses: dart-lang/ecosystem/.github/workflows/publish.yaml@main
     with:
       write-comments: false
+      checkout_submodules: true

.gitignore

@@ -15,4 +15,4 @@
 
 # Specific files
 pkgs/intl/test/number_format_compact_google3_icu_test.dart
-pkgs/intl/update_from_cldr_data.sh
+pkgs/intl/update_from_cldr_data.sh

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "submodules/icu4x"]
+	path = submodules/icu4x
+	url = https://github.com/unicode-org/icu4x.git

analysis_options.yaml

@@ -0,0 +1,3 @@
+analyzer:
+  exclude:
+    - "submodules/*"

pkgs/intl4x/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.8.0
+
+- Add ICU4X support for collation.
+
 ## 0.7.1
 
 - Export plural rules.

pkgs/intl4x/analysis_options.yaml

@@ -7,3 +7,8 @@ linter:
     - prefer_final_locals
     - prefer_relative_imports
     - unnecessary_parenthesis
+
+analyzer:
+  exclude:
+    - "submodules/*"
+    - "lib/src/bindings/*"

pkgs/intl4x/build.dart

@@ -0,0 +1,155 @@
+// Copyright (c) 2024, 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 'dart:io';
+
+import 'package:archive/archive_io.dart';
+import 'package:native_assets_cli/native_assets_cli.dart';
+import 'package:path/path.dart' as path;
+
+const crateName = 'icu_capi';
+const release = true;
+const assetId = 'package:intl4x/src/bindings/lib.g.dart';
+
+void main(List<String> args) async {
+  final config = await BuildConfig.fromArgs(args);
+
+  final libFolder = path.join(config.outDir.path, folder);
+  final libPath = path.join(
+    libFolder,
+    'lib${crateName.replaceAll("-", "_")}.$dynamicLibraryExtension',
+  );
+
+  final buildMode = switch (Platform.environment['ICU4X_BUILD_MODE']) {
+    'local' => LocalMode(libPath),
+    'checkout' => CheckoutMode(config.outDir.path),
+    'fetch' || null => FetchMode(libPath),
+    String() => throw ArgumentError('''
+
+
+Unknown build mode for icu4x. Set the `ICU4X_BUILD_MODE` environment variable with either `fetch`, `local`, or `checkout`.
+* fetch: Fetch the precompiled binary from a CDN.
+* local: Use a locally existing binary at the environment variable `LOCAL_ICU4X_BINARY`.
+* checkout: Build a fresh library from a local git checkout of the icu4x repository at the environment variable `LOCAL_ICU4X_CHECKOUT`.
+
+'''),
+  };
+
+  await buildMode.build();
+
+  await BuildOutput(
+    assets: [
+      Asset(
+        id: assetId,
+        linkMode: LinkMode.dynamic,
+        target: Target.current,
+        path: AssetAbsolutePath(Uri.file(libPath)),
+      )
+    ],
+    dependencies: Dependencies([Uri.file('build.dart')]),
+  ).writeToFile(outDir: config.outDir);
+}
+
+String get folder => release ? 'release' : 'debug';
+
+String get dynamicLibraryExtension {
+  if (Platform.isMacOS) {
+    return 'dylib';
+  } else if (Platform.isWindows) {
+    return 'dll';
+  } else {
+    return 'so';
+  }
+}
+
+String get platformName {
+  if (Platform.isMacOS) {
+    return 'macos';
+  } else if (Platform.isWindows) {
+    return 'windows';
+  } else {
+    return 'ubuntu';
+  }
+}
+
+void unzipFirstFile({required File input, required File output}) {
+  final inputStream = InputFileStream(input.path);
+  final archive = ZipDecoder().decodeBuffer(inputStream);
+  final file = archive.files.firstOrNull;
+  // If it's a file and not a directory
+  if (file?.isFile ?? false) {
+    final outputStream = OutputFileStream(output.path);
+    file!.writeContent(outputStream);
+    outputStream.close();
+  }
+}
+
+sealed class BuildMode {
+  Future<void> build();
+}
+
+final class FetchMode implements BuildMode {
+  final String libPath;
+
+  FetchMode(this.libPath);
+
+  @override
+  Future<void> build() async {
+    // TODO: Get a nicer CDN than a generated link to a privately owned repo.
+    final request = await HttpClient().getUrl(Uri.parse(
+        'https://nightly.link/mosuem/i18n/workflows/intl4x_artifacts/main/lib-$platformName-latest.zip'));
+    final response = await request.close();
+
+    final zippedDynamicLibrary =
+        File(path.join(Directory.systemTemp.path, 'tmp.zip'));
+    zippedDynamicLibrary.createSync();
+    await response.pipe(zippedDynamicLibrary.openWrite());
+
+    final dynamicLibrary = File(libPath);
+    dynamicLibrary.createSync(recursive: true);
+    unzipFirstFile(input: zippedDynamicLibrary, output: dynamicLibrary);
+  }
+}
+
+final class LocalMode implements BuildMode {
+  final String libPath;
+
+  LocalMode(this.libPath);
+
+  String get _localBinaryPath => Platform.environment['LOCAL_ICU4X_BINARY']!;
+
+  @override
+  Future<void> build() async {
+    await File(_localBinaryPath).copy(libPath);
+  }
+}
+
+final class CheckoutMode implements BuildMode {
+  final String outDirPath;
+  CheckoutMode(this.outDirPath);
+
+  @override
+  Future<void> build() async {
+    final arguments = [
+      'rustc',
+      '-p',
+      crateName,
+      '--crate-type=cdylib',
+      if (release) '--release',
+      ...['--target-dir', outDirPath],
+    ];
+    final processResult = await Process.run(
+      'cargo',
+      arguments,
+      workingDirectory: Platform.environment['LOCAL_ICU4X_CHECKOUT']!,
+    );
+    if (processResult.exitCode != 0) {
+      throw ProcessException(
+        'cargo',
+        arguments,
+        processResult.stderr.toString(),
+      );
+    }
+  }
+}

pkgs/intl4x/lib/intl4x.dart

@@ -30,7 +30,7 @@ typedef Icu4xKey = String;
 
 /// The main class for all i18n calls, containing references to other
 /// functions such as
-/// * [NumberFormatBuilder]
+/// * [numberFormat]
 ///
 /// The functionalities are called through getters on an `Intl` instance, i.e.
 /// ```dart
@@ -42,45 +42,43 @@ typedef Icu4xKey = String;
 /// ```
 class Intl {
   final EcmaPolicy ecmaPolicy;
-
-  // ignore: unused_field, prefer_final_fields
-  String _dyliblocation = 'path.dll'; //What about path.wasm? How to load this?
-  // ignore: unused_field, prefer_final_fields
-  String _datalocation = 'data.blob'; //What about additional data?
-
+  final Data data;
   final List<Locale> supportedLocales;
   final LocaleMatcher localeMatcher;
 
   Collation collation([CollationOptions options = const CollationOptions()]) =>
       Collation(
-        options,
-        CollationImpl.build(locale, localeMatcher, ecmaPolicy),
+        CollationImpl.build(locale, data, options, localeMatcher, ecmaPolicy),
       );
 
   NumberFormat numberFormat([NumberFormatOptions? options]) => NumberFormat(
-        options ?? NumberFormatOptions.custom(),
-        NumberFormatImpl.build(locale, localeMatcher, ecmaPolicy),
+        NumberFormatImpl.build(locale, data,
+            options ?? NumberFormatOptions.custom(), localeMatcher, ecmaPolicy),
       );
 
-  ListFormat listFormat([ListFormatOptions? options]) => ListFormat(
-        options ?? const ListFormatOptions(),
-        ListFormatImpl.build(locale, localeMatcher, ecmaPolicy),
+  ListFormat listFormat(
+          [ListFormatOptions options = const ListFormatOptions()]) =>
+      ListFormat(
+        ListFormatImpl.build(locale, data, options, localeMatcher, ecmaPolicy),
       );
 
-  DisplayNames displayNames([DisplayNamesOptions? options]) => DisplayNames(
-        options ?? const DisplayNamesOptions(),
-        DisplayNamesImpl.build(locale, localeMatcher, ecmaPolicy),
+  DisplayNames displayNames(
+          [DisplayNamesOptions options = const DisplayNamesOptions()]) =>
+      DisplayNames(
+        DisplayNamesImpl.build(
+            locale, data, options, localeMatcher, ecmaPolicy),
       );
 
-  DateTimeFormat datetimeFormat([DateTimeFormatOptions? options]) =>
+  DateTimeFormat datetimeFormat(
+          [DateTimeFormatOptions options = const DateTimeFormatOptions()]) =>
       DateTimeFormat(
-        options ?? const DateTimeFormatOptions(),
-        DateTimeFormatImpl.build(locale, localeMatcher, ecmaPolicy),
+        DateTimeFormatImpl.build(
+            locale, data, options, localeMatcher, ecmaPolicy),
       );
 
   PluralRules plural([PluralRulesOptions? options]) => PluralRules(
-        options ?? PluralRulesOptions(),
-        PluralRulesImpl.build(locale, localeMatcher, ecmaPolicy),
+        PluralRulesImpl.build(locale, data, options ?? PluralRulesOptions(),
+            localeMatcher, ecmaPolicy),
       );
 
   /// Construct an [Intl] instance providing the current [locale] and the
@@ -91,6 +89,7 @@ class Intl {
     this.ecmaPolicy = defaultPolicy,
     this.supportedLocales = allLocales,
     this.localeMatcher = LocaleMatcher.lookup,
+    this.data = const NoData(),
   }) : locale = locale ?? findSystemLocale();
 
   Intl.includeLocales({
@@ -121,10 +120,12 @@ class Intl {
     Locale? locale,
     EcmaPolicy ecmaPolicy = defaultPolicy,
     LocaleMatcher localeMatcher = LocaleMatcher.lookup,
+    Data data = const BundleData(),
   }) : this._(
           locale: locale,
           ecmaPolicy: ecmaPolicy,
           supportedLocales: allLocales,
+          data: data,
         );
 
   Locale locale;
@@ -136,23 +137,3 @@ class Intl {
     return shouldUse && canUse;
   }
 }
-
-/// ICU4X will be compiled into the application, so there is no need to
-/// specify any data here. Users may want to add additional data at runtime,
-/// which could be supported through this API.
-///
-/// TODO: Wire this through to the ICU4X formatters.
-final Map<String, List<Icu4xKey>> additionalICU4XData = {};
-
-void addIcu4XData(Data data) {
-  final callbackFromICUTellingMeWhatLocalesTheDataContained =
-      extractKeysFromData();
-  additionalICU4XData
-      .addAll(callbackFromICUTellingMeWhatLocalesTheDataContained);
-  throw UnimplementedError('Call to ICU4X here');
-}
-
-Map<String, List<Icu4xKey>> extractKeysFromData() {
-  //TODO: Add implementation
-  return {};
-}

pkgs/intl4x/lib/src/bindings/AnyCalendarKind.g.dart

@@ -0,0 +1 @@
+../../../../../submodules/icu4x/ffi/capi/bindings/dart/AnyCalendarKind.g.dart

pkgs/intl4x/lib/src/bindings/Bcp47ToIanaMapper.g.dart

@@ -0,0 +1 @@
+../../../../../submodules/icu4x/ffi/capi/bindings/dart/Bcp47ToIanaMapper.g.dart

pkgs/intl4x/lib/src/bindings/Bidi.g.dart

@@ -0,0 +1 @@
+../../../../../submodules/icu4x/ffi/capi/bindings/dart/Bidi.g.dart

pkgs/intl4x/lib/src/bindings/BidiDirection.g.dart

@@ -0,0 +1 @@
+../../../../../submodules/icu4x/ffi/capi/bindings/dart/BidiDirection.g.dart

pkgs/intl4x/lib/src/bindings/BidiInfo.g.dart

@@ -0,0 +1 @@
+../../../../../submodules/icu4x/ffi/capi/bindings/dart/BidiInfo.g.dart

pkgs/intl4x/lib/src/bindings/BidiParagraph.g.dart

@@ -0,0 +1 @@
+../../../../../submodules/icu4x/ffi/capi/bindings/dart/BidiParagraph.g.dart

pkgs/intl4x/lib/src/bindings/Calendar.g.dart

@@ -0,0 +1 @@
+../../../../../submodules/icu4x/ffi/capi/bindings/dart/Calendar.g.dart

pkgs/intl4x/lib/src/bindings/CanonicalCombiningClassMap.g.dart

@@ -0,0 +1 @@
+../../../../../submodules/icu4x/ffi/capi/bindings/dart/CanonicalCombiningClassMap.g.dart