Add UnitsNet.NumberExtensions nuget (#742)

* Add number extensions back to Units.NET as separate nuget UnitsNet.NumberExtensions

* Change the build process, include the UnitsNet.NumberExtensions project and add the version bump scripts.

* Create UnitsNet.NumberExtensions.Tests project.

* Sync the Extension project version number with the main library, add a test project for extension methods, and improve the Extension project decription.

Co-authored-by: Anthony Langlois <[email protected]>
Co-authored-by: Andreas Gullberg Larsen <[email protected]>
Co-authored-by: Jan Paolo Go <[email protected]>

Author: 4 people

Build/build-functions.psm1

@@ -60,6 +60,7 @@ function Start-Build([boolean] $IncludeWindowsRuntimeComponent = $false) {
 function Start-Tests {
   $projectPaths = @(
     "UnitsNet.Tests\UnitsNet.Tests.csproj",
+    "UnitsNet.NumberExtensions.Tests\UnitsNet.NumberExtensions.Tests.csproj",
     "UnitsNet.Serialization.JsonNet.Tests\UnitsNet.Serialization.JsonNet.Tests.csproj",
     "UnitsNet.Serialization.JsonNet.CompatibilityTests\UnitsNet.Serialization.JsonNet.CompatibilityTests.csproj"
     )
@@ -97,7 +98,8 @@ function Start-Tests {
 function Start-PackNugets {
   $projectPaths = @(
     "UnitsNet\UnitsNet.csproj",
-    "UnitsNet.Serialization.JsonNet\UnitsNet.Serialization.JsonNet.csproj"
+    "UnitsNet.Serialization.JsonNet\UnitsNet.Serialization.JsonNet.csproj",
+    "UnitsNet.NumberExtensions\UnitsNet.NumberExtensions.csproj"
     )
 
   write-host -foreground blue "Pack nugets...`n---"

Build/bump-version-UnitsNet-major.bat

@@ -1,4 +1,5 @@
 @echo off
 SET scriptdir=%~dp0
 call powershell -NoProfile %scriptdir%\set-version-UnitsNet.ps1 -bump major
+call powershell -NoProfile %scriptdir%\set-version-UnitsNet.NumberExtensions.ps1 -bump major
 if %errorlevel% neq 0 exit /b %errorlevel%

Build/bump-version-UnitsNet-minor.bat

@@ -1,4 +1,5 @@
 @echo off
 SET scriptdir=%~dp0
 call powershell -NoProfile %scriptdir%\set-version-UnitsNet.ps1 -bump minor
+call powershell -NoProfile %scriptdir%\set-version-UnitsNet.NumberExtensions.ps1 -bump minor
 if %errorlevel% neq 0 exit /b %errorlevel%

Build/bump-version-UnitsNet-patch.bat

@@ -1,4 +1,5 @@
 @echo off
 SET scriptdir=%~dp0
 call powershell -NoProfile %scriptdir%\set-version-UnitsNet.ps1 -bump patch
+call powershell -NoProfile %scriptdir%\set-version-UnitsNet.NumberExtensions.ps1 -bump patch
 if %errorlevel% neq 0 exit /b %errorlevel%

Build/bump-version-UnitsNet-suffix.bat

@@ -1,4 +1,5 @@
 @echo off
 SET scriptdir=%~dp0
 call powershell -NoProfile %scriptdir%\set-version-UnitsNet.ps1 -bump suffix
+call powershell -NoProfile %scriptdir%\set-version-UnitsNet.NumberExtensions.ps1 -bump suffix
 if %errorlevel% neq 0 exit /b %errorlevel%

Build/bump-version-UnitsNet.NumberExtensions-major.bat

@@ -0,0 +1,4 @@
+@echo off
+SET scriptdir=%~dp0
+call powershell -NoProfile %scriptdir%\set-version-UnitsNet.NumberExtensions.ps1 -bump major
+if %errorlevel% neq 0 exit /b %errorlevel%

Build/bump-version-UnitsNet.NumberExtensions-minor.bat

@@ -0,0 +1,4 @@
+@echo off
+SET scriptdir=%~dp0
+call powershell -NoProfile %scriptdir%\set-version-UnitsNet.NumberExtensions.ps1 -bump minor
+if %errorlevel% neq 0 exit /b %errorlevel%

Build/bump-version-UnitsNet.NumberExtensions-patch.bat

@@ -0,0 +1,4 @@
+@echo off
+SET scriptdir=%~dp0
+call powershell -NoProfile %scriptdir%\set-version-UnitsNet.NumberExtensions.ps1 -bump patch
+if %errorlevel% neq 0 exit /b %errorlevel%

Build/bump-version-UnitsNet.NumberExtensions-suffix.bat

@@ -0,0 +1,4 @@
+@echo off
+SET scriptdir=%~dp0
+call powershell -NoProfile %scriptdir%\set-version-UnitsNet.NumberExtensions.ps1 -bump suffix
+if %errorlevel% neq 0 exit /b %errorlevel%

Build/set-version-UnitsNet.NumberExtensions.ps1

@@ -0,0 +1,59 @@
+<# .SYNOPSIS
+  Updates the version of all UnitsNet.Extensions projects.
+.DESCRIPTION
+  Updates the <Version> property of the .csproj project files.
+.PARAMETER set
+  Set new version
+.PARAMETER bump
+  Bump major, minor, patch or semver suffix number. Only one can be specified at a time, and bumping one part will reset all the lesser parts.
+.EXAMPLE
+  Set new version.
+  -v 2.3.4-beta3: 1.0.0 => 2.3.4-beta3
+.EXAMPLE
+  Bump the major, minor, patch or suffix part of the version.
+  -b major: 1.2.3-alpha1 => 2.0.0
+  -b minor: 1.2.3-alpha1 => 1.3.0
+  -b patch: 1.2.3-alpha1 => 1.2.4
+  -b suffix: 1.2.3-alpha => 1.2.3-alpha2
+  -b suffix: 1.2.3-alpha2 => 1.2.3-alpha3
+  -b suffix: 1.2.3-beta2 => 1.2.3-beta3
+  -b suffix: 1.2.3-rc2 => 1.2.3-rc3
+
+.NOTES
+  Author: Lu Li
+  Date:   Jan 15, 2020
+  Based on original work by Luis Rocha from: http://www.luisrocha.net/2009/11/setting-assembly-version-with-windows.html
+  #>
+  [CmdletBinding()]
+  Param(
+    [Parameter(Mandatory=$true, Position=0, ParameterSetName="set", HelpMessage="Set version string")]
+    [Alias("version")]
+    [string]$setVersion,
+
+    [Parameter(Mandatory=$true, Position=0, ParameterSetName="bump", HelpMessage="Bump one or more version parts")]
+    [Alias("bump")]
+    [ValidateSet('major','minor','patch','suffix')]
+    [string]$bumpVersion
+    )
+
+  function Help {
+    "Sets the AssemblyVersion and AssemblyFileVersion of AssemblyInfo.cs files`n"
+    ".\SetVersion.ps1 [VersionNumber]`n"
+    "   [VersionNumber]     The version number to set, for example: 1.1.9301.0"
+    "                       If not provided, a version number will be generated.`n"
+  }
+
+# Import functions: Get-NewProjectVersion, Set-ProjectVersion, Invoke-CommitAndTagVersion
+Import-Module "$PSScriptRoot\set-version.psm1"
+
+$root = Resolve-Path "$PSScriptRoot\.."
+$paramSet = $PsCmdlet.ParameterSetName
+$projFile = "$root\UnitsNet.NumberExtensions\UnitsNet.NumberExtensions.csproj"
+$versionFiles = @($projFile)
+$projectName = "UnitsNet.NumberExtensions"
+
+# Use UnitsNet.Common.props version as base if bumping major/minor/patch
+$newVersion = Get-NewProjectVersion $projFile $paramSet $setVersion $bumpVersion
+
+Set-ProjectVersion $projFile $newVersion
+Invoke-CommitAndTagVersion $projectName $versionFiles $newVersion

CodeGen/Generators/UnitsNetGen/NumberExtensionsGenerator.cs

@@ -0,0 +1,58 @@
+using System;
+using CodeGen.JsonTypes;
+
+namespace CodeGen.Generators.UnitsNetGen
+{
+    internal class NumberExtensionsGenerator : GeneratorBase
+    {
+        private readonly Unit[] _units;
+        private readonly string _quantityName;
+
+        public NumberExtensionsGenerator(Quantity quantity)
+        {
+            if (quantity is null)
+                throw new ArgumentNullException(nameof(quantity));
+
+            _units = quantity.Units;
+            _quantityName = quantity.Name;
+        }
+
+        public override string Generate()
+        {
+            Writer.WL(GeneratedFileHeader);
+
+            Writer.WL(
+$@"
+using System;
+                        
+namespace UnitsNet.NumberExtensions.NumberTo{_quantityName}
+{{
+    /// <summary>
+    /// A number to {_quantityName} Extensions
+    /// </summary>
+    public static class NumberTo{_quantityName}Extensions
+    {{");
+
+            foreach (var unit in _units)
+            {
+                Writer.WL(2, $@"
+/// <inheritdoc cref=""{_quantityName}.From{unit.PluralName}(UnitsNet.QuantityValue)"" />");
+
+                Writer.WLIfText(2, GetObsoleteAttributeOrNull(unit.ObsoleteText));
+
+                Writer.WL(2, $@"public static {_quantityName} {unit.PluralName}<T>(this T value) =>
+            {_quantityName}.From{unit.PluralName}(Convert.ToDouble(value));
+");
+            }
+
+            Writer.WL(1, @"}
+}");
+            return Writer.ToString();
+        }
+
+        private string GetObsoleteAttributeOrNull(string obsoleteText) =>
+            string.IsNullOrWhiteSpace(obsoleteText) ?
+            null :
+            $"[System.Obsolete({obsoleteText})]";
+    }
+}

CodeGen/Generators/UnitsNetGen/NumberExtensionsTestClassGenerator.cs

@@ -0,0 +1,57 @@
+using System;
+using CodeGen.JsonTypes;
+
+namespace CodeGen.Generators.UnitsNetGen
+{
+    internal class NumberExtensionsTestClassGenerator : GeneratorBase
+    {
+        private readonly Unit[] _units;
+        private readonly string _quantityName;
+
+        public NumberExtensionsTestClassGenerator(Quantity quantity)
+        {
+            if (quantity is null)
+                throw new ArgumentNullException(nameof(quantity));
+
+            _units = quantity.Units;
+            _quantityName = quantity.Name;
+        }
+
+
+        public override string Generate()
+        {
+            Writer.WL(GeneratedFileHeader);
+
+            Writer.WL(
+$@"
+using UnitsNet.NumberExtensions.NumberTo{_quantityName};
+using Xunit;
+
+namespace UnitsNet.Tests
+{{    
+    public class NumberTo{_quantityName}ExtensionsTests
+    {{");
+
+            foreach (var unit in _units)
+            {
+                Writer.WL(2, $@"
+[Fact]");
+
+                Writer.WLIfText(2, GetObsoleteAttributeOrNull(unit.ObsoleteText));
+
+                Writer.WL(2, $@"public void NumberTo{unit.PluralName}Test() =>
+            Assert.Equal({_quantityName}.From{unit.PluralName}(2), 2.{unit.PluralName}());
+");
+            }
+
+            Writer.WL(1, @"}
+}");
+            return Writer.ToString();
+        }
+
+        private string GetObsoleteAttributeOrNull(string obsoleteText) =>
+          string.IsNullOrWhiteSpace(obsoleteText) ?
+          null :
+          $"[System.Obsolete({obsoleteText})]";
+    }
+}

CodeGen/Generators/UnitsNetGenerator.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.IO;
@@ -37,11 +37,15 @@ internal static class UnitsNetGenerator
         public static void Generate(string rootDir, Quantity[] quantities)
         {
             var outputDir = $"{rootDir}/UnitsNet/GeneratedCode";
+            var extensionsOutputDir = $"{rootDir}/UnitsNet.NumberExtensions/GeneratedCode";
+            var extensionsTestOutputDir = $"{rootDir}/UnitsNet.NumberExtensions.Tests/GeneratedCode";
             var testProjectDir = $"{rootDir}/UnitsNet.Tests";
 
             // Ensure output directories exist
             Directory.CreateDirectory($"{outputDir}/Quantities");
             Directory.CreateDirectory($"{outputDir}/Units");
+            Directory.CreateDirectory($"{extensionsOutputDir}");
+            Directory.CreateDirectory($"{extensionsTestOutputDir}");
             Directory.CreateDirectory($"{testProjectDir}/GeneratedCode");
             Directory.CreateDirectory($"{testProjectDir}/GeneratedCode/TestsBase");
             Directory.CreateDirectory($"{testProjectDir}/GeneratedCode/QuantityTests");
@@ -51,6 +55,8 @@ public static void Generate(string rootDir, Quantity[] quantities)
                 var sb = new StringBuilder($"{quantity.Name}:".PadRight(AlignPad));
                 GenerateQuantity(sb, quantity, $"{outputDir}/Quantities/{quantity.Name}.g.cs");
                 GenerateUnitType(sb, quantity, $"{outputDir}/Units/{quantity.Name}Unit.g.cs");
+                GenerateNumberToExtensions(sb, quantity, $"{extensionsOutputDir}/NumberTo{quantity.Name}Extensions.g.cs");
+                GenerateNumberToExtensionsTestClass(sb, quantity, $"{extensionsTestOutputDir}/NumberTo{quantity.Name}ExtensionsTest.g.cs");
 
                 // Example: CustomCode/Quantities/LengthTests inherits GeneratedCode/TestsBase/LengthTestsBase
                 // This way when new units are added to the quantity JSON definition, we auto-generate the new
@@ -96,6 +102,20 @@ private static void GenerateQuantity(StringBuilder sb, Quantity quantity, string
             sb.Append("quantity(OK) ");
         }
 
+        private static void GenerateNumberToExtensions(StringBuilder sb, Quantity quantity, string filePath)
+        {
+            var content = new NumberExtensionsGenerator(quantity).Generate();
+            File.WriteAllText(filePath, content, Encoding.UTF8);
+            sb.Append("number extensions(OK) ");
+        }
+
+        private static void GenerateNumberToExtensionsTestClass(StringBuilder sb, Quantity quantity, string filePath)
+        {
+            var content = new NumberExtensionsTestClassGenerator(quantity).Generate();
+            File.WriteAllText(filePath, content, Encoding.UTF8);
+            sb.Append("number extensions tests(OK) ");
+        }
+
         private static void GenerateUnitType(StringBuilder sb, Quantity quantity, string filePath)
         {
             var content = new UnitTypeGenerator(quantity).Generate();