From 20aef1b6da6ec581b2402a2ed648c63baf225172 Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Sun, 18 Aug 2019 17:04:35 +0200 Subject: [PATCH 01/12] [SL.Core] Extend Guard and DebugGuard --- src/SixLabors.Core/Helpers/DebugGuard.cs | 217 ++++++++++++++++-- src/SixLabors.Core/Helpers/Guard.cs | 217 ++++++++++++++++-- .../Helpers/GuardTests.cs | 102 +++++++- 3 files changed, 484 insertions(+), 52 deletions(-) diff --git a/src/SixLabors.Core/Helpers/DebugGuard.cs b/src/SixLabors.Core/Helpers/DebugGuard.cs index bfc2a7a8d6..c7fb796b3d 100644 --- a/src/SixLabors.Core/Helpers/DebugGuard.cs +++ b/src/SixLabors.Core/Helpers/DebugGuard.cs @@ -3,6 +3,7 @@ using System; using System.Diagnostics; +using System.Runtime.CompilerServices; namespace SixLabors { @@ -13,26 +14,47 @@ namespace SixLabors internal static class DebugGuard { /// - /// Verifies, that the method parameter with specified object value is not null - /// and throws an exception if it is found to be so. + /// Ensures that the value is not null. /// - /// The target object, which cannot be null. + /// The target object, which cannot be null. /// The name of the parameter that is to be checked. - /// is null. - /// The type of the object to verify. + /// The type of the value. + /// is null. [Conditional("DEBUG")] - public static void NotNull(T target, string parameterName) - where T : class + [DebuggerStepThrough] + public static void NotNull(TValue value, string parameterName) + where TValue : class { - if (target is null) + if (value is null) { - throw new ArgumentNullException(parameterName); + ThrowArgumentNullException(parameterName); } } /// - /// Verifies that the specified value is less than a maximum value - /// and throws an exception if it is not. + /// Ensures that the target value is not null, empty, or whitespace. + /// + /// The target string, which should be checked against being null or empty. + /// Name of the parameter. + /// is null. + /// is empty or contains only blanks. + [Conditional("DEBUG")] + [DebuggerStepThrough] + public static void NotNullOrWhiteSpace(string value, string parameterName) + { + if (value is null) + { + ThrowArgumentNullException(parameterName); + } + + if (string.IsNullOrWhiteSpace(value)) + { + ThrowArgumentException("Must not be empty or whitespace.", parameterName); + } + } + + /// + /// Ensures that the specified value is less than a maximum value. /// /// The target value, which should be validated. /// The maximum value. @@ -42,12 +64,13 @@ namespace SixLabors /// is greater than the maximum value. /// [Conditional("DEBUG")] + [DebuggerStepThrough] public static void MustBeLessThan(TValue value, TValue max, string parameterName) where TValue : IComparable { if (value.CompareTo(max) >= 0) { - throw new ArgumentOutOfRangeException(parameterName, $"Value must be less than {max}."); + ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be less than {max}."); } } @@ -63,12 +86,13 @@ namespace SixLabors /// is greater than the maximum value. /// [Conditional("DEBUG")] + [DebuggerStepThrough] public static void MustBeLessThanOrEqualTo(TValue value, TValue max, string parameterName) where TValue : IComparable { if (value.CompareTo(max) > 0) { - throw new ArgumentOutOfRangeException(parameterName, $"Value must be less than or equal to {max}."); + ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be less than or equal to {max}."); } } @@ -84,14 +108,15 @@ namespace SixLabors /// is less than the minimum value. /// [Conditional("DEBUG")] + [DebuggerStepThrough] public static void MustBeGreaterThan(TValue value, TValue min, string parameterName) where TValue : IComparable { if (value.CompareTo(min) <= 0) { - throw new ArgumentOutOfRangeException( + ThrowArgumentOutOfRangeException( parameterName, - $"Value must be greater than {min}."); + $"Value {value} must be greater than {min}."); } } @@ -107,33 +132,177 @@ namespace SixLabors /// is less than the minimum value. /// [Conditional("DEBUG")] + [DebuggerStepThrough] public static void MustBeGreaterThanOrEqualTo(TValue value, TValue min, string parameterName) where TValue : IComparable { if (value.CompareTo(min) < 0) { - throw new ArgumentOutOfRangeException(parameterName, $"Value must be greater than or equal to {min}."); + ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be greater than or equal to {min}."); } } /// - /// Verifies, that the `target` array has declared the length or longer. + /// Verifies that the specified value is greater than or equal to a minimum value and less than + /// or equal to a maximum value and throws an exception if it is not. /// - /// The element type of the spans. - /// The target array. - /// The min length the array must have. + /// The target value, which should be validated. + /// The minimum value. + /// The maximum value. /// The name of the parameter that is to be checked. + /// The type of the value. + /// + /// is less than the minimum value of greater than the maximum value. + /// + [Conditional("DEBUG")] + [DebuggerStepThrough] + public static void MustBeBetweenOrEqualTo(TValue value, TValue min, TValue max, string parameterName) + where TValue : IComparable + { + if (value.CompareTo(min) < 0 || value.CompareTo(max) > 0) + { + ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be greater than or equal to {min} and less than or equal to {max}."); + } + } + + /// + /// Verifies, that the method parameter with specified target value is true + /// and throws an exception if it is found to be so. + /// + /// The target value, which cannot be false. + /// The name of the parameter that is to be checked. + /// The error message, if any to add to the exception. + /// + /// is false. + /// + [Conditional("DEBUG")] + [DebuggerStepThrough] + public static void IsTrue(bool target, string parameterName, string message) + { + if (!target) + { + ThrowArgumentException(message, parameterName); + } + } + + /// + /// Verifies, that the method parameter with specified target value is false + /// and throws an exception if it is found to be so. + /// + /// The target value, which cannot be true. + /// The name of the parameter that is to be checked. + /// The error message, if any to add to the exception. /// /// is true. /// [Conditional("DEBUG")] - public static void MustBeSizedAtLeast(T[] target, int minLength, string parameterName) - where T : struct + [DebuggerStepThrough] + public static void IsFalse(bool target, string parameterName, string message) { - if (target.Length < minLength) + if (target) { - throw new ArgumentException($"The size must be at least {minLength}.", parameterName); + ThrowArgumentException(message, parameterName); } } + + /// + /// Verifies, that the `source` span has the length of 'minLength', or longer. + /// + /// The element type of the spans. + /// The source span. + /// The minimum length. + /// The name of the parameter that is to be checked. + /// + /// has less than items. + /// + [Conditional("DEBUG")] + [DebuggerStepThrough] + public static void MustBeSizedAtLeast(ReadOnlySpan source, int minLength, string parameterName) + { + if (source.Length < minLength) + { + ThrowArgumentException($"Span-s must be at least of length {minLength}!", parameterName); + } + } + + /// + /// Verifies that the 'destination' span is not shorter than 'source'. + /// + /// The source element type. + /// The destination element type. + /// The source span. + /// The destination span. + /// The name of the argument for 'destination'. + [Conditional("DEBUG")] + [DebuggerStepThrough] + public static void DestinationShouldNotBeTooShort( + ReadOnlySpan source, + Span destination, + string destinationParamName) + { + if (destination.Length < source.Length) + { + ThrowArgumentException($"Destination span is too short!", destinationParamName); + } + } + + /// + /// Verifies that the 'destination' span is not shorter than 'source'. + /// + /// The source element type. + /// The destination element type. + /// The source span. + /// The destination span. + /// The name of the argument for 'destination'. + [Conditional("DEBUG")] + [DebuggerStepThrough] + public static void DestinationShouldNotBeTooShort( + Span source, + Span destination, + string destinationParamName) + { + if (destination.Length < source.Length) + { + ThrowArgumentException($"Destination span is too short!", destinationParamName); + } + } + + /// + /// Verifies, that the `source` span has the length of 'minLength', or longer. + /// + /// The element type of the spans. + /// The target span. + /// The minimum length. + /// The name of the parameter that is to be checked. + /// + /// has less than items. + /// + [Conditional("DEBUG")] + [DebuggerStepThrough] + public static void MustBeSizedAtLeast(Span source, int minLength, string parameterName) + { + if (source.Length < minLength) + { + ThrowArgumentException($"Span-s must be at least of length {minLength}!", parameterName); + } + } + + [MethodImpl(MethodImplOptions.NoInlining)] + private static void ThrowArgumentException(string message, string parameterName) + { + throw new ArgumentException(message, parameterName); + } + + [MethodImpl(MethodImplOptions.NoInlining)] + private static void ThrowArgumentOutOfRangeException(string parameterName, string message) + { + throw new ArgumentOutOfRangeException(parameterName, message); + } + + [MethodImpl(MethodImplOptions.NoInlining)] + private static void ThrowArgumentNullException(string parameterName) + { + throw new ArgumentNullException(parameterName); + } } } \ No newline at end of file diff --git a/src/SixLabors.Core/Helpers/Guard.cs b/src/SixLabors.Core/Helpers/Guard.cs index d6616aa78e..09c8675d3a 100644 --- a/src/SixLabors.Core/Helpers/Guard.cs +++ b/src/SixLabors.Core/Helpers/Guard.cs @@ -4,7 +4,7 @@ using System; using System.Collections.Generic; using System.Diagnostics; -using System.Linq; +using System.Runtime.CompilerServices; namespace SixLabors { @@ -15,22 +15,63 @@ namespace SixLabors internal static class Guard { /// - /// Verifies that the specified value is less than a maximum value - /// and throws an exception if it is not. + /// Ensures that the value is not null. + /// + /// The target object, which cannot be null. + /// The name of the parameter that is to be checked. + /// The type of the value. + /// is null. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + [DebuggerStepThrough] + public static void NotNull(TValue value, string parameterName) + where TValue : class + { + if (value is null) + { + ThrowArgumentNullException(parameterName); + } + } + + /// + /// Ensures that the target value is not null, empty, or whitespace. + /// + /// The target string, which should be checked against being null or empty. + /// Name of the parameter. + /// is null. + /// is empty or contains only blanks. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + [DebuggerStepThrough] + public static void NotNullOrWhiteSpace(string value, string parameterName) + { + if (value is null) + { + ThrowArgumentNullException(parameterName); + } + + if (string.IsNullOrWhiteSpace(value)) + { + ThrowArgumentException("Must not be empty or whitespace.", parameterName); + } + } + + /// + /// Ensures that the specified value is less than a maximum value. /// /// The target value, which should be validated. /// The maximum value. /// The name of the parameter that is to be checked. /// The type of the value. - /// + /// /// is greater than the maximum value. /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + [DebuggerStepThrough] public static void MustBeLessThan(TValue value, TValue max, string parameterName) - where TValue : IComparable + where TValue : IComparable { if (value.CompareTo(max) >= 0) { - throw new ArgumentOutOfRangeException(parameterName, $"Value must be less than {max}."); + ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be less than {max}."); } } @@ -42,15 +83,17 @@ namespace SixLabors /// The maximum value. /// The name of the parameter that is to be checked. /// The type of the value. - /// + /// /// is greater than the maximum value. /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + [DebuggerStepThrough] public static void MustBeLessThanOrEqualTo(TValue value, TValue max, string parameterName) - where TValue : IComparable + where TValue : IComparable { if (value.CompareTo(max) > 0) { - throw new ArgumentOutOfRangeException(parameterName, $"Value must be less than or equal to {max}."); + ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be less than or equal to {max}."); } } @@ -62,15 +105,19 @@ namespace SixLabors /// The minimum value. /// The name of the parameter that is to be checked. /// The type of the value. - /// + /// /// is less than the minimum value. /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + [DebuggerStepThrough] public static void MustBeGreaterThan(TValue value, TValue min, string parameterName) where TValue : IComparable { if (value.CompareTo(min) <= 0) { - throw new ArgumentOutOfRangeException(parameterName, $"Value must be greater than {min}."); + ThrowArgumentOutOfRangeException( + parameterName, + $"Value {value} must be greater than {min}."); } } @@ -82,15 +129,17 @@ namespace SixLabors /// The minimum value. /// The name of the parameter that is to be checked. /// The type of the value. - /// + /// /// is less than the minimum value. /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + [DebuggerStepThrough] public static void MustBeGreaterThanOrEqualTo(TValue value, TValue min, string parameterName) where TValue : IComparable { if (value.CompareTo(min) < 0) { - throw new ArgumentOutOfRangeException(parameterName, $"Value must be greater than or equal to {min}."); + ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be greater than or equal to {min}."); } } @@ -103,34 +152,158 @@ namespace SixLabors /// The maximum value. /// The name of the parameter that is to be checked. /// The type of the value. - /// + /// /// is less than the minimum value of greater than the maximum value. /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + [DebuggerStepThrough] public static void MustBeBetweenOrEqualTo(TValue value, TValue min, TValue max, string parameterName) where TValue : IComparable { if (value.CompareTo(min) < 0 || value.CompareTo(max) > 0) { - throw new ArgumentOutOfRangeException(parameterName, $"Value must be greater than or equal to {min} and less than or equal to {max}."); + ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be greater than or equal to {min} and less than or equal to {max}."); + } + } + + /// + /// Verifies, that the method parameter with specified target value is true + /// and throws an exception if it is found to be so. + /// + /// The target value, which cannot be false. + /// The name of the parameter that is to be checked. + /// The error message, if any to add to the exception. + /// + /// is false. + /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + [DebuggerStepThrough] + public static void IsTrue(bool target, string parameterName, string message) + { + if (!target) + { + ThrowArgumentException(message, parameterName); + } + } + + /// + /// Verifies, that the method parameter with specified target value is false + /// and throws an exception if it is found to be so. + /// + /// The target value, which cannot be true. + /// The name of the parameter that is to be checked. + /// The error message, if any to add to the exception. + /// + /// is true. + /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + [DebuggerStepThrough] + public static void IsFalse(bool target, string parameterName, string message) + { + if (target) + { + ThrowArgumentException(message, parameterName); } } /// - /// Verifies, that the `target` span has the length of 'minLength', or longer. + /// Verifies, that the `source` span has the length of 'minLength', or longer. /// /// The element type of the spans. - /// The target span. + /// The source span. /// The minimum length. /// The name of the parameter that is to be checked. /// - /// The length of is less than . + /// has less than items. /// - public static void MustBeSizedAtLeast(T[] value, int minLength, string parameterName) + [MethodImpl(MethodImplOptions.AggressiveInlining)] + [DebuggerStepThrough] + public static void MustBeSizedAtLeast(ReadOnlySpan source, int minLength, string parameterName) { - if (value.Length < minLength) + if (source.Length < minLength) { - throw new ArgumentException($"The size must be at least {minLength}.", parameterName); + ThrowArgumentException($"Span-s must be at least of length {minLength}!", parameterName); } } + + /// + /// Verifies, that the `source` span has the length of 'minLength', or longer. + /// + /// The element type of the spans. + /// The target span. + /// The minimum length. + /// The name of the parameter that is to be checked. + /// + /// has less than items. + /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + [DebuggerStepThrough] + public static void MustBeSizedAtLeast(Span source, int minLength, string parameterName) + { + if (source.Length < minLength) + { + ThrowArgumentException($"The size must be at least {minLength}.", parameterName); + } + } + + /// + /// Verifies that the 'destination' span is not shorter than 'source'. + /// + /// The source element type. + /// The destination element type. + /// The source span. + /// The destination span. + /// The name of the argument for 'destination'. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + [DebuggerStepThrough] + public static void DestinationShouldNotBeTooShort( + ReadOnlySpan source, + Span destination, + string destinationParamName) + { + if (destination.Length < source.Length) + { + ThrowArgumentException($"Destination span is too short!", destinationParamName); + } + } + + /// + /// Verifies that the 'destination' span is not shorter than 'source'. + /// + /// The source element type. + /// The destination element type. + /// The source span. + /// The destination span. + /// The name of the argument for 'destination'. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + [DebuggerStepThrough] + public static void DestinationShouldNotBeTooShort( + Span source, + Span destination, + string destinationParamName) + { + if (destination.Length < source.Length) + { + ThrowArgumentException($"Destination span is too short!", destinationParamName); + } + } + + [MethodImpl(MethodImplOptions.NoInlining)] + private static void ThrowArgumentException(string message, string parameterName) + { + throw new ArgumentException(message, parameterName); + } + + [MethodImpl(MethodImplOptions.NoInlining)] + private static void ThrowArgumentOutOfRangeException(string parameterName, string message) + { + throw new ArgumentOutOfRangeException(parameterName, message); + } + + [MethodImpl(MethodImplOptions.NoInlining)] + private static void ThrowArgumentNullException(string parameterName) + { + throw new ArgumentNullException(parameterName); + } } -} \ No newline at end of file +} diff --git a/tests/SixLabors.Core.Tests/Helpers/GuardTests.cs b/tests/SixLabors.Core.Tests/Helpers/GuardTests.cs index d6ef967b83..bed743767a 100644 --- a/tests/SixLabors.Core.Tests/Helpers/GuardTests.cs +++ b/tests/SixLabors.Core.Tests/Helpers/GuardTests.cs @@ -8,6 +8,96 @@ namespace SixLabors.Helpers.Tests { public class GuardTests { + private class Foo + { + } + + [Fact] + public void NotNull_WhenNull_Throws() + { + Foo foo = null; + Assert.Throws(() => Guard.NotNull(foo, nameof(foo))); + } + + [Fact] + public void NotNull_NotNull() + { + Foo foo = new Foo(); + Guard.NotNull(foo, nameof(foo)); + } + + [Theory] + [InlineData(null, true)] + [InlineData("", true)] + [InlineData(" ", true)] + [InlineData("$", false)] + [InlineData("lol", false)] + public void NotNullOrWhiteSpace(string str, bool shouldThrow) + { + if (shouldThrow) + { + Assert.ThrowsAny(() => Guard.NotNullOrWhiteSpace(str, nameof(str))); + } + else + { + Guard.NotNullOrWhiteSpace(str, nameof(str)); + } + } + + [Theory] + [InlineData(true)] + [InlineData(false)] + public void IsTrue(bool value) + { + if (!value) + { + Assert.Throws(() => Guard.IsTrue(value, nameof(value), "Boo!")); + } + else + { + Guard.IsTrue(value, nameof(value), "Boo."); + } + } + + [Theory] + [InlineData(true)] + [InlineData(false)] + public void IsFalse(bool value) + { + if (value) + { + Assert.Throws(() => Guard.IsFalse(value, nameof(value), "Boo!")); + } + else + { + Guard.IsFalse(value, nameof(value), "Boo."); + } + } + + [Theory] + [InlineData(0, 0, false)] + [InlineData(1, 1, false)] + [InlineData(1, 0, false)] + [InlineData(13, 13, false)] + [InlineData(20, 13, false)] + [InlineData(12, 13, true)] + [InlineData(0, 1, true)] + public void MustBeSizedAtLeast(int length, int minLength, bool shouldThrow) + { + int[] data = new int[length]; + + if (shouldThrow) + { + Assert.Throws(() => Guard.MustBeSizedAtLeast((Span)data, minLength, nameof(data))); + Assert.Throws(() => Guard.MustBeSizedAtLeast((ReadOnlySpan)data, minLength, nameof(data))); + } + else + { + Guard.MustBeSizedAtLeast((Span)data, minLength, nameof(data)); + Guard.MustBeSizedAtLeast((ReadOnlySpan)data, minLength, nameof(data)); + } + } + [Fact] public void MustBeLessThan_IsLess_ThrowsNoException() { @@ -25,7 +115,7 @@ namespace SixLabors.Helpers.Tests }); Assert.Equal("myParamName", exception.ParamName); - Assert.Contains($"Value must be less than {max}.", exception.Message); + Assert.Contains($"Value {value} must be less than {max}.", exception.Message); } [Theory] @@ -45,7 +135,7 @@ namespace SixLabors.Helpers.Tests }); Assert.Equal("myParamName", exception.ParamName); - Assert.Contains($"Value must be less than or equal to 1.", exception.Message); + Assert.Contains($"Value 2 must be less than or equal to 1.", exception.Message); } [Fact] @@ -65,7 +155,7 @@ namespace SixLabors.Helpers.Tests }); Assert.Equal("myParamName", exception.ParamName); - Assert.Contains($"Value must be greater than {min}.", exception.Message); + Assert.Contains($"Value {value} must be greater than {min}.", exception.Message); } [Theory] @@ -85,7 +175,7 @@ namespace SixLabors.Helpers.Tests }); Assert.Equal("myParamName", exception.ParamName); - Assert.Contains($"Value must be greater than or equal to 2.", exception.Message); + Assert.Contains($"Value 1 must be greater than or equal to 2.", exception.Message); } [Theory] @@ -108,7 +198,7 @@ namespace SixLabors.Helpers.Tests }); Assert.Equal("myParamName", exception.ParamName); - Assert.Contains($"Value must be greater than or equal to {min} and less than or equal to {max}.", exception.Message); + Assert.Contains($"Value {value} must be greater than or equal to {min} and less than or equal to {max}.", exception.Message); } [Theory] @@ -128,7 +218,7 @@ namespace SixLabors.Helpers.Tests }); Assert.Equal("myParamName", exception.ParamName); - Assert.Contains("The size must be at least 3.", exception.Message); + Assert.Contains("The size must be at least 3", exception.Message); } } } From ff972defaf9c18288519e0dc3a9cca9e19c1a921 Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Sun, 18 Aug 2019 17:17:30 +0200 Subject: [PATCH 02/12] [SL.Core] harmonize Guard + DebugGuard code and tests --- src/SixLabors.Core/Helpers/DebugGuard.cs | 42 +++---- .../Helpers/DebugGuardTests.cs | 119 ++++++++++++++++-- .../Helpers/GuardTests.cs | 40 ++++-- 3 files changed, 162 insertions(+), 39 deletions(-) diff --git a/src/SixLabors.Core/Helpers/DebugGuard.cs b/src/SixLabors.Core/Helpers/DebugGuard.cs index c7fb796b3d..31d7d23f26 100644 --- a/src/SixLabors.Core/Helpers/DebugGuard.cs +++ b/src/SixLabors.Core/Helpers/DebugGuard.cs @@ -13,7 +13,7 @@ namespace SixLabors [DebuggerStepThrough] internal static class DebugGuard { - /// + /// /// Ensures that the value is not null. /// /// The target object, which cannot be null. @@ -225,6 +225,26 @@ namespace SixLabors } } + /// + /// Verifies, that the `source` span has the length of 'minLength', or longer. + /// + /// The element type of the spans. + /// The target span. + /// The minimum length. + /// The name of the parameter that is to be checked. + /// + /// has less than items. + /// + [Conditional("DEBUG")] + [DebuggerStepThrough] + public static void MustBeSizedAtLeast(Span source, int minLength, string parameterName) + { + if (source.Length < minLength) + { + ThrowArgumentException($"The size must be at least {minLength}.", parameterName); + } + } + /// /// Verifies that the 'destination' span is not shorter than 'source'. /// @@ -267,26 +287,6 @@ namespace SixLabors } } - /// - /// Verifies, that the `source` span has the length of 'minLength', or longer. - /// - /// The element type of the spans. - /// The target span. - /// The minimum length. - /// The name of the parameter that is to be checked. - /// - /// has less than items. - /// - [Conditional("DEBUG")] - [DebuggerStepThrough] - public static void MustBeSizedAtLeast(Span source, int minLength, string parameterName) - { - if (source.Length < minLength) - { - ThrowArgumentException($"Span-s must be at least of length {minLength}!", parameterName); - } - } - [MethodImpl(MethodImplOptions.NoInlining)] private static void ThrowArgumentException(string message, string parameterName) { diff --git a/tests/SixLabors.Core.Tests/Helpers/DebugGuardTests.cs b/tests/SixLabors.Core.Tests/Helpers/DebugGuardTests.cs index 9b14fc8ca0..3db5642d11 100644 --- a/tests/SixLabors.Core.Tests/Helpers/DebugGuardTests.cs +++ b/tests/SixLabors.Core.Tests/Helpers/DebugGuardTests.cs @@ -14,6 +14,10 @@ namespace SixLabors.Helpers.Tests { public class DebugGuardTests { + private class Foo + { + } + [Fact] public void AllStaticMethodsOnOnDebugGuardHaveDEBUGConditional() { @@ -28,18 +32,113 @@ namespace SixLabors.Helpers.Tests } [Fact] - public void NotNull_TargetNotNull_ThrowsNoException() + public void NotNull_WhenNull_Throws() { - DebugGuard.NotNull("test", "myParamName"); + Foo foo = null; + Assert.Throws(() => Guard.NotNull(foo, nameof(foo))); } [Fact] - public void NotNull_TargetNull_ThrowsException() + public void NotNull_WhenNotNull() + { + Foo foo = new Foo(); + Guard.NotNull(foo, nameof(foo)); + } + + [Theory] + [InlineData(null, true)] + [InlineData("", true)] + [InlineData(" ", true)] + [InlineData("$", false)] + [InlineData("lol", false)] + public void NotNullOrWhiteSpace(string str, bool shouldThrow) { - Assert.Throws(() => + if (shouldThrow) { - DebugGuard.NotNull((object)null, "myParamName"); - }); + Assert.ThrowsAny(() => Guard.NotNullOrWhiteSpace(str, nameof(str))); + } + else + { + Guard.NotNullOrWhiteSpace(str, nameof(str)); + } + } + + [Theory] + [InlineData(true)] + [InlineData(false)] + public void IsTrue(bool value) + { + if (!value) + { + Assert.Throws(() => Guard.IsTrue(value, nameof(value), "Boo!")); + } + else + { + Guard.IsTrue(value, nameof(value), "Boo."); + } + } + + [Theory] + [InlineData(true)] + [InlineData(false)] + public void IsFalse(bool value) + { + if (value) + { + Assert.Throws(() => Guard.IsFalse(value, nameof(value), "Boo!")); + } + else + { + Guard.IsFalse(value, nameof(value), "Boo."); + } + } + + public static readonly TheoryData SizeCheckData = new TheoryData + { + { 0, 0, false }, + { 1, 1, false }, + { 1, 0, false }, + { 13, 13, false }, + { 20, 13, false }, + { 12, 13, true }, + { 0, 1, true }, + }; + + [Theory] + [MemberData(nameof(SizeCheckData))] + public void MustBeSizedAtLeast(int length, int minLength, bool shouldThrow) + { + int[] data = new int[length]; + + if (shouldThrow) + { + Assert.Throws(() => Guard.MustBeSizedAtLeast((Span)data, minLength, nameof(data))); + Assert.Throws(() => Guard.MustBeSizedAtLeast((ReadOnlySpan)data, minLength, nameof(data))); + } + else + { + Guard.MustBeSizedAtLeast((Span)data, minLength, nameof(data)); + Guard.MustBeSizedAtLeast((ReadOnlySpan)data, minLength, nameof(data)); + } + } + + [Theory] + [MemberData(nameof(SizeCheckData))] + public void DestinationShouldNotBeTooShort(int destLength, int sourceLength, bool shouldThrow) + { + int[] dest = new int[destLength]; + int[] source = new int[sourceLength]; + + if (shouldThrow) + { + Assert.Throws(() => Guard.DestinationShouldNotBeTooShort((Span)source, (Span)dest, nameof(dest))); + Assert.Throws(() => Guard.DestinationShouldNotBeTooShort((ReadOnlySpan)source, (Span)dest, nameof(dest))); + } + else + { + Guard.DestinationShouldNotBeTooShort((Span)source, (Span)dest, nameof(dest)); + Guard.DestinationShouldNotBeTooShort((ReadOnlySpan)source, (Span)dest, nameof(dest)); + } } [Fact] @@ -59,7 +158,7 @@ namespace SixLabors.Helpers.Tests }); Assert.Equal("myParamName", exception.ParamName); - Assert.Contains($"Value must be less than {max}.", exception.Message); + Assert.Contains($"Value {value} must be less than {max}.", exception.Message); } [Theory] @@ -79,7 +178,7 @@ namespace SixLabors.Helpers.Tests }); Assert.Equal("myParamName", exception.ParamName); - Assert.Contains($"Value must be less than or equal to 1.", exception.Message); + Assert.Contains($"Value 2 must be less than or equal to 1.", exception.Message); } [Fact] @@ -99,7 +198,7 @@ namespace SixLabors.Helpers.Tests }); Assert.Equal("myParamName", exception.ParamName); - Assert.Contains($"Value must be greater than {min}.", exception.Message); + Assert.Contains($"Value {value} must be greater than {min}.", exception.Message); } [Theory] @@ -119,7 +218,7 @@ namespace SixLabors.Helpers.Tests }); Assert.Equal("myParamName", exception.ParamName); - Assert.Contains($"Value must be greater than or equal to 2.", exception.Message); + Assert.Contains($"Value 1 must be greater than or equal to 2.", exception.Message); } [Theory] diff --git a/tests/SixLabors.Core.Tests/Helpers/GuardTests.cs b/tests/SixLabors.Core.Tests/Helpers/GuardTests.cs index bed743767a..a35668c38c 100644 --- a/tests/SixLabors.Core.Tests/Helpers/GuardTests.cs +++ b/tests/SixLabors.Core.Tests/Helpers/GuardTests.cs @@ -20,7 +20,7 @@ namespace SixLabors.Helpers.Tests } [Fact] - public void NotNull_NotNull() + public void NotNull_WhenNotNull() { Foo foo = new Foo(); Guard.NotNull(foo, nameof(foo)); @@ -74,14 +74,19 @@ namespace SixLabors.Helpers.Tests } } + public static readonly TheoryData SizeCheckData = new TheoryData + { + { 0, 0, false }, + { 1, 1, false }, + { 1, 0, false }, + { 13, 13, false }, + { 20, 13, false }, + { 12, 13, true }, + { 0, 1, true }, + }; + [Theory] - [InlineData(0, 0, false)] - [InlineData(1, 1, false)] - [InlineData(1, 0, false)] - [InlineData(13, 13, false)] - [InlineData(20, 13, false)] - [InlineData(12, 13, true)] - [InlineData(0, 1, true)] + [MemberData(nameof(SizeCheckData))] public void MustBeSizedAtLeast(int length, int minLength, bool shouldThrow) { int[] data = new int[length]; @@ -98,6 +103,25 @@ namespace SixLabors.Helpers.Tests } } + [Theory] + [MemberData(nameof(SizeCheckData))] + public void DestinationShouldNotBeTooShort(int destLength, int sourceLength, bool shouldThrow) + { + int[] dest = new int[destLength]; + int[] source = new int[sourceLength]; + + if (shouldThrow) + { + Assert.Throws(() => Guard.DestinationShouldNotBeTooShort((Span)source, (Span)dest, nameof(dest))); + Assert.Throws(() => Guard.DestinationShouldNotBeTooShort((ReadOnlySpan)source, (Span)dest, nameof(dest))); + } + else + { + Guard.DestinationShouldNotBeTooShort((Span)source, (Span)dest, nameof(dest)); + Guard.DestinationShouldNotBeTooShort((ReadOnlySpan)source, (Span)dest, nameof(dest)); + } + } + [Fact] public void MustBeLessThan_IsLess_ThrowsNoException() { From e4beee618d8a561ecee9f2bd85717d1f7192522a Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Sun, 18 Aug 2019 17:32:46 +0200 Subject: [PATCH 03/12] [SL.Core] import standards submodule --- .gitmodules | 3 +++ standards | 1 + 2 files changed, 4 insertions(+) create mode 100644 .gitmodules create mode 160000 standards diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000000..b82e14d8db --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "standards"] + path = standards + url = https://github.com/SixLabors/Standards.git diff --git a/standards b/standards new file mode 160000 index 0000000000..8b085c0ec4 --- /dev/null +++ b/standards @@ -0,0 +1 @@ +Subproject commit 8b085c0ec4fb64797b9965741f7138f8f66a6b44 From b169e9252f4220b1722eeb9b53371ea7de9db7cd Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Sun, 18 Aug 2019 17:34:04 +0200 Subject: [PATCH 04/12] [SL.Core] temporarily redirect "standards" to af/shared-guard branch --- standards | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/standards b/standards index 8b085c0ec4..4e6ebb923f 160000 --- a/standards +++ b/standards @@ -1 +1 @@ -Subproject commit 8b085c0ec4fb64797b9965741f7138f8f66a6b44 +Subproject commit 4e6ebb923f20a5280ada67aad1fa7478f45c44cc From eb40549006149c0f4be019d0131ec82ffab66b28 Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Sun, 18 Aug 2019 17:41:28 +0200 Subject: [PATCH 05/12] [SL.Core] use shared guards from standards --- src/SixLabors.Core/Helpers/DebugGuard.cs | 308 ---------------------- src/SixLabors.Core/Helpers/Guard.cs | 309 ----------------------- src/SixLabors.Core/SixLabors.Core.csproj | 10 +- standards | 2 +- 4 files changed, 10 insertions(+), 619 deletions(-) delete mode 100644 src/SixLabors.Core/Helpers/DebugGuard.cs delete mode 100644 src/SixLabors.Core/Helpers/Guard.cs diff --git a/src/SixLabors.Core/Helpers/DebugGuard.cs b/src/SixLabors.Core/Helpers/DebugGuard.cs deleted file mode 100644 index 31d7d23f26..0000000000 --- a/src/SixLabors.Core/Helpers/DebugGuard.cs +++ /dev/null @@ -1,308 +0,0 @@ -// Copyright (c) Six Labors and contributors. -// Licensed under the Apache License, Version 2.0. - -using System; -using System.Diagnostics; -using System.Runtime.CompilerServices; - -namespace SixLabors -{ - /// - /// Provides methods to protect against invalid parameters for a DEBUG build. - /// - [DebuggerStepThrough] - internal static class DebugGuard - { - /// - /// Ensures that the value is not null. - /// - /// The target object, which cannot be null. - /// The name of the parameter that is to be checked. - /// The type of the value. - /// is null. - [Conditional("DEBUG")] - [DebuggerStepThrough] - public static void NotNull(TValue value, string parameterName) - where TValue : class - { - if (value is null) - { - ThrowArgumentNullException(parameterName); - } - } - - /// - /// Ensures that the target value is not null, empty, or whitespace. - /// - /// The target string, which should be checked against being null or empty. - /// Name of the parameter. - /// is null. - /// is empty or contains only blanks. - [Conditional("DEBUG")] - [DebuggerStepThrough] - public static void NotNullOrWhiteSpace(string value, string parameterName) - { - if (value is null) - { - ThrowArgumentNullException(parameterName); - } - - if (string.IsNullOrWhiteSpace(value)) - { - ThrowArgumentException("Must not be empty or whitespace.", parameterName); - } - } - - /// - /// Ensures that the specified value is less than a maximum value. - /// - /// The target value, which should be validated. - /// The maximum value. - /// The name of the parameter that is to be checked. - /// The type of the value. - /// - /// is greater than the maximum value. - /// - [Conditional("DEBUG")] - [DebuggerStepThrough] - public static void MustBeLessThan(TValue value, TValue max, string parameterName) - where TValue : IComparable - { - if (value.CompareTo(max) >= 0) - { - ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be less than {max}."); - } - } - - /// - /// Verifies that the specified value is less than or equal to a maximum value - /// and throws an exception if it is not. - /// - /// The target value, which should be validated. - /// The maximum value. - /// The name of the parameter that is to be checked. - /// The type of the value. - /// - /// is greater than the maximum value. - /// - [Conditional("DEBUG")] - [DebuggerStepThrough] - public static void MustBeLessThanOrEqualTo(TValue value, TValue max, string parameterName) - where TValue : IComparable - { - if (value.CompareTo(max) > 0) - { - ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be less than or equal to {max}."); - } - } - - /// - /// Verifies that the specified value is greater than a minimum value - /// and throws an exception if it is not. - /// - /// The target value, which should be validated. - /// The minimum value. - /// The name of the parameter that is to be checked. - /// The type of the value. - /// - /// is less than the minimum value. - /// - [Conditional("DEBUG")] - [DebuggerStepThrough] - public static void MustBeGreaterThan(TValue value, TValue min, string parameterName) - where TValue : IComparable - { - if (value.CompareTo(min) <= 0) - { - ThrowArgumentOutOfRangeException( - parameterName, - $"Value {value} must be greater than {min}."); - } - } - - /// - /// Verifies that the specified value is greater than or equal to a minimum value - /// and throws an exception if it is not. - /// - /// The target value, which should be validated. - /// The minimum value. - /// The name of the parameter that is to be checked. - /// The type of the value. - /// - /// is less than the minimum value. - /// - [Conditional("DEBUG")] - [DebuggerStepThrough] - public static void MustBeGreaterThanOrEqualTo(TValue value, TValue min, string parameterName) - where TValue : IComparable - { - if (value.CompareTo(min) < 0) - { - ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be greater than or equal to {min}."); - } - } - - /// - /// Verifies that the specified value is greater than or equal to a minimum value and less than - /// or equal to a maximum value and throws an exception if it is not. - /// - /// The target value, which should be validated. - /// The minimum value. - /// The maximum value. - /// The name of the parameter that is to be checked. - /// The type of the value. - /// - /// is less than the minimum value of greater than the maximum value. - /// - [Conditional("DEBUG")] - [DebuggerStepThrough] - public static void MustBeBetweenOrEqualTo(TValue value, TValue min, TValue max, string parameterName) - where TValue : IComparable - { - if (value.CompareTo(min) < 0 || value.CompareTo(max) > 0) - { - ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be greater than or equal to {min} and less than or equal to {max}."); - } - } - - /// - /// Verifies, that the method parameter with specified target value is true - /// and throws an exception if it is found to be so. - /// - /// The target value, which cannot be false. - /// The name of the parameter that is to be checked. - /// The error message, if any to add to the exception. - /// - /// is false. - /// - [Conditional("DEBUG")] - [DebuggerStepThrough] - public static void IsTrue(bool target, string parameterName, string message) - { - if (!target) - { - ThrowArgumentException(message, parameterName); - } - } - - /// - /// Verifies, that the method parameter with specified target value is false - /// and throws an exception if it is found to be so. - /// - /// The target value, which cannot be true. - /// The name of the parameter that is to be checked. - /// The error message, if any to add to the exception. - /// - /// is true. - /// - [Conditional("DEBUG")] - [DebuggerStepThrough] - public static void IsFalse(bool target, string parameterName, string message) - { - if (target) - { - ThrowArgumentException(message, parameterName); - } - } - - /// - /// Verifies, that the `source` span has the length of 'minLength', or longer. - /// - /// The element type of the spans. - /// The source span. - /// The minimum length. - /// The name of the parameter that is to be checked. - /// - /// has less than items. - /// - [Conditional("DEBUG")] - [DebuggerStepThrough] - public static void MustBeSizedAtLeast(ReadOnlySpan source, int minLength, string parameterName) - { - if (source.Length < minLength) - { - ThrowArgumentException($"Span-s must be at least of length {minLength}!", parameterName); - } - } - - /// - /// Verifies, that the `source` span has the length of 'minLength', or longer. - /// - /// The element type of the spans. - /// The target span. - /// The minimum length. - /// The name of the parameter that is to be checked. - /// - /// has less than items. - /// - [Conditional("DEBUG")] - [DebuggerStepThrough] - public static void MustBeSizedAtLeast(Span source, int minLength, string parameterName) - { - if (source.Length < minLength) - { - ThrowArgumentException($"The size must be at least {minLength}.", parameterName); - } - } - - /// - /// Verifies that the 'destination' span is not shorter than 'source'. - /// - /// The source element type. - /// The destination element type. - /// The source span. - /// The destination span. - /// The name of the argument for 'destination'. - [Conditional("DEBUG")] - [DebuggerStepThrough] - public static void DestinationShouldNotBeTooShort( - ReadOnlySpan source, - Span destination, - string destinationParamName) - { - if (destination.Length < source.Length) - { - ThrowArgumentException($"Destination span is too short!", destinationParamName); - } - } - - /// - /// Verifies that the 'destination' span is not shorter than 'source'. - /// - /// The source element type. - /// The destination element type. - /// The source span. - /// The destination span. - /// The name of the argument for 'destination'. - [Conditional("DEBUG")] - [DebuggerStepThrough] - public static void DestinationShouldNotBeTooShort( - Span source, - Span destination, - string destinationParamName) - { - if (destination.Length < source.Length) - { - ThrowArgumentException($"Destination span is too short!", destinationParamName); - } - } - - [MethodImpl(MethodImplOptions.NoInlining)] - private static void ThrowArgumentException(string message, string parameterName) - { - throw new ArgumentException(message, parameterName); - } - - [MethodImpl(MethodImplOptions.NoInlining)] - private static void ThrowArgumentOutOfRangeException(string parameterName, string message) - { - throw new ArgumentOutOfRangeException(parameterName, message); - } - - [MethodImpl(MethodImplOptions.NoInlining)] - private static void ThrowArgumentNullException(string parameterName) - { - throw new ArgumentNullException(parameterName); - } - } -} \ No newline at end of file diff --git a/src/SixLabors.Core/Helpers/Guard.cs b/src/SixLabors.Core/Helpers/Guard.cs deleted file mode 100644 index 09c8675d3a..0000000000 --- a/src/SixLabors.Core/Helpers/Guard.cs +++ /dev/null @@ -1,309 +0,0 @@ -// Copyright (c) Six Labors and contributors. -// Licensed under the Apache License, Version 2.0. - -using System; -using System.Collections.Generic; -using System.Diagnostics; -using System.Runtime.CompilerServices; - -namespace SixLabors -{ - /// - /// Provides methods to protect against invalid parameters. - /// - [DebuggerStepThrough] - internal static class Guard - { - /// - /// Ensures that the value is not null. - /// - /// The target object, which cannot be null. - /// The name of the parameter that is to be checked. - /// The type of the value. - /// is null. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - [DebuggerStepThrough] - public static void NotNull(TValue value, string parameterName) - where TValue : class - { - if (value is null) - { - ThrowArgumentNullException(parameterName); - } - } - - /// - /// Ensures that the target value is not null, empty, or whitespace. - /// - /// The target string, which should be checked against being null or empty. - /// Name of the parameter. - /// is null. - /// is empty or contains only blanks. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - [DebuggerStepThrough] - public static void NotNullOrWhiteSpace(string value, string parameterName) - { - if (value is null) - { - ThrowArgumentNullException(parameterName); - } - - if (string.IsNullOrWhiteSpace(value)) - { - ThrowArgumentException("Must not be empty or whitespace.", parameterName); - } - } - - /// - /// Ensures that the specified value is less than a maximum value. - /// - /// The target value, which should be validated. - /// The maximum value. - /// The name of the parameter that is to be checked. - /// The type of the value. - /// - /// is greater than the maximum value. - /// - [MethodImpl(MethodImplOptions.AggressiveInlining)] - [DebuggerStepThrough] - public static void MustBeLessThan(TValue value, TValue max, string parameterName) - where TValue : IComparable - { - if (value.CompareTo(max) >= 0) - { - ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be less than {max}."); - } - } - - /// - /// Verifies that the specified value is less than or equal to a maximum value - /// and throws an exception if it is not. - /// - /// The target value, which should be validated. - /// The maximum value. - /// The name of the parameter that is to be checked. - /// The type of the value. - /// - /// is greater than the maximum value. - /// - [MethodImpl(MethodImplOptions.AggressiveInlining)] - [DebuggerStepThrough] - public static void MustBeLessThanOrEqualTo(TValue value, TValue max, string parameterName) - where TValue : IComparable - { - if (value.CompareTo(max) > 0) - { - ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be less than or equal to {max}."); - } - } - - /// - /// Verifies that the specified value is greater than a minimum value - /// and throws an exception if it is not. - /// - /// The target value, which should be validated. - /// The minimum value. - /// The name of the parameter that is to be checked. - /// The type of the value. - /// - /// is less than the minimum value. - /// - [MethodImpl(MethodImplOptions.AggressiveInlining)] - [DebuggerStepThrough] - public static void MustBeGreaterThan(TValue value, TValue min, string parameterName) - where TValue : IComparable - { - if (value.CompareTo(min) <= 0) - { - ThrowArgumentOutOfRangeException( - parameterName, - $"Value {value} must be greater than {min}."); - } - } - - /// - /// Verifies that the specified value is greater than or equal to a minimum value - /// and throws an exception if it is not. - /// - /// The target value, which should be validated. - /// The minimum value. - /// The name of the parameter that is to be checked. - /// The type of the value. - /// - /// is less than the minimum value. - /// - [MethodImpl(MethodImplOptions.AggressiveInlining)] - [DebuggerStepThrough] - public static void MustBeGreaterThanOrEqualTo(TValue value, TValue min, string parameterName) - where TValue : IComparable - { - if (value.CompareTo(min) < 0) - { - ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be greater than or equal to {min}."); - } - } - - /// - /// Verifies that the specified value is greater than or equal to a minimum value and less than - /// or equal to a maximum value and throws an exception if it is not. - /// - /// The target value, which should be validated. - /// The minimum value. - /// The maximum value. - /// The name of the parameter that is to be checked. - /// The type of the value. - /// - /// is less than the minimum value of greater than the maximum value. - /// - [MethodImpl(MethodImplOptions.AggressiveInlining)] - [DebuggerStepThrough] - public static void MustBeBetweenOrEqualTo(TValue value, TValue min, TValue max, string parameterName) - where TValue : IComparable - { - if (value.CompareTo(min) < 0 || value.CompareTo(max) > 0) - { - ThrowArgumentOutOfRangeException(parameterName, $"Value {value} must be greater than or equal to {min} and less than or equal to {max}."); - } - } - - /// - /// Verifies, that the method parameter with specified target value is true - /// and throws an exception if it is found to be so. - /// - /// The target value, which cannot be false. - /// The name of the parameter that is to be checked. - /// The error message, if any to add to the exception. - /// - /// is false. - /// - [MethodImpl(MethodImplOptions.AggressiveInlining)] - [DebuggerStepThrough] - public static void IsTrue(bool target, string parameterName, string message) - { - if (!target) - { - ThrowArgumentException(message, parameterName); - } - } - - /// - /// Verifies, that the method parameter with specified target value is false - /// and throws an exception if it is found to be so. - /// - /// The target value, which cannot be true. - /// The name of the parameter that is to be checked. - /// The error message, if any to add to the exception. - /// - /// is true. - /// - [MethodImpl(MethodImplOptions.AggressiveInlining)] - [DebuggerStepThrough] - public static void IsFalse(bool target, string parameterName, string message) - { - if (target) - { - ThrowArgumentException(message, parameterName); - } - } - - /// - /// Verifies, that the `source` span has the length of 'minLength', or longer. - /// - /// The element type of the spans. - /// The source span. - /// The minimum length. - /// The name of the parameter that is to be checked. - /// - /// has less than items. - /// - [MethodImpl(MethodImplOptions.AggressiveInlining)] - [DebuggerStepThrough] - public static void MustBeSizedAtLeast(ReadOnlySpan source, int minLength, string parameterName) - { - if (source.Length < minLength) - { - ThrowArgumentException($"Span-s must be at least of length {minLength}!", parameterName); - } - } - - /// - /// Verifies, that the `source` span has the length of 'minLength', or longer. - /// - /// The element type of the spans. - /// The target span. - /// The minimum length. - /// The name of the parameter that is to be checked. - /// - /// has less than items. - /// - [MethodImpl(MethodImplOptions.AggressiveInlining)] - [DebuggerStepThrough] - public static void MustBeSizedAtLeast(Span source, int minLength, string parameterName) - { - if (source.Length < minLength) - { - ThrowArgumentException($"The size must be at least {minLength}.", parameterName); - } - } - - /// - /// Verifies that the 'destination' span is not shorter than 'source'. - /// - /// The source element type. - /// The destination element type. - /// The source span. - /// The destination span. - /// The name of the argument for 'destination'. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - [DebuggerStepThrough] - public static void DestinationShouldNotBeTooShort( - ReadOnlySpan source, - Span destination, - string destinationParamName) - { - if (destination.Length < source.Length) - { - ThrowArgumentException($"Destination span is too short!", destinationParamName); - } - } - - /// - /// Verifies that the 'destination' span is not shorter than 'source'. - /// - /// The source element type. - /// The destination element type. - /// The source span. - /// The destination span. - /// The name of the argument for 'destination'. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - [DebuggerStepThrough] - public static void DestinationShouldNotBeTooShort( - Span source, - Span destination, - string destinationParamName) - { - if (destination.Length < source.Length) - { - ThrowArgumentException($"Destination span is too short!", destinationParamName); - } - } - - [MethodImpl(MethodImplOptions.NoInlining)] - private static void ThrowArgumentException(string message, string parameterName) - { - throw new ArgumentException(message, parameterName); - } - - [MethodImpl(MethodImplOptions.NoInlining)] - private static void ThrowArgumentOutOfRangeException(string parameterName, string message) - { - throw new ArgumentOutOfRangeException(parameterName, message); - } - - [MethodImpl(MethodImplOptions.NoInlining)] - private static void ThrowArgumentNullException(string parameterName) - { - throw new ArgumentNullException(parameterName); - } - } -} diff --git a/src/SixLabors.Core/SixLabors.Core.csproj b/src/SixLabors.Core/SixLabors.Core.csproj index 0c6c537f44..61b8fa4b65 100644 --- a/src/SixLabors.Core/SixLabors.Core.csproj +++ b/src/SixLabors.Core/SixLabors.Core.csproj @@ -34,7 +34,11 @@ $(DefineConstants);SUPPORTS_HASHCODE - + + + + + All @@ -55,4 +59,8 @@ + + + + diff --git a/standards b/standards index 4e6ebb923f..948a02984c 160000 --- a/standards +++ b/standards @@ -1 +1 @@ -Subproject commit 4e6ebb923f20a5280ada67aad1fa7478f45c44cc +Subproject commit 948a02984c6b62dca1c40b02b289f6d1c13d79b1 From 56277c4735ac19dab2db03cdfe40a415cd582616 Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Sun, 18 Aug 2019 18:08:43 +0200 Subject: [PATCH 06/12] [SL.Core] do not share internals across SixLabors projects --- src/SixLabors.Core/Properties/AssemblyInfo.cs | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/src/SixLabors.Core/Properties/AssemblyInfo.cs b/src/SixLabors.Core/Properties/AssemblyInfo.cs index 92c683b139..241c0fe99c 100644 --- a/src/SixLabors.Core/Properties/AssemblyInfo.cs +++ b/src/SixLabors.Core/Properties/AssemblyInfo.cs @@ -4,12 +4,4 @@ using System.Runtime.CompilerServices; // Ensure the internals can be tested. -[assembly: InternalsVisibleTo("SixLabors.Core.Tests")] - -// Ensure the internals are visible to the other projects. -[assembly: InternalsVisibleTo("SixLabors.Exif")] -[assembly: InternalsVisibleTo("SixLabors.Fonts")] -[assembly: InternalsVisibleTo("SixLabors.ImageSharp")] -[assembly: InternalsVisibleTo("SixLabors.ImageSharp.Drawing")] -[assembly: InternalsVisibleTo("SixLabors.Shapes")] -[assembly: InternalsVisibleTo("SixLabors.Shapes.Text")] \ No newline at end of file +[assembly: InternalsVisibleTo("SixLabors.Core.Tests")] \ No newline at end of file From 4de4e5bfebed9a884fccd05877503a1891ac0533 Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Sun, 18 Aug 2019 18:23:27 +0200 Subject: [PATCH 07/12] [SL.Core] hope we can drop travis soon --- appveyor.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/appveyor.yml b/appveyor.yml index 016a9ee379..3c301a1964 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -3,6 +3,7 @@ image: Visual Studio 2017 before_build: + - git submodule -q update --init - cmd: dotnet --version build_script: From bfbda9863306a98c9dea8dd5c94e9d0334b79d76 Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Sun, 18 Aug 2019 20:34:17 +0200 Subject: [PATCH 08/12] [SL.Core] update submodule --- standards | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/standards b/standards index 948a02984c..30e6fe889d 160000 --- a/standards +++ b/standards @@ -1 +1 @@ -Subproject commit 948a02984c6b62dca1c40b02b289f6d1c13d79b1 +Subproject commit 30e6fe889dd8005634496c4d8aac85ab01f62c1d From c97def9117284aea55f635616a2aea745fc866a0 Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Sun, 18 Aug 2019 20:42:35 +0200 Subject: [PATCH 09/12] [SL.Core] update submodule --- standards | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/standards b/standards index 30e6fe889d..10fa2a5d9f 160000 --- a/standards +++ b/standards @@ -1 +1 @@ -Subproject commit 30e6fe889dd8005634496c4d8aac85ab01f62c1d +Subproject commit 10fa2a5d9f3e16ff01faa857b6eaf7833a7163ca From 29046532a299ac497f875e8987b43a0e649ae050 Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Thu, 29 Aug 2019 22:52:42 +0200 Subject: [PATCH 10/12] [SL.Core] Standards -> SharedInfrastructure --- .gitmodules | 6 +++--- standards => shared-infrastructure | 0 src/SixLabors.Core/SixLabors.Core.csproj | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) rename standards => shared-infrastructure (100%) diff --git a/.gitmodules b/.gitmodules index b82e14d8db..f560cd5905 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,3 @@ -[submodule "standards"] - path = standards - url = https://github.com/SixLabors/Standards.git +[submodule "shared-infrastructure"] + path = shared-infrastructure + url = https://github.com/SixLabors/SharedInfrastructure.git diff --git a/standards b/shared-infrastructure similarity index 100% rename from standards rename to shared-infrastructure diff --git a/src/SixLabors.Core/SixLabors.Core.csproj b/src/SixLabors.Core/SixLabors.Core.csproj index 61b8fa4b65..eafe9824ed 100644 --- a/src/SixLabors.Core/SixLabors.Core.csproj +++ b/src/SixLabors.Core/SixLabors.Core.csproj @@ -36,7 +36,7 @@ - + From 278a79e5009149f72e03e13d9b025395e6d810f7 Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Thu, 29 Aug 2019 23:37:46 +0200 Subject: [PATCH 11/12] [SL.Core] use shared .editorconfig and stylecop.json --- .editorconfig | 3 --- SixLabors.Core.sln | 2 +- src/SixLabors.Core/SixLabors.Core.csproj | 14 +++++++++----- stylecop.json | 15 --------------- .../SixLabors.Core.Tests.csproj | 3 +-- 5 files changed, 11 insertions(+), 26 deletions(-) delete mode 100644 .editorconfig delete mode 100644 stylecop.json diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index f39b267256..0000000000 --- a/.editorconfig +++ /dev/null @@ -1,3 +0,0 @@ -[*.cs] -indent_style = space -indent_size = 4 diff --git a/SixLabors.Core.sln b/SixLabors.Core.sln index 040ce0688f..a796a9ebac 100644 --- a/SixLabors.Core.sln +++ b/SixLabors.Core.sln @@ -5,7 +5,6 @@ VisualStudioVersion = 16.0.28803.352 MinimumVisualStudioVersion = 10.0.40219.1 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SolutionItems", "SolutionItems", "{C317F1B1-D75E-4C6D-83EB-80367343E0D7}" ProjectSection(SolutionItems) = preProject - .editorconfig = .editorconfig appveyor.yml = appveyor.yml .github\ISSUE_TEMPLATE\ask-question.md = .github\ISSUE_TEMPLATE\ask-question.md .github\ISSUE_TEMPLATE\bug-report.md = .github\ISSUE_TEMPLATE\bug-report.md @@ -16,6 +15,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SolutionItems", "SolutionIt gitversion.yml = gitversion.yml .github\PULL_REQUEST_TEMPLATE.md = .github\PULL_REQUEST_TEMPLATE.md README.md = README.md + shared-infrastructure\.editorconfig = shared-infrastructure\.editorconfig EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Source", "Source", "{815C0625-CD3D-440F-9F80-2D83856AB7AE}" diff --git a/src/SixLabors.Core/SixLabors.Core.csproj b/src/SixLabors.Core/SixLabors.Core.csproj index eafe9824ed..2fb64cdf37 100644 --- a/src/SixLabors.Core/SixLabors.Core.csproj +++ b/src/SixLabors.Core/SixLabors.Core.csproj @@ -37,15 +37,19 @@ + - + + ..\..\shared-infrastructure\SixLabors.ruleset + + - All - - - + All + + + diff --git a/stylecop.json b/stylecop.json deleted file mode 100644 index c67c0db325..0000000000 --- a/stylecop.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", - "settings": - { - "orderingRules": - { - "usingDirectivesPlacement": "outsideNamespace" - }, - "documentationRules": - { - "xmlHeader": false, - "copyrightText": "Copyright (c) Six Labors and contributors.\nLicensed under the Apache License, Version 2.0." - } - } -} \ No newline at end of file diff --git a/tests/SixLabors.Core.Tests/SixLabors.Core.Tests.csproj b/tests/SixLabors.Core.Tests/SixLabors.Core.Tests.csproj index 55951fb43f..f33dde1c6f 100644 --- a/tests/SixLabors.Core.Tests/SixLabors.Core.Tests.csproj +++ b/tests/SixLabors.Core.Tests/SixLabors.Core.Tests.csproj @@ -23,8 +23,7 @@ - - + From 68dca4fddbd4cd5661cb2c93c1588ad2f736253c Mon Sep 17 00:00:00 2001 From: James Jackson-South Date: Sat, 31 Aug 2019 14:00:48 +1000 Subject: [PATCH 12/12] [SL.Core] Update submodule and fix warnings. --- .editorconfig | 372 ++++++++++++++++++ .gitattributes | 108 +++++ shared-infrastructure | 2 +- src/SixLabors.Core/SixLabors.Core.csproj | 5 +- src/SixLabors.ruleset | 6 - .../Helpers/DebugGuardTests.cs | 40 +- .../Helpers/GuardTests.cs | 12 +- .../Memory/ArrayPoolMemoryAllocatorTests.cs | 16 +- .../Memory/SimpleGcMemoryAllocatorTests.cs | 4 +- .../Primitives/RectangleTests.cs | 20 +- .../SixLabors.Core.Tests.csproj | 2 +- 11 files changed, 528 insertions(+), 59 deletions(-) create mode 100644 .editorconfig create mode 100644 .gitattributes delete mode 100644 src/SixLabors.ruleset diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000000..b0d0662bf8 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,372 @@ +############################################################################### +# EditorConfig is awesome: http://EditorConfig.org +############################################################################### + +############################################################################### +# Top-most EditorConfig file +############################################################################### +root = true + +############################################################################### +# Set default behavior to: +# a UTF-8 encoding, +# Unix-style line endings, +# a newline ending the file, +# 4 space indentation, and +# trimming of trailing whitespace +############################################################################### +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +indent_style = space +indent_size = 4 +trim_trailing_whitespace = true + +############################################################################### +# Set file behavior to: +# 2 space indentation +############################################################################### +[*.{cmd,config,csproj,json,props,ps1,resx,sh,targets}] +indent_size = 2 + +############################################################################### +# Set file behavior to: +# Windows-style line endings, and +# tabular indentation +############################################################################### +[*.sln] +end_of_line = crlf +indent_style = tab + +############################################################################### +# Set dotnet naming rules to: +# suggest async members be pascal case suffixed with Async +# suggest const declarations be pascal case +# suggest interfaces be pascal case prefixed with I +# suggest parameters be camel case +# suggest private and internal static fields be camel case +# suggest private and internal fields be camel case +# suggest public and protected declarations be pascal case +# suggest static readonly declarations be pascal case +# suggest type parameters be prefixed with T +############################################################################### +[*.cs] +dotnet_naming_rule.async_members_should_be_pascal_case_suffixed_with_async.severity = suggestion +dotnet_naming_rule.async_members_should_be_pascal_case_suffixed_with_async.style = pascal_case_suffixed_with_async +dotnet_naming_rule.async_members_should_be_pascal_case_suffixed_with_async.symbols = async_members + +dotnet_naming_rule.const_declarations_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.const_declarations_should_be_pascal_case.style = pascal_case +dotnet_naming_rule.const_declarations_should_be_pascal_case.symbols = const_declarations + +dotnet_naming_rule.interfaces_should_be_pascal_case_prefixed_with_i.severity = suggestion +dotnet_naming_rule.interfaces_should_be_pascal_case_prefixed_with_i.style = pascal_case_prefixed_with_i +dotnet_naming_rule.interfaces_should_be_pascal_case_prefixed_with_i.symbols = interfaces + +dotnet_naming_rule.parameters_should_be_camel_case.severity = suggestion +dotnet_naming_rule.parameters_should_be_camel_case.style = camel_case +dotnet_naming_rule.parameters_should_be_camel_case.symbols = parameters + +dotnet_naming_rule.private_and_internal_static_fields_should_be_camel_case.severity = suggestion +dotnet_naming_rule.private_and_internal_static_fields_should_be_camel_case.style = camel_case +dotnet_naming_rule.private_and_internal_static_fields_should_be_camel_case.symbols = private_and_internal_static_fields + +dotnet_naming_rule.private_and_internal_fields_should_be_camel_case.severity = suggestion +dotnet_naming_rule.private_and_internal_fields_should_be_camel_case.style = camel_case +dotnet_naming_rule.private_and_internal_fields_should_be_camel_case.symbols = private_and_internal_fields + +dotnet_naming_rule.public_and_protected_declarations_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.public_and_protected_declarations_should_be_pascal_case.style = pascal_case +dotnet_naming_rule.public_and_protected_declarations_should_be_pascal_case.symbols = public_and_protected_declarations +dotnet_naming_symbols.public_and_protected_declarations.applicable_kinds = method, field, event, property + +dotnet_naming_rule.static_readonly_declarations_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.static_readonly_declarations_should_be_pascal_case.style = pascal_case +dotnet_naming_rule.static_readonly_declarations_should_be_pascal_case.symbols = static_readonly_declarations + +dotnet_naming_rule.type_parameters_should_be_pascal_case_prefixed_with_t.severity = suggestion +dotnet_naming_rule.type_parameters_should_be_pascal_case_prefixed_with_t.style = pascal_case_prefixed_with_t +dotnet_naming_rule.type_parameters_should_be_pascal_case_prefixed_with_t.symbols = type_parameters + +############################################################################### +# Set dotnet naming styles to define: +# camel case +# pascal case +# pascal case suffixed with Async +# pascal case prefixed with I +# pascal case prefixed with T +############################################################################### +[*.cs] +dotnet_naming_style.camel_case.capitalization = camel_case + +dotnet_naming_style.pascal_case.capitalization = pascal_case + +dotnet_naming_style.pascal_case_suffixed_with_async.capitalization = pascal_case +dotnet_naming_style.pascal_case_suffixed_with_async.required_suffix = Async + +dotnet_naming_style.pascal_case_prefixed_with_i.capitalization = pascal_case +dotnet_naming_style.pascal_case_prefixed_with_i.required_prefix = I + +dotnet_naming_style.pascal_case_prefixed_with_t.capitalization = pascal_case +dotnet_naming_style.pascal_case_prefixed_with_t.required_prefix = T + +############################################################################### +# Set dotnet naming symbols to: +# async members +# const declarations +# interfaces +# private and internal fields +# private and internal static fields +# public and protected declarations +# static readonly declarations +# type parameters +############################################################################### +[*.cs] +dotnet_naming_symbols.async_members.required_modifiers = async + +dotnet_naming_symbols.const_declarations.required_modifiers = const + +dotnet_naming_symbols.interfaces.applicable_kinds = interface + +dotnet_naming_symbols.parameters.applicable_kinds = parameter + +dotnet_naming_symbols.private_and_internal_fields.applicable_accessibilities = private, internal +dotnet_naming_symbols.private_and_internal_fields.applicable_kinds = field + +dotnet_naming_symbols.private_and_internal_static_fields.applicable_accessibilities = private, internal +dotnet_naming_symbols.private_and_internal_static_fields.applicable_kinds = field +dotnet_naming_symbols.private_and_internal_static_fields.required_modifiers = static + +dotnet_naming_symbols.public_and_protected_declarations.applicable_accessibilities = public, protected + +dotnet_naming_symbols.static_readonly_declarations.required_modifiers = static, readonly + +dotnet_naming_symbols.type_parameters.applicable_kinds = type_parameter + +############################################################################### +# Set dotnet sort options to: +# do not separate import directives into groups, and +# sort system directives first +############################################################################### +[*.cs] +dotnet_separate_import_directive_groups = false +dotnet_sort_system_directives_first = true + +############################################################################### +# Set dotnet style options to: +# suggest null-coalescing expressions, +# suggest collection-initializers, +# suggest explicit tuple names, +# suggest null-propogation +# suggest object-initializers, +# generate parentheses in arithmetic binary operators for clarity, +# generate parentheses in other binary operators for clarity, +# don't generate parentheses in other operators if unnecessary, +# generate parentheses in relational binary operators for clarity, +# warn when not using predefined-types for locals, parameters, and members, +# generate predefined-types of type names for member access, +# generate auto properties, +# suggest compound assignment, +# generate conditional expression over assignment, +# generate conditional expression over return, +# suggest inferred anonymous types, +# suggest inferred tuple names, +# suggest 'is null' checks over '== null', +# don't generate 'this.' and 'Me.' for events, +# warn when not using 'this.' and 'Me.' for fields, +# warn when not using 'this.' and 'Me.' for methods, +# warn when not using 'this.' and 'Me.' for properties, +# suggest readonly fields, and +# generate accessibility modifiers for non interface members +############################################################################### +[*.cs] +dotnet_style_coalesce_expression = true:suggestion +dotnet_style_collection_initializer = true:suggestion +dotnet_style_explicit_tuple_names = true:suggestion +dotnet_style_null_propagation = true:suggestion +dotnet_style_object_initializer = true:suggestion + +dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent +dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent +dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent +dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent + +dotnet_style_predefined_type_for_locals_parameters_members = true:warning +dotnet_style_predefined_type_for_member_access = true:silent + +dotnet_style_prefer_auto_properties = true:silent +dotnet_style_prefer_compound_assignment = true:suggestion +dotnet_style_prefer_conditional_expression_over_assignment = true:silent +dotnet_style_prefer_conditional_expression_over_return = true:silent +dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion +dotnet_style_prefer_inferred_tuple_names = true:suggestion +dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion + +dotnet_style_qualification_for_event = false:silent +dotnet_style_qualification_for_field = true:warning +dotnet_style_qualification_for_method = true:warning +dotnet_style_qualification_for_property = true:warning + +dotnet_style_readonly_field = true:suggestion +dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent + +############################################################################### +# Set dotnet style options to: +# suggest removing all unused parameters +############################################################################### +[*.cs] +dotnet_code_quality_unused_parameters = all:suggestion + +############################################################################### +# Set csharp indent options to: +# indent block contents, +# not indent braces, +# indent case contents, +# not indent case contents when block, +# indent labels one less than the current, and +# indent switch labels +############################################################################### +[*.cs] +csharp_indent_block_contents = true +csharp_indent_braces = false +csharp_indent_case_contents = true +csharp_indent_case_contents_when_block = false +csharp_indent_labels = one_less_than_current +csharp_indent_switch_labels = true + +############################################################################### +# Set csharp new-line options to: +# insert a new-line before "catch", +# insert a new-line before "else", +# insert a new-line before "finally", +# insert a new-line before members in anonymous-types, +# insert a new-line before members in object-initializers, and +# insert a new-line before all open braces +############################################################################### +[*.cs] +csharp_new_line_before_catch = true +csharp_new_line_before_else = true +csharp_new_line_before_finally = true + +csharp_new_line_before_members_in_anonymous_types = true +csharp_new_line_before_members_in_object_initializers = true + +csharp_new_line_before_open_brace = all + +############################################################################### +# Set csharp preserve options to: +# preserve single-line blocks, and +# preserve single-line statements +############################################################################### +[*.cs] +csharp_preserve_single_line_blocks = true +csharp_preserve_single_line_statements = true + +############################################################################### +# Set csharp space options to: +# remove any space after a cast, +# add a space after the colon in an inheritance clause, +# add a space after a comma, +# remove any space after a dot, +# add a space after keywords in control flow statements, +# add a space after a semicolon in a "for" statement, +# add a space before and after binary operators, +# remove space around declaration statements, +# add a space before the colon in an inheritance clause, +# remove any space before a comma, +# remove any space before a dot, +# remove any space before an open square-bracket, +# remove any space before a semicolon in a "for" statement, +# remove any space between empty square-brackets, +# remove any space between a method call's empty parameter list parenthesis, +# remove any space between a method call's name and its opening parenthesis, +# remove any space between a method call's parameter list parenthesis, +# remove any space between a method declaration's empty parameter list parenthesis, +# remove any space between a method declaration's name and its openening parenthesis, +# remove any space between a method declaration's parameter list parenthesis, +# remove any space between parentheses, and +# remove any space between square brackets +############################################################################### +[*.cs] +csharp_space_after_cast = false +csharp_space_after_colon_in_inheritance_clause = true +csharp_space_after_comma = true +csharp_space_after_dot = false +csharp_space_after_keywords_in_control_flow_statements = true +csharp_space_after_semicolon_in_for_statement = true + +csharp_space_around_binary_operators = before_and_after +csharp_space_around_declaration_statements = do_not_ignore + +csharp_space_before_colon_in_inheritance_clause = true +csharp_space_before_comma = false +csharp_space_before_dot = false +csharp_space_before_open_square_brackets = false +csharp_space_before_semicolon_in_for_statement = false + +csharp_space_between_empty_square_brackets = false +csharp_space_between_method_call_empty_parameter_list_parentheses = false +csharp_space_between_method_call_name_and_opening_parenthesis = false +csharp_space_between_method_call_parameter_list_parentheses = false +csharp_space_between_method_declaration_empty_parameter_list_parentheses = false +csharp_space_between_method_declaration_name_and_open_parenthesis = false +csharp_space_between_method_declaration_parameter_list_parentheses = false +csharp_space_between_parentheses = false +csharp_space_between_square_brackets = false + +############################################################################### +# Set csharp style options to: +# generate braces, +# suggest simple default expressions, +# generate a preferred modifier order, +# suggest conditional delegate calls, +# suggest deconstructed variable declarations, +# generate expression-bodied accessors, +# generate expression-bodied constructors, +# generate expression-bodied indexers, +# generate expression-bodied lambdas, +# generate expression-bodied methods, +# generate expression-bodied operators, +# generate expression-bodied properties, +# suggest inlined variable declarations, +# suggest local over anonymous functions, +# suggest pattern-matching over "as" with "null" check, +# suggest pattern-matching over "is" with "cast" check, +# suggest throw expressions, +# generate a discard variable for unused value expression statements, +# suggest a discard variable for unused assignments, +# warn when using var for built-in types, +# warn when using var when the type is not apparent, and +# warn when not using var when the type is apparent +############################################################################### +[*.cs] +csharp_prefer_braces = true:silent +csharp_prefer_simple_default_expression = true:suggestion +csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:silent + +csharp_style_conditional_delegate_call = true:suggestion +csharp_style_deconstructed_variable_declaration = true:suggestion + +csharp_style_expression_bodied_accessors = true:silent +csharp_style_expression_bodied_constructors = true:silent +csharp_style_expression_bodied_indexers = true:silent +csharp_style_expression_bodied_lambdas = true:silent +csharp_style_expression_bodied_methods = true:silent +csharp_style_expression_bodied_operators = true:silent +csharp_style_expression_bodied_properties = true:silent + +csharp_style_inlined_variable_declaration = true:suggestion + +csharp_style_pattern_local_over_anonymous_function = true:suggestion +csharp_style_pattern_matching_over_as_with_null_check = true:suggestion +csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion + +csharp_style_throw_expression = true:suggestion + +csharp_style_unused_value_expression_statement_preference = discard_variable:silent +csharp_style_unused_value_assignment_preference = discard_variable:suggestion + +csharp_style_var_for_built_in_types = false:warning +csharp_style_var_elsewhere = false:warning +csharp_style_var_when_type_is_apparent = true:warning diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000000..537d9cef11 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,108 @@ +############################################################################### +# Set default behavior to: +# treat as text and +# normalize to Unix-style line endings +############################################################################### +* text eol=lf + +############################################################################### +# Set explicit file behavior to: +# treat as text and +# normalize to Unix-style line endings +############################################################################### +*.asm text eol=lf +*.c text eol=lf +*.clj text eol=lf +*.cmd text eol=lf +*.cpp text eol=lf +*.css text eol=lf +*.cxx text eol=lf +*.config text eol=lf +*.DotSettings text eol=lf +*.erl text eol=lf +*.fs text eol=lf +*.fsx text eol=lf +*.h text eol=lf +*.htm text eol=lf +*.html text eol=lf +*.hs text eol=lf +*.hxx text eol=lf +*.java text eol=lf +*.js text eol=lf +*.json text eol=lf +*.less text eol=lf +*.lisp text eol=lf +*.lua text eol=lf +*.m text eol=lf +*.md text eol=lf +*.php text eol=lf +*.props text eol=lf +*.ps1 text eol=lf +*.py text eol=lf +*.rb text eol=lf +*.resx text eol=lf +*.runsettings text eol=lf +*.ruleset text eol=lf +*.sass text eol=lf +*.scss text eol=lf +*.sh text eol=lf +*.sql text eol=lf +*.svg text eol=lf +*.targets text eol=lf +*.tt text eol=crlf +*.ttinclude text eol=crlf +*.txt text eol=lf +*.vb text eol=lf +*.yml text eol=lf + +############################################################################### +# Set explicit file behavior to: +# treat as text +# normalize to Unix-style line endings and +# diff as csharp +############################################################################### +*.cs text eol=lf diff=csharp + +############################################################################### +# Set explicit file behavior to: +# treat as text +# normalize to Unix-style line endings and +# use a union merge when resoling conflicts +############################################################################### +*.csproj text eol=lf merge=union +*.dbproj text eol=lf merge=union +*.fsproj text eol=lf merge=union +*.ncrunchproject text eol=lf merge=union +*.vbproj text eol=lf merge=union + +############################################################################### +# Set explicit file behavior to: +# treat as text +# normalize to Windows-style line endings and +# use a union merge when resoling conflicts +############################################################################### +*.sln text eol=crlf merge=union + +############################################################################### +# Set explicit file behavior to: +# treat as binary +############################################################################### +*.bmp binary +*.dll binary +*.exe binary +*.gif binary +*.jpg binary +*.png binary +*.ttf binary +*.snk binary + +############################################################################### +# Set explicit file behavior to: +# diff as plain text +############################################################################### +*.doc diff=astextplain +*.docx diff=astextplain +*.dot diff=astextplain +*.pdf diff=astextplain +*.pptx diff=astextplain +*.rtf diff=astextplain diff --git a/shared-infrastructure b/shared-infrastructure index 10fa2a5d9f..9b5a5b70b4 160000 --- a/shared-infrastructure +++ b/shared-infrastructure @@ -1 +1 @@ -Subproject commit 10fa2a5d9f3e16ff01faa857b6eaf7833a7163ca +Subproject commit 9b5a5b70b46bc23b9d8d8645cd691d5bc5a2d84f diff --git a/src/SixLabors.Core/SixLabors.Core.csproj b/src/SixLabors.Core/SixLabors.Core.csproj index 2fb64cdf37..4611693b70 100644 --- a/src/SixLabors.Core/SixLabors.Core.csproj +++ b/src/SixLabors.Core/SixLabors.Core.csproj @@ -23,7 +23,7 @@ - ..\SixLabors.ruleset + ..\..\shared-infrastructure\SixLabors.ruleset @@ -39,9 +39,6 @@ - - ..\..\shared-infrastructure\SixLabors.ruleset - diff --git a/src/SixLabors.ruleset b/src/SixLabors.ruleset deleted file mode 100644 index 4106b892cf..0000000000 --- a/src/SixLabors.ruleset +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/tests/SixLabors.Core.Tests/Helpers/DebugGuardTests.cs b/tests/SixLabors.Core.Tests/Helpers/DebugGuardTests.cs index 3db5642d11..0b0d33090f 100644 --- a/tests/SixLabors.Core.Tests/Helpers/DebugGuardTests.cs +++ b/tests/SixLabors.Core.Tests/Helpers/DebugGuardTests.cs @@ -1,10 +1,11 @@ -// Copyright (c) Six Labors and contributors. +// Copyright (c) Six Labors and contributors. // Licensed under the Apache License, Version 2.0. // tell this file to enable debug conditional method calls, i.e. all the debug guard calls #define DEBUG using System; +using System.Collections.Generic; using System.Diagnostics; using System.Linq; using System.Reflection; @@ -21,12 +22,12 @@ namespace SixLabors.Helpers.Tests [Fact] public void AllStaticMethodsOnOnDebugGuardHaveDEBUGConditional() { - var methods = typeof(DebugGuard).GetTypeInfo().GetMethods() + IEnumerable methods = typeof(DebugGuard).GetTypeInfo().GetMethods() .Where(x => x.IsStatic); - foreach (var m in methods) + foreach (MethodInfo m in methods) { - var attribs = m.GetCustomAttributes(); + IEnumerable attribs = m.GetCustomAttributes(); Assert.True(attribs.Select(x => x.ConditionString).Contains("DEBUG"), $"Method '{m.Name}' does not have [Conditional(\"DEBUG\")] set."); } } @@ -41,7 +42,7 @@ namespace SixLabors.Helpers.Tests [Fact] public void NotNull_WhenNotNull() { - Foo foo = new Foo(); + var foo = new Foo(); Guard.NotNull(foo, nameof(foo)); } @@ -152,10 +153,8 @@ namespace SixLabors.Helpers.Tests [InlineData(1, 1)] public void MustBeLessThan_IsGreaterOrEqual_ThrowsNoException(int value, int max) { - var exception = Assert.Throws(() => - { - DebugGuard.MustBeLessThan(value, max, "myParamName"); - }); + ArgumentOutOfRangeException exception = Assert.Throws( + () => DebugGuard.MustBeLessThan(value, max, "myParamName")); Assert.Equal("myParamName", exception.ParamName); Assert.Contains($"Value {value} must be less than {max}.", exception.Message); @@ -172,10 +171,7 @@ namespace SixLabors.Helpers.Tests [Fact] public void MustBeLessThanOrEqualTo_IsGreater_ThrowsNoException() { - var exception = Assert.Throws(() => - { - DebugGuard.MustBeLessThanOrEqualTo(2, 1, "myParamName"); - }); + ArgumentOutOfRangeException exception = Assert.Throws(() => DebugGuard.MustBeLessThanOrEqualTo(2, 1, "myParamName")); Assert.Equal("myParamName", exception.ParamName); Assert.Contains($"Value 2 must be less than or equal to 1.", exception.Message); @@ -192,10 +188,8 @@ namespace SixLabors.Helpers.Tests [InlineData(1, 1)] public void MustBeGreaterThan_IsLessOrEqual_ThrowsNoException(int value, int min) { - var exception = Assert.Throws(() => - { - DebugGuard.MustBeGreaterThan(value, min, "myParamName"); - }); + ArgumentOutOfRangeException exception = Assert.Throws( + () => DebugGuard.MustBeGreaterThan(value, min, "myParamName")); Assert.Equal("myParamName", exception.ParamName); Assert.Contains($"Value {value} must be greater than {min}.", exception.Message); @@ -212,10 +206,8 @@ namespace SixLabors.Helpers.Tests [Fact] public void MustBeGreaterThanOrEqualTo_IsLess_ThrowsNoException() { - var exception = Assert.Throws(() => - { - DebugGuard.MustBeGreaterThanOrEqualTo(1, 2, "myParamName"); - }); + ArgumentOutOfRangeException exception = Assert.Throws( + () => DebugGuard.MustBeGreaterThanOrEqualTo(1, 2, "myParamName")); Assert.Equal("myParamName", exception.ParamName); Assert.Contains($"Value 1 must be greater than or equal to 2.", exception.Message); @@ -232,10 +224,8 @@ namespace SixLabors.Helpers.Tests [Fact] public void MustBeSizedAtLeast_Array_LengthIsLess_ThrowsException() { - var exception = Assert.Throws(() => - { - DebugGuard.MustBeSizedAtLeast(new int[] { 1, 2 }, 3, "myParamName"); - }); + ArgumentException exception = Assert.Throws( + () => DebugGuard.MustBeSizedAtLeast(new int[] { 1, 2 }, 3, "myParamName")); Assert.Equal("myParamName", exception.ParamName); Assert.Contains($"The size must be at least 3.", exception.Message); diff --git a/tests/SixLabors.Core.Tests/Helpers/GuardTests.cs b/tests/SixLabors.Core.Tests/Helpers/GuardTests.cs index a35668c38c..4b5ebbdfde 100644 --- a/tests/SixLabors.Core.Tests/Helpers/GuardTests.cs +++ b/tests/SixLabors.Core.Tests/Helpers/GuardTests.cs @@ -133,7 +133,7 @@ namespace SixLabors.Helpers.Tests [InlineData(1, 1)] public void MustBeLessThan_IsGreaterOrEqual_ThrowsNoException(int value, int max) { - var exception = Assert.Throws(() => + ArgumentOutOfRangeException exception = Assert.Throws(() => { Guard.MustBeLessThan(value, max, "myParamName"); }); @@ -153,7 +153,7 @@ namespace SixLabors.Helpers.Tests [Fact] public void MustBeLessThanOrEqualTo_IsGreater_ThrowsNoException() { - var exception = Assert.Throws(() => + ArgumentOutOfRangeException exception = Assert.Throws(() => { Guard.MustBeLessThanOrEqualTo(2, 1, "myParamName"); }); @@ -173,7 +173,7 @@ namespace SixLabors.Helpers.Tests [InlineData(1, 1)] public void MustBeGreaterThan_IsLessOrEqual_ThrowsNoException(int value, int min) { - var exception = Assert.Throws(() => + ArgumentOutOfRangeException exception = Assert.Throws(() => { Guard.MustBeGreaterThan(value, min, "myParamName"); }); @@ -193,7 +193,7 @@ namespace SixLabors.Helpers.Tests [Fact] public void MustBeGreaterThanOrEqualTo_IsLess_ThrowsNoException() { - var exception = Assert.Throws(() => + ArgumentOutOfRangeException exception = Assert.Throws(() => { Guard.MustBeGreaterThanOrEqualTo(1, 2, "myParamName"); }); @@ -216,7 +216,7 @@ namespace SixLabors.Helpers.Tests [InlineData(4, 1, 3)] public void MustBeBetweenOrEqualTo_IsLessOrGreater_ThrowsNoException(int value, int min, int max) { - var exception = Assert.Throws(() => + ArgumentOutOfRangeException exception = Assert.Throws(() => { Guard.MustBeBetweenOrEqualTo(value, min, max, "myParamName"); }); @@ -236,7 +236,7 @@ namespace SixLabors.Helpers.Tests [Fact] public void MustBeSizedAtLeast_Array_LengthIsLess_ThrowsException() { - var exception = Assert.Throws(() => + ArgumentException exception = Assert.Throws(() => { Guard.MustBeSizedAtLeast(new int[] { 1, 2 }, 3, "myParamName"); }); diff --git a/tests/SixLabors.Core.Tests/Memory/ArrayPoolMemoryAllocatorTests.cs b/tests/SixLabors.Core.Tests/Memory/ArrayPoolMemoryAllocatorTests.cs index 6f72a076e6..1c1d721674 100644 --- a/tests/SixLabors.Core.Tests/Memory/ArrayPoolMemoryAllocatorTests.cs +++ b/tests/SixLabors.Core.Tests/Memory/ArrayPoolMemoryAllocatorTests.cs @@ -66,7 +66,7 @@ namespace SixLabors.Memory.Tests [Fact] public void When_PoolSelectorThresholdInBytes_IsGreaterThan_MaxPooledBufferSizeInBytes_ExceptionIsThrown() { - Assert.ThrowsAny(() => { new ArrayPoolMemoryAllocator(100, 200); }); + Assert.ThrowsAny(() => new ArrayPoolMemoryAllocator(100, 200)); } } @@ -169,13 +169,13 @@ namespace SixLabors.Memory.Tests return; } - int arrayLengthThreshold = PoolSelectorThresholdInBytes / sizeof(int); + const int ArrayLengthThreshold = PoolSelectorThresholdInBytes / sizeof(int); - IMemoryOwner small = this.MemoryAllocator.Allocate(arrayLengthThreshold - 1); + IMemoryOwner small = this.MemoryAllocator.Allocate(ArrayLengthThreshold - 1); ref int ptr2Small = ref small.GetReference(); small.Dispose(); - IMemoryOwner large = this.MemoryAllocator.Allocate(arrayLengthThreshold + 1); + IMemoryOwner large = this.MemoryAllocator.Allocate(ArrayLengthThreshold + 1); Assert.False(Unsafe.AreSame(ref ptr2Small, ref large.GetReference())); } @@ -227,7 +227,7 @@ namespace SixLabors.Memory.Tests [StructLayout(LayoutKind.Sequential)] private struct Rgba32 { - private uint dummy; + private readonly uint dummy; } private const int SizeOfLargeStruct = MaxPooledBufferSizeInBytes / 5; @@ -242,7 +242,7 @@ namespace SixLabors.Memory.Tests [InlineData((int.MaxValue / SizeOfLargeStruct) + 1)] public void AllocateIncorrectAmount_ThrowsCorrect_ArgumentOutOfRangeException(int length) { - var ex = Assert.Throws(() => this.MemoryAllocator.Allocate(length)); + ArgumentOutOfRangeException ex = Assert.Throws(() => this.MemoryAllocator.Allocate(length)); Assert.Equal("length", ex.ParamName); } @@ -250,8 +250,8 @@ namespace SixLabors.Memory.Tests [InlineData(-1)] public void AllocateManagedByteBuffer_IncorrectAmount_ThrowsCorrect_ArgumentOutOfRangeException(int length) { - var ex = Assert.Throws(() => this.MemoryAllocator.AllocateManagedByteBuffer(length)); + ArgumentOutOfRangeException ex = Assert.Throws(() => this.MemoryAllocator.AllocateManagedByteBuffer(length)); Assert.Equal("length", ex.ParamName); } } -} \ No newline at end of file +} diff --git a/tests/SixLabors.Core.Tests/Memory/SimpleGcMemoryAllocatorTests.cs b/tests/SixLabors.Core.Tests/Memory/SimpleGcMemoryAllocatorTests.cs index 7b431126db..a22e9e375d 100644 --- a/tests/SixLabors.Core.Tests/Memory/SimpleGcMemoryAllocatorTests.cs +++ b/tests/SixLabors.Core.Tests/Memory/SimpleGcMemoryAllocatorTests.cs @@ -23,7 +23,7 @@ namespace SixLabors.Memory.Tests [InlineData(-1)] public void Allocate_IncorrectAmount_ThrowsCorrect_ArgumentOutOfRangeException(int length) { - var ex = Assert.Throws(() => this.MemoryAllocator.Allocate(length)); + ArgumentOutOfRangeException ex = Assert.Throws(() => this.MemoryAllocator.Allocate(length)); Assert.Equal("length", ex.ParamName); } @@ -31,7 +31,7 @@ namespace SixLabors.Memory.Tests [InlineData(-1)] public void AllocateManagedByteBuffer_IncorrectAmount_ThrowsCorrect_ArgumentOutOfRangeException(int length) { - var ex = Assert.Throws(() => this.MemoryAllocator.AllocateManagedByteBuffer(length)); + ArgumentOutOfRangeException ex = Assert.Throws(() => this.MemoryAllocator.AllocateManagedByteBuffer(length)); Assert.Equal("length", ex.ParamName); } diff --git a/tests/SixLabors.Core.Tests/Primitives/RectangleTests.cs b/tests/SixLabors.Core.Tests/Primitives/RectangleTests.cs index 2f56b9ecd6..84b15d36e0 100644 --- a/tests/SixLabors.Core.Tests/Primitives/RectangleTests.cs +++ b/tests/SixLabors.Core.Tests/Primitives/RectangleTests.cs @@ -173,11 +173,19 @@ namespace SixLabors.Primitives.Tests unchecked { - rCeiling = new Rectangle((int)Math.Ceiling(x), (int)Math.Ceiling(y), - (int)Math.Ceiling(width), (int)Math.Ceiling(height)); + rCeiling = new Rectangle( + (int)Math.Ceiling(x), + (int)Math.Ceiling(y), + (int)Math.Ceiling(width), + (int)Math.Ceiling(height)); + rTruncate = new Rectangle((int)x, (int)y, (int)width, (int)height); - rRound = new Rectangle((int)Math.Round(x), (int)Math.Round(y), - (int)Math.Round(width), (int)Math.Round(height)); + + rRound = new Rectangle( + (int)Math.Round(x), + (int)Math.Round(y), + (int)Math.Round(width), + (int)Math.Round(height)); } Assert.Equal(rCeiling, Rectangle.Ceiling(rect)); @@ -315,7 +323,7 @@ namespace SixLabors.Primitives.Tests [InlineData(0, 0, 0, 0)] public void DeconstructTest(int x, int y, int width, int height) { - Rectangle r = new Rectangle(x, y, width, height); + var r = new Rectangle(x, y, width, height); (int dx, int dy, int dw, int dh) = r; @@ -325,4 +333,4 @@ namespace SixLabors.Primitives.Tests Assert.Equal(height, dh); } } -} \ No newline at end of file +} diff --git a/tests/SixLabors.Core.Tests/SixLabors.Core.Tests.csproj b/tests/SixLabors.Core.Tests/SixLabors.Core.Tests.csproj index f33dde1c6f..45eeef1b73 100644 --- a/tests/SixLabors.Core.Tests/SixLabors.Core.Tests.csproj +++ b/tests/SixLabors.Core.Tests/SixLabors.Core.Tests.csproj @@ -19,7 +19,7 @@ - ..\SixLabors.ruleset + ..\..\shared-infrastructure\SixLabors.Tests.ruleset