Add Test project from NetTopologySuite.IO.ShapeFile repository

NetTopologySuite.IO.Esri.sln

@@ -13,7 +13,13 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetTopologySuite.IO.Esri.Shapefile", "src\NetTopologySuite.IO.Esri.Shapefile\NetTopologySuite.IO.Esri.Shapefile.csproj", "{6E95BC91-8066-4420-B61F-854DE5F3A746}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NetTopologySuite.IO.Esri.TestConsole", "test\NetTopologySuite.IO.Esri.TestConsole\NetTopologySuite.IO.Esri.TestConsole.csproj", "{AA37EFC6-737F-4E8A-A79C-2D179C1B38EC}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetTopologySuite.IO.Esri.TestConsole", "test\NetTopologySuite.IO.Esri.TestConsole\NetTopologySuite.IO.Esri.TestConsole.csproj", "{AA37EFC6-737F-4E8A-A79C-2D179C1B38EC}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Test", "Test", "{800A3D3F-D350-4AAF-89F2-CBA8C0D54862}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Src", "Src", "{FDC792AB-D6EB-4963-A3F5-1D7A11AA47FC}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetTopologySuite.IO.Esri.Test", "test\NetTopologySuite.IO.Esri.Test\NetTopologySuite.IO.Esri.Test.csproj", "{64B2B87A-EFA0-4BEA-B5D8-7EA989630D68}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -29,10 +35,19 @@ Global
 		{AA37EFC6-737F-4E8A-A79C-2D179C1B38EC}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{AA37EFC6-737F-4E8A-A79C-2D179C1B38EC}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{AA37EFC6-737F-4E8A-A79C-2D179C1B38EC}.Release|Any CPU.Build.0 = Release|Any CPU
+		{64B2B87A-EFA0-4BEA-B5D8-7EA989630D68}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{64B2B87A-EFA0-4BEA-B5D8-7EA989630D68}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{64B2B87A-EFA0-4BEA-B5D8-7EA989630D68}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{64B2B87A-EFA0-4BEA-B5D8-7EA989630D68}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
+	GlobalSection(NestedProjects) = preSolution
+		{6E95BC91-8066-4420-B61F-854DE5F3A746} = {FDC792AB-D6EB-4963-A3F5-1D7A11AA47FC}
+		{AA37EFC6-737F-4E8A-A79C-2D179C1B38EC} = {800A3D3F-D350-4AAF-89F2-CBA8C0D54862}
+		{64B2B87A-EFA0-4BEA-B5D8-7EA989630D68} = {800A3D3F-D350-4AAF-89F2-CBA8C0D54862}
+	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {06DEE0C5-480C-4A70-BC80-3791D98E6A89}
 	EndGlobalSection

README.md

