DateTime Options migration (#5811)

#1317

components/datetime/benches/fixtures/mod.rs

@@ -2,7 +2,7 @@
 // called LICENSE at the top level of the ICU4X source tree
 // (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
 
-use icu_datetime::{neo_skeleton, options::components};
+use icu_datetime::{options, provider::skeleton::components};
 use serde::{Deserialize, Serialize};
 
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
@@ -25,7 +25,8 @@ pub struct TestOptions {
     pub length: Option<TestOptionsLength>,
     pub components: Option<TestComponentsBag>,
     pub semantic: Option<icu_datetime::fieldset::dynamic::CompositeFieldSet>,
-    pub preferences: Option<icu_datetime::options::preferences::Bag>,
+    #[serde(rename = "hourCycle")]
+    pub hour_cycle: Option<TestHourCycle>,
 }
 
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
@@ -58,11 +59,9 @@ pub struct TestComponentsBag {
     pub hour: Option<components::Numeric>,
     pub minute: Option<components::Numeric>,
     pub second: Option<components::Numeric>,
-    pub fractional_second: Option<neo_skeleton::FractionalSecondDigits>,
+    pub fractional_second: Option<options::FractionalSecondDigits>,
 
     pub time_zone_name: Option<components::TimeZoneName>,
-
-    pub hour_cycle: Option<TestHourCycle>,
 }
 
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]

components/datetime/benches/fixtures/tests/components.json

@@ -253,7 +253,7 @@
                         "length": "medium",
                         "timePrecision": "minuteExact"
                     },
-                    "preferences": { "hourCycle": "h12" }
+                    "hourCycle": "h12"
                 }
             },
             {
@@ -270,7 +270,7 @@
                         "length": "medium",
                         "timePrecision": "secondPlus"
                     },
-                    "preferences": { "hourCycle": "h12" }
+                    "hourCycle": "h12"
                 }
             },
             {
@@ -286,7 +286,7 @@
                         "length": "medium",
                         "timePrecision": "minuteExact"
                     },
-                    "preferences": { "hourCycle": "h23" }
+                    "hourCycle": "h23"
                 }
             },
             {
@@ -303,7 +303,7 @@
                         "length": "medium",
                         "timePrecision": "secondPlus"
                     },
-                    "preferences": { "hourCycle": "h23" }
+                    "hourCycle": "h23"
                 }
             },
             {
@@ -317,7 +317,7 @@
                         "length": "medium",
                         "timePrecision": "hourExact"
                     },
-                    "preferences": { "hourCycle": "h12" }
+                    "hourCycle": "h12"
                 }
             },
             {
@@ -332,7 +332,7 @@
                         "length": "medium",
                         "timePrecision": "minuteExact"
                     },
-                    "preferences": { "hourCycle": "h12" }
+                    "hourCycle": "h12"
                 }
             },
             {
@@ -348,7 +348,7 @@
                         "length": "medium",
                         "timePrecision": "secondPlus"
                     },
-                    "preferences": { "hourCycle": "h12" }
+                    "hourCycle": "h12"
                 }
             },
             {
@@ -362,7 +362,7 @@
                         "length": "medium",
                         "timePrecision": "hourExact"
                     },
-                    "preferences": { "hourCycle": "h23" }
+                    "hourCycle": "h23"
                 }
             },
             {
@@ -377,7 +377,7 @@
                         "length": "medium",
                         "timePrecision": "minuteExact"
                     },
-                    "preferences": { "hourCycle": "h23" }
+                    "hourCycle": "h23"
                 }
             },
             {
@@ -393,7 +393,7 @@
                         "length": "medium",
                         "timePrecision": "secondPlus"
                     },
-                    "preferences": { "hourCycle": "h23" }
+                    "hourCycle": "h23"
                 }
             },
             {
@@ -454,7 +454,7 @@
                         "length": "medium",
                         "timePrecision": "minuteExact"
                     },
-                    "preferences": { "hourCycle": "h12" }
+                    "hourCycle": "h12"
                 }
             },
             {
@@ -474,7 +474,7 @@
                         "length": "long",
                         "timePrecision": "minuteExact"
                     },
-                    "preferences": { "hourCycle": "h12" }
+                    "hourCycle": "h12"
                 }
             },
             {
@@ -489,7 +489,7 @@
                         "length": "short",
                         "timePrecision": "minuteExact"
                     },
-                    "preferences": { "hourCycle": "h11" }
+                    "hourCycle": "h11"
                 }
             },
             {
@@ -504,7 +504,7 @@
                         "length": "short",
                         "timePrecision": "minuteExact"
                     },
