Merge pull request #71 from mikifus/room-database-refactor

Huge refactor

Author: mikifus

README.md

@@ -1,17 +1,33 @@
 # Padland
 Padland is a tool to manage, share, remember and read collaborative documents based on the Etherpad technology in Android.
 
-<a href="https://f-droid.org/repository/browse/?fdid=com.mikifus.padland" target="_blank">
-<img src="https://f-droid.org/badge/get-it-on.png" height="90"/></a>
-
-<a href='https://play.google.com/store/apps/details?id=com.mikifus.padland'>
-<img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png'  height="90" /></a>
-
-![Introduction screenshot 1](fastlane/metadata/android/en-US/images/phoneScreenshots/1.png)
-![Introduction screenshot 2](fastlane/metadata/android/en-US/images/phoneScreenshots/2.png)
-![Introduction screenshot 3](fastlane/metadata/android/en-US/images/phoneScreenshots/3.png)
-![Introduction screenshot 4](fastlane/metadata/android/en-US/images/phoneScreenshots/4.png)
-![Introduction screenshot 5](fastlane/metadata/android/en-US/images/phoneScreenshots/5.png)
+<p align="center" style="text-align:center;">
+  <a href="https://f-droid.org/repository/browse/?fdid=com.mikifus.padland" alt='Download from F-Droid' target="_blank">
+    <img src="https://f-droid.org/badge/get-it-on.png" height="90"/>
+  </a>
+
+  <a href='https://play.google.com/store/apps/details?id=com.mikifus.padland'>
+    <img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png'  height="90" />
+  </a>
+</p>
+
+<p align="center" style="text-align:center;">
+  <img alt='Padland Logo' src='./metadata/en-US/images/icon.png'  height="90" />
+</p>
+
+<p align="center" style="text-align:center;">
+  <picture>
+    <source media="(prefers-color-scheme: light)" srcset="./metadata/en-US/images/phoneScreenshots/1.png">
+    <source media="(prefers-color-scheme: dark)" srcset="./metadata/en-US/images/phoneScreenshots/2.png">
+    <img alt="Screenshot 1" src="./metadata/en-US/images/phoneScreenshots/1.png" width="150">
+  </picture>
+
+  <picture>
+    <source media="(prefers-color-scheme: light)" srcset="./metadata/en-US/images/phoneScreenshots/3.png">
+    <source media="(prefers-color-scheme: dark)" srcset="./metadata/en-US/images/phoneScreenshots/4.png">
+    <img alt="Screenshot 2" src="./metadata/en-US/images/phoneScreenshots/3.png" width="150">
+  </picture>
+</p>
 
 ## Translations
 Thanks to all the volunteers that already contributed!
@@ -30,16 +46,21 @@ To try your new server create a new pad and choose it. You can make it the defau
 
 ## Opening a URL
 
-The user can now share an URL to the app in order to open it. Keep in mind that the host server must be previously added, otherwise the URL will be considered unsafe. 
+The user can now share a URL to the app in order to open it. Keep in mind that the host server must be previously added, otherwise the URL will be considered unsafe.
 
 ## Current version
-2.0
+3.0
+
+### v3.0
+- Migrated database to Room.
+- Better implementation of Material Design.
+- Extreme refactoring keeping the same features and adding some minor ones.
+- Export and import data.
 
-## 
 ### v2.0
 - Migrated code to Kotlin.
 - Implemented AndroidX and Material Design.
-- Theme dark/light follows device
+- Theme dark/light follows device.
 
 ### v1.9
 - Fixed a vulnerability.

app/build.gradle

@@ -1,31 +1,38 @@
 apply plugin: "com.android.application"
 apply plugin: 'kotlin-android'
