Allow to add pods to multiple targets

The plugin developers can specify `addToAllTargets` attribute to
Dependencies.xml or use `IOSResolver.AddPod()` API in code.

The plugin users can enable or disable adding pods to multiple targets
globally in iOS Resolver settings menu, or by changing
`IOSResolver.PodfileAllowPodsInMultipleTargets` in code

Bug: 174515725
Fix: 405

Change-Id: Ic285519a451964c3e3e59c6a2ae8f4b0dc81bf41

Author: chkuang-g

README.md

@@ -432,7 +432,7 @@ For example, to add the AdMob pod, version 7.0 or greater with bitcode enabled:
 <dependencies>
   <iosPods>
     <iosPod name="Google-Mobile-Ads-SDK" version="~> 7.0" bitcodeEnabled="true"
-            minTargetSdk="6.0" />
+            minTargetSdk="6.0" addToAllTargets="false" />
   </iosPods>
 </dependencies>
 ```

sample/Assets/ExternalDependencyManager/Editor/SampleDependencies.xml

@@ -67,6 +67,9 @@
            generated Xcode project.  This is "true" by default.
          * "minTargetSdk" (optional)
            The minimum iOS SDK required by this Cocoapod.
+         * "addToAllTargets" (optional)
+           Whether to add this pod to all targets when multiple target is
+           supported. This is "false" by default.
          * "configurations" (optional)
            Podfile formatted list of configurations to include this pod in.
          * "modular_headers" (optional)
@@ -77,7 +80,7 @@
            Subspecs to include for the pod.
      -->
     <iosPod name="Google-Mobile-Ads-SDK" path="../google-mobile-ads-sdk" version="~> 7.0" bitcodeEnabled="true"
-            minTargetSdk="6.0">
+            minTargetSdk="6.0" addToAllTargets="false">
       <!-- Set of source URIs to search for this Cocoapod spec.
            By default Cocoapods will attempt to fetch the pod specs from:
            * $HOME/.cocoapods/repos

source/IOSResolver/src/IOSResolver.cs

@@ -86,6 +86,11 @@ private class Pod {
         /// </summary>
         public string minTargetSdk = null;
 
+        /// <summary>
+        /// Whether to add this pod to all targets when multiple
+        /// </summary>
+        public bool addToAllTargets = false;
+
         /// <summary>
         /// Tag that indicates where this was created.
         /// </summary>
@@ -162,21 +167,25 @@ public string PodFilePodLine {
         /// bitcode.</param>
         /// <param name="minTargetSdk">Minimum target SDK revision required by
         /// this pod.</param>
+        /// <param name="addToAllTargets">Whether to add this pod to all targets when multiple
+        /// target is supported.</param>
         /// <param name="sources">List of sources to search for all pods.
         /// Each source is a URL that is injected in the source section of a Podfile
         /// See https://guides.cocoapods.org/syntax/podfile.html#source for the description of
         /// a source.</param>
         /// <param name="propertiesByName">Dictionary of additional properties for the pod
         /// reference.</param>
         public Pod(string name, string version, bool bitcodeEnabled, string minTargetSdk,
-                   IEnumerable<string> sources, Dictionary<string, string> propertiesByName) {
+                   bool addToAllTargets, IEnumerable<string> sources,
+                   Dictionary<string, string> propertiesByName) {
             this.name = name;
             this.version = version;
             if (propertiesByName != null) {
                 this.propertiesByName = new Dictionary<string, string>(propertiesByName);
             }
             this.bitcodeEnabled = bitcodeEnabled;
             this.minTargetSdk = minTargetSdk;
+            this.addToAllTargets = addToAllTargets;
             if (sources != null) {
                 var allSources = new List<string>(sources);
                 allSources.AddRange(this.sources);
@@ -305,6 +314,7 @@ protected override bool Read(string filename, Logger logger) {
             string versionSpec = null;
             bool bitcodeEnabled = true;
             string minTargetSdk = null;
+            bool addToAllTargets = false;
             var propertiesByName = new Dictionary<string, string>();
             if (!XmlUtilities.ParseXmlTextFileElements(
                 filename, logger,
@@ -331,7 +341,12 @@ protected override bool Read(string filename, Logger logger) {
                                 (reader.GetAttribute("bitcodeEnabled") ?? "").ToLower();
                             bitcodeEnabled |= trueStrings.Contains(bitcodeEnabledString);
                             bitcodeEnabled &= !falseStrings.Contains(bitcodeEnabledString);
+                            var addToAllTargetsString =
+                                (reader.GetAttribute("addToAllTargets") ?? "").ToLower();
+                            addToAllTargets |= trueStrings.Contains(addToAllTargetsString);
+                            addToAllTargets &= !falseStrings.Contains(addToAllTargetsString);
                             minTargetSdk = reader.GetAttribute("minTargetSdk");
+
                             sources = new List<string>();
                             if (podName == null) {
                                 logger.Log(
@@ -344,6 +359,7 @@ protected override bool Read(string filename, Logger logger) {
                             AddPodInternal(podName, preformattedVersion: versionSpec,
                                            bitcodeEnabled: bitcodeEnabled,
                                            minTargetSdk: minTargetSdk,
+                                           addToAllTargets: addToAllTargets,
                                            sources: sources,
                                            overwriteExistingPod: false,
                                            createdBy: String.Format("{0}:{1}",
@@ -464,6 +480,10 @@ protected override bool Read(string filename, Logger logger) {
     // Whether to add an main target to Podfile for Unity 2019.3+.
     private const string PREFERENCE_PODFILE_ALWAYS_ADD_MAIN_TARGET =
         PREFERENCE_NAMESPACE + "PodfileAlwaysAddMainTarget";
+    // Whether to allow the same pods to be in multiple targets, if specified in Dependecies.xml.
+    private const string PREFERENCE_PODFILE_ALLOW_PODS_IN_MULTIPLE_TARGETS =
+        PREFERENCE_NAMESPACE + "PodfileAllowPodsInMultipleTargets";
+
     // List of preference keys, used to restore default settings.
     private static string[] PREFERENCE_KEYS = new [] {
         PREFERENCE_COCOAPODS_INSTALL_ENABLED,
@@ -476,7 +496,8 @@ protected override bool Read(string filename, Logger logger) {
         PREFERENCE_SKIP_POD_INSTALL_WHEN_USING_WORKSPACE_INTEGRATION,
         PREFERENCE_PODFILE_ADD_USE_FRAMEWORKS,
         PREFERENCE_PODFILE_STATIC_LINK_FRAMEWORKS,
-        PREFERENCE_PODFILE_ALWAYS_ADD_MAIN_TARGET
+        PREFERENCE_PODFILE_ALWAYS_ADD_MAIN_TARGET,
+        PREFERENCE_PODFILE_ALLOW_PODS_IN_MULTIPLE_TARGETS
     };
 
     // Whether the xcode extension was successfully loaded.
@@ -546,6 +567,9 @@ protected override bool Read(string filename, Logger logger) {
     // Parses a source URL from a Podfile.
     private static Regex PODFILE_SOURCE_REGEX = new Regex(@"^\s*source\s+'([^']*)'");
 
+    // Parses comments from a Podfile
+    private static Regex PODFILE_COMMENT_REGEX = new Regex(@"^\s*\#");
+
     // Parses dependencies from XML dependency files.
     private static IOSXmlDependencies xmlDependencies = new IOSXmlDependencies();
 
@@ -987,6 +1011,18 @@ public static bool PodfileAlwaysAddMainTarget {
         }
     }
 
+    /// <summary>
+    /// Whether to allow the same pods to be in multiple targets, if specified in Dependecies.xml.
+    /// </summary>
+    public static bool PodfileAllowPodsInMultipleTargets {
+        get { return settings.GetBool(PREFERENCE_PODFILE_ALLOW_PODS_IN_MULTIPLE_TARGETS,
+                                    defaultValue: true); }
+        set {
+            settings.SetBool(PREFERENCE_PODFILE_ALLOW_PODS_IN_MULTIPLE_TARGETS, value);
+        }
+    }
+
+
     /// <summary>
     /// Whether to use project level settings.
     /// </summary>
@@ -1166,7 +1202,38 @@ public static void AddPod(string podName, string version = null,
         AddPodInternal(podName,
                        preformattedVersion: PodVersionExpressionFromVersionDep(version),
                        bitcodeEnabled: bitcodeEnabled, minTargetSdk: minTargetSdk,
-                       sources: sources);
+                       addToAllTargets: false, sources: sources);
+    }
+
+    /// <summary>
+    /// Tells the app what pod dependencies are needed.
+    /// This is called from a deps file in each API to aggregate all of the
+    /// dependencies to automate the Podfile generation.
+    /// </summary>
+    /// <param name="podName">pod path, for example "Google-Mobile-Ads-SDK" to
+    /// be included</param>
+    /// <param name="version">Version specification.
+    /// See PodVersionExpressionFromVersionDep for how the version string is processed.</param>
+    /// <param name="bitcodeEnabled">Whether the pod was compiled with bitcode
+    /// enabled.  If this is set to false on a pod, the entire project will
+    /// be configured with bitcode disabled.</param>
+    /// <param name="minTargetSdk">Minimum SDK revision required by this
+    /// pod.</param>
+    /// <param name="addToAllTargets">Whether to add this pod to all targets when multiple
+    /// target is supported.</param>
+    /// <param name="sources">List of sources to search for all pods.
+    /// Each source is a URL that is injected in the source section of a Podfile
+    /// See https://guides.cocoapods.org/syntax/podfile.html#source for the description of
+    /// a source.</param>
+    public static void AddPod(string podName, string version = null,
+                              bool bitcodeEnabled = true,
+                              string minTargetSdk = null,
+                              bool addToAllTargets = false,
+                              IEnumerable<string> sources = null) {
+        AddPodInternal(podName,
+                       preformattedVersion: PodVersionExpressionFromVersionDep(version),
+                       bitcodeEnabled: bitcodeEnabled, minTargetSdk: minTargetSdk,
+                       addToAllTargets: addToAllTargets, sources: sources);
     }
 
     /// <summary>
@@ -1182,6 +1249,8 @@ public static void AddPod(string podName, string version = null,
     /// be configured with bitcode disabled.</param>
     /// <param name="minTargetSdk">Minimum SDK revision required by this
     /// pod.</param>
+    /// <param name="addToAllTargets">Whether to add this pod to all targets when multiple
+    /// target is supported.</param>
     /// <param name="sources">List of sources to search for all pods.
     /// Each source is a URL that is injected in the source section of a Podfile
     /// See https://guides.cocoapods.org/syntax/podfile.html#source for the description of
@@ -1195,22 +1264,24 @@ private static void AddPodInternal(string podName,
                                        string preformattedVersion = null,
                                        bool bitcodeEnabled = true,
                                        string minTargetSdk = null,
+                                       bool addToAllTargets = false,
                                        IEnumerable<string> sources = null,
                                        bool overwriteExistingPod = true,
                                        string createdBy = null,
                                        bool fromXmlFile = false,
                                        Dictionary<string, string> propertiesByName = null) {
         var pod = new Pod(podName, preformattedVersion, bitcodeEnabled, minTargetSdk,
-                          sources, propertiesByName);
+                          addToAllTargets, sources, propertiesByName);
         pod.createdBy = createdBy ?? pod.createdBy;
         pod.fromXmlFile = fromXmlFile;
 
         Log(String.Format(
-            "AddPod - name: {0} version: {1} bitcode: {2} sdk: {3} sources: {4}, " +
-            "properties: {5}\n" +
-            "createdBy: {6}\n\n",
+            "AddPod - name: {0} version: {1} bitcode: {2} sdk: {3} alltarget: {4} " +
+            "sources: {5} properties: {6}\n" +
+            "createdBy: {7}\n\n",
             podName, preformattedVersion ?? "null", bitcodeEnabled.ToString(),
             minTargetSdk ?? "null",
+            addToAllTargets.ToString(),
             sources != null ? String.Join(", ", (new List<string>(sources)).ToArray()) : "(null)",
             Pod.PropertyDictionaryToString(pod.propertiesByName),
             createdBy ?? pod.createdBy),
@@ -1874,11 +1945,15 @@ private static void ParseUnityDeps(string unityPodfilePath) {
         var sources = new List<string>();
         while ((line = unityPodfile.ReadLine()) != null) {
             line = line.Trim();
+            if (PODFILE_COMMENT_REGEX.IsMatch(line)) {
+                continue;
+            }
             var sourceLineMatch = PODFILE_SOURCE_REGEX.Match(line);
             if (sourceLineMatch.Groups.Count > 1) {
                 sources.Add(sourceLineMatch.Groups[1].Value);
                 continue;
             }
+            // TODO: Properly support multiple targets.
             if (line.StartsWith("target 'Unity-iPhone' do")) {
                 capturingPodsDepth++;
                 continue;
@@ -2000,6 +2075,20 @@ public static void GenPodfile(BuildTarget buildTarget,
 
             if (MultipleXcodeTargetsSupported && PodfileAlwaysAddMainTarget) {
                 file.WriteLine(String.Format("target '{0}' do", "Unity-iPhone"));
+                bool allowPodsInMultipleTargets = PodfileAllowPodsInMultipleTargets;
+                int podAdded = 0;
+                foreach(var pod in pods.Values) {
+                    if (pod.addToAllTargets) {
+                        file.WriteLine(String.Format("  {0}{1}",
+                                allowPodsInMultipleTargets ? "" : "# ",
+                                pod.PodFilePodLine));
+                        podAdded++;
+                    }
+                }
+                if (!allowPodsInMultipleTargets && podAdded > 0) {
+                    file.WriteLine(String.Format(
+                        "  # Commented due to iOS Resolver settings."));
+                }
                 file.WriteLine("end");
             }
             if (PodfileAddUseFrameworks) {

source/IOSResolver/src/IOSResolverSettingsDialog.cs

@@ -39,6 +39,7 @@ private class Settings {
         internal bool podfileAddUseFrameworks;
         internal bool podfileStaticLinkFrameworks;
         internal bool podfileAlwaysAddMainTarget;
+        internal bool podfileAllowPodsInMultipleTargets;
         internal bool useProjectSettings;
         internal EditorMeasurement.Settings analyticsSettings;
 
@@ -55,6 +56,7 @@ internal Settings() {
             podfileAddUseFrameworks = IOSResolver.PodfileAddUseFrameworks;
             podfileStaticLinkFrameworks = IOSResolver.PodfileStaticLinkFrameworks;
             podfileAlwaysAddMainTarget = IOSResolver.PodfileAlwaysAddMainTarget;
+            podfileAllowPodsInMultipleTargets = IOSResolver.PodfileAllowPodsInMultipleTargets;
             useProjectSettings = IOSResolver.UseProjectSettings;
             analyticsSettings = new EditorMeasurement.Settings(IOSResolver.analytics);
         }
@@ -72,6 +74,7 @@ internal void Save() {
             IOSResolver.PodfileAddUseFrameworks = podfileAddUseFrameworks;
             IOSResolver.PodfileStaticLinkFrameworks = podfileStaticLinkFrameworks;
             IOSResolver.PodfileAlwaysAddMainTarget = podfileAlwaysAddMainTarget;
+            IOSResolver.PodfileAllowPodsInMultipleTargets = podfileAllowPodsInMultipleTargets;
             IOSResolver.UseProjectSettings = useProjectSettings;
             analyticsSettings.Save();
         }
@@ -104,7 +107,7 @@ private static int FindIndexFromCocoapodsIntegrationMethod(
     }
 
     public void Initialize() {
-        minSize = new Vector2(400, 650);
+        minSize = new Vector2(400, 700);
         position = new Rect(UnityEngine.Screen.width / 3, UnityEngine.Screen.height / 3,
                             minSize.x, minSize.y);
     }
@@ -221,6 +224,18 @@ public void OnGUI() {
                 GUILayout.Label("Add the following lines to Podfile.");
                 GUILayout.Label("  target 'Unity-iPhone' do\n" +
                                 "  end");
+
+                if (settings.podfileAlwaysAddMainTarget) {
+                    GUILayout.BeginHorizontal();
+                    GUILayout.Label("Allow the same pod to be in multiple targets",
+                        EditorStyles.boldLabel);
+                    settings.podfileAllowPodsInMultipleTargets =
+                        EditorGUILayout.Toggle(settings.podfileAllowPodsInMultipleTargets);
+                    GUILayout.EndHorizontal();
+
+                    GUILayout.Label("Allow to add the same pod to multiple targets, if specified in " +
+                                    "Dependencies.xml with 'addToAllTargets' attribute.");
+                }
             }
 
             GUILayout.Box("", GUILayout.ExpandWidth(true), GUILayout.Height(1));
@@ -283,6 +298,9 @@ public void OnGUI() {
                     new KeyValuePair<string, string>(
                         "podfileAlwaysAddMainTarget",
                         IOSResolver.PodfileAlwaysAddMainTarget.ToString()),
+                    new KeyValuePair<string, string>(
+                        "podfileAllowPodsInMultipleTargets",
+                        IOSResolver.PodfileAllowPodsInMultipleTargets.ToString()),
                 },
                 "Settings Save");
             settings.Save();