Merge branch 'master' into enhancements/subview-is-busy

Author: StanleyGoldman

GitHub.Unity.sln.DotSettings

@@ -341,4 +341,6 @@
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EAddAccessorOwnerDeclarationBracesMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EAlwaysTreatStructAsNotReorderableMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateBlankLinesAroundFieldToBlankLinesAroundProperty/@EntryIndexedValue">True</s:Boolean>
-	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateThisQualifierSettings/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateThisQualifierSettings/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/UnitTesting/ShadowCopy/@EntryValue">False</s:Boolean>
+	</wpf:ResourceDictionary>

README.md

@@ -2,7 +2,7 @@
 
 ## Notices
 
-From version 0.19 onwards, the location of the plugin has moved to `Assets/Plugins/GitHub`. If you have version 0.18 or lower, you need to delete the `Assets/Editor/GitHub` folder before you install newer versions. You should exit Unity and delete the folder from Explorer/Finder, as Unity will not unload native libraries while it's running.
+From version 0.19 onwards, the location of the plugin has moved to `Assets/Plugins/GitHub`. If you have version 0.18 or lower, you need to delete the `Assets/Editor/GitHub` folder before you install newer versions. You should exit Unity and delete the folder from Explorer/Finder, as Unity will not unload native libraries while it's running. Also, remember to update your `.gitignore` file.
 
 ![Build Status](https://ci.appveyor.com/api/projects/status/github/github-for-unity/Unity?branch=master&svg=true)
 
@@ -81,7 +81,11 @@ Once the extension is installed, you can open a command line with the same Git a
 
 ### Installation
 
-To install the extension, download the latest package from [the releases page](https://github.com/github-for-unity/Unity/releases) and double click on it.
+This extensions needs to be installed (and updated) for each Unity project that you want to version control. 
+First step is to download the latest package from [the releases page](https://github.com/github-for-unity/Unity/releases);
+it will be saved as a file with the extension `.unitypackage`.
+To install it, open Unity, then open the project you want to version control, and then double click on the downloaded package.
+Alternatively, import the package by clicking Assets, Import Package, Custom Package, then select the downloaded package.
 
 #### Log files
 

src/UnityExtension/Assets/Editor/GitHub.Unity/ApplicationCache.cs

@@ -126,52 +126,52 @@ public List<GitBranch> RemoteBranches
     }
 
     [Location("views/branches.yaml", LocationAttribute.Location.LibraryFolder)]
-    sealed class Favourites : ScriptObjectSingleton<Favourites>
+    sealed class Favorites : ScriptObjectSingleton<Favorites>
     {
-        [SerializeField] private List<string> favouriteBranches;
-        public List<string> FavouriteBranches
+        [SerializeField] private List<string> favoriteBranches;
+        public List<string> FavoriteBranches
         {
             get
             {
-                if (favouriteBranches == null)
-                    FavouriteBranches = new List<string>();
-                return favouriteBranches;
+                if (favoriteBranches == null)
+                    FavoriteBranches = new List<string>();
+                return favoriteBranches;
             }
             set
             {
-                favouriteBranches = value;
+                favoriteBranches = value;
                 Save(true);
             }
         }
 
-        public void SetFavourite(string branchName)
+        public void SetFavorite(string branchName)
         {
-            if (FavouriteBranches.Contains(branchName))
+            if (FavoriteBranches.Contains(branchName))
                 return;
-            FavouriteBranches.Add(branchName);
+            FavoriteBranches.Add(branchName);
             Save(true);
         }
 
-        public void UnsetFavourite(string branchName)
+        public void UnsetFavorite(string branchName)
         {
-            if (!FavouriteBranches.Contains(branchName))
+            if (!FavoriteBranches.Contains(branchName))
                 return;
-            FavouriteBranches.Remove(branchName);
+            FavoriteBranches.Remove(branchName);
             Save(true);
         }
 
-        public void ToggleFavourite(string branchName)
+        public void ToggleFavorite(string branchName)
         {
-            if (FavouriteBranches.Contains(branchName))
-                FavouriteBranches.Remove(branchName);
+            if (FavoriteBranches.Contains(branchName))
+                FavoriteBranches.Remove(branchName);
             else
-                FavouriteBranches.Add(branchName);
+                FavoriteBranches.Add(branchName);
             Save(true);
         }
 
-        public bool IsFavourite(string branchName)
+        public bool IsFavorite(string branchName)
         {
-            return FavouriteBranches.Contains(branchName);
+            return FavoriteBranches.Contains(branchName);
         }
     }
 

src/UnityExtension/Assets/Editor/GitHub.Unity/Misc/Styles.cs

@@ -84,8 +84,8 @@ class Styles
         private static Texture2D branchIcon,
                                  activeBranchIcon,
                                  trackingBranchIcon,
-                                 favouriteIconOn,
-                                 favouriteIconOff,
+                                 favoriteIconOn,
+                                 favoriteIconOff,
                                  smallLogoIcon,
                                  bigLogoIcon,
                                  defaultAssetIcon,
@@ -663,29 +663,29 @@ public static Texture2D TrackingBranchIcon
             }
         }
 
