Use Kotlin DSL

Author: maxkeppeler

build.gradle

@@ -0,0 +1,125 @@
+/*
+ *  Copyright (C) 2020. Maximilian Keppeler (https://www.maxkeppeler.com)
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+import com.android.build.gradle.LibraryExtension
+
+plugins {
+    id(Plugins.APPLICATION.id) version (Plugins.APPLICATION.version) apply false
+    id(Plugins.LIBRARY.id) version (Plugins.APPLICATION.version) apply false
+    id(Plugins.KOTLIN.id) version (Plugins.KOTLIN.version) apply false
+    id(Plugins.SPOTLESS.id) version (Plugins.SPOTLESS.version)
+    id(Plugins.DOKKA.id) version (Plugins.DOKKA.version)
+}
+
+buildscript {
+
+    repositories {
+        google()
+        mavenCentral()
+        maven("https://plugins.gradle.org/m2/")
+    }
+
+    dependencies {
+        classpath(Dependencies.Kotlin.GRADLE_PLUGIN)
+        classpath(Dependencies.Gradle.BUILD)
+        classpath(Dependencies.MAVEN_PUBLISH)
+        classpath(Dependencies.DOKKA)
+    }
+}
+
+allprojects {
+    repositories {
+        google()
+        mavenCentral()
+        maven("https://jitpack.io")
+    }
+}
+
+tasks.dokkaHtmlMultiModule.configure {
+    outputDirectory.set(projectDir.resolve("docs/api"))
+}
+
+subprojects {
+    plugins.apply(Plugins.SPOTLESS.id)
+    project.plugins.applyBaseConfig(project)
+    spotless {
+        kotlin {
+            target("**/*.kt")
+            licenseHeaderFile(rootProject.file("copyright.kt"))
+        }
+        kotlinGradle {
+            target("*.gradle.kts", "gradle/*.gradle.kts", "buildSrc/*.gradle.kts")
+            licenseHeaderFile(
+                rootProject.file("copyright.kt"),
+                "import|tasks|apply|plugins|rootProject"
+            )
+        }
+    }
+}
+
+
+/**
+ * Apply base configurations to the subjects that include specific custom plugins.
+ */
+fun PluginContainer.applyBaseConfig(project: Project) {
+    whenPluginAdded {
+        when (this) {
+            is LibraryModulePlugin -> {
+                project.extensions
+                    .getByType<LibraryExtension>()
+                    .apply {
+                        baseLibraryConfig()
+                    }
+            }
+        }
+    }
+}
+
+/**
+ * Apply base library configurations to the subprojects that include the plugin [LibraryModulePlugin].
+ */
+fun com.android.build.gradle.BaseExtension.baseLibraryConfig() {
+
+    compileSdkVersion(App.COMPILE_SDK)
+
+    defaultConfig {
+        minSdk = App.MIN_SDK
+        targetSdk = App.TARGET_SDK
+        testInstrumentationRunner = App.TEST_INSTRUMENTATION_RUNNER
+    }
+
+    compileOptions.apply {
+        sourceCompatibility(JavaVersion.VERSION_1_8)
+        targetCompatibility(JavaVersion.VERSION_1_8)
+    }
+
+    buildFeatures.viewBinding = true
+
+    packagingOptions.resources.excludes += listOf(
+        "META-INF/DEPENDENCIES.txt",
+        "META-INF/LICENSE",
+        "META-INF/LICENSE.txt",
+        "META-INF/NOTICE",
+        "META-INF/NOTICE.txt",
+        "META-INF/AL2.0",
+        "META-INF/LGPL2.1"
+    )
+
+    tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
+        kotlinOptions {
+            jvmTarget = "1.8"
+        }
+    }
+}

build.gradle.kts

@@ -0,0 +1,20 @@
+import org.gradle.kotlin.dsl.`kotlin-dsl`
+
+plugins {
+    `kotlin-dsl`
+}
+
+repositories {
+    google()
+    mavenCentral()
+    gradlePluginPortal()
+}
+
+gradlePlugin {
+    plugins {
+        register("library-module") {
+            id = "library-module"
+            implementationClass = "LibraryModulePlugin"
+        }
+    }
+}

buildSrc/build.gradle.kts

@@ -0,0 +1,13 @@
+object App {
+
+    const val ID = "com.maxkeppeler.sample"
+
+    const val COMPILE_SDK = 33
+    const val MIN_SDK = 21
+    const val TARGET_SDK = 33
+
+    const val VERSION_CODE = 27
+    const val VERSION_NAME = "2.3.0"
+
+    const val TEST_INSTRUMENTATION_RUNNER = "androidx.test.runner.AndroidJUnitRunner"
+}

buildSrc/src/main/java/App.kt

