Replace Date::day_of_week by Date::weekday (#7288)

#7228

Also replace other usages of "day of week" that are not the numeric day
of the week (pretty much all of them).

Author: robertbastian

components/calendar/README.md

@@ -21,7 +21,7 @@ struct FuzzInput {
 fuzz_target!(|data: FuzzInput| {
     if let Some(date) = data.ymd.to_date(data.cal, data.overflow_constrain) {
         let _ = date.day_of_month();
-        let _ = date.day_of_week();
+        let _ = date.weekday();
         let _ = date.day_of_year();
         let _ = date.days_in_month();
         let _ = date.days_in_year();

components/calendar/fuzz/fuzz_targets/construction.rs

@@ -365,8 +365,8 @@ impl Date<Hebrew> {
 
 #[cfg(test)]
 mod tests {
-
     use super::*;
+    use crate::types::Weekday;
 
     pub const TISHREI: Month = Month::new(1);
     pub const ḤESHVAN: Month = Month::new(2);
@@ -508,6 +508,6 @@ mod tests {
 
         // Should be Saturday per:
         // https://www.hebcal.com/converter?hd=1&hm=Tishrei&hy=3760&h2g=1
-        assert_eq!(6, dt.day_of_week() as usize);
+        assert_eq!(dt.weekday(), Weekday::Saturday);
     }
 }

components/calendar/src/cal/hebrew.rs

@@ -200,20 +200,20 @@ mod test {
     }
 
     #[test]
-    fn test_day_of_week() {
+    fn test_weekday() {
         // June 23, 2021 is a Wednesday
         assert_eq!(
-            Date::try_new_iso(2021, 6, 23).unwrap().day_of_week(),
+            Date::try_new_iso(2021, 6, 23).unwrap().weekday(),
             Weekday::Wednesday,
         );
         // Feb 2, 1983 was a Wednesday
         assert_eq!(
-            Date::try_new_iso(1983, 2, 2).unwrap().day_of_week(),
+            Date::try_new_iso(1983, 2, 2).unwrap().weekday(),
             Weekday::Wednesday,
         );
         // Jan 21, 2021 was a Tuesday
         assert_eq!(
-            Date::try_new_iso(2020, 1, 21).unwrap().day_of_week(),
+            Date::try_new_iso(2020, 1, 21).unwrap().weekday(),
             Weekday::Tuesday,
         );
     }

components/calendar/src/cal/iso.rs

@@ -243,16 +243,69 @@ impl<A: AsCalendar> Date<A> {
         Date { inner, calendar }
     }
 
-    /// The number of months in the year of this date.
+    /// The day-of-month of this date.
     #[inline]
-    pub fn months_in_year(&self) -> u8 {
-        self.calendar.as_calendar().months_in_year(self.inner())
+    pub fn day_of_month(&self) -> types::DayOfMonth {
+        self.calendar.as_calendar().day_of_month(&self.inner)
     }
 
-    /// The number of days in the year of this date.
+    /// The day-of-year of this date.
     #[inline]
-    pub fn days_in_year(&self) -> u16 {
-        self.calendar.as_calendar().days_in_year(self.inner())
+    pub fn day_of_year(&self) -> types::DayOfYear {
+        self.calendar.as_calendar().day_of_year(&self.inner)
+    }
+
+    /// The weekday of this date.
+    #[inline]
+    pub fn weekday(&self) -> types::Weekday {
+        self.to_rata_die().into()
+    }
+
+    /// The weekday of this date.
+    ///
+    /// This is *not* the day of the week, an ordinal number that is locale
+    /// dependent.
+    #[deprecated(since = "2.2.0", note = "use `Date::weekday")]
+    pub fn day_of_week(&self) -> types::Weekday {
+        self.to_rata_die().into()
+    }
+
+    /// The month of this date.
+    #[inline]
+    pub fn month(&self) -> types::MonthInfo {
+        self.calendar.as_calendar().month(&self.inner)
+    }
+
+    /// The year of this date.
+    ///
+    /// This returns an enum, see [`Date::era_year()`] and [`Date::cyclic_year()`] which are available
+    /// for concrete calendar types and return concrete types.
+    #[inline]
+    pub fn year(&self) -> types::YearInfo {
+        self.calendar.as_calendar().year_info(&self.inner).into()
+    }
+
+    /// The "extended year" of this date.
+    ///
+    /// This year number can be used when you need a simple numeric representation
+    /// of the year, and can be meaningfully compared with extended years from other
+    /// eras or used in arithmetic.
+    ///
+    /// For calendars defined in Temporal, this will match the "arithmetic year"
+    /// as defined in <https://tc39.es/proposal-intl-era-monthcode/>.
+    /// This is typically anchored with year 1 as the year 1 of either the most modern or
+    /// otherwise some "major" era for the calendar.
+    ///
+    /// See [`Self::year()`] for more information about the year.
+    #[inline]
+    pub fn extended_year(&self) -> i32 {
+        self.year().extended_year()
+    }
+
+    /// Whether this date is in a leap year.
+    #[inline]
+    pub fn is_in_leap_year(&self) -> bool {
+        self.calendar.as_calendar().is_in_leap_year(&self.inner)
     }
 
     /// The number of days in the month of this date.
@@ -261,10 +314,16 @@ impl<A: AsCalendar> Date<A> {
         self.calendar.as_calendar().days_in_month(self.inner())
     }
 
-    /// The day of the week of this date.
+    /// The number of days in the year of this date.
     #[inline]
-    pub fn day_of_week(&self) -> types::Weekday {
-        self.to_rata_die().into()
+    pub fn days_in_year(&self) -> u16 {
+        self.calendar.as_calendar().days_in_year(self.inner())
+    }
+
+    /// The number of months in the year of this date.
+    #[inline]
+    pub fn months_in_year(&self) -> u8 {
+        self.calendar.as_calendar().months_in_year(self.inner())
     }
 
     /// Add a `duration` to this date, mutating it
@@ -359,56 +418,6 @@ impl<A: AsCalendar> Date<A> {
             .until(self.inner(), other.inner(), options)
     }
 
-    /// The year of this date.
-    ///
-    /// This returns an enum, see [`Date::era_year()`] and [`Date::cyclic_year()`] which are available
-    /// for concrete calendar types and return concrete types.
-    #[inline]
-    pub fn year(&self) -> types::YearInfo {
-        self.calendar.as_calendar().year_info(&self.inner).into()
-    }
-
-    /// The "extended year" of this date.
-    ///
-    /// This year number can be used when you need a simple numeric representation
-    /// of the year, and can be meaningfully compared with extended years from other
-    /// eras or used in arithmetic.
-    ///
-    /// For calendars defined in Temporal, this will match the "arithmetic year"
-    /// as defined in <https://tc39.es/proposal-intl-era-monthcode/>.
-    /// This is typically anchored with year 1 as the year 1 of either the most modern or
-    /// otherwise some "major" era for the calendar.
-    ///
-    /// See [`Self::year()`] for more information about the year.
-    #[inline]
-    pub fn extended_year(&self) -> i32 {
-        self.year().extended_year()
-    }
-
-    /// Whether this date is in a leap year.
-    #[inline]
-    pub fn is_in_leap_year(&self) -> bool {
-        self.calendar.as_calendar().is_in_leap_year(&self.inner)
-    }
-
-    /// The month of this date.
-    #[inline]
-    pub fn month(&self) -> types::MonthInfo {
-        self.calendar.as_calendar().month(&self.inner)
-    }
-
-    /// The day-of-month of this date.
-    #[inline]
-    pub fn day_of_month(&self) -> types::DayOfMonth {
-        self.calendar.as_calendar().day_of_month(&self.inner)
-    }
-
-    /// The day-of-month of this date.
-    #[inline]
-    pub fn day_of_year(&self) -> types::DayOfYear {
-        self.calendar.as_calendar().day_of_year(&self.inner)
-    }
-
     /// Construct a date from raw values for a given calendar. This does not check any
     /// invariants for the date and calendar, and should only be called by calendar implementations.
     ///
@@ -483,7 +492,7 @@ impl Date<Iso> {
                     as u16,
                 self.days_in_year(),
                 self.day_of_year().0,
-                self.day_of_week(),
+                self.weekday(),
             )
             .unwrap_or_else(|_| {
                 // ISO calendar has more than 14 days per year
@@ -648,20 +657,20 @@ mod tests {
     }
 
     #[test]
-    fn test_day_of_week() {
+    fn test_weekday() {
         // June 23, 2021 is a Wednesday
         assert_eq!(
-            Date::try_new_iso(2021, 6, 23).unwrap().day_of_week(),
+            Date::try_new_iso(2021, 6, 23).unwrap().weekday(),
             Weekday::Wednesday,
         );
         // Feb 2, 1983 was a Wednesday
         assert_eq!(
-            Date::try_new_iso(1983, 2, 2).unwrap().day_of_week(),
+            Date::try_new_iso(1983, 2, 2).unwrap().weekday(),
             Weekday::Wednesday,
         );
         // Jan 21, 2021 was a Tuesday
         assert_eq!(
-            Date::try_new_iso(2020, 1, 21).unwrap().day_of_week(),
+            Date::try_new_iso(2020, 1, 21).unwrap().weekday(),
             Weekday::Tuesday,
         );
     }

components/calendar/src/date.rs

@@ -26,7 +26,7 @@
 /// let mut date_iso = Date::try_new_iso(1992, 9, 2)
 ///     .expect("Failed to initialize ISO Date instance.");
 ///
-/// assert_eq!(date_iso.day_of_week(), Weekday::Wednesday);
+/// assert_eq!(date_iso.weekday(), Weekday::Wednesday);
 /// assert_eq!(date_iso.era_year().year, 1992);
 /// assert_eq!(date_iso.month().ordinal, 9);
 /// assert_eq!(date_iso.day_of_month().0, 2);

components/calendar/src/duration.rs

@@ -33,7 +33,7 @@
 //! let mut date_iso = Date::try_new_iso(1992, 9, 2)
 //!     .expect("Failed to initialize ISO Date instance.");
 //!
-//! assert_eq!(date_iso.day_of_week(), Weekday::Wednesday);
+//! assert_eq!(date_iso.weekday(), Weekday::Wednesday);
 //! assert_eq!(date_iso.era_year().year, 1992);
 //! assert_eq!(date_iso.month().ordinal, 9);
 //! assert_eq!(date_iso.day_of_month().0, 2);

components/calendar/src/lib.rs

@@ -8,7 +8,7 @@ fn check_continuity<A: AsCalendar>(mut date: Date<A>, years_to_check: usize) {
     let duration = DateDuration::for_days(1);
 
     let mut rata_die = date.to_rata_die();
-    let mut weekday = date.day_of_week();
+    let mut weekday = date.weekday();
     let mut year = date.year();
     let mut is_in_leap_year = date.is_in_leap_year();
 
@@ -18,7 +18,7 @@ fn check_continuity<A: AsCalendar>(mut date: Date<A>, years_to_check: usize) {
             .unwrap();
         let next_rata_die = next_date.to_iso().to_rata_die();
         assert_eq!(next_rata_die, rata_die + 1, "{next_date:?}");
-        let next_weekday = next_date.day_of_week();
+        let next_weekday = next_date.weekday();
         let next_year = next_date.year();
         let next_is_in_leap_year = next_date.is_in_leap_year();
         assert_eq!(

components/calendar/src/tests/continuity_test.rs

@@ -103,11 +103,11 @@ impl WeekCalculator {
         num_days_in_previous_unit: u16,
         num_days_in_unit: u16,
         day: u16,
-        week_day: Weekday,
+        weekday: Weekday,
     ) -> Result<WeekOf, RangeError> {
         let current = UnitInfo::new(
             // The first day of this month/year is (day - 1) days from `day`.
-            add_to_weekday(week_day, 1 - i32::from(day)),
+            add_to_weekday(weekday, 1 - i32::from(day)),
             num_days_in_unit,
         )?;
 
@@ -465,7 +465,7 @@ mod tests {
             u16::from(previous_month.days_in_month()),
             u16::from(date.days_in_month()),
             u16::from(day),
-            date.day_of_week(),
+            date.weekday(),
         )
     }
 

components/calendar/src/week.rs

@@ -117,16 +117,16 @@ pub enum DateFields {
     /// The year, month, and day of the month, as in
     /// “January 1st, 2000”.
     YMD,
-    /// The day of the month and day of the week, as in
+    /// The day of the month and weekday, as in
     /// “Saturday 1st”.
     DE,
-    /// The month, day of the month, and day of the week, as in
+    /// The month, day of the month, and weekday, as in
     /// “Saturday, January 1st”.
     MDE,
-    /// The year, month, day of the month, and day of the week, as in
+    /// The year, month, day of the month, and weekday, as in
     /// “Saturday, January 1st, 2000”.
     YMDE,
-    /// The day of the week alone, as in
+    /// The weekday alone, as in
     /// “Saturday”.
     E,
     /// A standalone month, as in