Match the empty remainder with a trailing whole-segment ** [patch]

TextFilter.Test/ReadmeTests.cs

@@ -4,6 +4,7 @@ namespace TextFilter.Test;
 
 using System;
 using System.Collections.Generic;
+using System.ComponentModel;
 using System.IO;
 using System.Linq;
 using System.Reflection;
@@ -89,7 +90,10 @@ public void EveryMethodInTheReadmeApiReferenceExistsWithItsDocumentedDefaults()
 		foreach (Match row in rows)
 		{
 			string methodName = row.Groups["method"].Value;
-			MethodInfo[] overloads = [.. methods.Where(m => m.Name == methodName)];
+			// The binary-compatibility overloads are hidden from IntelliSense and deliberately carry no
+			// defaults, since defaults on both sets would make calls ambiguous. The README documents the
+			// visible overloads, so only those are held to its defaults.
+			MethodInfo[] overloads = [.. methods.Where(m => m.Name == methodName && !IsHiddenFromCallers(m))];
 			if (overloads.Length == 0)
 			{
 				problems.Add($"{methodName} does not exist");
@@ -115,6 +119,9 @@ public void EveryMethodInTheReadmeApiReferenceExistsWithItsDocumentedDefaults()
 		Assert.IsEmpty(problems, string.Join("; ", problems));
 	}
 
+	private static bool IsHiddenFromCallers(MethodInfo method) =>
+		method.GetCustomAttribute<EditorBrowsableAttribute>()?.State == EditorBrowsableState.Never;
+
 	[TestMethod]
 	public void ReadmeMatchOptionsSampleGivesTheDocumentedResults()
 	{

TextFilter.Test/TextFilterTests.cs

@@ -1169,8 +1169,8 @@
 	public void FilterWithAClassFollowedByALiteralBracketKeepsAndExcludesTheRightItems()
 	{
 		List<string> items = ["items[3]", "items[3", "notes.txt"];
 		CollectionAssert.AreEqual(new List<string> { "items[3]" }, TextFilter.Filter(items, "*[[][0-9]]").ToList());
 		CollectionAssert.AreEqual(new List<string> { "items[3", "notes.txt" }, TextFilter.Filter(items, "-*[[][0-9]]").ToList());
 	}
 
 	[TestMethod]
@@ -1313,6 +1313,44 @@
 		Assert.AreEqual("src/x/a.cs", result[1]);
 	}
 
+	[TestMethod]
+	[DataRow("src/", "src/**")]
+	[DataRow("src/a.cs", "src/**")]
+	[DataRow("src/lib/b.cs", "src/**")]
+	[DataRow("a/b/", "a/**/b/**")]
+	[DataRow("/", "/**")]
+	[DataRow("-b/", "*/**")]
+	[DataRow("-/", "?/**")]
+	[DataRow("b-/", "b-/**")]
+	[DataRow(@"src\", @"src\**")]
+	public void TrailingGlobStarSegmentMatchesTheEmptyRemainder(string text, string filter)
+	{
+		Assert.IsTrue(TextFilter.IsMatch(text, filter, TextFilterType.Glob, TextFilterMatchOptions.ByWholeString));
+		Assert.IsTrue(TextFilter.IsMatch(text, filter));
+	}
+
+	[TestMethod]
+	[DataRow("src", "src/**")]
+	[DataRow("docs/a.cs", "src/**")]
+	[DataRow("foo", "foo**")]
+	public void TrailingGlobStarSegmentStillNeedsItsDirectory(string text, string filter)
+	{
+		Assert.IsFalse(TextFilter.IsMatch(text, filter, TextFilterType.Glob, TextFilterMatchOptions.ByWholeString));
+	}
+
+	[TestMethod]
+	public void TrailingGlobStarSegmentFiltersLikeASingleStar()
+	{
+		string[] items = ["src/", "src/a.cs", "src/lib/b.cs", "build/", "build/out.dll", "readme.md"];
+
+		List<string> included = ["src/", "src/a.cs", "src/lib/b.cs"];
+		List<string> excluded = ["src/", "src/a.cs", "src/lib/b.cs", "readme.md"];
+
+		CollectionAssert.AreEqual(included, TextFilter.Filter(items, "src/**").ToList());
+		CollectionAssert.AreEqual(TextFilter.Filter(items, "src/*").ToList(), TextFilter.Filter(items, "src/**").ToList());
+		CollectionAssert.AreEqual(excluded, TextFilter.Filter(items, "-build/**").ToList());
+	}
+
 	[TestMethod]
 	public void GlobStarSlashMatchesCaseInsensitively()
 	{
@@ -1326,7 +1364,7 @@
 	{
 		List<string> result = [.. TextFilter.Filter(["readme.md", "src/a.cs", "docs/", "a b"], filter)];
 
 		Assert.AreEqual(1, result.Count);
 		Assert.AreEqual("docs/", result[0]);
 	}
 
@@ -1337,7 +1375,7 @@
 	{
 		List<string> result = [.. TextFilter.Filter(["readme.md", "src/a.cs", "docs/", "a b"], filter)];
 
 		Assert.AreEqual(3, result.Count);
 		Assert.AreEqual("readme.md", result[0]);
 		Assert.AreEqual("src/a.cs", result[1]);
 		Assert.AreEqual("a b", result[2]);
@@ -1348,7 +1386,7 @@
 	{
 		List<string> result = [.. TextFilter.Filter(["readme.md", "src/a.cs", "docs/"], "+**/")];
 
 		Assert.AreEqual(1, result.Count);
 		Assert.AreEqual("docs/", result[0]);
 	}
 
@@ -1559,11 +1597,11 @@
 	[TestMethod]
 	public void Pre17GenericFilterSignatureStillExists()
 	{
 		Assert.IsTrue(typeof(TextFilter).GetMethods().Any(m =>
 			m.Name == nameof(TextFilter.Filter)
 			&& m.IsGenericMethodDefinition
 			&& m.GetParameters().Length == 5
 			&& m.GetParameters()[4].ParameterType == typeof(TextFilterMatchOptions)));
 	}
 
 	[TestMethod]

TextFilter/TextFilter.cs

@@ -303,7 +303,7 @@
 
 			return ExcludedTokenPrefixes.Contains(prefix)
 				? TextFilterTokenType.Excluded
 				: RequiredTokenPrefixes.Contains(prefix)
 				? TextFilterTokenType.Required
 				: TextFilterTokenType.Optional;
 		})
@@ -334,7 +334,7 @@
 	/// matches nor rejects anything; as a required token it matches everything; and as an excluded
 	/// token it excludes nothing.
 	/// </remarks>
 	public static bool DoesMatchGlob(string text, string filter, TextFilterMatchOptions textFilterMatchOptions, TextFilterCaseSensitivity caseSensitivity = TextFilterCaseSensitivity.CaseSensitive)
 	{
 		Ensure.NotNull(text);
 		Ensure.NotNull(filter);
@@ -408,7 +408,7 @@
 	/// <param name="textTokens">The set of text tokens to match against.</param>
 	/// <param name="caseSensitivity">Whether the match distinguishes uppercase from lowercase.</param>
 	/// <returns><c>true</c> if any token matches the glob filter token; otherwise, <c>false</c>.</returns>
 	public static bool AnyTokenMatchesGlobFilter(string filterToken, HashSet<string> textTokens, TextFilterCaseSensitivity caseSensitivity = TextFilterCaseSensitivity.CaseSensitive)
 	{
 		Ensure.NotNull(filterToken);
 		Ensure.NotNull(textTokens);
@@ -425,7 +425,7 @@
 	/// <param name="textTokens">The set of text tokens to match against.</param>
 	/// <param name="caseSensitivity">Whether the match distinguishes uppercase from lowercase.</param>
 	/// <returns><c>true</c> if all tokens match the glob filter token; otherwise, <c>false</c>.</returns>
 	public static bool AllTokensMatchGlobFilter(string filterToken, HashSet<string> textTokens, TextFilterCaseSensitivity caseSensitivity = TextFilterCaseSensitivity.CaseSensitive)
 	{
 		Ensure.NotNull(filterToken);
 		Ensure.NotNull(textTokens);
@@ -492,7 +492,23 @@
 		}
 
 		string tail = maskedToken[start..];
-		return [.. expansions.Select(prefix => prefix + tail).Distinct(StringComparer.Ordinal)];
+		return [.. expansions.Select(prefix => ExpandTrailingGlobStar(prefix + tail)).Distinct(StringComparer.Ordinal)];
+	}
+
+	// A trailing whole-segment "**", as in "src/**", should match the empty remainder too, so that
+	// "dir/**" matches at least what "dir/*" does, "dir/" included. With the separator masked,
+	// DotNet.Glob reads it as "**" joined to a literal, which needs at least one more character. Since
+	// * already crosses the masked separator, a plain "*" means the same and also matches nothing.
+	private static string ExpandTrailingGlobStar(string expansion)
+	{
+		if (!expansion.EndsWith("**", StringComparison.Ordinal))
+		{
+			return expansion;
+		}
+
+		int globStarStart = expansion.Length - 2;
+		bool isWholeSegment = globStarStart == 0 || expansion[globStarStart - 1] == MaskedPathSeparator;
+		return isWholeSegment ? expansion[..globStarStart] + "*" : expansion;
 	}
 
 	// DotNet.Glob reads a bracket class as exactly one token: a single range when it starts "x-y" with
@@ -509,7 +525,7 @@
 	// MaxGlobClassMembers characters, or that has no members at all because every range is reversed.
 	private const int MaxGlobClassMembers = 4096;
 
 	internal static string? ExpandGlobClasses(string token)
 	{
 		if (!token.Contains(']'))
 		{
@@ -712,7 +728,7 @@
 	/// <see cref="TextFilterMatchOptions.ByWholeString"/> for those.
 	/// </para>
 	/// </remarks>
 	public static bool DoesMatchRegex(string text, string filter, TextFilterMatchOptions textFilterMatchOptions, TextFilterCaseSensitivity caseSensitivity = TextFilterCaseSensitivity.CaseSensitive)
 	{
 		Ensure.NotNull(text);
 		Ensure.NotNull(filter);