Merge remote-tracking branch 'origin/master' into release/v5

Fix various nullability issues

Author: angularsen

CodeGen/Generators/UnitsNetGen/QuantityGenerator.cs

@@ -161,6 +161,8 @@ private void GenerateStaticConstructor()
                 }},
                 BaseUnit, Zero, BaseDimensions);
 
+            DefaultConversionFunctions = new UnitConverter();
+
             RegisterDefaultConversions(DefaultConversionFunctions);
         }}
 ");
@@ -221,7 +223,7 @@ private void GenerateStaticProperties()
         /// <summary>
         ///     The <see cref=""UnitConverter"" /> containing the default generated conversion functions for <see cref=""{_quantity.Name}"" /> instances.
         /// </summary>
-        public static UnitConverter DefaultConversionFunctions {{ get; }} = new UnitConverter();
+        public static UnitConverter DefaultConversionFunctions {{ get; }}
 
         /// <inheritdoc cref=""IQuantity.QuantityInfo""/>
         public static QuantityInfo<{_unitEnumName}> Info {{ get; }}
@@ -352,14 +354,33 @@ internal static void RegisterDefaultConversions(UnitConverter unitConverter)
             if(unit.SingularName == _quantity.BaseUnit)
                 continue;
 
-        var func = unit.FromUnitToBaseFunc.Replace("{x}", "quantity.Value");
-        Writer.WL($@"
+            var func = unit.FromUnitToBaseFunc.Replace("{x}", "quantity.Value");
+            Writer.WL($@"
             unitConverter.SetConversionFunction<{_quantity.Name}>({_quantity.Name}Unit.{unit.SingularName}, {_unitEnumName}.{_quantity.BaseUnit}, quantity => new {_quantity.Name}({func}, {_unitEnumName}.{_quantity.BaseUnit}));");
         }
 
         Writer.WL($@"
         }}
 