-        public static Texture2D FavouriteIconOn
+        public static Texture2D FavoriteIconOn
         {
             get
             {
-                if (favouriteIconOn == null)
+                if (favoriteIconOn == null)
                 {
-                    favouriteIconOn = Utility.GetIcon("favorite-branch-indicator.png");
+                    favoriteIconOn = Utility.GetIcon("favorite-branch-indicator.png");
                 }
 
-                return favouriteIconOn;
+                return favoriteIconOn;
             }
         }
 
-        public static Texture2D FavouriteIconOff
+        public static Texture2D FavoriteIconOff
         {
             get
             {
-                if (favouriteIconOff == null)
+                if (favoriteIconOff == null)
                 {
-                    favouriteIconOff = FolderIcon;
+                    favoriteIconOff = FolderIcon;
                 }
 
-                return favouriteIconOff;
+                return favoriteIconOff;
             }
         }
 

src/UnityExtension/Assets/Editor/GitHub.Unity/UI/BranchesView.cs

@@ -38,11 +38,12 @@ class BranchesView : Subview
         private bool showLocalBranches = true;
         private bool showRemoteBranches = true;
 
-        [NonSerialized] private List<BranchTreeNode> favourites = new List<BranchTreeNode>();
+        [NonSerialized] private List<BranchTreeNode> favorites = new List<BranchTreeNode>();
         [NonSerialized] private int listID = -1;
         [NonSerialized] private List<GitBranch> newLocalBranches;
         [NonSerialized] private BranchTreeNode newNodeSelection;
         [NonSerialized] private BranchesMode targetMode;
+        [NonSerialized] private bool favoritesHasChanged;
 
         [SerializeField] private BranchTreeNode activeBranchNode;
         [SerializeField] private BranchTreeNode localRoot;
@@ -51,6 +52,7 @@ class BranchesView : Subview
         [SerializeField] private List<Remote> remotes = new List<Remote>();
         [SerializeField] private Vector2 scroll;
         [SerializeField] private BranchTreeNode selectedNode;
+        private List<string> favoritesList;
 
         public override void InitializeView(IView parent)
         {
@@ -62,6 +64,7 @@ public override void OnEnable()
         {
             base.OnEnable();
             AttachHandlers(Repository);
+            favoritesHasChanged = true;
         }
 
         public override void OnDisable()
@@ -70,6 +73,21 @@ public override void OnDisable()
             DetachHandlers(Repository);
         }
 
