#25 gradle plugin for using Flapi within a gradle project

Author: UnquietCode

flapi-build-test-consumer/build.gradle

@@ -0,0 +1,15 @@
+apply plugin: 'java'
+apply plugin: 'maven'
+
+group = 'unquietcode.tools.flapi.test'
+version = '0.0-DEVELOPMENT'
+sourceCompatibility = '1.7'
+
+repositories {
+	mavenLocal()
+}
+
+dependencies {
+	compile 'unquietcode.tools.flapi.test:flapi-build-test-producer:0.0-DEVELOPMENT'
+	testCompile 'junit:junit:4.11'
+}

flapi-build-test-producer/build.gradle

@@ -0,0 +1,35 @@
+apply plugin: 'java'
+apply plugin: 'maven'
+
+group = 'unquietcode.tools.flapi.test'
+version = '0.0-DEVELOPMENT'
+sourceCompatibility = '1.7'
+
+// add the gradle plugin
+buildscript {
+	repositories {
+		mavenLocal()
+	}
+
+	dependencies {
+		classpath 'unquietcode.tools.flapi:flapi-gradle-plugin:0.0-DEVELOPMENT'
+	}
+}
+apply plugin: 'com.unquietcode.flapi.plugin'
+
+
+// ------------------------------------------------------- //
+
+
+repositories {
+	mavenLocal()
+}
+
+dependencies {
+	testCompile 'unquietcode.tools.flapi:flapi:0.0-DEVELOPMENT'
+}
+
+flapi {
+	descriptorClasses = ['unquietcode.tools.flapi.plugin.TestDescriptor']
+	includeRuntime = true
+}

flapi-gradle-plugin/build.gradle

@@ -0,0 +1,17 @@
+apply plugin: 'groovy'
+apply plugin: 'maven'
+
+group = 'unquietcode.tools.flapi'
+version = '0.0-DEVELOPMENT'
+sourceCompatibility = '1.7'
+
+repositories {
+	mavenLocal()
+}
+
+dependencies {
+	compile gradleApi()
+	compile localGroovy()
+
+	compile 'unquietcode.tools.flapi:flapi-plugin:0.0-DEVELOPMENT'
+}

flapi-gradle-plugin/src/main/groovy/unquietcode/tools/flapi/plugin/FlapiPluginExtension.groovy

@@ -0,0 +1,59 @@
+/*********************************************************************
+ Copyright 2015 the Flapi 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
+
+     http://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.
+ ********************************************************************/
+
+package unquietcode.tools.flapi.plugin
+
+/**
+ * Configuration closure for the Flapi Gradle plugin.
+ *
+ * @author Ben Fagin
+ * @version 2015-03-17
+ */
+public class FlapiPluginExtension {
+
+	/**
+	 * The list of {@link unquietcode.tools.flapi.DescriptorMaker} classes.
+	 */
+	String[] descriptorClasses;
+
+	/**
+	 * The directory to which the generated classes
+	 * will be written.
+	 */
+	String classesDirectory;
+
+	/**
+	 * The directory to which the generated sources
+	 * will be written.
+	 */
+	String sourcesDirectory;
+
+	/**
+	 * If true, the runtime classes will be written
+	 * out alongside the generated classes.
+	 */
+	boolean includeRuntime = true
+
+	/**
+	 * If true, the sources will be written.
+	 */
+	boolean writeSources = true
+
+	/**
+	 * If true, the sources will be compiled and written.
+	 */
+	boolean writeClasses = true
+}

flapi-gradle-plugin/src/main/groovy/unquietcode/tools/flapi/plugin/GradlePlugin.groovy

