diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..097f9f9 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,9 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf + diff --git a/.github/workflows/ci_notify.yml b/.github/workflows/ci_notify.yml new file mode 100644 index 0000000..bba77fc --- /dev/null +++ b/.github/workflows/ci_notify.yml @@ -0,0 +1,111 @@ +name: Notify + +on: + push: + branches: ["master"] + tags: + - "v*" + pull_request: + branches: ["master"] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout Repository + uses: actions/checkout@v3 + + notify: + runs-on: ubuntu-latest + needs: build + steps: + - name: Check Secrets + id: check + run: | + if [[ -z "${{ secrets.TELEGRAM_CHAT_ID }}" || -z "${{ secrets.TELEGRAM_BOT_TOKEN }}" ]]; then + echo "::set-output name=skip::true" + else + echo "::set-output name=skip::false" + fi + - name: Send Telegram Notification + if: steps.check.outputs.skip == 'false' + uses: appleboy/telegram-action@master + with: + to: ${{ secrets.TELEGRAM_CHAT_ID }} + token: ${{ secrets.TELEGRAM_BOT_TOKEN }} + format: markdown + message: | + 🚀 CI Commit + 🔯 `${{ github.actor }}` created commit: + - message: `${{ github.event.commits[0].message }}` + - hash: `${{ github.sha }}` + - repository: `${{ github.repository }}` + - head: `${{ github.event.head_commit.message }}` + 🍀 See changes: `https://github.com/${{ github.repository }}/commit/${{github.sha}}` + + deploy: + runs-on: ubuntu-latest + if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/') + needs: build + steps: + - name: Checkout repository + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Check if tag exists + id: check_tag + run: | + if [ -n "$GITHUB_REF" ]; then + TAG=${GITHUB_REF#refs/tags/} + # echo "::set-output name=tag::$TAG" + echo "TAG=${TAG}" >> $GITHUB_ENV + else + # echo "::set-output name=tag::" + echo "TAG=" >> $GITHUB_ENV + fi + shell: bash + + - name: Check Secrets + id: check + run: | + if [[ -z "${{ secrets.TELEGRAM_CHAT_ID }}" || -z "${{ secrets.TELEGRAM_BOT_TOKEN }}" ]]; then + echo "::set-output name=skip::true" + else + echo "::set-output name=skip::false" + fi + + - name: Generate Changelog + id: changelog + run: | + # Generate your changelog here and set it as an output variable + CHANGELOG=$(git log --pretty=format:"%h - %s" -n 10) + echo "::set-output name=changelog::$CHANGELOG" + + - name: Create GitHub Release + id: create_release + uses: softprops/action-gh-release@v1 + with: + tag_name: ${{ env.TAG }} + body: | + :gem: released new version ${{ env.TAG }} + draft: false + prerelease: false + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Send Telegram Notification + if: steps.check.outputs.skip == 'false' + uses: appleboy/telegram-action@master + with: + to: ${{ secrets.TELEGRAM_CHAT_ID }} + token: ${{ secrets.TELEGRAM_BOT_TOKEN }} + format: markdown + message: | + 🚀 New tag created: **${{ env.TAG }}** + 🔯 `${{ github.actor }}` created tag: + - repository: `${{ github.repository }}` + - head: `${{ github.event.head_commit.message }}` + 🍀 See changes: `https://github.com/${{ github.repository }}/releases/tag/${{ env.TAG }}` + 📜 Changelog: + `${{ steps.changelog.outputs.changelog }}` diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1114463 --- /dev/null +++ b/.gitignore @@ -0,0 +1,37 @@ +HELP.md +.gradle +build/ +logs/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/** +!**/src/test/** +plugin/build/ +plugin/bin/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ +src/main/java/META-INF/ +*.gz diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..7f0672f --- /dev/null +++ b/Makefile @@ -0,0 +1,18 @@ +.PHONY: build test jar clean + +build: + ./gradlew jar + +clean: + ./gradlew clean + +jar: build + +list-task: + ./gradlew tasks + +test: + ./gradlew test + +groovy: + ./gradlew build diff --git a/README.md b/README.md new file mode 100644 index 0000000..66eb5a2 --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +# wizard4j + +## Introduction + +wizard4j: A Java 1.8 library offering a robust collection of utility functions for streamlined development. + +## Features + +- Comprehensive set of utility functions. +- Written in Java 1.8. +- Well-documented code for easy understanding. +- Regular updates and maintenance. + +## Installation + +```bash +git clone --depth 1 https://github.com/sivaosorg/wizard4j.git +``` + +## Generation Plugin Java + +```bash +curl https://gradle-initializr.cleverapps.io/starter.zip -d type=groovy-gradle-plugin -d testFramework=testng -d projectName=wizard4j -o wizard4j.zip +``` + +## Modules + +Explain how users can interact with the various modules. + +### Tidying up + +To tidy up the project's Java modules, use the following command: + +```bash +./gradlew clean +``` + +or + +```bash +make clean +``` + +### Building SDK + +```bash +./gradlew jar +``` + +or + +```bash +make jar +``` + +### Upgrading version + +- file `gradle.properties` + +```sh +ng.name=wizard4j +ng.version=v1.0.0 +``` + +## Integration + +1. Add dependency into file `build.gradle` + +```gradle +implementation files('libs/wizard4j-v1.0.0.jar') // filename based on ng.name and ng.version +``` + +2. Edit file `main Spring Boot application` (optional) + +```java + +@SpringBootApplication +@ComponentScan(basePackages = {"org.wizard4j"}) // root name of package wizard4j +public class ApiApplication { + public static void main(String[] args) { + SpringApplication.run(ApiApplication.class, args); + } +} +``` diff --git a/VERSION_RELEASES.md b/VERSION_RELEASES.md new file mode 100644 index 0000000..cc8a6b9 --- /dev/null +++ b/VERSION_RELEASES.md @@ -0,0 +1,53 @@ +# Version Releases + +## Semantic Versioning (SemVer): `vMAJOR.MINOR.PATCH` + +Example: + +- v1.0.0 +- v1.0.1 +- v1.1.1 + +## Pre-release versions: `vMAJOR.MINOR.PATCH-.` + +Example: + +- v1.0.0-beta.1 +- v1.0.0-beta.2 +- v1.2.3-rc1 +- v1.2.3-SNAPSHOT + +## Post-release versions: `vMAJOR.MINOR.PATCH-POST.` + +Example: + +- v1.2.3-post.1 +- v1.2.3-post.2 + +## Local versions: `vMAJOR.MINOR.PATCH+LOCAL` + +Example: + +- v1.0.0+local +- v1.1.0+local + +## Caret range versions: `^MAJOR.MINOR.PATCH` + +Example: + +- ^1.2.3 (similar `>=1.2.3 < 2.0.0`) + +## Tilde range versions: `~MAJOR.MINOR.PATCH` + +Example: + +- ~1.2.3 (similar `>=1.2.3 <1.3.0`) + +--- + +Notes: + +- `MAJOR`: major version. +- `MINOR`: Minor version, often adding new features. +- `PATCH`: Patch version, typically fixing bugs. +- `SNAPSHOT`: Indicates a version under development or in progress. It is often used to represent the latest state of the codebase and may include ongoing changes and features that are not yet finalized. This allows developers to work with the most recent developments in a project. diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..3f32b8f --- /dev/null +++ b/gradle.properties @@ -0,0 +1,2 @@ +ng.name=wizard4j +ng.version=v1.0.0 diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..46b343f --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,8 @@ +# This file was generated by the Gradle 'init' task. +# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format + +[versions] +spock-core = "2.2-groovy-3.0" + +[libraries] +spock-core = { module = "org.spockframework:spock-core", version.ref = "spock-core" } diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..d64cd49 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..a80b22c --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..1aa94a4 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100755 index 0000000..25da30d --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/plugin/build.gradle b/plugin/build.gradle new file mode 100644 index 0000000..b154f9d --- /dev/null +++ b/plugin/build.gradle @@ -0,0 +1,77 @@ +/* + * This generated file contains a sample Gradle plugin project to get you started. + * For more details on writing Custom Plugins, please refer to https://docs.gradle.org/8.6/userguide/custom_plugins.html in the Gradle documentation. + */ +//file:noinspection VulnerableLibrariesLocal +//file:noinspection SpellCheckingInspection + +plugins { + // Apply the Java Gradle plugin development plugin to add support for developing Gradle plugins + id 'java-gradle-plugin' + + // Apply the Groovy plugin to add support for Groovy + id 'groovy' +} + +apply plugin: 'java' +apply plugin: 'eclipse' + +// Set the Java version compatibility for the project +// sourceCompatibility = '1.8' + +repositories { + // Use Maven Central for resolving dependencies. + mavenCentral() +} + +def props = new Properties() +props.load(new FileInputStream(rootProject.file("gradle.properties"))) +def _name = props.getProperty("ng.name") +def _version = props.getProperty("ng.version") + +// Define a task to build the Groovy library into a JAR +tasks.register('buildGroovyJar', Jar) { + // Set the base directory for the source files + from 'src/main/groovy' + // Set the destination directory for the compiled classes + into('') + archiveFileName = "${_name}" + ".jar" + version("${_version}") + include '**/*.groovy' +} + +// Configure the build task to depend on the buildGroovyJar task +tasks.named('build') { + dependsOn(buildGroovyJar) +} + +tasks.jar { + archivesBaseName = "${_name}" + version = "${_version}" +} + +// Add dependencies +dependencies { + // Use the awesome Spock testing and specification framework + testImplementation libs.spock.core + // Use JUnit Platform launcher for test runtime + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' + // The "logback-classic" library, version 1.4.12, is a robust logging framework for Java applications, + // offering flexible and customizable logging functionalities to efficiently manage and analyze application logs. + implementation 'ch.qos.logback:logback-classic:1.4.12' + // Add dependencies for JAXB, activation, and Jackson libraries + // JAXB is commonly used for marshalling and unmarshalling XML data in Java applications. + // If your project deals with XML data and you need to convert Java objects to XML (marshalling) or vice versa (unmarshalling), then JAXB may be necessary. + implementation('javax.xml.bind:jaxb-api:2.3.0') + implementation group: 'com.fasterxml.jackson.core', name: 'jackson-core', version: '2.17.0' + implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.17.0' + // The activation library provides support for the JavaBeans Activation Framework, which is used to determine the type of an arbitrary piece of data, + // encapsulate access to it, discover the operations available on it, and to instantiate the appropriate bean to perform those operations. + // It's typically used in JavaMail API and other contexts where dynamic loading of data types is required. + implementation('javax.activation:activation:1.1') + // Jackson is a popular JSON library for Java, used for parsing JSON data into Java objects and vice versa. + // If your project deals with JSON data, then Jackson can be very useful for serialization and deserialization. + implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-joda', version: '2.17.0' + // The "unirest-java" library, version 3.13.10, provides streamlined HTTP communication capabilities for Java applications, simplifying API interactions and network requests. + implementation group: 'com.konghq', name: 'unirest-java', version: '3.13.10' +} diff --git a/plugin/src/functionalTest/groovy/org/wizard4j/Wizard4jPluginFunctionalTest.groovy b/plugin/src/functionalTest/groovy/org/wizard4j/Wizard4jPluginFunctionalTest.groovy new file mode 100644 index 0000000..da6bca3 --- /dev/null +++ b/plugin/src/functionalTest/groovy/org/wizard4j/Wizard4jPluginFunctionalTest.groovy @@ -0,0 +1,45 @@ +/* + * This Groovy source file was generated by the Gradle 'init' task. + */ +package org.wizard4j + +import spock.lang.Specification +import spock.lang.TempDir +import org.gradle.testkit.runner.GradleRunner + +/** + * A simple functional test for the 'org.example.greeting' plugin. + */ +class Wizard4jPluginFunctionalTest extends Specification { + @TempDir + private File projectDir + + private getBuildFile() { + new File(projectDir, "build.gradle") + } + + private getSettingsFile() { + new File(projectDir, "settings.gradle") + } + + def "can run task"() { + given: + settingsFile << "" + buildFile << """ +plugins { + id('org.example.greeting') +} +""" + + when: + def runner = GradleRunner.create() + runner.forwardOutput() + runner.withPluginClasspath() + runner.withArguments("greeting") + runner.withProjectDir(projectDir) + def result = runner.build() + + then: + result.output.contains("Hello from plugin 'org.example.greeting'") + } +} diff --git a/plugin/src/main/groovy/org/wizard4j/Wizard4jPlugin.groovy b/plugin/src/main/groovy/org/wizard4j/Wizard4jPlugin.groovy new file mode 100644 index 0000000..eead272 --- /dev/null +++ b/plugin/src/main/groovy/org/wizard4j/Wizard4jPlugin.groovy @@ -0,0 +1,21 @@ +/* + * This Groovy source file was generated by the Gradle 'init' task. + */ +package org.wizard4j + +import org.gradle.api.Project +import org.gradle.api.Plugin + +/** + * A simple 'hello world' plugin. + */ +class Wizard4jPlugin implements Plugin { + void apply(Project project) { + // Register a task + project.tasks.register("greeting") { + doLast { + println("Hello from plugin 'org.example.greeting'") + } + } + } +} diff --git a/plugin/src/test/groovy/org/wizard4j/Wizard4jPluginTest.groovy b/plugin/src/test/groovy/org/wizard4j/Wizard4jPluginTest.groovy new file mode 100644 index 0000000..4e54179 --- /dev/null +++ b/plugin/src/test/groovy/org/wizard4j/Wizard4jPluginTest.groovy @@ -0,0 +1,23 @@ +/* + * This Groovy source file was generated by the Gradle 'init' task. + */ +package org.wizard4j + +import org.gradle.testfixtures.ProjectBuilder +import spock.lang.Specification + +/** + * A simple unit test for the 'org.example.greeting' plugin. + */ +class Wizard4jPluginTest extends Specification { + def "plugin registers task"() { + given: + def project = ProjectBuilder.builder().build() + + when: + project.plugins.apply("org.example.greeting") + + then: + project.tasks.findByName("greeting") != null + } +} diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..e2cff9b --- /dev/null +++ b/settings.gradle @@ -0,0 +1,9 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * The settings file is used to specify which projects to include in your build. + * For more detailed information on multi-project builds, please refer to https://docs.gradle.org/8.6/userguide/multi_project_builds.html in the Gradle documentation. + */ + +rootProject.name = 'wizard4j' +include('plugin')