Address some messages (synthetic commit by lisias)

blowfishpro · Lisias · commit 44196b8fed7f · 2020-07-11T06:41:20.000-03:00
Do some dependency in jection on InterceptLogHandler, no need to hold onto a reference to it as Unity will

Remove paramter checks in StreamLogger as StreamWriter does the same checks Ibut keep basic tests for them)
diff --git a/Source/ModuleManager/Cats/CatAnimator.cs b/Source/ModuleManager/Cats/CatAnimator.cs
@@ -1,4 +1,5 @@
 ﻿using System.Collections;
+using System.Diagnostics.CodeAnalysis;
 using UnityEngine;
 
 #if CATS
@@ -13,6 +14,7 @@ class CatAnimator : MonoBehaviour
         private SpriteRenderer spriteRenderer;
         private int spriteIdx;
 
+        [SuppressMessage("CodeQuality", "IDE0051", Justification = "Called by Unity")]
         void Start()
         {
             spriteRenderer = this.GetComponent<SpriteRenderer>();
diff --git a/Source/ModuleManager/Cats/CatManager.cs b/Source/ModuleManager/Cats/CatManager.cs
@@ -16,7 +16,7 @@ public static void LaunchCat()
             InitCats();
 
             GameObject cat = LaunchCat(scale);
-            CatMover catMover = cat.AddComponent<CatMover>();
+            cat.AddComponent<CatMover>();
         }
 
         public static void LaunchCats()
diff --git a/Source/ModuleManager/Cats/CatMover.cs b/Source/ModuleManager/Cats/CatMover.cs
@@ -1,4 +1,4 @@
-﻿using System.Collections;
+﻿using System.Diagnostics.CodeAnalysis;
 using UnityEngine;
 
 #if CATS
@@ -25,6 +25,7 @@ public class CatMover : MonoBehaviour
         private bool clearTrail = false;
 
         // Use this for initialization
+        [SuppressMessage("CodeQuality", "IDE0051", Justification = "Called by Unity")]
         void Start()
         {
             trail = this.GetComponent<TrailRenderer>();
@@ -42,6 +43,7 @@ void Start()
             clearTrail = true;
         }
 
