-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
271 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,5 +10,5 @@ import Foundation | |
@available(iOS 13.0, *) | ||
protocol EasyLinkable: Document { | ||
|
||
|
||
// TODO: - Implement | ||
} |
64 changes: 64 additions & 0 deletions
64
Sources/EasyFirebase/Services/Firestore/Protocols/GeoQueryable.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
// | ||
// File.swift | ||
// | ||
// | ||
// Created by Ben Myers on 9/3/22. | ||
// | ||
|
||
import Foundation | ||
|
||
@available(iOS 13.0, *) | ||
public protocol GeoQueryable: Document { | ||
|
||
// MARK: - Public Static Properties | ||
|
||
/// The precision to use with geohashing. | ||
static var geohashPrecision: GeoPrecision { get } | ||
|
||
// MARK: - Properties | ||
|
||
/// The document's location latitude. | ||
var latitude: Double { get set } | ||
/// The document's location longitude. | ||
var longitude: Double { get set } | ||
/// The address of the location of the document. | ||
var address: String? { get set } | ||
} | ||
|
||
#if canImport(CoreLocation) | ||
|
||
import CoreLocation | ||
|
||
@available(iOS 13.0, *) | ||
public extension GeoQueryable { | ||
|
||
// MARK: - Properties | ||
|
||
/// The document's location's geohash. | ||
var geohash: String { | ||
let location: CLLocationCoordinate2D = .init(latitude: latitude, longitude: longitude) | ||
let hash = location.geohash(length: Self.geohashPrecision.rawValue) | ||
return hash | ||
} | ||
} | ||
|
||
#endif | ||
|
||
public enum GeoPrecision: Int { | ||
/// ± 2500 km. | ||
case maxLoose = 1 | ||
/// ± 630 km. | ||
case veryLoose = 2 | ||
/// ± 20 km. | ||
case loose = 4 | ||
/// ± 610 m. | ||
case normal = 6 | ||
/// ± 19 m. | ||
case tight = 8 | ||
/// ± 2.4 m. | ||
case veryTight = 9 | ||
/// ± 60 cm. | ||
case maxTight = 10 | ||
/// ± 7.4 cm. | ||
case exact = 11 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,172 @@ | ||
// The MIT License (MIT) | ||
// | ||
// Copyright (c) 2019 Naoki Hiroshima | ||
// | ||
// 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. | ||
|
||
import Foundation | ||
|
||
enum Geohash { | ||
static func decode(hash: String) -> (latitude: (min: Double, max: Double), longitude: (min: Double, max: Double))? { | ||
// For example: hash = u4pruydqqvj | ||
|
||
let bits = hash | ||
.map { bitmap[$0] ?? "?" } | ||
.joined(separator: "") | ||
guard bits.count % 5 == 0 else { return nil } | ||
// bits = 1101000100101011011111010111100110010110101101101110001 | ||
|
||
let (lat, lon) = bits.enumerated().reduce(into: ([Character](), [Character]())) { | ||
if $1.0 % 2 == 0 { | ||
$0.1.append($1.1) | ||
} else { | ||
$0.0.append($1.1) | ||
} | ||
} | ||
// lat = [1,1,0,1,0,0,0,1,1,1,1,1,1,1,0,1,0,1,1,0,0,1,1,0,1,0,0] | ||
// lon = [1,0,0,0,0,1,1,1,0,1,1,0,0,1,1,0,1,0,0,1,1,1,0,1,1,1,0,1] | ||
|
||
func combiner(array a: (min: Double, max: Double), value: Character) -> (Double, Double) { | ||
let mean = (a.min + a.max) / 2 | ||
return value == "1" ? (mean, a.max) : (a.min, mean) | ||
} | ||
|
||
let latRange = lat.reduce((-90.0, 90.0), combiner) | ||
// latRange = (57.649109959602356, 57.649111300706863) | ||
|
||
let lonRange = lon.reduce((-180.0, 180.0), combiner) | ||
// lonRange = (10.407439023256302, 10.407440364360809) | ||
|
||
return (latRange, lonRange) | ||
} | ||
|
||
static func encode(latitude: Double, longitude: Double, length: Int) -> String { | ||
// For example: (latitude, longitude) = (57.6491106301546, 10.4074396938086) | ||
|
||
func combiner(array a: (min: Double, max: Double, array: [String]), value: Double) -> (Double, Double, [String]) { | ||
let mean = (a.min + a.max) / 2 | ||
if value < mean { | ||
return (a.min, mean, a.array + "0") | ||
} else { | ||
return (mean, a.max, a.array + "1") | ||
} | ||
} | ||
|
||
let lat = Array(repeating: latitude, count: length * 5).reduce((-90.0, 90.0, [String]()), combiner) | ||
// lat = (57.64911063015461, 57.649110630154766, [1,1,0,1,0,0,0,1,1,1,1,1,1,1,0,1,0,1,1,0,0,1,1,0,1,0,0,1,0,0,...]) | ||
|
||
let lon = Array(repeating: longitude, count: length * 5).reduce((-180.0, 180.0, [String]()), combiner) | ||
// lon = (10.407439693808236, 10.407439693808556, [1,0,0,0,0,1,1,1,0,1,1,0,0,1,1,0,1,0,0,1,1,1,0,1,1,1,0,1,0,1,..]) | ||
|
||
let latlon = lon.2.enumerated().flatMap { [$1, lat.2[$0]] } | ||
// latlon - [1,1,0,1,0,0,0,1,0,0,1,0,1,0,1,1,0,1,1,1,1,1,0,1,0,1,1,1,1,...] | ||
|
||
let bits = latlon.enumerated().reduce([String]()) { $1.0 % 5 > 0 ? $0 << $1.1 : $0 + $1.1 } | ||
// bits: [11010,00100,10101,10111,11010,11110,01100,10110,10110,11011,10001,10010,10101,...] | ||
|
||
let arr = bits.compactMap { charmap[$0] } | ||
// arr: [u,4,p,r,u,y,d,q,q,v,j,k,p,b,...] | ||
|
||
return String(arr.prefix(length)) | ||
} | ||
|
||
// MARK: Private | ||
|
||
private static let bitmap = "0123456789bcdefghjkmnpqrstuvwxyz" | ||
.enumerated() | ||
.map { | ||
($1, String(integer: $0, radix: 2, padding: 5)) | ||
} | ||
.reduce(into: [Character: String]()) { | ||
$0[$1.0] = $1.1 | ||
} | ||
|
||
private static let charmap = bitmap | ||
.reduce(into: [String: Character]()) { | ||
$0[$1.1] = $1.0 | ||
} | ||
} | ||
|
||
extension Geohash { | ||
enum Precision: Int { | ||
case twentyFiveHundredKilometers = 1 // ±2500 km | ||
case sixHundredThirtyKilometers // ±630 km | ||
case seventyEightKilometers // ±78 km | ||
case twentyKilometers // ±20 km | ||
case twentyFourHundredMeters // ±2.4 km | ||
case sixHundredTenMeters // ±0.61 km | ||
case seventySixMeters // ±0.076 km | ||
case nineteenMeters // ±0.019 km | ||
case twoHundredFourtyCentimeters // ±0.0024 km | ||
case sixtyCentimeters // ±0.00060 km | ||
case seventyFourMillimeters // ±0.000074 km | ||
} | ||
|
||
static func encode(latitude: Double, longitude: Double, precision: Precision) -> String { | ||
return encode(latitude: latitude, longitude: longitude, length: precision.rawValue) | ||
} | ||
} | ||
|
||
private extension String { | ||
init(integer n: Int, radix: Int, padding: Int) { | ||
let s = String(n, radix: radix) | ||
let pad = (padding - s.count % padding) % padding | ||
self = Array(repeating: "0", count: pad).joined(separator: "") + s | ||
} | ||
} | ||
|
||
private func + (left: [String], right: String) -> [String] { | ||
var arr = left | ||
arr.append(right) | ||
return arr | ||
} | ||
|
||
private func << (left: [String], right: String) -> [String] { | ||
var arr = left | ||
var s = arr.popLast()! | ||
s += right | ||
arr.append(s) | ||
return arr | ||
} | ||
|
||
#if canImport(CoreLocation) | ||
|
||
// MARK: - CLLocationCoordinate2D | ||
|
||
import CoreLocation | ||
|
||
extension CLLocationCoordinate2D { | ||
init(geohash: String) { | ||
if let (lat, lon) = Geohash.decode(hash: geohash) { | ||
self = CLLocationCoordinate2DMake((lat.min + lat.max) / 2, (lon.min + lon.max) / 2) | ||
} else { | ||
self = kCLLocationCoordinate2DInvalid | ||
} | ||
} | ||
|
||
func geohash(length: Int) -> String { | ||
return Geohash.encode(latitude: latitude, longitude: longitude, length: length) | ||
} | ||
|
||
func geohash(precision: Geohash.Precision) -> String { | ||
return geohash(length: precision.rawValue) | ||
} | ||
} | ||
|
||
#endif |