-                    "preferences": { "hourCycle": "h24" }
+                    "hourCycle": "h24"
                 }
             },
             {
@@ -519,7 +519,7 @@
                         "length": "short",
                         "timePrecision": "minuteExact"
                     },
-                    "preferences": { "hourCycle": "h11" }
+                    "hourCycle": "h11"
                 }
             },
             {
@@ -534,7 +534,7 @@
                         "length": "short",
                         "timePrecision": "minuteExact"
                     },
-                    "preferences": { "hourCycle": "h12" }
+                    "hourCycle": "h12"
                 }
             },
             {
@@ -549,7 +549,7 @@
                         "length": "short",
                         "timePrecision": "minuteExact"
                     },
-                    "preferences": { "hourCycle": "h23" }
+                    "hourCycle": "h23"
                 }
             },
             {
@@ -564,7 +564,7 @@
                         "length": "short",
                         "timePrecision": "minuteExact"
                     },
-                    "preferences": { "hourCycle": "h24" }
+                    "hourCycle": "h24"
                 }
             }
         ],

components/datetime/src/dynamic.rs

@@ -4,7 +4,6 @@
 
 #[cfg(feature = "serde")]
 use crate::neo_serde::*;
-use crate::options::preferences::HourCycle;
 use crate::raw::neo::RawNeoOptions;
 use crate::scaffold::GetField;
 use crate::{fields, fieldset, NeoSkeletonLength};
