Skip to content

Commit dad7c4c

Browse files
xuzhgxuzhg
authored
Support DateOnly and TimeOnly (#450)
* Support DateOnly and TimeOnly * Update the nuget nuspec to include .NET 6 target framework * Resolve review comment. Thanks @juliano Leal Goncalves
1 parent b3b2e3d commit dad7c4c

17 files changed

+627
-16
lines changed

‎src/Microsoft.AspNetCore.OData.Nightly.nuspec

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<package>
33
<metadata>
44
<id>Microsoft.AspNetCore.OData</id>
5-
<title>Microsoft ASP.NET Core 3.x and 5.x for OData v4.0</title>
5+
<title>Microsoft ASP.NET Core 3.x, 5.x and 6.x for OData v4.0</title>
66
<version>$VersionFullSemantic$-Nightly$NightlyBuildVersion$</version>
77
<authors>OData (.NET Foundation)</authors>
88
<copyright>&#169; .NET Foundation and Contributors. All rights reserved.</copyright>
@@ -28,6 +28,12 @@
2828
<dependency id="Microsoft.OData.Edm" version="$ODataLibPackageDependency$" />
2929
<dependency id="Microsoft.Spatial" version="$ODataLibPackageDependency$" />
3030
</group>
31+
<group targetFramework=".net6.0">
32+
<dependency id="Microsoft.OData.ModelBuilder" version="$ODataModelBuilderPackageDependency$" />
33+
<dependency id="Microsoft.OData.Core" version="$ODataLibPackageDependency$" />
34+
<dependency id="Microsoft.OData.Edm" version="$ODataLibPackageDependency$" />
35+
<dependency id="Microsoft.Spatial" version="$ODataLibPackageDependency$" />
36+
</group>
3137
</dependencies>
3238
</metadata>
3339
<files>
@@ -37,6 +43,9 @@
3743
<file src="$ProductRoot$\net5.0\Microsoft.AspNetCore.OData.dll" target="lib\net5.0" />
3844
<file src="$ProductRoot$\net5.0\Microsoft.AspNetCore.OData.xml" target="lib\net5.0" />
3945
<file src="$ProductRoot$\net5.0\Microsoft.AspNetCore.OData.pdb" target="lib\net5.0" />
46+
<file src="$ProductRoot$\net6.0\Microsoft.AspNetCore.OData.dll" target="lib\net6.0" />
47+
<file src="$ProductRoot$\net6.0\Microsoft.AspNetCore.OData.xml" target="lib\net6.0" />
48+
<file src="$ProductRoot$\net6.0\Microsoft.AspNetCore.OData.pdb" target="lib\net6.0" />
4049
<file src="$SourcesRoot$\images\odata.png" target="images\" />
4150
</files>
4251
</package>

‎src/Microsoft.AspNetCore.OData.Release.nuspec

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<package>
33
<metadata>
44
<id>Microsoft.AspNetCore.OData</id>
5-
<title>Microsoft ASP.NET Core 3.x and 5.x for OData v4.0</title>
5+
<title>Microsoft ASP.NET Core 3.x, 5.x and 6.x for OData v4.0</title>
66
<version>$VersionNuGetSemantic$</version>
77
<authors>OData (.NET Foundation)</authors>
88
<copyright>&#169; .NET Foundation and Contributors. All rights reserved.</copyright>
@@ -22,7 +22,13 @@
2222
<dependency id="Microsoft.OData.Edm" version="$ODataLibPackageDependency$" />
2323
<dependency id="Microsoft.Spatial" version="$ODataLibPackageDependency$" />
2424
</group>
25-
<group targetFramework=".net5.0">
25+
<group targetFramework=".net5.0">
26+
<dependency id="Microsoft.OData.ModelBuilder" version="$ODataModelBuilderPackageDependency$" />
27+
<dependency id="Microsoft.OData.Core" version="$ODataLibPackageDependency$" />
28+
<dependency id="Microsoft.OData.Edm" version="$ODataLibPackageDependency$" />
29+
<dependency id="Microsoft.Spatial" version="$ODataLibPackageDependency$" />
30+
</group>
31+
<group targetFramework=".net6.0">
2632
<dependency id="Microsoft.OData.ModelBuilder" version="$ODataModelBuilderPackageDependency$" />
2733
<dependency id="Microsoft.OData.Core" version="$ODataLibPackageDependency$" />
2834
<dependency id="Microsoft.OData.Edm" version="$ODataLibPackageDependency$" />
@@ -37,6 +43,9 @@
3743
<file src="$ProductRoot$\net5.0\Microsoft.AspNetCore.OData.dll" target="lib\net5.0" />
3844
<file src="$ProductRoot$\net5.0\Microsoft.AspNetCore.OData.xml" target="lib\net5.0" />
3945
<file src="$ProductRoot$\net5.0\Microsoft.AspNetCore.OData.pdb" target="lib\net5.0" />
46+
<file src="$ProductRoot$\net6.0\Microsoft.AspNetCore.OData.dll" target="lib\net6.0" />
47+
<file src="$ProductRoot$\net6.0\Microsoft.AspNetCore.OData.xml" target="lib\net6.0" />
48+
<file src="$ProductRoot$\net6.0\Microsoft.AspNetCore.OData.pdb" target="lib\net6.0" />
4049
<file src="$SourcesRoot$\images\odata.png" target="images\" />
4150
</files>
4251
</package>

‎src/Microsoft.AspNetCore.OData/Common/TypeHelper.cs

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,30 @@ public static bool IsDateTime(Type clrType)
9090
return Type.GetTypeCode(underlyingTypeOrSelf) == TypeCode.DateTime;
9191
}
9292

