Extend query DSL with SpanFieldMaskingQuery (#2231)

Author: yevhen

src/Nest/DSL/Query/IQueryContainer.cs

@@ -128,6 +128,9 @@ public interface IQueryContainer : ICustomJson
 		[JsonProperty(PropertyName = "span_multi")]
 		ISpanMultiTermQuery SpanMultiTerm { get; set; }
 
+        [JsonProperty(PropertyName = "field_masking_span")]
+		ISpanFieldMaskingQuery SpanFieldMasking { get; set; }
+
 		[JsonProperty(PropertyName = "top_children")]
 		ITopChildrenQuery TopChildren { get; set; }
 

src/Nest/DSL/Query/QueryContainer.cs

@@ -79,6 +79,8 @@ public class QueryContainer : IQueryContainer
 
 		ISpanMultiTermQuery IQueryContainer.SpanMultiTerm { get; set; }
 
+		ISpanFieldMaskingQuery IQueryContainer.SpanFieldMasking { get; set; }
+
 		ITopChildrenQuery IQueryContainer.TopChildren { get; set; }
 
 		INestedQuery IQueryContainer.Nested { get; set; }

src/Nest/DSL/Query/SpanFieldMaskingQueryDescriptor.cs

@@ -0,0 +1,96 @@
+using System;
+using System.Linq.Expressions;
+
+using Nest.DSL.Query.Behaviour;
+using Nest.Resolvers.Converters;
+using Newtonsoft.Json;
+
+namespace Nest
+{
+	[JsonObject(MemberSerialization = MemberSerialization.OptIn)]
+	[JsonConverter(typeof(ReadAsTypeConverter<SpanFieldMaskingQueryDescriptor<object>>))]
+	public interface ISpanFieldMaskingQuery : ISpanSubQuery, IFieldNameQuery
+    {
+        [JsonProperty(PropertyName = "field")]
+        PropertyPathMarker Field { get; set; }
+        
+        [JsonProperty(PropertyName = "query")]
+		ISpanQuery Query { get; set; }
+	}
+
+	public class SpanFieldMaskingQuery : PlainQuery, ISpanFieldMaskingQuery
+    {
+		protected override void WrapInContainer(IQueryContainer container)
+		{
+			container.SpanFieldMasking = this;
+		}
+
+		bool IQuery.IsConditionless { get { return false; } }
+
+        public string Name { get; set; }
+        public PropertyPathMarker Field { get; set; }
+        public ISpanQuery Query { get; set; }
+
+        PropertyPathMarker IFieldNameQuery.GetFieldName()
+        {
+            return this.Field;
+        }
+
+        void IFieldNameQuery.SetFieldName(string fieldName)
+        {
+            this.Field = fieldName;
+        }
+    }
+
+	public class SpanFieldMaskingQueryDescriptor<T> : ISpanFieldMaskingQuery where T : class
+	{
+		ISpanFieldMaskingQuery Self { get { return this; } }
+        bool IQuery.IsConditionless { get { return false; } }
+
+        ISpanQuery ISpanFieldMaskingQuery.Query { get; set; }
+        PropertyPathMarker ISpanFieldMaskingQuery.Field { get; set; }
+        string IQuery.Name { get; set; }
+        
+		public SpanFieldMaskingQueryDescriptor<T> Name(string name)
+		{
+			Self.Name = name;
+			return this;
+		}
+
+		public SpanFieldMaskingQueryDescriptor<T> Query(Func<SpanQuery<T>, SpanQuery<T>> selector)
+		{
+			if (selector == null) return this;
+			var span = new SpanQuery<T>();
+			Self.Query = selector(span); ;
+			return this;
+		}
+
+		public SpanFieldMaskingQueryDescriptor<T> OnField(string field)
+		{
+			Self.Field = field;
+			return this;
+		}
+
+        public SpanFieldMaskingQueryDescriptor<T> OnField(Expression<Func<T, object>> field)
+        {
+            Self.Field = field;
+            return this;
+        }
+
+        public SpanFieldMaskingQueryDescriptor<T> OnField<K>(Expression<Func<T, K>> field)
+        {
+            Self.Field = field;
+            return this;
+        }
+        
+        public PropertyPathMarker GetFieldName()
+        {
+            return Self.Field;
+        }
+
+        public void SetFieldName(string fieldName)
+        {
+            Self.Field = fieldName;
+        }
+    }
+}

src/Nest/DSL/Query/SpanQueryDescriptor.cs

@@ -28,6 +28,9 @@ public interface ISpanQuery : IQuery
 
 		[JsonProperty(PropertyName = "span_multi")]
 		ISpanMultiTermQuery SpanMultiTerm { get; set; }
+
+        [JsonProperty(PropertyName = "field_masking_span")]
+		ISpanFieldMaskingQuery SpanFieldMasking { get; set; }
 	}
 
 	public class SpanQuery : ISpanQuery
