Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/designedbyclowns/GeoURI
A Swift implementation of the geo URI scheme.
https://github.com/designedbyclowns/GeoURI
Last synced: 13 days ago
JSON representation
A Swift implementation of the geo URI scheme.
- Host: GitHub
- URL: https://github.com/designedbyclowns/GeoURI
- Owner: designedbyclowns
- License: unlicense
- Created: 2023-12-26T18:17:26.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-06-30T14:04:43.000Z (5 months ago)
- Last Synced: 2024-07-04T12:35:24.703Z (4 months ago)
- Language: Swift
- Size: 45.9 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/designedbyclowns/GeoURI/releases)
[](https://swiftpackageindex.com/designedbyclowns/GeoURI)
[](https://swiftpackageindex.com/designedbyclowns/GeoURI)
[](https://swift.org/package-manager)
[](LICENSE)
# GeoURI
A Swift implementation of the geo URI scheme.
The geo URI scheme is a Uniform Resource Identifier (URI) scheme defined by the Internet Engineering Task Force's [RFC 5870](https://datatracker.ietf.org/doc/html/rfc5870).
A 'geo' URI identifies a physical location in a two- or three-dimensional
coordinate reference system in a compact, simple, human-readable, and
protocol-independent way.
## Requirements
iOS 16, macOS 10.13, tvOS 16, watchOS 9
## Installation
This package is available via [Swift Package Manager](https://www.swift.org/package-manager/).
To install it, simply add the repo URL to your project in the usual way, and `import GeoURI` where needed.
## Usage
A `GeoURI` type can be created from its constituent components (latitude, longitude, and an optional altitude), or from a URL that conforms the [geo URI scheme](https://datatracker.ietf.org/doc/html/rfc5870).
There are also CoreLocation extension to initialize a `GeoURI` from a `CLLocation` or `CLLocationCoordinate2D`.
An error will be thrown if any of the properties do not meet the specification.
See the [documentation](#documentation) for a complete reference.
### Creating a GeoURI
```swift
import GeoURI
let geoURI = try? GeoURI(latitude: 48.2010, longitude: 16.3695, altitude: 183)
let urlString = geoURI?.url.absoluteString // "geo:48.201,16.3695,183?crs=wgs84"
```
### Create a GeoURI from a URL
```swift
import GeoURI
if let let url = URL(string: "geo:-48.876667,-123.393333") {
let geoURI = try? GeoURI(url: url)
}
```
### Create a GeoURI from a String
```swift
import GeoURI
let geoURI = try GeoURI("geo:48.201,16.3695", format: GeoURI.FormatStyle)
```
### Create a String from a GeoURI
```swift
geoURI.formatted() // "geo:48.201,16.3695"
geoURI.formatted(.full) // "geo:48.201,16.3695;crs=wgs84"
```
### CoreLocation
```swift
import CoreLocation
import GeoURI
let coordinate = CLLocationCoordinate2D(latitude: 48.2010, longitude: 16.3695)
let geoURI = try? GeoURI(coordinate: coordinate)
let urlString = geoURI?.url.absoluteString // "geo:48.2010,16.3695?crs=wgs84"
```
### Handling errors
```swift
import GeoURI
if let url = URL(string: "geo:-48.876667,-123.393333") {
do {
let geoURI = try GeoURI(url: url)
} catch GeoURIParsingError {
print("A parsing error occurred: \(parsingError.errorDescription)")
}
}
```
## Documentation
Documentation of this package is provided via a [DocC](https://www.swift.org/documentation/docc/) documentation catalog.
The official specification of [RFC 5870](https://datatracker.ietf.org/doc/html/rfc5870) is the canonical reference for the GeoURI scheme.
### Building the documentation
To build the documentation from the command-line:
```
$ swift package generate-documentation
```
Add the `--help` flag to get a list of all supported arguments and options.
### Xcode
You can also build the documentation directly in [Xcode](https://developer.apple.com/xcode/) from the Product menu:
**Product > Build Documentation**
The documentation can then be viewed in the documentation viewer.
## Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue on the GitHub repository.
## License
GeoURI is available under the [Unlicense](https://unlicense.org). See the [LICENSE](https://github.com/designedbyclowns/GeoURI/blob/main/LICENSE) file for more info.