93+
#if NET6_0
94+
/// <summary>
95+
/// Determine if a type is a <see cref="DateOnly"/>.
96+
/// </summary>
97+
/// <param name="clrType">The type to test.</param>
98+
/// <returns>True if the type is a DateOnly; false otherwise.</returns>
99+
public static bool IsDateOnly(this Type clrType)
100+
{
101+
Type underlyingTypeOrSelf = GetUnderlyingTypeOrSelf(clrType);
102+
return underlyingTypeOrSelf == typeof(DateOnly);
103+
}
104+
105+
/// <summary>
106+
/// Determine if a type is a <see cref="TimeOnly"/>.
107+
/// </summary>
108+
/// <param name="clrType">The type to test.</param>
109+
/// <returns>True if the type is a TimeOnly; false otherwise.</returns>
110+
public static bool IsTimeOnly(this Type clrType)
111+
{
112+
Type underlyingTypeOrSelf = GetUnderlyingTypeOrSelf(clrType);
113+
return underlyingTypeOrSelf == typeof(TimeOnly);
114+
}
115+
#endif
116+
93117
/// <summary>
94118
/// Determine if a type is a TimeSpan.
95119
/// </summary>

‎src/Microsoft.AspNetCore.OData/Edm/DefaultODataTypeMapper.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,13 @@ static DefaultODataTypeMapper()
111111
BuildTypeMapping<char>(EdmPrimitiveTypeKind.String, isStandard: false);
112112
BuildTypeMapping<DateTime?>(EdmPrimitiveTypeKind.DateTimeOffset, isStandard: false);
113113
BuildTypeMapping<DateTime>(EdmPrimitiveTypeKind.DateTimeOffset, isStandard: false);
114+
115+
#if NET6_0
116+
BuildTypeMapping<DateOnly?>(EdmPrimitiveTypeKind.Date, isStandard: false);
117+
BuildTypeMapping<DateOnly>(EdmPrimitiveTypeKind.Date, isStandard: false);
118+
BuildTypeMapping<TimeOnly?>(EdmPrimitiveTypeKind.TimeOfDay, isStandard: false);
119+
BuildTypeMapping<TimeOnly>(EdmPrimitiveTypeKind.TimeOfDay, isStandard: false);
120+
#endif
114121
}
115122
#endregion
116123