+        public override void OnDataUpdate()
+        {
+            base.OnDataUpdate();
+            MaybeUpdateData();
+        }
+
+        private void MaybeUpdateData()
+        {
+            if (favoritesHasChanged)
+            {
+                favoritesList = Manager.LocalSettings.Get(FavoritesSetting, new List<string>());
+                favoritesHasChanged = false;
+            }
+        }
+
         public override void OnRepositoryChanged(IRepository oldRepository)
         {
             base.OnRepositoryChanged(oldRepository);
@@ -142,17 +160,17 @@ public void OnEmbeddedGUI()
 
                 GUILayout.BeginVertical(Styles.CommitFileAreaStyle);
                 {
-                    // Favourites list
-                    if (favourites.Count > 0)
+                    // Favorites list
+                    if (favorites.Count > 0)
                     {
                         GUILayout.Label(FavoritesTitle);
                         GUILayout.BeginHorizontal();
                         {
                             GUILayout.BeginVertical();
                             {
-                                for (var index = 0; index < favourites.Count; ++index)
+                                for (var index = 0; index < favorites.Count; ++index)
                                 {
-                                    OnTreeNodeGUI(favourites[index]);
+                                    OnTreeNodeGUI(favorites[index]);
                                 }
                             }
 
@@ -246,12 +264,12 @@ public void OnEmbeddedGUI()
 
         private int CompareBranches(GitBranch a, GitBranch b)
         {
-            if (GetFavourite(a.Name))
+            if (IsFavorite(a.Name))
             {
                 return -1;
             }
 
-            if (GetFavourite(b.Name))
+            if (IsFavorite(b.Name))
             {
                 return 1;
             }
@@ -269,19 +287,9 @@ private int CompareBranches(GitBranch a, GitBranch b)
             return 0;
         }
 
-        private bool GetFavourite(BranchTreeNode branch)
-        {
-            return GetFavourite(branch.Name);
-        }
-
-        private bool GetFavourite(string branchName)
+        private bool IsFavorite(string branchName)
         {
-            if (string.IsNullOrEmpty(branchName))
-            {
-                return false;
-            }
-
-            return Manager.LocalSettings.Get(FavoritesSetting, new List<string>()).Contains(branchName);
+            return !String.IsNullOrEmpty(branchName) && favoritesList.Contains(branchName);
         }
 
         private void OnLocalBranchesUpdate(IEnumerable<GitBranch> list)
@@ -310,9 +318,8 @@ private void BuildTree(IEnumerable<GitBranch> local, IEnumerable<GitBranch> remo
             var tracking = new List<KeyValuePair<int, int>>();
             var localBranchNodes = new List<BranchTreeNode>();
 
-            // Prepare for updated favourites listing
-            favourites.Clear();
-            var cachedFavs = Manager.LocalSettings.Get<List<string>>(FavoritesSetting, new List<string>());
+            // Prepare for updated favorites listing
+            favorites.Clear();
 
             // Just build directly on the local root, keep track of active branch
             localRoot = new BranchTreeNode("", NodeType.Folder, false);
@@ -341,10 +348,10 @@ private void BuildTree(IEnumerable<GitBranch> local, IEnumerable<GitBranch> remo
                     }
                 }
 
-                // Add to favourites
-                if (cachedFavs.Contains(branch.Name))
+                // Add to favorites
+                if (favoritesList.Contains(branch.Name))
                 {
-                    favourites.Add(node);
+                    favorites.Add(node);
                 }
 
                 // Build into tree
@@ -385,10 +392,10 @@ private void BuildTree(IEnumerable<GitBranch> local, IEnumerable<GitBranch> remo
                     }
                 }
 
-                // Add to favourites
-                if (cachedFavs.Contains(branch.Name))
+                // Add to favorites
+                if (favoritesList.Contains(branch.Name))
                 {
-                    favourites.Add(node);
+                    favorites.Add(node);
                 }
 
                 // Build on the root of the remote, just like with locals
@@ -423,23 +430,23 @@ private void BuildTree(BranchTreeNode parent, BranchTreeNode child)
             BuildTree(folder, child);
         }
 
-        private void SetFavourite(BranchTreeNode branch, bool favourite)
+        private void SetFavorite(BranchTreeNode branch, bool favorite)
         {
             if (string.IsNullOrEmpty(branch.Name))
             {
                 return;
             }
 
-            if (!favourite)
+            if (!favorite)
             {
-                favourites.Remove(branch);
-                Manager.LocalSettings.Set(FavoritesSetting, favourites.Select(x => x.Name).ToList());
+                favorites.Remove(branch);
+                Manager.LocalSettings.Set(FavoritesSetting, favorites.Select(x => x.Name).ToList());
             }
             else
             {
-                favourites.Remove(branch);
-                favourites.Add(branch);
-                Manager.LocalSettings.Set(FavoritesSetting, favourites.Select(x => x.Name).ToList());
+                favorites.Remove(branch);
+                favorites.Add(branch);
+                Manager.LocalSettings.Set(FavoritesSetting, favorites.Select(x => x.Name).ToList());
             }
         }
 
@@ -582,12 +589,12 @@ private void OnTreeNodeGUI(BranchTreeNode node)
             var style = node.Active ? Styles.BoldLabel : Styles.Label;
             var rect = GUILayoutUtility.GetRect(content, style, GUILayout.MaxHeight(EditorGUIUtility.singleLineHeight));
             var clickRect = new Rect(0f, rect.y, Position.width, rect.height);
-            var favouriteRect = new Rect(clickRect.xMax - clickRect.height * 2f, clickRect.y, clickRect.height, clickRect.height);
+            var favoriteRect = new Rect(clickRect.xMax - clickRect.height * 2f, clickRect.y, clickRect.height, clickRect.height);
 
             var selected = selectedNode == node;
             var keyboardFocus = GUIUtility.keyboardControl == listID;
 
-            // Selection highlight and favourite toggle
+            // Selection highlight and favorite toggle
             if (selected)
             {
                 if (Event.current.type == EventType.Repaint)
@@ -597,22 +604,22 @@ private void OnTreeNodeGUI(BranchTreeNode node)
 
                 if (node.Type != NodeType.Folder)
                 {
-                    var favourite = GetFavourite(node);
+                    var favorite = IsFavorite(node.Name);
                     if (Event.current.type == EventType.Repaint)
                     {
-                        GUI.DrawTexture(favouriteRect, favourite ? Styles.FavouriteIconOn : Styles.FavouriteIconOff);
+                        GUI.DrawTexture(favoriteRect, favorite ? Styles.FavoriteIconOn : Styles.FavoriteIconOff);
                     }
-                    else if (Event.current.type == EventType.MouseDown && favouriteRect.Contains(Event.current.mousePosition))
+                    else if (Event.current.type == EventType.MouseDown && favoriteRect.Contains(Event.current.mousePosition))
                     {
-                        SetFavourite(node, !favourite);
+                        SetFavorite(node, !favorite);
                         Event.current.Use();
                     }
                 }
             }
-            // Favourite status
-            else if (Event.current.type == EventType.Repaint && node.Type != NodeType.Folder && GetFavourite(node.Name))
+            // Favorite status
+            else if (Event.current.type == EventType.Repaint && node.Type != NodeType.Folder && IsFavorite(node.Name))
             {
-                GUI.DrawTexture(favouriteRect, Styles.FavouriteIconOn);
+                GUI.DrawTexture(favoriteRect, Styles.FavoriteIconOn);
             }
 
             // The actual icon and label