Feature/default constructor

.github/workflows/BuildAndPack.yml

@@ -58,63 +58,63 @@ jobs:
         with:
           name: artifacts
           path: artifacts
-  windows-latest:
-    name: windows-latest
-    runs-on: windows-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-dotnet@v3
-        with:
-          dotnet-version: |
-            7.0.x
-            6.0.x
-            5.0.x
-            3.1.x
-      - name: Cache .nuke/temp, ~/.nuget/packages
-        uses: actions/cache@v2
-        with:
-          path: |
-            .nuke/temp
-            ~/.nuget/packages
-            !~/.nuget/packages/stronglytypeid
-          key: ${{ runner.os }}-${{ hashFiles('**/global.json', '**/*.csproj') }}
-      - name: Run './build.cmd Clean Test TestPackages PushToNuGet'
-        run: ./build.cmd Clean Test TestPackages PushToNuGet
-        env:
-          GithubToken: ${{ secrets.GITHUB_TOKEN }}
-          NuGetToken: ${{ secrets.NUGET_TOKEN }}
-          MSBuildEnableWorkloadResolver: false
-      - uses: actions/upload-artifact@v1
-        with:
-          name: artifacts
-          path: artifacts
-  macOS-latest:
-    name: macOS-latest
-    runs-on: macOS-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-dotnet@v3
-        with:
-          dotnet-version: |
-            7.0.x
-            6.0.x
-            5.0.x
-            3.1.x
-      - name: Cache .nuke/temp, ~/.nuget/packages
-        uses: actions/cache@v2
-        with:
-          path: |
-            .nuke/temp
-            ~/.nuget/packages
-            !~/.nuget/packages/stronglytypeid
-          key: ${{ runner.os }}-${{ hashFiles('**/global.json', '**/*.csproj') }}
-      - name: Run './build.cmd Clean Test TestPackages PushToNuGet'
-        run: ./build.cmd Clean Test TestPackages PushToNuGet
-        env:
-          GithubToken: ${{ secrets.GITHUB_TOKEN }}
-          NuGetToken: ${{ secrets.NUGET_TOKEN }}
-          MSBuildEnableWorkloadResolver: false
-      - uses: actions/upload-artifact@v1
-        with:
-          name: artifacts
-          path: artifacts
+#  windows-latest:
+#    name: windows-latest
+#    runs-on: windows-latest
+#    steps:
+#      - uses: actions/checkout@v3
+#      - uses: actions/setup-dotnet@v3
+#        with:
+#          dotnet-version: |
+#            7.0.x
+#            6.0.x
+#            5.0.x
+#            3.1.x
+#      - name: Cache .nuke/temp, ~/.nuget/packages
+#        uses: actions/cache@v2
+#        with:
+#          path: |
+#            .nuke/temp
+#            ~/.nuget/packages
+#            !~/.nuget/packages/stronglytypeid
+#          key: ${{ runner.os }}-${{ hashFiles('**/global.json', '**/*.csproj') }}
+#      - name: Run './build.cmd Clean Test TestPackages PushToNuGet'
+#        run: ./build.cmd Clean Test TestPackages PushToNuGet
+#        env:
+#          GithubToken: ${{ secrets.GITHUB_TOKEN }}
+#          NuGetToken: ${{ secrets.NUGET_TOKEN }}
+#          MSBuildEnableWorkloadResolver: false
+#      - uses: actions/upload-artifact@v1
+#        with:
+#          name: artifacts
+#          path: artifacts
+#  macOS-latest:
+#    name: macOS-latest
+#    runs-on: macOS-latest
+#    steps:
+#      - uses: actions/checkout@v3
+#      - uses: actions/setup-dotnet@v3
+#        with:
+#          dotnet-version: |
+#            7.0.x
+#            6.0.x
+#            5.0.x
+#            3.1.x
+#      - name: Cache .nuke/temp, ~/.nuget/packages
+#        uses: actions/cache@v2
+#        with:
+#          path: |
+#            .nuke/temp
+#            ~/.nuget/packages
+#            !~/.nuget/packages/stronglytypeid
+#          key: ${{ runner.os }}-${{ hashFiles('**/global.json', '**/*.csproj') }}
+#      - name: Run './build.cmd Clean Test TestPackages PushToNuGet'
+#        run: ./build.cmd Clean Test TestPackages PushToNuGet
+#        env:
+#          GithubToken: ${{ secrets.GITHUB_TOKEN }}
+#          NuGetToken: ${{ secrets.NUGET_TOKEN }}
+#          MSBuildEnableWorkloadResolver: false
+#      - uses: actions/upload-artifact@v1
+#        with:
+#          name: artifacts
+#          path: artifacts

