refactored exception messages and messages formats, removed unused

Author: petesramek

src/PolylineAlgorithm/Coordinate.cs

@@ -5,6 +5,7 @@
 
 namespace PolylineAlgorithm;
 
+using PolylineAlgorithm.Properties;
 using System;
 using System.Diagnostics;
 using System.Globalization;
@@ -44,11 +45,11 @@ public Coordinate() {
     /// </exception>
     public Coordinate(double latitude, double longitude) {
         if (latitude < -90 || latitude > 90 || double.IsNaN(latitude) || double.IsInfinity(latitude)) {
-            throw new ArgumentOutOfRangeException(nameof(latitude), "Latitude must be between -90 and 90.");
+            throw new ArgumentOutOfRangeException(nameof(latitude), string.Format(ExceptionMessageResource.CoordinateValueMustBeBetweenValuesMessageFormat, "Latitude", -90, 90));
         }
 
         if (longitude < -180 || longitude > 180 || double.IsNaN(longitude) || double.IsInfinity(longitude)) {
-            throw new ArgumentOutOfRangeException(nameof(longitude), "Longitude must be between -180 and 180.");
+            throw new ArgumentOutOfRangeException(nameof(longitude), string.Format(ExceptionMessageResource.CoordinateValueMustBeBetweenValuesMessageFormat, "Longitude", -180, 180));
         }
 
         Latitude = latitude;

src/PolylineAlgorithm/InvalidPolylineException.cs

@@ -37,7 +37,7 @@ private InvalidPolylineException(string message)
     /// <exception cref="InvalidPolylineException">
     /// Always thrown to indicate that the polyline is malformed at the specified position.
     /// </exception>
-    public static void Throw(long position) {
+    internal static void Throw(long position) {
         Debug.Assert(position >= 0, "Position must be a non-negative value.");
 
         throw new InvalidPolylineException(string.Format(ExceptionMessageResource.PolylineStringIsMalformedMessage, position.ToString()));

src/PolylineAlgorithm/Polyline.cs

@@ -5,6 +5,7 @@
 
 namespace PolylineAlgorithm;
 
+using PolylineAlgorithm.Properties;
 using System;
 using System.Diagnostics;
 using System.Runtime.InteropServices;
@@ -70,8 +71,8 @@ public void CopyTo(char[] destination) {
             throw new ArgumentNullException(nameof(destination));
         }
 
-        if (Length != destination.Length) {
-            throw new ArgumentException("Destination array length must match the polyline's length.", nameof(destination));
+        if (destination.Length < Length) {
+            throw new ArgumentException(ExceptionMessageResource.DestinationArrayLengthMustBeEqualOrGreaterThanPolylineLengthMessage, nameof(destination));
         }
 
         _value.CopyTo(destination);

src/PolylineAlgorithm/PolylineEncoding.cs

@@ -92,12 +92,12 @@ public static bool TryReadValue(ref int variance, ref ReadOnlyMemory<char> buffe
     public static double Denormalize(int value, CoordinateValueType type) {
         // Validate that the type is not None, as it does not represent a valid coordinate value type.
         if (type == CoordinateValueType.None) {
-            throw new ArgumentOutOfRangeException(nameof(type), string.Format(ExceptionMessageResource.ArgumentCannotBeCoordinateCoordinateValueTypeErrorFormat, type.ToString()));
+            throw new ArgumentOutOfRangeException(nameof(type), string.Format(ExceptionMessageResource.ArgumentCannotBeCoordinateValueTypeMessageFormat, type.ToString()));
         }
 
         // Validate that the value is finite and within the acceptable range for the specified type.
         if (!ValidateValue(value, type)) {
-            throw new ArgumentOutOfRangeException(nameof(value), value, string.Format(ExceptionMessageResource.ArgumentIsOutOfRangeForSpecifiedType, type.ToString().ToLowerInvariant()));
+            throw new ArgumentOutOfRangeException(nameof(value), value, string.Format(ExceptionMessageResource.ArgumentOutOfRangeForSpecifiedCoordinateValueTypeMessageFormat, type.ToString().ToLowerInvariant()));
         }
 
         // Return fast if the value is zero, return 0.0 as the denormalized value.
@@ -181,7 +181,7 @@ public static bool TryWriteValue(int variance, ref Span<char> buffer, ref int po
     public static int Normalize(double value, CoordinateValueType type) {
         // Validate that the type is not None, as it does not represent a valid coordinate value type.
         if (type == CoordinateValueType.None) {
-            throw new ArgumentOutOfRangeException(nameof(type), string.Format(ExceptionMessageResource.ArgumentCannotBeCoordinateCoordinateValueTypeErrorFormat, type.ToString()));
+            throw new ArgumentOutOfRangeException(nameof(type), string.Format(ExceptionMessageResource.ArgumentCannotBeCoordinateValueTypeMessageFormat, type.ToString()));
         }
 
         // Validate that the value is finite and not NaN or Infinity.
@@ -191,7 +191,7 @@ public static int Normalize(double value, CoordinateValueType type) {
 
         // Validate that the value is within the acceptable range for the specified type.
         if (!ValidateValue(value, type)) {
-            throw new ArgumentOutOfRangeException(nameof(value), value, string.Format(ExceptionMessageResource.ArgumentIsOutOfRangeForSpecifiedType, type.ToString().ToLowerInvariant()));
+            throw new ArgumentOutOfRangeException(nameof(value), value, string.Format(ExceptionMessageResource.ArgumentOutOfRangeForSpecifiedCoordinateValueTypeMessageFormat, type.ToString().ToLowerInvariant()));
         }
 
         // Fast return if the value is zero, return 0 as the normalized value.

src/PolylineAlgorithm/PolylineEncodingOptions.cs

@@ -15,7 +15,7 @@ namespace PolylineAlgorithm;
 /// <remarks>
 /// This class allows you to set options such as buffer size and logger factory for encoding operations.
 /// </remarks>
-[DebuggerDisplay("BufferSize: {BufferSize}, MaxBufferLength: {MaxBufferLength}, LoggerFactoryType: {LoggerFactory.GetType().Name}")]
+[DebuggerDisplay("BufferSizeInBytes: {BufferSizeInBytes}, MaxBufferLength: {MaxBufferLength}, LoggerFactoryType: {LoggerFactory.GetType().Name}")]
 public sealed class PolylineEncodingOptions {
     /// <summary>
     /// Gets the maximum buffer size for encoding operations.

src/PolylineAlgorithm/PolylineEncodingOptionsBuilder.cs

@@ -7,6 +7,7 @@ namespace PolylineAlgorithm;
 
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Abstractions;
+using PolylineAlgorithm.Properties;
 
 /// <summary>
 /// Provides a builder for configuring options for polyline encoding operations.
@@ -51,7 +52,7 @@ public PolylineEncodingOptions Build() {
     /// </returns>
     /// <exception cref="ArgumentOutOfRangeException">Thrown when <paramref name="maxBufferSize"/> is less than or equal to 11.</exception>
     public PolylineEncodingOptionsBuilder WithBufferSize(int maxBufferSize) {
-        _bufferSize = maxBufferSize > 11 ? maxBufferSize : throw new ArgumentOutOfRangeException(nameof(maxBufferSize), "Buffer size must be greater than 11.");
+        _bufferSize = maxBufferSize > 11 ? maxBufferSize : throw new ArgumentOutOfRangeException(nameof(maxBufferSize), string.Format(ExceptionMessageResource.BufferSizeMustBeGreaterThanMessageFormat, 11));
 
         return this;
     }
@@ -69,7 +70,7 @@ public PolylineEncodingOptionsBuilder WithBufferSize(int maxBufferSize) {
     /// Thrown when <paramref name="loggerFactory"/> is <see langword="null"/>.
     /// </exception>
     public PolylineEncodingOptionsBuilder WithLoggerFactory(ILoggerFactory loggerFactory) {
-        _loggerFactory = loggerFactory ?? throw new ArgumentNullException(nameof(loggerFactory), "Logger factory cannot be null.");
+        _loggerFactory = loggerFactory ?? throw new ArgumentNullException(nameof(loggerFactory));
 
         return this;
     }

src/PolylineAlgorithm/Properties/ExceptionMessageResource.Designer.cs

@@ -117,34 +117,31 @@
   <resheader name="writer">
     <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
   </resheader>
-  <data name="CoordinatesAreInvalidErrorMessage" xml:space="preserve">
-    <value>One or more coordinates are invalid. Check InnerExceptions property for details.</value>
-  </data>
   <data name="ArgumentCannotBeEmptyEnumerationMessage" xml:space="preserve">
     <value>Argument cannot be an empty enumeration.</value>
   </data>
-  <data name="CoordinateIsOutOfRangeMessageFormat" xml:space="preserve">
-    <value>Latitude {0} or longitude {1} is not valid. Latitude must be in range between -90 and +90. Longitude must be in range between -180 and +180.</value>
-  </data>
   <data name="PolylineStringIsMalformedMessage" xml:space="preserve">
     <value>Polyline is malformed at position {0}.</value>
   </data>
-  <data name="ArgumentMinCannotBeGreaterOfEqualThanMaxArgumentMessageFormat" xml:space="preserve">
-    <value>Argument {0} cannot be greater or equal than {1}.</value>
-  </data>
   <data name="PolylineCannotBeShorterThanExceptionMessage" xml:space="preserve">
     <value>Argument cannot be shorten than 2 characters. Actual length: {0}.</value>
   </data>
   <data name="ArgumentValueMustBeFiniteNumber" xml:space="preserve">
     <value>Value must be a finite number.</value>
   </data>
-  <data name="ArgumentIsOutOfRangeForSpecifiedType" xml:space="preserve">
+  <data name="ArgumentOutOfRangeForSpecifiedCoordinateValueTypeMessageFormat" xml:space="preserve">
     <value>Value is out of range for the specified type {0}.</value>
   </data>
-  <data name="ArgumentCannotBeNullEmptyOrWhiteSpaceMessage" xml:space="preserve">
-    <value>Argument cannot be null -or- empty -or- white space.</value>
-  </data>
-  <data name="ArgumentCannotBeCoordinateCoordinateValueTypeErrorFormat" xml:space="preserve">
+  <data name="ArgumentCannotBeCoordinateValueTypeMessageFormat" xml:space="preserve">
     <value>Argument cannot be CoordinateValueType.{0}.</value>
   </data>
+  <data name="BufferSizeMustBeGreaterThanMessageFormat" xml:space="preserve">
+    <value>Buffer size must be greater than {0}.</value>
+  </data>
+  <data name="DestinationArrayLengthMustBeEqualOrGreaterThanPolylineLengthMessage" xml:space="preserve">
+    <value>Destination array length must be greater than the polyline length.</value>
+  </data>
+  <data name="CoordinateValueMustBeBetweenValuesMessageFormat" xml:space="preserve">
+    <value>{0} must be between {1} and {2}.</value>
+  </data>
 </root>

src/PolylineAlgorithm/Properties/ExceptionMessageResource.resx

@@ -164,10 +164,6 @@ protected override (double Latitude, double Longitude) CreateCoordinate(double l
         }
 
         protected override ReadOnlyMemory<char> GetReadOnlyMemory(string? polyline) {
-            if (string.IsNullOrWhiteSpace(polyline)) {
-                throw new ArgumentException(ExceptionMessageResource.ArgumentCannotBeNullEmptyOrWhiteSpaceMessage, nameof(polyline));
-            }
-
             return polyline.AsMemory();
         }
     }