Update to v0.7.1

Author: osipxd

README.md

@@ -14,51 +14,62 @@ Gradle utilities for easier writing Bukkit plugins.
 - Automatically applies plugins: java, idea, eclipse
 - Sets up compiler encoding to UTF-8
 - Adds repositories: mavenCentral, mavenLocal, spigot-repo, sk89q-repo
-- Automatically resolves needed version of bukkit api
+- Provides short extension-functions to include bukkit/craftbukkit/spigot/spigot-api
 - Generates plugin.yml from Gradle project information
 - Allows to run dev server from IDE
+- Automatically copies your plugin to plugins dir on server running
 
 #### TODO:
+- Add extension function for PaperApi
+- Add possibility to use Paper/CraftBukkit as dev server core
+- Add automatically downloading of BuildTools
 - Add smart dependency system
 
 ## Apply plugin
 [BukkitGradle on plugins.gradle.org](https://plugins.gradle.org/plugin/ru.endlesscode.bukkitgradle)
-#### Gradle 2.1 and higher
+#### With new plugins mechanism
 ```groovy
 plugins {
-  id "ru.endlesscode.bukkitgradle" version "0.6.7"
+  id "ru.endlesscode.bukkitgradle" version "0.7.1"
 }
 ```
 
-#### Any gradle versions
+#### With buildscript and apply
 ```groovy
 buildscript {
   repositories {
     jcenter()
   }
   dependencies {
-    classpath "gradle.plugin.ru.endlesscode:bukkit-gradle:0.6.7"
+    classpath "gradle.plugin.ru.endlesscode:bukkit-gradle:0.7.1"
   }
 }
 
 apply plugin: "ru.endlesscode.bukkitgradle"
 ```
 
 ## Usage
-You can clone [this example project](https://github.com/EndlessCodeGroup/BukkitGradle-Example), and use it for quick start.
+You can clone [this example project](https://github.com/EndlessCodeGroup/BukkitGradle-Example) [**OUTDATED**], and use it for quick start.
 
 ### First steps
 Simple `build.gradle` file that use BukkitGradle:
 ```groovy
 plugins {
-    id "ru.endlesscode.bukkitgradle" version "0.6.7"
+    id "ru.endlesscode.bukkitgradle" version "0.7.1"
 }
  
 // Project information
 group "com.example"
 description "My first Bukkit plugin with Gradle"
 version "0.1"
+
+// Let's add needed API to project
+dependencies {
+    compileOnly bukkit() 
+    // You also can use craftbukkit(), spigot() and spigotApi()
+}
 ```
+`compileOnly` - it's like provided scope in Maven. It means that this dependncy will not included to your final jar.
 It's enough! Will be hooked latest version of Bukkit and automatically generated `plugin.yml` with next content:
 ```yaml
 name: MyPlugin
@@ -73,8 +84,8 @@ You can configure attributes that will be placed to `plugin.yml`:
 ```groovy
 // Override default configurations
 bukkit {
-    // Version of Bukkit (latest by default)
-    version = "1.10.2"
+    // Version of API (latest by default)
+    version = "1.12.2"
  
     // Attributes for plugin.yml
     meta {
@@ -102,9 +113,21 @@ Also you can add custom (unsupported by BukkitGradle) attributes like a `depend`
 Just create `plugin.yml` file and put custom attributes into.
 
 ### Running Dev server
+Before running server you should configure BuildTools and dev server location.
+
+You can define it in `local.properties` file (that was automatically created in project root on refresh):
+```properties
+# Absolute path to directory that contains BuildTools.jar
+buildtools.dir=/path/to/buildtools/
+# Absolute path to dev server
+server.dir=/path/to/buildtools/
+```
+Or you can define it globally (for all projects that uses BukkitGradle) with environment variables `BUKKIT_DEV_SERVER_HOME` 
+and `BUILDTOOLS_HOME`.
 
 ##### On IntelliJ IDEA
-Run `:buildIdeaRun` task. To your IDE will be added Run Configuration that will dynamically refreshes when you change server configurations.
+Run `:buildIdeaRun` task. To your IDE will be added Run Configuration that will dynamically refreshes when you change 
+server configurations.
 
 ![Run Configuration](http://image.prntscr.com/image/1a12a03b8ac54fccb7d5b70a335fa996.png)
 
@@ -121,8 +144,6 @@ bukkit {
        eula = false
        // Set online-mode flag
        onlineMode = false
-       // Path to deploy server (relative)
-       dir = "server"
        // Debug mode (listen 5005 port, if you use running from IDEA this option will be ignored)
        debug = true
        // Set server encoding (flag -Dfile.encoding)

build.gradle

@@ -3,7 +3,7 @@ plugins {
     id "idea"
 
     id "java-gradle-plugin"
-    id "com.gradle.plugin-publish" version "0.9.9"
+    id "com.gradle.plugin-publish" version "0.9.10"
 }
 
 apply from: "jacoco.gradle"
@@ -17,10 +17,10 @@ repositories {
 jar.archivePath
 
 dependencies {
-    compile gradleApi()
-    compile localGroovy()
-    compile group: "de.undercouch", name: "gradle-download-task", version: "3.2.+"
-    testCompile group: "junit", name: "junit", version: "4.12"
+    implementation gradleApi()
+    implementation localGroovy()
+    implementation "de.undercouch:gradle-download-task:3.4.3"
+    testImplementation "junit:junit:4.12"
 }
 
 pluginBundle {

gradle.properties

@@ -1,6 +1,6 @@
 group=ru.endlesscode
 description=Bukkit Gradle integration plugins
-version=0.7.0
+version=0.7.1
 org.gradle.jvmargs=-Xmx3G
 org.gradle.parallel=true
 org.gradle.daemon=true

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.6-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.3.1-bin.zip

gradle/wrapper/gradle-wrapper.properties

@@ -11,7 +11,6 @@ class Bukkit {
     private final Project project
 
     String version
-    String buildtools = ''
 
     final PluginMeta meta
     final RunConfiguration run

src/main/groovy/ru/endlesscode/bukkitgradle/extension/Bukkit.groovy

@@ -18,7 +18,6 @@ class RunConfiguration {
     boolean onlineMode
     boolean debug
     String encoding
-    String dir
     String javaArgs
     String bukkitArgs
 
@@ -29,7 +28,6 @@ class RunConfiguration {
         this.onlineMode = false
         this.debug = true
         this.encoding = 'UTF-8'
-        this.dir = 'server'
 
         this.javaArgs = '-Xmx1G'
         this.bukkitArgs = ''
@@ -53,15 +51,6 @@ class RunConfiguration {
         return bukkitArgs ?: ''
     }
 
-    /**
-     * Returns servers dir
-     *
-     * @return The directory
-     */
-    Path getDir() {
-        project.projectDir.toPath().resolve(this.dir)
-    }
-
     /**
      * Builds and writes to file run configuration in IDEA .xml format
      *

src/main/groovy/ru/endlesscode/bukkitgradle/extension/RunConfiguration.groovy

@@ -76,7 +76,7 @@ class MetaFile {
      */
     private void filterMetaLines() {
         staticLines.clear()
-        if (!Files.exists(metaFile)) {
+        if (Files.notExists(metaFile)) {
             return
         }
 

src/main/groovy/ru/endlesscode/bukkitgradle/meta/MetaFile.groovy

@@ -11,9 +11,12 @@ class PluginMeta {
     final MetaItem url
     final MetaItem authors
 
+    private final Project project
     private final List<MetaItem> metaItems = []
 
     PluginMeta(Project project) {
+        this.project = project
+
         this.name = new MetaItem("name", true, project.name)
         this.description = new MetaItem("description", { project.description })
         this.main = new MetaItem("main", true, { "${project.group}.${getName().toLowerCase()}.${getName()}" })
@@ -26,6 +29,7 @@ class PluginMeta {
 
     void setName(def name) {
         this.name.value = name
+        project.archivesBaseName = getName()
     }
 
     String getName() {
@@ -75,4 +79,24 @@ class PluginMeta {
     List<MetaItem> getItems() {
         return metaItems
     }
+
+    /**
+     * Enclose value in single quotes.
+     *
+     * @param value The value
+     * @return Value with single quotes around
+     */
+    def q(value) {
+        return "'$value'"
+    }
+
+    /**
+     * Enclose value in double quotes.
+     *
+     * @param value The value
+     * @return Value with double quotes around
+     */
+    def qq(value) {
+        return "\"$value\""
+    }
 }