commit 04e679a46174eea2edbf00cbfebb5e33eab45027 Author: Minecrell Date: Wed Sep 27 20:19:16 2017 +0200 Initial Commit diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..a937871 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,10 @@ +* text=auto +*.bat text eol=crlf +gradlew text eol=lf +*.sh text eol=lf + +################# +## Java +################# +*.java text +*.java diff=java diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1ce8b44 --- /dev/null +++ b/.gitignore @@ -0,0 +1,324 @@ +########################## +#### General +########################## +# https://gist.github.com/octocat/9257657 + +*.log +*.bak + +################# +## Compiled source +################# +*.com +*.class +*.dll +*.exe +*.o +*.so + +################# +## Archives +################# +# https://github.com/github/gitignore/blob/master/Global/Archives.gitignore + +# It's better to unpack these files and commit the raw source because +# git has its own built in compression methods. +*.7z +*.jar +*.rar +*.zip +*.gz +*.tgz +*.bzip +*.bz2 +*.xz +*.lzma +*.cab + +# Packing-only formats +*.iso +*.tar + +# Package management formats +*.dmg +*.xpi +*.gem +*.egg +*.deb +*.rpm +*.msi +*.msm +*.msp + +########################## +#### Operating Systems +########################## + +################# +## Windows +################# +# https://github.com/github/gitignore/blob/master/Global/Windows.gitignore + +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +Desktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msm +*.msp + +# Windows shortcuts +*.lnk + +################# +## macOS +################# +# https://raw.githubusercontent.com/github/gitignore/master/Global/macOS.gitignore + +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +################# +## Linux +################# +# https://github.com/github/gitignore/blob/master/Global/Linux.gitignore + +*~ + +# temporary files which can be created if a process still has a handle open of a deleted file +.fuse_hidden* + +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + +# .nfs files are created when an open file is removed but is still being accessed +.nfs* + +########################## +#### IDE +########################## + +################# +## Eclipse +################# +# https://github.com/github/gitignore/blob/master/Global/Eclipse.gitignore + +.metadata +bin/ +tmp/ +*.tmp +*.bak +*.swp +*~.nib +local.properties +.settings/ +.loadpath +.recommenders + +# Eclipse Core +.project + +# External tool builders +.externalToolBuilders/ + +# Locally stored "Eclipse launch configurations" +*.launch + +# PyDev specific (Python IDE for Eclipse) +*.pydevproject + +# CDT-specific (C/C++ Development Tooling) +.cproject + +# JDT-specific (Eclipse Java Development Tools) +.classpath + +# Java annotation processor (APT) +.factorypath + +# PDT-specific (PHP Development Tools) +.buildpath + +# sbteclipse plugin +.target + +# Tern plugin +.tern-project + +# TeXlipse plugin +.texlipse + +# STS (Spring Tool Suite) +.springBeans + +# Code Recommenders +.recommenders/ + +# Scala IDE specific (Scala & Java development for Eclipse) +.cache-main +.scala_dependencies +.worksheet + +################# +## NetBeans +################# +# https://github.com/github/gitignore/blob/master/Global/NetBeans.gitignore + +nbproject/private/ +build/ +nbbuild/ +dist/ +nbdist/ +nbactions.xml +nb-configuration.xml +.nb-gradle/ + +################# +## JetBrains +################# +# https://github.com/github/gitignore/blob/master/Global/JetBrains.gitignore + +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm + +*.iml + +## Directory-based project format: +.idea/ +# if you remove the above rule, at least ignore the following: + +# User-specific stuff: +# .idea/**/workspace.xml +# .idea/**/tasks.xml +# .idea/dictionaries + +# Sensitive or high-churn files: +# .idea/**/dataSources/ +# .idea/**/dataSources.ids +# .idea/**/dataSources.xml +# .idea/**/dataSources.local.xml +# .idea/**/sqlDataSources.xml +# .idea/**/dynamic.xml +# .idea/**/uiDesigner.xml + +# Gradle: +# .idea/**/gradle.xml +# .idea/**/libraries + +# CMake +cmake-build-debug/ + +# Mongo Explorer plugin: +# .idea/**/mongoSettings.xml + +## File-based project format: +*.ipr +*.iws + +## Plugin-specific files: + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +# .idea/replstate.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +########################## +#### Project +########################## + +################# +## Java +################# +# https://github.com/github/gitignore/blob/master/Java.gitignore + +# Compiled class file +*.class + +# Log file +*.log + +# BlueJ files +*.ctxt + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +*.jar +*.war +*.ear +*.zip +*.tar.gz +*.rar + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* + +################# +## Gradle +################# +# https://github.com/github/gitignore/blob/master/Gradle.gitignore + +.gradle +/build/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# Cache of project +.gradletasknamecache diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..f28bae1 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,13 @@ +sudo: false +dist: trusty + +language: java +jdk: + - openjdk8 + - oraclejdk8 + +install: true +script: ./gradlew build + +notifications: + email: false diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..fe67aa0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +plugin-yml +Copyright (c) 2017 Minecrell + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..c0f85bb --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,51 @@ +import org.gradle.api.tasks.bundling.Jar + +plugins { + `java-gradle-plugin` + `kotlin-dsl` + `maven-publish` + id("net.minecrell.licenser") version "0.3" +} + +repositories { + jcenter() +} + +dependencies { + compile("com.fasterxml.jackson.module:jackson-module-kotlin:2.9.1") { + exclude(group = "org.jetbrains.kotlin") + } + compile("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.9.1") +} + +var sourceJar = task("sourceJar") { + classifier = "sources" + from(java.sourceSets["main"].allSource) +} +artifacts.add("archives", sourceJar) + +gradlePlugin { + (plugins) { + "bukkit" { + id = "net.minecrell.plugin-yml.bukkit" + implementationClass = "net.minecrell.pluginyml.bukkit.BukkitPlugin" + } + "bungee" { + id = "net.minecrell.plugin-yml.bungee" + implementationClass = "net.minecrell.pluginyml.bungee.BungeePlugin" + } + } +} + +publishing { + publications { + create("mavenJava") { + from(components["java"]) + artifact(sourceJar) + } + } +} + +// Workaround for https://github.com/gradle/kotlin-dsl/issues/509 +configurations.compile.run { setExtendsFrom(extendsFrom.minus(configurations.embeddedKotlin)) } +configurations.compileOnly.extendsFrom(configurations.embeddedKotlin) diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..48ae432 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,4 @@ +group = net.minecrell +name = plugin-yml +version = 0.1.0-SNAPSHOT +description = A Gradle plugin that generates plugin.yml for Bukkit/BungeeCord plugins based on the Gradle project diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..736fb7d 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..52dd1f0 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-4.2-bin.zip diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..cccdd3d --- /dev/null +++ b/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# 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 + ;; + 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" + which java >/dev/null 2>&1 || 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 + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..f955316 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,84 @@ +@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=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@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= + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +: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 %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="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! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..89f4110 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = name diff --git a/src/main/kotlin/net/minecrell/pluginyml/GeneratePluginDescription.kt b/src/main/kotlin/net/minecrell/pluginyml/GeneratePluginDescription.kt new file mode 100644 index 0000000..07dc715 --- /dev/null +++ b/src/main/kotlin/net/minecrell/pluginyml/GeneratePluginDescription.kt @@ -0,0 +1,63 @@ +/* + * plugin-yml + * Copyright (c) 2017 Minecrell + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +package net.minecrell.pluginyml + +import com.fasterxml.jackson.annotation.JsonInclude +import com.fasterxml.jackson.databind.ObjectMapper +import com.fasterxml.jackson.dataformat.yaml.YAMLFactory +import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator +import com.fasterxml.jackson.module.kotlin.registerKotlinModule +import org.gradle.api.DefaultTask +import org.gradle.api.tasks.Input +import org.gradle.api.tasks.OutputFile +import org.gradle.api.tasks.TaskAction +import java.io.File +import java.io.Serializable + +open class GeneratePluginDescription : DefaultTask() { + + @Input + var fileName: String? = null + + @Input + var pluginDescription: Serializable? = null + + val outputFile: File + @OutputFile get() = File(temporaryDir, fileName) + + @TaskAction + fun generate() { + val factory = YAMLFactory() + .disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER) + .enable(YAMLGenerator.Feature.MINIMIZE_QUOTES) + .enable(YAMLGenerator.Feature.INDENT_ARRAYS) + + val mapper = ObjectMapper(factory) + .registerKotlinModule() + .setSerializationInclusion(JsonInclude.Include.NON_NULL) + + mapper.writeValue(outputFile, pluginDescription) + } + +} diff --git a/src/main/kotlin/net/minecrell/pluginyml/InvalidPluginDescriptionException.kt b/src/main/kotlin/net/minecrell/pluginyml/InvalidPluginDescriptionException.kt new file mode 100644 index 0000000..13be9c9 --- /dev/null +++ b/src/main/kotlin/net/minecrell/pluginyml/InvalidPluginDescriptionException.kt @@ -0,0 +1,26 @@ +/* + * plugin-yml + * Copyright (c) 2017 Minecrell + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +package net.minecrell.pluginyml + +class InvalidPluginDescriptionException(message: String) : Exception("Invalid plugin description: $message") diff --git a/src/main/kotlin/net/minecrell/pluginyml/PlatformPlugin.kt b/src/main/kotlin/net/minecrell/pluginyml/PlatformPlugin.kt new file mode 100644 index 0000000..68c5232 --- /dev/null +++ b/src/main/kotlin/net/minecrell/pluginyml/PlatformPlugin.kt @@ -0,0 +1,71 @@ +/* + * plugin-yml + * Copyright (c) 2017 Minecrell + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +package net.minecrell.pluginyml + +import org.gradle.api.Plugin +import org.gradle.api.Project +import org.gradle.api.plugins.JavaBasePlugin +import org.gradle.api.tasks.AbstractCopyTask +import org.gradle.kotlin.dsl.getValue +import org.gradle.kotlin.dsl.task +import org.gradle.kotlin.dsl.withType +import java.io.Serializable + +abstract class PlatformPlugin(private val platformName: String, private val fileName: String) : Plugin { + + protected abstract fun createExtension(project: Project): T + + override final fun apply(project: Project) { + project.run { + val description = createExtension(this) + + // Add extension + extensions.add(platformName.decapitalize(), description) + + // Create task + val generateTask = task("generate${platformName}PluginDescription") { + fileName = this@PlatformPlugin.fileName + pluginDescription = description + } + + generateTask.doFirst { + prepare(project, description) + } + + plugins.withType { + val processResources: AbstractCopyTask by tasks + processResources.from(generateTask) + } + } + } + + private fun prepare(project: Project, description: T) { + setDefaults(project, description) + validate(description) + } + + protected abstract fun setDefaults(project: Project, description: T) + protected abstract fun validate(description: T) + +} diff --git a/src/main/kotlin/net/minecrell/pluginyml/bukkit/BukkitPlugin.kt b/src/main/kotlin/net/minecrell/pluginyml/bukkit/BukkitPlugin.kt new file mode 100644 index 0000000..2c3a866 --- /dev/null +++ b/src/main/kotlin/net/minecrell/pluginyml/bukkit/BukkitPlugin.kt @@ -0,0 +1,52 @@ +/* + * plugin-yml + * Copyright (c) 2017 Minecrell + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +package net.minecrell.pluginyml.bukkit + +import net.minecrell.pluginyml.InvalidPluginDescriptionException +import net.minecrell.pluginyml.PlatformPlugin +import org.gradle.api.Project + +class BukkitPlugin : PlatformPlugin("Bukkit", "plugin.yml") { + + override fun createExtension(project: Project) = BukkitPluginDescription(project) + + override fun setDefaults(project: Project, description: BukkitPluginDescription) { + description.name = description.name ?: project.name + description.version = description.version ?: project.version.toString() + description.description = description.description ?: project.description + description.website = description.website ?: project.findProperty("url")?.toString() + // TODO: Authors + } + + override fun validate(description: BukkitPluginDescription) { + if (description.name == null) { + throw InvalidPluginDescriptionException("Plugin name is not set") + } + + if (description.main == null) { + throw InvalidPluginDescriptionException("Main class is not defined") + } + } + +} diff --git a/src/main/kotlin/net/minecrell/pluginyml/bukkit/BukkitPluginDescription.kt b/src/main/kotlin/net/minecrell/pluginyml/bukkit/BukkitPluginDescription.kt new file mode 100644 index 0000000..4310ebe --- /dev/null +++ b/src/main/kotlin/net/minecrell/pluginyml/bukkit/BukkitPluginDescription.kt @@ -0,0 +1,88 @@ +/* + * plugin-yml + * Copyright (c) 2017 Minecrell + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +package net.minecrell.pluginyml.bukkit + +import com.fasterxml.jackson.annotation.JsonIgnore +import com.fasterxml.jackson.annotation.JsonProperty +import groovy.lang.Closure +import org.gradle.api.NamedDomainObjectContainer +import org.gradle.api.Project +import java.io.Serializable + +class BukkitPluginDescription(project: Project) : Serializable { + + var name: String? = null + var version: String? = null + var main: String? = null + var description: String? = null + var load: PluginLoadOrder? = null + var authors: List? = null + var website: String? = null + var depend: List? = null + @JsonProperty("softdepend") var softDepend: List? = null + @JsonProperty("loadbefore") var loadBefore: List? = null + var prefix: String? = null + @JsonProperty("default-permission") var defaultPermission: Permission.Default? = null + + // DSL provider for commands and permissions (not serialized) + @Transient @JsonIgnore val commands: NamedDomainObjectContainer = project.container(Command::class.java) + @Transient @JsonIgnore val permissions: NamedDomainObjectContainer = project.container(Permission::class.java) + + // Java/Jackson serialization for commands and permissions + internal val commandMap: Map = commands.asMap + @JsonProperty("commands") get() = field.toMap() // Return copy + internal val permissionMap: Map = permissions.asMap + @JsonProperty("permissions") get() = field.toMap() // Return copy + + // For Groovy DSL + fun commands(closure: Closure) = commands.configure(closure) + fun permissions(closure: Closure) = permissions.configure(closure) + + enum class PluginLoadOrder { + STARTUP, + POSTWORLD + } + + data class Command(@Transient val name: String) : Serializable { + var description: String? = null + var aliases: List? = null + var permission: String? = null + @JsonProperty("permission-message") var permissionMessage: String? = null + var usage: String? = null + } + + data class Permission(@Transient val name: String) : Serializable { + var description: String? = null + var default: Default? = null + var children: List? = null + + enum class Default { + @JsonProperty("true") TRUE, + @JsonProperty("false") FALSE, + @JsonProperty("op") OP, + @JsonProperty("!op") NOT_OP + } + } + +} diff --git a/src/main/kotlin/net/minecrell/pluginyml/bungee/BungeePlugin.kt b/src/main/kotlin/net/minecrell/pluginyml/bungee/BungeePlugin.kt new file mode 100644 index 0000000..1dea260 --- /dev/null +++ b/src/main/kotlin/net/minecrell/pluginyml/bungee/BungeePlugin.kt @@ -0,0 +1,51 @@ +/* + * plugin-yml + * Copyright (c) 2017 Minecrell + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +package net.minecrell.pluginyml.bungee + +import net.minecrell.pluginyml.InvalidPluginDescriptionException +import net.minecrell.pluginyml.PlatformPlugin +import org.gradle.api.Project + +class BungeePlugin : PlatformPlugin("Bungee", "bungee.yml") { + + override fun createExtension(project: Project) = BungeePluginDescription() + + override fun setDefaults(project: Project, description: BungeePluginDescription) { + description.name = description.name ?: project.name + description.version = description.version ?: project.version.toString() + description.description = description.description ?: project.description + // TODO: Author + } + + override fun validate(description: BungeePluginDescription) { + if (description.name == null) { + throw InvalidPluginDescriptionException("Plugin name is not set") + } + + if (description.main == null) { + throw InvalidPluginDescriptionException("Main class is not defined") + } + } + +} diff --git a/src/main/kotlin/net/minecrell/pluginyml/bungee/BungeePluginDescription.kt b/src/main/kotlin/net/minecrell/pluginyml/bungee/BungeePluginDescription.kt new file mode 100644 index 0000000..a7d8648 --- /dev/null +++ b/src/main/kotlin/net/minecrell/pluginyml/bungee/BungeePluginDescription.kt @@ -0,0 +1,36 @@ +/* + * plugin-yml + * Copyright (c) 2017 Minecrell + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +package net.minecrell.pluginyml.bungee + +import java.io.Serializable + +class BungeePluginDescription : Serializable { + var name: String? = null + var main: String? = null + var version: String? = null + var author: String? = null + var depends: Set? = null + var softDepends: Set? = null + var description: String? = null +}