feat(util): add QueryStringOptions.WithCollectionKeyFormatter to be able to format keys only e.g. convert php like by appending [] to the key (#82)

Author: stephenlautier

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 [_vNext_](https://github.com/sketch7/FluentlyHttpClient/compare/3.8.1...3.9.0) (2020-X-X)
 
+## [3.9.6](https://github.com/sketch7/FluentlyHttpClient/compare/3.9.5...3.9.6) (2024-06-11)
+
+### Features
+
+- **util:** add `QueryStringOptions.WithCollectionKeyFormatter` to be able to format keys only e.g. convert php like by appending `[]` to the key
+
 ## [3.9.5](https://github.com/sketch7/FluentlyHttpClient/compare/3.9.4...3.9.5) (2024-03-22)
 
 ### Features

Directory.Packages.props

@@ -16,12 +16,12 @@
 
     <PackageVersion Include="Microsoft.EntityFrameworkCore.SqlServer" Version="2.2.3" />
 
-    <PackageVersion Include="Microsoft.AspNet.WebApi.Client" Version="5.2.7" />
+    <PackageVersion Include="Microsoft.AspNet.WebApi.Client" Version="6.0.0" />
     <!-- 3rd party -->
     <PackageVersion Include="BenchmarkDotNet" Version="0.13.12" />
     <PackageVersion Include="MessagePack" Version="2.5.108" />
     <PackageVersion Include="MimeTypesMap" Version="1.0.8" />
-    <PackageVersion Include="Newtonsoft.Json" Version="12.0.1" />
+    <PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageVersion Include="Humanizer.Core" Version="2.7.9" />
     <PackageVersion Include="Sketch7.Core" Version="0.1.1" />
     <!-- testing -->

NuGet.Config

@@ -1,6 +1,11 @@
 <?xml version="1.0" encoding="utf-8"?>
 <configuration>
-  <packageSources>
-    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
-  </packageSources>
-</configuration>
+	<packageSources>
+		<add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
+	</packageSources>
+	<packageSourceMapping>
+		<packageSource key="nuget.org">
+			<package pattern="*" />
+		</packageSource>
+	</packageSourceMapping>
+</configuration>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sketch7/fluently-http-client",
-  "version": "3.9.5",
+  "version": "3.9.6",
   "versionSuffix": "",
   "scripts": {
     "pack": "bash ./tools/pack.sh",

src/FluentlyHttpClient/Utils/QueryStringOptions.cs

@@ -1,4 +1,3 @@
-using System.Net;
 using System.Web;
 
 #pragma warning disable 618 // todo: remove after removing deprecated code
@@ -41,9 +40,6 @@ public class QueryStringOptions
 	/// </summary>
 	public static readonly Func<string, string> DefaultValueEncoder = HttpEncode;
 
-	/// <summary>
-	/// Debugger display.
-	/// </summary>
 	protected string DebuggerDisplay => $"CollectionMode: '{CollectionMode}'";
 
 	/// <summary>
@@ -65,7 +61,9 @@ public class QueryStringOptions
 
 	internal Func<object, string>? ValueFormatter { get; set; }
 
-	internal Func<string, string>? ValueEncoder { get; set; } = DefaultValueEncoder;
+	internal Func<string, string> ValueEncoder { get; set; } = DefaultValueEncoder;
+
+	internal Func<string, string>? CollectionKeyFormatter { get; set; }
 
 	/// <summary>
 	/// Gets or sets the function to format a collection item. This will allow you to manipulate the value.
@@ -86,6 +84,16 @@ public QueryStringOptions WithKeyFormatter(Func<string, string> configure)
 		return this;
 	}
 
+	/// <summary>
+	/// Gets or sets the function to format the key to be used only for collections. Useful to make php like keys e.g. append '[]' 'filter[]'.
+	/// NOTE: <see cref="WithKeyFormatter"/> will still be used.
+	/// </summary>
+	public QueryStringOptions WithCollectionKeyFormatter(Func<string, string> configure)
+	{
+		CollectionKeyFormatter = configure;
+		return this;
+	}
+
 	/// <summary>
 	/// Gets or sets the function to format a value. This will allow you to manipulate the value e.g. use enums attribute instead of value.
 	/// </summary>

src/FluentlyHttpClient/Utils/QueryStringUtils.cs

@@ -74,6 +74,10 @@ public static string ToQueryString<TKey, TValue>(this IDictionary<TKey, TValue>
 
 	private static string BuildCollectionQueryString(string key, IEnumerable values, string qs, QueryStringOptions options)
 	{
+		key = options.CollectionKeyFormatter == null
+			? key
+			: options.CollectionKeyFormatter(key);
+
 		switch (options.CollectionMode)
 		{
 			case QueryStringCollectionMode.KeyPerValue:

test/Utils/QueryStringUtilsTest.cs

@@ -47,7 +47,7 @@ public void ShouldGenerateComplexQueryStringWithoutCollection()
 	[Fact]
 	public void ShouldOmitEmptyOrNulls()
 	{
-		var queryCollection = new Dictionary<string, object>
+		var queryCollection = new Dictionary<string, object?>
 		{
 			{"heroName", ""},
 			{"cap", null},
@@ -147,6 +147,24 @@ public void ShouldFormatKeyToLower()
 		Assert.Equal("heroname=yasuo&level=100", result);
 	}
 
+	[Fact]
+	public void ShouldFormatCollectionKey()
+	{
+		var queryCollection = new Dictionary<string, object>
+		{
+			{"HeroName", "yasuo"},
+			{"filter", new List<string>{ "assassin", "fighter" }}
+		};
+
+		var result = queryCollection.ToQueryString(opts =>
+			{
+				opts.CollectionMode = QueryStringCollectionMode.KeyPerValue;
+				opts.WithCollectionKeyFormatter(key => $"{key}[]");
+			}
+		);
+
+		Assert.Equal("heroName=yasuo&filter[]=assassin&filter[]=fighter", result);
+	}
 
 	[Fact]
 	public void ShouldNotHttpEncodeValue()