Merge pull request #211 from mapbox/feature/sendable

Add support for Sendable

.circleci/config.yml

@@ -0,0 +1,50 @@
+version: 2.1
+
+jobs:
+  build_and_test_linux:
+    docker:
+      - image: swift:latest
+    steps:
+      - checkout
+      - run:
+          name: "Build"
+          command: swift build
+      - run:
+          name: "Test"
+          command: swift test
+  build_and_test_macos:
+    parameters:
+      xcode_version:
+        type: string
+    macos:
+      xcode: << parameters.xcode_version >>
+    steps:
+      - checkout
+      - run:
+          name: "Build"
+          command: swift build
+      - run:
+          name: "Test"
+          command: swift test
+  build_for_library_evolution:
+    macos:
+      xcode: 15.1.0
+    steps:
+      - checkout
+      - run:
+          name: "Build for library evolution"
+          command: |
+           swift build \
+             -c release \
+             -Xswiftc -emit-module-interface \
+             -Xswiftc -enable-library-evolution
+
+workflows:
+  build-and-test:
+    jobs:
+      - build_for_library_evolution
+      - build_and_test_linux
+      - build_and_test_macos:
+          matrix:
+            parameters:
+              xcode_version: [13.4.1, 14.3.1, 15.1.0]

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright © 2014–2023, Mapbox
+Copyright © 2014–2024, Mapbox
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.4
+// swift-tools-version:5.5
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
@@ -9,22 +9,17 @@ let package = Package(
         .macOS(.v10_13), .iOS(.v11), .watchOS(.v4), .tvOS(.v11),
     ],
     products: [
-        // Products define the executables and libraries produced by a package, and make them visible to other packages.
         .library(
             name: "Turf",
-            targets: ["Turf"]),
-    ],
-    dependencies: [
-        // Dependencies declare other packages that this package depends on.
-        // .package(url: /* package url */, from: "1.0.0"),
+            targets: ["Turf"]
+        ),
     ],
     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: "Turf",
             dependencies: [],
-            exclude: ["Info.plist"]),
+            exclude: ["Info.plist"]
+        ),
         .testTarget(
             name: "TurfTests",
             dependencies: ["Turf"],
@@ -35,4 +30,4 @@ let package = Package(
             swiftSettings: [.define("SPM_TESTING")]
         ),
     ]
-)
+)

README.md