+        internal static void MapGeneratedLocalizations(UnitAbbreviationsCache unitAbbreviationsCache)
+        {{");
+            foreach(var unit in _quantity.Units)
+            {
+                foreach(var localization in unit.Localization)
+                {
+                    // All units must have a unit abbreviation, so fallback to "" for units with no abbreviations defined in JSON
+                    var abbreviationParams = localization.Abbreviations.Any() ?
+                        string.Join(", ", localization.Abbreviations.Select(abbr => $@"""{abbr}""")) :
+                        $@"""""";
+
+                    Writer.WL($@"
+            unitAbbreviationsCache.MapUnitToAbbreviation({_unitEnumName}.{unit.SingularName}, new CultureInfo(""{localization.Culture}""), new string[]{{{abbreviationParams}}});");
+                }
+            }
+
+            Writer.WL($@"
+        }}
+
         /// <summary>
         ///     Get unit abbreviation string.
         /// </summary>

CodeGen/Generators/UnitsNetGen/StaticQuantityGenerator.cs

@@ -128,6 +128,14 @@ public static bool TryParse(IFormatProvider? formatProvider, Type quantityType,
                     return false;
             }
         }
+
+        internal static IEnumerable<Type> GetQuantityTypes()
+        {");
+            foreach (var quantity in _quantities)
+                Writer.WL($@"
+            yield return typeof({quantity.Name});");
+            Writer.WL(@"
+        }
     }
 }");
             return Writer.ToString();

CodeGen/Generators/UnitsNetGen/UnitAbbreviationsCacheGenerator.cs

@@ -281,12 +281,8 @@ public void ToUnit_WithSameUnits_AreEqual({_unitEnumName} unit)
         [MemberData(nameof(UnitTypes))]
         public void ToUnit_FromNonBaseUnit_ReturnsQuantityWithGivenUnit({_unitEnumName} unit)
         {{
-            // See if there is a unit available that is not the base unit.
-            var fromUnit = {_quantity.Name}.Units.FirstOrDefault(u => u != {_quantity.Name}.BaseUnit && u != {_unitEnumName}.Undefined);
-
-            // If there is only one unit for the quantity, we must use the base unit.
-            if(fromUnit == {_unitEnumName}.Undefined)
-                fromUnit = {_quantity.Name}.BaseUnit;
+            // See if there is a unit available that is not the base unit, fallback to base unit if it has only a single unit.
+            var fromUnit = {_quantity.Name}.Units.FirstOrDefault(u => u != {_quantity.Name}.BaseUnit);
 
             var quantity = {_quantity.Name}.From(3.0, fromUnit);
             var converted = quantity.ToUnit(unit);

CodeGen/Generators/UnitsNetGen/UnitTestBaseClassGenerator.cs

@@ -66,7 +66,6 @@ public static void Generate(string rootDir, Quantity[] quantities)
 
             Log.Information("");
             GenerateIQuantityTests(quantities, $"{testProjectDir}/GeneratedCode/IQuantityTests.g.cs");
-            GenerateUnitAbbreviationsCache(quantities, $"{outputDir}/UnitAbbreviationsCache.g.cs");
             GenerateStaticQuantity(quantities, $"{outputDir}/Quantity.g.cs");
 
             var unitCount = quantities.SelectMany(q => q.Units).Count();
@@ -121,13 +120,6 @@ private static void GenerateIQuantityTests(Quantity[] quantities, string filePat
             Log.Information("✅ IQuantityTests.g.cs");
         }
 
-        private static void GenerateUnitAbbreviationsCache(Quantity[] quantities, string filePath)
-        {
-            var content = new UnitAbbreviationsCacheGenerator(quantities).Generate();
-            File.WriteAllText(filePath, content);
-            Log.Information("✅ UnitAbbreviationsCache.g.cs");
-        }
-
         private static void GenerateStaticQuantity(Quantity[] quantities, string filePath)
         {
             var content = new StaticQuantityGenerator(quantities).Generate();

CodeGen/Generators/UnitsNetGenerator.cs

@@ -27,7 +27,7 @@ public class AbbreviatedUnitsConverter : JsonConverter<IQuantity>
         private const string TypeProperty = "Type";
 
         private readonly UnitAbbreviationsCache _abbreviations;
-        private readonly IEqualityComparer<string> _propertyComparer;
+        private readonly IEqualityComparer<string?> _propertyComparer;
         private readonly IDictionary<string, QuantityInfo> _quantities;
         private readonly UnitParser _unitParser;
 
@@ -43,7 +43,7 @@ public AbbreviatedUnitsConverter()
         ///     Construct a converter using the default list of quantities and unit abbreviation provider
         /// </summary>
         /// <param name="comparer">The comparer used to compare the property/quantity names (e.g. StringComparer.OrdinalIgnoreCase) </param>
-        public AbbreviatedUnitsConverter(IEqualityComparer<string> comparer)
+        public AbbreviatedUnitsConverter(IEqualityComparer<string?> comparer)
             : this(new Dictionary<string, QuantityInfo>(Quantity.ByName, comparer), UnitAbbreviationsCache.Default, comparer)
         {
         }
@@ -54,7 +54,7 @@ public AbbreviatedUnitsConverter(IEqualityComparer<string> comparer)
         /// <param name="quantities">The dictionary of quantity names</param>
         /// <param name="abbreviations">The unit abbreviations used for the serialization </param>
         /// <param name="propertyComparer">The comparer used to compare the property names (e.g. StringComparer.OrdinalIgnoreCase) </param>
-        public AbbreviatedUnitsConverter(IDictionary<string, QuantityInfo> quantities, UnitAbbreviationsCache abbreviations, IEqualityComparer<string> propertyComparer)
+        public AbbreviatedUnitsConverter(IDictionary<string, QuantityInfo> quantities, UnitAbbreviationsCache abbreviations, IEqualityComparer<string?> propertyComparer)
         {
             _quantities = quantities;
             _abbreviations = abbreviations;
@@ -63,7 +63,7 @@ public AbbreviatedUnitsConverter(IDictionary<string, QuantityInfo> quantities, U
         }
 
         /// <inheritdoc />
-        public override void WriteJson(JsonWriter writer, IQuantity quantity, JsonSerializer serializer)
+        public override void WriteJson(JsonWriter writer, IQuantity? quantity, JsonSerializer serializer)
         {
             if (quantity is null)
             {
@@ -110,17 +110,16 @@ protected string GetQuantityType(IQuantity quantity)
         }
 
         /// <inheritdoc />
-        public override IQuantity ReadJson(JsonReader reader, Type objectType, IQuantity existingValue, bool hasExistingValue, JsonSerializer serializer)
+        public override IQuantity? ReadJson(JsonReader reader, Type objectType, IQuantity? existingValue, bool hasExistingValue, JsonSerializer serializer)
         {
-            QuantityInfo quantityInfo;
+            QuantityInfo? quantityInfo;
             if (reader.TokenType == JsonToken.Null)
             {
-                // return null;
                 return TryGetQuantity(objectType.Name, out quantityInfo) ? quantityInfo.Zero : default;
             }
 
-            string valueToken = null;
-            string unitAbbreviation = null, quantityName = null;
+            string? valueToken = null;
+            string? unitAbbreviation = null, quantityName = null;
             if (reader.TokenType == JsonToken.StartObject)
             {
                 while (reader.Read() && reader.TokenType != JsonToken.EndObject)
@@ -148,18 +147,23 @@ public override IQuantity ReadJson(JsonReader reader, Type objectType, IQuantity
                 }
             }
 
+
             Enum unit;
             if (quantityName is null)
             {
                 if (TryGetQuantity(objectType.Name, out quantityInfo))
                 {
                     unit = GetUnitOrDefault(unitAbbreviation, quantityInfo);
                 }
-                else // the objectType doesn't match any concrete quantity type (likely it is an IQuantity)
+                else if (unitAbbreviation != null) // the objectType doesn't match any concrete quantity type (likely it is an IQuantity)
                 {
                     // failing back to an exhaustive search (it is possible that this converter was created with a short-list of non-ambiguous quantities
                     unit = FindUnit(unitAbbreviation, out quantityInfo);
                 }
+                else
+                {
+                    throw new FormatException("No unit abbreviation found in JSON.");
+                }
             }
             else
             {
@@ -203,8 +207,8 @@ protected virtual Enum FindUnit(string unitAbbreviation, out QuantityInfo quanti
                 throw new UnitNotFoundException("The unit abbreviation and quantity type cannot both be null");
             }
 
-            Enum unit = null;
-            quantityInfo = default;
+            Enum? unit = null;
+            QuantityInfo? tempQuantityInfo = default;
             foreach (var targetQuantity in _quantities.Values)
             {
                 if (!TryParse(unitAbbreviation, targetQuantity, out var unitMatched))
@@ -213,20 +217,21 @@ protected virtual Enum FindUnit(string unitAbbreviation, out QuantityInfo quanti
                 }
 
                 if (unit != null &&
-                    !(targetQuantity == quantityInfo && Equals(unit, unitMatched))) // it is possible to have "synonyms": e.g. "Mass" and "Weight"
+                    !(targetQuantity == tempQuantityInfo && Equals(unit, unitMatched))) // it is possible to have "synonyms": e.g. "Mass" and "Weight"
                 {
                     throw new AmbiguousUnitParseException($"Multiple quantities found matching the provided abbreviation: {unit}, {unitMatched}");
                 }
 
-                quantityInfo = targetQuantity;
+                tempQuantityInfo = targetQuantity;
                 unit = unitMatched;
             }
 
-            if (unit is null)
+            if (unit is null || tempQuantityInfo is null)
             {
                 throw new UnitNotFoundException($"No quantity found with abbreviation [{unitAbbreviation}].");
             }
 
+            quantityInfo = tempQuantityInfo;
             return unit;
         }
 
@@ -254,7 +259,7 @@ protected string GetUnitAbbreviation(Enum unit)
         /// <returns>Unit enum value, such as <see cref="MassUnit.Kilogram" />.</returns>
         /// <exception cref="UnitNotFoundException">No units match the abbreviation.</exception>
         /// <exception cref="AmbiguousUnitParseException">More than one unit matches the abbreviation.</exception>
-        protected virtual Enum GetUnitOrDefault(string unitAbbreviation, QuantityInfo quantityInfo)
+        protected virtual Enum GetUnitOrDefault(string? unitAbbreviation, QuantityInfo quantityInfo)
         {
             return unitAbbreviation == null
                 ? quantityInfo.BaseUnitInfo.Value
@@ -269,7 +274,7 @@ protected virtual Enum GetUnitOrDefault(string unitAbbreviation, QuantityInfo qu
         /// <returns>Unit enum value, such as <see cref="MassUnit.Kilogram" />.</returns>
         /// <exception cref="UnitNotFoundException">No units match the abbreviation.</exception>
         /// <exception cref="AmbiguousUnitParseException">More than one unit matches the abbreviation.</exception>
-        protected Enum Parse(string unitAbbreviation, QuantityInfo quantityInfo)
+        protected Enum Parse(string? unitAbbreviation, QuantityInfo quantityInfo)
         {
             return _unitParser.Parse(unitAbbreviation, quantityInfo.UnitType, CultureInfo.InvariantCulture);
         }
@@ -283,7 +288,7 @@ protected Enum Parse(string unitAbbreviation, QuantityInfo quantityInfo)
         /// <returns>True if successful.</returns>
         /// <exception cref="UnitNotFoundException">No units match the abbreviation.</exception>
         /// <exception cref="AmbiguousUnitParseException">More than one unit matches the abbreviation.</exception>
-        protected bool TryParse(string unitAbbreviation, QuantityInfo quantityInfo, out Enum unit)
+        protected bool TryParse(string? unitAbbreviation, QuantityInfo quantityInfo, out Enum? unit)
         {
             return _unitParser.TryParse(unitAbbreviation, quantityInfo.UnitType, CultureInfo.InvariantCulture, out unit);
         }

UnitsNet.Serialization.JsonNet/AbbreviatedUnitsConverter.cs

@@ -213,12 +213,6 @@ public void Reference_WithDefaultPressureReference_IsAbsolute()
             Equals(PressureReference.Absolute, refPressure.Reference);
         }
 
-        [Fact]
-        public void ReferencesDoesNotContainUndefined()
-        {
-            Assert.DoesNotContain(PressureReference.Undefined, ReferencePressure.References);
-        }
-
         [Fact]
         public void Vacuum_WithDefaultPressureReference_IsOneLessAtmosphereNegative()
         {