Deprecate QuantityType to better support custom quantities (#864)

* obsolete QuantityType instead of removing it straight away
* Pass QuantityType as argument with default value, instead of looking up in Quantity.

Co-authored-by: Ruud Poutsma <[email protected]>
Co-authored-by: Andreas Gullberg Larsen <[email protected]>

Author: 3 people

CodeGen/Generators/UnitsNetGen/IQuantityTestClassGenerator.cs

@@ -1,4 +1,4 @@
-// Licensed under MIT No Attribution, see LICENSE file at the root.
+// Licensed under MIT No Attribution, see LICENSE file at the root.
 // Copyright 2013 Andreas Gullberg Larsen ([email protected]). Maintained at https://github.com/angularsen/UnitsNet.
 
 using System;

CodeGen/Generators/UnitsNetGen/QuantityGenerator.cs

@@ -117,7 +117,7 @@ private void GenerateStaticConstructor()
 ");
 
             Writer.WL($@"
-            Info = new QuantityInfo<{_unitEnumName}>(QuantityType.{_quantity.Name},
+            Info = new QuantityInfo<{_unitEnumName}>(""{_quantity.Name}"",
                 new UnitInfo<{_unitEnumName}>[] {{");
 
             foreach (var unit in _quantity.Units)
@@ -147,10 +147,10 @@ private void GenerateStaticConstructor()
                 }
             }
 
-            Writer.WL(@"
-                },
-                BaseUnit, Zero, BaseDimensions);
-        }
+            Writer.WL($@"
+                }},
+                BaseUnit, Zero, BaseDimensions, QuantityType.{_quantity.Name});
+        }}
 ");
         }
 
@@ -236,6 +236,7 @@ private void GenerateStaticProperties()
         /// <summary>
         ///     The <see cref=""QuantityType"" /> of this quantity.
         /// </summary>
+        [Obsolete(""QuantityType will be removed in the future. Use Info property instead."")]
         public static QuantityType QuantityType {{ get; }} = QuantityType.{_quantity.Name};
 
         /// <summary>
