task: added third example project featuring Temperature conversions u…

…sing new Double datatype support
dtanglr · Mar 28, 2024 · 09e237e · 09e237e
1 parent a564492
commit 09e237e
Show file tree

Hide file tree

Showing 15 changed files with 541 additions and 4 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -8,7 +8,7 @@ _layout: landing
 
 Primitively is a powerful C# source generator that transforms primitive identifiers and value objects into highly performant, customisable, read-only struct values that support ASP.NET model binding and validation (including FluentValidation), Open API standards, JSON and MongoDB BSON serialization, with zero or minimal configuration.
 
-The forthcoming 1.4 release supports the following platforms:
+The 1.4.x release supports the following platforms:
 
 - .NET 8
 - .NET 7
@@ -17,6 +17,4 @@ The forthcoming 1.4 release supports the following platforms:
 - .NET Core 3.1¹
 - .NET Standard 2.0¹
 
-Prior to the 1.4 release. Primitively supported .NET 6 only.
-
-¹ It is possible (but not recommended) to use Primitively on class libraries that target platforms that preceed .NET 6. Extra configuration is required for this to work because C# 10 is a minimum requirement. Please see the documentation for details. 
+¹ It is possible (but not recommended) to use Primitively on class libraries that target platforms that preceed .NET 6. Extra configuration is required for this to work because C# 10 is a minimum requirement. To learn more, clone the Primitively git repo and open the example projects. 
diff --git a/...temperature-units-of-measure/Acme.Temperature.UnitTests/Acme.Temperature.UnitTests.csproj b/...temperature-units-of-measure/Acme.Temperature.UnitTests/Acme.Temperature.UnitTests.csproj
@@ -0,0 +1,30 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <IsPackable>false</IsPackable>
+    <IsTestProject>true</IsTestProject>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="FluentAssertions" Version="6.12.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
+    <PackageReference Include="Primitively.Abstractions" Version="1.5.0-alpha.14" />
+    <PackageReference Include="xunit" Version="2.7.0" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.7">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+    <PackageReference Include="coverlet.collector" Version="6.0.2">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Acme.Temperature\Acme.Temperature.csproj" />
+  </ItemGroup>
+
+</Project>
diff --git a/examples/03-temperature-units-of-measure/Acme.Temperature.UnitTests/CelsiusTests.cs b/examples/03-temperature-units-of-measure/Acme.Temperature.UnitTests/CelsiusTests.cs
@@ -0,0 +1,76 @@
+namespace Acme.Temperature.UnitTests;
+
+public class CelsiusTests
+{
+    [Fact]
+    public void AbsoluteZero_In_Sut_Scale_Converts_To_AbsoluteZero_In_Other_Scales()
+    {
+        // Assign
+        var celsius = Celsius.AbsoluteZero;
+
+        // Act
+        var fahrenheit = (Fahrenheit)celsius;
+        var kelvin = (Kelvin)celsius;
+        var rankine = (Rankine)celsius;
+
+        // Assert
+        celsius.Should().BeEquivalentTo(Celsius.AbsoluteZero);
+        fahrenheit.Should().BeEquivalentTo(Fahrenheit.AbsoluteZero);
+        kelvin.Should().BeEquivalentTo(Kelvin.AbsoluteZero);
+        rankine.Should().BeEquivalentTo(Rankine.AbsoluteZero);
+    }
+
+    [Fact]
+    public void WaterMeltingPoint_In_Sut_Scale_Converts_To_WaterMeltingPoint_In_Other_Scales()
+    {
+        // Assign
+        var celsius = Celsius.WaterMeltingPoint;
+
+        // Act
+        var fahrenheit = (Fahrenheit)celsius;
+        var kelvin = (Kelvin)celsius;
+        var rankine = (Rankine)celsius;
+
+        // Assert
+        celsius.Should().BeEquivalentTo(Celsius.WaterMeltingPoint);
+        fahrenheit.Should().BeEquivalentTo(Fahrenheit.WaterMeltingPoint);
+        kelvin.Should().BeEquivalentTo(Kelvin.WaterMeltingPoint);
+        rankine.Should().BeEquivalentTo(Rankine.WaterMeltingPoint);
+    }
+
+    [Fact]
+    public void WaterBoilingPoint_In_Sut_Scale_Converts_To_WaterBoilingPoint_In_Other_Scales()
+    {
+        // Assign
+        var celsius = Celsius.WaterBoilingPoint;
+
+        // Act
+        var fahrenheit = (Fahrenheit)celsius;
+        var kelvin = (Kelvin)celsius;
+        var rankine = (Rankine)celsius;
+
+        // Assert
+        celsius.Should().BeEquivalentTo(Celsius.WaterBoilingPoint);
+        fahrenheit.Should().BeEquivalentTo(Fahrenheit.WaterBoilingPoint);
+        kelvin.Should().BeEquivalentTo(Kelvin.WaterBoilingPoint);
+        rankine.Should().BeEquivalentTo(Rankine.WaterBoilingPoint);
+    }
+
+    [Fact]
+    public void Minimum_Sut_Scale_Converts_To_Minimum_In_Other_Scales()
+    {
+        // Assign
+        var celsius = new Celsius(Celsius.Minimum);
+
+        // Act
+        double kelvin = (Kelvin)celsius;
+        double fahrenheit = (Fahrenheit)celsius;
+        double rankine = (Rankine)celsius;
+
+        // Assert
+        celsius.Should().BeEquivalentTo((Celsius)Celsius.Minimum);
+        fahrenheit.Should().Be(Fahrenheit.Minimum);
+        kelvin.Should().Be(Kelvin.Minimum);
+        rankine.Should().Be(Rankine.Minimum);
+    }
+}
diff --git a/examples/03-temperature-units-of-measure/Acme.Temperature.UnitTests/FahrenheitTests.cs b/examples/03-temperature-units-of-measure/Acme.Temperature.UnitTests/FahrenheitTests.cs
@@ -0,0 +1,76 @@
+namespace Acme.Temperature.UnitTests;
+
+public class FahrenheitTests
+{
+    [Fact]
+    public void AbsoluteZero_In_Sut_Scale_Converts_To_AbsoluteZero_In_Other_Scales()
+    {
+        // Assign
+        var fahrenheit = Fahrenheit.AbsoluteZero;
+
+        // Act
+        var celsius = (Celsius)fahrenheit;
+        var kelvin = (Kelvin)fahrenheit;
+        var rankine = (Rankine)fahrenheit;
+
+        // Assert
+        celsius.Should().BeEquivalentTo(Celsius.AbsoluteZero);
+        fahrenheit.Should().BeEquivalentTo(Fahrenheit.AbsoluteZero);
+        kelvin.Should().BeEquivalentTo(Kelvin.AbsoluteZero);
+        rankine.Should().BeEquivalentTo(Rankine.AbsoluteZero);
+    }
+
+    [Fact]
+    public void WaterMeltingPoint_In_Sut_Scale_Converts_To_WaterMeltingPoint_In_Other_Scales()
+    {
+        // Assign
+        var fahrenheit = Fahrenheit.WaterMeltingPoint;
+
+        // Act
+        var celsius = (Celsius)fahrenheit;
+        var kelvin = (Kelvin)fahrenheit;
+        var rankine = (Rankine)fahrenheit;
+
+        // Assert
+        celsius.Should().BeEquivalentTo(Celsius.WaterMeltingPoint);
+        fahrenheit.Should().BeEquivalentTo(Fahrenheit.WaterMeltingPoint);
+        kelvin.Should().BeEquivalentTo(Kelvin.WaterMeltingPoint);
+        rankine.Should().BeEquivalentTo(Rankine.WaterMeltingPoint);
+    }
+
+    [Fact]
+    public void WaterBoilingPoint_In_Sut_Scale_Converts_To_WaterBoilingPoint_In_Other_Scales()
+    {
+        // Assign
+        var fahrenheit = Fahrenheit.WaterBoilingPoint;
+
+        // Act
+        var celsius = (Celsius)fahrenheit;
+        var kelvin = (Kelvin)fahrenheit;
+        var rankine = (Rankine)fahrenheit;
+
+        // Assert
+        celsius.Should().BeEquivalentTo(Celsius.WaterBoilingPoint);
+        fahrenheit.Should().BeEquivalentTo(Fahrenheit.WaterBoilingPoint);
+        kelvin.Should().BeEquivalentTo(Kelvin.WaterBoilingPoint);
+        rankine.Should().BeEquivalentTo(Rankine.WaterBoilingPoint);
+    }
+
+    [Fact]
+    public void Minimum_Sut_Scale_Converts_To_Minimum_In_Other_Scales()
+    {
+        // Assign
+        var fahrenheit = new Fahrenheit(Fahrenheit.Minimum);
+
+        // Act
+        double celsius = (Celsius)fahrenheit;
+        double kelvin = (Kelvin)fahrenheit;
+        double rankine = (Rankine)fahrenheit;
+
+        // Assert
+        celsius.Should().Be(Celsius.Minimum);
+        fahrenheit.Should().BeEquivalentTo((Fahrenheit)Fahrenheit.Minimum);
+        kelvin.Should().Be(Kelvin.Minimum);
+        rankine.Should().Be(Rankine.Minimum);
+    }
+}
diff --git a/examples/03-temperature-units-of-measure/Acme.Temperature.UnitTests/GlobalUsings.cs b/examples/03-temperature-units-of-measure/Acme.Temperature.UnitTests/GlobalUsings.cs
@@ -0,0 +1,2 @@
+global using Xunit;
+global using FluentAssertions;
diff --git a/examples/03-temperature-units-of-measure/Acme.Temperature.UnitTests/KelvinTests.cs b/examples/03-temperature-units-of-measure/Acme.Temperature.UnitTests/KelvinTests.cs
@@ -0,0 +1,76 @@
+namespace Acme.Temperature.UnitTests;
+
+public class KelvinTests
+{
+    [Fact]
+    public void AbsoluteZero_In_Sut_Scale_Converts_To_AbsoluteZero_In_Other_Scales()
+    {
+        // Assign
+        var kelvin = Kelvin.AbsoluteZero;
+
+        // Act
+        var celsius = (Celsius)kelvin;
+        var fahrenheit = (Fahrenheit)kelvin;
+        var rankine = (Rankine)kelvin;
+
+        // Assert
+        celsius.Should().BeEquivalentTo(Celsius.AbsoluteZero);
+        fahrenheit.Should().BeEquivalentTo(Fahrenheit.AbsoluteZero);
+        kelvin.Should().BeEquivalentTo(Kelvin.AbsoluteZero);
+        rankine.Should().BeEquivalentTo(Rankine.AbsoluteZero);
+    }
+
+    [Fact]
+    public void WaterMeltingPoint_In_Sut_Scale_Converts_To_WaterMeltingPoint_In_Other_Scales()
+    {
+        // Assign
+        var kelvin = Kelvin.WaterMeltingPoint;
+
+        // Act
+        var celsius = (Celsius)kelvin;
+        var fahrenheit = (Fahrenheit)kelvin;
+        var rankine = (Rankine)kelvin;
+
+        // Assert
+        celsius.Should().BeEquivalentTo(Celsius.WaterMeltingPoint);
+        fahrenheit.Should().BeEquivalentTo(Fahrenheit.WaterMeltingPoint);
+        kelvin.Should().BeEquivalentTo(Kelvin.WaterMeltingPoint);
+        rankine.Should().BeEquivalentTo(Rankine.WaterMeltingPoint);
+    }
+
+    [Fact]
+    public void WaterBoilingPoint_In_Sut_Scale_Converts_To_WaterBoilingPoint_In_Other_Scales()
+    {
+        // Assign
+        var kelvin = Kelvin.WaterBoilingPoint;
+
+        // Act
+        var celsius = (Celsius)kelvin;
+        var fahrenheit = (Fahrenheit)kelvin;
+        var rankine = (Rankine)kelvin;
+
+        // Assert
+        celsius.Should().BeEquivalentTo(Celsius.WaterBoilingPoint);
+        fahrenheit.Should().BeEquivalentTo(Fahrenheit.WaterBoilingPoint);
+        kelvin.Should().BeEquivalentTo(Kelvin.WaterBoilingPoint);
+        rankine.Should().BeEquivalentTo(Rankine.WaterBoilingPoint);
+    }
+
+    [Fact]
+    public void Minimum_Sut_Scale_Converts_To_Minimum_In_Other_Scales()
+    {
+        // Assign
+        var kelvin = new Kelvin(Kelvin.Minimum);
+
+        // Act
+        double celsius = (Celsius)kelvin;
+        double fahrenheit = (Fahrenheit)kelvin;
+        double rankine = (Rankine)kelvin;
+
+        // Assert
+        celsius.Should().Be(Celsius.Minimum);
+        fahrenheit.Should().Be(Fahrenheit.Minimum);
+        kelvin.Should().BeEquivalentTo((Kelvin)Kelvin.Minimum);
+        rankine.Should().Be(Rankine.Minimum);
+    }
+}
diff --git a/examples/03-temperature-units-of-measure/Acme.Temperature.UnitTests/RankineTests.cs b/examples/03-temperature-units-of-measure/Acme.Temperature.UnitTests/RankineTests.cs
@@ -0,0 +1,76 @@
+namespace Acme.Temperature.UnitTests;
+
+public class RankineTests
+{
+    [Fact]
+    public void AbsoluteZero_In_Sut_Scale_Converts_To_AbsoluteZero_In_Other_Scales()
+    {
+        // Assign
+        var rankine = Rankine.AbsoluteZero;
+
+        // Act
+        var celsius = (Celsius)rankine;
+        var fahrenheit = (Fahrenheit)rankine;
+        var kelvin = (Kelvin)rankine;
+
+        // Assert
+        celsius.Should().BeEquivalentTo(Celsius.AbsoluteZero);
+        fahrenheit.Should().BeEquivalentTo(Fahrenheit.AbsoluteZero);
+        kelvin.Should().BeEquivalentTo(Kelvin.AbsoluteZero);
+        rankine.Should().BeEquivalentTo(Rankine.AbsoluteZero);
+    }
+
+    [Fact]
+    public void WaterMeltingPoint_In_Sut_Scale_Converts_To_WaterMeltingPoint_In_Other_Scales()
+    {
+        // Assign
+        var rankine = Rankine.WaterMeltingPoint;
+
+        // Act
+        var celsius = (Celsius)rankine;
+        var fahrenheit = (Fahrenheit)rankine;
+        var kelvin = (Kelvin)rankine;
+
+        // Assert
+        celsius.Should().BeEquivalentTo(Celsius.WaterMeltingPoint);
+        fahrenheit.Should().BeEquivalentTo(Fahrenheit.WaterMeltingPoint);
+        kelvin.Should().BeEquivalentTo(Kelvin.WaterMeltingPoint);
+        rankine.Should().BeEquivalentTo(Rankine.WaterMeltingPoint);
+    }
+
+    [Fact]
+    public void WaterBoilingPoint_In_Sut_Scale_Converts_To_WaterBoilingPoint_In_Other_Scales()
+    {
+        // Assign
+        var rankine = Rankine.WaterBoilingPoint;
+
+        // Act
+        var celsius = (Celsius)rankine;
+        var fahrenheit = (Fahrenheit)rankine;
+        var kelvin = (Kelvin)rankine;
+
+        // Assert
+        celsius.Should().BeEquivalentTo(Celsius.WaterBoilingPoint);
+        fahrenheit.Should().BeEquivalentTo(Fahrenheit.WaterBoilingPoint);
+        kelvin.Should().BeEquivalentTo(Kelvin.WaterBoilingPoint);
+        rankine.Should().BeEquivalentTo(Rankine.WaterBoilingPoint);
+    }
+
+    [Fact]
+    public void Minimum_Sut_Scale_Converts_To_Minimum_In_Other_Scales()
+    {
+        // Assign
+        var rankine = new Rankine(Rankine.Minimum);
+
+        // Act
+        double celsius = (Celsius)rankine;
+        double fahrenheit = (Fahrenheit)rankine;
+        double kelvin = (Kelvin)rankine;
+
+        // Assert
+        celsius.Should().Be(Celsius.Minimum);
+        fahrenheit.Should().Be(Fahrenheit.Minimum);
+        kelvin.Should().Be(Kelvin.Minimum);
+        rankine.Should().BeEquivalentTo((Rankine)Rankine.Minimum);
+    }
+}
diff --git a/examples/03-temperature-units-of-measure/Acme.Temperature/Acme.Temperature.csproj b/examples/03-temperature-units-of-measure/Acme.Temperature/Acme.Temperature.csproj
@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Primitively" Version="1.5.0-alpha.14" PrivateAssets="all" />
+  </ItemGroup>
+
+</Project>