Add support for Swift Package Manager #362

frederoni · 2019-03-23T01:44:42Z

~~Fixes 318 - Support for static library using CocoaPods~~
Fixes #234 - Swift Package Manager on macOS

Audit Obj-C bridgeability
~~Deprecate MapboxDirections.swift on CocoaPods public repo in favor of MapboxDirections~~ (Reverted pod rename to minimize the changes)

1ec5 · 2019-03-27T01:14:02Z

I wonder if we can replace all extensible and bitmask Obj-C enums. 🤔

Unfortunately, that won’t be feasible as long as this library supports Objective-C. Would it be possible to maintain parallel types, with CocoaPods and Carthage using the Objective-C version and SPM using the Swift version?

frederoni · 2019-03-27T08:53:53Z

Would it be possible to maintain parallel types

Great idea. That should be relatively straightforward, and only four duplicated data types in the shim, which shouldn't be too inconvenient to maintain.

1ec5 · 2019-04-05T04:45:48Z

Package.swift

+        ],
+    dependencies: [
+        // Dependencies declare other packages that this package depends on.
+        .package(url: "../Polyline", .branch("fred/spm4.2"))


Remember to update this line before merging.

frederoni · 2019-04-09T13:15:20Z

Sources/MapboxDirections/MBLane.swift


    /**
     Initializes a new `Lane` using the given lane indications.
     */
+    #if SWIFT_PACKAGE


I'm not entirely satisfied with this workaround, having to provide duplicated initializers.
What I would like to see is a pre-processor macro:

#if SWIFT_PACKAGE #define OBJC_NO_SPM #define OBJC_NO_SPM(x) #else #define OBJC_NO_SPM @objc #define OBJC_NO_SPM(x) @objc(x) #endif

but an Obj-C macro would not work with SPM and SPM doesn't support these macros.

~~@objcMembers solves roughly half of the issues, since it ignores the @objc-flag if it's not able to bridge properly to Obj-C, but it only works for some methods and properties.~~

frederoni · 2019-04-09T14:09:46Z

OHHTTPStubs doesn't provide support for SPM so we're not running tests on the SPM flavor yet.

frederoni · 2019-04-15T11:02:11Z

Package.swift

+        ],
+    dependencies: [
+        // Dependencies declare other packages that this package depends on.
+        .package(url: "https://github.com/raphaelmor/Polyline.git", .branch("master"))


@1ec5 Would you mind making a new release of Polyline?

Changes since v4.2.0:
Added support for Swift Package Manager (#51)

Sources/MapboxDirections/MBLaneIndicationComponent.swift

 /**
 A component that represents a lane  representation of an instruction.
 */
-@objc(MBLaneIndicationComponent)


1ec5 · 2019-04-24T17:47:40Z

Sources/MapboxDirections/MBDirectionsOptions.swift

@@ -219,6 +221,7 @@ public enum InstructionFormat: UInt, CustomStringConvertible {

 You do not create instances of this class directly. Instead, create instances of `MatchOptions` or `RouteOptions`.
 */
+@objcMembers


Huh, didn’t know about this annotation. Good find. There are still some bare @objc keywords in the class; are they redundant now?

@objc is still needed for refinements. It's also useful for compile-time errors of unbridgeable types.
Only using @objcMembers would fail silently if a type all of a sudden doesn't bridge to Objective-C. Haven't figured out a best practice yet, but as long as we have Obj-C bridging tests, a missing @objc annotation is fine since it would get caught by the test at compile-time.

1ec5 · 2019-04-24T17:49:04Z

Sources/MapboxDirections/MBDirectionsOptions.swift

@@ -382,7 +390,12 @@ open class DirectionsOptions: NSObject, NSSecureCoding, NSCopying {

     This property should be set to `MBDirectionsProfileIdentifierAutomobile`, `MBDirectionsProfileIdentifierAutomobileAvoidingTraffic`, `MBDirectionsProfileIdentifierCycling`, or `MBDirectionsProfileIdentifierWalking`. The default value of this property is `MBDirectionsProfileIdentifierAutomobile`, which specifies driving directions.
     */
+    #if SWIFT_PACKAGE
+    open var profileIdentifier: MBDirectionsProfileIdentifier
+    #else


Is this conditional compilation still necessary now that the overall class is annotated with @objcMembers?

good catch, not needed.

Sources/MapboxDirections/MBRouteOptions.swift

frederoni · 2019-06-07T13:01:01Z

We can put Obj-C++ inside a separate compat dependency in SPM and compile the Objective-C code along with the Swift framework and therefore support Objective-C w/o having to maintain duplicated types for the SPM version.

1ec5 · 2019-06-11T07:35:11Z

Sources/MapboxDirections/MBDirectionsOptions.swift

@@ -418,7 +425,7 @@ open class DirectionsOptions: NSObject, NSSecureCoding, NSCopying {

     By default, no attribute options are specified. It is recommended that `routeShapeResolution` be set to `.full`.
     */
-    @objc open var attributeOptions: AttributeOptions = []
+    open var attributeOptions: MBAttributeOptions = []


Can the type remain as AttributeOptions, or does it have to be downgraded to MBAttributeOptions?

1ec5

Suggested changelog entry:

Added support for Swift Package Manager. (#362)

frederoni force-pushed the fred/spm branch 4 times, most recently from fc1dea3 to 7833e8a Compare March 23, 2019 02:37

frederoni force-pushed the fred/spm branch 2 times, most recently from be1bc31 to f2515a3 Compare April 4, 2019 13:35

1ec5 reviewed Apr 5, 2019

View reviewed changes

frederoni force-pushed the fred/spm branch 2 times, most recently from 0321f46 to 1d59309 Compare April 9, 2019 13:09

frederoni commented Apr 9, 2019

View reviewed changes

frederoni force-pushed the fred/spm branch 2 times, most recently from 3c9181d to 3bc1d47 Compare April 15, 2019 10:41

frederoni commented Apr 15, 2019

View reviewed changes

frederoni force-pushed the fred/spm branch 3 times, most recently from 6b7a031 to 176c4bb Compare April 15, 2019 12:15

frederoni commented Apr 15, 2019

View reviewed changes

Sources/MapboxDirections/MBLaneIndicationComponent.swift Outdated

/**

A component that represents a lane representation of an instruction.

*/

@objc(MBLaneIndicationComponent)

This comment was marked as resolved.

Sign in to view

frederoni marked this pull request as ready for review April 16, 2019 11:17

frederoni force-pushed the fred/spm branch from 658a406 to 619fcd8 Compare April 16, 2019 11:19

1ec5 added the build label Apr 24, 2019

1ec5 reviewed Apr 24, 2019

View reviewed changes

frederoni added 6 commits June 3, 2019 14:37

Rename to MapboxDirections and add support for Swift Package Manager

fd2cb9d

Separate SPM and ObjC prerequisites

e4cd60d

Build SPM flavor on CI

ca4b503

Generate LinuxMain

4881291

Drop unused macro

3c3b737

Add static pod test

22ff645

Add MBDirectionsPriority to SPM flavor

f571388

frederoni force-pushed the fred/spm branch from 48a9e75 to f571388 Compare June 3, 2019 13:10

frederoni added 2 commits June 3, 2019 15:13

Remove explicit objc annotation

07c7b02

Drop Xcode 9

2cdb3c7

1ec5 reviewed Jun 6, 2019

View reviewed changes

Sources/MapboxDirections/MBRouteOptions.swift Outdated Show resolved Hide resolved

Sources/MapboxDirections/MBRouteOptions.swift Outdated Show resolved Hide resolved

frederoni force-pushed the fred/spm branch from 7c9c797 to b08be27 Compare June 7, 2019 12:56

frederoni added 2 commits June 7, 2019 15:05

Remove SPM specific code paths

e37246c

Fix CocoaPods compat

24291c2

frederoni force-pushed the fred/spm branch from b08be27 to 24291c2 Compare June 7, 2019 13:24

Fix refs in default and Carthage build

ea8bae4

frederoni force-pushed the fred/spm branch from 156c784 to ea8bae4 Compare June 7, 2019 13:54

Rename MapboxDirectionsCompat to CMapboxDirections

06065a7

frederoni force-pushed the fred/spm branch 2 times, most recently from 6c22ddd to 2265f23 Compare June 7, 2019 21:36

Revert pod rename

f780f54

frederoni force-pushed the fred/spm branch from 2265f23 to f780f54 Compare June 7, 2019 21:47

1ec5 approved these changes Jun 11, 2019

View reviewed changes

1ec5 changed the title ~~Rename to MapboxDirections and add support for Swift Package Manager~~ Add support for Swift Package Manager Jun 11, 2019

1ec5 reviewed Jun 11, 2019

View reviewed changes

frederoni added 4 commits June 11, 2019 10:22

Unpublicize CMapboxDirections

a6e22e7

Use swift alias

90b2b4d

Import missing framework

cecfebd

Add a blurb in the CHANGELOG

d099233

frederoni merged commit 2fcaf62 into master Jun 11, 2019

1ec5 mentioned this pull request Dec 9, 2019

Remove Objective-C compatibility; adopt Swift language features #382

Merged

1 task

1ec5 mentioned this pull request Dec 27, 2019

Rename MapboxDirections.swift to Mapbox Directions for Swift #399

Closed

8 tasks

1ec5 mentioned this pull request Sep 16, 2020

Support installation via Swift Package Manager mapbox/mapbox-navigation-ios#2629

Closed

16 tasks

1ec5 mentioned this pull request Nov 3, 2020

Linux #484

Closed

2 tasks

1ec5 mentioned this pull request Nov 11, 2020

Support Swift Package Manager mapbox/MapboxGeocoder.swift#132

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Swift Package Manager #362

Add support for Swift Package Manager #362

frederoni commented Mar 23, 2019 •

edited

Loading

1ec5 commented Mar 27, 2019

frederoni commented Mar 27, 2019

1ec5 Apr 5, 2019

frederoni Apr 9, 2019 •

edited

Loading

frederoni commented Apr 9, 2019

frederoni Apr 15, 2019

1ec5 Apr 15, 2019

This comment was marked as resolved.

1ec5 Apr 24, 2019

frederoni Apr 24, 2019

1ec5 Apr 24, 2019

frederoni Jun 3, 2019 •

edited

Loading

frederoni commented Jun 7, 2019

1ec5 Jun 11, 2019

1ec5 left a comment

Add support for Swift Package Manager #362

Add support for Swift Package Manager #362

Conversation

frederoni commented Mar 23, 2019 • edited Loading

1ec5 commented Mar 27, 2019

frederoni commented Mar 27, 2019

1ec5 Apr 5, 2019

Choose a reason for hiding this comment

frederoni Apr 9, 2019 • edited Loading

Choose a reason for hiding this comment

frederoni commented Apr 9, 2019

frederoni Apr 15, 2019

Choose a reason for hiding this comment

1ec5 Apr 15, 2019

Choose a reason for hiding this comment

This comment was marked as resolved.

1ec5 Apr 24, 2019

Choose a reason for hiding this comment

frederoni Apr 24, 2019

Choose a reason for hiding this comment

1ec5 Apr 24, 2019

Choose a reason for hiding this comment

frederoni Jun 3, 2019 • edited Loading

Choose a reason for hiding this comment

frederoni commented Jun 7, 2019

1ec5 Jun 11, 2019

Choose a reason for hiding this comment

1ec5 left a comment

Choose a reason for hiding this comment

frederoni commented Mar 23, 2019 •

edited

Loading

frederoni Apr 9, 2019 •

edited

Loading

frederoni Jun 3, 2019 •

edited

Loading