Transformer for RelativeTimeFormat component

Cargo.toml

@@ -24,6 +24,7 @@ members = [
     "experimental/ixdtf",
     "experimental/tutorials",
     "experimental/displaynames",
+				"experimental/relativetime",
     "utils/databake",
     "utils/databake/derive",
     "experimental/segmenter",

components/icu/Cargo.toml

@@ -43,6 +43,7 @@ icu_timezone = { version = "1.0.0", path = "../timezone", default-features = fal
 icu_casemapping = { version = "0.7.0", path = "../../experimental/casemapping", default-features = false, optional = true }
 icu_segmenter = { version = "0.7.0", path = "../../experimental/segmenter", default-features = false, optional = true }
 icu_displaynames = { version = "0.7.0", path = "../../experimental/displaynames", default-features = false, optional = true }
+icu_relativetime = { version = "0.1.0", path = "../../experimental/relativetime", default-features = false, optional = true }
 
 # For docs links
 icu_provider = { version = "1.0.0", path = "../../provider/core", default-features = false }
@@ -90,7 +91,7 @@ serde = [
 serde_human = [
     "icu_list/serde_human"
 ]
-experimental = ["icu_casemapping", "icu_segmenter", "icu_datetime/experimental", "icu_displaynames"]
+experimental = ["icu_casemapping", "icu_segmenter", "icu_datetime/experimental", "icu_displaynames", "icu_relativetime"]
 
 [[example]]
 name = "tui"

experimental/relativetime/Cargo.toml

@@ -0,0 +1,35 @@
+# This file is part of ICU4X. For terms of use, please see the file
+# called LICENSE at the top level of the ICU4X source tree
+# (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+[package]
+name = "icu_relativetime"
+version = "0.1.0"
+authors = ["The ICU4X Project Developers"]
+edition = "2018"
+repository = "https://github.com/unicode-org/icu4x"
+license-file = "LICENSE"
+categories = ["internationalization"]
+# Keep this in sync with other crates unless there are exceptions
+include = [
+    "data/*",
+    "src/**/*",
+    "examples/**/*",
+    "benches/**/*",
+    "tests/**/*",
+    "Cargo.toml",
+    "LICENSE",
+    "README.md"
+]
+
+[dependencies]
+icu_provider = { version = "1.0.0", path = "../../provider/core", features = ["macros"] }
+zerovec = { version = "0.9", path = "../../utils/zerovec", features = ["yoke"] }
+serde = { version = "1.0", default-features = false, features = ["derive", "alloc"], optional = true }
+databake = { version = "0.1.0", path = "../../utils/databake", optional = true, features = ["derive"]}
+
+[features]
+default = []
+std = ["icu_provider/std"]
+serde = ["dep:serde", "zerovec/serde"]
+datagen = ["std", "serde", "dep:databake", "zerovec/databake"]

experimental/relativetime/LICENSE

@@ -0,0 +1,51 @@
+UNICODE, INC. LICENSE AGREEMENT - DATA FILES AND SOFTWARE
+
+See Terms of Use <https://www.unicode.org/copyright.html>
+for definitions of Unicode Inc.’s Data Files and Software.
+
+NOTICE TO USER: Carefully read the following legal agreement.
+BY DOWNLOADING, INSTALLING, COPYING OR OTHERWISE USING UNICODE INC.'S
+DATA FILES ("DATA FILES"), AND/OR SOFTWARE ("SOFTWARE"),
+YOU UNEQUIVOCALLY ACCEPT, AND AGREE TO BE BOUND BY, ALL OF THE
+TERMS AND CONDITIONS OF THIS AGREEMENT.
+IF YOU DO NOT AGREE, DO NOT DOWNLOAD, INSTALL, COPY, DISTRIBUTE OR USE
+THE DATA FILES OR SOFTWARE.
+
+COPYRIGHT AND PERMISSION NOTICE
+
+Copyright © 1991-2022 Unicode, Inc. All rights reserved.
+Distributed under the Terms of Use in https://www.unicode.org/copyright.html.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Unicode data files and any associated documentation
+(the "Data Files") or Unicode software and any associated documentation
+(the "Software") to deal in the Data Files or Software
+without restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, and/or sell copies of
+the Data Files or Software, and to permit persons to whom the Data Files
+or Software are furnished to do so, provided that either
+(a) this copyright and permission notice appear with all copies
+of the Data Files or Software, or
+(b) this copyright and permission notice appear in associated
+Documentation.
+
+THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT OF THIRD PARTY RIGHTS.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS
+NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL
+DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
+DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THE DATA FILES OR SOFTWARE.
+
+Except as contained in this notice, the name of a copyright holder
+shall not be used in advertising or otherwise to promote the sale,
+use or other dealings in these Data Files or Software without prior
+written authorization of the copyright holder.
+
+—
+
+Portions of ICU4X may have been adapted from ICU4C and/or ICU4J.
+ICU 1.8.1 to ICU 57.1 © 1995-2016 International Business Machines Corporation and others.

experimental/relativetime/README.md

@@ -0,0 +1,17 @@
+# icu_relativetime [![crates.io](https://img.shields.io/crates/v/icu_relativetime)](https://crates.io/crates/icu_relativetime)
+
+🚧 \[Experimental\] Relative time formatting
+
+This module is published as its own crate ([`icu_relativetime`](https://docs.rs/icu_relativetime/latest/icu_relativetime/))
+and as part of the [`icu`](https://docs.rs/icu/latest/icu/) crate. See the latter for more details on the ICU4X project.
+
+<div class="stab unstable">
+🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
+including in SemVer minor releases. It can be enabled with the "experimental" feature
+of the icu meta-crate. Use with caution.
+</div>
+
+
+## More Information
+
+For more information on development, authorship, contributing etc. please visit [`ICU4X home page`](https://github.com/unicode-org/icu4x).

experimental/relativetime/src/lib.rs

@@ -0,0 +1,21 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+//! 🚧 \[Experimental\] Relative time formatting
+//!
+//! This module is published as its own crate ([`icu_relativetime`](https://docs.rs/icu_relativetime/latest/icu_relativetime/))
+//! and as part of the [`icu`](https://docs.rs/icu/latest/icu/) crate. See the latter for more details on the ICU4X project.
+//!
+//! <div class="stab unstable">
+//! 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
+//! including in SemVer minor releases. It can be enabled with the "experimental" feature
+//! of the icu meta-crate. Use with caution.
+//! </div>
+//!
+
+#![warn(missing_docs)]
+
+extern crate alloc;
+
+pub mod provider;

experimental/relativetime/src/provider.rs

@@ -0,0 +1,99 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+// Provider structs must be stable
+#![allow(clippy::exhaustive_structs, clippy::exhaustive_enums)]
+
+//! Data provider struct definitions for this ICU4X component.
+//!
+//! Read more about data providers: [`icu_provider`]
+
+use alloc::borrow::Cow;
+use icu_provider::{yoke, zerofrom};
+use zerovec::ZeroMap;
+
+/// Relative time patterns data struct.
+#[icu_provider::data_struct(
+    StandardRelativeTimeV1Marker = "relativetime/standard@1",
+    NarrowRelativeTimeV1Marker = "relativetime/narrow@1",
+    ShortRelativeTimeV1Marker = "relativetime/short@1"
+)]
+#[derive(Debug, Clone, Default, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
+#[cfg_attr(
+    feature = "datagen", 
+    derive(serde::Serialize, databake::Bake),
+    databake(path = icu_relativetime::provider)
+)]
+#[yoke(prove_covariance_manually)]
+pub struct RelativeTimePatternsV1<'data>(
+    #[cfg_attr(feature = "serde", serde(borrow))]
+    // Contains patterns in order second, minute, hour, day, week, month, quarter, year
+    pub [RelativeTimePattern<'data>; 8],
+);
+
+impl<'data> RelativeTimePatternsV1<'data> {
+    /// Create a new RelativeTimePatternsV1
+    pub fn new(patterns: [RelativeTimePattern<'data>; 8]) -> Self {
+        Self(patterns)
+    }
+}
+
+/// A single relative time pattern.
+#[derive(Debug, Clone, Default, PartialEq, yoke::Yokeable, zerofrom::ZeroFrom)]
+#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
+#[cfg_attr(
+    feature = "datagen", 
+    derive(serde::Serialize, databake::Bake),
+    databake(path = icu_relativetime::provider)
+)]
+#[yoke(prove_covariance_manually)]
+pub struct RelativeTimePattern<'data> {
+    /// The display name of the pattern
+    pub display_name: Option<Cow<'data, str>>,
+    /// Mapping for relative time fields.
+    #[cfg_attr(feature = "serde", serde(borrow))]
+    pub relatives: ZeroMap<'data, i8, str>,
+    /*
+    // Plural rules mapping for past.
+    #[cfg_attr(feature = "serde", serde(borrow))]
+    pub past_zero: Option<SingularSubPattern<'data>>,
+    #[cfg_attr(feature = "serde", serde(borrow))]
+    pub past_one: Option<SingularSubPattern<'data>>,
+    #[cfg_attr(feature = "serde", serde(borrow))]
+    pub past_two: Option<SingularSubPattern<'data>>,
+    #[cfg_attr(feature = "serde", serde(borrow))]
+    pub past_few: Option<SingularSubPattern<'data>>,
+    #[cfg_attr(feature = "serde", serde(borrow))]
+    pub past_many: Option<SingularSubPattern<'data>>,
+    #[cfg_attr(feature = "serde", serde(borrow))]
+    pub past_other: Option<SingularSubPattern<'data>>,
+    // Plural rules mapping for future.
+    #[cfg_attr(feature = "serde", serde(borrow))]
+    pub future_zero: Option<SingularSubPattern<'data>>,
+    #[cfg_attr(feature = "serde", serde(borrow))]
+    pub future_one: Option<SingularSubPattern<'data>>,
+    #[cfg_attr(feature = "serde", serde(borrow))]
+    pub future_two: Option<SingularSubPattern<'data>>,
+    #[cfg_attr(feature = "serde", serde(borrow))]
+    pub future_few: Option<SingularSubPattern<'data>>,
+    #[cfg_attr(feature = "serde", serde(borrow))]
+    pub future_many: Option<SingularSubPattern<'data>>,
+    #[cfg_attr(feature = "serde", serde(borrow))]
+    pub future_other: Option<SingularSubPattern<'data>>,
+    */
+}
+
+/// Singular substitution pattern string.
+#[derive(Debug, Clone, Default, PartialEq, yoke::Yokeable, zerofrom::ZeroFrom)]
+#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
+#[cfg_attr(
+    feature = "datagen", 
+    derive(serde::Serialize, databake::Bake),
+    databake(path = icu_relativetime::provider)
+)]
+pub struct SingularSubPattern<'data> {
+    pattern: Cow<'data, str>,
+    index: u8,
+}

