Merge pull request #36 from icerockdev/#35-compose-multiplatform

#35 compose multiplatform

Author: Alex009

README.md

@@ -16,6 +16,7 @@ This is a Kotlin Multiplatform library that provides geolocation to common code.
 
 ## Features
 - **Geolocation tracking** - track user geolocation from common code;
+- **Compose Multiplatform** support;
 
 ## Requirements
 - Gradle version 6.0+
@@ -35,7 +36,10 @@ allprojects {
 project build.gradle
 ```groovy
 dependencies {
-    commonMainApi("dev.icerock.moko:geo:0.5.0")
+    commonMainApi("dev.icerock.moko:geo:0.6.0")
+
+    // Compose Multiplatform
+    commonMainApi("dev.icerock.moko:geo-compose:0.6.0")
 }
 ```
 

build.gradle.kts

@@ -15,6 +15,8 @@ buildscript {
         classpath(libs.mokoGradlePlugin)
         classpath(libs.mobileMultiplatformGradlePlugin)
         classpath(libs.kotlinSerializationGradlePlugin)
+        classpath(libs.composeJetBrainsGradlePlugin)
+        classpath(libs.detektGradlePlugin)
     }
 }
 

geo-compose/build.gradle.kts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2023 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+plugins {
+    id("dev.icerock.moko.gradle.multiplatform.mobile")
+    id("dev.icerock.moko.gradle.publication")
+    id("dev.icerock.moko.gradle.stub.javadoc")
+    id("dev.icerock.moko.gradle.detekt")
+    id("org.jetbrains.compose")
+}
+
+android {
+    namespace = "dev.icerock.moko.geo.compose"
+
+    defaultConfig {
+        minSdk = 21
+    }
+}
+
+dependencies {
+    commonMainApi(projects.geo)
+    commonMainApi(compose.runtime)
+
+    androidMainImplementation(libs.appCompat)
+    androidMainImplementation(compose.foundation)
+}

geo-compose/src/androidMain/kotlin/dev/icerock/moko/geo/compose/BindLocationTrackerEffect.android.kt

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2023 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.geo.compose
+
+import android.content.Context
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.ui.platform.LocalContext
+import androidx.compose.ui.platform.LocalLifecycleOwner
+import androidx.fragment.app.FragmentActivity
+import androidx.fragment.app.FragmentManager
+import androidx.lifecycle.LifecycleOwner
+import dev.icerock.moko.geo.LocationTracker
+
+@Suppress("FunctionNaming")
+@Composable
+actual fun BindLocationTrackerEffect(locationTracker: LocationTracker) {
+    val lifecycleOwner: LifecycleOwner = LocalLifecycleOwner.current
+    val context: Context = LocalContext.current
+
+    LaunchedEffect(locationTracker, lifecycleOwner, context) {
+        val fragmentManager: FragmentManager = (context as FragmentActivity).supportFragmentManager
+
+        locationTracker.bind(lifecycleOwner.lifecycle, context, fragmentManager)
+    }
+}

geo-compose/src/androidMain/kotlin/dev/icerock/moko/geo/compose/LocationTrackerFactory.android.kt

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2023 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.geo.compose
+
+import android.content.Context
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.remember
+import androidx.compose.ui.platform.LocalContext
+import com.google.android.gms.location.LocationRequest
+import dev.icerock.moko.geo.LocationTracker
+import dev.icerock.moko.permissions.PermissionsController
+
+@Composable
+actual fun rememberLocationTrackerFactory(accuracy: LocationTrackerAccuracy): LocationTrackerFactory {
+    val context: Context = LocalContext.current
+    return remember(context) {
+        object : LocationTrackerFactory {
+            override fun createLocationTracker(): LocationTracker {
+                return LocationTracker(
+                    permissionsController = PermissionsController(
+                        applicationContext = context.applicationContext
+                    ),
+                    priority = accuracy.toPriority()
+                )
+            }
+
+            override fun createLocationTracker(
+                permissionsController: PermissionsController
+            ): LocationTracker {
+                return LocationTracker(
+                    permissionsController = permissionsController,
+                    priority = accuracy.toPriority()
+                )
+            }
+        }
+    }
+}
+
+private fun LocationTrackerAccuracy.toPriority(): Int {
+    return when (this) {
+        LocationTrackerAccuracy.Best -> LocationRequest.PRIORITY_HIGH_ACCURACY
+        LocationTrackerAccuracy.Medium -> LocationRequest.PRIORITY_BALANCED_POWER_ACCURACY
+        LocationTrackerAccuracy.LowPower -> LocationRequest.PRIORITY_LOW_POWER
+    }
+}

geo-compose/src/commonMain/kotlin/dev/icerock/moko/geo/compose/BindLocationTrackerEffect.kt

