Add datetime support for query param (#27) +semver: minor

charlesdevandiere · web-flow · commit 32e4b78ab8aa · 2022-03-30T13:48:28.000+02:00
diff --git a/.editorconfig b/.editorconfig
@@ -8,7 +8,7 @@ root = true
 [*]
 indent_style = space
 insert_final_newline = true
-charset = utf-8-bom
+charset = utf-8
 
 # Code files
 [*.{cs,csx,vb,vbx}]
diff --git a/GraphQL.Query.Builder.sln b/GraphQL.Query.Builder.sln
@@ -1,4 +1,4 @@
-﻿
+
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 15
 VisualStudioVersion = 15.0.26124.0
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -25,11 +25,6 @@ steps:
     inputs:
       versionSpec: '5.x'
 
-  - task: UseDotNet@2
-    displayName: 'Use .NET 5 sdk'
-    inputs:
-      version: '5.0.x'
-
   - script: dotnet tool restore
     displayName: 'dotnet tool restore'
 
diff --git a/docs/api/graphql.query.builder.querystringbuilder.md b/docs/api/graphql.query.builder.querystringbuilder.md
@@ -54,13 +54,14 @@ public void Clear()
 Formats query param.
  
  Returns:
- - String: `"value"`
+ - String: `"foo"`
  - Number: `10`
- - Boolean: `true` / `false`
+ - Boolean: `true` or `false`
  - Enum: `EnumValue`
- - Key value pair: `key:"value"` / `key:10`
- - List: `["value1","value2"]` / `[1,2]`
- - Dictionary: `{a:"value",b:10}`
+ - DateTime: `"2022-06-15T13:45:30.0000000Z"`
+ - Key value pair: `foo:"bar"` or `foo:10` ...
+ - List: `["foo","bar"]` or `[1,2]` ...
+ - Dictionary: `{foo:"bar",b:10}`
 
 ```csharp
 protected internal string FormatQueryParam(object value)
diff --git a/generate-documentation.bat b/generate-documentation.bat
@@ -1,3 +1,4 @@
 @echo off
+dotnet tool restore
 dotnet build .\src\GraphQL.Query.Builder\GraphQL.Query.Builder.csproj -c Release
-dotnet tool run xmldoc2md .\src\GraphQL.Query.Builder\bin\Debug\netstandard2.0\GraphQL.Query.Builder.dll .\docs\api --github-pages --back-button
+dotnet tool run xmldoc2md .\src\GraphQL.Query.Builder\bin\Release\netstandard2.0\GraphQL.Query.Builder.dll .\docs\api --github-pages --back-button
diff --git a/sample/Models/Models.csproj b/sample/Models/Models.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
-    <LangVersion>9.0</LangVersion>
+    <LangVersion>latest</LangVersion>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
diff --git a/sample/Pokedex/Pokedex.csproj b/sample/Pokedex/Pokedex.csproj
@@ -2,8 +2,8 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net5</TargetFramework>
-    <LangVersion>9.0</LangVersion>
+    <TargetFramework>net6.0</TargetFramework>
+    <LangVersion>latest</LangVersion>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/GraphQL.Query.Builder/GraphQL.Query.Builder.csproj b/src/GraphQL.Query.Builder/GraphQL.Query.Builder.csproj
@@ -1,7 +1,7 @@
-﻿<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
-    <LangVersion>9.0</LangVersion>
+    <LangVersion>latest</LangVersion>
     <Version>0.0.0</Version>
     <Authors>Charles de Vandière</Authors>
     <Description>A tool to build GraphQL query from a C# model.</Description>
diff --git a/src/GraphQL.Query.Builder/IQueryOf{T}.cs b/src/GraphQL.Query.Builder/IQueryOf{T}.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections.Generic;
 using System.Linq.Expressions;
 
diff --git a/src/GraphQL.Query.Builder/IQueryStringBuilder.cs b/src/GraphQL.Query.Builder/IQueryStringBuilder.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 
 namespace GraphQL.Query.Builder
 {
diff --git a/src/GraphQL.Query.Builder/QueryOf{T}.cs b/src/GraphQL.Query.Builder/QueryOf{T}.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections.Generic;
 using System.Linq.Expressions;
 using System.Reflection;
diff --git a/src/GraphQL.Query.Builder/QueryOptions.cs b/src/GraphQL.Query.Builder/QueryOptions.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 
 namespace GraphQL.Query.Builder
 {
diff --git a/src/GraphQL.Query.Builder/QueryStringBuilder.cs b/src/GraphQL.Query.Builder/QueryStringBuilder.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections;
 using System.Collections.Generic;
 using System.Globalization;
@@ -25,13 +25,14 @@ public void Clear()
         /// Formats query param.
         /// 
         /// Returns:
-        /// - String: `"value"`
+        /// - String: `"foo"`
         /// - Number: `10`
-        /// - Boolean: `true` / `false`
+        /// - Boolean: `true` or `false`
         /// - Enum: `EnumValue`
-        /// - Key value pair: `key:"value"` / `key:10`
-        /// - List: `["value1","value2"]` / `[1,2]`
-        /// - Dictionary: `{a:"value",b:10}`
+        /// - DateTime: `"2022-06-15T13:45:30.0000000Z"`
+        /// - Key value pair: `foo:"bar"` or `foo:10` ...
+        /// - List: `["foo","bar"]` or `[1,2]` ...
+        /// - Dictionary: `{foo:"bar",b:10}`
         /// </summary>
         /// <param name="value"></param>
         /// <returns>The formatted query param.</returns>
@@ -82,6 +83,9 @@ internal protected virtual string FormatQueryParam(object value)
                 case Enum enumValue:
                     return enumValue.ToString();
 
+                case DateTime dateTimeValue:
+                    return FormatQueryParam(dateTimeValue.ToString("o"));
+
                 case KeyValuePair<string, object> kvValue:
                     return $"{kvValue.Key}:{FormatQueryParam(kvValue.Value)}";
 
diff --git a/tests/GraphQL.Query.Builder.UnitTests/CustomQueryStringBuilderTests.cs b/tests/GraphQL.Query.Builder.UnitTests/CustomQueryStringBuilderTests.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Text;
 using Xunit;
 
diff --git a/tests/GraphQL.Query.Builder.UnitTests/GraphQL.Query.Builder.UnitTests.csproj b/tests/GraphQL.Query.Builder.UnitTests/GraphQL.Query.Builder.UnitTests.csproj
@@ -1,8 +1,8 @@
-﻿<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net5</TargetFramework>
-    <LangVersion>9.0</LangVersion>
+    <TargetFramework>net6.0</TargetFramework>
+    <LangVersion>latest</LangVersion>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
diff --git a/tests/GraphQL.Query.Builder.UnitTests/QueryStringBuilderTests.cs b/tests/GraphQL.Query.Builder.UnitTests/QueryStringBuilderTests.cs
@@ -1,4 +1,5 @@
-﻿using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using GraphQL.Query.Builder.UnitTests.Models;
 using Xunit;
 
@@ -141,6 +142,13 @@ public void TestFormatQueryParam_enum()
             Assert.Equal("DISABLED", new QueryStringBuilder().FormatQueryParam(value));
         }
 
+        [Fact]
+        public void TestFormatQueryParam_date()
+        {
+            DateTime value = new DateTime(2022, 3, 30);
+            Assert.Equal("\"2022-03-30T00:00:00.0000000\"", new QueryStringBuilder().FormatQueryParam(value));
+        }
+
         [Fact]
         public void TestFormatQueryParam_keyvaluepair()
         {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-`
	`1`	`+`
`2`	`2`	`Microsoft Visual Studio Solution File, Format Version 12.00`
`3`	`3`	`# Visual Studio 15`
`4`	`4`	`VisualStudioVersion = 15.0.26124.0`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-using System;`
	`1`	`+using System;`
`2`	`2`	`using System.Collections.Generic;`
`3`	`3`	`using System.Linq.Expressions;`
`4`	`4`