Add original nmea message to all kind of error, this makes errors eas…

…ier to analyze

CHANGELOG.md

@@ -1,9 +1,13 @@
+0.7.2
+--------------
+- Add original nmea message to all kind of error, this makes errors easier to analyze
+- Bump libraries
+
 0.7.1 (2023-11-20)
 --------------
 - Add observeBarometricAltitudeAndAccuracyUpdates to get barometric altitude along with accuracy state + allow observeBarometricAltitudeUpdates to specify minimum accuracy to filters events
 - Bump libraries
 
-
 0.7.0 (2022-10-19)
 --------------
 - Add Nmea throwIfContentInvalid parameter to allow more flexibility when parsing nmea by not throwing any error when content is mal formatted

gradle.properties

@@ -22,7 +22,7 @@ kotlin.code.style=official
 SONATYPE_HOST=DEFAULT
 RELEASE_SIGNING_ENABLED=true
 GROUP=net.samystudio.rxlocationmanager
-VERSION_NAME=0.7.2
+VERSION_NAME=0.7.2-SNAPSHOT
 POM_URL=https://github.com/SamYStudiO/RxLocationManager/
 POM_SCM_URL=https://github.com/SamYStudiO/RxLocationManager/
 POM_SCM_CONNECTION=scm:git:git://github.com/SamYStudiO/RxLocationManager.git

rx-location-manager-nmea/src/main/kotlin/net/samystudio/rxlocationmanager/nmea/Nmea.kt

@@ -19,7 +19,7 @@ abstract class Nmea(val message: String, throwIfContentInvalid: Boolean = true)
             throw NmeaException(BLANK_ERROR_MESSAGE)
         }
         if (!message.startsWith("$")) {
-            throw NmeaException(MISSING_DOLLAR_ERROR_MESSAGE, 0)
+            throw NmeaException(getMissingDollarErrorMessage(message), 0)
         }
 
         val validators =
@@ -34,13 +34,14 @@ abstract class Nmea(val message: String, throwIfContentInvalid: Boolean = true)
         }
 
         if (!message.contains("*")) {
-            throw NmeaException(CANNOT_FIND_CHECKSUM_ERROR_MESSAGE)
+            throw NmeaException(getCannotFindChecksumErrorMessage(message))
         }
         if (computeChecksum() != checksum) {
             throw NmeaException(
                 getChecksumErrorMessage(
                     checksum,
                     computeChecksum(),
+                    message
                 ),
             )
         }
@@ -71,10 +72,13 @@ abstract class Nmea(val message: String, throwIfContentInvalid: Boolean = true)
     companion object {
         private const val CANNOT_PARSE_INDEX_ERROR_MESSAGE =
             "Cannot parse message at index %s with validator %s from source %s"
-        private const val CHECKSUM_ERROR_MESSAGE = "Message checksum %s doesn't match %s"
+        private const val CHECKSUM_ERROR_MESSAGE =
+            "Message checksum %s doesn't match %s from source %s"
         internal const val BLANK_ERROR_MESSAGE = "Message is blank"
-        internal const val MISSING_DOLLAR_ERROR_MESSAGE = "Message should stat with $"
-        internal const val CANNOT_FIND_CHECKSUM_ERROR_MESSAGE = "Cannot find checksum from message"
+        internal const val MISSING_DOLLAR_ERROR_MESSAGE =
+            "Message should stat with $ from source %s"
+        internal const val CANNOT_FIND_CHECKSUM_ERROR_MESSAGE =
+            "Cannot find checksum from source %s"
 
         internal fun computeChecksum(message: String): String {
             val data = message.split("*")[0]
@@ -97,6 +101,15 @@ abstract class Nmea(val message: String, throwIfContentInvalid: Boolean = true)
         internal fun getChecksumErrorMessage(
             expectedChecksum: String,
             actualChecksum: String,
-        ) = CHECKSUM_ERROR_MESSAGE.format(expectedChecksum, actualChecksum)
+            message: String,
+        ) = CHECKSUM_ERROR_MESSAGE.format(expectedChecksum, actualChecksum, message)
+
+        internal fun getMissingDollarErrorMessage(
+            message: String,
+        ) = MISSING_DOLLAR_ERROR_MESSAGE.format(message)
+
+        internal fun getCannotFindChecksumErrorMessage(
+            message: String,
+        ) = CANNOT_FIND_CHECKSUM_ERROR_MESSAGE.format(message)
     }
 }