Add Swift Package Manager support

Author: a-maurice

source/IOSResolver/IOSResolver.csproj

@@ -68,6 +68,7 @@
   <ItemGroup>
     <Compile Include="src\IOSResolver.cs" />
     <Compile Include="src\IOSResolverSettingsDialog.cs" />
+    <Compile Include="src\SwiftPackageManager.cs" />
     <Compile Include="src\VersionNumber.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>

source/IOSResolver/src/IOSResolver.cs

@@ -405,6 +405,9 @@ protected override bool Read(string filename, Logger logger) {
     private static SortedDictionary<string, Pod> pods =
         new SortedDictionary<string, Pod>();
 
+    // List of pods to ignore because they are replaced by Swift packages.
+    private static HashSet<string> podsToIgnore = new HashSet<string>();
+
     // Order of post processing operations.
     private const int BUILD_ORDER_REFRESH_DEPENDENCIES = 10;
     private const int BUILD_ORDER_CHECK_COCOAPODS_INSTALL = 20;
@@ -510,6 +513,10 @@ protected override bool Read(string filename, Logger logger) {
     private const string PREFERENCE_PODFILE_ALLOW_PODS_IN_MULTIPLE_TARGETS =
         PREFERENCE_NAMESPACE + "PodfileAllowPodsInMultipleTargets";
 
+    // Whether to use Swift Package Manager for dependency resolution.
+    private const string PREFERENCE_SWIFT_PACKAGE_MANAGER_ENABLED =
+        PREFERENCE_NAMESPACE + "SwiftPackageManagerEnabled";
+
     // List of preference keys, used to restore default settings.
     private static string[] PREFERENCE_KEYS = new [] {
         PREFERENCE_COCOAPODS_INSTALL_ENABLED,
@@ -525,7 +532,8 @@ protected override bool Read(string filename, Logger logger) {
         PREFERENCE_SWIFT_FRAMEWORK_SUPPORT_WORKAROUND,
         PREFERENCE_SWIFT_LANGUAGE_VERSION,
         PREFERENCE_PODFILE_ALWAYS_ADD_MAIN_TARGET,
-        PREFERENCE_PODFILE_ALLOW_PODS_IN_MULTIPLE_TARGETS
+        PREFERENCE_PODFILE_ALLOW_PODS_IN_MULTIPLE_TARGETS,
+        PREFERENCE_SWIFT_PACKAGE_MANAGER_ENABLED
     };
 
     // Whether the xcode extension was successfully loaded.
@@ -605,6 +613,9 @@ protected override bool Read(string filename, Logger logger) {
     // Parses dependencies from XML dependency files.
     private static IOSXmlDependencies xmlDependencies = new IOSXmlDependencies();
 
+    // Parses SPM dependencies from XML dependency files.
+    private static SwiftPackageManager spmDependencies = new SwiftPackageManager();
+
     // Project level settings for this module.
     private static ProjectSettings settings = new ProjectSettings(PREFERENCE_NAMESPACE);
 
@@ -1158,6 +1169,19 @@ public static bool PodfileAllowPodsInMultipleTargets {
         }
     }
 
+    /// <summary>
+    /// Whether to use Swift Package Manager for dependency resolution.
+    /// If enabled, the resolver will attempt to use SPM for packages that define SPM support,
+    /// falling back to Cocoapods if disabled or if the package does not support SPM.
+    /// </summary>
+    public static bool SwiftPackageManagerEnabled {
+        get { return settings.GetBool(PREFERENCE_SWIFT_PACKAGE_MANAGER_ENABLED,
+                                    defaultValue: true); }
+        set {
+            settings.SetBool(PREFERENCE_SWIFT_PACKAGE_MANAGER_ENABLED, value);
+        }
+    }
+
 
     /// <summary>
     /// Whether to use project level settings.
@@ -2148,14 +2172,25 @@ internal static void AddDummySwiftFile(
         File.WriteAllText(pbxprojPath, project.WriteToString());
     }
 
+    [PostProcessBuildAttribute(35)]
+    public static void OnPostProcessResolveSwiftPackages(BuildTarget buildTarget,
+                                                           string pathToBuiltProject) {
+        if (!SwiftPackageManagerEnabled) {
+            return;
+        }
+        var resolvedPackages = SwiftPackageManager.Resolve(spmDependencies.SwiftPackages, logger);
+        SwiftPackageManager.AddPackagesToProject(resolvedPackages, pathToBuiltProject, logger);
+        podsToIgnore = SwiftPackageManager.GetReplacedPods(resolvedPackages);
+    }
+
     /// <summary>
     /// Post-processing build step to generate the podfile for ios.
     /// </summary>
     [PostProcessBuildAttribute(BUILD_ORDER_GEN_PODFILE)]
     public static void OnPostProcessGenPodfile(BuildTarget buildTarget,
                                                string pathToBuiltProject) {
         if (!InjectDependencies() || !PodfileGenerationEnabled) return;
-        GenPodfile(buildTarget, pathToBuiltProject);
+        GenPodfile(buildTarget, pathToBuiltProject, podsToIgnore);
     }
 
     /// <summary>
@@ -2299,7 +2334,8 @@ private static string GeneratePodfileSourcesSection() {
     // Mono runtime from loading the Xcode API before calling the post
     // processing step.
     public static void GenPodfile(BuildTarget buildTarget,
-                                  string pathToBuiltProject) {
+                                  string pathToBuiltProject,
+                                  HashSet<string> podsToIgnore = null) {
         analytics.Report("generatepodfile", "Generate Podfile");
         string podfilePath = GetPodfilePath(pathToBuiltProject);
 
@@ -2341,6 +2377,10 @@ public static void GenPodfile(BuildTarget buildTarget,
             foreach (var target in XcodeTargetNames) {
                 file.WriteLine(String.Format("target '{0}' do", target));
                 foreach(var pod in pods.Values) {
+                    if (podsToIgnore != null && podsToIgnore.Contains(pod.name)) {
+                        Log(String.Format("Skipping pod {0} because it is replaced by a Swift Package.", pod.name), verbose: true);
+                        continue;
+                    }
                     file.WriteLine(String.Format("  {0}", pod.PodFilePodLine));
                 }
                 file.WriteLine("end");
@@ -2351,6 +2391,9 @@ public static void GenPodfile(BuildTarget buildTarget,
                 bool allowPodsInMultipleTargets = PodfileAllowPodsInMultipleTargets;
                 int podAdded = 0;
                 foreach(var pod in pods.Values) {
+                    if (podsToIgnore != null && podsToIgnore.Contains(pod.name)) {
+                        continue;
+                    }
                     if (pod.addToAllTargets) {
                         file.WriteLine(String.Format("  {0}{1}",
                                 allowPodsInMultipleTargets ? "" : "# ",
@@ -2908,10 +2951,14 @@ private static void RefreshXmlDependencies() {
         foreach (var podName in podsToRemove) {
             pods.Remove(podName);
         }
+        spmDependencies.SwiftPackages.Clear();
+        podsToIgnore.Clear();
+
         // Clear all sources (only can be set via XML config).
         Pod.Sources = new List<KeyValuePair<string, string>>();
-        // Read pod specifications from XML dependencies.
+        // Read pod and spm specifications from XML dependencies.
         xmlDependencies.ReadAll(logger);
+        spmDependencies.ReadAll(logger);
     }
 }
 

source/IOSResolver/src/IOSResolverSettingsDialog.cs

@@ -43,6 +43,7 @@ private class Settings {
         internal string swiftLanguageVersion;
         internal bool podfileAlwaysAddMainTarget;
         internal bool podfileAllowPodsInMultipleTargets;
+        internal bool swiftPackageManagerEnabled;
         internal bool useProjectSettings;
         internal EditorMeasurement.Settings analyticsSettings;
 
@@ -64,6 +65,7 @@ internal Settings() {
             swiftLanguageVersion = IOSResolver.SwiftLanguageVersion;
             podfileAlwaysAddMainTarget = IOSResolver.PodfileAlwaysAddMainTarget;
             podfileAllowPodsInMultipleTargets = IOSResolver.PodfileAllowPodsInMultipleTargets;
+            swiftPackageManagerEnabled = IOSResolver.SwiftPackageManagerEnabled;
             useProjectSettings = IOSResolver.UseProjectSettings;
             analyticsSettings = new EditorMeasurement.Settings(IOSResolver.analytics);
         }
@@ -86,6 +88,7 @@ internal void Save() {
             IOSResolver.SwiftLanguageVersion = swiftLanguageVersion;
             IOSResolver.PodfileAlwaysAddMainTarget = podfileAlwaysAddMainTarget;
             IOSResolver.PodfileAllowPodsInMultipleTargets = podfileAllowPodsInMultipleTargets;
+            IOSResolver.SwiftPackageManagerEnabled = swiftPackageManagerEnabled;
             IOSResolver.UseProjectSettings = useProjectSettings;
             analyticsSettings.Save();
         }
@@ -149,6 +152,18 @@ public void OnGUI() {
 
         scrollPosition = EditorGUILayout.BeginScrollView(scrollPosition);
 
+        GUILayout.BeginHorizontal();
+        GUILayout.Label("Swift Package Manager Integration", EditorStyles.boldLabel);
+        settings.swiftPackageManagerEnabled =
+            EditorGUILayout.Toggle(settings.swiftPackageManagerEnabled);
+        GUILayout.EndHorizontal();
+        GUILayout.Label("Use Swift Package Manager to resolve dependencies that support it. " +
+                        "If this is enabled, the resolver will prioritize SPM packages and " +
+                        "fall back to Cocoapods for any dependencies that do not have an " +
+                        "SPM equivalent specified.");
+
+        GUILayout.Box("", GUILayout.ExpandWidth(true), GUILayout.Height(1));
+
         GUILayout.BeginHorizontal();
         GUILayout.Label("Podfile Generation", EditorStyles.boldLabel);
         settings.podfileGenerationEnabled =