Rename and relocate Gradle task classes

Use idiomatic naming for the 'format' and 'checkFormat' tasks.

Closes gh-271

Author: philwebb

spring-javaformat-gradle/spring-javaformat-gradle-plugin/src/main/java/io/spring/javaformat/gradle/SpringJavaFormatPlugin.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 the original author or authors.
+ * Copyright 2017-2021 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,10 @@
 import org.gradle.api.plugins.JavaPluginConvention;
 import org.gradle.api.tasks.SourceSet;
 
+import io.spring.javaformat.gradle.tasks.CheckFormat;
+import io.spring.javaformat.gradle.tasks.Format;
+import io.spring.javaformat.gradle.tasks.FormatterTask;
+
 /**
  * Spring Format Gradle Plugin.
  *
@@ -42,28 +46,28 @@ public void apply(Project project) {
 
 	private void addSourceTasks() {
 		this.project.getPlugins().withType(JavaBasePlugin.class, (plugin) -> {
-			Task formatAll = this.project.task(FormatTask.NAME);
-			formatAll.setDescription(FormatTask.DESCRIPTION);
-			Task checkAll = this.project.task(CheckTask.NAME);
-			checkAll.setDescription(CheckTask.DESCRIPTION);
+			Task formatAll = this.project.task(Format.NAME);
+			formatAll.setDescription(Format.DESCRIPTION);
+			Task checkAll = this.project.task(CheckFormat.NAME);
+			checkAll.setDescription(CheckFormat.DESCRIPTION);
 			this.project.getTasks().getByName(JavaBasePlugin.CHECK_TASK_NAME).dependsOn(checkAll);
 			this.project.getConvention().getPlugin(JavaPluginConvention.class).getSourceSets()
 					.all((sourceSet) -> addSourceTasks(sourceSet, checkAll, formatAll));
 		});
 	}
 
 	private void addSourceTasks(SourceSet sourceSet, Task checkAll, Task formatAll) {
-		CheckTask checkTask = addSourceTask(sourceSet, CheckTask.class, CheckTask.NAME, CheckTask.DESCRIPTION);
+		CheckFormat checkTask = addFormatterTask(sourceSet, CheckFormat.class, CheckFormat.NAME,
+				CheckFormat.DESCRIPTION);
 		checkTask.setReportLocation(
 				new File(this.project.getBuildDir(), "reports/format/" + sourceSet.getName() + "/check-format.txt"));
 		checkAll.dependsOn(checkTask);
-		FormatTask formatSourceSet = addSourceTask(sourceSet, FormatTask.class, FormatTask.NAME,
-				FormatTask.DESCRIPTION);
+		Format formatSourceSet = addFormatterTask(sourceSet, Format.class, Format.NAME, Format.DESCRIPTION);
 		formatSourceSet.conventionMapping("encoding", () -> "UTF-8");
 		formatAll.dependsOn(formatSourceSet);
 	}
 
-	private <T extends FormatterTask> T addSourceTask(SourceSet sourceSet, Class<T> taskType, String name,
+	private <T extends FormatterTask> T addFormatterTask(SourceSet sourceSet, Class<T> taskType, String name,
 			String desc) {
 		String taskName = sourceSet.getTaskName(name, null);
 		T task = this.project.getTasks().create(taskName, taskType);

spring-javaformat-gradle/spring-javaformat-gradle-plugin/src/main/java/io/spring/javaformat/gradle/CheckTask.java renamed to spring-javaformat-gradle/spring-javaformat-gradle-plugin/src/main/java/io/spring/javaformat/gradle/tasks/CheckFormat.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 the original author or authors.
+ * Copyright 2017-2021 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.spring.javaformat.gradle;
+package io.spring.javaformat.gradle.tasks;
 
 import java.io.File;
 import java.io.IOException;
@@ -40,7 +40,7 @@
  * @author Phillip Webb
  */
 @CacheableTask
-public class CheckTask extends FormatterTask {
+public class CheckFormat extends FormatterTask {
 
 	/**
 	 * The name of the task.

spring-javaformat-gradle/spring-javaformat-gradle-plugin/src/main/java/io/spring/javaformat/gradle/FormatTask.java renamed to spring-javaformat-gradle/spring-javaformat-gradle-plugin/src/main/java/io/spring/javaformat/gradle/tasks/Format.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2019 the original author or authors.
+ * Copyright 2017-2021 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.spring.javaformat.gradle;
+package io.spring.javaformat.gradle.tasks;
 
 import java.io.IOException;
 
@@ -29,7 +29,7 @@
  *
  * @author Phillip Webb
  */
-public class FormatTask extends FormatterTask {
+public class Format extends FormatterTask {
 
 	/**
 	 * The name of the task.

spring-javaformat-gradle/spring-javaformat-gradle-plugin/src/main/java/io/spring/javaformat/gradle/FormatterTask.java renamed to spring-javaformat-gradle/spring-javaformat-gradle-plugin/src/main/java/io/spring/javaformat/gradle/tasks/FormatterTask.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.spring.javaformat.gradle;
+package io.spring.javaformat.gradle.tasks;
 
 import java.nio.charset.Charset;
 import java.util.stream.Stream;
@@ -32,10 +32,13 @@
  *
  * @author Phillip Webb
  */
-abstract class FormatterTask extends SourceTask {
+public abstract class FormatterTask extends SourceTask {
 
 	private String encoding;
 
+	FormatterTask() {
+	}
+
 	/**
 	 * Get the file encoding in use.
 	 * @return the encoding the file encoding

spring-javaformat-gradle/spring-javaformat-gradle-plugin/src/test/java/io/spring/javaformat/gradle/CheckTaskTests.java

@@ -31,13 +31,14 @@
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.junit.jupiter.api.io.TempDir;
 
+import io.spring.javaformat.gradle.tasks.CheckFormat;
 import io.spring.javaformat.gradle.testkit.GradleBuild;
 import io.spring.javaformat.gradle.testkit.GradleBuildExtension;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
- * Tests for {@link CheckTask}.
+ * Tests for {@link CheckFormat}.
  *
  * @author Phillip Webb
  */

spring-javaformat-gradle/spring-javaformat-gradle-plugin/src/test/java/io/spring/javaformat/gradle/FormatTaskTests.java

@@ -25,13 +25,14 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 
+import io.spring.javaformat.gradle.tasks.Format;
 import io.spring.javaformat.gradle.testkit.GradleBuild;
 import io.spring.javaformat.gradle.testkit.GradleBuildExtension;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
- * Tests for {@link FormatTask}.
+ * Tests for {@link Format}.
  *
  * @author Phillip Webb
  */