Merge pull request #130 from nhibernate/npgsql-4

Use Npgsql's PostGIS/NTS plug-in for Geometry type

Author: peetw

NHibernate.Spatial.PostGis/NHibernate.Spatial.PostGis.csproj

@@ -29,7 +29,8 @@
 
   <ItemGroup>
     <PackageReference Include="NetTopologySuite.IO.PostGis" Version="2.1.0" />
-    <PackageReference Include="Npgsql" Version="[3.2.7, 4.0)" />
+    <PackageReference Include="Npgsql" Version="4.1.12" />
+    <PackageReference Include="Npgsql.NetTopologySuite" Version="4.1.12" />
   </ItemGroup>
 
   <ItemGroup>

NHibernate.Spatial.PostGis/Type/PostGisGeometryType.cs

@@ -15,10 +15,9 @@
 // along with NHibernate.Spatial; if not, write to the Free Software
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
-using NetTopologySuite.Geometries;
-using NetTopologySuite.IO;
 using System;
 using System.Data.Common;
+using NetTopologySuite.Geometries;
 using NHibernate.Engine;
 using NHibernate.SqlTypes;
 using NHibernate.Type;
@@ -28,7 +27,7 @@
 namespace NHibernate.Spatial.Type
 {
     [Serializable]
-    public class PostGisGeometryType : GeometryTypeBase<byte[]>
+    public class PostGisGeometryType : GeometryTypeBase<Geometry>
     {
         private static readonly NullableType GeometryType = new CustomGeometryType();
 
@@ -45,45 +44,17 @@ public PostGisGeometryType()
         /// </summary>
         /// <param name="value">The GeoAPI geometry value.</param>
         /// <returns></returns>
-        protected override byte[] FromGeometry(object value)
+        protected override Geometry FromGeometry(object value)
         {
-            Geometry geometry = value as Geometry;
+            var geometry = value as Geometry;
             if (geometry == null)
             {
                 return null;
             }
-            // PostGIS can't parse a WKB of any empty geometry other than GeomtryCollection
-            // (throws the error: "geometry requires more points")
-            // and parses WKT of empty geometries always as GeometryCollection
-            // (ie. "select AsText(GeomFromText('LINESTRING EMPTY', -1)) = 'GEOMETRYCOLLECTION EMPTY'").
-            // Force GeometryCollection.Empty to avoid the error.
-            if (!(geometry is GeometryCollection) && geometry.IsEmpty)
-            {
-                geometry = GeometryCollection.Empty;
-            }
 
             this.SetDefaultSRID(geometry);
 
-            // Determine the ordinality of the geometry to ensure 3D and 4D geometries are
-            // correctly serialized by PostGisWriter (see issue #66)
-            // NOTE: Cannot use InteriorPoint here as that always returns a 2D point (see #120)
-            // TODO: Is there a way of getting the ordinates directly from the geometry?
-            var ordinates = Ordinates.XY;
-            var coordinate = geometry.Coordinate;
-            if (coordinate != null && !double.IsNaN(coordinate.Z))
-            {
-                ordinates |= Ordinates.Z;
-            }
-            if (coordinate != null && !double.IsNaN(coordinate.M))
-            {
-                ordinates |= Ordinates.M;
-            }
-
-            var postGisWriter = new PostGisWriter
-            {
-                HandleOrdinates = ordinates
-            };
-            return postGisWriter.Write(geometry);
+            return geometry;
         }
 
         /// <summary>
@@ -93,15 +64,14 @@ protected override byte[] FromGeometry(object value)
         /// <returns></returns>
         protected override Geometry ToGeometry(object value)
         {
-            var bytes = value as byte[];
-            if (bytes == null)
+            var geometry = value as Geometry;
+            if (geometry == null)
             {
                 return null;
             }
 
-            PostGisReader reader = new PostGisReader();
-            Geometry geometry = reader.Read(bytes);
             this.SetDefaultSRID(geometry);
+
             return geometry;
         }
 
@@ -114,16 +84,7 @@ internal CustomGeometryType() : base(new BinarySqlType())
 
             public override object Get(DbDataReader rs, int index, ISessionImplementor session)
             {
-                // Npgsql 3 from the received bytes creates his own PostGisGeometry type.
-                // As we need to return a byte array that represents the geometry object,
-                // we will retrive the bytes from the reader instead.
-                var length = (int)rs.GetBytes(index, 0, null, 0, 0);
-                var buffer = new byte[length];
-                if (length > 0)
-                {
-                    rs.GetBytes(index, 0, buffer, 0, length);
-                }
-                return buffer;
+                return (Geometry)rs.GetValue(index);
             }
 
             public override object Get(DbDataReader rs, string name, ISessionImplementor session)
@@ -144,8 +105,8 @@ public override void Set(DbCommand cmd, object value, int index, ISessionImpleme
 
             public override object DeepCopyNotNull(object value)
             {
-                var arr = (byte[]) value;
-                return arr.Clone();
+                var obj = (Geometry)value;
+                return obj.Copy();
             }
         }
     }

NetTopologySuite.TestRunner/Utility/WKTOrWKBReader.cs

@@ -37,7 +37,10 @@ private static Boolean IsHexDigit(char ch)
 
         public WKTOrWKBReader(NtsGeometryServices ntsGeometryServices)
         {
-            _wktReader = new WKTReader(ntsGeometryServices);
+            _wktReader = new WKTReader(ntsGeometryServices)
+            {
+                IsOldNtsCoordinateSyntaxAllowed = false
+            };
 #pragma warning disable 612
             _wkbReader = new WKBReader();
 #pragma warning restore 612

Tests.NHibernate.Spatial.PostGis/TestConfiguration.cs

@@ -3,6 +3,7 @@
 using NHibernate.Cfg;
 using NHibernate.Driver;
 using NHibernate.Spatial.Dialect;
+using Npgsql;
 using System.Collections.Generic;
 
 namespace Tests.NHibernate.Spatial
@@ -29,6 +30,10 @@ public static void Configure(Configuration configuration)
                 [Environment.ConnectionString] = _configurationRoot.GetConnectionString("PostGis")
             };
             configuration.SetProperties(properties);
+
+            // Use NTS plugin for mapping PostGIS types; see:
+            // https://www.npgsql.org/doc/release-notes/4.0.html#improved-spatial-support-postgis
+            NpgsqlConnection.GlobalTypeMapper.UseNetTopologySuite();
         }
     }
 }