@@ -0,0 +1,41 @@
+object Dependencies {
+
+    object Google {
+        const val MATERIAL= "com.google.android.material:material:1.5.0"
+    }
+
+    object AndroidX {
+
+        const val CORE_KTX = "androidx.core:core-ktx:1.8.0"
+        const val LIFECYCLE_KTX = "androidx.lifecycle:lifecycle-runtime-ktx:2.5.1"
+        const val CONSTRAINT_LAYOUT = "androidx.constraintlayout:constraintlayout:2.1.3"
+        const val ANNOTATIONS = "androidx.annotation:annotation:1.3.0"
+        const val APP_COMPAT = "androidx.appcompat:appcompat:1.4.1"
+        const val PREFERENCE = "androidx.preference:preference-ktx:1.2.0"
+        const val RECYCLER_VIEW = "androidx.recyclerview:recyclerview:1.2.1"
+    }
+
+    object Coil {
+        const val COIL_BASE = "io.coil-kt:coil:1.4.0"
+        const val COIL_VIDEO = "io.coil-kt:coil-video:1.4.0"
+    }
+
+    object AirBnb {
+        const val LOTTIE = "com.airbnb.android:lottie:4.2.1"
+    }
+
+    object Kotlin {
+        const val GRADLE_PLUGIN = "org.jetbrains.kotlin:kotlin-gradle-plugin:1.5.30"
+        const val KOTLIN_STD = "org.jetbrains.kotlin:kotlin-stdlib-jdk7:${Versions.KOTLIN}"
+    }
+
+    object Gradle {
+        const val BUILD = "com.android.tools.build:gradle:7.3.0"
+    }
+
+    const val CALENDAR_VIEW = "com.github.kizitonwose:CalendarView:1.1.0"
+    const val DOKKA = "org.jetbrains.dokka:dokka-gradle-plugin:1.6.0"
+    const val DESUGAR = "com.android.tools:desugar_jdk_libs:1.1.5"
+
+    const val MAVEN_PUBLISH = "com.vanniktech:gradle-maven-publish-plugin:0.21.0"
+}

buildSrc/src/main/java/Dependencies.kt

@@ -0,0 +1,51 @@
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.project
+
+class LibraryModulePlugin : Plugin<Project> {
+
+    override fun apply(project: Project) {
+        with(project) {
+            applyPlugins()
+            applyDependencies()
+        }
+    }
+
+    private fun Project.applyPlugins() {
+        plugins.run {
+            apply(Plugins.LIBRARY.id)
+            apply(Plugins.KOTLIN.id)
+            apply(Plugins.DOKKA.id)
+            apply(Plugins.MAVEN_PUBLISH.id)
+        }
+    }
+
+    private fun Project.applyDependencies() {
+
+        dependencies.apply {
+
+            // All modules require the core module
+
+            if (name != Modules.CORE.moduleName) {
+                apis(project(Modules.CORE.path))
+            }
+
+            // Google libs
+
+            implementations(Dependencies.Google.MATERIAL)
+
+            // Kotlin libs
+
+            implementations(Dependencies.Kotlin.KOTLIN_STD)
+
+            // AndroidX libs
+
+            implementations(
+                Dependencies.AndroidX.ANNOTATIONS,
+                Dependencies.AndroidX.CORE_KTX,
+                Dependencies.AndroidX.CONSTRAINT_LAYOUT,
+                Dependencies.AndroidX.RECYCLER_VIEW,
+            )
+        }
+    }
+}

buildSrc/src/main/java/LibraryModulePlugin.kt

@@ -0,0 +1,21 @@
+@file:Suppress("PropertyName")
+
+enum class Modules(val moduleName: String) {
+
+    CORE("core"),
+    INFO("info"),
+    COLOR("color"),
+    CALENDAR("calendar"),
+    CLOCK("clock"),
+    DURATION("duration"),
+    OPTION("option"),
+    INPUT("input"),
+    LOTTIE("lottie"),
+    STORAGE("storage");
+
+    val path: String
+        get() = ":$moduleName"
+
+    val namespace: String
+        get() = "com.maxkeppeler.sheets.$moduleName"
+}

buildSrc/src/main/java/Modules.kt

@@ -0,0 +1,13 @@
+import models.Plugin
+
+object Plugins {
+
+    val APPLICATION = Plugin("com.android.application", "7.2.2")
+    val LIBRARY = Plugin("com.android.library", "7.2.2")
+    val KOTLIN = Plugin("org.jetbrains.kotlin.android", "1.7.0")
+    val SPOTLESS = Plugin("com.diffplug.spotless", "6.10.0")
+    val MAVEN_PUBLISH = Plugin("com.vanniktech.maven.publish")
+    val DOKKA = Plugin("org.jetbrains.dokka", "1.7.10")
+
+    val CUSTOM_LIBRARY_MODULE = Plugin("library-module")
+}

buildSrc/src/main/java/Plugins.kt

@@ -0,0 +1,12 @@
+object Versions {
+
+    const val KOTLIN = "1.7.0"
+    const val COMPOSE = "1.2.0"
+
+    const val KT_LINT = "0.47.1"
+
+    // Test
+
+    const val JUNIT = "4.13.2"
+    const val ESPRESSO_CORE = "3.4.0"
+}

buildSrc/src/main/java/Versions.kt

@@ -0,0 +1,6 @@
+package models
+
+data class Plugin(
+    val id: String,
+    val version: String? = ""
+)