feat: bring full implementation of library from outsystems-geolocation repo

References: https://outsystemsrd.atlassian.net/browse/RMET-3771

Author: alexgerardojacinto

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 OutSystems
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,3 @@
+# OSGeolocationLib-Android
+
+The `OSGeolocationLib-Android` is a library built using `Kotlin`.

build.gradle

@@ -1,31 +1,58 @@
 buildscript {
-    ext.kotlin_version = "1.5.21"
+    ext.kotlin_version = "1.9.24"
     ext.jacocoVersion = '0.8.7'
     repositories {
         google()
         mavenCentral()
+        maven {
+            url = uri("https://plugins.gradle.org/m2/")
+        }
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:7.1.2'
+        if (System.getenv("SHOULD_PUBLISH") == "true") {
+            classpath("io.github.gradle-nexus:publish-plugin:1.1.0")
+        }
+        classpath 'com.android.tools.build:gradle:8.2.2'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
         classpath "org.jacoco:org.jacoco.core:$jacocoVersion"
     }
 }
 
+plugins {
+    id "org.sonarqube" version "3.5.0.2730"
+}
+
+sonarqube {
+    properties {
+        property "sonar.projectKey", "OutSystems_OSGeolocationLib-Android"
+        property "sonar.organization", "outsystemsrd"
+        property "sonar.host.url", "https://sonarcloud.io"
+    }
+}
+
+if (System.getenv("SHOULD_PUBLISH") == "true") {
+    apply plugin: "io.github.gradle-nexus.publish-plugin"
+    apply from: file("./scripts/publish-root.gradle")
+}
+
 apply plugin: "com.android.library"
 apply plugin: "kotlin-android"
 apply plugin: "jacoco"
 
 android {
-    compileSdk 32
+    namespace "com.outsystems.plugins.osgeolocation"
+    compileSdk 35
 
     defaultConfig {
         minSdk 26
-        targetSdk 32
+        targetSdk 35
         versionCode 1
         versionName "1.0"
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+        vectorDrawables {
+            useSupportLibrary true
+        }
     }
 
     buildTypes {
@@ -35,23 +62,23 @@ android {
         }
     }
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_1_8
-        targetCompatibility JavaVersion.VERSION_1_8
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
     }
     kotlinOptions {
-        jvmTarget = '1.8'
+        jvmTarget = '17'
     }
 
     task jacocoTestReport(type: JacocoReport, dependsOn: ['testDebugUnitTest']) {
 
         reports {
-            xml.enabled = true
-            html.enabled = true
+            xml.getRequired().set(true)
+            html.getRequired().set(true)
         }
 
         def fileFilter = ['**/BuildConfig.*', '**/Manifest*.*']
-        def debugTree = fileTree(dir: "${buildDir}/tmp/kotlin-classes/debugUnitTest", excludes: fileFilter)
-        def mainSrc = "${project.projectDir}/src/main/java"
+        def debugTree = fileTree(dir: "${buildDir}/tmp/kotlin-classes/debug", excludes: fileFilter)
+        def mainSrc = "${project.projectDir}/src/main/kotlin"
 
         sourceDirectories.setFrom(files([mainSrc]))
         classDirectories.setFrom(files([debugTree]))
@@ -60,6 +87,24 @@ android {
                 "outputs/code-coverage/connected/*coverage.ec"
         ]))
     }
