Support serialization of geo shapes on documents (#3208)

* Support serialization of geo shapes on documents

Fixes #3100
Fixes #3096

* GeometryCollection implements IGeoShape

This commit changes GeometryCollection to implement IGeoShape, to allow a document to have an
IGeoShape member and accept a GeometryCollection. IGeoShape.Type is implemented explicitly so
that the existing Type member continues to be the implicit implementation of IGeometryCollection.

The ideal scenario would have been for IGeometryCollection to implement IGeoShape however this
would break backwards binary compatibility, since both interfaces have a Type member.

(cherry picked from commit 96c0d4d)

This commit includes changes from PR #3214, which were required to address incorrect
serialization introduced in 6.x

Author: russcam

.paket/Paket.Restore.targets

@@ -48,16 +48,16 @@
 
     <!-- Because ReadAllText is slow on osx/linux, try to find shasum and awk -->
     <PropertyGroup>
-        <PaketRestoreCachedHasher Condition="'$(OS)' != 'Windows_NT' And '$(PaketRestoreCachedHasher)' == '' And Exists('/usr/bin/shasum') And Exists('/usr/bin/awk')">/usr/bin/shasum $(PaketRestoreCacheFile) | /usr/bin/awk '{ print $1 }'</PaketRestoreCachedHasher>
-        <PaketRestoreLockFileHasher Condition="'$(OS)' != 'Windows_NT' And '$(PaketRestoreLockFileHash)' == '' And Exists('/usr/bin/shasum') And Exists('/usr/bin/awk')">/usr/bin/shasum $(PaketLockFilePath) | /usr/bin/awk '{ print $1 }'</PaketRestoreLockFileHasher>
+      <PaketRestoreCachedHasher Condition="'$(OS)' != 'Windows_NT' And '$(PaketRestoreCachedHasher)' == '' And Exists('/usr/bin/shasum') And Exists('/usr/bin/awk')">/usr/bin/shasum $(PaketRestoreCacheFile) | /usr/bin/awk '{ print $1 }'</PaketRestoreCachedHasher>
+      <PaketRestoreLockFileHasher Condition="'$(OS)' != 'Windows_NT' And '$(PaketRestoreLockFileHash)' == '' And Exists('/usr/bin/shasum') And Exists('/usr/bin/awk')">/usr/bin/shasum $(PaketLockFilePath) | /usr/bin/awk '{ print $1 }'</PaketRestoreLockFileHasher>
     </PropertyGroup>
 
     <!-- If shasum and awk exist get the hashes -->
     <Exec StandardOutputImportance="Low" Condition=" '$(PaketRestoreCachedHasher)' != '' " Command="$(PaketRestoreCachedHasher)" ConsoleToMSBuild='true'>
-        <Output TaskParameter="ConsoleOutput" PropertyName="PaketRestoreCachedHash" />
+      <Output TaskParameter="ConsoleOutput" PropertyName="PaketRestoreCachedHash" />
     </Exec>
     <Exec StandardOutputImportance="Low" Condition=" '$(PaketRestoreLockFileHasher)' != '' " Command="$(PaketRestoreLockFileHasher)" ConsoleToMSBuild='true'>
-        <Output TaskParameter="ConsoleOutput" PropertyName="PaketRestoreLockFileHash" />
+      <Output TaskParameter="ConsoleOutput" PropertyName="PaketRestoreLockFileHash" />
     </Exec>
 
     <PropertyGroup Condition="Exists('$(PaketRestoreCacheFile)') ">
@@ -127,6 +127,7 @@
       <PackageReference Include="%(PaketReferencesFileLinesInfo.PackageName)">
         <Version>%(PaketReferencesFileLinesInfo.PackageVersion)</Version>
         <PrivateAssets Condition="%(PaketReferencesFileLinesInfo.AllPrivateAssets) == 'true'">All</PrivateAssets>
+        <ExcludeAssets Condition="%(PaketReferencesFileLinesInfo.AllPrivateAssets) == 'exclude'">runtime</ExcludeAssets>
       </PackageReference>
     </ItemGroup>
 
@@ -183,8 +184,8 @@
 
     <ConvertToAbsolutePath Condition="@(_NuspecFiles) != ''" Paths="@(_NuspecFiles)">
       <Output TaskParameter="AbsolutePaths" PropertyName="NuspecFileAbsolutePath" />
-    </ConvertToAbsolutePath>      
-        
+    </ConvertToAbsolutePath>
+
 
     <!-- Call Pack -->
     <PackTask Condition="$(UseNewPack)"

build/scripts/Commandline.fsx

@@ -32,6 +32,10 @@ Targets:
 * diff <github|nuget|directories|assemblies> <version|path 1> <version|path 2> [format]
 
 NOTE: both the `test` and `integrate` targets can be suffixed with `-all` to force the tests against all suported TFM's
+
+Execution hints can be provided anywhere on the command line
+- skiptests : skip running tests as part of the target chain
+- skipdocs : skip generating documentation
 """
 
 module Commandline =
@@ -41,7 +45,7 @@ module Commandline =
     let skipTests = args |> List.exists (fun x -> x = "skiptests")
     let skipDocs = args |> List.exists (fun x -> x = "skipdocs") || isMono
     let private filteredArgs = args |> List.filter (fun x -> x <> "skiptests" && x <> "skipdocs")
-
+        
     let multiTarget =
         match (filteredArgs |> List.tryHead) with
         | Some t when t.EndsWith("-all") -> MultiTarget.All
@@ -69,7 +73,7 @@ module Commandline =
         match Uri.TryCreate(candidate, UriKind.RelativeOrAbsolute) with
         | true, _ -> Some candidate
         | _ -> None
-
+        
     let private (|IsDiff|_|) (candidate:string) =
         let c = candidate |> toLower
         match c with
@@ -150,7 +154,7 @@ module Commandline =
             setBuildParam "esversions" esVersions
             setBuildParam "clusterfilter" "ConnectionReuse"
             setBuildParam "numberOfConnections" numberOfConnections
-            
+ 
         | ["diff"; IsDiff diffType; IsProject project; firstVersionOrPath; secondVersionOrPath; IsFormat format] ->
              setBuildParam "diffType" diffType
              setBuildParam "project" project

src/Nest/CommonAbstractions/SerializationBehavior/GenericJsonConverters/ReserializeJsonConverter.cs

@@ -31,8 +31,7 @@ protected virtual object DeserializeJson(JsonReader reader, Type objectType, obj
 
 		public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
 		{
-			var v = value as TInterface;
-			if (v == null) return;
+			if (!(value is TInterface v)) return;
 			this.SerializeJson(writer, value, v, serializer);
 		}
 
@@ -41,6 +40,8 @@ protected virtual void SerializeJson(JsonWriter writer, object value, TInterface
 			this.Reserialize(writer, value, serializer);
 		}
 
+		protected virtual bool SkipWriteProperty(string propertyName) => false;
+
 		protected void Reserialize(JsonWriter writer, object value, JsonSerializer serializer, Action<JsonWriter> inlineWriter = null)
 		{
 			var properties = value.GetType().GetCachedObjectProperties();
@@ -49,7 +50,7 @@ protected void Reserialize(JsonWriter writer, object value, JsonSerializer seria
 			inlineWriter?.Invoke(writer);
 			foreach (var p in properties)
 			{
-				if (p.Ignored) continue;
+				if (p.Ignored || SkipWriteProperty(p.PropertyName)) continue;
 				var vv = p.ValueProvider.GetValue(value);
 				if (vv == null) continue;
 				writer.WritePropertyName(p.PropertyName);

src/Nest/QueryDsl/Geo/GeoLocation.cs

@@ -8,7 +8,6 @@
 
 namespace Nest
 {
-
 	/// <summary>
 	/// Represents a Latitude/Longitude as a 2 dimensional point that gets serialized as { lat, lon }
 	/// </summary>
@@ -18,18 +17,16 @@ public class GeoLocation : IEquatable<GeoLocation>, IFormattable
 		/// Latitude
 		/// </summary>
 		[JsonProperty("lat")]
-		public double Latitude => _latitude;
-		private readonly double _latitude;
+		public double Latitude { get; }
 
 		/// <summary>
 		/// Longitude
 		/// </summary>
 		[JsonProperty("lon")]
-		public double Longitude => _longitude;
-		private readonly double _longitude;
+		public double Longitude { get; }
 
 		/// <summary>
-		/// Represents a Latitude/Longitude as a 2 dimensional point. 
+		/// Represents a Latitude/Longitude as a 2 dimensional point.
 		/// </summary>
 		/// <param name="latitude">Value between -90 and 90</param>
 		/// <param name="longitude">Value between -180 and 180</param>
@@ -42,32 +39,26 @@ public GeoLocation(double latitude, double longitude)
 			if (!IsValidLongitude(longitude))
 				throw new ArgumentOutOfRangeException(string.Format(CultureInfo.InvariantCulture,
 					"Invalid longitude '{0}'. Valid values are between -180 and 180", longitude));
-			_latitude = latitude;
-			_longitude = longitude;
+			Latitude = latitude;
+			Longitude = longitude;
 		}
 
 		/// <summary>
 		/// True if <paramref name="latitude"/> is a valid latitude. Otherwise false.
 		/// </summary>
 		/// <param name="latitude"></param>
 		/// <returns></returns>
-		public static bool IsValidLatitude(double latitude)
-		{
-			return latitude >= -90 && latitude <= 90;
-		}
+		public static bool IsValidLatitude(double latitude) => latitude >= -90 && latitude <= 90;
 
 		/// <summary>
 		/// True if <paramref name="longitude"/> is a valid longitude. Otherwise false.
 		/// </summary>
 		/// <param name="longitude"></param>
 		/// <returns></returns>
-		public static bool IsValidLongitude(double longitude)
-		{
-			return longitude >= -180 && longitude <= 180;
-		}
+		public static bool IsValidLongitude(double longitude) => longitude >= -180 && longitude <= 180;
 
 		/// <summary>
-		/// Try to create a <see cref="GeoLocation"/>. 
+		/// Try to create a <see cref="GeoLocation"/>.
 		/// Return <value>null</value> if either <paramref name="latitude"/> or <paramref name="longitude"/> are invalid.
 		/// </summary>
 		/// <param name="latitude">Value between -90 and 90</param>
@@ -80,18 +71,17 @@ public static GeoLocation TryCreate(double latitude, double longitude)
 			return null;
 		}
 
-		public override string ToString()
-		{
-            return _latitude.ToString("#0.0#######", CultureInfo.InvariantCulture) + "," + _longitude.ToString("#0.0#######", CultureInfo.InvariantCulture);
-		}
+		public override string ToString() =>
+			Latitude.ToString("#0.0#######", CultureInfo.InvariantCulture) + "," +
+			Longitude.ToString("#0.0#######", CultureInfo.InvariantCulture);
 
 		public bool Equals(GeoLocation other)
 		{
 			if (ReferenceEquals(null, other))
 				return false;
 			if (ReferenceEquals(this, other))
 				return true;
-			return _latitude.Equals(other._latitude) && _longitude.Equals(other._longitude);
+			return Latitude.Equals(other.Latitude) && Longitude.Equals(other.Longitude);
 		}
 
 		public override bool Equals(object obj)
@@ -106,7 +96,7 @@ public override bool Equals(object obj)
 		}
 
 		public override int GetHashCode() =>
-			unchecked((_latitude.GetHashCode() * 397) ^ _longitude.GetHashCode());
+			unchecked((Latitude.GetHashCode() * 397) ^ Longitude.GetHashCode());
 
 		public string ToString(string format, IFormatProvider formatProvider) => ToString();
 
@@ -117,21 +107,18 @@ public static implicit operator GeoLocation(string latLon)
 
 			var parts = latLon.Split(',');
 			if (parts.Length != 2) throw new ArgumentException("Invalid format: string must be in the form of lat,lon");
-			double lat;
-			if (!double.TryParse(parts[0], NumberStyles.Any, CultureInfo.InvariantCulture, out lat))
+			if (!double.TryParse(parts[0], NumberStyles.Any, CultureInfo.InvariantCulture, out var lat))
 				throw new ArgumentException("Invalid latitude value");
-			double lon;
-			if (!double.TryParse(parts[1], NumberStyles.Any, CultureInfo.InvariantCulture, out lon))
+			if (!double.TryParse(parts[1], NumberStyles.Any, CultureInfo.InvariantCulture, out var lon))
 				throw new ArgumentException("Invalid longitude value");
 			return new GeoLocation(lat, lon);
 		}
 
 		public static implicit operator GeoLocation(double[] lonLat)
 		{
-			if (lonLat.Length != 2)
-				return null;
-			
-			return new GeoLocation(lonLat[1], lonLat[0]);
+			return lonLat.Length != 2
+				? null
+				: new GeoLocation(lonLat[1], lonLat[0]);
 		}
 	}
 
@@ -141,14 +128,21 @@ public static implicit operator GeoLocation(double[] lonLat)
 	[JsonConverter(typeof(GeoCoordinateJsonConverter))]
 	public class GeoCoordinate : GeoLocation
 	{
-		public GeoCoordinate(double latitude, double longitude) : base(latitude, longitude)
-		{
-		}
+		/// <summary>
+		/// Creates a new instance of <see cref="GeoCoordinate"/>
+		/// </summary>
+		public GeoCoordinate(double latitude, double longitude) : base(latitude, longitude) { }
 
+		/// <summary>
+		/// Creates a new instance of <see cref="GeoCoordinate"/> from a pair of coordinates
+		/// in the order Latitude then Longitude.
+		/// </summary>
 		public static implicit operator GeoCoordinate(double[] coordinates)
 		{
 			if (coordinates == null || coordinates.Length != 2)
-				throw new ArgumentOutOfRangeException(nameof(coordinates), "Can not create a GeoCoordinate from an array that does not have two doubles");
+				throw new ArgumentOutOfRangeException(
+					nameof(coordinates),
+					$"Can not create a {nameof(GeoCoordinate)} from an array that does not have two doubles");
 
 			return new GeoCoordinate(coordinates[0], coordinates[1]);
 		}

src/Nest/QueryDsl/Geo/Shape/Envelope/EnvelopeGeoShape.cs

@@ -13,11 +13,8 @@ public class EnvelopeGeoShape : GeoShapeBase, IEnvelopeGeoShape
 	{
 		public EnvelopeGeoShape() : this(null) { }
 
-		public EnvelopeGeoShape(IEnumerable<GeoCoordinate> coordinates) 
-			: base("envelope") 
-		{
+		public EnvelopeGeoShape(IEnumerable<GeoCoordinate> coordinates) : base("envelope") =>
 			this.Coordinates = coordinates;
-		}
 
 		public IEnumerable<GeoCoordinate> Coordinates { get; set; }
 	}