element-x-ios/ElementX/Sources/Other/Extensions/Date.swift

//
// Copyright 2025 Element Creations Ltd.
// Copyright 2023-2025 New Vector Ltd.
//
// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
// Please see LICENSE files in the repository root for full details.
//

import Foundation

extension Date {
    /// The date formatted with the minimal necessary units given how long ago it occurred.
    nonisolated func formattedMinimal() -> String {
        let calendar = Calendar.current
        
        if calendar.isDateInToday(self) {
            // Just the time if it was today.
            return formatted(date: .omitted, time: .shortened)
        } else if calendar.isDateInYesterday(self) {
            // Simply "Yesterday" if it was yesterday.
            guard let yesterday = Calendar.current.date(byAdding: .day, value: -1, to: Date()) else { fatalError() }
            return yesterday.formatted(Date.RelativeFormatStyle(presentation: .named, capitalizationContext: .beginningOfSentence))
        } else if let sixDaysAgo = calendar.date(byAdding: .day, value: -6, to: calendar.startOfDay(for: .now)),
                  sixDaysAgo <= self {
            // The named day if it was in the last 6 days.
            return formatted(.dateTime.weekday(.wide))
        } else if let oneYearAgo = calendar.date(byAdding: .year, value: -1, to: .now),
                  oneYearAgo <= self {
            // The day and month if it was in the past year
            return formatted(.dateTime.day().month())
        } else {
            // The day, month and year if it is any older.
            return formatted(.dateTime.year().day().month())
        }
    }
    
    /// The date of an expiration formatted with the minimal necessary units given how long in the future it is.
    nonisolated func formattedExpiration() -> String {
        let calendar = Calendar.current
        let now = Date.now
        
        guard let tomorrow = calendar.date(byAdding: .hour, value: 24, to: now),
              let oneYearFromNow = calendar.date(byAdding: .year, value: 1, to: now) else {
            return formatted(date: .omitted, time: .shortened)
        }
        
        if self < tomorrow {
            return formatted(date: .omitted, time: .shortened)
        } else if self < oneYearFromNow {
            return formatted(.dateTime.day().month())
        } else {
            return formatted(.dateTime.year())
        }
    }
    
    /// Similar to ``formattedMinimal`` but returning "Today" instead of the time and
    /// including the year when it the date is from a previous year (rather than over a year ago).
    func formattedDateSeparator() -> String {
        let calendar = Calendar.current
        
        if calendar.isDateInToday(self) || calendar.isDateInYesterday(self) {
            // Simply "Today" or "Yesterday" if it was today or yesterday.
            return DateFormatter.relative.string(from: self)
        } else if let sixDaysAgo = calendar.date(byAdding: .day, value: -6, to: calendar.startOfDay(for: .now)),
                  sixDaysAgo <= self {
            // The named day if it was in the last 6 days.
            return formatted(.dateTime.weekday(.wide))
        } else if calendar.component(.year, from: self) == calendar.component(.year, from: .now) {
            // The day and month if it was this year.
            return formatted(.dateTime.weekday(.wide).day().month(.wide))
        } else {
            // The day, month and year if it is any older.
            return formatted(.dateTime.weekday(.wide).day().month(.wide).year())
        }
    }
    
    /// The date formatted as just the time, for use in timeline items specifically.
    nonisolated func formattedTime() -> String {
        formatted(date: .omitted, time: .shortened)
    }
    
    /// A fixed date used for mocks, previews etc.
    nonisolated static var mock: Date {
        DateComponents(calendar: .current, year: 2007, month: 1, day: 9, hour: 9, minute: 41).date ?? .now
    }
}

private extension DateFormatter {
    /// There doesn't appear to be a way to get "Today" out of
    /// `Date.RelativeFormatStyle` so use the old way instead 😐
    static let relative: DateFormatter = {
        let formatter = DateFormatter()
        formatter.doesRelativeDateFormatting = true
        formatter.dateStyle = .long
        formatter.timeStyle = .none
        return formatter
    }()
}