Support for project level settings.

Allows storage of project level settings for all components of the
Play Services Resolver plugin.

* Moved common logging logic into a common module.
* Moved xml utilities module into VersionHandlerImpl so that it can be
  shared by other components.
* Added ProjectSettings class which stores settings with a project and
  allows a user to switch between project vs. application level settings.
  By default all settings are now per-project rather than application wide.
  Application settings are applied where project settings are currently not
  available to enable the transition of user's existing application level
  settings to project level settings.

Bug: 36280202
Change-Id: I5340068a1da5b642cb9288fc566970a2bd5d6bd7

Author: Stewart Miles

CHANGELOG.md

@@ -1,3 +1,12 @@
+# Version 1.2.48 - Sep 12, 2017
+## New Features
+* Changed settings to be per-project by default.
+
+## Bug Fixes
+* Added Google maven repository to fix GradlePrebuild resolution with Google
+  components.
+* Fixed Android Resolution failure with spaces in paths.
+
 # Version 1.2.47 - Aug 29, 2017
 ## New Features
 * Android and iOS dependencies can now be specified using *Dependencies.xml

exploded/Assets/PlayServicesResolver/Editor.meta

@@ -194,7 +194,7 @@ public IOSXmlDependencies() {
         /// Read XML declared dependencies.
         /// </summary>
         /// <param name="filename">File to read.</param>
-        /// <param name="logger">Logging delegate.</param>
+        /// <param name="logger">Logger to log with.</param>
         ///
         /// Parses dependencies in the form:
         ///
@@ -210,8 +210,7 @@ public IOSXmlDependencies() {
         ///     </iosPod>
         ///   </iosPods>
         /// </dependencies>
-        protected override bool Read(string filename,
-                                     PlayServicesSupport.LogMessageWithLevel logger) {
+        protected override bool Read(string filename, Logger logger) {
             IOSResolver.Log(String.Format("Reading iOS dependency XML file {0}", filename),
                             verbose: true);
             var sources = new List<string>();
@@ -242,10 +241,10 @@ protected override bool Read(string filename,
                             minTargetSdk = reader.GetAttribute("minTargetSdk");
                             sources = new List<string>();
                             if (podName == null) {
-                                logger(
+                                logger.Log(
                                     String.Format("Pod name not specified while reading {0}:{1}\n",
                                                   filename, reader.LineNumber),
-                                    level: PlayServicesSupport.LogLevel.Warning);
+                                    level: LogLevel.Warning);
                                 return false;
                             }
                         } else {
@@ -415,6 +414,9 @@ protected override bool Read(string filename,
     // Parses dependencies from XML dependency files.
     private static IOSXmlDependencies xmlDependencies = new IOSXmlDependencies();
 
+    // Project level settings for this module.
+    private static ProjectSettings settings = new ProjectSettings(PREFERENCE_NAMESPACE);
+
     // Search for a file up to a maximum search depth stopping the
     // depth first search each time the specified file is found.
     private static List<string> FindFile(
@@ -545,7 +547,7 @@ exception is TypeInitializationException ||
         // Prompt the user to use workspaces if they aren't at least using project level
         // integration.
         if (EditorUserBuildSettings.activeBuildTarget == BuildTarget.iOS &&
-            (CocoapodsIntegrationMethod)EditorPrefs.GetInt(PREFERENCE_COCOAPODS_INTEGRATION_METHOD,
+            (CocoapodsIntegrationMethod)settings.GetInt(PREFERENCE_COCOAPODS_INTEGRATION_METHOD,
                 CocoapodsIntegrationUpgradeDefault) == CocoapodsIntegrationMethod.None &&
             !InBatchMode && !UpgradeToWorkspaceWarningDisabled) {
 
@@ -557,8 +559,8 @@ exception is TypeInitializationException ||
                 "to integrating Cocoapods with the .xcodeproj file.\n",
                 "Yes", "Not Now", "Silence Warning")) {
                 case 0:  // Yes
-                    EditorPrefs.SetInt(PREFERENCE_COCOAPODS_INTEGRATION_METHOD,
-                                       (int)CocoapodsIntegrationMethod.Workspace);
+                    settings.SetInt(PREFERENCE_COCOAPODS_INTEGRATION_METHOD,
+                                    (int)CocoapodsIntegrationMethod.Workspace);
                     break;
                 case 1:  // Not now
                     break;
@@ -602,7 +604,7 @@ public static void RemapXcodeExtension() {
     /// Reset settings of this plugin to default values.
     /// </summary>
     internal static void RestoreDefaultSettings() {
-        VersionHandlerImpl.RestoreDefaultSettings(PREFERENCE_KEYS);
+        settings.DeleteKeys(PREFERENCE_KEYS);
     }
 
     /// <summary>
@@ -630,11 +632,11 @@ private static int CocoapodsIntegrationUpgradeDefault {
     /// </summary>
     public static CocoapodsIntegrationMethod CocoapodsIntegrationMethodPref {
         get {
-            return (CocoapodsIntegrationMethod)EditorPrefs.GetInt(
+            return (CocoapodsIntegrationMethod)settings.GetInt(
                 PREFERENCE_COCOAPODS_INTEGRATION_METHOD,
                 defaultValue: CocoapodsIntegrationUpgradeDefault);
         }
-        set { EditorPrefs.SetInt(PREFERENCE_COCOAPODS_INTEGRATION_METHOD, (int)value); }
+        set { settings.SetInt(PREFERENCE_COCOAPODS_INTEGRATION_METHOD, (int)value); }
     }
 
     /// <summary>
@@ -654,57 +656,62 @@ public static bool CocoapodsInstallEnabled {
     /// CocoapodsIntegrationEnabled.
     /// </summary>
     private static bool LegacyCocoapodsInstallEnabled {
-        get { return EditorPrefs.GetBool(PREFERENCE_COCOAPODS_INSTALL_ENABLED,
+        get { return settings.GetBool(PREFERENCE_COCOAPODS_INSTALL_ENABLED,
                                          defaultValue: true); }
-        set { EditorPrefs.SetBool(PREFERENCE_COCOAPODS_INSTALL_ENABLED, value); }
+        set { settings.SetBool(PREFERENCE_COCOAPODS_INSTALL_ENABLED, value); }
     }
 
     /// <summary>
     /// Enable / disable Podfile generation.
     /// </summary>
     public static bool PodfileGenerationEnabled {
-        get { return EditorPrefs.GetBool(PREFERENCE_PODFILE_GENERATION_ENABLED,
+        get { return settings.GetBool(PREFERENCE_PODFILE_GENERATION_ENABLED,
                                          defaultValue: true); }
-        set { EditorPrefs.SetBool(PREFERENCE_PODFILE_GENERATION_ENABLED, value); }
+        set { settings.SetBool(PREFERENCE_PODFILE_GENERATION_ENABLED, value); }
     }
 
     /// <summary>
     /// Enable / disable execution of the pod tool via the shell.
     /// </summary>
     public static bool PodToolExecutionViaShellEnabled {
-        get { return EditorPrefs.GetBool(PREFERENCE_POD_TOOL_EXECUTION_VIA_SHELL_ENABLED,
-                                         defaultValue: false); }
-        set { EditorPrefs.SetBool(PREFERENCE_POD_TOOL_EXECUTION_VIA_SHELL_ENABLED, value); }
+        get { return settings.GetBool(PREFERENCE_POD_TOOL_EXECUTION_VIA_SHELL_ENABLED,
+                                      defaultValue: false); }
+        set { settings.SetBool(PREFERENCE_POD_TOOL_EXECUTION_VIA_SHELL_ENABLED, value); }
     }
 
     /// <summary>
     /// Enable automated pod tool installation in the editor.  This is only performed when the
     /// editor isn't launched in batch mode.
     /// </summary>
     public static bool AutoPodToolInstallInEditorEnabled {
-        get { return EditorPrefs.GetBool(PREFERENCE_AUTO_POD_TOOL_INSTALL_IN_EDITOR,
-                                         defaultValue: true); }
-        set { EditorPrefs.SetBool(PREFERENCE_AUTO_POD_TOOL_INSTALL_IN_EDITOR, value); }
+        get { return settings.GetBool(PREFERENCE_AUTO_POD_TOOL_INSTALL_IN_EDITOR,
+                                      defaultValue: true); }
+        set { settings.SetBool(PREFERENCE_AUTO_POD_TOOL_INSTALL_IN_EDITOR, value); }
     }
 
     /// <summary>
     /// Get / set the nag prompt disabler setting for turning on workspace integration.
     /// </summary>
     public static bool UpgradeToWorkspaceWarningDisabled {
-        get { return EditorPrefs.GetBool(PREFERENCE_WARN_UPGRADE_WORKSPACE,
-                                         defaultValue: false); }
-        set { EditorPrefs.SetBool(PREFERENCE_WARN_UPGRADE_WORKSPACE, value); }
+        get { return settings.GetBool(PREFERENCE_WARN_UPGRADE_WORKSPACE, defaultValue: false); }
+        set { settings.SetBool(PREFERENCE_WARN_UPGRADE_WORKSPACE, value); }
     }
 
     /// <summary>
     /// Enable / disable verbose logging.
     /// </summary>
     public static bool VerboseLoggingEnabled {
-        get { return EditorPrefs.GetBool(PREFERENCE_VERBOSE_LOGGING_ENABLED,
-                                         defaultValue: false); }
-        set { EditorPrefs.SetBool(PREFERENCE_VERBOSE_LOGGING_ENABLED, value); }
+        get { return settings.GetBool(PREFERENCE_VERBOSE_LOGGING_ENABLED, defaultValue: false); }
+        set { settings.SetBool(PREFERENCE_VERBOSE_LOGGING_ENABLED, value); }
     }
 
+    /// <summary>
+    /// Whether to use project level settings.
+    /// </summary>
+    public static bool UseProjectSettings {
+        get { return settings.UseProjectSettings; }
+        set { settings.UseProjectSettings = value; }
+    }
 
     /// <summary>
     /// Determine whether it's possible to perform iOS dependency injection.
@@ -779,18 +786,11 @@ public static bool CocoapodsIntegrationEnabled {
         }
     }
 
-    /// <summary>
-    /// Log severity.
-    /// </summary>
-    internal enum LogLevel {
-        Info,
-        Warning,
-        Error,
-    };
-
     private delegate void LogMessageDelegate(string message, bool verbose = false,
                                             LogLevel level = LogLevel.Info);
 
+    private static Google.Logger logger = new Google.Logger();
+
     /// <summary>
     /// Log a message.
     /// </summary>
@@ -800,19 +800,8 @@ private delegate void LogMessageDelegate(string message, bool verbose = false,
     /// <param name="level">Severity of the message.</param>
     internal static void Log(string message, bool verbose = false,
                              LogLevel level = LogLevel.Info) {
-        if (!verbose || VerboseLoggingEnabled || InBatchMode) {
-            switch (level) {
-                case LogLevel.Info:
-                    Debug.Log(message);
-                    break;
-                case LogLevel.Warning:
-                    Debug.LogWarning(message);
-                    break;
-                case LogLevel.Error:
-                    Debug.LogError(message);
-                    break;
-            }
-        }
+        logger.Level = (VerboseLoggingEnabled || InBatchMode) ? LogLevel.Verbose : LogLevel.Info;
+        logger.Log(message, level: verbose ? LogLevel.Verbose : level);
     }
 
     /// <summary>
@@ -2432,7 +2421,7 @@ private static void RefreshXmlDependencies() {
             pods.Remove(podName);
         }
         // Read pod specifications from XML dependencies.
-        xmlDependencies.ReadAll(IOSXmlDependencies.LogMessage);
+        xmlDependencies.ReadAll(logger);
     }
 
     /// <summary>

exploded/Assets/PlayServicesResolver/Editor/Google.IOSResolver_v1.2.48.0.dll

@@ -35,6 +35,7 @@ private class Settings {
         internal bool autoPodToolInstallInEditorEnabled;
         internal bool verboseLoggingEnabled;
         internal int cocoapodsIntegrationMenuIndex;
+        internal bool useProjectSettings;
 
         /// <summary>
         /// Load settings into the dialog.
@@ -47,6 +48,7 @@ internal Settings() {
             verboseLoggingEnabled = IOSResolver.VerboseLoggingEnabled;
             cocoapodsIntegrationMenuIndex = FindIndexFromCocoapodsIntegrationMethod(
                 IOSResolver.CocoapodsIntegrationMethodPref);
+            useProjectSettings = IOSResolver.UseProjectSettings;
         }
 
         /// <summary>
@@ -60,6 +62,7 @@ internal void Save() {
             IOSResolver.VerboseLoggingEnabled = verboseLoggingEnabled;
             IOSResolver.CocoapodsIntegrationMethodPref =
                 integrationMapping[cocoapodsIntegrationMenuIndex];
+            IOSResolver.UseProjectSettings = useProjectSettings;
         }
     }
 
@@ -170,6 +173,11 @@ public void OnGUI() {
         settings.verboseLoggingEnabled = EditorGUILayout.Toggle(settings.verboseLoggingEnabled);
         GUILayout.EndHorizontal();
 
+        GUILayout.BeginHorizontal();
+        GUILayout.Label("Use project settings", EditorStyles.boldLabel);
+        settings.useProjectSettings = EditorGUILayout.Toggle(settings.useProjectSettings);
+        GUILayout.EndHorizontal();
+
         GUILayout.Space(10);
 
         if (GUILayout.Button("Reset to Defaults")) {

exploded/Assets/PlayServicesResolver/Editor/Google.IOSResolver_v1.2.48.0.dll.meta

@@ -67,7 +67,6 @@
     <Compile Include="src\TextAreaDialog.cs" />
     <Compile Include="src\UnityCompat.cs" />
     <Compile Include="src\XmlDependencies.cs" />
-    <Compile Include="src\XmlUtilities.cs" />
     <Compile Include="..\JarResolverLib\src\Google.JarResolver\Dependency.cs">
       <Link>Google.JarResolver\Dependency.cs</Link>
     </Compile>

exploded/Assets/PlayServicesResolver/Editor/Google.JarResolver_v1.2.48.0.dll

@@ -19,6 +19,7 @@ namespace GooglePlayServices {
     using System;
     using System.Collections.Generic;
     using System.Xml;
+    using Google;
     using Google.JarResolver;
     using UnityEditor;
 
@@ -35,8 +36,8 @@ public AndroidXmlDependencies() {
         /// <summary>
         /// Read XML declared dependencies.
         /// </summary>
-        /// <param name="svcSupport">Instance to add dependencies to.</param>
         /// <param name="filename">File to read.</param>
+        /// <param name="logger">Logger instance to log with.</param>
         ///
         /// Parses dependencies in the form:
         ///
@@ -52,16 +53,15 @@ public AndroidXmlDependencies() {
         ///     </androidPackage>
         ///   </androidPackages>
         /// </dependencies>
-        protected override bool Read(string filename,
-                                     PlayServicesSupport.LogMessageWithLevel logger) {
+        protected override bool Read(string filename, Logger logger) {
             List<string> androidSdkPackageIds = null;
             string group = null;
             string artifact = null;
             string versionSpec = null;
             List<string> repositories = null;
-            PlayServicesSupport.Log(
+            logger.Log(
                 String.Format("Reading Android dependency XML file {0}", filename),
-                verbose: true);
+                level: LogLevel.Verbose);
 
             if (!XmlUtilities.ParseXmlTextFileElements(
                 filename, logger,
@@ -85,12 +85,12 @@ protected override bool Read(string filename,
                             var spec = reader.GetAttribute("spec") ?? "";
                             var specComponents = spec.Split(new [] { ':' });
                             if (specComponents.Length != 3) {
-                                logger(
+                                logger.Log(
                                     String.Format(
                                         "Ignoring invalid package specification '{0}' " +
                                         "while reading {1}:{2}\n",
                                         spec, filename, reader.LineNumber),
-                                    level: PlayServicesSupport.LogLevel.Warning);
+                                    level: LogLevel.Warning);
                                 return false;
                             }
                             group = specComponents[0];
@@ -136,7 +136,8 @@ protected override bool Read(string filename,
         /// <summary>
         /// Find and read all XML declared dependencies.
         /// </summary>
-        public override bool ReadAll(PlayServicesSupport.LogMessageWithLevel logger) {
+        /// <param name="logger">Logger to log with.</param>
+        public override bool ReadAll(Logger logger) {
             const string XML_DEPENDENCIES_INSTANCE = "InternalXmlDependencies";
             if (PlayServicesSupport.instances.TryGetValue(XML_DEPENDENCIES_INSTANCE,
                                                           out svcSupport)) {