Merge pull request #84 from shinji-san/remove-ObsoleteIsValidMethods

Remove obsolete IsValid methods

Resolves: #84

Author: shinji-san

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+### Removed
+- Removed `Luhn.IsValid` methods
+
 ## [1.3.0] - 2024-12-27
 ### Added
 - Add project icon

src/Luhn.cs

@@ -52,6 +52,11 @@ public static class Luhn
         /// </summary>
         private const int Modulus = 10;
 
+        /// <summary>
+        /// Represents the ASCII code for the character '0'.
+        /// </summary>
+        private const int AsciiCodeForZero = 48;
+
 #if NET8_0_OR_GREATER
         /// <summary>
         /// Computes the Luhn check digit
@@ -63,7 +68,7 @@ public static class Luhn
         [SuppressMessage("ReSharper", "UnusedMember.Global")]
         [SuppressMessage("ReSharper", "HeapView.ObjectAllocation")]
         public static byte ComputeLuhnCheckDigit(this ReadOnlySpan<char> number) =>
-            (byte)((Modulus - number.IsNumber().GetDigits().DoubleEverySecondDigit(false).SumDigits()) % Modulus);
+            (byte)((Modulus - number.ValidateAndTrimNumber().GetDigits().DoubleEverySecondDigit(false).SumDigits()) % Modulus);
 #endif
 
         /// <summary>
@@ -79,7 +84,7 @@ public static byte ComputeLuhnCheckDigit(this string number) =>
 #if NET8_0_OR_GREATER
             number.AsSpan().ComputeLuhnCheckDigit();
 #else
-            (byte)((Modulus - number.IsNumber().GetDigits().DoubleEverySecondDigit(false).SumDigits()) % Modulus);
+            (byte)((Modulus - number.ValidateAndTrimNumber().GetDigits().DoubleEverySecondDigit(false).SumDigits()) % Modulus);
 #endif
 
 #if NET8_0_OR_GREATER
@@ -123,21 +128,6 @@ public static string ComputeLuhnNumber(this string number)
         }
 
 #if NET8_0_OR_GREATER
-        /// <summary>
-        /// Checks whether the Luhn Number is valid
-        /// </summary>
-        /// <param name="luhnNumber">An identification number w/ check digit (Luhn Number).</param>
-        /// <returns><see langword="true" /> if the <paramref name="luhnNumber"/> is valid;
-        /// otherwise <see langword="false" /></returns>
-        /// <exception cref="ArgumentException"><paramref name="luhnNumber"/> is not valid.
-        /// It contains none-numeric characters.</exception>
-        /// <remarks>The check digit must be at the end of the <paramref name="luhnNumber"/>
-        /// (on the right side).</remarks>
-        [SuppressMessage("ReSharper", "UnusedMember.Global")]
-        [SuppressMessage("ReSharper", "HeapView.ObjectAllocation")]
-        [Obsolete("Use the IsValidLuhnNumber method instead.", false)]
-        public static bool IsValid(this ReadOnlySpan<char> luhnNumber) => luhnNumber.IsValidLuhnNumber();
-
         /// <summary>
         /// Checks whether the Luhn Number is valid
         /// </summary>
@@ -151,24 +141,9 @@ public static string ComputeLuhnNumber(this string number)
         [SuppressMessage("ReSharper", "UnusedMember.Global")]
         [SuppressMessage("ReSharper", "HeapView.ObjectAllocation")]
         public static bool IsValidLuhnNumber(this ReadOnlySpan<char> luhnNumber) =>
-            luhnNumber.IsNumber().GetDigits().DoubleEverySecondDigit(true).SumDigits() == 0;
+            luhnNumber.ValidateAndTrimNumber().GetDigits().DoubleEverySecondDigit(true).SumDigits() == 0;
 #endif
 
