Merge pull request #35 from jonsagara/release/3.1.0

jonsagara · web-flow · commit 62efc25dbf5a · 2024-11-19T23:19:39.000-08:00
Merge 3.1.0 into main for release
diff --git a/docs/AAMVA-2000-DLID-Card-Design-Standard.pdf b/docs/AAMVA-2000-DLID-Card-Design-Standard.pdf
diff --git a/docs/AAMVA-2003-DLID-Card-Design-Standard.pdf b/docs/AAMVA-2003-DLID-Card-Design-Standard.pdf
diff --git a/docs/AAMVA-2005-DLID-Card-Design-Standard.pdf b/docs/AAMVA-2005-DLID-Card-Design-Standard.pdf
diff --git a/docs/AAMVA-2010-DLID-Card-Design-Standard.pdf b/docs/AAMVA-2010-DLID-Card-Design-Standard.pdf
diff --git a/global.json b/global.json
@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "8.0.200",
+    "version": "9.0.100",
     "rollForward": "latestPatch"
   }
 }
diff --git a/src/IdParser.Core.Benchmarks/IdParser.Core.Benchmarks.csproj b/src/IdParser.Core.Benchmarks/IdParser.Core.Benchmarks.csproj
@@ -2,13 +2,14 @@
 
 	<PropertyGroup>
 		<OutputType>Exe</OutputType>
-		<TargetFramework>net8.0</TargetFramework>
+		<TargetFramework>net9.0</TargetFramework>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="BenchmarkDotNet" Version="0.13.12" />
+		<PackageReference Include="BenchmarkDotNet" Version="0.14.0" />
+		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.0" />
 	</ItemGroup>
 
 	<ItemGroup>
diff --git a/src/IdParser.Core.Client/IdParser.Core.Client.csproj b/src/IdParser.Core.Client/IdParser.Core.Client.csproj
@@ -1,6 +1,6 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
-		<TargetFramework>net8.0-windows</TargetFramework>
+		<TargetFramework>net9.0-windows</TargetFramework>
 		<OutputType>WinExe</OutputType>
 		<AssemblyName>ID Parser</AssemblyName>
 		<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
@@ -28,13 +28,13 @@
 		<Content Include="ID Parser Icon.ico" />
 	</ItemGroup>
 	<ItemGroup>
-		<Reference
-			Include="Microsoft.PointOfService, Version=1.14.1.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
+		<Reference Include="Microsoft.PointOfService, Version=1.14.1.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
 			<SpecificVersion>False</SpecificVersion>
 			<HintPath>..\..\lib\Microsoft.PointOfService.dll</HintPath>
 		</Reference>
 	</ItemGroup>
 	<ItemGroup>
+		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.0" />
 		<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
 		<PackageReference Include="System.Data.DataSetExtensions" Version="4.5.0" />
 	</ItemGroup>
diff --git a/src/IdParser.Core.Client/Main.cs b/src/IdParser.Core.Client/Main.cs
@@ -76,10 +76,14 @@ private void Disconnect()
             try
             {
                 SetStatus(Level.Info, "Disconnecting scanner");
-                RemoveDataEvent(_scanner);
-                _scanner.DeviceEnabled = false;
-                _scanner.Release();
-                _scanner.Close();
+
+                if (_scanner is not null)
+                {
+                    RemoveDataEvent(_scanner);
+                    _scanner.DeviceEnabled = false;
+                    _scanner.Release();
+                    _scanner.Close();
+                }
 
                 SetStatus(Level.Success, "Scanner disconnected");
             }
diff --git a/src/IdParser.Core.Test/DriversLicenseTests.cs b/src/IdParser.Core.Test/DriversLicenseTests.cs
@@ -192,6 +192,49 @@ public void TestNYLicense()
         Assert.Equal("New York", parseResult.Card.IssuerIdentificationNumber.Value.GetDescriptionOrDefault());
     }
 
