- PR comments

Author: BorisDog

src/MongoDB.Driver.Core/Core/Misc/Ensure.cs

@@ -27,6 +27,22 @@ namespace MongoDB.Driver.Core.Misc
     [DebuggerStepThrough]
     public static class Ensure
     {
+        /// <summary>
+        /// Ensures that the value of a parameter is not null.
+        /// </summary>
+        /// <typeparam name="T">Type type of the value.</typeparam>
+        /// <param name="value">The value of the parameter.</param>
+        /// <param name="paramName">The name of the parameter.</param>
+        /// <returns>The value of the parameter.</returns>
+        public static Nullable<T> HasValue<T>(Nullable<T> value, string paramName) where T : struct
+        {
+            if (!value.HasValue)
+            {
+                throw new ArgumentException("The Nullable parameter must have a value.", paramName);
+            }
+            return value;
+        }
+
         /// <summary>
         /// Ensures that the value of a parameter is between a minimum and a maximum value.
         /// </summary>
@@ -65,36 +81,36 @@ public static T IsEqualTo<T>(T value, T comparand, string paramName)
         }
 
         /// <summary>
-        /// Ensures that the value of a parameter is greater than or equal to a comparand.
+        /// Ensures that the value of a parameter is greater than a comparand.
         /// </summary>
         /// <typeparam name="T">Type type of the value.</typeparam>
         /// <param name="value">The value of the parameter.</param>
         /// <param name="comparand">The comparand.</param>
         /// <param name="paramName">The name of the parameter.</param>
         /// <returns>The value of the parameter.</returns>
-        public static T IsGreaterThanOrEqualTo<T>(T value, T comparand, string paramName) where T : IComparable<T>
+        public static T IsGreaterThan<T>(T value, T comparand, string paramName) where T : IComparable<T>
         {
-            if (value.CompareTo(comparand) < 0)
+            if (value.CompareTo(comparand) <= 0)
             {
-                var message = string.Format("Value is not greater than or equal to {1}: {0}.", value, comparand);
+                var message = $"Value is not greater than {comparand}: {value}.";
                 throw new ArgumentOutOfRangeException(paramName, message);
             }
             return value;
         }
 
         /// <summary>
-        /// Ensures that the value of a parameter is greater than a comparand.
+        /// Ensures that the value of a parameter is greater than or equal to a comparand.
         /// </summary>
         /// <typeparam name="T">Type type of the value.</typeparam>
         /// <param name="value">The value of the parameter.</param>
         /// <param name="comparand">The comparand.</param>
         /// <param name="paramName">The name of the parameter.</param>
         /// <returns>The value of the parameter.</returns>
