Fix nullability and code style warnings (#885)

angularsen · web-flow · commit bf26c7f4704f · 2021-03-20T01:10:20.000+01:00
diff --git a/CodeGen/Exceptions/UnitsNetCodeGenException.cs b/CodeGen/Exceptions/UnitsNetCodeGenException.cs
@@ -0,0 +1,27 @@
+﻿// Licensed under MIT No Attribution, see LICENSE file at the root.
+// Copyright 2013 Andreas Gullberg Larsen (andreas.larsen84@gmail.com). Maintained at https://github.com/angularsen/UnitsNet.
+
+using System;
+using System.Runtime.Serialization;
+
+namespace CodeGen.Exceptions
+{
+    internal class UnitsNetCodeGenException : Exception
+    {
+        public UnitsNetCodeGenException()
+        {
+        }
+
+        protected UnitsNetCodeGenException(SerializationInfo info, StreamingContext context) : base(info, context)
+        {
+        }
+
+        public UnitsNetCodeGenException(string message) : base(message)
+        {
+        }
+
+        public UnitsNetCodeGenException(string message, Exception innerException) : base(message, innerException)
+        {
+        }
+    }
+}
diff --git a/CodeGen/Generators/QuantityJsonFilesParser.cs b/CodeGen/Generators/QuantityJsonFilesParser.cs
@@ -6,6 +6,7 @@
 using System.IO;
 using System.Linq;
 using System.Text;
+using CodeGen.Exceptions;
 using CodeGen.Helpers;
 using CodeGen.JsonTypes;
 using Newtonsoft.Json;
@@ -41,7 +42,9 @@ private static Quantity ParseQuantityFile(string jsonFile)
         {
             try
             {
-                var quantity = JsonConvert.DeserializeObject<Quantity>(File.ReadAllText(jsonFile, Encoding.UTF8), JsonSerializerSettings);
+                var quantity = JsonConvert.DeserializeObject<Quantity>(File.ReadAllText(jsonFile, Encoding.UTF8), JsonSerializerSettings)
+                               ?? throw new UnitsNetCodeGenException($"Unable to parse quantity from JSON file: {jsonFile}");
+
                 AddPrefixUnits(quantity);
                 FixConversionFunctionsForDecimalValueTypes(quantity);
                 OrderUnitsByName(quantity);
diff --git a/CodeGen/Generators/UnitsNetGen/IQuantityTestClassGenerator.cs b/CodeGen/Generators/UnitsNetGen/IQuantityTestClassGenerator.cs
@@ -1,12 +1,14 @@
 ﻿// Licensed under MIT No Attribution, see LICENSE file at the root.
 // Copyright 2013 Andreas Gullberg Larsen (andreas.larsen84@gmail.com). Maintained at https://github.com/angularsen/UnitsNet.
 
-using System;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using CodeGen.JsonTypes;
 
 namespace CodeGen.Generators.UnitsNetGen
 {
+    // ReSharper disable once InconsistentNaming
+    [SuppressMessage("ReSharper", "EnforceForeachStatementBraces")]
     internal class IQuantityTestClassGenerator : GeneratorBase
     {
         private readonly Quantity[] _quantities;
diff --git a/CodeGen/Generators/UnitsNetGen/NumberExtensionsTestClassGenerator.cs b/CodeGen/Generators/UnitsNetGen/NumberExtensionsTestClassGenerator.cs
@@ -10,8 +10,7 @@ internal class NumberExtensionsTestClassGenerator : GeneratorBase
 
         public NumberExtensionsTestClassGenerator(Quantity quantity)
         {
-            if (quantity is null)
-                throw new ArgumentNullException(nameof(quantity));
+            if (quantity is null) throw new ArgumentNullException(nameof(quantity));
 
             _units = quantity.Units;
             _quantityName = quantity.Name;
diff --git a/CodeGen/Generators/UnitsNetGen/QuantityGenerator.cs b/CodeGen/Generators/UnitsNetGen/QuantityGenerator.cs
@@ -1148,16 +1148,16 @@ ulong IConvertible.ToUInt64(IFormatProvider provider)
         }
 
         /// <inheritdoc cref="GetObsoleteAttributeOrNull(string)"/>
-        internal static string GetObsoleteAttributeOrNull(Quantity quantity) => GetObsoleteAttributeOrNull(quantity.ObsoleteText);
+        internal static string? GetObsoleteAttributeOrNull(Quantity quantity) => GetObsoleteAttributeOrNull(quantity.ObsoleteText);
 
         /// <inheritdoc cref="GetObsoleteAttributeOrNull(string)"/>
-        internal static string GetObsoleteAttributeOrNull(Unit unit) => GetObsoleteAttributeOrNull(unit.ObsoleteText);
+        internal static string? GetObsoleteAttributeOrNull(Unit unit) => GetObsoleteAttributeOrNull(unit.ObsoleteText);
 
         /// <summary>
         /// Returns the Obsolete attribute if ObsoleteText has been defined on the JSON input - otherwise returns empty string
         /// It is up to the consumer to wrap any padding/new lines in order to keep to correct indentation formats
         /// </summary>
-        private static string GetObsoleteAttributeOrNull(string obsoleteText) => string.IsNullOrWhiteSpace(obsoleteText)
+        private static string? GetObsoleteAttributeOrNull(string obsoleteText) => string.IsNullOrWhiteSpace(obsoleteText)
             ? null
             : $"[System.Obsolete(\"{obsoleteText}\")]";
     }
diff --git a/CodeGen/Helpers/MyTextWriter.cs b/CodeGen/Helpers/MyTextWriter.cs
@@ -16,6 +16,7 @@ public MyTextWriter(string indentString = "    ", int initialIndentLevel = 0)
         {
             IndentString = indentString;
             IndentLevel = initialIndentLevel;
+            _currentIndentationString = GetIndent(0);
         }
 
         public string IndentString { get; }
@@ -89,9 +90,9 @@ public override string ToString()
         /// </summary>
         /// <param name="indentLevel">The level of indentation to prepend to the text.</param>
         /// <param name="text">The text to write.</param>
-        public void WLIfText(int indentLevel, string text)
+        public void WLIfText(int indentLevel, string? text)
         {
-            if (string.IsNullOrWhiteSpace(text)) return;
+            if (text == null || string.IsNullOrWhiteSpace(text)) return;
             WL(indentLevel, text);
         }
 
@@ -102,8 +103,7 @@ public void WLIfText(int indentLevel, string text)
         /// <param name="text">The text to write.</param>
         public void WLCondition(bool condition, string text)
         {
-            if (condition)
-                WL(text);
+            if (condition) WL(text);
         }
     }
 }
diff --git a/CodeGen/JsonTypes/Unit.cs b/CodeGen/JsonTypes/Unit.cs
@@ -10,7 +10,7 @@ internal class Unit
         // 0649 Field is never assigned to
 #pragma warning disable 0649
 
-        public BaseUnits BaseUnits;
+        public BaseUnits? BaseUnits;
         public string FromBaseToUnitFunc;
         public string FromUnitToBaseFunc;
         public Localization[] Localization = Array.Empty<Localization>();
diff --git a/UnitsNet.sln.DotSettings b/UnitsNet.sln.DotSettings
@@ -14,6 +14,8 @@
 	<s:String x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/ForOtherTypes/@EntryValue">UseVarWhenEvident</s:String>
 	<s:String x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/ForSimpleTypes/@EntryValue">UseVarWhenEvident</s:String>
 	<s:String x:Key="/Default/CodeStyle/FileHeader/FileHeaderText/@EntryValue">Licensed under MIT No Attribution, see LICENSE file at the root.&#xD;Copyright 2013 Andreas Gullberg Larsen (andreas.larsen84@gmail.com). Maintained at https://github.com/angularsen/UnitsNet.</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=SI/@EntryIndexedValue">SI</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=WL/@EntryIndexedValue">WL</s:String>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpAttributeForSingleLineMethodUpgrade/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpKeepExistingMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpPlaceEmbeddedOnSameLineMigration/@EntryIndexedValue">True</s:Boolean>
diff --git a/UnitsNet/QuantityInfo.cs b/UnitsNet/QuantityInfo.cs
@@ -203,7 +203,7 @@ public QuantityInfo(QuantityType quantityType, UnitInfo<TUnit>[] unitInfos, TUni
         /// <inheritdoc />
         public QuantityInfo(string name, UnitInfo<TUnit>[] unitInfos, TUnit baseUnit, IQuantity<TUnit> zero, BaseDimensions baseDimensions,
             QuantityType quantityType = QuantityType.Undefined)
-            : base(name, unitInfos, baseUnit, zero, baseDimensions, quantityType)
+            : base(name, unitInfos.ToArray<UnitInfo>(), baseUnit, zero, baseDimensions, quantityType)
         {
             Zero = zero;
             UnitInfos = unitInfos ?? throw new ArgumentNullException(nameof(unitInfos));
diff --git a/UnitsNet/UnitFormatter.cs b/UnitsNet/UnitFormatter.cs
@@ -4,7 +4,6 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using JetBrains.Annotations;
 
 namespace UnitsNet
 {
diff --git a/UnitsNet/UnitSystem.cs b/UnitsNet/UnitSystem.cs
@@ -19,31 +19,22 @@ public sealed class UnitSystem : IEquatable<UnitSystem>
         /// <param name="baseUnits">The base units for the unit system.</param>
         public UnitSystem(BaseUnits baseUnits)
         {
-            if(baseUnits is null)
-                throw new ArgumentNullException(nameof(baseUnits));
-
-            if(!baseUnits.IsFullyDefined)
-                throw new ArgumentException("A unit system must have all base units defined.", nameof(baseUnits));
+            if (baseUnits is null) throw new ArgumentNullException(nameof(baseUnits));
+            if (!baseUnits.IsFullyDefined) throw new ArgumentException("A unit system must have all base units defined.", nameof(baseUnits));
 
             BaseUnits = baseUnits;
         }
 
         /// <inheritdoc />
-        public override bool Equals(object obj)
+        public override bool Equals(object? other)
         {
-            if(obj is null || !(obj is UnitSystem))
-                return false;
-
-            return Equals((UnitSystem)obj);
+            return other is UnitSystem otherUnitSystem && Equals(otherUnitSystem);
         }
 
         /// <inheritdoc />
-        public bool Equals(UnitSystem other)
+        public bool Equals(UnitSystem? other)
         {
-            if(other is null)
-                return false;
-
-            return BaseUnits.Equals(other.BaseUnits);
+            return other is not null && BaseUnits.Equals(other.BaseUnits);
         }
 
         /// <summary>
@@ -53,9 +44,9 @@ public bool Equals(UnitSystem other)
         /// <param name="right">The right instance.</param>
         /// <returns>True if equal, otherwise false.</returns>
         /// <seealso cref="Equals(UnitSystem)"/>
-        public static bool operator ==(UnitSystem left, UnitSystem right)
+        public static bool operator ==(UnitSystem? left, UnitSystem? right)
         {
-            return left is null ? right is null : left.Equals(right);
+            return left?.Equals(right) ?? right is null;
         }
 
         /// <summary>
@@ -65,7 +56,7 @@ public bool Equals(UnitSystem other)
         /// <param name="right">The right instance.</param>
         /// <returns>True if equal, otherwise false.</returns>
         /// <seealso cref="Equals(UnitSystem)"/>
-        public static bool operator !=(UnitSystem left, UnitSystem right)
+        public static bool operator !=(UnitSystem? left, UnitSystem? right)
         {
             return !(left == right);
         }

Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,14 @@`
`1`	`1`	`// Licensed under MIT No Attribution, see LICENSE file at the root.`
`2`	`2`	`// Copyright 2013 Andreas Gullberg Larsen (andreas.larsen84@gmail.com). Maintained at https://github.com/angularsen/UnitsNet.`
`3`	`3`
`4`		`-using System;`
	`4`	`+using System.Diagnostics.CodeAnalysis;`
`5`	`5`	`using System.Linq;`
`6`	`6`	`using CodeGen.JsonTypes;`
`7`	`7`
`8`	`8`	`namespace CodeGen.Generators.UnitsNetGen`
`9`	`9`	`{`
	`10`	`+ // ReSharper disable once InconsistentNaming`
	`11`	`+ [SuppressMessage("ReSharper", "EnforceForeachStatementBraces")]`
`10`	`12`	`internal class IQuantityTestClassGenerator : GeneratorBase`
`11`	`13`	`{`
`12`	`14`	`private readonly Quantity[] _quantities;`
Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,7 @@ internal class NumberExtensionsTestClassGenerator : GeneratorBase`
`10`	`10`
`11`	`11`	`public NumberExtensionsTestClassGenerator(Quantity quantity)`
`12`	`12`	`{`
`13`		`- if (quantity is null)`
`14`		`- throw new ArgumentNullException(nameof(quantity));`
	`13`	`+ if (quantity is null) throw new ArgumentNullException(nameof(quantity));`
`15`	`14`
`16`	`15`	`_units = quantity.Units;`
`17`	`16`	`_quantityName = quantity.Name;`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ public MyTextWriter(string indentString = " ", int initialIndentLevel = 0)`
`16`	`16`	`{`
`17`	`17`	`IndentString = indentString;`
`18`	`18`	`IndentLevel = initialIndentLevel;`
	`19`	`+ _currentIndentationString = GetIndent(0);`
`19`	`20`	`}`
`20`	`21`
`21`	`22`	`public string IndentString { get; }`
`@@ -89,9 +90,9 @@ public override string ToString()`
`89`	`90`	`/// </summary>`
`90`	`91`	`/// <param name="indentLevel">The level of indentation to prepend to the text.</param>`
`91`	`92`	`/// <param name="text">The text to write.</param>`
`92`		`- public void WLIfText(int indentLevel, string text)`
	`93`	`+ public void WLIfText(int indentLevel, string? text)`
`93`	`94`	`{`
`94`		`- if (string.IsNullOrWhiteSpace(text)) return;`
	`95`	`+ if (text == null \|\| string.IsNullOrWhiteSpace(text)) return;`
`95`	`96`	`WL(indentLevel, text);`
`96`	`97`	`}`
`97`	`98`
`@@ -102,8 +103,7 @@ public void WLIfText(int indentLevel, string text)`
`102`	`103`	`/// <param name="text">The text to write.</param>`
`103`	`104`	`public void WLCondition(bool condition, string text)`
`104`	`105`	`{`
`105`		`- if (condition)`
`106`		`- WL(text);`
	`106`	`+ if (condition) WL(text);`
`107`	`107`	`}`
`108`	`108`	`}`
`109`	`109`	`}`
Original file line number	Diff line number	Diff line change
`@@ -203,7 +203,7 @@ public QuantityInfo(QuantityType quantityType, UnitInfo<TUnit>[] unitInfos, TUni`
`203`	`203`	`/// <inheritdoc />`
`204`	`204`	`public QuantityInfo(string name, UnitInfo<TUnit>[] unitInfos, TUnit baseUnit, IQuantity<TUnit> zero, BaseDimensions baseDimensions,`
`205`	`205`	`QuantityType quantityType = QuantityType.Undefined)`
`206`		`- : base(name, unitInfos, baseUnit, zero, baseDimensions, quantityType)`
	`206`	`+ : base(name, unitInfos.ToArray<UnitInfo>(), baseUnit, zero, baseDimensions, quantityType)`
`207`	`207`	`{`
`208`	`208`	`Zero = zero;`
`209`	`209`	`UnitInfos = unitInfos ?? throw new ArgumentNullException(nameof(unitInfos));`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`	`using System;`
`5`	`5`	`using System.Collections.Generic;`
`6`	`6`	`using System.Linq;`
`7`		`-using JetBrains.Annotations;`
`8`	`7`
`9`	`8`	`namespace UnitsNet`
`10`	`9`	`{`