@@ -0,0 +1,113 @@
+/*********************************************************************
+ Copyright 2015 the Flapi 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
+
+     http://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.
+ ********************************************************************/
+
+package unquietcode.tools.flapi.plugin
+
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+
+/**
+ * Gradle plugin for generating and compiling descriptors.
+ *
+ * @author Ben Fagin
+ * @version 2015-02-03
+ */
+public class GradlePlugin implements Plugin<Project> {
+
+ 	@Override
+	public void apply(Project project) {
+	    FlapiPluginExtension properties = project.extensions.create("flapi", FlapiPluginExtension)
+	    project.apply plugin: 'java'
+
+	    def flapiTask = project.task('flapi') << {
+		    runTask(project, properties)
+	    }
+
+	    def testClassesTask = project.tasks.getByName('testClasses')
+
+		// Add a dependency to the 'flapi' task for all existing 'testClasses' dependencies.
+	    testClassesTask.getTaskDependencies().getDependencies(testClassesTask).each {
+		    flapiTask.dependsOn(it)
+	    }
+
+		// Add the 'flapi' task as a dependency of 'testClasses'.
+		testClassesTask.dependsOn(flapiTask)
+    }
+
+	private void runTask(Project project, FlapiPluginExtension properties) {
+
+	    // default for sources directory
+	    if (isEmpty(properties.sourcesDirectory)) {
+		    properties.sourcesDirectory = project.buildDir.getAbsolutePath()+File.separator+"generated-sources"
+	    }
+
+	    // default for classes directory
+	    if (isEmpty(properties.classesDirectory)) {
+			properties.classesDirectory = project.sourceSets.main.output.classesDir.getPath()
+	    }
+
+	    // set up shared plugin helper
+	    final PluginHelper helper = new PluginHelper(properties.classesDirectory, properties.sourcesDirectory) {
+		    protected @Override Exception handleError(String message, Throwable cause) throws Exception {
+			    throw new RuntimeException(message, cause);
+		    }
+
+		    protected @Override Exception handleFailure(String message, Throwable cause) throws Exception {
+			    throw new Exception(message, cause);
+		    }
+
+		    protected @Override void logInfo(String message) {
+			    project.logger.info(message)
+		    }
+
+		    protected @Override void logWarn(String message) {
+			    project.logger.warn(message)
+		    }
+
+		    protected @Override void logError(String message) {
+			    project.logger.error(message)
+		    }
+
+		    protected @Override URLClassLoader getCompiledClassloader() throws Exception {
+			    List<URL> urls = new ArrayList<>();
+
+			    // dependencies
+				for (def path : project.configurations['testCompile']) {
+				    urls.add(path.toURI().toURL())
+				}
+
+			    // sources
+			    for (def sourceSet : project.sourceSets) {
+			        urls.add(sourceSet.output.classesDir.toURI().toURL())
+			    }
+
+			    return new URLClassLoader(urls.toArray(new URL[urls.size()]), getClass().getClassLoader());
+		    }
+	    };
+
+	    // configure it
+	    helper.setIncludeRuntime(properties.includeRuntime)
+	    helper.setWriteClasses(properties.writeClasses)
+	    helper.setWriteSources(properties.writeSources)
+
+	    // run it
+		helper.processDescriptors(properties.descriptorClasses)
+	}
+
+	private static boolean isEmpty(String s) {
+		return s == null || s.trim().isEmpty()
+	}
+}

flapi-gradle-plugin/src/main/resources/META-INF/gradle-plugins/com.unquietcode.flapi.plugin.properties

@@ -0,0 +1 @@
+implementation-class=unquietcode.tools.flapi.plugin.GradlePlugin

flapi-plugin/src/main/java/unquietcode/tools/flapi/plugin/PluginHelper.java

@@ -50,8 +50,8 @@ public abstract class PluginHelper {
 	private boolean includeRuntime = true;
 
 	public PluginHelper(String classesDirectory, String sourcesDirectory) {
-		this.classesDirectory = Objects.requireNonNull(classesDirectory);
-		this.sourcesDirectory = Objects.requireNonNull(sourcesDirectory);
+		this.classesDirectory = Objects.requireNonNull(classesDirectory, "classes directory is required");
+		this.sourcesDirectory = Objects.requireNonNull(sourcesDirectory, "sources directory is required");
 	}
 
 	public void setWriteClasses(boolean writeClasses) {