Date/Time Natural Language Approximation in Swift

Question

I am attempting to convert a UTC formatted date from an API to a human-readable approximation format using Swift.

I'm looking for something like the following:

2015-07-14T13:51:05.423Z

to

About two weeks ago

What is the best approach to this in Swift? While optimally this could format strings directly, I understand that this will probably require casting the string to a NSDate object.

Any help would be greatly appreciated.

EDIT: My question had been identified as a possible duplicate of another question. Tom's solution below is written for Swift and much more elegant than creating a new method in regards to my situation.

Check out https://github.com/kevinlawler/NSDate-TimeAgo or http://stackoverflow.com/questions/902950/iphone-convert-date-string-to-a-relative-time-stamp. — jtbandes, Jul 28 '15 at 20:22
try https://github.com/quire-io/SwiftyChrono, it's even powerful than just ago pattern and written in Swift. — Jerry Chen, Mar 02 '17 at 07:14

Tom Harrington · Accepted Answer · 2015-07-29T02:49:26.387

32

You need two steps. First, convert your date string to an NSDate:

let dateString = "2015-07-14T13:51:05.423Z"

let df = NSDateFormatter()
df.dateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSSZ"
let date = df.dateFromString(dateString)

(If that's not an exact representation of the strings you get, you'll have to change the date format string to get this to convert).

Next, use NSDateComponentsFormatter to get your desired string:

let formatter = NSDateComponentsFormatter()
formatter.unitsStyle = NSDateComponentsFormatterUnitsStyle.Full
formatter.includesApproximationPhrase = true
formatter.includesTimeRemainingPhrase = false
formatter.allowedUnits = NSCalendarUnit.WeekOfMonthCalendarUnit

if let pastDate = date {
    let dateRelativeString = formatter.stringFromDate(pastDate, toDate: NSDate())
}

Today is July 28, so the result for that string is "About 2 weeks". The allowedUnits attribute is a bit field, so you can specify as many unit types as you want to allow.

edited Jul 29 '15 at 02:49

answered Jul 29 '15 at 02:21

Tom Harrington

69,312
10
146
170

1

Thanks Tom, the solution worked great! I made a couple of modifications to fit my needs. First I changed the allowedUnits to `[.Year, .Month, .WeekOfMonth, .Day, .Hour, .Minute, .Second]` and then added `formatter.maximumUnitCount = 1`, which seems to produce the best "natural approximation" result. EDIT: Just noting that my NSCalendarUnit array reflects Swift 2 usage – Tyler Jul 29 '15 at 03:36
5

One thing that should be noted if you use this repeatedly (i.e. on a table view cell) is that creating the date formatter cost a bit of CPU, so it would be handy to keep one date formatter to be reused around (e.g. create it in viewDidLoad). – Enrico Susatyo Jul 29 '15 at 04:58
It would be great to know how this compares with TTTTimeIntervalFormatter, from FormatterKit, which is quite widely used. – algal Jul 30 '15 at 02:22

algal · Answer 2 · 2015-08-13T20:33:22.540

As Tom Harrington's answer notes, you can produce a colloquial representation of a moment or a time interval using NSDateComponentsFormatter.

However, if you want to do exactly what the question asks in its example, which is to produce a colloquial representation of a moment in the past, relative to the present moment, like for a timeline-oriented UI, then it seems like NSDateComponentsFormatter is not suitable. As the documentation for stringFromTimeInterval(_:) says, the time interval value "must be a finite number. Negative numbers are treated as positive numbers when creating the string."

As near as I can tell, the best choice is TTTTimeIntervalFormatter, a standalone class in Mattt Thompson's FormatterKit.

I have produced an Xcode 7 playground, RelativeDatePlayground, that compares the outputs of NSDateFormatter output to TTTTimeIntervalFormatter. Here is a table showing output for different relative times in seconds. As you can see, NSDateComponentsFormatter does not seem to handle past moments or the present moment well:

        -1488010 |               2 weeks ago |         -1 week remaining
        -1468800 |               2 weeks ago |         -1 week remaining
         -864000 |                1 week ago |       0 seconds remaining
          -86400 |                 1 day ago |          -1 day remaining
          -36000 |              10 hours ago |       -10 hours remaining
           -3600 |                1 hour ago |         -1 hour remaining
            -600 |            10 minutes ago |     -10 minutes remaining
             -60 |              1 minute ago |       -1 minute remaining
             -10 |            10 seconds ago |     -10 seconds remaining
              -1 |              1 second ago |       -1 second remaining
              -0 |                  just now |       0 seconds remaining
               0 |                  just now |       0 seconds remaining
               1 |         1 second from now |        1 second remaining
              10 |       10 seconds from now |      10 seconds remaining
              60 |         1 minute from now |        1 minute remaining
             600 |       10 minutes from now |      10 minutes remaining
            3600 |           1 hour from now |          1 hour remaining
           36000 |         10 hours from now |        10 hours remaining
           86400 |            1 day from now |           1 day remaining
          864000 |           1 week from now |          1 week remaining
         1468800 |          2 weeks from now |         2 weeks remaining
         1488010 |          2 weeks from now |         2 weeks remaining

score 0 · Answer 3 · answered Dec 29 '20 at 19:08

Since iOS 13 / macOS 10.15 you can use RelativeDateTimeFormatter. Thanks @mattt for putting this on your archived Github README.

import Foundation

let formatter = RelativeDateTimeFormatter()
formatter.formattingContext = .beginningOfSentence

let date = Date().addingTimeInterval(-67 * 60)
formatter.string(for: date)! // => "1 hour ago"

Date/Time Natural Language Approximation in Swift

3 Answers3

Linked