Implement Intl.PluralRules (#3298)

* Implement `PluralRules` * cargo fmt * Move options utils to builtins module * Fix docs * Apply review
boa-dev · Sep 25, 2023 · 25c120b · 25c120b
1 parent 7e18da6
commit 25c120b
Show file tree

Hide file tree

Showing 25 changed files with 1,377 additions and 173 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/boa_engine/Cargo.toml b/boa_engine/Cargo.toml
@@ -32,6 +32,7 @@ intl = [
     "dep:sys-locale",
     "dep:yoke",
     "dep:zerofrom",
+    "dep:fixed_decimal",
 ]
 
 fuzz = ["boa_ast/arbitrary", "boa_interner/arbitrary"]
@@ -93,6 +94,7 @@ writeable = { version = "0.5.2", optional = true }
 yoke = { version = "0.7.1", optional = true }
 zerofrom = { version = "0.1.2", optional = true }
 sys-locale = { version = "0.3.1", optional = true }
+fixed_decimal = { version = "0.5.4", features = ["ryu"], optional = true}
 
 [dev-dependencies]
 criterion = "0.5.1"

diff --git a/boa_engine/src/builtins/intl/collator/mod.rs b/boa_engine/src/builtins/intl/collator/mod.rs
@@ -11,7 +11,9 @@ use icu_locid::{
 use icu_provider::DataLocale;
 
 use crate::{
-    builtins::{BuiltInBuilder, BuiltInConstructor, BuiltInObject, IntrinsicObject},
+    builtins::{
+        options::get_option, BuiltInBuilder, BuiltInConstructor, BuiltInObject, IntrinsicObject,
+    },
     context::{
         intrinsics::{Intrinsics, StandardConstructor, StandardConstructors},
         BoaProvider,
@@ -30,7 +32,7 @@ use crate::{
 
 use super::{
     locale::{canonicalize_locale_list, resolve_locale, supported_locales, validate_extension},
-    options::{coerce_options_to_object, get_option, IntlOptions, LocaleMatcher},
+    options::{coerce_options_to_object, IntlOptions, LocaleMatcher},
     Service,
 };
 

diff --git a/boa_engine/src/builtins/intl/collator/options.rs b/boa_engine/src/builtins/intl/collator/options.rs
@@ -1,8 +1,11 @@
 use std::str::FromStr;
 
-use icu_collator::{CaseLevel, Strength};
+use icu_collator::{CaseFirst, CaseLevel, Strength};
 
-use crate::builtins::intl::options::OptionTypeParsable;
+use crate::{
+    builtins::options::{OptionType, ParsableOptionType},
+    Context, JsNativeError, JsResult, JsValue,
+};
 
 #[derive(Debug, Clone, Copy)]
 pub(crate) enum Sensitivity {
@@ -47,7 +50,7 @@ impl FromStr for Sensitivity {
     }
 }
 
-impl OptionTypeParsable for Sensitivity {}
+impl ParsableOptionType for Sensitivity {}
 
 #[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
 pub(crate) enum Usage {
@@ -77,4 +80,17 @@ impl FromStr for Usage {
     }
 }
 
-impl OptionTypeParsable for Usage {}
+impl ParsableOptionType for Usage {}
+
+impl OptionType for CaseFirst {
+    fn from_value(value: JsValue, context: &mut Context<'_>) -> JsResult<Self> {
+        match value.to_string(context)?.to_std_string_escaped().as_str() {
+            "upper" => Ok(Self::UpperFirst),
+            "lower" => Ok(Self::LowerFirst),
+            "false" => Ok(Self::Off),
+            _ => Err(JsNativeError::range()
+                .with_message("provided string was not `upper`, `lower` or `false`")
+                .into()),
+        }
+    }
+}
diff --git a/boa_engine/src/builtins/intl/date_time_format.rs b/boa_engine/src/builtins/intl/date_time_format.rs
@@ -8,7 +8,9 @@
 //! [spec]: https://tc39.es/ecma402/#datetimeformat-objects
 
 use crate::{
-    builtins::{BuiltInBuilder, BuiltInConstructor, BuiltInObject, IntrinsicObject},
+    builtins::{
+        options::OptionType, BuiltInBuilder, BuiltInConstructor, BuiltInObject, IntrinsicObject,
+    },
     context::intrinsics::{Intrinsics, StandardConstructor, StandardConstructors},
     error::JsNativeError,
     js_string,
@@ -22,8 +24,6 @@ use boa_gc::{Finalize, Trace};
 use boa_profiler::Profiler;
 use icu_datetime::options::preferences::HourCycle;
 
-use super::options::OptionType;
-
 impl OptionType for HourCycle {
     fn from_value(value: JsValue, context: &mut Context<'_>) -> JsResult<Self> {
         match value.to_string(context)?.to_std_string_escaped().as_str() {

diff --git a/boa_engine/src/builtins/intl/list_format/mod.rs b/boa_engine/src/builtins/intl/list_format/mod.rs
@@ -6,7 +6,10 @@ use icu_locid::Locale;
 use icu_provider::DataLocale;
 
 use crate::{
-    builtins::{Array, BuiltInBuilder, BuiltInConstructor, BuiltInObject, IntrinsicObject},
+    builtins::{
+        options::{get_option, get_options_object},
+        Array, BuiltInBuilder, BuiltInConstructor, BuiltInObject, IntrinsicObject,
+    },
     context::intrinsics::{Intrinsics, StandardConstructor, StandardConstructors},
     object::{internal_methods::get_prototype_from_constructor, JsObject, ObjectData},
     property::Attribute,
@@ -18,7 +21,7 @@ use crate::{
 
 use super::{
     locale::{canonicalize_locale_list, resolve_locale, supported_locales},
-    options::{get_option, get_options_object, IntlOptions, LocaleMatcher},
+    options::{IntlOptions, LocaleMatcher},
     Service,
 };
 

diff --git a/boa_engine/src/builtins/intl/list_format/options.rs b/boa_engine/src/builtins/intl/list_format/options.rs
@@ -3,7 +3,7 @@ use std::str::FromStr;
 use icu_list::ListLength;
 
 use crate::{
-    builtins::intl::options::{OptionType, OptionTypeParsable},
+    builtins::options::{OptionType, ParsableOptionType},
     Context, JsNativeError, JsResult, JsValue,
 };
 
@@ -37,7 +37,7 @@ impl FromStr for ListFormatType {
     }
 }
 
-impl OptionTypeParsable for ListFormatType {}
+impl ParsableOptionType for ListFormatType {}
 
 impl OptionType for ListLength {
     fn from_value(value: JsValue, context: &mut Context<'_>) -> JsResult<Self> {

diff --git a/boa_engine/src/builtins/intl/locale/mod.rs b/boa_engine/src/builtins/intl/locale/mod.rs
@@ -1,4 +1,4 @@
-use crate::{realm::Realm, string::utf16};
+use crate::{builtins::options::get_option, realm::Realm, string::utf16};
 use boa_profiler::Profiler;
 use icu_collator::CaseFirst;
 use icu_datetime::options::preferences::HourCycle;
@@ -26,7 +26,7 @@ use crate::{
     Context, JsArgs, JsNativeError, JsResult, JsString, JsValue,
 };
 
-use super::options::{coerce_options_to_object, get_option};
+use super::options::coerce_options_to_object;
 
 #[derive(Debug, Clone)]
 pub(crate) struct Locale;

diff --git a/boa_engine/src/builtins/intl/locale/options.rs b/boa_engine/src/builtins/intl/locale/options.rs
@@ -1,6 +1,6 @@
 use icu_locid::extensions::unicode::Value;
 
-use crate::{builtins::intl::options::OptionType, Context, JsNativeError};
+use crate::{builtins::options::OptionType, Context, JsNativeError};
 
 impl OptionType for Value {
     fn from_value(value: crate::JsValue, context: &mut Context<'_>) -> crate::JsResult<Self> {

diff --git a/boa_engine/src/builtins/intl/locale/utils.rs b/boa_engine/src/builtins/intl/locale/utils.rs
@@ -1,9 +1,10 @@
 use crate::{
     builtins::{
         intl::{
-            options::{coerce_options_to_object, get_option, IntlOptions, LocaleMatcher},
+            options::{coerce_options_to_object, IntlOptions, LocaleMatcher},
             Service,
         },
+        options::get_option,
         Array,
     },
     context::{icu::Icu, BoaProvider},

diff --git a/boa_engine/src/builtins/intl/mod.rs b/boa_engine/src/builtins/intl/mod.rs
@@ -26,11 +26,13 @@ pub(crate) mod collator;
 pub(crate) mod date_time_format;
 pub(crate) mod list_format;
 pub(crate) mod locale;
+pub(crate) mod number_format;
+pub(crate) mod plural_rules;
 pub(crate) mod segmenter;
 
 pub(crate) use self::{
     collator::Collator, date_time_format::DateTimeFormat, list_format::ListFormat, locale::Locale,
-    segmenter::Segmenter,
+    plural_rules::PluralRules, segmenter::Segmenter,
 };
 
 mod options;
@@ -73,6 +75,15 @@ impl IntrinsicObject for Intl {
                 realm.intrinsics().constructors().segmenter().constructor(),
                 Segmenter::ATTRIBUTE,
             )
+            .static_property(
+                PluralRules::NAME,
+                realm
+                    .intrinsics()
+                    .constructors()
+                    .plural_rules()
+                    .constructor(),
+                PluralRules::ATTRIBUTE,
+            )
             .static_property(
                 DateTimeFormat::NAME,
                 realm

diff --git a/boa_engine/src/builtins/intl/number_format/mod.rs b/boa_engine/src/builtins/intl/number_format/mod.rs
@@ -0,0 +1,4 @@
+mod options;
+mod utils;
+pub(crate) use options::*;
+pub(crate) use utils::*;