Linux (#488)

* Fixed test build with SPM

Explicitly import Core Location in each test file that uses it.

* SPM 5.3

Upgraded to SPM 5.3. Added fixtures to test target so that tests pass.

* Updated tests for SPM

* Added Linux to CI

* Removed Core Location dependency on Linux

* Removed Core Graphics dependency on Linux

* Migrated Linux to FoundationNetworking

* DateComponentsFormatter is unimplemented in swift-corelibs-foundation

* Polyline v5.0.2, Turf v1.1.0

* Imported Foundation where missing

* Use current ProcessInfo instead of creating a new one

* Remove Objective-C runtime dependency on Linux

* Bridge Turf and Polyline compatibility shims for Core Location on Linux

* Documented Linux support

Reworked the system requirements documentation for clarity.

* Test on Linux

* Removed truisms from unit tests

Removed some assertions that, combined with other assertions nearby, essentially check that a Foundation class’s non-failable initializer doesn’t return nil. These default initializers happen to also be unavailable in swift-corelibs-foundation.

* Work around swift-corelibs-foundation usage of NSNull

swift-corelibs-foundation’s implementation of JSONSerialization uses NSNull to represent a JSON null value, whereas the implementation on Apple platforms uses nil.

Author: 1ec5

.circleci/config.yml

@@ -37,6 +37,14 @@ commands:
                 command: bash <(curl -s https://codecov.io/bash)
 
 jobs:
+  spm-linux-job:
+    docker:
+      - image: swift:5.3
+    steps:
+      - checkout
+      - run: swift build
+      - run: swift test
+
   spm-job:
     parameters:
       xcode:
@@ -132,3 +140,5 @@ workflows:
       - spm-job:
           name: "SPM_build"
           xcode: "12.0.0"
+      - spm-linux-job:
+          name: "SPM_Ubuntu_build"

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changes to Mapbox Directions for Swift
 
+## v1.2.0
+
+* Added support for building and running on any Linux distribution supported by Swift. ([#488](https://github.com/mapbox/mapbox-directions-swift/pull/488))
+
 ## v1.1.0
 
 * Added the `DirectionsResult.typicalTravelTime`, `RouteLeg.typicalTravelTime` and `RouteStep.typicalTravelTime` properties that indicate the typical travel time, as opposed to the current expected travel time. ([#462](https://github.com/mapbox/mapbox-directions-swift/pull/462))

Cartfile.resolved

@@ -1,5 +1,5 @@
 binary "https://www.mapbox.com/ios-sdk/Mapbox-iOS-SDK.json" "5.9.0"
 github "linksmt/OHHTTPStubs" "563f48d3fab84ef04639649c770b00f4fa502cca"
 github "mapbox/mapbox-events-ios" "v0.10.5"
-github "mapbox/turf-swift" "v1.0.0"
-github "raphaelmor/Polyline" "v5.0.0"
+github "mapbox/turf-swift" "v1.1.0"
+github "raphaelmor/Polyline" "v5.0.2"

Package.resolved

@@ -1,4 +1,4 @@
-// swift-tools-version:5.0
+// swift-tools-version:5.3
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
@@ -17,17 +17,22 @@ let package = Package(
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
-        .package(url: "https://github.com/raphaelmor/Polyline.git", from: "5.0.0"),
-        .package(url: "https://github.com/mapbox/turf-swift.git", from: "1.0.0")
+        .package(url: "https://github.com/raphaelmor/Polyline.git", from: "5.0.2"),
+        .package(name: "Turf", url: "https://github.com/mapbox/turf-swift.git", from: "1.1.0")
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
         // Targets can depend on other targets in this package, and on products in packages which this package depends on.
         .target(
             name: "MapboxDirections",
-            dependencies: ["Polyline", "Turf"]),
+            dependencies: ["Polyline", "Turf"],
+            exclude: ["Info.plist"]),
         .testTarget(
             name: "MapboxDirectionsTests",
-            dependencies: ["MapboxDirections"]),
+            dependencies: ["MapboxDirections"],
+            exclude: ["Info.plist"],
+            resources: [
+                .process("Fixtures"),
+            ]),
     ]
 )

Package.swift

@@ -6,7 +6,7 @@
 [![SPM compatible](https://img.shields.io/badge/SPM-compatible-4BC51D.svg?style=flat)](https://swift.org/package-manager/)
 [![codecov](https://codecov.io/gh/mapbox/mapbox-directions-swift/branch/main/graph/badge.svg)](https://codecov.io/gh/mapbox/mapbox-directions-swift)
 
-Mapbox Directions for Swift (formerly MapboxDirections.swift) makes it easy to connect your iOS, macOS, tvOS, or watchOS application to the [Mapbox Directions](https://docs.mapbox.com/api/navigation/) and [Map Matching](https://docs.mapbox.com/api/navigation/#map-matching) APIs. Quickly get driving, cycling, or walking directions, whether the trip is nonstop or it has multiple stopping points, all using a simple interface reminiscent of MapKit’s `MKDirections` API. Fit a GPX trace to the [OpenStreetMap](https://www.openstreetmap.org/) road network. The Mapbox Directions and Map Matching APIs are powered by the [OSRM](http://project-osrm.org/) and [Valhalla](https://github.com/valhalla/valhalla/) routing engines. For more information, see the [Mapbox Navigation](https://www.mapbox.com/navigation/) homepage.
+Mapbox Directions for Swift (formerly MapboxDirections.swift) makes it easy to connect your iOS, macOS, tvOS, watchOS, or Linux application to the [Mapbox Directions](https://docs.mapbox.com/api/navigation/) and [Map Matching](https://docs.mapbox.com/api/navigation/#map-matching) APIs. Quickly get driving, cycling, or walking directions, whether the trip is nonstop or it has multiple stopping points, all using a simple interface reminiscent of MapKit’s `MKDirections` API. Fit a GPX trace to the [OpenStreetMap](https://www.openstreetmap.org/) road network. The Mapbox Directions and Map Matching APIs are powered by the [OSRM](http://project-osrm.org/) and [Valhalla](https://github.com/valhalla/valhalla/) routing engines. For more information, see the [Mapbox Navigation](https://www.mapbox.com/navigation/) homepage.
 
 Mapbox Directions pairs well with [MapboxGeocoder.swift](https://github.com/mapbox/MapboxGeocoder.swift), [MapboxStatic.swift](https://github.com/mapbox/MapboxStatic.swift), the [Mapbox Navigation SDK for iOS](https://github.com/mapbox/mapbox-navigation-ios/), and the [Mapbox Maps SDK for iOS](https://docs.mapbox.com/ios/maps/) or [macOS SDK](https://mapbox.github.io/mapbox-gl-native/macos/).
 
@@ -32,11 +32,24 @@ Or in your [Swift Package Manager](https://swift.org/package-manager/) Package.s
 
 Then `import MapboxDirections`.
 
-This library requires Xcode 11 or higher in order to build.
-This library supports a minimum deployment target of iOS 10.0 or above, macOS 10.12.0 or above, tvOS 10.0 or above, or watchOS 2.0 or above. v0.30.0 is the last release of MapboxDirections.swift that supports a minimum deployment target of iOS 9._x_, macOS 10.11._x_, tvOS 9._x_, or watchOS 2._x_. v0.30.0 is also the last release that is compatible with Objective-C or AppleScript code.
-
 This repository contains an example application that demonstrates how to use the framework. To run it, you need to use [Carthage](https://github.com/Carthage/Carthage) 0.19 or above to install the dependencies. Detailed documentation is available in the [Mapbox API Documentation](https://docs.mapbox.com/api/navigation/#directions).
 
+## System requirements
+
+* One of the following package managers:
+   * CocoaPods (CocoaPods 1.10 or above if using Xcode 12)
+   * Carthage 0.19 or above (run [this script](https://github.com/mapbox/mapbox-directions-swift/blob/main/scripts/wcarthage.sh) instead of `carthage` if using Xcode 12)
+   * Swift Package Manager 5.3 or above
+* Xcode 11 or above (Xcode 12 or above if using Swift Package Manager)
+* One of the following operating systems:
+   * iOS 10.0 or above
+   * macOS 10.12.0 or above
+   * tvOS 10.0 or above
+   * watchOS 2.0 or above
+   * Any Linux distribution supported by Swift
+
+v0.30.0 is the last release of MapboxDirections.swift that supports a minimum deployment target of iOS 9._x_, macOS 10.11._x_, tvOS 9._x_, or watchOS 2._x_. v0.30.0 is also the last release that is compatible with Objective-C or AppleScript code.
+
 ## Usage
 
 **[API reference](https://docs.mapbox.com/ios/api/directions/)**

README.md

@@ -1,4 +1,7 @@
 import Foundation
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
 
 typealias JSONDictionary = [String: Any]
 
@@ -37,7 +40,7 @@ let userAgent: String = {
     #else
         system = "unknown"
     #endif
-    let systemVersion = ProcessInfo().operatingSystemVersion
+    let systemVersion = ProcessInfo.processInfo.operatingSystemVersion
     components.append("\(system)/\(systemVersion.majorVersion).\(systemVersion.minorVersion).\(systemVersion.patchVersion)")
 
     let chip: String

Sources/MapboxDirections/Directions.swift

@@ -20,9 +20,13 @@ public struct DirectionsCredentials: Equatable {
      The SKU Token associated with the request. Used for billing.
      */
     public var skuToken: String? {
+        #if os(iOS)
         guard let mbx: AnyClass = NSClassFromString("MBXAccounts") else { return nil }
         guard mbx.responds(to: Selector(("serviceSkuToken"))) else { return nil }
         return mbx.value(forKeyPath: "serviceSkuToken") as? String
+        #else
+        return nil
+        #endif
     }
 
     /**

Sources/MapboxDirections/DirectionsCredentials.swift

@@ -1,4 +1,7 @@
 import Foundation
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
 
 /**
  An error that occurs when calculating directions.
@@ -131,12 +134,16 @@ public enum DirectionsError: LocalizedError {
         case .requestTooLarge:
             return "The request is too large."
         case let .rateLimited(rateLimitInterval: interval, rateLimit: limit, _):
-            let intervalFormatter = DateComponentsFormatter()
-            intervalFormatter.unitsStyle = .full
             guard let interval = interval, let limit = limit else {
                 return "Too many requests."
             }
+            #if os(Linux)
+            let formattedInterval = "\(interval) seconds"
+            #else
+            let intervalFormatter = DateComponentsFormatter()
+            intervalFormatter.unitsStyle = .full
             let formattedInterval = intervalFormatter.string(from: interval) ?? "\(interval) seconds"
+            #endif
             let formattedCount = NumberFormatter.localizedString(from: NSNumber(value: limit), number: .decimal)
             return "More than \(formattedCount) requests have been made with this access token within a period of \(formattedInterval)."
         case let .unknown(_, underlying: error, _, message):

Sources/MapboxDirections/DirectionsError.swift

@@ -1,6 +1,5 @@
 import Foundation
 import Polyline
-import CoreLocation
 
 /**
  Maximum length of an HTTP request URL for the purposes of switching from GET to