-        /// <summary>
-        /// Checks whether the Luhn Number is valid
-        /// </summary>
-        /// <param name="luhnNumber">An identification number w/ check digit (Luhn Number).</param>
-        /// <returns><see langword="true" /> if the <paramref name="luhnNumber"/> is valid;
-        /// otherwise <see langword="false" /></returns>
-        /// <exception cref="ArgumentException"><paramref name="luhnNumber"/> is not valid.
-        /// It contains none-numeric characters.</exception>
-        /// <remarks>The check digit must be at the end of the <paramref name="luhnNumber"/>
-        /// (on the right side).</remarks>
-        [SuppressMessage("ReSharper", "UnusedMember.Global")]
-        [SuppressMessage("ReSharper", "HeapView.ObjectAllocation")]
-        [Obsolete("Use the IsValidLuhnNumber method instead.", false)]
-        public static bool IsValid(this string luhnNumber) => luhnNumber.IsValidLuhnNumber();
-
         /// <summary>
         /// Checks whether the Luhn Number is valid
         /// </summary>
@@ -185,27 +160,10 @@ public static bool IsValidLuhnNumber(this string luhnNumber) =>
 #if NET8_0_OR_GREATER
             luhnNumber.AsSpan().IsValidLuhnNumber();
 #else
-            luhnNumber.IsNumber().GetDigits().DoubleEverySecondDigit(true).SumDigits() == 0;
+            luhnNumber.ValidateAndTrimNumber().GetDigits().DoubleEverySecondDigit(true).SumDigits() == 0;
 #endif
 
 #if NET8_0_OR_GREATER
-        /// <summary>
-        /// Checks whether the concatenation of number and corresponding Luhn check digit is valid
-        /// </summary>
-        /// <param name="number">Identification number w/o Luhn check digit</param>
-        /// <param name="checkDigit">The Luhn check digit</param>
-        /// <returns><see langword="true" /> if the <paramref name="number"/> is valid;
-        /// otherwise <see langword="false" /></returns>
-        /// <exception cref="ArgumentException"><paramref name="number"/> is not valid.
-        /// It contains none-numeric characters.</exception>
-        /// <exception cref="ArgumentOutOfRangeException">The <paramref name="checkDigit"/> value is greater than 9.
-        /// The <paramref name="checkDigit"/> value must be between 0 and 9.</exception>
-        [SuppressMessage("ReSharper", "UnusedMember.Global")]
-        [SuppressMessage("ReSharper", "HeapView.ObjectAllocation")]
-        [Obsolete("Use the IsValidLuhnCheckDigit method instead.", false)]
-        public static bool IsValid(this ReadOnlySpan<char> number, byte checkDigit) =>
-            checkDigit.IsValidLuhnCheckDigit(number);
-
         /// <summary>
         /// Checks whether the concatenation of number and corresponding Luhn check digit is valid
         /// </summary>
@@ -231,29 +189,13 @@ public static bool IsValidLuhnCheckDigit(this byte checkDigit, ReadOnlySpan<char
 
             return string.Concat(number.Trim(), checkDigit.ToString(CultureInfo.InvariantCulture))
                 .AsSpan()
-                .IsNumber()
+                .ValidateAndTrimNumber()
                 .GetDigits()
                 .DoubleEverySecondDigit(true)
                 .SumDigits() == 0;
         }
 #endif
 
-        /// <summary>
-        /// Checks whether the concatenation of number and corresponding Luhn check digit is valid
-        /// </summary>
-        /// <param name="number">Identification number w/o Luhn check digit</param>
-        /// <param name="checkDigit">The Luhn check digit</param>
-        /// <returns><see langword="true" /> if the <paramref name="number"/> is valid;
-        /// otherwise <see langword="false" /></returns>
-        /// <exception cref="ArgumentException"><paramref name="number"/> is not valid.
-        /// It contains none-numeric characters.</exception>
-        /// <exception cref="ArgumentOutOfRangeException">The <paramref name="checkDigit"/> value is greater than 9.
-        /// The <paramref name="checkDigit"/> value must be between 0 and 9.</exception>
-        [SuppressMessage("ReSharper", "UnusedMember.Global")]
-        [SuppressMessage("ReSharper", "HeapView.ObjectAllocation")]
-        [Obsolete("Use the IsValidLuhnCheckDigit method instead.", false)]
-        public static bool IsValid(this string number, byte checkDigit) => checkDigit.IsValidLuhnCheckDigit(number);
-
         /// <summary>
         /// Checks whether the concatenation of number and corresponding Luhn check digit is valid
         /// </summary>