@@ -14,7 +14,7 @@ A [spatial analysis](http://en.wikipedia.org/wiki/Spatial_analysis) library writ
 
 ## Requirements
 
-Turf requires Xcode 12.0 or above and supports the following minimum deployment targets:
+Turf requires Xcode 13.0 or above and supports the following minimum deployment targets:
 
 * iOS 11.0 and above
 * macOS 10.13 (High Sierra) and above
@@ -27,7 +27,7 @@ If your project is written in Objective-C, you’ll need to write a compatibilit
 
 ## Installation
 
-Although a stable release of this library is not yet available, prereleases are available for installation using any of the popular Swift dependency managers.
+Releases are available for installation using any of the popular Swift dependency managers.
 
 ### CocoaPods
 

Sources/Turf/BoundingBox.swift

@@ -6,7 +6,7 @@ import CoreLocation
 /**
  A [bounding box](https://datatracker.ietf.org/doc/html/rfc7946#section-5) indicates the extremes of a `GeoJSONObject` along the x- and y-axes (longitude and latitude, respectively).
  */
-public struct BoundingBox {
+public struct BoundingBox: Sendable {
     /// The southwesternmost position contained in the bounding box.
     public var southWest: LocationCoordinate2D
 

Sources/Turf/Consumer/Consumer+WKT.swift

@@ -7,7 +7,7 @@ import CoreLocation
 struct WKTParser {
     init() {}
 
-    mutating func parse<T>(_ input: String) throws -> T {
+    mutating func parse<T: Sendable>(_ input: String) throws -> T {
         let match = try wktConsumer.match(input.uppercased())
         guard let output = try match.transform(wktTransform) else {
             throw WKTError.emptyOutput
@@ -21,16 +21,16 @@ struct WKTParser {
         return object
     }
 
-    static func parse<T>(_ input: String) throws -> T {
+    static func parse<T: Sendable>(_ input: String) throws -> T {
         var parser = WKTParser()
         return try parser.parse(input)
     }
 
     enum WKTError: Error, CustomStringConvertible {
         case emptyOutput
-        case numberParsingFailed(Any)
-        case coordinatesParsingFailed(Any)
-        case geometriesParsingFailed(Any)
+        case numberParsingFailed(Sendable)
+        case coordinatesParsingFailed(Sendable)
+        case geometriesParsingFailed(Sendable)
         case castFailed(Any.Type)
 
         public var description: String {

Sources/Turf/Consumer/Consumer.swift

@@ -33,7 +33,7 @@ import Foundation
 
 // MARK: Consumer
 
-public indirect enum Consumer<Label: Hashable>: Equatable {
+public indirect enum Consumer<Label: Hashable & Sendable>: Equatable, Sendable {
     /// Primitives
     case string(String)
     case charset(Charset)
@@ -67,38 +67,38 @@ public extension Consumer {
     var isOptional: Bool { return _isOptional }
 
     /// Source location
-    struct Location: Equatable {
+    struct Location: Equatable, Sendable {
         fileprivate var source: String.UnicodeScalarView
         public let range: Range<String.Index>
         public var offset: (line: Int, column: Int) { return _offset }
     }
 
     /// Abstract syntax tree returned by consumer
-    indirect enum Match: Equatable {
+    indirect enum Match: Equatable, Sendable {
         case token(String, Location)
         case node(Label?, [Match])
 
         /// The location of the match in the original source (if known)
         public var location: Location? { return _location }
 
         /// Transform generic AST to application-specific form
-        public func transform(_ fn: Transform) rethrows -> Any? {
+        public func transform(_ fn: Transform) rethrows -> Sendable? {
             return try _transform(fn)
         }
     }
 
     /// Opaque type used for efficient character matching
-    struct Charset: Hashable {
+    struct Charset: Hashable, Sendable {
         fileprivate let characterSet: CharacterSet
         let inverted: Bool
     }
 
     /// Closure for transforming a Match to an application-specific data type
-    typealias Transform = (_ name: Label, _ values: [Any]) throws -> Any?
+    typealias Transform = (_ name: Label, _ values: [Sendable]) throws -> (Sendable)?
 
     /// A Parsing error
     struct Error: Swift.Error {
-        public indirect enum Kind {
+        public indirect enum Kind: Sendable {
             case expected(Consumer)
             case unexpectedToken
             case custom(Swift.Error)
@@ -784,7 +784,7 @@ private extension Consumer.Match {
         }
     }
 
-    func _transform(_ fn: Consumer.Transform) rethrows -> Any? {
+    func _transform(_ fn: Consumer.Transform) rethrows -> Sendable? {
         // TODO: warn if no matches are labelled, as transform won't work
         do {
             switch self {
@@ -885,3 +885,7 @@ private func escapeString<T: StringProtocol>(_ string: T) -> String {
     }
     return result + "'"
 }
+
+#if swift(<5.6)
+extension CharacterSet: @unchecked Sendable {}
+#endif

Sources/Turf/CoreLocation.swift

@@ -50,7 +50,7 @@ public typealias LocationDegrees = Double
 /**
  A geographic coordinate with its components measured in degrees.
  */
-public struct LocationCoordinate2D {
+public struct LocationCoordinate2D: Sendable {
     /**
      The latitude in degrees.
      */

Sources/Turf/FeatureIdentifier.swift

@@ -3,7 +3,7 @@ import Foundation
 /**
  A [feature identifier](https://datatracker.ietf.org/doc/html/rfc7946#section-3.2) identifies a `Feature` object.
  */
-public enum FeatureIdentifier: Hashable {
+public enum FeatureIdentifier: Hashable, Sendable {
     /// A string.
     case string(_ string: String)
 

Sources/Turf/GeoJSON.swift

@@ -8,7 +8,7 @@ import CoreLocation
  
  - Note: [Foreign members](https://datatracker.ietf.org/doc/html/rfc7946#section-6.1) which may be present inside are coded only if used `JSONEncoder` or `JSONDecoder` has `userInfo[.includesForeignMembers] = true`.
  */
-public enum GeoJSONObject: Equatable {
+public enum GeoJSONObject: Equatable, Sendable {
     /**
      A [Geometry object](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1) represents points, curves, and surfaces in coordinate space.
      
@@ -94,7 +94,7 @@ extension FeatureCollection: GeoJSONObjectConvertible {
 /**
  A GeoJSON object that can contain [foreign members](https://datatracker.ietf.org/doc/html/rfc7946#section-6.1) in arbitrary keys.
  */
-public protocol ForeignMemberContainer {
+public protocol ForeignMemberContainer: Sendable {
     /// [Foreign members](https://datatracker.ietf.org/doc/html/rfc7946#section-6.1) to round-trip to JSON.
     ///
     /// Members are coded only if used `JSONEncoder` or `JSONDecoder` has `userInfo[.includesForeignMembers] = true`.

Sources/Turf/Geometries/GeometryCollection.swift

@@ -6,7 +6,7 @@ import CoreLocation
 /**
  A [GeometryCollection geometry](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.8) is a heterogeneous collection of `Geometry` objects that are related.
  */
-public struct GeometryCollection: Equatable, ForeignMemberContainer {
+public struct GeometryCollection: Equatable, ForeignMemberContainer, Sendable {
     /// The geometries contained by the geometry collection.
     public var geometries: [Geometry]
 

Sources/Turf/Geometries/LineString.swift

@@ -194,7 +194,7 @@ extension LineString {
     /**
      `IndexedCoordinate` is a coordinate with additional information such as the index from its position in the polyline and distance from the start of the polyline.
      */
-    public struct IndexedCoordinate {
+    public struct IndexedCoordinate: Sendable {
         /// The coordinate
         public let coordinate: Array<LocationCoordinate2D>.Element
         /// The index of the coordinate

Sources/Turf/Geometries/Point.swift

@@ -6,7 +6,7 @@ import CoreLocation
 /**
  A [Point geometry](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2) represents a single position.
  */
-public struct Point: Equatable, ForeignMemberContainer {
+public struct Point: Equatable, ForeignMemberContainer, Sendable {
     /**
      The position at which the point is located.
      

Sources/Turf/Geometry.swift

@@ -6,7 +6,7 @@ import CoreLocation
 /**
  A [Geometry object](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1) represents points, curves, and surfaces in coordinate space. Use an instance of this enumeration whenever a value could be any kind of Geometry object.
  */
-public enum Geometry: Equatable {
+public enum Geometry: Equatable, Sendable {
     /// A single position.
     case point(_ geometry: Point)
 
@@ -94,7 +94,7 @@ extension Geometry: Codable {
 /**
  A type that can be represented as a `Geometry` instance.
  */
-public protocol GeometryConvertible {
+public protocol GeometryConvertible: Sendable {
     /// The instance wrapped in a `Geometry` instance.
     var geometry: Geometry { get }
 }

Sources/Turf/JSON.swift

@@ -5,7 +5,7 @@ import Foundation
  
  This type does not represent the `null` value in JSON. Use `Optional<JSONValue>` wherever `null` is accepted.
  */
-public enum JSONValue: Hashable {
+public enum JSONValue: Hashable, Sendable {
     // case null would be redundant to Optional.none
 
     /// A string.

Sources/Turf/RadianCoordinate2D.swift

@@ -12,7 +12,7 @@ public typealias RadianDistance = Double
 /**
  A coordinate pair measured in radians, as opposed to `LocationCoordinate2D`, which is measured in degrees of arc.
  */
-public struct RadianCoordinate2D {
+public struct RadianCoordinate2D: Sendable {
     /// The latitude measured in radians.
     private(set) var latitude: LocationRadians
 

Sources/Turf/Ring.swift

@@ -6,7 +6,8 @@ import CoreLocation
 /**
  A [linear ring](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6) is a closed figure bounded by three or more straight line segments.
  */
-public struct Ring {
+
+public struct Ring: Sendable {
     /// The positions at which the linear ring is located.
     public var coordinates: [LocationCoordinate2D]
 

Turf.podspec

@@ -40,6 +40,6 @@ Pod::Spec.new do |s|
 
   s.frameworks = 'CoreLocation'
 
-  s.swift_version = "5.0"
+  s.swift_version = "5.5"
 
 end

docs/jazzy.yml

@@ -3,4 +3,4 @@ author: Mapbox
 title: Turf for Swift
 author_url: https://github.com/mapbox/turf-swift/
 github_url: https://github.com/mapbox/turf-swift
-copyright: '© 2014–2023 [Mapbox](https://www.mapbox.com/). See [license](https://github.com/mapbox/turf-swift/blob/main/LICENSE.md) for more details.'
+copyright: '© 2014–2024 [Mapbox](https://www.mapbox.com/). See [license](https://github.com/mapbox/turf-swift/blob/main/LICENSE.md) for more details.'