Tests.NHibernate.Spatial.PostGis20/TestConfiguration.cs

@@ -3,6 +3,7 @@
 using NHibernate.Cfg;
 using NHibernate.Driver;
 using NHibernate.Spatial.Dialect;
+using Npgsql;
 using System.Collections.Generic;
 
 namespace Tests.NHibernate.Spatial
@@ -29,6 +30,10 @@ public static void Configure(Configuration configuration)
                 [Environment.ConnectionString] = _configurationRoot.GetConnectionString("PostGis20")
             };
             configuration.SetProperties(properties);
+
+            // Use NTS plugin for mapping PostGIS types; see:
+            // https://www.npgsql.org/doc/release-notes/4.0.html#improved-spatial-support-postgis
+            NpgsqlConnection.GlobalTypeMapper.UseNetTopologySuite();
         }
     }
 }

Tests.NHibernate.Spatial/AbstractFixture.cs

@@ -24,7 +24,10 @@ namespace Tests.NHibernate.Spatial
     public abstract class AbstractFixture
     {
         private static readonly ILog Log = LogManager.GetLogger(typeof(AbstractFixture));
-        protected static readonly WKTReader Wkt = new WKTReader();
+        protected static readonly WKTReader Wkt = new WKTReader()
+        {
+            IsOldNtsCoordinateSyntaxAllowed = false
+        };
         protected Configuration configuration;
         protected ISessionFactory sessions;
         private ISpatialDialect spatialDialect;

appveyor.yml

@@ -37,19 +37,19 @@ install:
   # - ps: if ($isWindows) { (Get-Content $iniPath).replace('port=3306', 'port=3307') | Set-Content $iniPath }
 
   # install PostgreSQL 8.4
-  - cmd: curl -L -O -S -s https://get.enterprisedb.com/postgresql/postgresql-8.4.22-1-windows.exe
-  - cmd: postgresql-8.4.22-1-windows.exe --mode unattended --superpassword Password12! --serverport 5431
+  # - cmd: curl -L -O -S -s https://get.enterprisedb.com/postgresql/postgresql-8.4.22-1-windows.exe
+  # - cmd: postgresql-8.4.22-1-windows.exe --mode unattended --superpassword Password12! --serverport 5431
 
   # install PostGIS 1.5.5 for PostgreSQL 8.4
-  - cmd: curl -L -O -S -s http://download.osgeo.org/postgis/windows/pg84/postgis-pg84-binaries-1.5.5.zip
-  - cmd: 7z x postgis-pg84-binaries-1.5.5.zip > nul
-  - cmd: xcopy /s /y /q postgis-pg84-binaries-1.5.5 "C:\Program Files (x86)\PostgreSQL\8.4"
-  - cmd: SET PGPASSWORD=Password12!
-  - cmd: SET PGDIR=C:\Program Files (x86)\PostgreSQL\8.4
-  - cmd: SET PATH=%PGDIR%\bin;%PATH%
-  - cmd: createdb -p 5431 -U postgres template_postgis
-  - cmd: psql -q -p 5431 -U postgres -d template_postgis -f "%PGDIR%\share\contrib\postgis-1.5\postgis.sql"
-  - cmd: psql -q -p 5431 -U postgres -d template_postgis -f "%PGDIR%\share\contrib\postgis-1.5\spatial_ref_sys.sql"
+  # - cmd: curl -L -O -S -s http://download.osgeo.org/postgis/windows/pg84/postgis-pg84-binaries-1.5.5.zip
+  # - cmd: 7z x postgis-pg84-binaries-1.5.5.zip > nul
+  # - cmd: xcopy /s /y /q postgis-pg84-binaries-1.5.5 "C:\Program Files (x86)\PostgreSQL\8.4"
+  # - cmd: SET PGPASSWORD=Password12!
+  # - cmd: SET PGDIR=C:\Program Files (x86)\PostgreSQL\8.4
+  # - cmd: SET PATH=%PGDIR%\bin;%PATH%
+  # - cmd: createdb -p 5431 -U postgres template_postgis
+  # - cmd: psql -q -p 5431 -U postgres -d template_postgis -f "%PGDIR%\share\contrib\postgis-1.5\postgis.sql"
+  # - cmd: psql -q -p 5431 -U postgres -d template_postgis -f "%PGDIR%\share\contrib\postgis-1.5\spatial_ref_sys.sql"
 
   # install PostGIS 2.3.2 for PostgreSQL 9.6 on Windows
   - cmd: curl -L -O -S -s http://download.osgeo.org/postgis/windows/pg96/archive/postgis-bundle-pg96-2.3.2x64.zip
@@ -106,12 +106,13 @@ before_test:
   # - cmd: '%mysql% -P 3307 -u root < Tests.NHibernate.Spatial.MySQL57\nhsp_test.sql'
 
   # setup PostgreSQL 8.4
-  - cmd: SET psql="C:\Program Files (x86)\PostgreSQL\8.4\bin\psql.exe"
-  - cmd: '%psql% -q -p 5431 -U postgres -f Tests.NHibernate.Spatial.PostGis\nhsp_test.sql'
+  # - cmd: SET psql="C:\Program Files (x86)\PostgreSQL\8.4\bin\psql.exe"
+  # - cmd: '%psql% -q -p 5431 -U postgres -f Tests.NHibernate.Spatial.PostGis\nhsp_test.sql'
 
   # setup PostgreSQL 9.6 on Windows
   - cmd: net start postgresql-x64-9.6
   - cmd: SET psql="C:\Program Files\PostgreSQL\9.6\bin\psql.exe"
+  - cmd: SET PGPASSWORD=Password12!
   - cmd: '%psql% -q -p 5432 -U postgres -f Tests.NHibernate.Spatial.PostGis20\nhsp_test.sql'
 
   # setup PostgreSQL 9.6 on Ubuntu
@@ -125,7 +126,7 @@ test_script:
   # Disable MySQL tests until issue #87 is resolved
   # - cmd: dotnet test -c Release --no-build --logger "trx;LogFileName=MySQL.trx" --results-directory %APPVEYOR_BUILD_FOLDER% Tests.NHibernate.Spatial.MySQL
   # - cmd: dotnet test -c Release --no-build --logger "trx;LogFileName=MySQL57.trx" --results-directory %APPVEYOR_BUILD_FOLDER% Tests.NHibernate.Spatial.MySQL57
-  - cmd: dotnet test -c Release --no-build --logger "trx;LogFileName=PostGis.trx" --results-directory %APPVEYOR_BUILD_FOLDER% Tests.NHibernate.Spatial.PostGis
+  # - cmd: dotnet test -c Release --no-build --logger "trx;LogFileName=PostGis.trx" --results-directory %APPVEYOR_BUILD_FOLDER% Tests.NHibernate.Spatial.PostGis
   - ps: dotnet test -c Release --no-build --logger "trx;LogFileName=PostGis20.trx" --results-directory $env:APPVEYOR_BUILD_FOLDER Tests.NHibernate.Spatial.PostGis20
 
 after_test:
@@ -135,5 +136,5 @@ after_test:
   - ps: if ($isWindows) { $wc.UploadFile($uri, (Resolve-Path MsSql2012.trx)) }
   # - ps: $wc.UploadFile($uri, (Resolve-Path MySQL.trx))
   # - ps: $wc.UploadFile($uri, (Resolve-Path MySQL57.trx))
-  - ps: if ($isWindows) { $wc.UploadFile($uri, (Resolve-Path PostGis.trx)) }
+  # - ps: if ($isWindows) { $wc.UploadFile($uri, (Resolve-Path PostGis.trx)) }
   - ps: $wc.UploadFile($uri, (Resolve-Path PostGis20.trx))