@@ -415,9 +414,9 @@ impl_attrs! {
 impl TimeFieldSet {
     pub(crate) const fn id_str_for_hour_cycle(
         self,
-        hour_cycle: Option<HourCycle>,
+        hour_cycle: Option<fields::Hour>,
     ) -> &'static DataMarkerAttributes {
-        use HourCycle::*;
+        use fields::Hour::*;
         match hour_cycle {
             None => Self::ATTR_T,
             Some(H11 | H12) => Self::ATTR_T12,

components/datetime/src/fields/symbols.rs

@@ -4,9 +4,10 @@
 
 #[cfg(feature = "datagen")]
 use crate::fields::FieldLength;
-use crate::neo_skeleton::FractionalSecondDigits;
+use crate::options::FractionalSecondDigits;
 use core::{cmp::Ordering, convert::TryFrom};
 use displaydoc::Display;
+use icu_locale_core::preferences::extensions::unicode::keywords::HourCycle;
 use icu_provider::prelude::*;
 use zerovec::ule::{AsULE, UleError, ULE};
 
@@ -593,6 +594,18 @@ field_type!(
     HourULE
 );
 
+impl Hour {
+    pub(crate) fn from_hour_cycle(hour_cycle: HourCycle) -> Self {
+        match hour_cycle {
+            HourCycle::H11 => Self::H11,
+            HourCycle::H12 => Self::H12,
+            HourCycle::H23 => Self::H23,
+            HourCycle::H24 => Self::H24,
+            _ => unreachable!(),
+        }
+    }
+}
+
 // NOTE: 'S' FractionalSecond is represented via DecimalSecond,
 // so it is not included in the Second enum.
 

components/datetime/src/fieldset.rs

@@ -10,7 +10,7 @@ use crate::{
     dynamic::*,
     fields,
     format::neo::*,
-    neo_skeleton::*,
+    options::*,
     provider::{neo::*, time_zones::tz, *},
     raw::neo::RawNeoOptions,
     scaffold::*,

components/datetime/src/lib.rs

@@ -100,7 +100,6 @@ mod neo_marker;
 pub mod neo_pattern;
 #[cfg(feature = "serde")]
 mod neo_serde;
-pub mod neo_skeleton;
 pub mod options;
 pub mod provider;
 pub(crate) mod raw;
@@ -113,4 +112,4 @@ pub use format::neo::{FormattedDateTimePattern, PatternLoadError, TypedDateTimeN
 pub use neo::DateTimeFormatter;
 pub use neo::FixedCalendarDateTimeFormatter;
 pub use neo::FormattedNeoDateTime;
-pub use neo_skeleton::NeoSkeletonLength;
+pub use options::NeoSkeletonLength;

components/datetime/src/neo.rs

@@ -10,7 +10,6 @@ use crate::format::datetime::try_write_pattern_items;
 use crate::format::neo::*;
 use crate::input::ExtractedInput;
 use crate::neo_pattern::DateTimePattern;
-use crate::options::preferences::HourCycle;
 use crate::raw::neo::*;
 use crate::scaffold::*;
 use crate::scaffold::{
@@ -24,6 +23,7 @@ use core::fmt;
 use core::marker::PhantomData;
 use icu_calendar::any_calendar::IntoAnyCalendar;
 use icu_calendar::AnyCalendar;
+use icu_locale_core::preferences::extensions::unicode::keywords::HourCycle;
 use icu_provider::prelude::*;
 use writeable::TryWriteable;
 
@@ -243,12 +243,13 @@ where
         P: ?Sized + AllFixedCalendarFormattingDataMarkers<C, FSet>,
         L: FixedDecimalFormatterLoader,
     {
-        // TODO: Remove this when NeoOptions is gone
+        // TODO: Fix this when we have DateTimePreferences
         let prefs = RawPreferences {
             hour_cycle: locale
                 .get_unicode_ext(&icu_locale_core::extensions::unicode::key!("hc"))
                 .as_ref()
-                .and_then(HourCycle::from_locale_value),
+                .and_then(|v| HourCycle::try_from(v).ok())
+                .map(crate::fields::Hour::from_hour_cycle),
         };
         // END TODO
 
@@ -473,12 +474,13 @@ where
         P: ?Sized + AllAnyCalendarFormattingDataMarkers<FSet>,
         L: FixedDecimalFormatterLoader + AnyCalendarLoader,
     {
-        // TODO: Remove this when NeoOptions is gone
+        // TODO: Fix this when we have DateTimePreferences
         let prefs = RawPreferences {
             hour_cycle: locale
                 .get_unicode_ext(&icu_locale_core::extensions::unicode::key!("hc"))
                 .as_ref()
-                .and_then(HourCycle::from_locale_value),
+                .and_then(|v| HourCycle::try_from(v).ok())
+                .map(crate::fields::Hour::from_hour_cycle),
         };
         // END TODO
 

components/datetime/src/neo_marker.rs

@@ -16,7 +16,7 @@
 //! use icu::calendar::Date;
 //! use icu::calendar::Gregorian;
 //! use icu::datetime::fieldset::YMD;
-//! use icu::datetime::neo_skeleton::Alignment;
+//! use icu::datetime::options::Alignment;
 //! use icu::datetime::FixedCalendarDateTimeFormatter;
 //! use icu::locale::locale;
 //! use writeable::assert_try_writeable_eq;
@@ -56,7 +56,7 @@
 //! use icu::calendar::Date;
 //! use icu::calendar::Gregorian;
 //! use icu::datetime::fieldset::YMD;
-//! use icu::datetime::neo_skeleton::YearStyle;
+//! use icu::datetime::options::YearStyle;
 //! use icu::datetime::FixedCalendarDateTimeFormatter;
 //! use icu::locale::locale;
 //! use writeable::assert_try_writeable_eq;
@@ -233,8 +233,8 @@
 //! ```
 //! use icu::calendar::Time;
 //! use icu::datetime::fieldset::T;
-//! use icu::datetime::neo_skeleton::FractionalSecondDigits;
-//! use icu::datetime::neo_skeleton::TimePrecision;
+//! use icu::datetime::options::FractionalSecondDigits;
+//! use icu::datetime::options::TimePrecision;
 //! use icu::datetime::FixedCalendarDateTimeFormatter;
 //! use icu::locale::locale;
 //! use writeable::assert_try_writeable_eq;
@@ -291,8 +291,8 @@
 //! use icu::calendar::Gregorian;
 //! use icu::calendar::Time;
 //! use icu::datetime::fieldset::T;
-//! use icu::datetime::neo_skeleton::FractionalSecondDigits;
-//! use icu::datetime::neo_skeleton::TimePrecision;
+//! use icu::datetime::options::FractionalSecondDigits;
+//! use icu::datetime::options::TimePrecision;
 //! use icu::datetime::FixedCalendarDateTimeFormatter;
 //! use icu::locale::locale;
 //! use writeable::assert_try_writeable_eq;

components/datetime/src/neo_pattern.rs

@@ -42,7 +42,7 @@ size_test!(DateTimePattern, date_time_pattern_size, 32);
 /// use icu::calendar::Gregorian;
 /// use icu::datetime::fieldset::YMD;
 /// use icu::datetime::neo_pattern::DateTimePattern;
-/// use icu::datetime::options::components;
+/// use icu::datetime::provider::skeleton::components;
 /// use icu::datetime::FixedCalendarDateTimeFormatter;
 /// use icu::locale::locale;
 /// use writeable::assert_writeable_eq;

components/datetime/src/neo_serde.rs

@@ -4,7 +4,7 @@
 
 //! Serde definitions for semantic skeleta
 
-use crate::{dynamic::*, fieldset, neo_skeleton::*, raw::neo::RawNeoOptions};
+use crate::{dynamic::*, fieldset, options::*, raw::neo::RawNeoOptions};
 use alloc::vec::Vec;
 use serde::{Deserialize, Serialize};