Merge pull request #11 from ImaginativeShohag/dev

Dependencies updated, readme updated, latex, event class, ignoreCrash, userCase etc added

Author: ImaginativeShohag

README.md

@@ -2,10 +2,6 @@
 
 A simple Android MVVM pattern example and template.
 
-## Android Studio Version
-
-- Android Studio Arctic Fox | 2020.3.1 Patch 2
-
 ## Used Components/Libraries
 
 - Kotlin
@@ -26,9 +22,13 @@ A simple Android MVVM pattern example and template.
 
 ## Others
 
-- Build variant (https://developer.android.com/studio/build/build-variants)
+- Custom Build variant (https://developer.android.com/studio/build/build-variants)
+- Environment variable based on Build variant
 - Custom Snackbar
 - Dark Mode
+- Awesome module naming example (see `AwesomeModuleConstants`)
+- Dynamic accent color from image (see `calculatePaletteInImage()`)
+- Simple Encryption Utils (see `EncryptionUtils`)
 
 ## Extension Functions (see `utils/extensions`)
 
@@ -56,7 +56,8 @@ A simple Android MVVM pattern example and template.
 - `SharedPref`
 - `AlarmUtils`
 - `LocationProviderUtilClient`
-- `Event` Class
+- `Event` Class: Get notified for identical values in LiveData, Channel, Flow etc.
+- `ignoreCrash { }`: Ignore exceptions for a block.
 
 ## Todo
 

app/build.gradle

@@ -10,13 +10,14 @@ plugins {
 }
 
 android {
-    compileSdkVersion 31
-    buildToolsVersion "31.0.0"
+    namespace 'org.imaginativeworld.simplemvvm'
+    compileSdkVersion 33
+    buildToolsVersion "33.0.0"
 
     defaultConfig {
         applicationId "org.imaginativeworld.simplemvvm"
         minSdkVersion 21
-        targetSdkVersion 31
+        targetSdkVersion 33
         versionCode 1
         versionName "1.0.0.000000" // Major.Minor.Patch.YYMMDD
         vectorDrawables.useSupportLibrary = true
@@ -25,25 +26,50 @@ android {
 
         javaCompileOptions {
             annotationProcessorOptions {
-                arguments += [
-                        "room.schemaLocation"  : "$projectDir/schemas".toString(),
-                        "room.incremental"     : "true",
-                        "room.expandProjection": "true"
-                ]
+                arguments += ["room.schemaLocation"  : "$projectDir/schemas".toString(),
+                              "room.incremental"     : "true",
+                              "room.expandProjection": "true"]
             }
         }
+        signingConfig signingConfigs.debug
     }
 
     buildTypes {
-        debug {
+        local { // Local
+            initWith debug
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+
+            loadConfigurationProperties it, "config/internal.properties"
+
+            matchingFallbacks = ['debug']
+        }
+
+        debug { // Development
             debuggable true
+            minifyEnabled false
             applicationIdSuffix ".debug"
             versionNameSuffix "-debug"
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+
+            loadConfigurationProperties it, "config/development.properties"
+        }
+
+        staging { // Staging
+            initWith debug
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+
+            loadConfigurationProperties it, "config/staging.properties"
+
+            matchingFallbacks = ['release']
         }
-        release {
+
+        release { // Production
+            debuggable false
             minifyEnabled true
             shrinkResources true
-            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+
+            loadConfigurationProperties it, "config/release.properties"
         }
     }
 
@@ -68,16 +94,15 @@ android {
 
     kotlinOptions {
         jvmTarget = "1.8"
-        useIR = true
         freeCompilerArgs += "-Xopt-in=kotlin.RequiresOptIn"
         freeCompilerArgs += "-Xallow-jvm-ir-dependencies"
         // Enable experimental coroutines APIs, including Flow
         freeCompilerArgs += '-Xopt-in=kotlin.Experimental'
     }
 
     buildFeatures {
-        viewBinding = true
-        dataBinding = true
+        viewBinding true
+        dataBinding true
 
         // Disable unused AGP features
         // buildConfig false
@@ -86,63 +111,72 @@ android {
         resValues false
         shaders false
     }
+
+    signingConfigs {
+        debug {
+            storeFile file('../debug.keystore')
+            storePassword 'android'
+            keyAlias 'androiddebugkey'
+            keyPassword 'android'
+        }
+    }
 }
 
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-    implementation 'androidx.appcompat:appcompat:1.3.1'
-    implementation 'androidx.core:core-ktx:1.6.0'
-    implementation 'androidx.constraintlayout:constraintlayout:2.1.0'
+    implementation 'androidx.appcompat:appcompat:1.6.1'
+    implementation 'androidx.core:core-ktx:1.9.0'
+    implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
 
     testImplementation 'junit:junit:4.13.2'
-    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
-    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
+    androidTestImplementation 'androidx.test.ext:junit:1.1.5'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
 
     // Material Design
-    implementation 'com.google.android.material:material:1.4.0'
+    implementation 'com.google.android.material:material:1.8.0'
 
     // Retrofit
     implementation 'com.squareup.retrofit2:retrofit:2.9.0'
-    implementation 'com.squareup.okhttp3:logging-interceptor:4.9.1'
+    implementation 'com.squareup.okhttp3:logging-interceptor:4.9.3'
 
     // Moshi
     implementation 'com.squareup.retrofit2:converter-moshi:2.9.0'
-    implementation "com.squareup.moshi:moshi-kotlin:1.12.0"
-    kapt "com.squareup.moshi:moshi-kotlin-codegen:1.12.0"
+    implementation "com.squareup.moshi:moshi-kotlin:1.14.0"
+    kapt "com.squareup.moshi:moshi-kotlin-codegen:1.14.0"
 
     // Gson
-    implementation 'com.google.code.gson:gson:2.8.7'
+    implementation 'com.google.code.gson:gson:2.10.1'
 
     // ViewModel and LiveData
     implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycle_version"
     implementation "androidx.lifecycle:lifecycle-livedata-ktx:$lifecycle_version"
-    implementation "androidx.lifecycle:lifecycle-common-java8:2.3.1"
+    implementation "androidx.lifecycle:lifecycle-common:$lifecycle_version"
     implementation "androidx.lifecycle:lifecycle-runtime-ktx:$lifecycle_version"
 
     // Kotlin Coroutines
-    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.5.1"
-    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.1"
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4"
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4"
 
     // Room Persistence Library
-    implementation "androidx.room:room-runtime:2.3.0"
-    kapt "androidx.room:room-compiler:2.3.0"
+    implementation "androidx.room:room-runtime:$room_version"
+    kapt "androidx.room:room-compiler:$room_version"
 
     // Room: Kotlin Extensions and Coroutines support for Room
-    implementation "androidx.room:room-ktx:2.3.0"
+    implementation "androidx.room:room-ktx:$room_version"
 
     // Android Navigation Architecture
-    implementation "androidx.navigation:navigation-fragment-ktx:2.3.5"
-    implementation "androidx.navigation:navigation-ui-ktx:2.3.5"
+    implementation "androidx.navigation:navigation-fragment-ktx:2.5.3"
+    implementation "androidx.navigation:navigation-ui-ktx:2.5.3"
 
     // Glide
-    implementation 'com.github.bumptech.glide:glide:4.12.0'
-    kapt 'com.github.bumptech.glide:compiler:4.12.0'
+    implementation 'com.github.bumptech.glide:glide:4.15.1'
+    kapt 'com.github.bumptech.glide:compiler:4.15.1'
 
     // Paging
-    implementation "androidx.paging:paging-runtime-ktx:3.0.1"
+    implementation "androidx.paging:paging-runtime-ktx:3.1.1"
 
     // Permission
-    implementation 'com.karumi:dexter:6.2.2'
+    implementation 'com.karumi:dexter:6.2.3'
 
     // Timber
     implementation 'com.jakewharton.timber:timber:5.0.1'
@@ -155,17 +189,17 @@ dependencies {
     implementation 'com.facebook.shimmer:shimmer:0.5.0'
 
     // Firebase BoM
-    implementation platform('com.google.firebase:firebase-bom:28.2.0')
+    implementation platform('com.google.firebase:firebase-bom:31.2.3')
 
     // Firebase Libraries
     implementation 'com.google.firebase:firebase-analytics-ktx'
     implementation 'com.google.firebase:firebase-messaging-ktx'
 
     // Maps
-    implementation 'com.google.android.gms:play-services-maps:17.0.1'
+    implementation 'com.google.android.gms:play-services-maps:18.1.0'
 
     // Location
-    implementation 'com.google.android.gms:play-services-location:18.0.0'
+    implementation 'com.google.android.gms:play-services-location:21.0.1'
 
     // Image compressor
     implementation 'id.zelory:compressor:3.0.1'
@@ -174,16 +208,28 @@ dependencies {
     implementation 'org.imaginativeworld.oopsnointernet:oopsnointernet:2.0.0'
 
     // Image Carousel
-    implementation "org.imaginativeworld.whynotimagecarousel:whynotimagecarousel:2.0.2"
+    implementation "org.imaginativeworld.whynotimagecarousel:whynotimagecarousel:2.1.0"
 
     // OneSignal SDK
-    implementation 'com.onesignal:OneSignal:4.5.1'
+    implementation 'com.onesignal:OneSignal:4.8.5'
 
     // Coil
-    implementation("io.coil-kt:coil:1.3.2")
+    implementation("io.coil-kt:coil:2.2.2")
 
     // Palette
     implementation 'androidx.palette:palette-ktx:1.0.0'
+
+    // Markdown
+    implementation "io.noties.markwon:core:$markwon_version"
+    implementation "io.noties.markwon:ext-latex:$markwon_version"
+    implementation "io.noties.markwon:inline-parser:$markwon_version"
+
+    // Latex
+    implementation "ru.noties:jlatexmath-android:$jlatexmath_version"
+    // for Cyrillic symbols
+    implementation "ru.noties:jlatexmath-android-font-cyrillic:$jlatexmath_version"
+    // for Greek symbols
+    implementation "ru.noties:jlatexmath-android-font-greek:$jlatexmath_version"
 }
 
 // Workaround for OneSignal from:
@@ -194,4 +240,14 @@ tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).configureEach {
     kotlinOptions {
         jvmTarget = "1.8"
     }
+}
+
+/**
+ * Load properties from configuration file.
+ */
+def loadConfigurationProperties(buildType, String fileLocation) {
+    Properties properties = new Properties()
+    properties.load(project.rootProject.file(fileLocation).newDataInputStream())
+
+    buildType.buildConfigField "String", "BASE_URL", "\"${properties.getProperty("baseUrl")}\""
 }

app/schemas/org.imaginativeworld.simplemvvm.db.AppDatabase/1.json

@@ -2,11 +2,11 @@
   "formatVersion": 1,
   "database": {
     "version": 1,
-    "identityHash": "25c3d3b313b6c2aaf6ca0d581f9926e8",
+    "identityHash": "57b1ed91726ddfe1883b04ee15d1bb82",
     "entities": [
       {
         "tableName": "tbl_user",
-        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` INTEGER PRIMARY KEY AUTOINCREMENT, `name` TEXT NOT NULL, `phone` TEXT NOT NULL, `image` TEXT)",
+        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` INTEGER PRIMARY KEY AUTOINCREMENT, `name` TEXT NOT NULL, `phone` TEXT NOT NULL, `image` TEXT, `isFav` INTEGER NOT NULL)",
         "fields": [
           {
             "fieldPath": "id",
@@ -31,6 +31,12 @@
             "columnName": "image",
             "affinity": "TEXT",
             "notNull": false
+          },
+          {
+            "fieldPath": "isFav",
+            "columnName": "isFav",
+            "affinity": "INTEGER",
+            "notNull": true
           }
         ],
         "primaryKey": {
@@ -46,7 +52,7 @@
     "views": [],
     "setupQueries": [
       "CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)",
-      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, '25c3d3b313b6c2aaf6ca0d581f9926e8')"
+      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, '57b1ed91726ddfe1883b04ee15d1bb82')"
     ]
   }
 }

app/src/main/AndroidManifest.xml

@@ -1,7 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?><!-- Bismillahir Rahmanir Rahim -->
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    xmlns:tools="http://schemas.android.com/tools"
-    package="org.imaginativeworld.simplemvvm">
+    xmlns:tools="http://schemas.android.com/tools">
 
     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />