Improve readability

README.md

@@ -14,7 +14,7 @@ build.gradle.kts
 ---
 
 ~~~Kotlin
-import co.raccoons.local.gradle.BuildConfiguration
+import co.raccoons.local.gradle.GradleBuild
 import co.raccoons.local.gradle.checkstyle.CheckstyleConfiguration
 import co.raccoons.local.gradle.checkstyle.CheckstyleReportFormat
 import co.raccoons.local.gradle.jacoco.JacocoConfiguration
@@ -27,42 +27,42 @@ import co.raccoons.local.gradle.javadoc.JavadocTag
 import co.raccoons.local.gradle.repository.Repository
 import co.raccoons.local.gradle.test.TestNG
 
-BuildConfiguration.of(project)
+GradleBuild.of(project)
     .use(Repository.MAVEN_CENTRAL)
     .use(Repository.MAVEN_LOCAL)
-    .use(Configuration.javaLibrary())
+    .use(Configuration.javaLibrary)
     .use(Version.JAVA.of(20))
-    .use(Configuration.testNG())
-    .use(Configuration.jacoco())
-    .use(Configuration.javadoc())
-    .use(Configuration.checkstyle())
+    .use(Configuration.testNG)
+    .use(Configuration.jacoco)
+    .use(Configuration.javadoc)
+    .use(Configuration.checkstyle)
 
-class Configuration {
+internal class Configuration {
     companion object {
 
-        fun javaLibrary() =
+        val javaLibrary =
             JavaLibraryConfiguration.default()
 
-        fun testNG() =
+        val testNG =
             TestNG.Builder()
                 .addDependency(TestImplementation("org.testng", "testng", "7.8.0"))
                 .addDependency(TestImplementation("org.slf4j", "slf4j-simple", "2.0.7"))
                 .build()
 
-        fun jacoco() =
+        val jacoco =
             JacocoConfiguration.Builder()
                 .enable(JacocoReportFormat.HTML)
                 .enable(JacocoReportFormat.XML)
                 .build()
 
-        fun javadoc() =
+        val javadoc =
             JavadocConfiguration.Builder()
                 .addTag(JavadocTag("apiNote", "API Note"))
                 .addTag(JavadocTag("implSpec", "Implementation Specification"))
                 .addTag(JavadocTag("implNote", "Implementation Note"))
                 .build()
 
-        fun checkstyle() =
+        val checkstyle =
             CheckstyleConfiguration.Builder()
                 .setVersion("10.12.2")
                 .enable(CheckstyleReportFormat.HTML)

buildSrc/src/main/kotlin/co/raccoons/local/gradle/GradleBuild.kt

@@ -0,0 +1,34 @@
+package co.raccoons.local.gradle
+
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+
+/**
+ * Gradle build configurator.
+ */
+class GradleBuild private constructor() {
+
+    companion object {
+
+        /**
+         * Returns build configuration handler of this project.
+         */
+        fun of(project: Project): ConfigurationHandler {
+
+            /**
+             * Build configuration handler that applies configuration to project.
+             */
+            class BuildConfigurationHandler(private val project: Project) : ConfigurationHandler {
+                override fun use(plugin: Plugin<Project>): ConfigurationHandler {
+                    plugin.apply(this.project)
+                    return this
+                }
+            }
+            return BuildConfigurationHandler(project)
+        }
+    }
+
+    fun interface ConfigurationHandler {
+        fun use(plugin: Plugin<Project>): ConfigurationHandler
+    }
+}

buildSrc/src/main/kotlin/co/raccoons/local/gradle/Defaults.kt → buildSrc/src/main/kotlin/co/raccoons/local/gradle/Presets.kt

@@ -1,6 +1,9 @@
 package co.raccoons.local.gradle
 
-enum class Defaults(private val version: String) {
+/**
+ * Plugins version
+ */
+enum class Presets(private val version: String) {
     CHECKSTYLE("10.12.2");
 
     fun version() = version

buildSrc/src/main/kotlin/co/raccoons/local/gradle/checkstyle/CheckstyleConfiguration.kt

@@ -1,12 +1,12 @@
 package co.raccoons.local.gradle.checkstyle
 
-import co.raccoons.local.gradle.Defaults
+import co.raccoons.local.gradle.Presets
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.plugins.quality.Checkstyle
 import org.gradle.api.plugins.quality.CheckstyleExtension
 
-private const val CHECKSTYLE = "checkstyle"
+private const val CHECKSTYLE_PLUGIN_ID = "checkstyle"
 
 class CheckstyleConfiguration(
     private val toolVersion: String,
@@ -19,7 +19,7 @@ class CheckstyleConfiguration(
     }
 
     private fun setupPlugin(project: Project) {
-        project.plugins.apply(CHECKSTYLE)
+        project.plugins.apply(CHECKSTYLE_PLUGIN_ID)
         val checkstyleExtension = project.extensions.getByType(CheckstyleExtension::class.java)
         checkstyleExtension.toolVersion = this.toolVersion
     }
@@ -36,7 +36,7 @@ class CheckstyleConfiguration(
 
     class Builder {
 
-        private var toolVersion = Defaults.CHECKSTYLE.version()
+        private var toolVersion = Presets.CHECKSTYLE.version()
         private val enabledFormats = mutableListOf<CheckstyleReportFormat>()
 
         fun setVersion(version: String): Builder {

buildSrc/src/main/kotlin/co/raccoons/local/gradle/jacoco/JacocoConfiguration.kt

@@ -4,7 +4,7 @@ import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.testing.jacoco.tasks.JacocoReport
 
-private const val JACOCO = "jacoco"
+private const val JACOCO_PLUGIN_ID = "jacoco"
 
 class JacocoConfiguration(private val reportFormats: List<JacocoReportFormat>) : Plugin<Project> {
 
@@ -14,7 +14,7 @@ class JacocoConfiguration(private val reportFormats: List<JacocoReportFormat>) :
     }
 
     private fun setupPlugin(project: Project) {
-        project.plugins.apply(JACOCO)
+        project.plugins.apply(JACOCO_PLUGIN_ID)
     }
 
     private fun enableReports(project: Project) {

buildSrc/src/main/kotlin/co/raccoons/local/gradle/repository/Repository.kt

@@ -4,11 +4,13 @@ import org.gradle.api.Plugin
 import org.gradle.api.Project
 
 enum class Repository: Plugin<Project> {
+
     MAVEN_CENTRAL {
         override fun apply(project: Project) {
             project.repositories.mavenCentral()
         }
     },
+
     MAVEN_LOCAL {
         override fun apply(project: Project) {
             project.repositories.mavenLocal()

lib/build.gradle.kts

@@ -4,7 +4,7 @@
  * @license MIT
  */
 
-import co.raccoons.local.gradle.BuildConfiguration
+import co.raccoons.local.gradle.GradleBuild
 import co.raccoons.local.gradle.checkstyle.CheckstyleConfiguration
 import co.raccoons.local.gradle.checkstyle.CheckstyleReportFormat
 import co.raccoons.local.gradle.jacoco.JacocoConfiguration
@@ -17,7 +17,7 @@ import co.raccoons.local.gradle.javadoc.JavadocTag
 import co.raccoons.local.gradle.repository.Repository
 import co.raccoons.local.gradle.test.TestNG
 
-BuildConfiguration.of(project)
+GradleBuild.of(project)
     .use(Repository.MAVEN_CENTRAL)
     .use(Repository.MAVEN_LOCAL)
     .use(Configuration.javaLibrary)