Merge pull request #77 from pjoiner/v0.8.0

V0.8.0

.github/workflows/dotnet.yml

@@ -20,7 +20,7 @@ jobs:
     - name: Setup .NET
       uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: 7.0.x
+        dotnet-version: 8.0.x
     - name: Restore dependencies
       run: dotnet restore
     - name: Build

Benchmarks/Benchmarks.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFrameworks>net48;net5.0;net6.0;net7.0</TargetFrameworks>
+    <TargetFrameworks>net48;net6.0;net7.0;net8.0</TargetFrameworks>
     <Configurations>Debug;Release;LocalRelease</Configurations>
   </PropertyGroup>
 
@@ -67,7 +67,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="BenchmarkDotNet" Version="0.13.2" />
+    <PackageReference Include="BenchmarkDotNet" Version="0.13.9" />
     <PackageReference Condition="'$(LOCALBUILD)' == ''" Include="DwC-A_dotnet" Version="0.5.2" />
   </ItemGroup>
 

Benchmarks/Config.cs

@@ -10,23 +10,32 @@ public Config()
         {
             var baseJob = Job.ShortRun;
 #if LOCALBUILD
-            var package_0_7_0 = baseJob.WithId("0.7.0");
-            AddJob(package_0_7_0.WithRuntime(ClrRuntime.Net48));
-            AddJob(package_0_7_0.WithRuntime(CoreRuntime.Core50));
-            AddJob(package_0_7_0.WithRuntime(CoreRuntime.Core60));
-            AddJob(package_0_7_0.WithRuntime(CoreRuntime.Core70));
+            var package_0_8_0 = baseJob.WithId("0.8.0");
+            AddJob(package_0_8_0.WithRuntime(ClrRuntime.Net48));
+            AddJob(package_0_8_0.WithRuntime(CoreRuntime.Core50));
+            AddJob(package_0_8_0.WithRuntime(CoreRuntime.Core60));
+            AddJob(package_0_8_0.WithRuntime(CoreRuntime.Core70));
+            AddJob(package_0_8_0.WithRuntime(CoreRuntime.Core80));
 #else
             var package_0_5_2 = baseJob.WithNuGet("DwC-A_dotnet", "0.5.2").WithId("0.5.2");
             var package_0_6_2 = baseJob.WithNuGet("DwC-A_dotnet", "0.6.2").WithId("0.6.2");
+            var package_0_7_0 = baseJob.WithNuGet("DwC-A_dotnet", "0.7.0").WithId("0.7.0");
 
             AddJob(package_0_5_2.WithRuntime(ClrRuntime.Net48));
             AddJob(package_0_5_2.WithRuntime(CoreRuntime.Core50));
             AddJob(package_0_5_2.WithRuntime(CoreRuntime.Core60));
             AddJob(package_0_5_2.WithRuntime(CoreRuntime.Core70));
+            AddJob(package_0_5_2.WithRuntime(CoreRuntime.Core80));
             AddJob(package_0_6_2.WithRuntime(ClrRuntime.Net48));
             AddJob(package_0_6_2.WithRuntime(CoreRuntime.Core50));
             AddJob(package_0_6_2.WithRuntime(CoreRuntime.Core60));
             AddJob(package_0_6_2.WithRuntime(CoreRuntime.Core70));
+            AddJob(package_0_6_2.WithRuntime(CoreRuntime.Core80));
+            AddJob(package_0_7_0.WithRuntime(ClrRuntime.Net48));
+            AddJob(package_0_7_0.WithRuntime(CoreRuntime.Core50));
+            AddJob(package_0_7_0.WithRuntime(CoreRuntime.Core60));
+            AddJob(package_0_7_0.WithRuntime(CoreRuntime.Core70));
+            AddJob(package_0_7_0.WithRuntime(CoreRuntime.Core80));
 #endif
         }
     }

Benchmarks/readme.md

@@ -3,10 +3,10 @@
 To run benchmarks for the current release from the command line and save logs/results use the following command line.
 
 ```
-dotnet run -c LocalRelease --framework net48 net50 net60 net70
+dotnet run -c LocalRelease --framework net48 net50 net60 net70 net80
 ```
 To run benchmarks for the previous releases use the following command line.
 
 ```
-dotnet run -c Release --framework net48 net50 net60 net70
+dotnet run -c Release --framework net48 net50 net60 net70 net80
 ```

