Add support for time zones

.swiftpm/xcode/xcshareddata/xcschemes/FrenchRepublicanCalendarCore.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1250"
+   LastUpgradeVersion = "1340"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

Sources/FrenchRepublicanCalendarCore/DecimalTime.swift

@@ -69,7 +69,15 @@ public struct DecimalTime {
 public extension DecimalTime {
     /// Initializes a new DecimalTime with the current time
     init(base: Date = Date()) {
-        let midnight = Calendar.gregorian.startOfDay(for: base)
+        self.init(base: base, timeZone: nil)
+    }
+
+    init(base: Date = Date(), timeZone: TimeZone?) {
+        var GregorianCalendar: Calendar = Calendar.gregorian
+        if let timeZone = timeZone {
+            GregorianCalendar.timeZone = timeZone
+        }
+        let midnight = GregorianCalendar.startOfDay(for: base)
         self.init(timeSinceMidnight: base.timeIntervalSinceReferenceDate - midnight.timeIntervalSinceReferenceDate)
     }
 }

Sources/FrenchRepublicanCalendarCore/FrenchRepublicanDate+Formatting.swift

@@ -13,7 +13,7 @@
 import Foundation
 
 extension FrenchRepublicanDate: CustomDebugStringConvertible {
-    public static let allMonthNames = ["Vendémiaire", "Brumaire", "Frimaire", "Nivôse", "Pluviôse", "Ventôse", "Germinal", "Floréal", "Prairial", "Messidor", "Thermidor", "Fructidor", "Sansculottide"]
+    public static let allMonthNames = ["Vendémiaire", "Brumaire", "Frimaire", "Nivôse", "Pluviôse", "Ventôse", "Germinal", "Floréal", "Prairial", "Messidor", "Thermidor", "Fructidor", "Sansculottides"]
     public static let sansculottidesDayNames = ["Jour de la vertu", "Jour du génie", "Jour du travail", "Jour de l'opinion", "Jour des récompenses", "Jour de la révolution"]
 
     public static let shortMonthNames = ["Vend.r", "Brum.r", "Frim.r", "Niv.ô", "Pluv.ô", "Vent.ô", "Germ.l", "Flo.l", "Prai.l", "Mes.or", "Ther.or", "Fru.or", "Ss.cu"]
@@ -40,15 +40,15 @@ extension FrenchRepublicanDate: CustomDebugStringConvertible {
 
     /// Returns string as d MMMM
     public func toLongStringNoYear() -> String {
-        if components.month == 13 {
+        if components.month == 13 && !self.options.treatSansculottidesAsAMonth {
             return "\(FrenchRepublicanDate.sansculottidesDayNames[components.day! - 1])"
         }
         return "\(components.day!) \(monthName)"
     }
 
     /// Returns string as d MMM
     public func toShortString() -> String {
-        if components.month == 13 {
+        if components.month == 13 && !self.options.treatSansculottidesAsAMonth {
             return "\(FrenchRepublicanDate.sansculottidesShortNames[components.day! - 1])"
         }
         return "\(components.day!) \(shortMonthName)"
@@ -132,16 +132,7 @@ extension FrenchRepublicanDate: CustomDebugStringConvertible {
     /// Returns the wiktionary or wikipedia page link associated with the day name.
     public var descriptionURL: URL? {
         let wikipediaOverrides = [
-            "Belle de nuit": "Mirabilis_jalapa",
-            "Amaryllis": "Amaryllis_(plante)",
-            "Erable sucré": "%C3%89rable_%C3%A0_sucre",
-            "Perce Neige": "Perce-neige",
-            "Laurier thym": "Viorne_tin",
-            "Thimèle": "Daphn%C3%A9_garou",
-            "Bâton d'or": "Girofl%C3%A9e_des_murailles",
-            "Chamerops": "Chamaerops_humilis",
-            "Épine vinette": "%C3%89pine-vinette",
-            "Verge d'or": "Solidago"
+            "Belle de nuit": "Mirabilis_jalapa", "Amaryllis": "Amaryllis_(plante)", "Erable sucré": "%C3%89rable_%C3%A0_sucre", "Perce Neige": "Perce-neige", "Laurier thym": "Viorne_tin", "Thimèle": "Daphn%C3%A9_garou", "Bâton d'or": "Girofl%C3%A9e_des_murailles", "Chamerops": "Chamaerops_humilis", "Épine vinette": "%C3%89pine-vinette", "Verge d'or": "Solidago"
         ]
         if let override = wikipediaOverrides[dayName] {
             return URL(string: "https://fr.wikipedia.org/wiki/\(override)")

Sources/FrenchRepublicanCalendarCore/FrenchRepublicanDate.swift

@@ -47,6 +47,8 @@ public struct FrenchRepublicanDate {
 
     public private(set) var options: FrenchRepublicanDateOptions
 
+    public var timeZone: TimeZone?
+
     // MARK: Component accessors
 
     /// The day in year date component, 1-indexed
@@ -64,6 +66,10 @@ public struct FrenchRepublicanDate {
     /// Creates a Republican Date from the given Gregorian Date
     /// - Parameter date: the Gregorian Date
     public init(date: Date, options: FrenchRepublicanDateOptions? = nil) {
+        self.init(date: date, options: options, timeZone: nil)
+    }
+
+    public init(date: Date, options: FrenchRepublicanDateOptions? = nil, timeZone: TimeZone?) {
         self.date = date
         if let options = options {
             self.options = options
@@ -72,6 +78,9 @@ public struct FrenchRepublicanDate {
         } else {
             self.options = .default
         }
+        if let timeZone = timeZone {
+            self.timeZone = timeZone
+        }
         dateToFrenchRepublican()
     }
 
@@ -84,20 +93,28 @@ public struct FrenchRepublicanDate {
     ///   - second: Seconds
     ///   - nanosecond: Nanoseconds
     public init(dayInYear: Int, year: Int, hour: Int? = nil, minute: Int? = nil, second: Int? = nil, nanosecond: Int? = nil, options: FrenchRepublicanDateOptions? = nil) {
+        self.init(dayInYear: dayInYear, year: year, hour: hour, minute: minute, second: second, nanosecond: nanosecond, options: options, timeZone: nil)
+    }
+
+    public init(dayInYear: Int, year: Int, hour: Int? = nil, minute: Int? = nil, second: Int? = nil, nanosecond: Int? = nil, options: FrenchRepublicanDateOptions? = nil, timeZone: TimeZone?) {
         if let options = options {
             self.options = options
         } else if let type = FrenchRepublicanDateOptions.self as? SaveableFrenchRepublicanDateOptions.Type {
             self.options = type.current
         } else {
             self.options = .default
         }
-        self.date = Date(dayInYear: dayInYear, year: year, hour: hour, minute: minute, second: second, nanosecond: nanosecond, options: self.options)
+        self.date = Date(dayInYear: dayInYear, year: year, hour: hour, minute: minute, second: second, nanosecond: nanosecond, options: self.options, timeZone: timeZone)
         initComponents(dayOfYear: dayInYear - 1, year: year, hour: hour, minute: minute, second: second, nanosecond: nanosecond)
     }
 
     /// Logic that converts the `date` value to republican date components. Called by the Gregorian > Republican constructor
     private mutating func dateToFrenchRepublican() {
-        let gregorian = Calendar.gregorian.dateComponents([.year, .month, .day, .hour, .minute, .second, .nanosecond], from: date)
+        var GregorianCalendar: Calendar = Calendar.gregorian
+        if self.timeZone != nil {
+            GregorianCalendar.timeZone = self.timeZone!
+        }
+        let gregorian = GregorianCalendar.dateComponents([.year, .month, .day, .hour, .minute, .second, .nanosecond], from: date)
 
         var year: Int
         var dayOfYear: Int
@@ -151,7 +168,7 @@ public struct FrenchRepublicanDate {
     public mutating func nextYear() {
         components.year! += 1
         components.yearForWeekOfYear! += 1
-        date = Date(dayInYear: dayInYear, year: components.year!, hour: components.hour, minute: components.minute, second: components.second, nanosecond: components.nanosecond, options: options)
+        date = Date(dayInYear: dayInYear, year: components.year!, hour: components.hour, minute: components.minute, second: components.second, nanosecond: components.nanosecond, options: options, timeZone: self.timeZone)
     }
 }
 
@@ -211,7 +228,15 @@ internal extension Date {
     ///   - nanosecond: Nanosecond, will directly be copied over
     /// - Note: Library users: use FrenchRepublicanDate.init(dayInYear: ...).date
     init(dayInYear: Int, year: Int, hour: Int?, minute: Int?, second: Int?, nanosecond: Int?, options: FrenchRepublicanDateOptions) {
-        self = Calendar.gregorian.date(from: Date.dateToGregorian(dayInYear: dayInYear, year: year, hour: hour, minute: minute, second: second, nanosecond: nanosecond, options: options))!
+        self.init(dayInYear: dayInYear, year: year, hour: hour, minute: minute, second: second, nanosecond: nanosecond, options: options, timeZone: nil)
+    }
+
+    init(dayInYear: Int, year: Int, hour: Int?, minute: Int?, second: Int?, nanosecond: Int?, options: FrenchRepublicanDateOptions, timeZone: TimeZone?) {
+        var GregorianCalendar: Calendar = Calendar.gregorian
+        if let timeZone = timeZone {
+            GregorianCalendar.timeZone = timeZone
+        }
+        self = GregorianCalendar.date(from: Date.dateToGregorian(dayInYear: dayInYear, year: year, hour: hour, minute: minute, second: second, nanosecond: nanosecond, options: options, timeZone: timeZone))!
     }
 }
 
@@ -226,6 +251,14 @@ fileprivate extension Date {
     ///   - nanosecond: Nanosecond, will directly be copied over
     /// - Returns: A DateComponents object containing the gregorian year and day of year, with the additional time components copied over.
     static func dateToGregorian(dayInYear rDayInYear: Int, year rYear: Int, hour: Int?, minute: Int?, second: Int?, nanosecond: Int?, options: FrenchRepublicanDateOptions) -> DateComponents {
+        Date.dateToGregorian(dayInYear: rDayInYear, year: rYear, hour: hour, minute: minute, second: second, nanosecond: nanosecond, options: options, timeZone: nil)
+    }
+
+        static func dateToGregorian(dayInYear rDayInYear: Int, year rYear: Int, hour: Int?, minute: Int?, second: Int?, nanosecond: Int?, options: FrenchRepublicanDateOptions, timeZone: TimeZone?) -> DateComponents {
+        var GregorianCalendar: Calendar = Calendar.gregorian
+        if let timeZone = timeZone {
+            GregorianCalendar.timeZone = timeZone
+        }
 
         var gYear: Int
         var gDayOfYear: Int
@@ -249,14 +282,14 @@ fileprivate extension Date {
             }
         case .romme:
             // hour: 10 avoids a timezone change issue on 1911-03-11 (9 minutes 21 seconds change)
-            let date = Calendar.gregorian.date(from: DateComponents(year: rYear + 2000, day: rDayInYear, hour: 10))!
-            let shifted = Calendar.gregorian.date(byAdding: .day, value: -76071, to: date)!
-            gYear = Calendar.gregorian.component(.year, from: shifted)
-            gDayOfYear = Calendar.gregorian.ordinality(of: .day, in: .year, for: shifted)! - 1
+            let date = GregorianCalendar.date(from: DateComponents(year: rYear + 2000, day: rDayInYear, hour: 10))!
+            let shifted = GregorianCalendar.date(byAdding: .day, value: -76071, to: date)!
+            gYear = GregorianCalendar.component(.year, from: shifted)
+            gDayOfYear = GregorianCalendar.ordinality(of: .day, in: .year, for: shifted)! - 1
             let remdays = (rYear - 1) / 4000
             gDayOfYear.increment(by: -remdays, year: &gYear, daysInYear: \.daysInGregorianYear)
         }
 
-        return DateComponents(calendar: Calendar.gregorian, year: gYear, day: gDayOfYear + 1, hour: hour, minute: minute, second: second, nanosecond: nanosecond)
+        return DateComponents(calendar: GregorianCalendar, year: gYear, day: gDayOfYear + 1, hour: hour, minute: minute, second: second, nanosecond: nanosecond)
     }
 }

Sources/FrenchRepublicanCalendarCore/FrenchRepublicanDateOptions.swift

@@ -18,9 +18,17 @@ public struct FrenchRepublicanDateOptions {
     public var romanYear: Bool
     public var variant: Variant
 
+    /// If true, formatted dates in Sansculottides are things like "1 Sansculottides" instead of a holiday name.
+    public var treatSansculottidesAsAMonth: Bool
+
     public init(romanYear: Bool, variant: Variant) {
+        self.init(romanYear: romanYear, variant: variant, treatSansculottidesAsAMonth: false)
+    }
+
+    public init(romanYear: Bool, variant: Variant, treatSansculottidesAsAMonth: Bool) {
         self.romanYear = romanYear
         self.variant = variant
+        self.treatSansculottidesAsAMonth = treatSansculottidesAsAMonth
     }
 
     public enum Variant: Int, CaseIterable {