provider/datagen/Cargo.toml

@@ -50,6 +50,7 @@ icu_timezone = { version = "1.0.0", path = "../../components/timezone", features
 icu_casemapping = { version = "0.7.0", path = "../../experimental/casemapping", features = ["datagen"], optional = true }
 icu_segmenter = { version = "0.7.0", path = "../../experimental/segmenter", features = ["datagen", "lstm"], optional = true }
 icu_displaynames = { version = "0.7.0", path = "../../experimental/displaynames", features = ["datagen"], optional = true }
+icu_relativetime = { version = "0.1.0", path = "../../experimental/relativetime", features = ["datagen"], optional = true }
 
 # ICU provider infrastructure
 icu_provider = { version = "1.0.0", path = "../core", features = ["std", "log_error_context", "datagen"]}
@@ -95,7 +96,7 @@ icu = { path = "../../components/icu" }
 
 [features]
 default = []
-experimental = ["icu_casemapping", "icu_segmenter", "icu_datetime/experimental", "icu_displaynames"]
+experimental = ["icu_casemapping", "icu_segmenter", "icu_datetime/experimental", "icu_displaynames", "icu_relativetime"]
 bin = ["clap", "eyre", "simple_logger"]
 
 [[bin]]

provider/datagen/src/registry.rs

@@ -23,6 +23,8 @@ use icu_casemapping::provider::*;
 #[cfg(feature = "experimental")]
 use icu_displaynames::provider::*;
 #[cfg(feature = "experimental")]
+use icu_relativetime::provider::*;
+#[cfg(feature = "experimental")]
 use icu_segmenter::provider::*;
 
 macro_rules! registry {
@@ -220,6 +222,9 @@ registry!(
         SentenceBreakDataV1Marker,
         UCharDictionaryBreakDataV1Marker,
         WordBreakDataV1Marker,
+        StandardRelativeTimeV1Marker,
+        ShortRelativeTimeV1Marker,
+        NarrowRelativeTimeV1Marker,
     }
 );
 

provider/datagen/src/transform/cldr/cldr_serde/mod.rs

@@ -17,5 +17,6 @@ pub mod numbering_systems;
 pub mod numbers;
 pub mod parent_locales;
 pub mod plurals;
+pub mod relativetime;
 pub mod time_zones;
 pub mod week_data;