src/DWC_A/ArchiveWriter.cs

@@ -1,5 +1,4 @@
 using DwC_A.Builders;
-using DwC_A.Meta;
 using System.Collections.Generic;
 using System.IO;
 using System.IO.Compression;

src/DWC_A/AsyncEnumerable/FileReader.cs

@@ -2,6 +2,7 @@
 using System.IO;
 using System.Runtime.CompilerServices;
 using System.Threading;
+using System.Threading.Tasks;
 
 namespace DwC_A
 {
@@ -13,7 +14,7 @@ public async IAsyncEnumerable<IRow> GetRowsAsync([EnumeratorCancellation] Cancel
             using (var stream = new FileStream(FileName,
                 FileMode.Open, FileAccess.Read, FileShare.Read, config.BufferSize, true))
             {
-                await foreach (var row in streamReader.ReadRowsAsync(stream, ct))
+                await foreach (var row in streamReader.ReadRowsAsync(stream, ct).ConfigureAwait(false))
                 {
                     yield return row;
                 }
@@ -23,7 +24,7 @@ public async IAsyncEnumerable<IRow> GetRowsAsync([EnumeratorCancellation] Cancel
         public async IAsyncEnumerable<IRow> GetHeaderRowsAsync([EnumeratorCancellation] CancellationToken ct = default)
         {
             int count = 0;
-            await foreach (var row in GetRowsAsync(ct))
+            await foreach (var row in GetRowsAsync(ct).ConfigureAwait(false))
             {
                 if (count < FileMetaData.HeaderRowCount)
                 {
@@ -40,7 +41,7 @@ public async IAsyncEnumerable<IRow> GetHeaderRowsAsync([EnumeratorCancellation]
         public async IAsyncEnumerable<IRow> GetDataRowsAsync([EnumeratorCancellation] CancellationToken ct = default)
         {
             int count = 0;
-            await foreach (var row in GetRowsAsync(ct))
+            await foreach (var row in GetRowsAsync(ct).ConfigureAwait(false))
             {
                 if (count >= FileMetaData.HeaderRowCount)
                 {

src/DWC_A/AsyncEnumerable/StreamReader.cs

@@ -15,7 +15,7 @@ public async IAsyncEnumerable<IRow> ReadRowsAsync(Stream stream,
             using (var reader = new System.IO.StreamReader(stream, fileMetaData.Encoding))
             {
                 string line;
-                while ((line = await reader.ReadRowAsync(fileMetaData)) != null)
+                while ((line = await reader.ReadRowAsync(fileMetaData).ConfigureAwait(false)) != null)
                 {
                     ct.ThrowIfCancellationRequested();
                     yield return rowFactory.CreateRow(tokenizer.Split(line), fileMetaData.Fields);

src/DWC_A/Meta/ArchiveMetaDataBuilder.cs → src/DWC_A/Builders/ArchiveMetaDataBuilder.cs

@@ -1,8 +1,8 @@
-using DwC_A.Builders;
+using DwC_A.Meta;
 using System.IO;
 using System.Xml.Serialization;
 
-namespace DwC_A.Meta
+namespace DwC_A.Builders
 {
     public class ArchiveMetaDataBuilder
     {
@@ -48,7 +48,7 @@ public Archive Build()
         public string Serialize()
         {
             var path = GetPath();
-            var metaDataFileName = System.IO.Path.Combine(path, fileName);
+            var metaDataFileName = Path.Combine(path, fileName);
             var overrides = GetXmlAttributeOverrides();
             XmlSerializer serializer = new XmlSerializer(typeof(Archive), overrides);
             using (Stream stream = new FileStream(metaDataFileName, FileMode.Create))
@@ -60,7 +60,7 @@ public string Serialize()
 
         private string GetPath()
         {
-            if(context == null)
+            if (context == null)
             {
                 return BuilderContext.Default.Path;
             }
@@ -80,14 +80,14 @@ private XmlAttributeOverrides GetXmlAttributeOverrides()
                 "dateFormat"
             };
             var overrides = new XmlAttributeOverrides();
-            foreach(var attributeName in attributeNames)
+            foreach (var attributeName in attributeNames)
             {
                 var attribute = new XmlAttributes()
                 {
                     XmlDefaultValue = null,
                     XmlAttribute = new XmlAttributeAttribute()
-                    { 
-                        AttributeName = attributeName                        
+                    {
+                        AttributeName = attributeName
                     }
                 };
                 var memberName = Capitalize(attributeName);

src/DWC_A/Meta/CoreFileMetaDataBuilder.cs → src/DWC_A/Builders/CoreFileMetaDataBuilder.cs

@@ -1,6 +1,7 @@
 using System.Text;
+using DwC_A.Meta;
 
-namespace DwC_A.Meta
+namespace DwC_A.Builders
 {
     public class CoreFileMetaDataBuilder
     {
@@ -83,7 +84,7 @@ public CoreFileMetaDataBuilder AddField(FieldMetaDataBuilder field)
 
         public CoreFileMetaDataBuilder AddFields(FieldsMetaDataBuilder fields)
         {
-            foreach(var field in fields.Build()) 
+            foreach (var field in fields.Build())
             {
                 AddField(field);
             }

src/DWC_A/Meta/ExtensionFileMetaDataBuilder.cs → src/DWC_A/Builders/ExtensionFileMetaDataBuilder.cs

@@ -1,6 +1,7 @@
 using System.Text;
+using DwC_A.Meta;
 
-namespace DwC_A.Meta
+namespace DwC_A.Builders
 {
     public class ExtensionFileMetaDataBuilder
     {

src/DWC_A/Meta/FieldMetaDataBuilder.cs → src/DWC_A/Builders/FieldMetaDataBuilder.cs

@@ -1,4 +1,6 @@
-namespace DwC_A.Meta
+using DwC_A.Meta;
+
+namespace DwC_A.Builders
 {
     /// <summary>
     /// Builds field metadata definitions

src/DWC_A/Meta/FieldsMetaDataBuilder.cs → src/DWC_A/Builders/FieldsMetaDataBuilder.cs

@@ -1,8 +1,9 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using DwC_A.Meta;
 
-namespace DwC_A.Meta
+namespace DwC_A.Builders
 {
     /// <summary>
     /// Creates a collection of field metadata
@@ -41,10 +42,10 @@ public FieldsMetaDataBuilder AutomaticallyIndex()
         /// </summary>
         /// <param name="fieldMetaData">This method will create a FieldMetaDataBuilder and pass it to a lamba defined to fill in the field metadat</param>
         /// <returns>this</returns>
-        public FieldsMetaDataBuilder AddField( Func<FieldMetaDataBuilder, FieldMetaDataBuilder> fieldMetaData )
+        public FieldsMetaDataBuilder AddField(Func<FieldMetaDataBuilder, FieldMetaDataBuilder> fieldMetaData)
         {
             var fieldMetaDataBuilder = FieldMetaDataBuilder.Field();
-            if(automaticallyIndex)
+            if (automaticallyIndex)
             {
                 fieldMetaDataBuilder.Index(index++);
             }

src/DWC_A/DwC-A_dotnet.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net7.0;net6.0;netstandard2.1;netstandard2.0</TargetFrameworks>
+    <TargetFrameworks>net8.0;net7.0;net6.0;netstandard2.1;netstandard2.0</TargetFrameworks>
     <RootNamespace>DwC_A</RootNamespace>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <Configurations>Debug;Release;LocalRelease</Configurations>
@@ -12,12 +12,12 @@
     <RepositoryUrl>https://github.com/pjoiner/DwC-A_dotnet</RepositoryUrl>
     <Authors>Paul Joiner</Authors>
     <Company />
-    <Copyright>Copyright © Paul Joiner 2022</Copyright>
+    <Copyright>Copyright © Paul Joiner 2023</Copyright>
     <license>https://github.com/pjoiner/DwC-A_dotnet/blob/master/LICENSE</license>
     <RepositoryType>git</RepositoryType>
     <Description>A simple Darwin Core Archive Reader for dotnet</Description>
     <PackageTags>DwC-A darwin-core Biodiversity</PackageTags>
-    <Version>0.7.0</Version>
+    <Version>0.8.0</Version>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
     <DebugType>full</DebugType>
@@ -26,10 +26,12 @@
   <PropertyGroup>
     <DocumentationFile>DwC-A_dotnet.xml</DocumentationFile>
     <NoWarn>1701;1702;1591</NoWarn>
-    <AssemblyVersion>0.7.0.0</AssemblyVersion>
-    <FileVersion>0.7.0.0</FileVersion>
+    <AssemblyVersion>0.8.0.0</AssemblyVersion>
+    <FileVersion>0.8.0.0</FileVersion>
     <PackageReadmeFile>Readme.md</PackageReadmeFile>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
+    <IncludeSymbols>True</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
   </PropertyGroup>
   <ItemGroup>
     <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute" Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
@@ -47,7 +49,11 @@
     </None>
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="System.Linq.Async" Version="5.0.0" Condition="'$(TargetFramework)' != 'netstandard2.0'" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="System.Linq.Async" Version="6.0.1" Condition="'$(TargetFramework)' != 'netstandard2.0'" />
   </ItemGroup>
 
 </Project>

src/DWC_A/Exceptions/FileReaderNotFoundException.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Runtime.Serialization;
 
 namespace DwC_A.Exceptions
 {
@@ -14,19 +13,14 @@ public FileReaderNotFoundException()
         {
         }
 
-        public FileReaderNotFoundException(string fileName) : 
+        public FileReaderNotFoundException(string fileName) :
             base(BuildMessage(fileName))
         {
         }
 
-        public FileReaderNotFoundException(string fileName, Exception innerException) : 
+        public FileReaderNotFoundException(string fileName, Exception innerException) :
             base(BuildMessage(fileName), innerException)
         {
         }
-
-        protected FileReaderNotFoundException(SerializationInfo info, StreamingContext context) : 
-            base(info, context)
-        {
-        }
     }
 }

src/DWC_A/Exceptions/InvalidArchiveException.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Runtime.Serialization;
 
 namespace DwC_A.Exceptions
 {
@@ -14,19 +13,14 @@ public InvalidArchiveException()
         {
         }
 
-        public InvalidArchiveException(string path) : 
+        public InvalidArchiveException(string path) :
             base(BuildMessage(path))
         {
         }
 
-        public InvalidArchiveException(string path, Exception innerException) : 
+        public InvalidArchiveException(string path, Exception innerException) :
             base(BuildMessage(path), innerException)
         {
         }
-
-        protected InvalidArchiveException(SerializationInfo info, StreamingContext context) : 
-            base(info, context)
-        {
-        }
     }
 }

src/DWC_A/Exceptions/TermNotFoundException.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Runtime.Serialization;
 
 namespace DwC_A.Exceptions
 {
@@ -15,13 +14,9 @@ public TermNotFoundException(string term) :
         {
         }
 
-        public TermNotFoundException(string term, Exception innerException) : 
+        public TermNotFoundException(string term, Exception innerException) :
             base(BuildMessage(term), innerException)
         {
         }
-
-        protected TermNotFoundException(SerializationInfo info, StreamingContext context) : base(info, context)
-        {
-        }
     }
 }

src/DWC_A/Extensions/StreamReaderExtensions.cs

@@ -30,9 +30,9 @@ public static string ReadRow(this System.IO.StreamReader reader, IFileMetaData f
             char terminatorStart = fileMetaData.LinesTerminatedBy.FirstOrDefault();
             bool inQuotes = false;
             char[] c = new char[1];
-            while(reader.Peek() != -1)
+            while (reader.Peek() != -1)
             {
-                reader.Read(c,0,1);
+                reader.Read(c, 0, 1);
                 if (!inQuotes && c[0] == terminatorStart)
                 {
                     for (int i = 1; i < fileMetaData.LineTerminatorLength; i++)
@@ -61,20 +61,20 @@ public async static Task<string> ReadRowAsync(this System.IO.StreamReader reader
             char Quotes = fileMetaData.FieldsEnclosedBy.FirstOrDefault();
             if (Quotes == '\0')
             {
-                line.Append(await reader.ReadLineAsync());
+                line.Append(await reader.ReadLineAsync().ConfigureAwait(false));
                 return line.Flush();
             }
             char terminatorStart = fileMetaData.LinesTerminatedBy.FirstOrDefault();
             bool inQuotes = false;
             char[] c = new char[1];
             while (reader.Peek() != -1)
             {
-                await reader.ReadAsync(c, 0, 1);
+                await reader.ReadAsync(c, 0, 1).ConfigureAwait(false);
                 if (!inQuotes && c[0] == terminatorStart)
                 {
                     for (int i = 1; i < fileMetaData.LineTerminatorLength; i++)
                     {
-                        await reader.ReadAsync(c, 0, 1);
+                        await reader.ReadAsync(c, 0, 1).ConfigureAwait(false);
                     }
                     return line.Flush();
                 }