Merge pull request #2 from ChillyCheesy/update/documentation

Update/documentation

Author: AymericHenouille

README.md

@@ -1,6 +1,12 @@
-# Modulo Application Plugin
+<div align="center">
 
+# Modulo Application Plugin
 ![Release App](https://github.com/ChillyCheesy/ModuloGradleApplication/actions/workflows/release-app.yml/badge.svg?branch=master)
+[![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/com.chillycheesy.modulo-application)](https://plugins.gradle.org/plugin/com.chillycheesy.modulo-application)
+
+</div>
+
+---  
 
 ## Overview.
 The HomeTracker Application Plugin give help to deploy HomeTracker's modules.
@@ -16,14 +22,16 @@ The HomeTracker Application Plugin give help to deploy HomeTracker's modules.
         * [module](#closures-module)
     * [Tasks section](#tasks)
         * [generateModuleYml](#tasks-generateModuleYml)
+        * [runModuloServer](#tasks-runModuloServer)
+        * [deployModuleToLocalModuloServer](#tasks-deployModuleToLocalModuloServer)
 
 ## Getting Started Using the Plugin. <a id="start"></a>
 ### *Step 1: Apply the plugin to your Gradle build script.* <a id="start-1"></a>
 To apply the plugin, please add this following part of code.  
 
 ```groovy
 plugins {
-    id 'com.chillycheesy.modulo-application' version '0.0.3'
+    id 'com.chillycheesy.modulo-application' version '1.1.0'
 }
 
 group 'your.group'
@@ -50,8 +58,7 @@ $> ./gradlew build
 ```
 
 ### *Step 4: Use your module.* <a id="start-4"></a>
-Take the built module and put it in the *modules* file of your Modulo server.  
-
+Take the built module and put it in the *modules* file of your Modulo server.
 > Enjoy 🍻 🌶🧀 
 
 ## Plugins Documentation. <a id="doc"></a>
@@ -83,18 +90,32 @@ The following array was the exhaustive list of **module**'s parameters.
 
 |       Key        | Description                                              | Equivalent of YAML |                                  Default value |
 |:----------------:|:---------------------------------------------------------|:------------------:|-----------------------------------------------:|
-| moduleName       | Module name.                                             |        name        |                      Your Gradle project name. |
-| version          | Module version.                                          |       version      |                   Your Gradle project version. |
-| authors          | Module authors.                                          |       authors      |                               ['ChillyCheesy'] |
-| main             | Module main.                                             |        main        | Concat the project group and the project name. |
-| mainPageName     | Module main page name.                                   |     mainPageName   |                                        'index' |
-| dependencies     | Module dependencies.                                     |     dependencies   |                                    Empty list. |
-| softDependencies | Module soft dependencies.                                |   softDependencies |                                    Empty list. |
-| target           | The output folder for the generated **module.yml** file. |        none        |                           'src/main/resources' |
+|    moduleName    | Module name.                                             |        name        |                      Your Gradle project name. |
+|     version      | Module version.                                          |      version       |                   Your Gradle project version. |
+|     authors      | Module authors.                                          |      authors       |                               ['ChillyCheesy'] |
+|       main       | Module main.                                             |        main        | Concat the project group and the project name. |
+|   mainPageName   | Module main page name.                                   |    mainPageName    |                                        'index' |
+|   dependencies   | Module dependencies.                                     |    dependencies    |                                    Empty list. |
+| softDependencies | Module soft dependencies.                                |  softDependencies  |                                    Empty list. |
+|      target      | The output folder for the generated **module.yml** file. |        none        |                           'src/main/resources' |
+|  moduloVersion   | The target version for the modulo server.                |        none        |                                  'BINKS-0.1.1' |
+
 
 
 ## Tasks section. <a id="tasks"></a>
 ### generateModuleYml. <a id="tasks-generateModuleYml"></a>
-This task generate the **module.yml** file.
+This task generate the **module.yml** file.  
+If you run the processResources task. It will automatically call the generateModuleYml task.  
+The processResources task depends on the generateModuleYml task.
+
+
+### runModuloServer. <a id="tasks-runModuloServer"></a>
+This task run a modulo server. The version of the modulo server is defined by the **moduloVersion** parameter.  
+*[(See moduloVersion closure for more information.)](#closures-module)*  
+The server name is automatically downloaded and placed in the ```modulo-server``` folder at the root of your project.  
+The runModuloServer task depends on the deployModuleToLocalModuloServer task.
+
+### deployModuleToLocalModuloServer. <a id="tasks-deployModuleToLocalModuloServer"></a>
+This task build your module and copy it on the ```modulo-server/modules``` folder at the root of your project.
 
 🌶🧀

build.gradle

@@ -5,7 +5,7 @@ plugins {
     id 'maven-publish'
 }
 
-version = '1.0.0'
+version = '1.1.0'
 group = 'com.chillycheesy'
 
 repositories {

src/main/groovy/com/chillycheesy/modulo/extensions/ModuleExtension.groovy

@@ -42,7 +42,7 @@ class ModuleExtension {
     /**
      * Modulo api version.
      */
-    String moduloVersion = 'BINKS-0.1.0'
+    String moduloVersion = 'BINKS-0.1.1'
 
     /**
      * Init the extension with default values.

src/main/groovy/com/chillycheesy/modulo/tasks/DeployModuleTask.groovy

@@ -2,16 +2,25 @@ package com.chillycheesy.modulo.tasks
 
 import org.gradle.api.Project
 
+/**
+ * Define deployModuleToLocalModuloServer Task.
+ * This task build your module and copy it on the ```modulo-server/modules``` folder at the root of your project.
+ */
 class DeployModuleTask implements ModuloTask {
 
+    /**
+     * Create the task.
+     * @param project Target project.
+     * @return The new task
+     */
     @Override
     def generate(Project project) {
         return project.task('deployModuleToLocalModuloServer') {
             group = 'modulo'
             description = 'Deploy the module to the local modulo server module file.'
             doLast {
                 final moduleSrc = project.fileTree("$project.buildDir/libs")
-                final moduleDest = project.file('modulo/modules')
+                final moduleDest = project.file('modulo-server/modules')
                 assert moduleDest.exists() || moduleDest.mkdirs()
                 project.copy {
                     from moduleSrc

src/main/groovy/com/chillycheesy/modulo/tasks/RunModuloServer.groovy

@@ -3,23 +3,43 @@ package com.chillycheesy.modulo.tasks
 import com.chillycheesy.modulo.extensions.ModuleExtension
 import org.gradle.api.Project
 
+/**
+ * Define the runModuloServer task.
+ * This task download and run a modulo server.
+ * The server is downloaded from the official repository at the <code>modulo-server</code> folder.
+ */
 class RunModuloServer implements ModuloTask {
 
+    /**
+     * Official repository url.
+     */
     private final def LINK = 'https://s01.oss.sonatype.org/content/repositories/releases/com/chillycheesy/modulo-server'
 
+    /**
+     * The ModuleExtension store plugin.yml data and other information.
+     */
     private ModuleExtension moduleExtension
 
+    /**
+     * Create the task.
+     * @param moduleExtension The module extension who store plugin.yml data and other information.
+     */
     RunModuloServer(ModuleExtension moduleExtension) {
         this.moduleExtension = moduleExtension
     }
 
+    /**
+     * Create the task.
+     * @param project Target project.
+     * @return The new task
+     */
     @Override
     def generate(Project project) {
         return project.task('runModuloServer') {
             group = 'modulo'
-            description = 'Run the Modulo server.'
+            description = 'Run a Modulo server.'
             doLast {
-                final file = new File("${project.rootDir.path}/modulo/modulo-server-${moduleExtension.moduloVersion}.jar")
+                final file = new File("${project.rootDir.path}/modulo-server/modulo-server-${moduleExtension.moduloVersion}.jar")
                 assert file.parentFile.exists() || file.parentFile.mkdirs()
                 project.delete(project.fileTree(file.parent) {
                     include '*.jar'
@@ -36,7 +56,11 @@ class RunModuloServer implements ModuloTask {
         }
     }
 
-    private def downloadFile(File file) {
+    /**
+     * Download the modulo server jar file.
+     * @param file The file to download.
+     */
+    private downloadFile(File file) {
         def url = "$LINK/${moduleExtension.moduloVersion}/${file.getName()}"
         println "Downloading ${url} to ${file.getPath()}..."
         new URL(url).openConnection().with { connection ->