@@ -792,7 +793,7 @@ public bool Equals({_quantity.Name} other, double tolerance, ComparisonType comp
         /// <returns>A hash code for the current {_quantity.Name}.</returns>
         public override int GetHashCode()
         {{
-            return new {{ QuantityType, Value, Unit }}.GetHashCode();
+            return new {{ Info.Name, Value, Unit }}.GetHashCode();
         }}
 
         #endregion
@@ -1106,6 +1107,8 @@ object IConvertible.ToType(Type conversionType, IFormatProvider provider)
                 return Unit;
             else if(conversionType == typeof(QuantityType))
                 return {_quantity.Name}.QuantityType;
+            else if(conversionType == typeof(QuantityInfo))
+                return {_quantity.Name}.Info;
             else if(conversionType == typeof(BaseDimensions))
                 return {_quantity.Name}.BaseDimensions;
             else

CodeGen/Generators/UnitsNetGen/QuantityTypeGenerator.cs

@@ -1,4 +1,4 @@
-using CodeGen.JsonTypes;
+using CodeGen.JsonTypes;
 
 namespace CodeGen.Generators.UnitsNetGen
 {

CodeGen/Generators/UnitsNetGen/StaticQuantityGenerator.cs

@@ -1,4 +1,4 @@
-using CodeGen.Helpers;
+using CodeGen.Helpers;
 using CodeGen.JsonTypes;
 
 namespace CodeGen.Generators.UnitsNetGen
@@ -21,6 +21,7 @@ public override string Generate()
 using JetBrains.Annotations;
 using UnitsNet.InternalHelpers;
 using UnitsNet.Units;
+using System.Collections.Generic;
 
 #nullable enable
 
@@ -31,12 +32,34 @@ namespace UnitsNet
     /// </summary>
     public static partial class Quantity
     {
+        /// <summary>
+        /// All QuantityInfo instances mapped by quantity name that are present in UnitsNet by default.
+        /// </summary>
+        public static readonly IDictionary<string, QuantityInfo> ByName = new Dictionary<string, QuantityInfo>
+        {");
+            foreach (var quantity in _quantities)
+                Writer.WL($@"
+            {{ ""{quantity.Name}"", {quantity.Name}.Info }},");
+            Writer.WL(@"
+        };
+
+        // Used by the QuantityInfo .ctor to map a name to a QuantityType. Will be removed when QuantityType
+        // will be removed.
+        internal static readonly IDictionary<string, QuantityType> QuantityTypeByName = new Dictionary<string, QuantityType>
+        {");
+            foreach (var quantity in _quantities)
+                Writer.WL($@"
+            {{ ""{quantity.Name}"", QuantityType.{quantity.Name} }},");
+            Writer.WL(@"
+        };
+
         /// <summary>
         /// Dynamically constructs a quantity of the given <see cref=""QuantityType""/> with the value in the quantity's base units.
         /// </summary>
         /// <param name=""quantityType"">The <see cref=""QuantityType""/> of the quantity to create.</param>
         /// <param name=""value"">The value to construct the quantity with.</param>
         /// <returns>The created quantity.</returns>
+        [Obsolete(""QuantityType will be removed. Use FromQuantityInfo(QuantityInfo, QuantityValue) instead."")]
         public static IQuantity FromQuantityType(QuantityType quantityType, QuantityValue value)
         {
             switch(quantityType)
@@ -55,6 +78,30 @@ public static IQuantity FromQuantityType(QuantityType quantityType, QuantityValu
             }
         }
 
+        /// <summary>
+        /// Dynamically constructs a quantity of the given <see cref=""QuantityInfo""/> with the value in the quantity's base units.
+        /// </summary>
+        /// <param name=""quantityInfo"">The <see cref=""QuantityInfo""/> of the quantity to create.</param>
+        /// <param name=""value"">The value to construct the quantity with.</param>
+        /// <returns>The created quantity.</returns>
+        public static IQuantity FromQuantityInfo(QuantityInfo quantityInfo, QuantityValue value)
+        {
+            switch(quantityInfo.Name)
+            {");
+            foreach (var quantity in _quantities)
+            {
+                var quantityName = quantity.Name;
+                Writer.WL($@"
+                case ""{quantityName}"":
+                    return {quantityName}.From(value, {quantityName}.BaseUnit);");
+            }
+
+            Writer.WL(@"
+                default:
+                    throw new ArgumentException($""{quantityInfo.Name} is not a supported quantity."");
+            }
+        }
+
         /// <summary>
         ///     Try to dynamically construct a quantity.
         /// </summary>

CodeGen/Generators/UnitsNetGen/UnitTestBaseClassGenerator.cs

@@ -662,6 +662,13 @@ public void Convert_ChangeType_QuantityType_EqualsQuantityType()
             Assert.Equal(QuantityType.{_quantity.Name}, Convert.ChangeType(quantity, typeof(QuantityType)));
         }}
 
+        [Fact]
+        public void Convert_ChangeType_QuantityInfo_EqualsQuantityInfo()
+        {{
+            var quantity = {_quantity.Name}.From{_baseUnit.PluralName}(1.0);
+            Assert.Equal({_quantity.Name}.Info, Convert.ChangeType(quantity, typeof(QuantityInfo)));
+        }}
+
         [Fact]
         public void Convert_ChangeType_BaseDimensions_EqualsBaseDimensions()
         {{
@@ -680,7 +687,7 @@ public void Convert_ChangeType_InvalidType_ThrowsInvalidCastException()
         public void GetHashCode_Equals()
         {{
             var quantity = {_quantity.Name}.From{_baseUnit.PluralName}(1.0);
-            Assert.Equal(new {{{_quantity.Name}.QuantityType, quantity.Value, quantity.Unit}}.GetHashCode(), quantity.GetHashCode());
+            Assert.Equal(new {{{_quantity.Name}.Info.Name, quantity.Value, quantity.Unit}}.GetHashCode(), quantity.GetHashCode());
         }}
 ");
 

CodeGen/Generators/UnitsNetWrcGen/StaticQuantityGenerator.cs

@@ -1,4 +1,4 @@
-using CodeGen.Helpers;
+using CodeGen.Helpers;
 using CodeGen.JsonTypes;
 
 namespace CodeGen.Generators.UnitsNetWrcGen

UnitsNet.Tests/CustomQuantities/HowMuch.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace UnitsNet.Tests.CustomQuantities
 {
@@ -26,7 +26,7 @@ public HowMuch(double value, HowMuchUnit unit)
         public QuantityType Type => QuantityType.Undefined;
         public BaseDimensions Dimensions => BaseDimensions.Dimensionless;
 
-        public QuantityInfo QuantityInfo => new QuantityInfo(Type,
+        public QuantityInfo QuantityInfo => new QuantityInfo("HowMuch",
             new UnitInfo[]
             {
                 new UnitInfo<HowMuchUnit>(HowMuchUnit.Some, BaseUnits.Undefined),