Disallow compass azimuth outside range but allow finite angles

Author: mtrewartha

data/src/main/java/io/trewartha/positional/data/compass/AospCompassAzimuthRepository.kt

@@ -65,14 +65,14 @@ class AospCompassAzimuthRepository @Inject constructor(
             accelerometerAccuracy,
             magnetometerAccuracy
         ) { rotation, accelerometerAccuracy, magnetometerAccuracy ->
-            SensorManager.getOrientation(rotation, orientation)
             try {
+                SensorManager.getOrientation(rotation, orientation)
                 val angle = Angle.Degrees(
                     (Math.toDegrees(orientation[0].toDouble())
                         .toFloat() + DEGREES_360) % DEGREES_360
                 )
                 CompassAzimuth(angle, accelerometerAccuracy, magnetometerAccuracy)
-            } catch (_: IllegalArgumentException) {
+            } catch (_: Exception) {
                 null
             }
         }.filterNotNull()

data/src/main/java/io/trewartha/positional/data/compass/CompassAzimuth.kt

@@ -4,8 +4,10 @@ import io.trewartha.positional.data.measurement.Angle
 
 /**
  * Compass azimuth angle and accuracies associated with it
+ *
+ * @throws IllegalArgumentException if [angle] is outside of the range 0..<360
  */
-data class CompassAzimuth(
+data class CompassAzimuth @Throws(IllegalArgumentException::class) constructor(
 
     /**
      * Angle from north. A positive angle indicates the user is facing east of north and a negative
@@ -22,4 +24,13 @@ data class CompassAzimuth(
      * Accuracy of the magnetometer or `null` if unavailable
      */
     val magnetometerAccuracy: CompassAccuracy?
-)
+) {
+
+    init {
+        require(angle.inDegrees().value in VALID_RANGE) { "$angle is outside of range 0..<360" }
+    }
+}
+
+private const val DEGREES_0 = 0f
+private const val DEGREES_360 = 360f
+private val VALID_RANGE = DEGREES_0..<DEGREES_360

data/src/main/java/io/trewartha/positional/data/location/Conversions.kt

@@ -9,6 +9,7 @@ import io.trewartha.positional.data.measurement.Distance
 import io.trewartha.positional.data.measurement.Speed
 import kotlinx.datetime.Clock
 import kotlinx.datetime.Instant
+import timber.log.Timber
 
 fun AndroidLocation.toLocation(): Location = Location(
     coordinates = Coordinates(latitude, longitude),
@@ -72,7 +73,8 @@ internal val AndroidLocation.magneticDeclination: Angle?
         val alt = altitude.toFloat().takeIf { hasAltitude() && it.isFinite() } ?: 0f
         val millis = timestamp.toEpochMilliseconds()
         Angle.Degrees(GeomagneticField(lat, lon, alt, millis).declination)
-    } catch (_: IllegalArgumentException) {
+    } catch (exception: IllegalArgumentException) {
+        Timber.w(exception, "Unable to calculate magnetic declination")
         null
     }
 

data/src/main/java/io/trewartha/positional/data/measurement/Angle.kt

@@ -12,19 +12,16 @@ sealed interface Angle {
     ) : Angle {
 
         init {
-            require(value.isFinite()) { "Value must be finite" }
-            require(value in VALID_RANGE) { "Value is outside of range 0..<360" }
+            require(value.isFinite()) { "Value '$value' is not finite" }
         }
 
         override fun inDegrees(): Degrees = this
 
         override operator fun plus(other: Angle): Angle =
-            Degrees((value + other.inDegrees().value) % DEGREES_360)
+            Degrees((value + other.inDegrees().value + DEGREES_360) % DEGREES_360)
 
         override fun toString(): String = "${value}°"
     }
 }
 
-private const val DEGREES_0 = 0f
 private const val DEGREES_360 = 360f
-private val VALID_RANGE = DEGREES_0..<DEGREES_360

data/src/test/java/io/trewartha/positional/data/measurement/AngleTest.kt

@@ -6,21 +6,6 @@ import kotlin.test.assertFailsWith
 
 class AngleTest {
 
-    @Test
-    fun testIllegalArgumentExceptionThrownWhenValueIsLessThanZero() {
-        assertFailsWith<IllegalArgumentException> { Angle.Degrees(-0.0001f) }
-    }
-
-    @Test
-    fun testIllegalArgumentExceptionThrownWhenValueIsEqualTo360() {
-        assertFailsWith<IllegalArgumentException> { Angle.Degrees(360f) }
-    }
-
-    @Test
-    fun testIllegalArgumentExceptionThrownWhenValueIsGreaterThan360() {
-        assertFailsWith<IllegalArgumentException> { Angle.Degrees(360.0001f) }
-    }
-
     @Test
     fun testIllegalArgumentExceptionThrownWhenValueIsInfinite() {
         assertFailsWith<IllegalArgumentException> { Angle.Degrees(Float.POSITIVE_INFINITY) }