+        [SuppressMessage("CodeQuality", "IDE0051", Justification = "Called by Unity")]
         void Update()
         {
             if (trail.time <= 0f)
diff --git a/Source/ModuleManager/Cats/CatOrbiter.cs b/Source/ModuleManager/Cats/CatOrbiter.cs
@@ -1,5 +1,6 @@
 ﻿using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using KSP.UI;
 using UnityEngine;
 using Random = UnityEngine.Random;
@@ -9,7 +10,7 @@ namespace ModuleManager.Cats
 {
     class CatOrbiter : MonoBehaviour
     {
-        private static List<CatOrbiter> orbiters = new List<CatOrbiter>();
+        private static readonly List<CatOrbiter> orbiters = new List<CatOrbiter>();
 
         private static CatOrbiter sun;
 
@@ -21,7 +22,7 @@ class CatOrbiter : MonoBehaviour
         private Vector2d force;
         private float scale = 1;
 
-        private double G = 6.67408E-11;
+        private const double G = 6.67408E-11;
 
         public double Mass
         {
@@ -113,13 +114,14 @@ private void DoForces()
             }
         }
 
-
+        [SuppressMessage("CodeQuality", "IDE0051", Justification = "Called by Unity")]
         void OnDestroy()
         {
             orbiters.Remove(this);
             TimingManager.FixedUpdateRemove(TimingManager.TimingStage.Earlyish, DoForces);
         }
 
+        [SuppressMessage("CodeQuality", "IDE0051", Justification = "Called by Unity")]
         void FixedUpdate()
         {
             //if (this == sun)
diff --git a/Source/ModuleManager/Extensions/StringExtensions.cs b/Source/ModuleManager/Extensions/StringExtensions.cs
@@ -18,7 +18,7 @@ public static bool IsBracketBalanced(this string s)
             return level == 0;
         }
 
-        private static Regex whitespaceRegex = new Regex(@"\s+");
+        private static readonly Regex whitespaceRegex = new Regex(@"\s+");
 
         public static string RemoveWS(this string withWhite)
         {
diff --git a/Source/ModuleManager/Fix16.cs b/Source/ModuleManager/Fix16.cs
@@ -1,9 +1,11 @@
 ﻿using System.Collections;
+using System.Diagnostics.CodeAnalysis;
 
 namespace ModuleManager
 {
     class Fix16 : LoadingSystem
     {
+        [SuppressMessage("CodeQuality", "IDE0051", Justification = "Called by Unity")]
         private void Awake()
         {
             if (Instance != null)
diff --git a/Source/ModuleManager/Logging/UnityLogger.cs b/Source/ModuleManager/Logging/UnityLogger.cs
@@ -6,7 +6,7 @@ namespace ModuleManager.Logging
 {
     public class UnityLogger : IBasicLogger
     {
-        private ILogger logger;
+        private readonly ILogger logger;
 
         public UnityLogger(ILogger logger)
         {
diff --git a/Source/ModuleManager/MMPatchLoader.cs b/Source/ModuleManager/MMPatchLoader.cs
@@ -8,7 +8,6 @@
 using System.Reflection;
 using System.Text;
 using System.Text.RegularExpressions;
-using UnityEngine;
 
 using ModuleManager.Collections;
 using ModuleManager.Logging;
@@ -352,7 +351,6 @@ private bool CheckFilesChange(UrlDir.UrlFile[] files, ConfigNode shaConfigNode)
                     noChange = false;
                 }
             }
-            
             for (int i = 0; i < files.Length; i++)
             {
                 string url = files[i].GetUrlWithExtension();
diff --git a/Source/ModuleManager/NeedsChecker.cs b/Source/ModuleManager/NeedsChecker.cs
@@ -1,5 +1,6 @@
 ﻿using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using ModuleManager.Extensions;
 using ModuleManager.Logging;
@@ -20,6 +21,7 @@ public class NeedsChecker : INeedsChecker
         private readonly IEnumerable<string> mods;
         private readonly UrlDir gameData;
         private readonly IPatchProgress progress;
+        [SuppressMessage("CodeQuality", "IDE0052", Justification = "Reserved for future use")]
         private readonly IBasicLogger logger;
 
         public NeedsChecker(IEnumerable<string> mods, UrlDir gameData, IPatchProgress progress, IBasicLogger logger)
diff --git a/Source/ModuleManager/NodeMatcher.cs b/Source/ModuleManager/NodeMatcher.cs
@@ -10,11 +10,9 @@ public interface INodeMatcher
 
     public class NodeMatcher : INodeMatcher
     {
-        private static readonly char[] sep = { '[', ']' };
-
-        private string type;
-        private string[] namePatterns = null;
-        private string constraints = "";
+        private readonly string type;
+        private readonly string[] namePatterns = null;
+        private readonly string constraints = "";
 
         public NodeMatcher(string type, string name, string constraints)
         {
diff --git a/Source/ModuleManager/PatchExtractor.cs b/Source/ModuleManager/PatchExtractor.cs
@@ -1,4 +1,5 @@
 ﻿using System;
+using System.Diagnostics.CodeAnalysis;
 using ModuleManager.Extensions;
 using ModuleManager.Logging;
 using ModuleManager.Patches;
@@ -10,6 +11,7 @@ namespace ModuleManager
     public class PatchExtractor
     {
         private readonly IPatchProgress progress;
+        [SuppressMessage("CodeQuality", "IDE0052", Justification = "Reserved for future use")]
         private readonly IBasicLogger logger;
         private readonly INeedsChecker needsChecker;
         private readonly ITagListParser tagListParser;
diff --git a/Source/ModuleManager/PatchList.cs b/Source/ModuleManager/PatchList.cs
@@ -1,8 +1,6 @@
 ﻿using System;
 using System.Collections;
 using System.Collections.Generic;
-using System.Linq;
-using ModuleManager.Collections;
 using ModuleManager.Patches;
 using ModuleManager.Patches.PassSpecifiers;
 using ModuleManager.Progress;
diff --git a/Source/ModuleManager/PostPatchLoader.cs b/Source/ModuleManager/PostPatchLoader.cs
@@ -9,6 +9,7 @@
 using ModuleManager.Logging;
 
 using static ModuleManager.FilePathRepository;
+using System.Diagnostics.CodeAnalysis;
 
 namespace ModuleManager
 {
@@ -34,6 +35,7 @@ public static void AddPostPatchCallback(ModuleManagerPostPatchCallback callback)
                 postPatchCallbacks.Add(callback);
         }
 
+        [SuppressMessage("CodeQuality", "IDE0051", Justification = "Called by Unity")]
         private void Awake()
         {
             if (Instance != null)
diff --git a/Source/ModuleManager/Progress/PatchProgress.cs b/Source/ModuleManager/Progress/PatchProgress.cs
@@ -8,7 +8,7 @@ public class PatchProgress : IPatchProgress
     {
         public ProgressCounter Counter { get; private set; }
 
-        private IBasicLogger logger;
+        private readonly IBasicLogger logger;
 
         public float ProgressFraction
         {
diff --git a/Source/ModuleManager/Threading/TaskStatus.cs b/Source/ModuleManager/Threading/TaskStatus.cs
@@ -4,20 +4,18 @@ namespace ModuleManager.Threading
 {
     public class TaskStatus : ITaskStatus
     {
-        private bool isRunning = true;
-        private Exception exception = null;
-        private object lockObject = new object();
+        private readonly object lockObject = new object();
 
-        public bool IsRunning => isRunning;
-        public Exception Exception => exception;
+        public bool IsRunning { get; private set; } = true;
+        public Exception Exception { get; private set; } = null;
 
         public bool IsFinished
         {
             get
             {
                 lock (lockObject)
                 {
-                    return !isRunning && exception == null;
+                    return !IsRunning && Exception == null;
                 }
             }
         }
@@ -28,7 +26,7 @@ public bool IsExitedWithError
             {
                 lock (lockObject)
                 {
-                    return !isRunning && exception != null;
+                    return !IsRunning && Exception != null;
                 }
             }
         }
@@ -37,18 +35,18 @@ public void Finished()
         {
             lock (lockObject)
             {
-                if (!isRunning) throw new InvalidOperationException("Task is not running");
-                isRunning = false;
+                if (!IsRunning) throw new InvalidOperationException("Task is not running");
+                IsRunning = false;
             }
         }
 
         public void Finished(Exception exception)
         {
             lock(lockObject)
             {
-                if (!isRunning) throw new InvalidOperationException("Task is not running");
-                this.exception = exception ?? throw new ArgumentNullException(nameof(exception));
-                isRunning = false;
+                if (!IsRunning) throw new InvalidOperationException("Task is not running");
+                this.Exception = exception ?? throw new ArgumentNullException(nameof(exception));
+                IsRunning = false;
             }
         }
     }
diff --git a/Source/ModuleManager/Threading/TaskStatusWrapper.cs b/Source/ModuleManager/Threading/TaskStatusWrapper.cs
@@ -4,7 +4,7 @@ namespace ModuleManager.Threading
 {
     public class TaskStatusWrapper : ITaskStatus
     {
-        private ITaskStatus inner;
+        private readonly ITaskStatus inner;
 
         public TaskStatusWrapper(ITaskStatus inner)
         {
diff --git a/Source/ModuleManagerTests/Collections/MessageQueueTest.cs b/Source/ModuleManagerTests/Collections/MessageQueueTest.cs
@@ -8,7 +8,7 @@ public class MessageQueueTest
     {
         private class TestClass { }
 
-        private MessageQueue<TestClass> queue = new MessageQueue<TestClass>();
+        private readonly MessageQueue<TestClass> queue = new MessageQueue<TestClass>();
 
         [Fact]
         public void Test__Empty()
diff --git a/Source/ModuleManagerTests/Extensions/IBasicLoggerExtensionsTest.cs b/Source/ModuleManagerTests/Extensions/IBasicLoggerExtensionsTest.cs
@@ -1,20 +1,14 @@
 ﻿using System;
 using Xunit;
 using NSubstitute;
-using UnityEngine;
 using ModuleManager.Logging;
 using ModuleManager.Extensions;
 
 namespace ModuleManagerTests.Extensions
 {
     public class IBasicLoggerExtensionsTest
     {
-        private IBasicLogger logger;
-
-        public IBasicLoggerExtensionsTest()
-        {
-            logger = Substitute.For<IBasicLogger>();
-        }
+        private readonly IBasicLogger logger = Substitute.For<IBasicLogger>();
 
         [Fact]
         public void TestInfo()
diff --git a/Source/ModuleManagerTests/Logging/PrefixLoggerTest.cs b/Source/ModuleManagerTests/Logging/PrefixLoggerTest.cs
@@ -8,12 +8,11 @@ namespace ModuleManagerTests.Logging
 {
     public class PrefixLoggerTest
     {
-        private IBasicLogger innerLogger;
-        private PrefixLogger logger;
+        private readonly IBasicLogger innerLogger = Substitute.For<IBasicLogger>();
+        private readonly PrefixLogger logger;
 
         public PrefixLoggerTest()
         {
-            innerLogger = Substitute.For<IBasicLogger>();
             logger = new PrefixLogger("MyMod", innerLogger);
         }
 
diff --git a/Source/ModuleManagerTests/Logging/QueueLoggerTest.cs b/Source/ModuleManagerTests/Logging/QueueLoggerTest.cs
@@ -8,12 +8,11 @@ namespace ModuleManagerTests.Logging
 {
     public class QueueLoggerTest
     {
-        private IMessageQueue<ILogMessage> queue;
-        private QueueLogger logger;
+        private readonly IMessageQueue<ILogMessage> queue = Substitute.For<IMessageQueue<ILogMessage>>();
+        private readonly QueueLogger logger;
 
         public QueueLoggerTest()
         {
-            queue = Substitute.For<IMessageQueue<ILogMessage>>();
             logger = new QueueLogger(queue);
         }
 
diff --git a/Source/ModuleManagerTests/Logging/StreamLoggerTest.cs b/Source/ModuleManagerTests/Logging/StreamLoggerTest.cs
@@ -11,26 +11,21 @@ public class StreamLoggerTest
         [Fact]
         public void TestConstructor__StreamNull()
         {
-            ArgumentNullException ex = Assert.Throws<ArgumentNullException>(delegate
+            Assert.Throws<ArgumentNullException>(delegate
             {
                 new StreamLogger(null);
             });
-
-            Assert.Equal("stream", ex.ParamName);
         }
 
         [Fact]
         public void TestConstructor__CantWrite()
         {
             using (MemoryStream stream = new MemoryStream(new byte[0], false))
             {
-                ArgumentException ex = Assert.Throws<ArgumentException>(delegate
+                Assert.Throws<ArgumentException>(delegate
                 {
                     new StreamLogger(stream);
                 });
-
-                Assert.Equal("stream", ex.ParamName);
-                Assert.Contains("must be writable", ex.Message);
             }
         }
 
diff --git a/Source/ModuleManagerTests/Logging/UnityLoggerTest.cs b/Source/ModuleManagerTests/Logging/UnityLoggerTest.cs
@@ -9,12 +9,11 @@ namespace ModuleManagerTests.Logging
 {
     public class UnityLoggerTest
     {
-        private ILogger innerLogger;
-        private UnityLogger logger;
+        private readonly ILogger innerLogger = Substitute.For<ILogger>();
+        private readonly UnityLogger logger;
 
         public UnityLoggerTest()
         {
-            innerLogger = Substitute.For<ILogger>();
             logger = new UnityLogger(innerLogger);
         }
 
diff --git a/Source/ModuleManagerTests/NeedsCheckerTest.cs b/Source/ModuleManagerTests/NeedsCheckerTest.cs
diff --git a/Source/ModuleManagerTests/PassTest.cs b/Source/ModuleManagerTests/PassTest.cs
diff --git a/Source/ModuleManagerTests/PatchExtractorTest.cs b/Source/ModuleManagerTests/PatchExtractorTest.cs
diff --git a/Source/ModuleManagerTests/Progress/PatchProgressTest.cs b/Source/ModuleManagerTests/Progress/PatchProgressTest.cs

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public static void LaunchCat()`
`16`	`16`	`InitCats();`
`17`	`17`
`18`	`18`	`GameObject cat = LaunchCat(scale);`
`19`		`- CatMover catMover = cat.AddComponent<CatMover>();`
	`19`	`+ cat.AddComponent<CatMover>();`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`public static void LaunchCats()`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-using System.Collections;`
	`1`	`+using System.Diagnostics.CodeAnalysis;`
`2`	`2`	`using UnityEngine;`
`3`	`3`
`4`	`4`	`#if CATS`
`@@ -25,6 +25,7 @@ public class CatMover : MonoBehaviour`
`25`	`25`	`private bool clearTrail = false;`
`26`	`26`
`27`	`27`	`// Use this for initialization`
	`28`	`+ [SuppressMessage("CodeQuality", "IDE0051", Justification = "Called by Unity")]`
`28`	`29`	`void Start()`
`29`	`30`	`{`
`30`	`31`	`trail = this.GetComponent<TrailRenderer>();`
`@@ -42,6 +43,7 @@ void Start()`
`42`	`43`	`clearTrail = true;`
`43`	`44`	`}`
`44`	`45`
	`46`	`+ [SuppressMessage("CodeQuality", "IDE0051", Justification = "Called by Unity")]`
`45`	`47`	`void Update()`
`46`	`48`	`{`
`47`	`49`	`if (trail.time <= 0f)`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.Collections.Generic;`
	`3`	`+using System.Diagnostics.CodeAnalysis;`
`3`	`4`	`using KSP.UI;`
`4`	`5`	`using UnityEngine;`
`5`	`6`	`using Random = UnityEngine.Random;`
`@@ -9,7 +10,7 @@ namespace ModuleManager.Cats`
`9`	`10`	`{`
`10`	`11`	`class CatOrbiter : MonoBehaviour`
`11`	`12`	`{`
`12`		`- private static List<CatOrbiter> orbiters = new List<CatOrbiter>();`
	`13`	`+ private static readonly List<CatOrbiter> orbiters = new List<CatOrbiter>();`
`13`	`14`
`14`	`15`	`private static CatOrbiter sun;`
`15`	`16`
`@@ -21,7 +22,7 @@ class CatOrbiter : MonoBehaviour`
`21`	`22`	`private Vector2d force;`
`22`	`23`	`private float scale = 1;`
`23`	`24`
`24`		`- private double G = 6.67408E-11;`
	`25`	`+ private const double G = 6.67408E-11;`
`25`	`26`
`26`	`27`	`public double Mass`
`27`	`28`	`{`
`@@ -113,13 +114,14 @@ private void DoForces()`
`113`	`114`	`}`
`114`	`115`	`}`
`115`	`116`
`116`		`-`
	`117`	`+ [SuppressMessage("CodeQuality", "IDE0051", Justification = "Called by Unity")]`
`117`	`118`	`void OnDestroy()`
`118`	`119`	`{`
`119`	`120`	`orbiters.Remove(this);`
`120`	`121`	`TimingManager.FixedUpdateRemove(TimingManager.TimingStage.Earlyish, DoForces);`
`121`	`122`	`}`
`122`	`123`
	`124`	`+ [SuppressMessage("CodeQuality", "IDE0051", Justification = "Called by Unity")]`
`123`	`125`	`void FixedUpdate()`
`124`	`126`	`{`
`125`	`127`	`//if (this == sun)`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public static bool IsBracketBalanced(this string s)`
`18`	`18`	`return level == 0;`
`19`	`19`	`}`
`20`	`20`
`21`		`- private static Regex whitespaceRegex = new Regex(@"\s+");`
	`21`	`+ private static readonly Regex whitespaceRegex = new Regex(@"\s+");`
`22`	`22`
`23`	`23`	`public static string RemoveWS(this string withWhite)`
`24`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,11 @@`
`1`	`1`	`using System.Collections;`
	`2`	`+using System.Diagnostics.CodeAnalysis;`
`2`	`3`
`3`	`4`	`namespace ModuleManager`
`4`	`5`	`{`
`5`	`6`	`class Fix16 : LoadingSystem`
`6`	`7`	`{`
	`8`	`+ [SuppressMessage("CodeQuality", "IDE0051", Justification = "Called by Unity")]`
`7`	`9`	`private void Awake()`
`8`	`10`	`{`
`9`	`11`	`if (Instance != null)`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ namespace ModuleManager.Logging`
`6`	`6`	`{`
`7`	`7`	`public class UnityLogger : IBasicLogger`
`8`	`8`	`{`
`9`		`- private ILogger logger;`
	`9`	`+ private readonly ILogger logger;`
`10`	`10`
`11`	`11`	`public UnityLogger(ILogger logger)`
`12`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,6 @@`
`8`	`8`	`using System.Reflection;`
`9`	`9`	`using System.Text;`
`10`	`10`	`using System.Text.RegularExpressions;`
`11`		`-using UnityEngine;`
`12`	`11`
`13`	`12`	`using ModuleManager.Collections;`
`14`	`13`	`using ModuleManager.Logging;`
`@@ -352,7 +351,6 @@ private bool CheckFilesChange(UrlDir.UrlFile[] files, ConfigNode shaConfigNode)`
`352`	`351`	`noChange = false;`
`353`	`352`	`}`
`354`	`353`	`}`
`355`		`-`
`356`	`354`	`for (int i = 0; i < files.Length; i++)`
`357`	`355`	`{`
`358`	`356`	`string url = files[i].GetUrlWithExtension();`
Original file line number	Diff line number	Diff line change
`@@ -10,11 +10,9 @@ public interface INodeMatcher`
`10`	`10`
`11`	`11`	`public class NodeMatcher : INodeMatcher`
`12`	`12`	`{`
`13`		`- private static readonly char[] sep = { '[', ']' };`
`14`		`-`
`15`		`- private string type;`
`16`		`- private string[] namePatterns = null;`
`17`		`- private string constraints = "";`
	`13`	`+ private readonly string type;`
	`14`	`+ private readonly string[] namePatterns = null;`
	`15`	`+ private readonly string constraints = "";`
`18`	`16`
`19`	`17`	`public NodeMatcher(string type, string name, string constraints)`
`20`	`18`	`{`