Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

291 Added backwards compatibility #303

Merged
merged 2 commits into from
Nov 9, 2023
Merged

291 Added backwards compatibility #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf1e382
291 Added backwards compatibility
Marvin-Brouwer Oct 18, 2023
0ccbad8
Merge branch 'main' into 291-caller-argument-expression-net6
ardalis Nov 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/GuardClauses/CompilerFixes/CallerArgumentExpressionAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#if NETSTANDARD2_1

namespace System.Runtime.CompilerServices;

/// <summary>
/// This a special exception for backwards compatibility.
/// Please upgrade your dependent package to the latest supported netN.N version rather than using netstandard2.1
/// </summary>
[AttributeUsage(AttributeTargets.Parameter, AllowMultiple = false, Inherited = false)]
internal sealed class CallerArgumentExpressionAttribute : Attribute
{
public CallerArgumentExpressionAttribute(string parameterName)
{
ParameterName = parameterName;
}

public string ParameterName { get; }
}

#endif
28 changes: 14 additions & 14 deletions src/GuardClauses/GuardAgainstNegativeExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public static partial class GuardClauseExtensions
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not negative.</returns>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static int Negative(this IGuardClause guardClause,
int input,
string parameterName,
Expand All @@ -38,7 +38,7 @@ public static int Negative(this IGuardClause guardClause,
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not negative.</returns>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static long Negative(this IGuardClause guardClause,
long input,
string parameterName,
Expand All @@ -62,7 +62,7 @@ public static long Negative(this IGuardClause guardClause,
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not negative.</returns>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static decimal Negative(this IGuardClause guardClause,
decimal input,
string parameterName,
Expand All @@ -86,7 +86,7 @@ public static decimal Negative(this IGuardClause guardClause,
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not negative.</returns>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static float Negative(IGuardClause guardClause,
float input,
string parameterName,
Expand All @@ -110,7 +110,7 @@ public static float Negative(this IGuardClause guardClause,
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not negative.</returns>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static double Negative(this IGuardClause guardClause,
double input,
string parameterName,
Expand All @@ -134,7 +134,7 @@ public static double Negative(this IGuardClause guardClause,
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not negative.</returns>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static TimeSpan Negative(this IGuardClause guardClause,
TimeSpan input,
string parameterName,
Expand All @@ -158,7 +158,7 @@ public static TimeSpan Negative(this IGuardClause guardClause,
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not negative.</returns>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
private static T Negative<T>(this IGuardClause guardClause,
T input,
string parameterName,
Expand Down Expand Up @@ -186,7 +186,7 @@ private static T Negative<T>(this IGuardClause guardClause,
/// <param name="parameterName"></param>
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not negative or zero.</returns>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static int NegativeOrZero(this IGuardClause guardClause,
int input,
string parameterName,
Expand All @@ -209,7 +209,7 @@ public static int NegativeOrZero(this IGuardClause guardClause,
/// <param name="parameterName"></param>
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not negative or zero.</returns>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static long NegativeOrZero(this IGuardClause guardClause,
long input,
string parameterName,
Expand All @@ -232,7 +232,7 @@ public static long NegativeOrZero(this IGuardClause guardClause,
/// <param name="parameterName"></param>
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not negative or zero.</returns>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static decimal NegativeOrZero(this IGuardClause guardClause,
decimal input,
string parameterName,
Expand All @@ -255,7 +255,7 @@ public static decimal NegativeOrZero(this IGuardClause guardClause,
/// <param name="parameterName"></param>
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not negative or zero.</returns>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static float NegativeOrZero(this IGuardClause guardClause,
float input,
string parameterName,
Expand All @@ -278,7 +278,7 @@ public static float NegativeOrZero(this IGuardClause guardClause,
/// <param name="parameterName"></param>
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not negative or zero.</returns>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static double NegativeOrZero(this IGuardClause guardClause,
double input,
string parameterName,
Expand All @@ -301,7 +301,7 @@ public static double NegativeOrZero(this IGuardClause guardClause,
/// <param name="parameterName"></param>
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not negative or zero.</returns>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static TimeSpan NegativeOrZero(this IGuardClause guardClause,
TimeSpan input,
string parameterName,
Expand All @@ -325,7 +325,7 @@ public static TimeSpan NegativeOrZero(this IGuardClause guardClause,
/// <param name="parameterName"></param>
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not negative or zero.</returns>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
private static T NegativeOrZero<T>(this IGuardClause guardClause,
T input,
string parameterName,
Expand Down
4 changes: 2 additions & 2 deletions src/GuardClauses/GuardAgainstNotFoundExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public static partial class GuardClauseExtensions
/// <param name="parameterName"></param>
/// <returns><paramref name="input" /> if the value is not null.</returns>
/// <exception cref="NotFoundException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static T NotFound<T>(this IGuardClause guardClause,
[NotNull][ValidatedNotNull] string key,
[NotNull][ValidatedNotNull] T? input,
Expand Down Expand Up @@ -48,7 +48,7 @@ public static T NotFound<T>(this IGuardClause guardClause,
/// <param name="parameterName"></param>
/// <returns><paramref name="input" /> if the value is not null.</returns>
/// <exception cref="NotFoundException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static T NotFound<TKey, T>(this IGuardClause guardClause,
[NotNull][ValidatedNotNull] TKey key,
[NotNull][ValidatedNotNull] T? input,
Expand Down
16 changes: 8 additions & 8 deletions src/GuardClauses/GuardAgainstNullExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public static partial class GuardClauseExtensions
/// <param name="parameterName"></param>
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not null.</returns>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static T Null<T>(this IGuardClause guardClause,
[NotNull][ValidatedNotNull] T? input,
string parameterName,
Expand Down Expand Up @@ -56,7 +56,7 @@ public static T Null<T>(this IGuardClause guardClause,
/// <param name="parameterName"></param>
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not null.</returns>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static T Null<T>(this IGuardClause guardClause,
[NotNull][ValidatedNotNull] T? input,
string parameterName,
Expand Down Expand Up @@ -91,7 +91,7 @@ public static T Null<T>(this IGuardClause guardClause,
/// <returns><paramref name="input" /> if the value is not an empty string or null.</returns>
/// <exception cref="ArgumentNullException"></exception>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static string NullOrEmpty(this IGuardClause guardClause,
[NotNull][ValidatedNotNull] string? input,
string parameterName,
Expand Down Expand Up @@ -123,7 +123,7 @@ public static string NullOrEmpty(this IGuardClause guardClause,
/// <returns><paramref name="input" /> if the value is not an empty guid or null.</returns>
/// <exception cref="ArgumentNullException"></exception>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static Guid NullOrEmpty(this IGuardClause guardClause,
[NotNull][ValidatedNotNull] Guid? input,
string parameterName,
Expand Down Expand Up @@ -155,7 +155,7 @@ public static Guid NullOrEmpty(this IGuardClause guardClause,
/// <returns><paramref name="input" /> if the value is not an empty enumerable or null.</returns>
/// <exception cref="ArgumentNullException"></exception>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static IEnumerable<T> NullOrEmpty<T>(this IGuardClause guardClause,
[NotNull][ValidatedNotNull] IEnumerable<T>? input,
string parameterName,
Expand Down Expand Up @@ -187,7 +187,7 @@ public static IEnumerable<T> NullOrEmpty<T>(this IGuardClause guardClause,
/// <returns><paramref name="input" /> if the value is not an empty or whitespace string.</returns>
/// <exception cref="ArgumentNullException"></exception>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static string NullOrWhiteSpace(this IGuardClause guardClause,
[NotNull][ValidatedNotNull] string? input,
string parameterName,
Expand Down Expand Up @@ -217,7 +217,7 @@ public static string NullOrWhiteSpace(this IGuardClause guardClause,
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not default for that type.</returns>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static T Default<T>(this IGuardClause guardClause,
[AllowNull, NotNull] T input,
string parameterName,
Expand Down Expand Up @@ -251,7 +251,7 @@ public static T Default<T>(this IGuardClause guardClause,
/// <returns></returns>
/// <exception cref="ArgumentException"></exception>
/// <exception cref="ArgumentNullException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static T NullOrInvalidInput<T>(this IGuardClause guardClause,
[NotNull] T? input,
string parameterName,
Expand Down
8 changes: 4 additions & 4 deletions src/GuardClauses/GuardAgainstOutOfRangeExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not out of range.</returns>
/// <exception cref="InvalidEnumArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static int EnumOutOfRange<T>(this IGuardClause guardClause,
int input,
string parameterName,
Expand Down Expand Up @@ -53,7 +53,7 @@
/// /// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not out of range.</returns>
/// <exception cref="InvalidEnumArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static T EnumOutOfRange<T>(this IGuardClause guardClause,
T input,
string parameterName,
Expand Down Expand Up @@ -123,7 +123,7 @@
/// <returns><paramref name="input" /> if the value is in the range of valid SqlDateTime values.</returns>
/// <exception cref="ArgumentNullException"></exception>
/// <exception cref="ArgumentOutOfRangeException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static DateTime NullOrOutOfSQLDateRange(this IGuardClause guardClause,
[NotNull][ValidatedNotNull] DateTime? input,
string parameterName,
Expand All @@ -131,7 +131,7 @@
#else
public static DateTime NullOrOutOfSQLDateRange(this IGuardClause guardClause,
[NotNull][ValidatedNotNull] DateTime? input,
[CallerArgumentExpression("input")] string parameterName = null,

Check warning on line 134 in src/GuardClauses/GuardAgainstOutOfRangeExtensions.cs

View workflow job for this annotation

GitHub Actions / build 

Cannot convert null literal to non-nullable reference type.

Check warning on line 134 in src/GuardClauses/GuardAgainstOutOfRangeExtensions.cs

View workflow job for this annotation

GitHub Actions / build 

Cannot convert null literal to non-nullable reference type.
string? message = null)
#endif
{
Expand All @@ -148,7 +148,7 @@
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is in the range of valid SqlDateTime values.</returns>
/// <exception cref="ArgumentOutOfRangeException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static DateTime OutOfSQLDateRange(this IGuardClause guardClause,
DateTime input,
string parameterName,
Expand Down
12 changes: 6 additions & 6 deletions src/GuardClauses/GuardAgainstZeroExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public static partial class GuardClauseExtensions
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not zero.</returns>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static int Zero(this IGuardClause guardClause,
int input,
string parameterName,
Expand All @@ -39,7 +39,7 @@ public static int Zero(this IGuardClause guardClause,
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not zero.</returns>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static long Zero(this IGuardClause guardClause,
long input,
string parameterName,
Expand All @@ -63,7 +63,7 @@ public static long Zero(this IGuardClause guardClause,
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not zero.</returns>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static decimal Zero(this IGuardClause guardClause,
decimal input,
string parameterName,
Expand All @@ -87,7 +87,7 @@ public static decimal Zero(this IGuardClause guardClause,
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not zero.</returns>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static float Zero(this IGuardClause guardClause,
float input,
string parameterName,
Expand All @@ -111,7 +111,7 @@ public static float Zero(this IGuardClause guardClause,
/// <param name="message">Optional. Custom error message</param>
/// <returns><paramref name="input" /> if the value is not zero.</returns>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static double Zero(this IGuardClause guardClause,
double input,
string parameterName,
Expand All @@ -134,7 +134,7 @@ public static double Zero(this IGuardClause guardClause,
/// <param name="parameterName"></param>
/// <returns><paramref name="input" /> if the value is not zero.</returns>
/// <exception cref="ArgumentException"></exception>
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static TimeSpan Zero(this IGuardClause guardClause,
TimeSpan input,
string parameterName)
Expand Down
15 changes: 3 additions & 12 deletions src/GuardClauses/GuardClauses.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<None Include="..\..\LICENSE" Pack="true" PackagePath="" />
</ItemGroup>
<PropertyGroup>
<TargetFrameworks>netstandard2.0;net7.0</TargetFrameworks>
<TargetFrameworks>net7.0;netstandard2.1;netstandard2.0</TargetFrameworks>
<PackageId>Ardalis.GuardClauses</PackageId>
<Title>Ardalis.GuardClauses</Title>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
Expand All @@ -18,18 +18,9 @@
<RepositoryUrl>https://github.com/ardalis/guardclauses</RepositoryUrl>
<PackageTags>guard clause clauses assert assertion</PackageTags>
<PackageReleaseNotes>
* Implemented NullOrInvalidInput method by @tiagojsrios in https://github.com/ardalis/GuardClauses/pull/178
* Embed license in nuget package by @jafin in https://github.com/ardalis/GuardClauses/pull/208
* Remove JetBrains Annotations by @Coop56 in https://github.com/ardalis/GuardClauses/pull/236
* Add NullOrEmpty and NullOrWhiteSpace overloads for ReadOnlySpan by @KonH in https://github.com/ardalis/GuardClauses/pull/237
* Created async overload for clausules that use a predicate by @danny-bos-developer in https://github.com/ardalis/GuardClauses/pull/228
* Working through build issues for new contributors by @sadukie in https://github.com/ardalis/GuardClauses/pull/265
* Make type parameter T of the Null() method nullable and add overload for value types. by @amal-stack in https://github.com/ardalis/GuardClauses/pull/261
* Upgrade to dotnet 7.0 by @amal-stack in https://github.com/ardalis/GuardClauses/pull/282
* Adds `NullOrOutOfRange` clauses, adding support for nullable classes/structs to `OutOfRange` by @rafaelsc in https://github.com/ardalis/GuardClauses/pull/143
* Add README file to package
* Added netstandard2.1 to TargetFrameworks for backwards compatibility
</PackageReleaseNotes>
<Version>4.1.1</Version>
<Version>4.1.2</Version>
<AssemblyName>Ardalis.GuardClauses</AssemblyName>
<PackageIcon>icon.png</PackageIcon>
<PublishRepositoryUrl>true</PublishRepositoryUrl>
Expand Down
2 changes: 1 addition & 1 deletion test/GuardClauses.UnitTests/NamespaceSeparate/ExtendingGuard.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace Ardalis.GuardClauses;
/// </summary>
public static class FooGuard
{
#if NETSTANDARD || NETFRAMEWORK
#if NETFRAMEWORK || NETSTANDARD2_0
public static void Foo(this IGuardClause guardClause, string input, string parameterName)
#else
public static void Foo(this IGuardClause guardClause, string input, [CallerArgumentExpression("input")] string? parameterName = null)
Expand Down