Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add cyclic year to FormattableYear #3581

Merged
merged 4 commits into from
Jun 28, 2023
Merged

Add cyclic year to FormattableYear #3581

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0e10a51
Add `FormattableYear` field `cyclic`
atcupps Jun 26, 2023
7e2bc92
Make field `cyclic` in `FormattableYear` an `Option`
atcupps Jun 27, 2023
12b6843
Add comments
atcupps Jun 27, 2023
5cd3d79
Changed test size of
atcupps Jun 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add FormattableYear field cyclic
  • Loading branch information
@atcupps
atcupps committed Jun 26, 2023
commit 0e10a516f7035b3eac412fa4272b9c21222466ec
1 change: 1 addition & 0 deletions components/calendar/src/buddhist.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ fn iso_year_as_buddhist(year: i32) -> types::FormattableYear {
types::FormattableYear {
era: types::Era(tinystr!(16, "be")),
number: buddhist_year,
cyclic: 0,
related_iso: None,
}
}
2 changes: 2 additions & 0 deletions components/calendar/src/coptic.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,12 +326,14 @@ fn year_as_coptic(year: i32) -> types::FormattableYear {
types::FormattableYear {
era: types::Era(tinystr!(16, "ad")),
number: year,
cyclic: 0,
related_iso: None,
}
} else {
types::FormattableYear {
era: types::Era(tinystr!(16, "bd")),
number: 1 - year,
cyclic: 0,
related_iso: None,
}
}
Expand Down
3 changes: 3 additions & 0 deletions components/calendar/src/ethiopian.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,18 +292,21 @@ impl Ethiopian {
types::FormattableYear {
era: types::Era(tinystr!(16, "mundi")),
number: year + AMETE_ALEM_OFFSET,
cyclic: 0,
related_iso: None,
}
} else if year > 0 {
types::FormattableYear {
era: types::Era(tinystr!(16, "incar")),
number: year,
cyclic: 0,
related_iso: None,
}
} else {
types::FormattableYear {
era: types::Era(tinystr!(16, "pre-incar")),
number: 1 - year,
cyclic: 0,
related_iso: None,
}
}
Expand Down
2 changes: 2 additions & 0 deletions components/calendar/src/gregorian.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,12 +223,14 @@ pub(crate) fn year_as_gregorian(year: i32) -> types::FormattableYear {
types::FormattableYear {
era: types::Era(tinystr!(16, "ce")),
number: year,
cyclic: 0,
related_iso: None,
}
} else {
types::FormattableYear {
era: types::Era(tinystr!(16, "bce")),
number: 1_i32.saturating_sub(year),
cyclic: 0,
related_iso: None,
}
}
Expand Down
3 changes: 3 additions & 0 deletions components/calendar/src/indian.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ impl Calendar for Indian {
types::FormattableYear {
era: types::Era(tinystr!(16, "saka")),
number: date.0.year,
cyclic: 0,
related_iso: None,
}
}
Expand All @@ -204,11 +205,13 @@ impl Calendar for Indian {
let prev_year = types::FormattableYear {
era: types::Era(tinystr!(16, "saka")),
number: date.0.year - 1,
cyclic: 0,
related_iso: None,
};
let next_year = types::FormattableYear {
era: types::Era(tinystr!(16, "saka")),
number: date.0.year + 1,
cyclic: 0,
related_iso: None,
};
types::DayOfYearInfo {
Expand Down
1 change: 1 addition & 0 deletions components/calendar/src/iso.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,6 +516,7 @@ impl Iso {
types::FormattableYear {
era: types::Era(tinystr!(16, "default")),
number: year,
cyclic: 0,
related_iso: None,
}
}
Expand Down
1 change: 1 addition & 0 deletions components/calendar/src/japanese.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,7 @@ impl Calendar for Japanese {
types::FormattableYear {
era: types::Era(date.era),
number: date.adjusted_year,
cyclic: 0,
related_iso: None,
}
}
Expand Down
1 change: 1 addition & 0 deletions components/calendar/src/persian.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,7 @@ impl Persian {
types::FormattableYear {
era: types::Era(tinystr!(16, "ah")),
number: year,
cyclic: 0,
related_iso: None,
}
}
Expand Down
10 changes: 6 additions & 4 deletions components/calendar/src/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,6 @@ impl FromStr for Era {
}

/// Representation of a formattable year.
///
/// More fields may be added in the future, for things like
/// the cyclic or extended year
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: we should probably keep the comment around for extended year

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added the comment back in

#[derive(Copy, Clone, Debug, PartialEq)]
#[non_exhaustive]
pub struct FormattableYear {
Expand All @@ -49,6 +46,10 @@ pub struct FormattableYear {
/// The year number in the current era (usually 1-based).
pub number: i32,

/// The year in the current cycle for cyclic calendars;
/// can be ignored and set to any value for non-cyclic calendars.
pub cyclic: i32,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: this should probably be an Option, allowing formatter implementations to choose how to handle unknown cyclics

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I made this an Option with all currently existing calendars having this field set to None


/// The related ISO year. This is normally the ISO (proleptic Gregorian) year having the greatest
/// overlap with the calendar year. It is used in certain date formatting patterns.
///
Expand All @@ -62,10 +63,11 @@ impl FormattableYear {
///
/// Other fields can be set mutably after construction
/// as needed
pub fn new(era: Era, number: i32) -> Self {
pub fn new(era: Era, number: i32, cyclic: i32) -> Self {
Self {
era,
number,
cyclic,
related_iso: None,
}
}
Expand Down