Merge pull request #694 from splendo/develop

Release 1.2

.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*.{kt,kts}]
+max_line_length = 180
+ktlint_code_style = ktlint_official
+ktlint_ignore_back_ticked_identifier = true
+
+ktlint_standard = enabled
+ktlint_standard_no-wildcard-imports = disabled
+ktlint_standard_filename = disabled
+ktlint_standard_import-ordering = disabled
+
+ktlint_experimental = disabled
+

.github/workflows/emulator.yaml

@@ -16,11 +16,11 @@ jobs:
       # remove VM settings as defined for using the IDE
       - run: sed -i '' -e '/org.gradle.jvmargs/d' gradle.properties; cat gradle.properties
 
-      - name : set up JDK 11
+      - name : set up JDK 17
         uses : actions/setup-java@v3
         with :
           distribution : 'temurin'
-          java-version : 11
+          java-version : 17
 
       - name: Gradle cache
         uses: gradle/gradle-build-action@v2
@@ -69,10 +69,12 @@ jobs:
           "permissions",
           "location",
           "keyboard",
+          "media",
           "links",
           "resources",
           "review",
           "scientific",
+          "service",
           "system",
           "test-utils"
         ]
@@ -94,11 +96,11 @@ jobs:
             !/.gradle
           key: build-${{ github.sha }}
 
-      - name: set up JDK 11
+      - name: set up JDK 17
         uses: actions/setup-java@v3
         with:
           distribution: 'temurin'
-          java-version: 11
+          java-version: 17
 
       - name: AVD cache
         uses: actions/cache@v3

.github/workflows/publish.yaml

@@ -23,11 +23,11 @@ jobs:
       # remove VM settings as defined for using the IDE
       - run: sed -i '' -e '/org.gradle.jvmargs/d' gradle.properties; cat gradle.properties
 
-      - name : set up JDK 11
+      - name : set up JDK 17
         uses : actions/setup-java@v3
         with :
           distribution : 'temurin'
-          java-version : 11
+          java-version : 17
 
       - name: Konan cache
         uses: actions/cache@v3

DEVELOP.md

@@ -150,21 +150,21 @@ The project uses regular Kotlin code conventions. This includes not creating `co
 ### Code style verification
 
 This project uses [ktlint](https://github.com/pinterest/ktlint) Kotlin linter with standard rules.
-Each component should setup ktlint gradle [plugin](https://github.com/jlleitschuh/ktlint-gradle) in `build.gradle.kts` file:
+Each component should setup kotlinter gradle [plugin](https://github.com/jeremymailen/kotlinter-gradle) in `build.gradle.kts` file:
 
 ```kotlin
 plugins {
-    id("org.jlleitschuh.gradle.ktlint")
+    id("org.jmailen.kotlinter")
 }
 ```
 
-You can run `Ktlint Check` configuration from IDE before commit changes to git.
+You can run `Lint Kotlin` configuration from IDE before commit changes to git.
 
 #### Formatting
 
-You can run `Ktlint Format` configuration to reformat source code if needed.
+You can run `Format Kotlin` configuration to reformat source code if needed.
 
-See ktlint and gradle plugin documentation for more details.
+See kotlinter and gradle plugin documentation for more details.
 
 ## Frequent issues
 

README.md

@@ -76,7 +76,7 @@ repositories {
     mavenCentral()
 }
 dependencies {
-    implementation("com.splendo.kaluga:alerts:1.0.0")
+    implementation("com.splendo.kaluga:alerts:$kalugaVersion")
 }
 ```
 