Directory.Build.props

@@ -10,9 +10,9 @@
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageIcon>logo.png</PackageIcon>
-    <PackageProjectUrl>https://github.com/andrewlock/StronglyTypedId</PackageProjectUrl>
+    <PackageProjectUrl>https://github.com/tennisi/StronglyTypedId</PackageProjectUrl>
     <PackageTags>stronglytypedid attribute generator generation codegen codegenerator codegeneration netescapades</PackageTags>
-    <RepositoryUrl>https://github.com/andrewlock/StronglyTypedId</RepositoryUrl>
+    <RepositoryUrl>https://github.com/tennisi/StronglyTypedId</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <CheckEolTargetFramework>false</CheckEolTargetFramework>
   </PropertyGroup>
@@ -42,4 +42,4 @@
 
   <Import Project="releasenotes.props" />
 
-</Project>
+</Project>

README.md

@@ -54,6 +54,8 @@ To use the the [StronglyTypedId NuGet package](https://www.nuget.org/packages/St
 * [System.Text.Json](https://www.nuget.org/packages/System.Text.Json/) (optional, only required if [generating a System.Text `JsonConverter`](https://andrewlock.net/using-strongly-typed-entity-ids-to-avoid-primitive-obsession-part-2/#creating-a-custom-jsonconverter)). Note that in .NET Core apps, you will likely already reference this project via transitive dependencies.
 * [Dapper](https://www.nuget.org/packages/Dapper/) (optional, only required if [generating a type mapper](https://andrewlock.net/using-strongly-typed-entity-ids-to-avoid-primitive-obsession-part-3/#interfacing-with-external-system-using-strongly-typed-ids))
 * [EF Core](https://www.nuget.org/packages/Microsoft.EntityFrameworkCore) (optional, only required if [generating an EF Core ValueConverter](https://andrewlock.net/strongly-typed-ids-in-ef-core-using-strongly-typed-entity-ids-to-avoid-primitive-obsession-part-4/))
+* [Swagger Annotations](https://www.nuget.org/packages/Swashbuckle.AspNetCore.Annotations) (optional, only required if [generating an Swagger Schema Filter](#openapiswagger-specification)
+
 
 To install the packages, add the references to your _csproj_ file, for example by running
 
@@ -160,6 +162,18 @@ public partial struct OrderId { }
 public partial struct UserId { }
 ```
 
+## OpenApi/Swagger Specification
+
+If you wish to use an ID in your Swagger models and want to have schema and model sample reflecting the ID backingfield type you will need:
+- Install [Swagger Annotations](https://www.nuget.org/packages/Swashbuckle.AspNetCore.Annotations) `>=5.0.0` 
+- Enable annotation in swagger gen with `services.AddSwaggerGen(c => c.EnableAnnotations());`
+- Use the converter flag `StronglyTypedIdConverter.SwaggerSchemaFilter` on the ID decorator. eg:
+    ```csharp
+    [StronglyTypedId(
+        backingType: StronglyTypedIdBackingType.Int,
+        converters: StronglyTypedIdConverter.SwaggerSchemaFilter | StronglyTypedIdConverter.SystemTextJson)]
+    public partial struct UserId { }
+    ```
 
 ## Embedding the attributes in your project
 
@@ -253,4 +267,4 @@ The `struct`s you decorate with the `StronglyTypedId` attribute must be marked `
 
 `StronglyTypedId` wouldn't work if not for [AArnott's CodeGeneration.Roslyn](https://github.com/AArnott/CodeGeneration.Roslyn) library.
 
-The build process and general design of the library was modelled on the [RecordGenerator](https://github.com/amis92/RecordGenerator/blob/master/README.md) project, which is similar to this project, but can be used to generate immutable Record types.
+The build process and general design of the library was modelled on the [RecordGenerator](https://github.com/amis92/RecordGenerator/blob/master/README.md) project, which is similar to this project, but can be used to generate immutable Record types.

StronglyTypedId.sln

@@ -1,7 +1,7 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Version 16
-VisualStudioVersion = 16.0.28803.352
+# Visual Studio Version 17
+VisualStudioVersion = 17.4.33122.133
 MinimumVisualStudioVersion = 15.0.26124.0
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{EE1258BD-3422-4F55-B9CF-B4D6C95DAD68}"
 EndProject
@@ -16,21 +16,26 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		README.md = README.md
 		releasenotes.props = releasenotes.props
 		version.props = version.props
+		.github\workflows\BuildAndPack.yml = .github\workflows\BuildAndPack.yml
+		CHANGELOG.md = CHANGELOG.md
+		build.sh = build.sh
+		NuGet.integration-tests.config = NuGet.integration-tests.config
+		global.json = global.json
 	EndProjectSection
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "StronglyTypedIds", "src\StronglyTypedIds\StronglyTypedIds.csproj", "{9C0F3A36-ED47-4D0F-B736-EFC559C9E2DA}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "StronglyTypedIds", "src\StronglyTypedIds\StronglyTypedIds.csproj", "{9C0F3A36-ED47-4D0F-B736-EFC559C9E2DA}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "StronglyTypedIds.Tests", "test\StronglyTypedIds.Tests\StronglyTypedIds.Tests.csproj", "{00B5ED3F-827D-41CD-9AF2-A9A20A6604E1}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "StronglyTypedIds.Tests", "test\StronglyTypedIds.Tests\StronglyTypedIds.Tests.csproj", "{00B5ED3F-827D-41CD-9AF2-A9A20A6604E1}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "StronglyTypedIds.IntegrationTests", "test\StronglyTypedIds.IntegrationTests\StronglyTypedIds.IntegrationTests.csproj", "{09F7364F-8CE9-4E9D-9BB7-B4CEBF682904}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "StronglyTypedIds.IntegrationTests", "test\StronglyTypedIds.IntegrationTests\StronglyTypedIds.IntegrationTests.csproj", "{09F7364F-8CE9-4E9D-9BB7-B4CEBF682904}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "_build", "build\_build.csproj", "{E13FB452-2D47-4719-8BAA-7B695D79AF3A}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "StronglyTypedIds.Attributes", "src\StronglyTypedIds.Attributes\StronglyTypedIds.Attributes.csproj", "{F25F6E67-E62A-4075-86CF-4C4EDD7E4883}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "StronglyTypedIds.Attributes", "src\StronglyTypedIds.Attributes\StronglyTypedIds.Attributes.csproj", "{F25F6E67-E62A-4075-86CF-4C4EDD7E4883}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "StronglyTypedIds.Nuget.IntegrationTests", "test\StronglyTypedIds.Nuget.IntegrationTests\StronglyTypedIds.Nuget.IntegrationTests.csproj", "{A7355210-7DDC-4968-84B7-79002113EA6E}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "StronglyTypedIds.Nuget.IntegrationTests", "test\StronglyTypedIds.Nuget.IntegrationTests\StronglyTypedIds.Nuget.IntegrationTests.csproj", "{A7355210-7DDC-4968-84B7-79002113EA6E}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "StronglyTypedIds.Nuget.Attributes.IntegrationTests", "test\StronglyTypedIds.Nuget.Attributes.IntegrationTests\StronglyTypedIds.Nuget.Attributes.IntegrationTests.csproj", "{19A9B323-8C0B-4D1B-A20C-8CECFFD37F23}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "StronglyTypedIds.Nuget.Attributes.IntegrationTests", "test\StronglyTypedIds.Nuget.Attributes.IntegrationTests\StronglyTypedIds.Nuget.Attributes.IntegrationTests.csproj", "{19A9B323-8C0B-4D1B-A20C-8CECFFD37F23}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -42,8 +47,6 @@ Global
 		Release|x86 = Release|x86
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{E13FB452-2D47-4719-8BAA-7B695D79AF3A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{E13FB452-2D47-4719-8BAA-7B695D79AF3A}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{9C0F3A36-ED47-4D0F-B736-EFC559C9E2DA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{9C0F3A36-ED47-4D0F-B736-EFC559C9E2DA}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{9C0F3A36-ED47-4D0F-B736-EFC559C9E2DA}.Debug|x64.ActiveCfg = Debug|Any CPU
@@ -80,6 +83,16 @@ Global
 		{09F7364F-8CE9-4E9D-9BB7-B4CEBF682904}.Release|x64.Build.0 = Release|Any CPU
 		{09F7364F-8CE9-4E9D-9BB7-B4CEBF682904}.Release|x86.ActiveCfg = Release|Any CPU
 		{09F7364F-8CE9-4E9D-9BB7-B4CEBF682904}.Release|x86.Build.0 = Release|Any CPU
+		{E13FB452-2D47-4719-8BAA-7B695D79AF3A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{E13FB452-2D47-4719-8BAA-7B695D79AF3A}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{E13FB452-2D47-4719-8BAA-7B695D79AF3A}.Debug|x64.Build.0 = Debug|Any CPU
+		{E13FB452-2D47-4719-8BAA-7B695D79AF3A}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{E13FB452-2D47-4719-8BAA-7B695D79AF3A}.Debug|x86.Build.0 = Debug|Any CPU
+		{E13FB452-2D47-4719-8BAA-7B695D79AF3A}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{E13FB452-2D47-4719-8BAA-7B695D79AF3A}.Release|x64.ActiveCfg = Release|Any CPU
+		{E13FB452-2D47-4719-8BAA-7B695D79AF3A}.Release|x64.Build.0 = Release|Any CPU
+		{E13FB452-2D47-4719-8BAA-7B695D79AF3A}.Release|x86.ActiveCfg = Release|Any CPU
+		{E13FB452-2D47-4719-8BAA-7B695D79AF3A}.Release|x86.Build.0 = Release|Any CPU
 		{F25F6E67-E62A-4075-86CF-4C4EDD7E4883}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{F25F6E67-E62A-4075-86CF-4C4EDD7E4883}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{F25F6E67-E62A-4075-86CF-4C4EDD7E4883}.Debug|x64.ActiveCfg = Debug|Any CPU

build/Build.cs

@@ -146,7 +146,7 @@ class Build : NukeBuild
 
     Target PushToNuGet => _ => _
         .DependsOn(Compile)
-        .OnlyWhenStatic(() => IsTag && IsServerBuild && IsWin)
+        .OnlyWhenStatic(() => true || ( IsTag && IsServerBuild && IsWin ))
         .Requires(() => NuGetToken)
         .After(Pack)
         .Executes(() =>

src/StronglyTypedIds.Attributes/StronglyTypedIdConverter.cs

@@ -46,5 +46,11 @@ public enum StronglyTypedIdConverter
         /// Creates a Dapper TypeHandler for converting to and from the type
         /// </summary>
         DapperTypeHandler = 32,
+
+        /// <summary>
+        /// Creates a Swagger SchemaFilter for OpenApi documentation
+        /// </summary>
+        SwaggerSchemaFilter = 64,
+
     }
 }

src/StronglyTypedIds.Attributes/StronglyTypedIdImplementations.cs

@@ -8,7 +8,7 @@ namespace StronglyTypedIds
     [Flags]
     public enum StronglyTypedIdImplementations
     {
-        // Used with HasFlag, so needs to be 1, 2, 4 etc
+        // Used with HasFlag, so needs to be 1, 2, 4, 8 etc
 
         /// <summary>
         /// Don't implement any additional members for the strongly typed ID
@@ -33,5 +33,11 @@ public enum StronglyTypedIdImplementations
         /// Implement the <see cref="IComparable{T}"/> interface
         /// </summary>
         IComparable = 4,
+
+        // ReSharper disable once InconsistentNaming
+        /// <summary>
+        /// Implement the <see cref="IParsable{T}"/> interface
+        /// </summary>
+        IParsable = 8
     }
-}
+}

src/StronglyTypedIds.Attributes/StronglyTypedIds.Attributes.csproj

@@ -2,8 +2,8 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
-    <Nullable>enable</Nullable>
     <RootNamespace>StronglyTypedIds</RootNamespace>
+    <Nullable>enable</Nullable>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 

src/StronglyTypedIds/Constants.cs

@@ -1,7 +1,9 @@
+using System;
+
 namespace StronglyTypedIds
 {
     internal static class Constants
     {
         public const string Usage = nameof(Usage);
     }
-}
+}