+    [Fact]
+    public void TestNYLicenseWithAAMVA2000Height()
+    {
+        var expected = new DriversLicense
+        {
+            FirstName = FV<string?>(SubfileElementIds.FirstName, "ALDO"),
+            MiddleName = FV<string?>(SubfileElementIds.MiddleName, null),
+            LastName = FV<string?>(SubfileElementIds.LastName, "ADAMS"),
+
+            StreetLine1 = FV<string?>(SubfileElementIds.StreetLine1, "1234 ANY STREET"),
+            City = FV<string?>(SubfileElementIds.City, "ANYTOWN"),
+            JurisdictionCode = FV<string?>(SubfileElementIds.JurisdictionCode, "NY"),
+            PostalCode = FV<string?>(SubfileElementIds.PostalCode, "11111"),
+            Country = FV<Country>(SubfileElementIds.Country, Country.USA),
+
+            DateOfBirth = FV<DateTime?>(SubfileElementIds.DateOfBirth, new DateTime(1972, 2, 2)),
+            Sex = FV<Sex?>(SubfileElementIds.Sex, Sex.Male),
+            Height = FV<Height?>(SubfileElementIds.Height, new Height(feet: 6, inches: 1)),
+            EyeColor = FV<EyeColor?>(SubfileElementIds.EyeColor, EyeColor.Brown),
+
+            IdNumber = FV(SubfileElementIds.IdNumber, "123456789"),
+            AAMVAVersionNumber = FV(null, AAMVAVersion.AAMVA2005),
+
+            IssueDate = FV<DateTime?>(SubfileElementIds.IssueDate, new DateTime(2019, 2, 2)),
+            ExpirationDate = FV<DateTime?>(SubfileElementIds.ExpirationDate, new DateTime(2028, 2, 2)),
+
+            RevisionDate = FV<DateTime?>(SubfileElementIds.RevisionDate, new DateTime(2017, 9, 9)),
+            ComplianceType = FV<ComplianceType?>(SubfileElementIds.ComplianceType, ComplianceType.FullyCompliant),
+
+            VehicleClass = FV<string?>(SubfileElementIds.VehicleClass, "DM"),
+        };
+
+        var file = License("NY AAMVA2005 Height");
+        var parseResult = Barcode.Parse(file, Validation.None);
+        LogUnhandledElementIds(parseResult);
+
+        AssertNoErrors(parseResult);
+        AssertIdCard(expected, parseResult.Card);
+        AssertLicense(expected, parseResult.Card);
+
+        Assert.Equal("New York", parseResult.Card.IssuerIdentificationNumber.Value.GetDescriptionOrDefault());
+    }
+
     [Fact]
     public void TestVALicense()
     {
diff --git a/src/IdParser.Core.Test/IdParser.Core.Test.csproj b/src/IdParser.Core.Test/IdParser.Core.Test.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFramework>net8.0</TargetFramework>
+		<TargetFramework>net9.0</TargetFramework>
 		<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
 		<AssemblyTitle>IdParser.Core.Test</AssemblyTitle>
 		<Product>IdParser.Core.Test</Product>
@@ -24,9 +24,10 @@
 		</Content>
 	</ItemGroup>
 	<ItemGroup>
-		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
-		<PackageReference Include="xunit" Version="2.7.0" />
-		<PackageReference Include="xunit.runner.visualstudio" Version="2.5.7">
+		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.0" />
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
+		<PackageReference Include="xunit" Version="2.9.2" />
+		<PackageReference Include="xunit.runner.visualstudio" Version="2.8.2">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
 		</PackageReference>
diff --git a/src/IdParser.Core.Test/Licenses/NY AAMVA2005 Height.txt b/src/IdParser.Core.Test/Licenses/NY AAMVA2005 Height.txt
@@ -0,0 +1,23 @@
+@
+
+ANSI 636001030302DL00410279ZN03200070DLDCADM  
+DCBNONE      
+DCDNONE 
+DBA02022028
+DCSADAMS                  
+DCTALDO                  
+DBD02022019
+DBB02021972
+DBC1
+DAYBRO
+DAU601   
+DAG1234 ANY STREET       
+DAIANYTOWN             
+DAJNY
+DAK111110000  
+DAQ123456789
+DCFABC123
+DCGUSA
+DDAF
+DDB09092017
+DDD0
diff --git a/src/IdParser.Core/Barcode.cs b/src/IdParser.Core/Barcode.cs
@@ -182,7 +182,7 @@ private static void ValidateHeaderFormat(string input)
     /// <param name="input">The raw PDF417 barcode data</param>
     private static AAMVAVersionResult ParseAAMVAVersion(string input)
     {
-        ArgumentNullException.ThrowIfNull(nameof(input));
+        ArgumentNullException.ThrowIfNull(input);
 
         if (input.Length < 17)
         {
diff --git a/src/IdParser.Core/Fixes.cs b/src/IdParser.Core/Fixes.cs
@@ -12,11 +12,19 @@ internal static string TryToCorrectHeader(string rawPdf417Input, ILoggerFactory
     {
         var logger = loggerFactory.CreateLogger(typeof(Fixes));
 
-        return rawPdf417Input
-            .RemoveUndefinedCharacters()
-            .RemoveInvalidCharactersFromHeader(logger)
-            .FixIncorrectHeader(logger)
-            .RemoveIncorrectCarriageReturns(logger);
+        // This isn't easily debuggable.
+        //return rawPdf417Input
+        //    .RemoveUndefinedCharacters()
+        //    .RemoveInvalidCharactersFromHeader(logger)
+        //    .FixIncorrectHeader(logger)
+        //    .RemoveIncorrectCarriageReturns(logger);
+
+        rawPdf417Input = rawPdf417Input.RemoveUndefinedCharacters();
+        rawPdf417Input = rawPdf417Input.RemoveInvalidCharactersFromHeader(logger);
+        rawPdf417Input = rawPdf417Input.FixIncorrectHeader(logger);
+        rawPdf417Input = rawPdf417Input.RemoveIncorrectCarriageReturns(logger);
+
+        return rawPdf417Input;
     }
 
 
diff --git a/src/IdParser.Core/IdParser.Core.csproj b/src/IdParser.Core/IdParser.Core.csproj
@@ -1,14 +1,14 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFrameworks>net8.0</TargetFrameworks>
+		<TargetFrameworks>net8.0;net9.0</TargetFrameworks>
 		<Nullable>enable</Nullable>
 		<ImplicitUsings>enable</ImplicitUsings>
 
 		<!-- NuGet -->
-		<Version>3.0.0</Version>
-		<AssemblyVersion>3.0.0</AssemblyVersion>
-		<FileVersion>3.0.0</FileVersion>
+		<Version>3.1.0</Version>
+		<AssemblyVersion>3.1.0</AssemblyVersion>
+		<FileVersion>3.1.0</FileVersion>
 		<Authors>Connor O'Shea, Jon Sagara</Authors>
 		<Company />
 		<PackageId>IdParser.Core</PackageId>
@@ -40,8 +40,12 @@
 		<None Include="..\..\README.md" Pack="true" PackagePath="\" />
 	</ItemGroup>
 
-	<ItemGroup>
-		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.0" />
+	<ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
+		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.2" />
+	</ItemGroup>
+
+	<ItemGroup Condition="'$(TargetFramework)' == 'net9.0'">
+		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.0" />
 	</ItemGroup>
 
 	<PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Debug|net6.0|AnyCPU'">
diff --git a/src/IdParser.Core/Parsers/Id/HeightParser.cs b/src/IdParser.Core/Parsers/Id/HeightParser.cs
@@ -1,4 +1,5 @@
-﻿using System.Globalization;
+﻿using System.Diagnostics.CodeAnalysis;
+using System.Globalization;
 using IdParser.Core.Constants;
 
 namespace IdParser.Core.Parsers.Id;
@@ -26,28 +27,72 @@ internal static class HeightParser
 
         if (version == AAMVAVersion.AAMVA2000)
         {
-            var feetSpan = rawValue.AsSpan(start: 0, length: 1);
-            if (!int.TryParse(feetSpan, NumberStyles.Integer, provider: CultureInfo.InvariantCulture, out int feet))
+            if (!TryParseAAMVA2000Height(rawValue, out int? feet, out int? inches, out string? parseError))
             {
-                return FieldHelpers.UnparsedField<Height?>(elementId: elementId, rawValue: rawValue, $"Unable to parse Height Feet from field '{SubfileElementIds.Height}': '{feetSpan}' is not a valid integer.");
+                return FieldHelpers.UnparsedField<Height?>(elementId: elementId, rawValue: rawValue, error: parseError);
             }
 
-            var inchesSpan = rawValue.AsSpan(start: 1, length: 2);
-            if (!int.TryParse(inchesSpan, NumberStyles.Integer, provider: CultureInfo.InvariantCulture, out int inches))
+            return FieldHelpers.ParsedField<Height?>(elementId: elementId, value: new Height(feet: feet.Value, inches: inches.Value), rawValue: rawValue);
+        }
+
+        if (int.TryParse(rawValue.AsSpan(start: 0, length: rawValue.Length - 2), NumberStyles.Integer, provider: CultureInfo.InvariantCulture, out int height))
+        {
+            // #31: Even though AAMVA > 2000 is not supposed to have height as Feet and Inches mashed together, apparently
+            //   NY didn't get the memo because we got a report of an AAMVA 2005 NY license with the AAMVA 2000 height
+            //   formatting. Explicitly check for both cm and in, and if it's neither, try to parse it as AAMVA 2000.
+
+            if (rawValue.Contains("cm", StringComparison.OrdinalIgnoreCase))
             {
-                return FieldHelpers.UnparsedField<Height?>(elementId: elementId, rawValue: rawValue, $"Unable to parse Height Inches from field '{SubfileElementIds.Height}': '{inchesSpan}' is not a valid integer.");
+                return FieldHelpers.ParsedField<Height?>(elementId: elementId, value: new Height(centimeters: height), rawValue: rawValue);
             }
 
-            return FieldHelpers.ParsedField<Height?>(elementId: elementId, value: new Height(feet: feet, inches: inches), rawValue: rawValue);
+            if (rawValue.Contains("in", StringComparison.OrdinalIgnoreCase))
+            {
+                return FieldHelpers.ParsedField<Height?>(elementId: elementId, value: new Height(totalInches: height), rawValue: rawValue);
+            }
+
+            if (TryParseAAMVA2000Height(rawValue, out int? feet, out int? inches, out string? parseError))
+            {
+                return FieldHelpers.ParsedField<Height?>(elementId: elementId, value: new Height(feet: feet.Value, inches: inches.Value), rawValue: rawValue);
+            }
+
+            return FieldHelpers.UnparsedField<Height?>(elementId: elementId, rawValue: rawValue, error: parseError);
         }
 
-        if (int.TryParse(rawValue.AsSpan(start: 0, length: rawValue.Length - 2), NumberStyles.Integer, provider: CultureInfo.InvariantCulture, out int height))
+        return FieldHelpers.UnparsedField<Height?>(elementId: elementId, rawValue: rawValue, error: $"Unable to parse Height from field '{SubfileElementIds.Height}': '{rawValue}'.");
+    }
+
+
+    //
+    // Private methods
+    //
+
+    private static bool TryParseAAMVA2000Height(string rawValue, [NotNullWhen(true)] out int? feet, [NotNullWhen(true)] out int? inches, [NotNullWhen(false)] out string? parseError)
+    {
+        var feetSpan = rawValue.AsSpan(start: 0, length: 1);
+        if (!int.TryParse(feetSpan, NumberStyles.Integer, provider: CultureInfo.InvariantCulture, out int parsedFeet))
+        {
+            feet = null;
+            inches = null;
+            parseError = $"Unable to parse Height Feet from field '{SubfileElementIds.Height}': '{feetSpan}' is not a valid integer.";
+
+            return false;
+        }
+
+        var inchesSpan = rawValue.AsSpan(start: 1, length: 2);
+        if (!int.TryParse(inchesSpan, NumberStyles.Integer, provider: CultureInfo.InvariantCulture, out int parsedInches))
         {
-            return rawValue.Contains("cm", StringComparison.OrdinalIgnoreCase)
-                ? FieldHelpers.ParsedField<Height?>(elementId: elementId, value: new Height(centimeters: height), rawValue: rawValue)
-                : FieldHelpers.ParsedField<Height?>(elementId: elementId, value: new Height(totalInches: height), rawValue: rawValue);
+            feet = null;
+            inches = null;
+            parseError = $"Unable to parse Height Inches from field '{SubfileElementIds.Height}': '{inchesSpan}' is not a valid integer.";
+
+            return false;
         }
 
-        return FieldHelpers.UnparsedField<Height?>(elementId: elementId, rawValue: rawValue, error: $"Unable to parse Height from field '{SubfileElementIds.Height}': '{rawValue}'.");
+        feet = parsedFeet;
+        inches = parsedInches;
+        parseError = null;
+
+        return true;
     }
 }
diff --git a/src/IdParser.Core/Parsers/Id/NameParser.cs b/src/IdParser.Core/Parsers/Id/NameParser.cs
@@ -2,6 +2,9 @@
 
 internal record NameParts(string? First, string? Middle, string? Last, string? Suffix);
 
+/// <summary>
+/// Name parser for legacy AAMVA 2000 spec. The field code doesn't appear in the 2020 spec.
+/// </summary>
 internal static class NameParser
 {
     private static readonly char[] StandardSeparators = { ',', '$', '@' };
diff --git a/src/IdParser.Core/Parsers/Parser.cs b/src/IdParser.Core/Parsers/Parser.cs
@@ -149,6 +149,7 @@ internal static ParseAndSetElementResult ParseAndSetIdCardElement(string element
                 break;
 
             case SubfileElementIds.Name:
+                // Name parser for legacy 2000 spec. The field code doesn't appear in the 2020 spec.
                 // NOTE: this parser doesn't report errors
                 var nameParts = NameParser.Parse(elementId: elementId, rawValue: rawValue);
                 idCard.FirstName = FieldHelpers.ParsedField(elementId: elementId, value: nameParts?.First, rawValue: rawValue);

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"sdk": {`
`3`		`- "version": "8.0.200",`
	`3`	`+ "version": "9.0.100",`
`4`	`4`	`"rollForward": "latestPatch"`
`5`	`5`	`}`
`6`	`6`	`}`