Merge remote-tracking branch 'origin/master' into do_not_throw_general_exceptions_from_generated_data_types

Author: PhantomGrazzler

CHANGELOG.md

@@ -4,29 +4,71 @@ All notable changes to this project will be documented in this file.
 
 ## Upcoming Release
 
-## [3.X.X.X] - TBC
+## [3.X.X] - TBC
 
 ## Previous Releases
 
+## [3.2.2] - 2023-01-24
+
+This release is purely superficial, it does not fix or add anything.
+
+- Add appropriate [target framework](https://learn.microsoft.com/en-us/nuget/reference/target-frameworks) metadata to the metapackage nuspec - already exists in the individual nuget packages.
+
+See [3.2.0](#320---2023-01-20) release for latest changes.
+
+By @milkshakeuk
+
+## [3.2.0] - 2023-01-20
+
+Various new `ParserOptions` have been added, see the [wiki](https://github.com/nHapiNET/nHapi/wiki/Parser-Options) for more information.
+
+### Things of note
+
+As part of [#398](https://github.com/nHapiNET/nHapi/pull/398) the imperfect behaviour of `XmlParser` and `DefaultXmlParser` have been updated and brought inline with `hapi` fixing many quirks and defects. If you are dependant on this old behaviour you can use `LegacyXmlParser` and `LegacyDefaultXmlParser` instead, these will be available until the next major version of `nHapi`.
+
+The [nHapi](https://www.nuget.org/packages/nhapi) convenience nuget package is now a meta package meaning it does not directly contain any Dlls. This metapackage just describes its dependencies, which happen to be all of the individual nHapi nuget packages. If you want to understand a little bit more about metapackages [read this](https://andrewlock.net/what-is-the-microsoft-aspnetcore-metapackage/).
+
+There is no difference in behaviour when using this metapackage vs the previous nHapi nuget package.
+
+### Bug Fixes
+
+- [#318](https://github.com/nHapiNET/nHapi/pull/318) Port `ORL_O34` fix for cyclic reference, fixes for `V2.5.1`, `2.5`, `2.6`. By @milkshakeuk (fixes [#298](https://github.com/nHapiNET/nHapi/issues/298))
+- [#340](https://github.com/nHapiNET/nHapi/pull/340) Fix `Terser` Regex bug. By @milkshakeuk (fixes [#319](https://github.com/nHapiNET/nHapi/issues/319))
+- [#402](https://github.com/nHapiNET/nHapi/pull/402) Fix `OBX` repeat counts for V24. By @milkshakeuk (fixes [#341](https://github.com/nHapiNET/nHapi/issues/341))
+
+### Enhancements
+
+- [#283](https://github.com/nHapiNET/nHapi/pull/283) Enable refactor of Source Generation code. By @milkshakeuk
+- [#291](https://github.com/nHapiNET/nHapi/pull/291) Fix some static analysis issues. By @PhantomGrazzler
+- [#308](https://github.com/nHapiNET/nHapi/pull/308) Include the optional `LongName` attribute in the XML encoded output. By @laxmi-lal-menaria (resolves [#301](https://github.com/nHapiNET/nHapi/issues/301))
+- [#360](https://github.com/nHapiNET/nHapi/pull/360) Add Support for `CharSetUtil` and `PreParser`. By @milkshakeuk (resolves [#312](https://github.com/nHapiNET/nHapi/issues/312))
+- [#362](https://github.com/nHapiNET/nHapi/pull/362) Fixed some static analysis warnings related to public constants. By @PhantomGrazzler
+- [#398](https://github.com/nHapiNET/nHapi/pull/398) Bring XmlParsing in line with `hapi`. By @milkshakeuk (unblocks [#308](https://github.com/nHapiNET/nHapi/pull/308))
+- [#278](https://github.com/nHapiNET/nHapi/issues/278) Better Source Link Support. By @milkshakeuk
+
+### Other
+
+- [#288](https://github.com/nHapiNET/nHapi/pull/288) Update Github Actions to use OS matrix. By @milkshakeuk
+
 ## [3.1.1] - 2022-02-19
 
 ### Enhancements
 
-- [#277](https://github.com/nHapiNET/nHapi/pull/277) Remove MaxRepetition check, keeps nhapi in line with hapi behaviour, nhapi becomes more forgiving in regards to repetitions. (fixes [#276](https://github.com/nHapiNET/nHapi/issues/276))
+- [#277](https://github.com/nHapiNET/nHapi/pull/277) Remove MaxRepetition check, keeps nhapi in line with hapi behaviour, nhapi becomes more forgiving in regards to repetitions. By @milkshakeuk (fixes [#276](https://github.com/nHapiNET/nHapi/issues/276))
 
 ## [3.1.0] - 2022-01-01
 
 ### Enhancements
 
-- [#254](https://github.com/nHapiNET/nHapi/pull/254) Add `UnexpectedSegmentBehaviour` Options, ported from hapi
-- [#251](https://github.com/nHapiNET/nHapi/pull/251) Fix concurrency issues with `PipeParser`, `StructureDefinition`, `GenericMessage` and `Escape`.
-- [#250](https://github.com/nHapiNET/nHapi/pull/250) Add new options `DefaultObx2Type` and `InvalidObx2Type` to `ParserOptions`, ported from nhapi. (fixes [#63](https://github.com/nHapiNET/nHapi/issues/63))
-- [#240](https://github.com/nHapiNET/nHapi/pull/240) Add support for `NonGreedyMode` by introducing `ParserOptions` ported from hapi. by @PhantomGrazzler (fixes [#65](https://github.com/nHapiNET/nHapi/issues/65) [#232](https://github.com/nHapiNET/nHapi/issues/232))
+- [#254](https://github.com/nHapiNET/nHapi/pull/254) Add `UnexpectedSegmentBehaviour` Options, ported from hapi. By @milkshakeuk
+- [#251](https://github.com/nHapiNET/nHapi/pull/251) Fix concurrency issues with `PipeParser`, `StructureDefinition`, `GenericMessage` and `Escape`. By @milkshakeuk
+- [#250](https://github.com/nHapiNET/nHapi/pull/250) Add new options `DefaultObx2Type` and `InvalidObx2Type` to `ParserOptions`, ported from nhapi. By @milkshakeuk (fixes [#63](https://github.com/nHapiNET/nHapi/issues/63))
+- [#240](https://github.com/nHapiNET/nHapi/pull/240) Add support for `NonGreedyMode` by introducing `ParserOptions` ported from hapi. By @PhantomGrazzler (fixes [#65](https://github.com/nHapiNET/nHapi/issues/65) [#232](https://github.com/nHapiNET/nHapi/issues/232))
 
 ### Other
 
-- [#256](https://github.com/nHapiNET/nHapi/pull/256) Simplify cspoj through use of props and targets files.
-- Update tools and build to net6.0
+- [#256](https://github.com/nHapiNET/nHapi/pull/256) Simplify cspoj through use of props and targets files. By @milkshakeuk
+- Update tools and build to net6.0. By @milkshakeuk
 
 ## [3.0.4] - 2021-08-11
 
@@ -38,10 +80,14 @@ In cases where dictionaries / hashtables are used for lookups such as `Escape.cs
 
 Instead of using `Add(key, value)` which only allows 1 items with a given key to be added to the dictionary / hashtable, we are using the index accessor to set or update the value in a last one wins scenario, but only when its combined with `ContainsKey` which has indicated that an item with that key shouldn't exist.
 
+By @milkshakeuk
+
 ## [3.0.3] - 2021-08-10
 
 This change updates the `PipeParser` Version check when obtaining encoding characters from a message object in order to encode it to HL7; `string.CompareOrdinal` is now used instead of `System.Version` which is more forgiving when a version contains non numerical characters.
 
+By @milkshakeuk
+
 ## [3.0.2] - 2021-08-09
 
 This change gives nhapi [strong-named assemblies](https://docs.microsoft.com/en-us/dotnet/standard/assembly/strong-named), there are no codes changes.
@@ -50,6 +96,8 @@ This change gives nhapi [strong-named assemblies](https://docs.microsoft.com/en-
 
 - [#227](https://github.com/nHapiNET/nHapi/issues/227) fixes "A strongly-named assembly is required" runtime errors
 
+By @milkshakeuk
+
 ## [nhapi.model.v231 3.0.1] - 2021-07-02
 
 This release is for the NuGet package `nhapi.model.v231` only, there are no code changes, see below for change.

README.md

@@ -48,12 +48,9 @@ For more options please read the [Getting Started](https://github.com/nHapiNET/n
 
 ## Change Log
 
-### nHapi 3.0.0 Announcement
+### nHapi 3.2.0 Announcement
 
-nHapi 3.0.0 has been officially released, the main change for this release is support for netstandard2.0, but it also has other enhancements and bug fixes.
-Please read the change log below for full details of and how they might affect you prior to upgrading.
-
-[Full Change Log](https://github.com/nHapiNET/nHapi/blob/master/CHANGELOG.md).
+nHapi 3.2.0 has been released - see [Full Change Log](https://github.com/nHapiNET/nHapi/blob/master/CHANGELOG.md) for details.
 
 ## Related Projects
 

build/.nuget/NuGet.exe

@@ -10,14 +10,14 @@ properties {
         "NHapi.Model.V21",
         "NHapi.Model.V22",
         "NHapi.Model.V23",
+        "NHapi.Model.V231",
         "NHapi.Model.V24",
         "NHapi.Model.V25",
+        "NHapi.Model.V251",
         "NHapi.Model.V26",
         "NHapi.Model.V27",
-        "NHapi.Model.V28",
-        "NHapi.Model.V231",
-        "NHapi.Model.V251",
         "NHapi.Model.V271",
+        "NHapi.Model.V28",
         "NHapi.Model.V281"
     )
     $apiKey = "YOUR_API_KEY"
@@ -27,8 +27,9 @@ Task Default -depends Build
 
 Task Clean {
     Remove-Item ..\dist\*.nupkg -ErrorAction Ignore
-    Remove-Item ..\dist\net35\*.* -ErrorAction Ignore
-    Remove-Item ..\dist\netstandard2.0\*.* -ErrorAction Ignore
+    Remove-Item ..\dist\*.snupkg -ErrorAction Ignore
+    Remove-Item ..\dist\net35 -Recurse -ErrorAction Ignore
+    Remove-Item ..\dist\netstandard2.0 -Recurse -ErrorAction Ignore
 
     Get-ChildItem -path ..\ -inc bin -rec | Remove-Item -rec -force
     Get-ChildItem -path ..\ -inc obj -rec | Remove-Item -rec -force
@@ -72,33 +73,35 @@ task Test {
 
 Task Package -depends Build {
 
-    Remove-Item ..\dist\net35\*.* -ErrorAction Ignore
-    Remove-Item ..\dist\netstandard2.0\*.* -ErrorAction Ignore
-
-    New-Item -ItemType directory -Force -Path ..\dist\net35
-    New-Item -ItemType directory -Force -Path ..\dist\netstandard2.0
+    Remove-Item ..\dist\net35 -Recurse -ErrorAction Ignore
+    Remove-Item ..\dist\netstandard2.0 -Recurse -ErrorAction Ignore
+    Remove-Item ..\dist\*.nupkg -ErrorAction Ignore
+    Remove-Item ..\dist\*.snupkg -ErrorAction Ignore
 
     foreach($project in $projects) {
-        Copy-Item "..\src\$project\bin\$projectConfig\net35\*.dll" ..\dist\net35
-        Copy-Item "..\src\$project\bin\$projectConfig\net35\*.xml" ..\dist\net35
-
-        Copy-Item "..\src\$project\bin\$projectConfig\netstandard2.0\*.dll" ..\dist\netstandard2.0
-        Copy-Item "..\src\$project\bin\$projectConfig\netstandard2.0\*.xml" ..\dist\netstandard2.0
+        Exec { dotnet pack "..\src\$project\$project.csproj" -c $projectConfig --no-build --no-restore -o "..\dist" }
     }
 
-	Exec { .nuget\nuget pack .\nHapi.v3.nuspec -OutputDirectory ..\dist }
+    $commit = (git rev-parse --verify HEAD)
+    $nuspec = ".\nHapi.v3.nuspec"
 
-    foreach($project in $projects) {
-        Exec { dotnet pack "..\src\$project\$project.csproj" -c $projectConfig --no-build --no-restore -o "..\dist" }
-    }
+    (Get-Content $nuspec).Replace('commit=""', 'commit="' + $commit + '"') | Set-Content $nuspec
+
+    New-Item -ItemType directory -Force -Path ..\dist\net35
+    New-Item -ItemType directory -Force -Path ..\dist\netstandard2.0
+    New-Item -ItemType file -Path ..\dist\net35 -Name _._
+    New-Item -ItemType file -Path ..\dist\netstandard2.0 -Name _._
+
+    Exec { .nuget\nuget pack $nuspec -OutputDirectory ..\dist }
+
+    (Get-Content $nuspec).Replace('commit="' + $commit + '"', 'commit=""') | Set-Content $nuspec
 }
 
 Task Deploy -depends Package {
 
     foreach($project in $projects) {
-        Exec { dotnet nuget push "..\dist\$project.*.nupkg" --api-key $apiKey }
+        Exec { dotnet nuget push "..\dist\$project.*.nupkg" -k $apiKey -sk $apiKey -s "https://api.nuget.org/v3/index.json" }
     }
 
-    Exec { dotnet nuget push "..\dist\nhapi.3.1.0.nupkg" --api-key $apiKey }
-	# Exec { .nuget\nuget push *.nupkg -Source https://api.nuget.org/v3/index.json }
+    Exec { dotnet nuget push "..\dist\nhapi.3.*.nupkg" -k $apiKey -sk $apiKey -s "https://api.nuget.org/v3/index.json" }
 }

build/default.ps1

@@ -1,34 +1,59 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
     <metadata>
         <id>nhapi</id>
-        <version>3.1.1</version>
+        <version>3.2.2</version>
         <authors>Chad Chenoweth,Duane Edwards,Jake Aitchison</authors>
         <license type="expression">MPL-2.0</license>
         <projectUrl>https://github.com/nHapiNET/nHapi</projectUrl>
-        <repository type="git" url="https://github.com/nHapiNET/nHapi.git" />
         <requireLicenseAcceptance>false</requireLicenseAcceptance>
         <description>NHapi is a port of the original project HAPI.
 
 NHapi allows Microsoft .NET developers to easily use an HL7 2.x object model. This object model allows for parsing and encoding HL7 2.x data to/from Pipe Delimited or XML formats. A very handy program for use in the health care industry.
 
-This project is NOT affiliated with the HL7 organization. This software just conforms to the HL7 2.x specifications.</description>
-        <releaseNotes>https://github.com/nHapiNET/nHapi/releases/tag/v3.1.1</releaseNotes>
-        <tags>HL7 parsing healthcare HAPI xml</tags>
+This project is NOT affiliated with the HL7 organization. This software just conforms to the HL7 2.x specifications.
+
+This nuget package is just a metapackage for conveniance.</description>
+        <releaseNotes>https://github.com/nHapiNET/nHapi/releases/tag/v3.2.2</releaseNotes>
+        <tags>HL7 ER7 XML parsing healthcare HAPI</tags>
+        <repository type="git" url="https://github.com/nHapiNET/nHapi.git" commit=""/>
         <readme>docs\README.md</readme>
         <dependencies>
+            <group targetFramework=".NETFramework3.5">
+                <dependency id="nhapi.base" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v21" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v22" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v23" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v24" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v25" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v26" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v27" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v28" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v231" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v251" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v271" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v281" version="3.2.0" exclude="Build,Analyzers" />
+            </group>
             <group targetFramework=".NETStandard2.0">
-                <dependency id="System.Configuration.ConfigurationManager" version="5.0.0" />
+                <dependency id="nhapi.base" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v21" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v22" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v23" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v24" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v25" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v26" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v27" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v28" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v231" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v251" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v271" version="3.2.0" exclude="Build,Analyzers" />
+                <dependency id="nhapi.model.v281" version="3.2.0" exclude="Build,Analyzers" />
             </group>
-            <group targetFramework=".NETFramework3.5" />
         </dependencies>
-        <frameworkAssemblies>
-            <frameworkAssembly assemblyName="System.Configuration" targetFramework=".NETFramework3.5" />
-        </frameworkAssemblies>
     </metadata>
     <files>
-        <file src="..\dist\netstandard2.0\*.*" target="lib\netstandard2.0" />
-        <file src="..\dist\net35\*.*" target="lib\net35" />
+        <file src="..\dist\netstandard2.0\_._" target="lib\netstandard2.0\" />
+        <file src="..\dist\net35\_._" target="lib\net35\" />
         <file src="..\README.md" target="docs\" />
     </files>
 </package>

build/nHapi.v3.nuspec

@@ -13,6 +13,8 @@
     <AssemblyOriginatorKeyFile>..\..\NHapi.snk</AssemblyOriginatorKeyFile>
     <SignAssembly>true</SignAssembly>
     <PublicKey>0024000004800000940000000602000000240000525341310004000001000100b938fa88814fb99f1d02dfce84c41f38eb1ca31f694b706248e6e21ceed1b1d150416c1375603c7a5dd6d3b2cdec97ccbbdd7a1d6fac61a1ad96ebf88e889ba113913c2f36890ea75108a1d8a23affc0c87357f07dec77c69a519215d0d4043759397b1a8fea1dc881b440ba4232ad4e24d7a8d90bb004549cf4f9dd2d6c13d8</PublicKey>
+    <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
+    <EmbedUntrackedSources>true</EmbedUntrackedSources>
   </PropertyGroup>
 
   <ItemGroup>

src/Directory.Build.props

@@ -6,7 +6,7 @@
     <PackageProjectUrl>https://github.com/nHapiNET/nHapi</PackageProjectUrl>
     <RepositoryUrl>https://github.com/nHapiNET/nHapi.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
-    <PackageTags>HL7;parsing;healthcare;HAPI;xml</PackageTags>
+    <PackageTags>HL7;ER7;XML;parsing;healthcare;HAPI</PackageTags>
     <PackageReleaseNotes>https://github.com/nHapiNET/nHapi/releases/tag/v$(Version)</PackageReleaseNotes>
     <PackageReadmeFile>docs\README.md</PackageReadmeFile>
   </PropertyGroup>
@@ -24,6 +24,8 @@
 
   <PropertyGroup Condition=" '$(IsPackable)' == 'true' And '$(IncludeCommonPackageInfo)' == 'true' And '$(Configuration)' == 'Release' ">
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
   </PropertyGroup>
 
   <!-- Build Time Tools (Includes commit sha in AssemblyInfo etc)-->

src/Directory.Build.targets

@@ -4,7 +4,7 @@
     <TargetFrameworks>net35;netstandard2.0</TargetFrameworks>
     <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
     <PackageId>nhapi.base</PackageId>
-    <Version>3.1.1</Version>
+    <Version>3.2.0</Version>
     <PackageDescription>The core components for parsing/encoding HL7 messages. Contains the base classes and interfaces for datatypes, segments, and messages.</PackageDescription>
     <Description>NHapi Common Library</Description>
     <NoWarn>1591</NoWarn>

src/NHapi.Base/NHapi.Base.csproj

@@ -131,7 +131,7 @@ public ParserOptions()
         public bool NonGreedyMode { get; set; }
 
         /// <summary>
-        /// Gets or Sets flag which allows the Description attribute [LongName] to be added in encoded xml with counter position.
+        /// Gets or Sets flag which allows the Description attribute 'LongName' to be added in encoded xml with counter position.
         /// </summary>
         /// <example>
         /// <code>

src/NHapi.Base/Parser/ParserOptions.cs

@@ -4,7 +4,7 @@
     <TargetFrameworks>net35;netstandard2.0</TargetFrameworks>
     <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
     <PackageId>nhapi.model.v21</PackageId>
-    <Version>3.1.0</Version>
+    <Version>3.2.0</Version>
     <PackageDescription>Contains the data types, segments, and messages that follow the HL7 2.1 schema.</PackageDescription>
     <Description>NHapi Model V.2.1</Description>
     <IncludeCommonPackageInfo>true</IncludeCommonPackageInfo>

src/NHapi.Model.V21/NHapi.Model.V21.csproj

@@ -4,7 +4,7 @@
     <TargetFrameworks>net35;netstandard2.0</TargetFrameworks>
     <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
     <PackageId>nhapi.model.v22</PackageId>
-    <Version>3.1.0</Version>
+    <Version>3.2.0</Version>
     <PackageDescription>Contains the data types, segments, and messages that follow the HL7 2.2 schema.</PackageDescription>
     <Description>NHapi Model V.2.2</Description>
     <IncludeCommonPackageInfo>true</IncludeCommonPackageInfo>