Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dankinsoid/VDDate
Robust set of extensions for the Date struct
https://github.com/dankinsoid/VDDate
date datecomponents foundation swift
Last synced: 11 days ago
JSON representation
Robust set of extensions for the Date struct
- Host: GitHub
- URL: https://github.com/dankinsoid/VDDate
- Owner: dankinsoid
- License: mit
- Created: 2023-08-12T08:00:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-03T08:35:22.000Z (2 months ago)
- Last Synced: 2024-09-16T16:02:55.201Z (about 2 months ago)
- Topics: date, datecomponents, foundation, swift
- Language: Swift
- Homepage:
- Size: 82 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VDDate 📆
VDDate is a Swift library that offers a robust set of extensions for the Date struct, enhancing its capabilities and making date manipulation in Swift more intuitive and powerful.
## Features
### Date
- Convenience `Date.init`s with components parameters year, month, day etc.
- Convenience `Date.init`s from string with format.
- Static computed property `Date.now` that can be mocked if needed. It's recommended to use `Date.now` instead of `Date()`.
- Helper vars: `iToday`, `isTomorrow`, `isYesterday`, `iso8601`.
- var `components`, var for each component: `day`, `month`, `year` etc, mutating subscript with `Calendar.Component`.
- `start(of: Calendar.Component) -> Date`.
- `end(of: Calendar.Component) -> Date`.
- `matches(DateComponents) -> Bool`.
- `isInSame(Calendar.Component) -> Bool`.
- `isCurrent(Calendar.Component) -> Bool`
- `isEqual(to: Date, toGranularity: Calendar.Component) -> Bool`.
- `number(of: Calendar.Component, from: Date) -> Int`
- `numbers(of components: Set, from: Date) -> DateComponents`
- `components(_ components: Set, from: Date) -> DateComponents`
- `range(of: Calendar.Component, in: Calendar.Component) -> Range` - range of component, for example `range(of: .day, in: .month)` returns smth like `1..<32`.
- `interval(byAdding: DateComponents) -> DateInterval`
- `interval(of: Calendar.Component, in: Calendar.Component) -> DateInterval`
- `number(of: Calendar.Component) -> Int`
- `number(of: Calendar.Component, in: Calendar.Component) -> Int`
- `DateFormat` struct with predefined format components.
- `string(DateFormat) -> String` Note: Deprecated since iOS 15.0 in favor of `formatted(FormatStyle)`.
- `string(date: DateFormatter.Style, time: DateFormatter.Style) -> String` Note: Deprecated since iOS 15.0 in favor of `formatted(FormatStyle)`.
- `string(format: RelativeDateFormat)` - method for converting formatting date relative to current (or any other) date. Note: Deprecated since iOS 15.0 in favor of `formatted(RelativeDateFormatStyle)`
- `formatted(RelativeDateFormatStyle)`
- `name(of: Calendar.Component) -> String`
- `ordinality(of: Calendar.Component, in: Calendar.Component) -> Int?` and convenience methods for each component like `day(in: Calendar.Component)`.
- Minus operator for date returns TimeInterval.
- `adding(DateComponents) -> Date`
- `adding(Int, Calendar.Component) -> Date`
- `setting(DateComponents) -> Date`
- `setting(Int, Calendar.Component) -> Date`
- `compare(with: Date, toGranularity: Calendar.Component) -> ComparasionResult`
- `nextWeekend(direction: Calendar.SearchDirection) -> DateInterval?`
- `next(Calendar.Component, direction: Calendar.SearchDirection) -> Date`
- `nearest(DateComponents) -> Date?`
- `rounded(Calendar.Component, by: Int) -> Date` date rounded by some component, useful when you deal with regular time intervals.
#### Note
All methods accept a `Calendar` parameter and, in some cases, `TimeZone` or `Locale`.\
I've introduced static variables: `Calendar.default`, `TimeZone.default`, and `Locale.default`.\
These variables serve as the default values for each respective method. You can modify each `default` variable either globally or specifically for a given method.
Overload for `Calendar` parameter globally:
```swift
Calendar.bootstrap(default: Calendar(identifier: .gregorian))
```
Use `Calendar` parameter for a specific method:
```swift
date.start(of: .day, calendar: Calendar(identifier: .gregorian))
```
Tip: You can use `TaskLocal` to set the default value for a specific task and it's subtasks.
```swift
extension Calendar {
@TaskLocal
static var local: Calendar = .autoupdatingCurrent
}
Calendar.bootstrap(default: .local)
Calendar.$local.withValue(Calendar(identifier: .gregorian)) {
print(Date.now.start(of: .day))
}
```
### TimeInterval
- `DatesCollection` struct and function `each(Int, Calendar.Component) -> DatesCollection`.
### DateComponents
- Arithmetic operators: +, - between `DateComponents`, +, -, /, * between `DateComponents` and `Int`, +, - between `DateComponents` and `Date`.
- Convenience static methods for each component like `.day(3)`.
- Extensions on `BinaryInteger` like `2.days`, so now it possible to write `date + 2.days`.
- `DateComponents` now is expressible by dictionary literal like `[.day: 2, .month: 1]`
- mutating subscript with `Calendar.Components`.
- `rawValue: [Calendar.Component: Int]` - dictionary with components.
## Installation
1. [Swift Package Manager](https://github.com/apple/swift-package-manager)
Create a `Package.swift` file.
```swift
// swift-tools-version:5.7
import PackageDescription
let package = Package(
name: "SomeProject",
dependencies: [
.package(url: "https://github.com/dankinsoid/VDDate.git", from: "0.14.0")
],
targets: [
.target(name: "SomeProject", dependencies: ["VDDate"])
]
)
```
```ruby
$ swift build
```
## Author
dankinsoid, [email protected]
## License
VDDate is available under the MIT license. See the LICENSE file for more info.