@@ -40,6 +43,7 @@ public class SpanQuery : ISpanQuery
 		public ISpanOrQuery SpanOr { get; set; }
 		public ISpanNotQuery SpanNot { get; set; }
 		public ISpanMultiTermQuery SpanMultiTerm { get; set; }
+		public ISpanFieldMaskingQuery SpanFieldMasking { get; set; }
 	}
 
 	public class SpanQuery<T> : ISpanQuery where T : class
@@ -58,6 +62,8 @@ public class SpanQuery<T> : ISpanQuery where T : class
 
 		ISpanMultiTermQuery ISpanQuery.SpanMultiTerm { get; set; }
 
+        ISpanFieldMaskingQuery ISpanQuery.SpanFieldMasking { get; set; }
+
 		string IQuery.Name { get; set; }
 
 		bool IQuery.IsConditionless
@@ -71,7 +77,8 @@ bool IQuery.IsConditionless
 					Self.SpanNear as IQuery,
 					Self.SpanOr as IQuery,
 					Self.SpanNot as IQuery,
-					Self.SpanMultiTerm as IQuery
+					Self.SpanMultiTerm as IQuery,
+					Self.SpanFieldMasking as IQuery
 				};
 				return queries.All(q => q == null || q.IsConditionless);
 			}
@@ -134,6 +141,12 @@ public SpanQuery<T> SpanMultiTerm(Func<SpanMultiTermQueryDescriptor<T>, SpanMult
 			var q= selector(new SpanMultiTermQueryDescriptor<T>());
 			return CreateQuery(q, (sq) => sq.SpanMultiTerm = q);
 		}
+        public SpanQuery<T> SpanFieldMasking(Func<SpanFieldMaskingQueryDescriptor<T>, SpanFieldMaskingQueryDescriptor<T>> selector)
+		{
+			selector.ThrowIfNull("selector");
+			var q= selector(new SpanFieldMaskingQueryDescriptor<T>());
+			return CreateQuery(q, (sq) => sq.SpanFieldMasking = q);
+		}
 
 		private SpanQuery<T> CreateQuery<K>(K query, Action<ISpanQuery> setProperty) where K : ISpanSubQuery
 		{

src/Nest/DSL/Visitor/DslPrettyPrintVisitor.cs

@@ -230,6 +230,11 @@ public virtual void Visit(ISpanTermQuery query)
 			Write("span_term");
 		}
 
+        public virtual void Visit(ISpanFieldMaskingQuery query)
+		{
+			Write("field_masking_span");
+		}
+
 		public virtual void Visit(ITermQuery query)
 		{
 			Write("term", query.Field);

src/Nest/DSL/Visitor/QueryVisitor.cs

@@ -68,6 +68,7 @@ public interface IQueryVisitor
 		void Visit(ISpanNotQuery query);
 		void Visit(ISpanOrQuery query);
 		void Visit(ISpanTermQuery query);
+		void Visit(ISpanFieldMaskingQuery query);
 		void Visit(ITermQuery query);
 		void Visit(IWildcardQuery query);
 		void Visit(ITermsQuery query);
@@ -259,6 +260,10 @@ public virtual void Visit(ISpanTermQuery customFiltersScore)
 		{
 		}
 
+        public virtual void Visit(ISpanFieldMaskingQuery customFiltersScore)
+		{
+		}
+
 		public virtual void Visit(ITermQuery customFiltersScore)
 		{
 		}

src/Nest/Nest.csproj

@@ -243,6 +243,7 @@
     <Compile Include="DSL\FieldStatsDescriptor.cs" />
     <Compile Include="DSL\Filter\IndicesFilterDescriptor.cs" />
     <Compile Include="Domain\DSL\NoMatchShortcut.cs" />
+    <Compile Include="DSL\Query\SpanFieldMaskingQueryDescriptor.cs" />
     <Compile Include="DSL\SyncedFlushDescriptor.cs" />
     <Compile Include="DSL\Query\Functions\WeightFunction.cs" />
     <Compile Include="DSL\Search\IGlobalInnerHit.cs" />

src/Tests/Nest.Tests.Unit/QueryParsers/Visitor/DslPrettyPrintVisitor.cs

@@ -236,6 +236,11 @@ public virtual void Visit(ISpanTermQuery query)
 			Write("span_term");
 		}
 
+        public virtual void Visit(ISpanFieldMaskingQuery query)
+		{
+			Write("field_masking_span");
+		}
+
 		public virtual void Visit(ITermQuery query)
 		{
 			Write("term", query.Field);