‎src/Microsoft.AspNetCore.OData/Edm/EdmPrimitiveHelper.cs

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,26 @@ public static object ConvertPrimitiveValue(object value, Type type, TimeZoneInfo
137137

138138
throw new ValidationException(Error.Format(SRResources.PropertyMustBeBoolean));
139139
}
140+
#if NET6_0
141+
else if (type == typeof(DateOnly))
142+
{
143+
if (value is Date dt)
144+
{
145+
return new DateOnly(dt.Year, dt.Month, dt.Day);
146+
}
147+
148+
throw new ValidationException(Error.Format(SRResources.PropertyMustBeDateTimeOffsetOrDate));
149+
}
150+
else if (type == typeof(TimeOnly))
151+
{
152+
if (value is TimeOfDay tod)
153+
{
154+
return new TimeOnly(tod.Hours, tod.Minutes, tod.Seconds, (int)tod.Milliseconds);
155+
}
156+
157+
throw new ValidationException(Error.Format(SRResources.PropertyMustBeTimeOfDay));
158+
}
159+
#endif
140160
else
141161
{
142162
if (TypeHelper.TryGetInstance(type, value, out var result))

‎src/Microsoft.AspNetCore.OData/Extensions/SerializableErrorExtensions.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
using System;
99
using System.Collections.Generic;
1010
using System.ComponentModel;
11+
using System.Diagnostics.CodeAnalysis;
12+
using System.Globalization;
1113
using System.Linq;
1214
using System.Text;
1315
using Microsoft.AspNetCore.Mvc;
@@ -102,6 +104,7 @@ private static ODataInnerError ToODataInnerError(this Dictionary<string, object>
102104

103105
// Convert the model state errors in to a string (for debugging only).
104106
// This should be improved once ODataError allows more details.
107+
[SuppressMessage("Globalization", "CA1305:Specify IFormatProvider", Justification = "The default format provider is fine here.")]
105108
private static string ConvertModelStateErrors(this IReadOnlyDictionary<string, object> errors)
106109
{
107110
StringBuilder builder = new StringBuilder();

‎src/Microsoft.AspNetCore.OData/Formatter/Serialization/ODataPrimitiveSerializer.cs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,22 @@ internal static object ConvertPrimitiveValue(object value, IEdmPrimitiveTypeRefe
144144
return tod;
145145
}
146146

147+
#if NET6_0
148+
// Since ODL doesn't support "DateOnly", we have to use Date defined in ODL.
149+
if (primitiveType != null && primitiveType.IsDate() && TypeHelper.IsDateOnly(type))
150+
{
151+
DateOnly dateOnly = (DateOnly)value;
152+
return new Date(dateOnly.Year, dateOnly.Month, dateOnly.Day);
153+
}
154+
155+
// Since ODL doesn't support "TimeOnly", we have to use TimeOfDay defined in ODL.
156+
if (primitiveType != null && primitiveType.IsTimeOfDay() && TypeHelper.IsTimeOnly(type))
157+
{
158+
TimeOnly timeOnly = (TimeOnly)value;
159+
return new TimeOfDay(timeOnly.Hour, timeOnly.Minute, timeOnly.Second, timeOnly.Millisecond);
160+
}
161+
#endif
162+
147163
return ConvertUnsupportedPrimitives(value, timeZoneInfo);
148164
}
149165

‎src/Microsoft.AspNetCore.OData/Microsoft.AspNetCore.OData.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<Project Sdk="Microsoft.NET.Sdk.Web">
22

33
<PropertyGroup>
4-
<TargetFrameworks>netcoreapp3.1;net5.0</TargetFrameworks>
4+
<TargetFrameworks>netcoreapp3.1;net5.0;net6.0</TargetFrameworks>
55
<RootNamespace>Microsoft.AspNetCore.OData</RootNamespace>
66
<DocumentationFile>$(OutputPath)$(AssemblyName).xml</DocumentationFile>
77
<NoDefaultLaunchSettingsFile>true</NoDefaultLaunchSettingsFile>

‎src/Microsoft.AspNetCore.OData/Microsoft.AspNetCore.OData.xml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1089,6 +1089,20 @@
10891089
<param name="clrType">The type to test.</param>
10901090
<returns>True if the type is a DateTime; false otherwise.</returns>
10911091
</member>
1092+
<member name="M:Microsoft.AspNetCore.OData.Common.TypeHelper.IsDateOnly(System.Type)">
1093+
<summary>
1094+
Determine if a type is a <see cref="T:System.DateOnly"/>.
1095+
</summary>
1096+
<param name="clrType">The type to test.</param>
1097+
<returns>True if the type is a DateOnly; false otherwise.</returns>
1098+
</member>
1099+
<member name="M:Microsoft.AspNetCore.OData.Common.TypeHelper.IsTimeOnly(System.Type)">
1100+
<summary>
1101+
Determine if a type is a <see cref="T:System.TimeOnly"/>.
1102+
</summary>
1103+
<param name="clrType">The type to test.</param>
1104+
<returns>True if the type is a TimeOnly; false otherwise.</returns>
1105+
</member>
10921106
<member name="M:Microsoft.AspNetCore.OData.Common.TypeHelper.IsTimeSpan(System.Type)">
10931107
<summary>
10941108
Determine if a type is a TimeSpan.

‎src/Microsoft.AspNetCore.OData/Query/ClrCanonicalFunctions.cs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,25 @@ internal class ClrCanonicalFunctions
121121
new KeyValuePair<string, PropertyInfo>(MillisecondFunctionName, typeof(TimeOfDay).GetProperty("Milliseconds")),
122122
}.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
123123

124+
#if NET6_0
125+
// DateOnly properties
126+
public static readonly Dictionary<string, PropertyInfo> DateOnlyProperties = new Dictionary<string, PropertyInfo>
127+
{
128+
{ YearFunctionName, typeof(DateOnly).GetProperty(nameof(DateOnly.Year)) },
129+
{ MonthFunctionName, typeof(DateOnly).GetProperty(nameof(DateOnly.Month)) },
130+
{ DayFunctionName, typeof(DateOnly).GetProperty(nameof(DateOnly.Day)) }
131+
};
132+
133+
// TimeOnly properties
134+
public static readonly Dictionary<string, PropertyInfo> TimeOnlyProperties = new Dictionary<string, PropertyInfo>
135+
{
136+
{ HourFunctionName, typeof(TimeOnly).GetProperty(nameof(TimeOnly.Hour)) },
137+
{ MinuteFunctionName, typeof(TimeOnly).GetProperty(nameof(TimeOnly.Minute)) },
138+
{ SecondFunctionName, typeof(TimeOnly).GetProperty(nameof(TimeOnly.Second)) },
139+
{ MillisecondFunctionName, typeof(TimeOnly).GetProperty(nameof(TimeOnly.Millisecond)) }
140+
};
141+
#endif
142+
124143
// TimeSpan properties
125144
public static readonly Dictionary<string, PropertyInfo> TimeSpanProperties = new[]
126145
{

0 commit comments

Comments
 (0)