+
+    packaging {
+        resources {
+            excludes += '/META-INF/{AL2.0,LGPL2.1}'
+        }
+    }
+
+    testOptions {
+        unitTests.returnDefaultValues = true
+    }
+
+    lintOptions {
+        abortOnError false
+    }
+
+    publishing {
+        singleVariant("release")
+    }
 }
 
 repositories {
@@ -68,12 +113,22 @@ repositories {
 }
 
 dependencies {
+    implementation 'androidx.core:core-ktx:1.13.1'
+
+    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4'
+    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.7.3'
+    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-play-services:1.6.4'
+    implementation 'com.google.android.gms:play-services-location:21.3.0'
+    implementation 'com.google.android.gms:play-services-base:18.5.0'
+    implementation 'androidx.activity:activity:1.6.0'
+    implementation 'androidx.activity:activity-ktx:1.9.3'
 
-    implementation 'androidx.core:core-ktx:1.7.0'
-    implementation 'androidx.appcompat:appcompat:1.4.1'
-    implementation 'com.google.android.material:material:1.5.0'
-    implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
     testImplementation 'junit:junit:4.13.2'
-    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
-    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
+    testImplementation 'io.mockk:mockk:1.13.4'
+    testImplementation 'app.cash.turbine:turbine:1.2.0'
+    testImplementation 'org.jetbrains.kotlinx:kotlinx-coroutines-test:1.7.3'
 }
+
+if (System.getenv("SHOULD_PUBLISH") == "true") {
+    apply from: file("./scripts/publish-module.gradle")
+}

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 #Fri Apr 08 08:58:08 WEST 2022
 distributionBase=GRADLE_USER_HOME
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.2-bin.zip
 distributionPath=wrapper/dists
 zipStorePath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME

pom.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+             http://maven.apache.org/maven-v4_0_0.xsd">
+
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.outsystems</groupId>
+    <artifactId>osgeolocation-android</artifactId>
+    <version>0.0.1</version>
+</project>

pull_request_template.md

@@ -0,0 +1,32 @@
+## Description
+<!--- Describe your changes in detail -->
+
+## Context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- Place the link to the issue here -->
+
+## Type of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply -->
+- [ ] Fix (non-breaking change which fixes an issue)
+- [ ] Feature (non-breaking change which adds functionality)
+- [ ] Refactor (cosmetic changes)
+- [ ] Breaking change (change that would cause existing functionality to not work as expected)
+
+## Platforms affected
+- [ ] Android
+- [ ] iOS
+- [ ] JavaScript
+
+## Tests
+<!--- Describe how you tested your changes in detail -->
+<!--- Include details of your test environment if relevant -->
+
+## Screenshots (if appropriate)
+
+## Checklist
+<!--- Go over all the following items and put an `x` in all the boxes that apply -->
+- [ ] Pull request title follows the format `RNMT-XXXX <title>`
+- [ ] Code follows code style of this project
+- [ ] CHANGELOG.md file is correctly updated
+- [ ] Changes require an update to the documentation
+	- [ ] Documentation has been updated accordingly

scripts/publish-android.sh

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+
+ANDROID_PATH=../
+LOG_OUTPUT=./tmp/publish-android.txt
+THE_VERSION=`sed -n 's/.*<version>\(.*\)<\/version>.*/\1/p' ../pom.xml`
+
+# Get latest io.ionic:portals XML version info
+PUBLISHED_URL="https://repo1.maven.org/maven2/com/capacitorjs/geolocationlib-android/maven-metadata.xml"
+PUBLISHED_DATA=$(curl -s $PUBLISHED_URL)
+PUBLISHED_VERSION="$(perl -ne 'print and last if s/.*<latest>(.*)<\/latest>.*/\1/;' <<< $PUBLISHED_DATA)"
+
+if [[ "$THE_VERSION" == "$PUBLISHED_VERSION" ]]; then
+    printf %"s\n\n" "Duplicate: a published version exists for $THE_VERSION, skipping..."
+else
+    # Make log dir if doesnt exist
+    mkdir -p ./tmp
+
+    # Export ENV variable used by Gradle for Versioning
+    export THE_VERSION
+    export SHOULD_PUBLISH=true
+
+    printf %"s\n" "Attempting to build and publish version $THE_VERSION"
+    "$ANDROID_PATH"/gradlew clean build publishReleasePublicationToSonatypeRepository closeAndReleaseSonatypeStagingRepository --no-daemon --max-workers 1 -b "$ANDROID_PATH"/build.gradle -Pandroid.useAndroidX=true > $LOG_OUTPUT 2>&1
+    # "$ANDROID_PATH"/gradlew clean build publishReleasePublicationToSonatypeRepository --no-daemon --max-workers 1 -b "$ANDROID_PATH"/build.gradle -Pandroid.useAndroidX=true > $LOG_OUTPUT 2>&1
+
+    echo $RESULT
+
+    if grep --quiet "BUILD SUCCESSFUL" $LOG_OUTPUT; then
+        printf %"s\n" "Success: Published to MavenCentral."
+    else
+        printf %"s\n" "Error publishing, check $LOG_OUTPUT for more info! Manually review and release from the Sonatype Repository Manager may be necessary https://s01.oss.sonatype.org/"
+        cat $LOG_OUTPUT
+        exit 1
+    fi
+
+fi

scripts/publish-module.gradle

@@ -0,0 +1,79 @@
+apply plugin: 'maven-publish'
+apply plugin: 'signing'
+
+def LIB_VERSION = System.getenv('THE_VERSION')
+
+task androidSourcesJar(type: Jar) {
+    archiveClassifier.set('sources')
+    //if (project.plugins.findPlugin("com.android.library")) {
+        from android.sourceSets.main.java.srcDirs
+        from android.sourceSets.main.kotlin.srcDirs
+    //} else {
+    //    from sourceSets.main.java.srcDirs
+    //    from sourceSets.main.kotlin.srcDirs
+    //}
+}
+
+artifacts {
+    archives androidSourcesJar
+}
+
+group = 'com.capacitorjs'
+version = LIB_VERSION
+
+afterEvaluate {
+    publishing {
+        publications {
+            release(MavenPublication) {
+                // Coordinates
+                groupId 'com.capacitorjs'
+                artifactId 'osgeolocationlib-android'
+                version LIB_VERSION
+
+                // Two artifacts, the `aar` (or `jar`) and the sources
+                if (project.plugins.findPlugin("com.android.library")) {
+                    from components.release
+                } else {
+                    artifact("$buildDir/libs/${project.getName()}-${version}.jar")
+                }
+
+                artifact androidSourcesJar
+
+                // POM Data
+                pom {
+                    name = 'geolocationlib-android'
+                    description = 'Geolocation Android Lib'
+                    url = 'https://github.com/ionic-team/outsystems-geolocation/packages/android-lib'
+                    licenses {
+                        license {
+                            name = 'License'
+                            url = 'https://github.com/ionic-team/outsystems-geolocation/blob/main/packages/android-lib/LICENSE'
+                        }
+                    }
+                    developers {
+                        developer {
+                            name = 'Ionic'
+                            email = '[email protected]'
+                        }
+                    }
+
+                    // Version Control Info
+                    scm {
+                        connection = 'scm:git:github.com:ionic-team/outsystems-geolocation.git'
+                        developerConnection = 'scm:git:ssh://github.com:ionic-team/outsystems-geolocation.git'
+                        url = 'https://github.com/ionic-team/outsystems-geolocation/tree/main'
+                    }
+                }
+            }
+        }
+    }
+}
+
+signing {
+    useInMemoryPgpKeys(
+        rootProject.ext["signing.keyId"],
+        rootProject.ext["signing.key"],
+        rootProject.ext["signing.password"],
+    )
+    sign publishing.publications
+}

scripts/publish-root.gradle

@@ -0,0 +1,37 @@
+// Create variables with empty default values
+ext["signing.keyId"] = ''
+ext["signing.key"] = ''
+ext["signing.password"] = ''
+ext["ossrhUsername"] = ''
+ext["ossrhPassword"] = ''
+ext["sonatypeStagingProfileId"] = ''
+
+File secretPropsFile = file('./local.properties')
+if (secretPropsFile.exists()) {
+    // Read local.properties file first if it exists
+    Properties p = new Properties()
+    new FileInputStream(secretPropsFile).withCloseable { is -> p.load(is) }
+    p.each { name, value -> ext[name] = value }
+} else {
+    // Use system environment variables
+    ext["ossrhUsername"] = System.getenv('ANDROID_OSSRH_USERNAME')
+    ext["ossrhPassword"] = System.getenv('ANDROID_OSSRH_PASSWORD')
+    ext["sonatypeStagingProfileId"] = System.getenv('ANDROID_SONATYPE_STAGING_PROFILE_ID')
+    ext["signing.keyId"] = System.getenv('ANDROID_SIGNING_KEY_ID')
+    ext["signing.key"] = System.getenv('ANDROID_SIGNING_KEY')
+    ext["signing.password"] = System.getenv('ANDROID_SIGNING_PASSWORD')
+}
+
+// Set up Sonatype repository
+nexusPublishing {
+    repositories {
+        sonatype {
+            stagingProfileId = sonatypeStagingProfileId
+            username = ossrhUsername
+            password = ossrhPassword
+            nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/"))
+            snapshotRepositoryUrl.set(uri("https://s01.oss.sonatype.org/content/repositories/snapshots/"))
+        }
+    }
+    repositoryDescription = 'OSGeolocation Lib v' + System.getenv('THE_VERSION')
+}