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

Author: angularsen

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,75 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '34 11 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'csharp' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+    
+    # .NET 6 is used in CodeGen project.
+    - uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: '6.0.x'
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

CONTRIBUTING.md

@@ -27,11 +27,11 @@ For a fairly complete summary of the unit definition JSON schema, see [Meter of
 ### Conversion functions
 Converting from unit A to B is achieved by first converting from unit A to the base unit, then from the base unit to unit B. To achieve this, each unit defines two conversion functions.
 
-* Prefer multiplication for `FromUnitToBaseFunc` (`{x}*2.54e-2` for `Inch` to `Meter`)
-* Prefer division for `FromBaseToUnitFunc` (`{x}/2.54e-2` for `Meter` to `Inch`)
+* Prefer multiplication for `FromUnitToBaseFunc` (`{x} * 2.54e-2` for `Inch` to `Meter`)
+* Prefer division for `FromBaseToUnitFunc` (`{x} / 2.54e-2` for `Meter` to `Inch`)
 * Prefer scientific notation `1e3` and `1e-5` instead of `1000` and `0.00001`
-* Prefer a constant if the conversion factor is finite (`{x}*2.54e-2` for `Inch`)
-* Prefer a calculation if the conversion factor is infinite (`({x}/72.27)*2.54e-2` for `PrinterPoint`)
+* Prefer a constant if the conversion factor is finite (`{x} * 2.54e-2` for `Inch`)
+* Prefer a calculation if the conversion factor is infinite (`({x} / 72.27)*2.54e-2` for `PrinterPoint`)
 
 ### Units
 Generally we try to name the units as what is the most widely used.

CodeGen/Generators/NanoFrameworkGen/NuspecGenerator.cs

@@ -42,7 +42,7 @@ public string Generate()
     <dependencies>
       <dependency id=""nanoFramework.CoreLibrary"" version=""{_mscorlibNuGetVersion}"" />");
 
-    if(NanoFrameworkGenerator.ProjectsRequiringMath.Contains(_quantity.Name))
+    if (NanoFrameworkGenerator.ProjectsRequiringMath.Contains(_quantity.Name))
     {
                 Writer.WL($@"
       <dependency id=""nanoFramework.System.Math"" version=""{_mathNuGetVersion}"" />");

CodeGen/Generators/NanoFrameworkGen/ProjectGenerator.cs

@@ -48,7 +48,7 @@ public string Generate()
       <SpecificVersion>True</SpecificVersion>
     </Reference>");
 
-    if(NanoFrameworkGenerator.ProjectsRequiringMath.Contains(_quantity.Name))
+    if (NanoFrameworkGenerator.ProjectsRequiringMath.Contains(_quantity.Name))
     {
                 Writer.WL($@"
     <Reference Include=""System.Math, Version={_versions.MathVersion}, Culture=neutral, PublicKeyToken=c07d481e9758c731"">

CodeGen/Generators/NanoFrameworkGen/QuantityGenerator.cs

@@ -57,7 +57,8 @@ public struct  {_quantity.Name}
         public {_quantity.ValueType} Value => _value;
 
         /// <inheritdoc />
-        public {_unitEnumName} Unit => _unit;");
+        public {_unitEnumName} Unit => _unit;
+");
 
             // Constructor and static properties
             Writer.WL($@"        /// <summary>
@@ -88,7 +89,8 @@ public struct  {_quantity.Name}
         /// <summary>
         /// Represents the smallest possible value of Duration
         /// </summary>
-        public static {_quantity.Name} MinValue {{ get; }} = new {_quantity.Name}({_quantity.ValueType}.MinValue, BaseUnit);");
+        public static {_quantity.Name} MinValue {{ get; }} = new {_quantity.Name}({_quantity.ValueType}.MinValue, BaseUnit);
+");
 
             // Decimal MaxValue = 79228162514264337593543950335M
             Writer.WLCondition(_quantity.ValueType == "decimal", $@"
@@ -97,7 +99,8 @@ public struct  {_quantity.Name}
         /// <summary>
         /// Represents the smallest possible value of Duration
         /// </summary>
-        public static {_quantity.Name} MinValue {{ get; }} = new {_quantity.Name}(-79228162514264337593543950335M, BaseUnit);");
+        public static {_quantity.Name} MinValue {{ get; }} = new {_quantity.Name}(-79228162514264337593543950335M, BaseUnit);
+");
 
             Writer.WL($@"
         /// <summary>
@@ -124,10 +127,14 @@ private void GenerateConversionProperties()
 ");
             foreach (var unit in _quantity.Units)
             {
+                if (unit.SkipConversionGeneration)
+                    continue;
+
                 Writer.WL($@"
         /// <summary>
-        ///     Get {_quantity.Name} in {unit.PluralName}.
+        ///     Gets a <see cref=""double""/> value of this quantity converted into <see cref=""{_unitEnumName}.{unit.SingularName}""/>
         /// </summary>");
+                Writer.WLIfText(2, GetObsoleteAttributeOrNull(unit));
                 Writer.WL($@"
         public {_quantity.ValueType} {unit.PluralName} => As({_unitEnumName}.{unit.SingularName});
 ");
@@ -146,18 +153,21 @@ private void GenerateStaticFactoryMethods()
 ");
             foreach (var unit in _quantity.Units)
             {
+                if (unit.SkipConversionGeneration)
+                    continue;
+
                 var valueParamName = unit.PluralName.ToLowerInvariant();
                 Writer.WL($@"
         /// <summary>
-        ///     Get {_quantity.Name} from {unit.PluralName}.
+        ///     Creates a <see cref=""{_quantity.Name}""/> from <see cref=""{_unitEnumName}.{unit.SingularName}""/>.
         /// </summary>
         /// <exception cref=""ArgumentException"">If value is NaN or Infinity.</exception>");
+                Writer.WLIfText(2, GetObsoleteAttributeOrNull(unit));
                 Writer.WL($@"
         public static {_quantity.Name} From{unit.PluralName}({_quantity.ValueType} {valueParamName}) => new {_quantity.Name}({valueParamName}, {_unitEnumName}.{unit.SingularName});
 ");
             }
 
-            Writer.WL();
             Writer.WL($@"
         /// <summary>
         ///     Dynamically convert from value and unit enum <see cref=""{_unitEnumName}"" /> to <see cref=""{_quantity.Name}"" />.
@@ -177,71 +187,82 @@ private void GenerateStaticFactoryMethods()
         private void GenerateConversionMethods()
         {
             Writer.WL($@"
-        #region Conversion Methods
-
-        /// <summary>
-        ///     Convert to the unit representation <paramref name=""unit"" />.
-        /// </summary>
-        /// <returns>Value converted to the specified unit.</returns>
-        public {_quantity.ValueType} As({_unitEnumName} unit) => GetValueAs(unit);
-
-        /// <summary>
-        ///     Converts this Duration to another Duration with the unit representation <paramref name=""unit"" />.
-        /// </summary>
-        /// <returns>A Duration with the specified unit.</returns>
-        public {_quantity.Name} ToUnit({_unitEnumName} unit)
-        {{
-            var convertedValue = GetValueAs(unit);
-            return new {_quantity.Name}(convertedValue, unit);
-        }}
-
-        /// <summary>
-        ///     Converts the current value + unit to the base unit.
-        ///     This is typically the first step in converting from one unit to another.
-        /// </summary>
-        /// <returns>The value in the base unit representation.</returns>
-        private {_quantity.ValueType} GetValueInBaseUnit()
-        {{
-            switch(Unit)
-            {{");
+                #region Conversion Methods
+
+                /// <summary>
+                ///     Convert to the unit representation <paramref name=""unit"" />.
+                /// </summary>
+                /// <returns>Value converted to the specified unit.</returns>
+                public {_quantity.ValueType} As({_unitEnumName} unit) => GetValueAs(unit);
+
+                /// <summary>
+                ///     Converts this Duration to another Duration with the unit representation <paramref name=""unit"" />.
+                /// </summary>
+                /// <returns>A Duration with the specified unit.</returns>
+                public {_quantity.Name} ToUnit({_unitEnumName} unit)
+                {{
+                    var convertedValue = GetValueAs(unit);
+                    return new {_quantity.Name}(convertedValue, unit);
+                }}
+
+                /// <summary>
+                ///     Converts the current value + unit to the base unit.
+                ///     This is typically the first step in converting from one unit to another.
+                /// </summary>
+                /// <returns>The value in the base unit representation.</returns>
+                private {_quantity.ValueType} GetValueInBaseUnit()
+                {{
+                    return Unit switch
+                    {{");
             foreach (var unit in _quantity.Units)
             {
                 var func = unit.FromUnitToBaseFunc.Replace("{x}", "_value");
                 Writer.WL($@"
-                case {_unitEnumName}.{unit.SingularName}: return {func};");
+                        {_unitEnumName}.{unit.SingularName} => {func},");
             }
 
             Writer.WL($@"
-                default:
-                    throw new NotImplementedException($""Can not convert {{Unit}} to base units."");
-            }}
-        }}
+                        _ => throw new NotImplementedException($""Can not convert {{Unit}} to base units."")
+                    }};
+                    }}
 
-        private {_quantity.ValueType} GetValueAs({_unitEnumName} unit)
-        {{
-            if(Unit == unit)
-                return _value;
+                private {_quantity.ValueType} GetValueAs({_unitEnumName} unit)
+                {{
+                    if (Unit == unit)
+                        return _value;
 
-            var baseUnitValue = GetValueInBaseUnit();
+                    var baseUnitValue = GetValueInBaseUnit();
 
-            switch(unit)
-            {{");
+                    return unit switch
+                    {{");
             foreach (var unit in _quantity.Units)
             {
                 var func = unit.FromBaseToUnitFunc.Replace("{x}", "baseUnitValue");
                 Writer.WL($@"
-                case {_unitEnumName}.{unit.SingularName}: return {func};");
+                        {_unitEnumName}.{unit.SingularName} => {func},");
             }
 
             Writer.WL(@"
-                default:
-                    throw new NotImplementedException($""Can not convert {Unit} to {unit}."");
-            }
-        }
+                        _ => throw new NotImplementedException($""Can not convert {Unit} to {unit}."")
+                    };
+                    }
 
-        #endregion
-");
+                #endregion");
         }
 
+        /// <inheritdoc cref="GetObsoleteAttributeOrNull(string)"/>
+        internal static string? GetObsoleteAttributeOrNull(Quantity quantity) => GetObsoleteAttributeOrNull(quantity.ObsoleteText);
+
+        /// <inheritdoc cref="GetObsoleteAttributeOrNull(string)"/>
+        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)
+            ? null
+            : $"[Obsolete(\"{obsoleteText}\")]";
+
     }
 }

CodeGen/Generators/NanoFrameworkGen/UnitTypeGenerator.cs

@@ -43,7 +43,7 @@ public enum {_unitEnumName}
         /// <remarks>{unit.XmlDocRemarks}</remarks>");
                 }
 
-                Writer.WLIfText(2, UnitsNetGen.QuantityGenerator.GetObsoleteAttributeOrNull(unit));
+                Writer.WLIfText(2, GetObsoleteAttributeOrNull(unit.ObsoleteText));
                 Writer.WL($@"
         {unit.SingularName},");
             }
@@ -55,5 +55,10 @@ public enum {_unitEnumName}
 }}");
             return Writer.ToString();
         }
+
+        private string? GetObsoleteAttributeOrNull(string obsoleteText) =>
+            string.IsNullOrWhiteSpace(obsoleteText) ?
+            null :
+            $"[System.Obsolete(\"{obsoleteText}\")]";
     }
 }

CodeGen/Generators/QuantityJsonFilesParser.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;
@@ -94,8 +94,11 @@ private static void AddPrefixUnits(Quantity quantity)
                         BaseUnits = null, // Can we determine this somehow?
                         FromBaseToUnitFunc = $"({unit.FromBaseToUnitFunc}) / {prefixInfo.Factor}",
                         FromUnitToBaseFunc = $"({unit.FromUnitToBaseFunc}) * {prefixInfo.Factor}",
-                        Localization = GetLocalizationForPrefixUnit(unit.Localization, prefixInfo)
-                    });
+                        Localization = GetLocalizationForPrefixUnit(unit.Localization, prefixInfo),
+                        ObsoleteText = unit.ObsoleteText,
+                        SkipConversionGeneration = unit.SkipConversionGeneration,
+                        AllowAbbreviationLookup = unit.AllowAbbreviationLookup
+                    } );
                 }
                 catch (Exception e)
                 {

CodeGen/Generators/UnitsNetGen/NumberExtensionsGenerator.cs

@@ -37,6 +37,9 @@ public static class NumberTo{_quantityName}Extensions
 
             foreach (var unit in _units)
             {
+                if (unit.SkipConversionGeneration)
+                    continue;
+
                 Writer.WL(2, $@"
 /// <inheritdoc cref=""{_quantityName}.From{unit.PluralName}(UnitsNet.QuantityValue)"" />");
 
@@ -55,6 +58,6 @@ public static class NumberTo{_quantityName}Extensions
         private static string? GetObsoleteAttributeOrNull(string obsoleteText) =>
             string.IsNullOrWhiteSpace(obsoleteText) ?
             null :
-            $"[System.Obsolete(\"{obsoleteText}\")]";
+            $"[Obsolete(\"{obsoleteText}\")]";
     }
 }

CodeGen/Generators/UnitsNetGen/NumberExtensionsTestClassGenerator.cs

@@ -32,6 +32,9 @@ public class NumberTo{_quantityName}ExtensionsTests
 
             foreach (var unit in _units)
             {
+                if (unit.SkipConversionGeneration)
+                    continue;
+
                 Writer.WL(2, $@"
 [Fact]");
 
@@ -50,6 +53,6 @@ public class NumberTo{_quantityName}ExtensionsTests
         private static string? GetObsoleteAttributeOrNull(string obsoleteText) =>
           string.IsNullOrWhiteSpace(obsoleteText) ?
           null :
-          $"[System.Obsolete({obsoleteText})]";
+          $"[Obsolete(\"{obsoleteText}\")]";
     }
 }