@@ -0,0 +1,12 @@
+/*
+ * Copyright 2023 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.geo.compose
+
+import androidx.compose.runtime.Composable
+import dev.icerock.moko.geo.LocationTracker
+
+@Suppress("FunctionNaming")
+@Composable
+expect fun BindLocationTrackerEffect(locationTracker: LocationTracker)

geo-compose/src/commonMain/kotlin/dev/icerock/moko/geo/compose/LocationTrackerFactory.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2023 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.geo.compose
+
+import androidx.compose.runtime.Composable
+import dev.icerock.moko.geo.LocationTracker
+import dev.icerock.moko.permissions.PermissionsController
+
+interface LocationTrackerFactory {
+    fun createLocationTracker(): LocationTracker
+    fun createLocationTracker(permissionsController: PermissionsController): LocationTracker
+}
+
+enum class LocationTrackerAccuracy {
+    Best,
+    Medium,
+    LowPower
+}
+
+@Composable
+expect fun rememberLocationTrackerFactory(accuracy: LocationTrackerAccuracy): LocationTrackerFactory

geo-compose/src/iosMain/kotlin/dev/icerock/moko/geo/compose/BindLocationTrackerEffect.ios.kt

@@ -0,0 +1,13 @@
+/*
+ * Copyright 2023 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.geo.compose
+
+import androidx.compose.runtime.Composable
+import dev.icerock.moko.geo.LocationTracker
+
+// on iOS side we should not do anything to prepare LocationTracker to work
+@Suppress("FunctionNaming")
+@Composable
+actual fun BindLocationTrackerEffect(locationTracker: LocationTracker) = Unit

geo-compose/src/iosMain/kotlin/dev/icerock/moko/geo/compose/LocationTrackerFactory.ios.kt

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2023 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.geo.compose
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.remember
+import dev.icerock.moko.geo.LocationTracker
+import dev.icerock.moko.permissions.PermissionsController
+import platform.CoreLocation.CLLocationAccuracy
+import platform.CoreLocation.kCLLocationAccuracyBest
+import platform.CoreLocation.kCLLocationAccuracyKilometer
+import platform.CoreLocation.kCLLocationAccuracyReduced
+
+@Composable
+actual fun rememberLocationTrackerFactory(accuracy: LocationTrackerAccuracy): LocationTrackerFactory {
+    return remember {
+        object : LocationTrackerFactory {
+            override fun createLocationTracker(): LocationTracker {
+                return LocationTracker(
+                    permissionsController = dev.icerock.moko.permissions.ios.PermissionsController(),
+                    accuracy = accuracy.toIosAccuracy()
+                )
+            }
+
+            override fun createLocationTracker(
+                permissionsController: PermissionsController
+            ): LocationTracker {
+                return LocationTracker(
+                    permissionsController = permissionsController,
+                    accuracy = accuracy.toIosAccuracy()
+                )
+            }
+        }
+    }
+}
+
+private fun LocationTrackerAccuracy.toIosAccuracy(): CLLocationAccuracy {
+    return when (this) {
+        LocationTrackerAccuracy.Best -> kCLLocationAccuracyBest
+        LocationTrackerAccuracy.Medium -> kCLLocationAccuracyKilometer
+        LocationTrackerAccuracy.LowPower -> kCLLocationAccuracyReduced
+    }
+}

geo/src/androidMain/kotlin/dev/icerock/moko/geo/LocationTracker.kt

@@ -15,6 +15,7 @@ import com.google.android.gms.location.FusedLocationProviderClient
 import com.google.android.gms.location.LocationCallback
 import com.google.android.gms.location.LocationRequest
 import com.google.android.gms.location.LocationResult
+import com.google.android.gms.location.LocationServices
 import dev.icerock.moko.permissions.Permission
 import dev.icerock.moko.permissions.PermissionsController
 import kotlinx.coroutines.CoroutineScope
@@ -44,7 +45,7 @@ actual class LocationTracker(
     fun bind(lifecycle: Lifecycle, context: Context, fragmentManager: FragmentManager) {
         permissionsController.bind(lifecycle, fragmentManager)
 
-        locationProviderClient = FusedLocationProviderClient(context)
+        locationProviderClient = LocationServices.getFusedLocationProviderClient(context)
 
         @SuppressLint("MissingPermission")
         if (isStarted) {
@@ -63,7 +64,7 @@ actual class LocationTracker(
     override fun onLocationResult(locationResult: LocationResult) {
         super.onLocationResult(locationResult)
 
-        val lastLocation = locationResult.lastLocation
+        val lastLocation = locationResult.lastLocation ?: return
 
         val speedAccuracy = if (Build.VERSION.SDK_INT < Build.VERSION_CODES.O) null
         else lastLocation.speedAccuracyMetersPerSecond.toDouble()