GLDates

GLDates is a small library of date utilities written in Swift to handle several of the common date operations. It is implemented as an extension on NSDate.


Requirements

• A version of Xcode (7.x) capable of building the project you wish to document.
• iOS 8.x, Swift 1.2 or 2.0

##Installation

####Carthage

github "mrkeithelliott/GLDates" ~> 0.2

Usage

####Import GLDates module

import GLDates

Date operations

// Getting yesterday
let yesterday = NSDate.yesterday()   

// Getting Last Year
let today = NSDate()
let lastYear = today.previousDate(1, monthsBack: 0, daysBack: 0)

// Getting Last month
let lastMonth = today.previousDate(0, monthsBack: 1, daysBack: 0)

// Getting the first day of the month
let firstOfMonth = NSDate().firstOfMonth()

// Getting the last day of the month, given a starting date
let lastDayOfCurrentMonth = today.lastDayOfMonth()
let lastDayOfLastMonth = lastMonth.lastDayOfMonth()

// Getting the first day of the year
let firstOfYear = lastYear.firstOfYear()

// Getting the last day of the year
let lastDayOfCurrentYear = today.lastDayOfYear()
let lastDayOfLastYear = lastYear.lastDayOfYear()

Social Date Formatting

 let _5hours: NSTimeInterval = Double(60 * 60 * -5)
        
 var date = NSDate(timeInterval: _5hours, sinceDate: today)
 var dateString = date.formattedSocialTime()
 // prints "5 hours ago"

let _10hours: NSTimeInterval = Double(60 * 60 * -10)
date = NSDate(timeInterval:_10hours, sinceDate: today)
dateString = date.formattedSocialTime()
// prints "today"

let _30mins: NSTimeInterval = Double(60 * -30)
date = NSDate(timeInterval: _30mins, sinceDate: today)
dateString = date.formattedSocialTime()
// prints "30 mins ago"

let _30seconds: NSTimeInterval = Double(-30)
date = NSDate(timeInterval:_30seconds, sinceDate: today)
dateString = date.formattedSocialTime()
// prints "30 seconds ago"

let _5seconds: NSTimeInterval = Double(-5)
date = NSDate(timeInterval:_5seconds, sinceDate: today)
dateString = date.formattedSocialTime()
// prints "moments ago"

Finding the Next Date Using Patterns

You can use:

func nextDateSkippingDays(daysBetween: Int, currentDate: NSDate)->NSDate

on an NSDate to find the next date that is closes to the passed in current date, while adhering to a repeat policy. For example, if you have a repeating date from last month (repeats every 3 days) and you want to find the date that is closest to the current date while following the repeating schedule, you can accomplish this with the nextDateSkippingDays()

There are also methods that will allow you to skip weeks and months to accomplish similar tasks.

func nextDateSkippingWeeks(weeksBetween: Int, currentDate: NSDate)->NSDate
func nextDateSkippingMonths(monthsBetween: Int, currentDate: NSDate)->NSDate

Another series of methods will return you the array of dates that follow the pattern from the initial date up to the closest date passed in as the current date.

func getDatesSkippingDays(daysBetween: Int, currentDate: NSDate, currentlist: [NSDate]? = nil)->[NSDate]?
func getDatesSkippingWeeks(weeksBetween: Int, currentDate: NSDate, currentlist: [NSDate]? = nil)->[NSDate]?
func getDatesSkippingMonths(monthsBetween: Int, currentDate: NSDate, currentlist: [NSDate]? = nil)->[NSDate]?

Example Usage

let today = NSDate()
today.dateWithNoTime()
//prints "Jan 8, 2016, 12:00 AM"

let cal = NSCalendar.currentCalendar()
let _5daysAgo = cal.dateByAddingUnit(.Day, value: -5, toDate: today, options: .MatchStrictly)
// prints "Jan 3, 2016, 9:15 AM"

let nextDate = _5daysAgo!.nextDateSkippingDays(2, currentDate: today)
// prints "Jan 9, 2016, 12:00 AM"

let nextDates = _5daysAgo!.getDatesSkippingDays(2, currentDate: today)
// prints [["Jan 5, 2016, 12:00 AM", "Jan 7, 2016, 12:00 AM"]

License

The MIT License (MIT)

Copyright © 2016 GittieLabs

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

This project is released under the MIT license.