Improve and automate the plugin build (#9)

Fixes #6

This PR brings the following changes:

- Implemented the plugin in Kotlin
- Added unit and functional tests.
- Added ktlint and configured GitHub Actions as CI:
   - checks and tests on every push to any branch
   - publishing the plugin to the Gradle Plugin Portal on every tag creation.
- Cleanup and build script refactoring.

Author: Danil-Didkovskiy

.github/workflows/publish.yml

@@ -0,0 +1,28 @@
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  publish:
+    name: Publish Gradle Plugin
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up JDK
+        uses: actions/setup-java@v2
+        with:
+          java-version: 8
+
+      - name: Run Gradle tasks
+        run: ./gradlew check
+
+      - name: Build and Publish
+        env:
+          GRADLE_PUBLISH_KEY: ${{ secrets.GRADLE_PUBLISH_KEY }}
+          GRADLE_PUBLISH_SECRET: ${{ secrets.GRADLE_PUBLISH_SECRET }}
+        run: |
+          ./gradlew clean build publishPlugins -Pgradle.publish.key=$GRADLE_PUBLISH_KEY -Pgradle.publish.secret=$GRADLE_PUBLISH_SECRET

.github/workflows/validate.yml

@@ -0,0 +1,27 @@
+name: Validate Plugin
+
+on:
+  push:
+
+jobs:
+  ktlint:
+    name: Ktlint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Run ktlint check
+        run: ./gradlew ktlintCheck
+
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Run tests
+        run: ./gradlew test

README.md

@@ -11,41 +11,42 @@ plugins {
 
 jxbrowser {
     // The JxBrowser version. A mandatory field.
-    version = "7.35.2"
+    // Obtain the latest release version number at https://teamdev.com/jxbrowser/.
+    version = "7.36"
 
     // The location of JxBrowser repository to use. It's either North America or Europe.
-    // By default, it's North America.
+    // If not specified, the location is set to North America.
     repository = Repository.NORTH_AMERICA
 
     // Alternatively, it may point to a custom repo via its URL, as follows:
     // repository = "https://my.custom.repository"
 
-    // Adds JxBrowser EAP repository to the project.
+    // Adds a repository with JxBrowser preview builds to the project.
     includePreviewBuilds()
 }
 
 dependencies {
     // Adds a dependency to the core JxBrowser API.
-    implementation(jxbrowser.core())
+    implementation(jxbrowser.core)
 
     // Adds dependencies to the UI toolkit integrations.
-    implementation(jxbrowser.swt())
-    implementation(jxbrowser.swing())
-    implementation(jxbrowser.javafx())
+    implementation(jxbrowser.swt)
+    implementation(jxbrowser.swing)
+    implementation(jxbrowser.javafx)
 
     // Detects the current platform and adds the corresponding Chromium binaries.
-    implementation(jxbrowser.currentPlatform())
-
-    // Adds dependencies with binaries for all supported platforms.
-    implementation(jxbrowser.crossPlatform())
-
-    // Adds a dependency to specific Chromium binaries.
-    implementation(jxbrowser.mac())
-    implementation(jxbrowser.macArm())
-    implementation(jxbrowser.win32())
-    implementation(jxbrowser.win64())
-    implementation(jxbrowser.linux64())
-    implementation(jxbrowser.linuxArm())
+    implementation(jxbrowser.currentPlatform)
+
+    // Adds dependencies to the Chromium binaries for all supported platforms.
+    implementation(jxbrowser.crossPlatform)
+
+    // Adds a dependency to the platform-specific Chromium binaries.
+    implementation(jxbrowser.mac)
+    implementation(jxbrowser.macArm)
+    implementation(jxbrowser.win32)
+    implementation(jxbrowser.win64)
+    implementation(jxbrowser.linux64)
+    implementation(jxbrowser.linuxArm)
 }
 ```
 

build.gradle.kts

@@ -18,38 +18,92 @@
  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+object BuildSettings {
+    const val GROUP = "com.teamdev.jxbrowser"
+    const val VERSION = "1.0.0"
+    const val JXBROWSER_VERSION = "7.36"
+    val javaVersion = JavaVersion.VERSION_1_8
+}
+
+object PluginProperties {
+    const val ID = "com.teamdev.jxbrowser"
+    const val NAME = "jxbrowser-deps"
+    const val DISPLAY_NAME = "Adds JxBrowser repository and dependencies to the project"
+    const val WEBSITE = "https://github.com/TeamDev-IP/JxBrowser-Gradle-Plugin"
+    const val VCS_URL = "https://github.com/TeamDev-IP/JxBrowser-Gradle-Plugin"
+    const val IMPLEMENTATION_CLASS = "com.teamdev.jxbrowser.gradle.JxBrowserPlugin"
+    const val DESCRIPTION =
+        "Adds JxBrowser repository to the project and provides convenience methods for applying JxBrowser dependencies."
+    val TAGS = listOf("jxbrowser")
+}
+
 plugins {
     `java-gradle-plugin`
+    kotlin("jvm") version "1.9.10"
     id("maven-publish")
     id("com.gradle.plugin-publish") version "1.2.1"
+    id("org.jlleitschuh.gradle.ktlint") version "11.6.1"
 }
 
-group = "com.teamdev.jxbrowser"
-version = "0.0.5"
+group = BuildSettings.GROUP
+version = BuildSettings.VERSION
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation(kotlin("stdlib"))
+
+    testImplementation(kotlin("test"))
+    testImplementation(gradleTestKit())
+    testImplementation("io.kotest:kotest-assertions-core:5.7.2")
+}
+
+java {
+    with(BuildSettings) {
+        sourceCompatibility = javaVersion
+        targetCompatibility = javaVersion
+    }
+}
+
+kotlin {
+    explicitApi()
+}
 
 gradlePlugin {
-    plugins {
-        website = "https://github.com/TeamDev-IP/JxBrowser-Gradle-Plugin"
-        vcsUrl = "https://github.com/TeamDev-IP/JxBrowser-Gradle-Plugin"
-        create("jxbrowser-deps") {
-            id = "com.teamdev.jxbrowser"
-            displayName = "Adds JxBrowser repository and dependencies to the project"
-            description = """
-                This plug-in adds JxBrowser repository to the project and provides convenience methods for applying
-                JxBrowser dependencies.
-            """.trimIndent()
-            implementationClass = "com.teamdev.jxbrowser.gradle.DepsPlugin"
-            tags = listOf("jxbrowser")
+    with(PluginProperties) {
+        plugins {
+            create(NAME) {
+                id = ID
+                displayName = DISPLAY_NAME
+                description = DESCRIPTION
+                implementationClass = IMPLEMENTATION_CLASS
+                tags = TAGS
+            }
         }
+        website = WEBSITE
+        vcsUrl = VCS_URL
     }
 }
 
-// Used only for testing.
 publishing {
+    description = "Publishes the plugin to the local repository. Used for testing only."
     repositories {
         maven {
             name = "localPluginRepository"
             url = uri("../local-plugin-repository")
         }
     }
 }
+
+tasks.withType<KotlinCompile> {
+    kotlinOptions.jvmTarget = BuildSettings.javaVersion.toString()
+}
+
+tasks.withType<Test> {
+    useJUnitPlatform()
+    systemProperty("JXBROWSER_VERSION", BuildSettings.JXBROWSER_VERSION)
+}