@@ -87,7 +87,7 @@ repositories {
     maven("https://oss.sonatype.org/content/repositories/snapshots/")
 }
 dependencies {
-    implementation("com.splendo.kaluga:alerts:1.0.0-SNAPSHOT")
+    implementation("com.splendo.kaluga:alerts:$kalugaDevelopVersion-SNAPSHOT")
 }
 ```
 
@@ -111,6 +111,7 @@ To use kaluga with SwiftUI and/or Combine we have a [repo with Sourcery template
 | [links](links/)                                             | Used for decoding url into an object                                               | com.splendo.kaluga:links                       |
 | [location](location/)                                       | Provides the User' geolocation                                                     | com.splendo.kaluga:location                    |
 | [logging](logging/)                                         | Shared console logging                                                             | com.splendo.kaluga:logging                     |
+| [media](media/)                                             | Playing audio/video                                                                | com.splendo.kaluga:media                       |
 | [base-permissions](base-permissions/)                       | Managing permissions, used in conjunction with modules below                       | com.splendo.kaluga:base-permissions            |
 | [bluetooth-permissions](bluetooth-permissions/)             | Managing bluetooth permissions                                                     | com.splendo.kaluga:bluetooth-permissions       |
 | [calendar-permissions](calendar-permissions/)               | Managing calendar permissions                                                      | com.splendo.kaluga:calendar-permissions        |

adding-a-new-module/README.md

@@ -2,8 +2,14 @@
 This **project** includes all common dependencies and settings for kaluga module.
 
 # Steps for adding a new module
-1. Run gradle task: `./gradlew createNewModule -P module_name=<your-module> -P package_name=<your-package>` from the root directory.
-   * `package_name` can be omitted if the module and package names are the same.
+1. Run gradle task: `./gradlew createNewModule -P module_name=<your-module> -P package_name=<your-package> -P create-test-utils -P create-compose -P create-databinding` from the root directory.
+   * `package_name` can be omitted if the module and package names are the same. Package name will be prefixed with `com.splendo.kaluga`.
+   * Only pass `create-test-utils` if you want to also create a `test-utils-<your-module>` with package `com.splendo.kaluga.test.<your-package>`.
+      * Use `./gradlew createNewTestModule -P module_name=<your-module> -P package_name=<your-package>` to create a `test-utils-<your-module>` for an existing module.
+   * Only pass `create-compose` if you want to also create a `<your-module>-compose` with package `com.splendo.kaluga.<your-package>.compose`.
+      * Use `./gradlew createNewComposeModule -P module_name=<your-module> -P package_name=<your-package>` to create a `<your-module>-compose` for an existing module.
+   * Only pass `create-databinding` if you want to also create a `<your-module>-databinding` with package `com.splendo.kaluga.<your-package>.databinding`.
+      * Use `./gradlew createNewDataBindingModule -P module_name=<your-module> -P package_name=<your-package>` to create a `<your-module>-databinding` for an existing module.
 1. Include your module to kaluga project edit `kaluga/settings.gradle.kts` by adding: `include(":<your-module>")`.
 1. Add Unit tests
     * [Common Unit Tests](#commonTests)

adding-a-new-module/template/build.gradle.kts → adding-a-new-module/template/common/build.gradle.kts

@@ -4,13 +4,10 @@ plugins {
     id("convention.publication")
     id("com.android.library")
     id("org.jetbrains.dokka")
-    id("org.jlleitschuh.gradle.ktlint")
+    id("org.jmailen.kotlinter")
 }
 
-/* Multiplatform component */
-publishableComponent()
-/* Compose component */
-composeAndroidComponent()
+publishableComponent("%PACKAGE%")
 
 dependencies { }
 

adding-a-new-module/template/common/src/androidLibInstrumentedTest/AndroidManifest.xml

@@ -0,0 +1,5 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <application android:theme="@style/Theme.AppCompat">
+        <activity android:name="com.splendo.kaluga.%PACKAGE%.TestActivity"/>
+    </application>
+</manifest>

adding-a-new-module/template/common/src/androidLibInstrumentedTest/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#instrumentedUnitTests)

adding-a-new-module/template/common/src/androidLibMain/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#androidLibMain-sources)

adding-a-new-module/template/common/src/androidLibUnitTest/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#androidLibTests)

adding-a-new-module/template/common/src/commonMain/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#commonMain-sources)

adding-a-new-module/template/common/src/commonTest/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#commonTests)

adding-a-new-module/template/common/src/iosMain/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#iosMain-sources)

adding-a-new-module/template/common/src/iosTest/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#iosTests)

adding-a-new-module/template/common/src/jsMain/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#iosMain-sources)

adding-a-new-module/template/common/src/jvmMain/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#iosMain-sources)

adding-a-new-module/template/compose/build.gradle.kts

@@ -0,0 +1,15 @@
+plugins {
+    id("com.android.library")
+    kotlin("android")
+    id("jacoco")
+    id("convention.publication")
+    id("org.jetbrains.dokka")
+    id("org.jmailen.kotlinter")
+}
+
+composeAndroidComponent("%PACKAGE%")
+
+dependencies {
+    implementation(project(":base"))
+    implementation(project("%BASEMODULE%"))
+}

adding-a-new-module/template/compose/src/androidTest/AndroidManifest.xml

@@ -0,0 +1,5 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <application android:theme="@style/Theme.AppCompat">
+        <activity android:name="com.splendo.kaluga.%PACKAGE%.compose.TestActivity"/>
+    </application>
+</manifest>

adding-a-new-module/template/compose/src/androidTest/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#instrumentedUnitTests)

test-utils-hud/src/androidLibInstrumentedTest/kotlin/TestActivity.kt → adding-a-new-module/template/compose/src/androidTest/kotlin/TestActivity.kt

@@ -1,5 +1,5 @@
 /*
- Copyright 2022 Splendo Consulting B.V. The Netherlands
+ Copyright %YEAR% Splendo Consulting B.V. The Netherlands
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
 
 */
 
-package com.splendo.kaluga.test.hud
+package com.splendo.kaluga.%PACKAGE%
 
 import androidx.appcompat.app.AppCompatActivity
 

adding-a-new-module/template/compose/src/main/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#androidLibMain-sources)

adding-a-new-module/template/compose/src/test/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#androidLibTests)

adding-a-new-module/template/databinding/build.gradle.kts

@@ -0,0 +1,16 @@
+plugins {
+    id("com.android.library")
+    kotlin("android")
+    kotlin("kapt")
+    id("jacoco")
+    id("convention.publication")
+    id("org.jetbrains.dokka")
+    id("org.jmailen.kotlinter")
+}
+
+databindingAndroidComponent("%PACKAGE%")
+
+dependencies {
+    implementation(project(":base"))
+    implementation(project("%BASEMODULE%"))
+}

adding-a-new-module/template/databinding/src/androidTest/AndroidManifest.xml

@@ -0,0 +1,5 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <application android:theme="@style/Theme.AppCompat">
+        <activity android:name="com.splendo.kaluga.%PACKAGE%.databinding.TestActivity"/>
+    </application>
+</manifest>

adding-a-new-module/template/databinding/src/androidTest/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#instrumentedUnitTests)

test-utils-alerts/src/androidLibInstrumentedTest/kotlin/TestActivity.kt → adding-a-new-module/template/databinding/src/androidTest/kotlin/TestActivity.kt

@@ -1,5 +1,5 @@
 /*
- Copyright 2022 Splendo Consulting B.V. The Netherlands
+ Copyright %YEAR% Splendo Consulting B.V. The Netherlands
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
 
 */
 
-package com.splendo.kaluga.test.alerts
+package com.splendo.kaluga.%PACKAGE%
 
 import androidx.appcompat.app.AppCompatActivity
 

adding-a-new-module/template/databinding/src/main/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#androidLibMain-sources)

adding-a-new-module/template/databinding/src/test/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#androidLibTests)

adding-a-new-module/template/test/build.gradle.kts

@@ -0,0 +1,26 @@
+plugins {
+    kotlin("multiplatform")
+    id("jacoco")
+    id("convention.publication")
+    id("com.android.library")
+    id("org.jetbrains.dokka")
+    id("org.jmailen.kotlinter")
+}
+
+publishableComponent("%PACKAGE%")
+
+dependencies { }
+
+kotlin {
+    sourceSets {
+        commonMain {
+            dependencies {
+                implementation(project(":test-utils-base"))
+                implementation(project("%BASEMODULE%"))
+            }
+        }
+        commonTest {
+            dependencies {}
+        }
+    }
+}

adding-a-new-module/template/test/src/androidLibMain/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#androidLibMain-sources)

adding-a-new-module/template/test/src/commonMain/kotlin/README.md

@@ -0,0 +1 @@
+## Please check [Documentation](../../../../../README.md#commonMain-sources)