-        public static T IsGreaterThan<T>(T value, T comparand, string paramName) where T : IComparable<T>
+        public static T IsGreaterThanOrEqualTo<T>(T value, T comparand, string paramName) where T : IComparable<T>
         {
-            if (value.CompareTo(comparand) <= 0)
+            if (value.CompareTo(comparand) < 0)
             {
-                var message = $"Value is not greater than {comparand}: {value}.";
+                var message = string.Format("Value is not greater than or equal to {1}: {0}.", value, comparand);
                 throw new ArgumentOutOfRangeException(paramName, message);
             }
             return value;
@@ -232,22 +248,6 @@ public static IEnumerable<T> IsNotNullAndDoesNotContainAnyNulls<T>(IEnumerable<T
             return values;
         }
 
-        /// <summary>
-        /// Ensures that the value of a parameter is not null.
-        /// </summary>
-        /// <typeparam name="T">Type type of the value.</typeparam>
-        /// <param name="value">The value of the parameter.</param>
-        /// <param name="paramName">The name of the parameter.</param>
-        /// <returns>The value of the parameter.</returns>
-        public static Nullable<T> HasValue<T>(Nullable<T> value, string paramName) where T : struct
-        {
-            if (!value.HasValue)
-            {
-                throw new ArgumentException("The Nullable parameter must have a value.", paramName);
-            }
-            return value;
-        }
-
         /// <summary>
         /// Ensures that the value of a parameter is not null or empty.
         /// </summary>

src/MongoDB.Driver/AggregateFluentBase.cs

@@ -218,7 +218,7 @@ public virtual IAggregateFluent<TNewResult> ReplaceWith<TNewResult>(AggregateExp
 
         /// <inheritdoc />
         public virtual IAggregateFluent<TResult> Search(
-            SearchDefinition<TResult> query,
+            SearchDefinition<TResult> searchDefinition,
             SearchHighlightOptions<TResult> highlight = null,
             string indexName = null,
             SearchCountOptions count = null,

src/MongoDB.Driver/Search/CompoundSearchDefinitionFluent.cs renamed to src/MongoDB.Driver/Search/CompoundSearchDefinitionBuilder.cs

@@ -1,4 +1,4 @@
-/* Copyright 2016-present MongoDB Inc.
+/* Copyright 2010-present MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -19,10 +19,10 @@
 namespace MongoDB.Driver.Search
 {
     /// <summary>
-    /// Fluent interface for compound search definitions.
+    /// A builder for compound search definitions.
     /// </summary>
     /// <typeparam name="TDocument">The type of the document.</typeparam>
-    public sealed class CompoundSearchDefinitionFluent<TDocument>
+    public sealed class CompoundSearchDefinitionBuilder<TDocument>
     {
         private List<SearchDefinition<TDocument>> _must;
         private List<SearchDefinition<TDocument>> _mustNot;
@@ -34,101 +34,101 @@ public sealed class CompoundSearchDefinitionFluent<TDocument>
         /// Adds clauses which must match to produce results.
         /// </summary>
         /// <param name="clauses">The clauses.</param>
-        /// <returns>The compound fluent interface.</returns>
-        public CompoundSearchDefinitionFluent<TDocument> Must(IEnumerable<SearchDefinition<TDocument>> clauses) =>
+        /// <returns>The compound search definition builder.</returns>
+        public CompoundSearchDefinitionBuilder<TDocument> Must(IEnumerable<SearchDefinition<TDocument>> clauses) =>
              AddClauses(ref _must, clauses);
 
         /// <summary>
         /// Adds clauses which must match to produce results.
         /// </summary>
         /// <param name="clauses">The clauses.</param>
-        /// <returns>The compound fluent interface.</returns>
-        public CompoundSearchDefinitionFluent<TDocument> Must(params SearchDefinition<TDocument>[] clauses) =>
+        /// <returns>The compound search definition builder.</returns>
+        public CompoundSearchDefinitionBuilder<TDocument> Must(params SearchDefinition<TDocument>[] clauses) =>
             Must((IEnumerable<SearchDefinition<TDocument>>)clauses);
 
         /// <summary>
         /// Adds clauses which must not match for a document to be included in the
         /// results.
         /// </summary>
         /// <param name="clauses">The clauses.</param>
-        /// <returns>The compound fluent interface.</returns>
-        public CompoundSearchDefinitionFluent<TDocument> MustNot(IEnumerable<SearchDefinition<TDocument>> clauses) =>
+        /// <returns>The compound search definition builder.</returns>
+        public CompoundSearchDefinitionBuilder<TDocument> MustNot(IEnumerable<SearchDefinition<TDocument>> clauses) =>
             AddClauses(ref _mustNot, clauses);
 
         /// <summary>
         /// Adds clauses which must not match for a document to be included in the
         /// results.
         /// </summary>
         /// <param name="clauses">The clauses.</param>
-        /// <returns>The compound fluent interface.</returns>
-        public CompoundSearchDefinitionFluent<TDocument> MustNot(params SearchDefinition<TDocument>[] clauses) =>
+        /// <returns>The compound search definition builder.</returns>
+        public CompoundSearchDefinitionBuilder<TDocument> MustNot(params SearchDefinition<TDocument>[] clauses) =>
             MustNot((IEnumerable<SearchDefinition<TDocument>>)clauses);
 
         /// <summary>
         /// Adds clauses which cause documents in the result set to be scored higher if
         /// they match.
         /// </summary>
         /// <param name="clauses">The clauses.</param>
-        /// <returns>The compound fluent interface.</returns>
-        public CompoundSearchDefinitionFluent<TDocument> Should(IEnumerable<SearchDefinition<TDocument>> clauses) =>
+        /// <returns>The compound search definition builder.</returns>
+        public CompoundSearchDefinitionBuilder<TDocument> Should(IEnumerable<SearchDefinition<TDocument>> clauses) =>
             AddClauses(ref _should, clauses);
 
         /// <summary>
         /// Adds clauses which cause documents in the result set to be scored higher if
         /// they match.
         /// </summary>
         /// <param name="clauses">The clauses.</param>
-        /// <returns>The compound fluent interface.</returns>
-        public CompoundSearchDefinitionFluent<TDocument> Should(params SearchDefinition<TDocument>[] clauses) =>
+        /// <returns>The compound search definition builder.</returns>
+        public CompoundSearchDefinitionBuilder<TDocument> Should(params SearchDefinition<TDocument>[] clauses) =>
             Should((IEnumerable<SearchDefinition<TDocument>>)clauses);
 
         /// <summary>
         /// Adds clauses which must all match for a document to be included in the
         /// results.
         /// </summary>
         /// <param name="clauses">The clauses.</param>
-        /// <returns>The compound fluent interface.</returns>
-        public CompoundSearchDefinitionFluent<TDocument> Filter(IEnumerable<SearchDefinition<TDocument>> clauses) =>
+        /// <returns>The compound search definition builder.</returns>
+        public CompoundSearchDefinitionBuilder<TDocument> Filter(IEnumerable<SearchDefinition<TDocument>> clauses) =>
              AddClauses(ref _filter, clauses);
 
         /// <summary>
         /// Adds clauses which must all match for a document to be included in the
         /// results.
         /// </summary>
         /// <param name="clauses">The clauses.</param>
-        /// <returns>The compound fluent interface.</returns>
-        public CompoundSearchDefinitionFluent<TDocument> Filter(params SearchDefinition<TDocument>[] clauses) =>
+        /// <returns>The compound search definition builder.</returns>
+        public CompoundSearchDefinitionBuilder<TDocument> Filter(params SearchDefinition<TDocument>[] clauses) =>
             Filter((IEnumerable<SearchDefinition<TDocument>>)clauses);
 
         /// <summary>
         /// Sets a value specifying the minimum number of should clauses the must match
         /// to include a document in the results.
         /// </summary>
         /// <param name="minimumShouldMatch">The value to set.</param>
-        /// <returns>The compound fluent interface.</returns>
-        public CompoundSearchDefinitionFluent<TDocument> MinimumShouldMatch(int minimumShouldMatch)
+        /// <returns>The compound search definition builder.</returns>
+        public CompoundSearchDefinitionBuilder<TDocument> MinimumShouldMatch(int minimumShouldMatch)
         {
             _minimumShouldMatch = minimumShouldMatch;
             return this;
         }
 
         /// <summary>
-        /// Constructs a search definition from the fluent interface.
+        /// Constructs a search definition from the builder.
         /// </summary>
         /// <returns>A compound search definition.</returns>
         public SearchDefinition<TDocument> ToSearchDefinition() =>
             new CompoundSearchDefinition<TDocument>(_must, _mustNot, _should, _filter, _minimumShouldMatch);
 
         /// <summary>
-        /// Performs an implicit conversion from a <see cref="CompoundSearchDefinitionFluent{TDocument}"/>
+        /// Performs an implicit conversion from a <see cref="CompoundSearchDefinitionBuilder{TDocument}"/>
         /// to a <see cref="SearchDefinition{TDocument}"/>.
         /// </summary>
-        /// <param name="compound">The compound fluent interface.</param>
+        /// <param name="builder">The compound search definition builder.</param>
         /// <returns>The result of the conversion.</returns>
-        public static implicit operator SearchDefinition<TDocument>(CompoundSearchDefinitionFluent<TDocument> compound) =>
-            compound.ToSearchDefinition();
+        public static implicit operator SearchDefinition<TDocument>(CompoundSearchDefinitionBuilder<TDocument> builder) =>
+            builder.ToSearchDefinition();
 
-        private CompoundSearchDefinitionFluent<TDocument> AddClauses(ref List<SearchDefinition<TDocument>> clauses, IEnumerable<SearchDefinition<TDocument>> newClauses)
+        private CompoundSearchDefinitionBuilder<TDocument> AddClauses(ref List<SearchDefinition<TDocument>> clauses, IEnumerable<SearchDefinition<TDocument>> newClauses)
         {
             Ensure.IsNotNull(newClauses, nameof(newClauses));
             (clauses ??= new()).AddRange(newClauses);

src/MongoDB.Driver/Search/GeoShapeRelation.cs

@@ -1,4 +1,4 @@
-/* Copyright 2016-present MongoDB Inc.
+/* Copyright 2010-present MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

src/MongoDB.Driver/Search/GeoWithin.cs renamed to src/MongoDB.Driver/Search/GeoWithinArea.cs

@@ -1,4 +1,4 @@
-/* Copyright 2016-present MongoDB Inc.
+/* Copyright 2010-present MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -20,8 +20,7 @@
 namespace MongoDB.Driver.Search
 {
     /// <summary>
-    /// Base class for objects specifying GeoWithin query
-    /// search within.
+    /// Base class for area argument for GeoWithin queries.
     /// </summary>
     /// <typeparam name="TCoordinates">The type of the coordinates.</typeparam>
     public abstract class GeoWithinArea<TCoordinates> where TCoordinates : GeoJsonCoordinates