+apply plugin: 'kotlin-kapt'
+apply plugin: 'androidx.room'
 
 android {
     signingConfigs {
         release {
         }
     }
-    compileSdkVersion 33
     defaultConfig {
+        compileSdk 34
         applicationId "com.mikifus.padland"
-        minSdkVersion 14
-        targetSdkVersion 33
-        versionName '2.0'
-        versionCode 25
+        minSdkVersion 19
+        targetSdkVersion 34
+        versionName '3.0'
+        versionCode 26
         multiDexEnabled true
-//        vectorDrawables.useSupportLibrary = true
+        vectorDrawables.useSupportLibrary = true
+        testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
+    }
+
+    // used by Room, to test migrations
+    sourceSets {
+        getByName("androidTest").assets.srcDir("$projectDir/schemas")
     }
+
     buildTypes {
         debug {
             pseudoLocalesEnabled true
             minifyEnabled false
-            buildConfigField "Boolean", "DEBUG_MODE", "true"
             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
         }
         release {
             minifyEnabled true
-            buildConfigField "Boolean", "DEBUG_MODE", "false"
             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
             signingConfig signingConfigs.release
         }
@@ -36,24 +43,53 @@ android {
         disable 'InvalidPackage'
     }
     namespace 'com.mikifus.padland'
-    defaultConfig {
-        vectorDrawables.useSupportLibrary = true
-    }
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_17
         targetCompatibility JavaVersion.VERSION_17
     }
     kotlinOptions {
         jvmTarget = '17'
     }
+    testOptions {
+        unitTests {
+            includeAndroidResources = true
+        }
+    }
+}
+
+room {
+    schemaDirectory("$projectDir/schemas")
 }
 
 dependencies {
-    implementation 'androidx.core:core-ktx:1.10.1'
-    implementation 'com.pnikosis:materialish-progress:1.7'
-    implementation 'com.github.paolorotolo:appintro:4.1.0'
-    implementation 'androidx.recyclerview:recyclerview:1.3.1'
-    implementation 'com.google.android.material:material:1.9.0'
+    implementation 'androidx.core:core-ktx:1.12.0'
+    implementation 'com.github.paolorotolo:appintro:6.3.1'
+    implementation 'androidx.recyclerview:recyclerview:1.3.2'
+    implementation 'com.google.android.material:material:1.11.0'
+    implementation 'androidx.recyclerview:recyclerview-selection:1.1.0'
+    implementation 'com.android.support.constraint:constraint-layout:2.0.4'
+    implementation "androidx.preference:preference-ktx:1.2.1"
+    implementation 'com.github.martin-stone:hsv-alpha-color-picker-android:3.1.0'
+    implementation 'com.google.code.gson:gson:2.10'
+    implementation 'androidx.webkit:webkit:1.10.0'
+
+    // Room database
+    def room_version = "2.6.1"
+
+    implementation("androidx.room:room-runtime:$room_version")
+    annotationProcessor("androidx.room:room-compiler:$room_version")
+
+    // To use Kotlin annotation processing tool (kapt)
+    kapt("androidx.room:room-compiler:$room_version")
+    // To use Kotlin Symbol Processing (KSP)
+    annotationProcessor("androidx.room:room-compiler:$room_version")
+
+//    // optional - Kotlin Extensions and Coroutines support for Room
+    implementation("androidx.room:room-ktx:$room_version")
+
+    implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:2.7.0"
+    implementation "androidx.lifecycle:lifecycle-runtime-ktx:2.7.0"
+
 
     constraints {
         implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.8.0") {
@@ -63,4 +99,20 @@ dependencies {
             because("kotlin-stdlib-jdk8 is now a part of kotlin-stdlib")
         }
     }
+
+    // 'androidTest' dependencies for instrumentation (tests on device).
+    // These are for room database migration test.
+    androidTestImplementation "androidx.test.ext:junit-ktx:1.1.5"
+    androidTestImplementation "androidx.room:room-testing:2.6.1"
+    androidTestImplementation "androidx.test:runner:1.5.2"
+
+
+    // 'test' dependencies to run unit tests from the IDE
+    testImplementation "androidx.test.ext:junit-ktx:1.1.5"
+    testImplementation 'org.robolectric:robolectric:4.11.1'
+
+    // AndroidJUnitRunner and JUnit Rules
+    testImplementation "androidx.test:runner:1.5.2"
+    testImplementation "androidx.test:rules:1.5.0"
+
 }