@@ -4,23 +4,19 @@ This library provides forward-only readers and writers for [Esri shapefiles](htt
 
 ## DBF
 
-Shapefile feature attributes are held in a dBASE format file (.dbf extension). Each attribute record
+Shapefile feature attributes are held in a [dBASE format file](dBASE.md) (.dbf extension). Each attribute record
 has a one-to-one relationship with the associated shape record. Classes whose name starts
 with `Dbf` (eg. `DbfReader`) provide direct access to dBASE files.
 
 ```c#
-using (var dbf = new DbfReader(dbfPath))
+using var dbf = new DbfReader(dbfPath);
+foreach (var record in dbf)
 {
-    foreach (var fields in dbf)
+    foreach (var fieldName in record.GetNames())
     {
-        Console.WriteLine("Record ID: " + fields["Id"]);
-        var fieldNames = fields.Keys;
-        foreach (var fieldName in fieldNames)
-        {
-            Console.WriteLine($"{fieldName, 10} {fields[fieldName]}");
-        }
-        Console.WriteLine();
+        Console.WriteLine($"{fieldName,10} {record[fieldName]}");
     }
+    Console.WriteLine();
 }
 ```
 
@@ -31,13 +27,9 @@ a shape with a list of its vertices. Classes whose name starts with `Shp` (eg. `
 provide direct access to main file.
 
 ```c#
-using (var shpStream = File.OpenRead(shpPath))
-using (var shp = new ShpPointReader(shpStream, GeometryFactory.Default))
+foreach (var geometry in Shapefile.ReadAllGeometries(shpPath))
 {
-    while (shp.Read())
-    {
-        Console.WriteLine(shp.Geometry);
-    }
+    Console.WriteLine(geometry);
 }
 ```
 
@@ -58,7 +50,6 @@ Under the hood they are decorators wrapping `Dbf` and `Shp` classes.
 ```c#
 foreach (var feature in Shapefile.ReadAllFeatures(shpPath))
 {
-    Console.WriteLine(" Record ID: " + feature.Attributes["Id"]);
     foreach (var attrName in feature.Attributes.GetNames())
     {
         Console.WriteLine($"{attrName,10}: {feature.Attributes[attrName]}");
@@ -74,24 +65,27 @@ foreach (var feature in Shapefile.ReadAllFeatures(shpPath))
 var features = new List<Feature>();
 for (int i = 1; i < 5; i++)
 {
-    var lineCoords = new List<CoordinateZ>();
-    lineCoords.Add(new CoordinateZ(i, i + 1, i));
-    lineCoords.Add(new CoordinateZ(i, i, i));
-    lineCoords.Add(new CoordinateZ(i + 1, i, i));
+    var lineCoords = new List<CoordinateZ>
+    {
+        new CoordinateZ(i, i + 1, i),
+        new CoordinateZ(i, i, i),
+        new CoordinateZ(i + 1, i, i)
+    };
     var line = new LineString(lineCoords.ToArray());
     var mline = new MultiLineString(new LineString[] { line });
 
-    var attributes = new AttributesTable();
-    attributes.Add("date", new DateTime(2000, 1, i + 1));
-    attributes.Add("float", i * 0.1);
-    attributes.Add("int", i);
-    attributes.Add("logical", i % 2 == 0);
-    attributes.Add("text", i.ToString("0.00"));
+    var attributes = new AttributesTable
+    {
+        { "date", new DateTime(2000, 1, i + 1) },
+        { "float", i * 0.1 },
+        { "int", i },
+        { "logical", i % 2 == 0 },
+        { "text", i.ToString("0.00") }
+    };
 
     var feature = new Feature(mline, attributes);
     features.Add(feature);
 }
-
 Shapefile.WriteAllFeatures(features, shpPath);
 ```
 

src/NetTopologySuite.IO.Esri.Shapefile/Dbf/DbfReader.cs

@@ -1,3 +1,4 @@
+using NetTopologySuite.Features;
 using NetTopologySuite.IO.Esri.Dbf.Fields;
 using System;
 using System.Collections;
@@ -15,7 +16,7 @@ namespace NetTopologySuite.IO.Esri.Dbf
     /// <summary>
     ///     Class that allows records in a dbase file to be enumerated.
     /// </summary>
-    public class DbfReader : ManagedDisposable, IEnumerable<IReadOnlyDictionary<string, object>>
+    public class DbfReader : ManagedDisposable, IEnumerable<IAttributesTable>
     {
         private int HeaderSize;
         private int CurrentIndex = 0;
@@ -160,6 +161,10 @@ private Encoding GetEncoding(string dbfPath)
 
             try
             {
+                if (int.TryParse(cpgText, out var cpgId))
+                {
+                    return Encoding.GetEncoding(cpgId);
+                }
                 return Encoding.GetEncoding(cpgText);
             }
             catch (Exception)
@@ -178,6 +183,31 @@ private string ReadFileText(string filePath, string fileExtension)
             return File.ReadAllText(filePath).Trim();
         }
 
+
+
+        /// <summary>
+        /// Reads field values from underlying stream and advances the enumerator to the next record.
+        /// </summary>
+        /// <returns>
+        /// true if the enumerator was successfully advanced to the next record;
+        /// false if the enumerator has passed the end of the table.
+        /// </returns>
+        public bool Read()
+        {
+            var readSucceeded = Read(out var deleted);
+            if (!readSucceeded)
+            {
+                return false;
+            }
+            if (deleted)
+            {
+                return Read();
+            }
+            return true;
+        }
+
+
+
         /// <summary>
         /// Reads field values from underlying stream and advances the enumerator to the next record.
         /// </summary>
@@ -217,22 +247,41 @@ public bool Read(out bool deleted)
         /// true if the enumerator was successfully advanced to the next element;
         /// false if the enumerator has passed the end of the collection.
         /// </returns>
-        public bool Read(out IReadOnlyDictionary<string, object> values, out bool deleted)
+        public bool Read(out IAttributesTable values, out bool deleted)
         {
             if (!Read(out deleted))
             {
-                //values = null; // This would cause recreating array in next iteration
                 values = DbfField.EmptyFieldValues;
                 return false;
             }
 
-            values = Fields.GetValues();
+            values = Fields.ToAttributesTable();
             return true;
         }
 
+        /// <summary>
+        /// Moves enumerator to specified position and reads values from underlying stream.
+        /// </summary>
+        /// <param name="index">Thre record index.</param>
+        /// <returns>
+        /// Table containing record fields (attributes).
+        /// </returns>
+        public IAttributesTable ReadEntry(int index)
+        {
+            if (index < 0 || index >= RecordCount)
+            {
+                throw new ArgumentOutOfRangeException(nameof(index));
+            }
+
+            DbfStream.Position = HeaderSize + (index * RecordSize);
+            CurrentIndex = index;
+            Read(out var _);
+            return Fields.ToAttributesTable();
+        }
+
         #region IEnumerable
 
-        IEnumerator<IReadOnlyDictionary<string, object>> IEnumerable<IReadOnlyDictionary<string, object>>.GetEnumerator()
+        IEnumerator<IAttributesTable> IEnumerable<IAttributesTable>.GetEnumerator()
         {
             return new DbfEnumerator(this);
         }
@@ -242,10 +291,10 @@ IEnumerator IEnumerable.GetEnumerator()
             return new DbfEnumerator(this);
         }
 
-        private class DbfEnumerator : IEnumerator<IReadOnlyDictionary<string, object>>
+        private class DbfEnumerator : IEnumerator<IAttributesTable>
         {
             private readonly DbfReader Owner;
-            public IReadOnlyDictionary<string, object> Current { get; private set; }
+            public IAttributesTable Current { get; private set; }
             object IEnumerator.Current => Current;
 
             public DbfEnumerator(DbfReader owner)

src/NetTopologySuite.IO.Esri.Shapefile/Dbf/DbfStreamExtensions.cs

@@ -119,7 +119,7 @@ public static DbfField ReadDbaseFieldDescriptor(this Stream stream, Encoding enc
             }
             else if (type == DbfType.Numeric)
             {
-                return new DbfNumericField(name, length, precision);
+                return DbfNumericField.Create(name, length, precision);
             }
             else if (type == DbfType.Float)
             {

src/NetTopologySuite.IO.Esri.Shapefile/Dbf/DbfWriter.cs

@@ -1,5 +1,6 @@
 using NetTopologySuite.IO.Esri.Dbf.Fields;
 using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
@@ -15,6 +16,8 @@ namespace NetTopologySuite.IO.Esri.Dbf
     public class DbfWriter : ManagedDisposable
     {
         private Stream DbfStream;
+        private int Id = 1;
+        private DbfField IdField;
 
         /// <summary>
         /// Returns the fields in the dbase file.
@@ -46,8 +49,8 @@ public class DbfWriter : ManagedDisposable
         /// </summary>
         /// <param name="stream">Stream of source DBF file.</param>
         /// <param name="fields">dBASE field definitions.</param>
-        /// <param name="encoding">DBF file encoding or null if encoding should be resolved from DBF reserved bytes.</param>
-        public DbfWriter(Stream stream, IReadOnlyList<DbfField> fields, Encoding encoding)
+        /// <param name="encoding">DBF file encoding. Defaults to UTF8.</param>
+        public DbfWriter(Stream stream, IReadOnlyList<DbfField> fields, Encoding encoding = null)
         {
             Encoding = encoding ?? Encoding.UTF8;
             IntializeFields(fields);
@@ -60,8 +63,8 @@ public DbfWriter(Stream stream, IReadOnlyList<DbfField> fields, Encoding encodin
         /// </summary>
         /// <param name="dbfPath">Path to DBF file.</param>
         /// <param name="fields">dBASE field definitions.</param>
-        /// <param name="encoding">DBF file encoding or null if encoding should be resolved from DBF reserved bytes.</param>
-        public DbfWriter(string dbfPath, IReadOnlyList<DbfField> fields, Encoding encoding)
+        /// <param name="encoding">DBF file encoding. Defaults to UTF8.</param>
+        public DbfWriter(string dbfPath, IReadOnlyList<DbfField> fields, Encoding encoding = null)
         {
             Encoding = encoding ?? Encoding.UTF8;
             IntializeFields(fields);
@@ -80,20 +83,41 @@ public DbfWriter(string dbfPath, IReadOnlyList<DbfField> fields, Encoding encodi
         private void IntializeFields(IReadOnlyList<DbfField> fields)
         {
             if (fields == null || fields.Count < 1)
-                throw new ArgumentException("dBASE file must contain at least one field.", nameof(fields));
+            {
+                // https://desktop.arcgis.com/en/arcmap/latest/manage-data/shapefiles/geoprocessing-considerations-for-shapefile-output.htm
+                // # Attribute limitations
+                // The dBASE file must contain at least one field.
+                // When you create a shapefile or dBASE table, an integer ID field is created as a default.
+                fields = new List<DbfField>() { new DbfNumericInt32Field("Id") };
+            }
 
             if (fields.Count > Dbf.MaxFieldCount)
+            {
                 throw new ArgumentException($"dBASE file must contain no more than {Dbf.MaxFieldCount} fields.", nameof(fields));
+            }
 
             Fields = new DbfFieldCollection(fields.Count);
-            for (int i = 0; i < fields.Count; i++)
+            foreach (var field in fields)
             {
-                if (fields[i] is DbfCharacterField textField)
-                    textField.Encoding = Encoding;
-                Fields.Add(fields[i]);
+                InitializeField(field);
             }
         }
 
+        private void InitializeField(DbfField field)
+        {
+            if (field is DbfCharacterField textField)
+            {
+                textField.Encoding = Encoding;
+            }
+
+            if (field.Name.Equals("Id", StringComparison.OrdinalIgnoreCase))
+            {
+                IdField = field;
+            }
+
+            Fields.Add(field);
+        }
+
         private void WriteHeader(Stream stream)
         {
             DbfStream = stream ?? throw new ArgumentNullException("Uninitialized dBASE stream.", nameof(stream));
@@ -148,6 +172,7 @@ private void WriteCpgEncoding(string dbfPath, Encoding encoding)
         /// </returns>
         public void Write()
         {
+            UpdateIdField();
             DbfStream.WriteByte(Dbf.ValidRecordMark);
 
             for (int i = 0; i < Fields.Count; i++)
@@ -188,6 +213,18 @@ protected override void DisposeManagedResources()
             FinalizeWriting();
             base.DisposeManagedResources(); // FinalizeWriting() is using underlying file streams. Dispose them at the end.
         }
+
+        private void UpdateIdField()
+        {
+            if (IdField == null)
+            {
+                return;
+            }
+            if (IdField.IsNull)
+            {
+                IdField.Value = Id++;
+            }
+        }
     }
 
 

src/NetTopologySuite.IO.Esri.Shapefile/Dbf/Fields/DbfCharacterField.cs

@@ -39,6 +39,9 @@ public override object Value
             set { StringValue = value?.ToString(); }
         }
 
+        /// <inheritdoc/>
+        public override bool IsNull => StringValue == null;
+
         internal override void ReadValue(Stream stream)
         {
             StringValue = stream.ReadString(Length, Encoding)?.TrimEnd();

src/NetTopologySuite.IO.Esri.Shapefile/Dbf/Fields/DbfDateField.cs

@@ -35,6 +35,9 @@ public override object Value
             set { DateValue = (DateTime?)value; }
         }
 
+        /// <inheritdoc/>
+        public override bool IsNull => DateValue == null;
+
 
         internal override void ReadValue(Stream stream)
         {