@@ -285,7 +227,7 @@ public static bool IsValidLuhnCheckDigit(this byte checkDigit, string number)
                     "{0}{1}",
                     number.Trim(),
                     checkDigit.ToString(CultureInfo.InvariantCulture))
-                .IsNumber()
+                .ValidateAndTrimNumber()
                 .GetDigits()
                 .DoubleEverySecondDigit(true)
                 .SumDigits() == 0;
@@ -357,12 +299,12 @@ public static string ConvertAlphaNumericToNumeric(this string alphaNumeric)
 #endif
 
         /// <summary>
-        /// Doubling of every second digit.
+        /// Doubles every second digit of the <paramref name="digits"/> enumeration.
         /// </summary>
         /// <param name="digits">The digits represent a number w/ or w/o check digit.</param>
         /// <param name="forValidation"><see langword="true"/> if the <paramref name="digits"/> represent
         /// a Luhn number including a check digit; otherwise <see langword="false"/></param>
-        /// <returns></returns>
+        /// <returns>Enumeration of digits</returns>
         private static IEnumerable<uint> DoubleEverySecondDigit(this IEnumerable<uint> digits, bool forValidation)
         {
             int index = 0;
@@ -399,7 +341,7 @@ private static IEnumerable<uint> DoubleEverySecondDigit(this IEnumerable<uint> d
         /// <param name="number">An identification number</param>
         /// <returns>The trimmed identification number if valid</returns>
         /// <exception cref="ArgumentException"><paramref name="number"/> is not a valid number</exception>
-        private static string IsNumber(this string number)
+        private static string ValidateAndTrimNumber(this string number)
         {
             string trimmedNumber = number?.Trim();
             if (string.IsNullOrWhiteSpace(trimmedNumber) || !Regex.IsMatch(trimmedNumber, @"^\d+$"))
@@ -418,7 +360,7 @@ private static string IsNumber(this string number)
         /// <param name="number">An identification number</param>
         /// <returns>The trimmed identification number if valid</returns>
         /// <exception cref="ArgumentException"><paramref name="number"/> is not a valid number</exception>
-        private static ReadOnlySpan<char> IsNumber(this ReadOnlySpan<char> number)
+        private static ReadOnlySpan<char> ValidateAndTrimNumber(this ReadOnlySpan<char> number)
         {
             var trimmedNumber = number.Trim();
             if (trimmedNumber.Length == 0 || !trimmedNumber.IsDigits())
@@ -460,7 +402,7 @@ private static IEnumerable<uint> GetDigits(this ReadOnlySpan<char> number)
             uint[] digits = new uint[number.Length];
             for (int i = 0; i < number.Length; i++)
             {
-                digits[number.Length - i - 1] = (uint)number[i] - 48;
+                digits[number.Length - i - 1] = (uint)number[i] - AsciiCodeForZero;
             }
 
             return digits;
@@ -470,7 +412,7 @@ private static IEnumerable<uint> GetDigits(this string number)
         {
             for (int i = number.Length - 1; i >= 0; i--)
             {
-                yield return (uint)number[i] - 48;
+                yield return (uint)number[i] - AsciiCodeForZero;
             }
         }
 #endif

tests/LuhnTest.cs

@@ -187,9 +187,7 @@ public void ComputeLuhnNumber_ValidRawNumber_ReturnsExpectedLuhnNumber(
         [MemberData(nameof(LuhnNumberValidationSet), MemberType = typeof(LuhnTest))]
         public void LuhnNumberValidationTest(bool expectedResult, string luhnNumber)
         {
-            Assert.Equal(expectedResult, luhnNumber.IsValid());
             Assert.Equal(expectedResult, luhnNumber.IsValidLuhnNumber());
-            Assert.Equal(expectedResult, luhnNumber.AsSpan().IsValid());
             Assert.Equal(expectedResult, luhnNumber.AsSpan().IsValidLuhnNumber());
         }
 
@@ -203,9 +201,7 @@ public void LuhnNumberValidationTest(bool expectedResult, string luhnNumber)
         [MemberData(nameof(LuhnCheckDigitValidationSet), MemberType = typeof(LuhnTest))]
         public void LuhnCheckDigitValidationTest(bool expectedResult, string number, byte checkDigit)
         {
-            Assert.Equal(expectedResult, number.IsValid(checkDigit));
             Assert.Equal(expectedResult, checkDigit.IsValidLuhnCheckDigit(number));
-            Assert.Equal(expectedResult, number.AsSpan().IsValid(checkDigit));
             Assert.Equal(expectedResult, checkDigit.IsValidLuhnCheckDigit(number.AsSpan()));
         }
 
@@ -243,9 +239,7 @@ public void ComputeLuhnNumber_InvalidRawNumber_ThrowsArgumentException(string in
         [MemberData(nameof(InvalidNumbers), MemberType = typeof(LuhnTest))]
         public void LuhnNumberValidationExceptionTest(string invalidNumber)
         {
-            Assert.Throws<ArgumentException>(() => invalidNumber.IsValid());
             Assert.Throws<ArgumentException>(() => invalidNumber.IsValidLuhnNumber());
-            Assert.Throws<ArgumentException>(() => invalidNumber.AsSpan().IsValid());
             Assert.Throws<ArgumentException>(() => invalidNumber.AsSpan().IsValidLuhnNumber());
         }
 
@@ -257,9 +251,7 @@ public void LuhnNumberValidationExceptionTest(string invalidNumber)
         [MemberData(nameof(InvalidNumbersAndCheckDigits), MemberType = typeof(LuhnTest))]
         public void NumberValidationExceptionTest(string invalidNumber, byte checkDigit)
         {
-            Assert.Throws<ArgumentException>(() => invalidNumber.IsValid(checkDigit));
             Assert.Throws<ArgumentException>(() => checkDigit.IsValidLuhnCheckDigit(invalidNumber));
-            Assert.Throws<ArgumentException>(() => invalidNumber.AsSpan().IsValid(checkDigit));
             Assert.Throws<ArgumentException>(() => checkDigit.IsValidLuhnCheckDigit(invalidNumber.AsSpan()));
         }
 
@@ -271,9 +263,7 @@ public void NumberValidationExceptionTest(string invalidNumber, byte checkDigit)
         [MemberData(nameof(NumbersWithInvalidCheckDigits), MemberType = typeof(LuhnTest))]
         public void LuhnCheckDigitValidationExceptionTest(string invalidNumber, byte checkDigit)
         {
-            Assert.Throws<ArgumentOutOfRangeException>(() => invalidNumber.IsValid(checkDigit));
             Assert.Throws<ArgumentOutOfRangeException>(() => checkDigit.IsValidLuhnCheckDigit(invalidNumber));
-            Assert.Throws<ArgumentOutOfRangeException>(() => invalidNumber.AsSpan().IsValid(checkDigit));
             Assert.Throws<ArgumentOutOfRangeException>(() => checkDigit.IsValidLuhnCheckDigit(invalidNumber.AsSpan()));
         }
 
@@ -340,9 +330,7 @@ public void ConvertAlphaNumericToNumeric_InvalidInput_ThrowsArgumentException()
         [MemberData(nameof(IsValidWithConvertData), MemberType = typeof(LuhnTest))]
         public void IsValidWithConvertTest(string input, bool expected)
         {
-            Assert.Equal(expected, input.ConvertAlphaNumericToNumeric().IsValid());
             Assert.Equal(expected, input.ConvertAlphaNumericToNumeric().IsValidLuhnNumber());
-            Assert.Equal(expected, input.ConvertAlphaNumericToNumeric().AsSpan().IsValid());
             Assert.Equal(expected, input.ConvertAlphaNumericToNumeric().AsSpan().IsValidLuhnNumber());
         }