Add collation from ICU4X

pkgs/intl4x/lib/intl4x.dart

@@ -41,45 +41,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
@@ -90,6 +88,7 @@ class Intl {
     this.ecmaPolicy = defaultPolicy,
     this.supportedLocales = allLocales,
     this.localeMatcher = LocaleMatcher.lookup,
+    this.data = const NoData(),
   }) : locale = locale ?? findSystemLocale();
 
   Intl.includeLocales({
@@ -120,10 +119,12 @@ class Intl {
     Locale? locale,
     EcmaPolicy ecmaPolicy = defaultPolicy,
     LocaleMatcher localeMatcher = LocaleMatcher.lookup,
+    Data? data,
   }) : this._(
           locale: locale,
           ecmaPolicy: ecmaPolicy,
           supportedLocales: allLocales,
+          data: data ?? const NoData(),
         );
 
   Locale locale;
@@ -135,23 +136,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/collation/collation.dart

@@ -7,10 +7,9 @@ import 'collation_impl.dart';
 import 'collation_options.dart';
 
 class Collation {
-  final CollationOptions _options;
   final CollationImpl _collationImpl;
 
-  const Collation(this._options, this._collationImpl);
+  const Collation(this._collationImpl);
 
   /// Compare two strings in a locale-dependant manner.
   ///
@@ -25,7 +24,7 @@ class Collation {
     if (isInTest) {
       return a.compareTo(b);
     } else {
-      return _collationImpl.compareImpl(a, b, _options);
+      return _collationImpl.compareImpl(a, b);
     }
   }
 }

pkgs/intl4x/lib/src/collation/collation_4x.dart

@@ -2,17 +2,67 @@
 // 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:icu/icu.dart' as icu;
+
+import '../data.dart';
+import '../data_4x.dart';
 import '../locale/locale.dart';
+import '../locale/locale_4x.dart';
 import 'collation_impl.dart';
 import 'collation_options.dart';
 
-CollationImpl getCollator4X(Locale locale) => Collation4X(locale);
+CollationImpl getCollator4X(
+        Locale locale, Data data, CollationOptions options) =>
+    Collation4X(locale, data, options);
 
 class Collation4X extends CollationImpl {
-  Collation4X(super.locale);
+  final icu.ICU4XCollator _collator;
+
+  Collation4X(Locale locale, Data data, CollationOptions options)
+      : _collator = icu.ICU4XCollator.v1(
+          data.to4X(),
+          locale.to4X(),
+          options.toDartOptions(),
+        ),
+        super(locale, options);
 
   @override
-  int compareImpl(String a, String b, CollationOptions options) {
-    throw UnimplementedError('Insert diplomat bindings here');
+  int compareImpl(String a, String b) => _collator.compare(a, b).index;
+}
+
+extension on CollationOptions {
+  icu.ICU4XCollatorOptionsV1 toDartOptions() {
+    final icu4xOptions = icu.ICU4XCollatorOptionsV1();
+
+    //Usage usage;
+    //TODO: find matching
+
+    //Sensitivity? sensitivity;
+    //TODO: find matching
+
+    //bool ignorePunctuation;
+    //TODO: find matching
+
+    //bool numeric;
+    //TODO: what about auto?
+    icu4xOptions.numeric =
+        numeric ? icu.ICU4XCollatorNumeric.on : icu.ICU4XCollatorNumeric.off;
+
+    //CaseFirst? caseFirst;
+    //TODO: what about localeDependent? What about icu.off and icu.auto?
+    final caseFirst4X = switch (caseFirst) {
+      CaseFirst.upper => icu.ICU4XCollatorCaseFirst.upperFirst,
+      CaseFirst.lower => icu.ICU4XCollatorCaseFirst.lowerFirst,
+      CaseFirst.localeDependent => throw UnsupportedError(''),
+      null => null,
+    };
+    if (caseFirst4X != null) {
+      icu4xOptions.caseFirst = caseFirst4X;
+    }
+
+    //String? collation;
+    //TODO: find matching
+
+    return icu4xOptions;
   }
 }

pkgs/intl4x/lib/src/collation/collation_ecma.dart

@@ -12,9 +12,10 @@ import 'collation_options.dart';
 
 CollationImpl? getCollatorECMA(
   Locale locale,
+  CollationOptions options,
   LocaleMatcher localeMatcher,
 ) =>
-    CollationECMA.tryToBuild(locale, localeMatcher);
+    CollationECMA.tryToBuild(locale, options, localeMatcher);
 
 @JS('Intl.Collator')
 class CollatorJS {
@@ -29,15 +30,16 @@ external List<String> supportedLocalesOfJS(
 ]);
 
 class CollationECMA extends CollationImpl {
-  CollationECMA(super.locale);
+  CollationECMA(super.locale, super.options);
 
   static CollationImpl? tryToBuild(
     Locale locale,
+    CollationOptions options,
     LocaleMatcher localeMatcher,
   ) {
     final supportedLocales = supportedLocalesOf(localeMatcher, locale);
     return supportedLocales.isNotEmpty
-        ? CollationECMA(supportedLocales.first)
+        ? CollationECMA(supportedLocales.first, options)
         : null;
   }
 
@@ -54,7 +56,7 @@ class CollationECMA extends CollationImpl {
   }
 
   @override
-  int compareImpl(String a, String b, CollationOptions options) {
+  int compareImpl(String a, String b) {
     final collatorJS = CollatorJS(
       [locale.toLanguageTag()],
       options.toJsOptions(),

pkgs/intl4x/lib/src/collation/collation_impl.dart

@@ -2,6 +2,7 @@
 // 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 '../data.dart';
 import '../ecma/ecma_policy.dart';
 import '../locale/locale.dart';
 import '../options.dart';
@@ -15,24 +16,29 @@ import 'collation_stub.dart' if (dart.library.js) 'collation_ecma.dart';
 abstract class CollationImpl {
   /// The current locale, selected by the localematcher
   final Locale locale;
+  final CollationOptions options;
 
-  CollationImpl(this.locale);
+  CollationImpl(this.locale, this.options);
 
   /// Factory to get the correct implementation, either calling on ICU4X or the
   /// in-built browser implementation.
   factory CollationImpl.build(
-    Locale locales,
+    Locale locale,
+    Data data,
+    CollationOptions options,
     LocaleMatcher localeMatcher,
     EcmaPolicy ecmaPolicy,
   ) =>
       buildFormatter(
-        locales,
+        locale,
+        data,
+        options,
         localeMatcher,
         ecmaPolicy,
         getCollatorECMA,
         getCollator4X,
       );
 
   /// Actual implementation of the [compare] method.
-  int compareImpl(String a, String b, CollationOptions options);
+  int compareImpl(String a, String b);
 }

pkgs/intl4x/lib/src/collation/collation_stub.dart

@@ -2,10 +2,11 @@
 // 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 '../../collation.dart';
 import '../locale/locale.dart';
-import '../options.dart';
 import 'collation_impl.dart';
 
 /// Stub for the conditional import
-CollationImpl? getCollatorECMA(Locale locale, LocaleMatcher localeMatcher) =>
+CollationImpl? getCollatorECMA(
+        Locale locale, CollationOptions options, LocaleMatcher localeMatcher) =>
     throw UnimplementedError('Cannot use ECMA outside of web environments.');

pkgs/intl4x/lib/src/data.dart

@@ -1,20 +1,15 @@
-// Copyright (c) 2023, 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:typed_data';
-
-/// Placeholder for the data type of ICU4X - tbd!
-abstract final class Data {}
+sealed class Data {
+  const Data();
+}
 
-final class JsonData extends Data {
-  final String value;
+final class AssetData extends Data {
+  final String key;
 
-  JsonData(this.value);
+  const AssetData(this.key);
 }
 
-final class BlobData extends Data {
-  final Uint8List value;
+final class BundleData extends Data {}
 
-  BlobData(this.value);
+final class NoData extends Data {
+  const NoData();
 }

pkgs/intl4x/lib/src/data_4x.dart

@@ -0,0 +1,15 @@
+import 'dart:io';
+import 'package:icu/icu.dart';
+import 'data.dart';
+
+extension DataProvider on Data {
+  ICU4XDataProvider to4X() {
+    final icu4xDataProvider = switch (this) {
+      AssetData() => ICU4XDataProvider.fromByteSlice(
+          File((this as AssetData).key).readAsBytesSync()),
+      BundleData() => ICU4XDataProvider.compiled(),
+      NoData() => ICU4XDataProvider.empty(),
+    };
+    return icu4xDataProvider;
+  }
+}

pkgs/intl4x/lib/src/datetime_format/datetime_format.dart

@@ -4,7 +4,6 @@
 
 import '../test_checker.dart';
 import 'datetime_format_impl.dart';
-import 'datetime_format_options.dart';
 
 /// `DateTime` formatting, for example:
 ///
@@ -20,16 +19,15 @@ import 'datetime_format_options.dart';
 ///     .format(date); // Output: '4 mat.'
 /// ```
 class DateTimeFormat {
-  final DateTimeFormatOptions _options;
   final DateTimeFormatImpl impl;
 
-  DateTimeFormat(this._options, this.impl);
+  DateTimeFormat(this.impl);
 
   String format(DateTime datetime) {
     if (isInTest) {
       return '$datetime//${impl.locale}';
     } else {
-      return impl.formatImpl(datetime, _options);
+      return impl.formatImpl(datetime);
     }
   }
 }

pkgs/intl4x/lib/src/datetime_format/datetime_format_4x.dart

@@ -2,18 +2,23 @@
 // 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 '../data.dart';
 import '../locale/locale.dart';
 import 'datetime_format_impl.dart';
 import 'datetime_format_options.dart';
 
-DateTimeFormatImpl getDateTimeFormatter4X(Locale locale) =>
-    DateTimeFormat4X(locale);
+DateTimeFormatImpl getDateTimeFormatter4X(
+  Locale locale,
+  Data data,
+  DateTimeFormatOptions options,
+) =>
+    DateTimeFormat4X(locale, data, options);
 
 class DateTimeFormat4X extends DateTimeFormatImpl {
-  DateTimeFormat4X(super.locale);
+  DateTimeFormat4X(super.locale, Data data, super.options);
 
   @override
-  String formatImpl(DateTime datetime, DateTimeFormatOptions options) {
+  String formatImpl(DateTime datetime) {
     throw UnimplementedError('Insert diplomat bindings here');
   }
 }