Skip to content

Commit 908f52e

Browse files
sjohnrsjohnr
committed
Format new plugin code
Closes gh-54
1 parent 65c0400 commit 908f52e

15 files changed

+111
-54
lines changed

‎project-plugin/src/main/java/io/spring/gradle/plugin/module/SpringProjectPlugin.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,14 @@
3030
* @author Steve Riesenberg
3131
*/
3232
public class SpringProjectPlugin implements Plugin<Project> {
33+
3334
@Override
3435
public void apply(Project project) {
3536
// Apply default plugins
3637
PluginManager pluginManager = project.getPluginManager();
3738
if (project.getRootProject().equals(project)) {
3839
pluginManager.apply(BasePlugin.class);
39-
// pluginManager.apply(SpringNoHttpPlugin.class);
40+
// pluginManager.apply(SpringNoHttpPlugin.class);
4041
pluginManager.apply(SpringCheckProhibitedDependenciesLifecyclePlugin.class);
4142
}
4243
else {
@@ -45,4 +46,5 @@ public void apply(Project project) {
4546
pluginManager.apply(SpringCheckClasspathForProhibitedDependenciesPlugin.class);
4647
}
4748
}
49+
4850
}

‎project-plugin/src/main/java/org/springframework/gradle/SpringJavaPlugin.java

+7-7
Original file line numberDiff line numberDiff line change
@@ -44,22 +44,20 @@
4444
* @author Steve Riesenberg
4545
*/
4646
public class SpringJavaPlugin implements Plugin<Project> {
47+
4748
@Override
4849
public void apply(Project project) {
4950
// Apply default plugins
5051
PluginManager pluginManager = project.getPluginManager();
51-
if (project.file("src/main/java").exists()
52-
|| project.file("src/test/java").exists()
52+
if (project.file("src/main/java").exists() || project.file("src/test/java").exists()
5353
|| project.file("src/integration-test/java").exists()) {
5454
pluginManager.apply("org.gradle.java");
5555
}
56-
if (project.file("src/main/groovy").exists()
57-
|| project.file("src/test/groovy").exists()
56+
if (project.file("src/main/groovy").exists() || project.file("src/test/groovy").exists()
5857
|| project.file("src/integration-test/groovy").exists()) {
5958
pluginManager.apply("org.gradle.groovy");
6059
}
61-
if (project.file("src/main/kotlin").exists()
62-
|| project.file("src/test/kotlin").exists()
60+
if (project.file("src/main/kotlin").exists() || project.file("src/test/kotlin").exists()
6361
|| project.file("src/integration-test/kotlin").exists()
6462
|| project.getBuildFile().getName().endsWith(".kts")) {
6563
pluginManager.apply("org.jetbrains.kotlin.jvm");
@@ -89,7 +87,8 @@ public void apply(Project project) {
8987
// Configure jar task
9088
project.getTasks().withType(Jar.class, (jar) -> jar.manifest((manifest) -> {
9189
Map<String, String> attributes = new HashMap<>();
92-
attributes.put("Created-By", String.format("%s (%s)", System.getProperty("java.version"), System.getProperty("java.specification.vendor")));
90+
attributes.put("Created-By", String.format("%s (%s)", System.getProperty("java.version"),
91+
System.getProperty("java.specification.vendor")));
9392
attributes.put("Implementation-Title", project.getName());
9493
attributes.put("Implementation-Version", project.getVersion().toString());
9594
attributes.put("Automatic-Module-Name", project.getName().replace("-", "."));
@@ -99,4 +98,5 @@ public void apply(Project project) {
9998
// Configure JUnit 5
10099
project.getTasks().withType(Test.class, Test::useJUnitPlatform);
101100
}
101+
102102
}

‎project-plugin/src/main/java/org/springframework/gradle/checkstyle/SpringJavaCheckstylePlugin.java

+30-10
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,21 @@
3535
* @author Steve Riesenberg
3636
*/
3737
public class SpringJavaCheckstylePlugin implements Plugin<Project> {
38+
3839
private static final String CHECKSTYLE_DIR = "etc/checkstyle";
40+
3941
private static final String SPRING_JAVAFORMAT_VERSION_PROPERTY = "springJavaformatVersion";
42+
4043
private static final String DEFAULT_SPRING_JAVAFORMAT_VERSION = "0.0.38";
44+
4145
private static final String NOHTTP_CHECKSTYLE_VERSION_PROPERTY = "nohttpCheckstyleVersion";
46+
4247
private static final String DEFAULT_NOHTTP_CHECKSTYLE_VERSION = "0.0.11";
48+
4349
private static final String CHECKSTYLE_TOOL_VERSION_PROPERTY = "checkstyleToolVersion";
50+
4451
private static final String DEFAULT_CHECKSTYLE_TOOL_VERSION = "8.34";
52+
4553
private static final String SPRING_JAVAFORMAT_EXCLUDE_PACKAGES_PROPERTY = "springJavaformatExcludePackages";
4654

4755
@Override
@@ -51,20 +59,27 @@ public void apply(Project project) {
5159
if (checkstyleDir.exists() && checkstyleDir.isDirectory()) {
5260
project.getPluginManager().apply(CheckstylePlugin.class);
5361

54-
// NOTE: See gradle.properties#springJavaformatVersion for actual version number
55-
project.getDependencies().add("checkstyle", "io.spring.javaformat:spring-javaformat-checkstyle:" + getSpringJavaformatVersion(project));
56-
// NOTE: See gradle.properties#nohttpCheckstyleVersion for actual version number
57-
project.getDependencies().add("checkstyle", "io.spring.nohttp:nohttp-checkstyle:" + getNohttpCheckstyleVersion(project));
62+
// NOTE: See gradle.properties#springJavaformatVersion for actual version
63+
// number
64+
project.getDependencies()
65+
.add("checkstyle",
66+
"io.spring.javaformat:spring-javaformat-checkstyle:" + getSpringJavaformatVersion(project));
67+
// NOTE: See gradle.properties#nohttpCheckstyleVersion for actual version
68+
// number
69+
project.getDependencies()
70+
.add("checkstyle", "io.spring.nohttp:nohttp-checkstyle:" + getNohttpCheckstyleVersion(project));
5871

5972
CheckstyleExtension checkstyle = project.getExtensions().getByType(CheckstyleExtension.class);
6073
checkstyle.getConfigDirectory().set(checkstyleDir);
61-
// NOTE: See gradle.properties#checkstyleToolVersion for actual version number
74+
// NOTE: See gradle.properties#checkstyleToolVersion for actual version
75+
// number
6276
checkstyle.setToolVersion(getCheckstyleToolVersion(project));
6377
}
6478

6579
// Configure checkFormat task
6680
project.getTasks().withType(CheckFormat.class, (checkFormat) -> {
67-
// NOTE: See gradle.properties#springJavaformatExcludePackages for excluded packages
81+
// NOTE: See gradle.properties#springJavaformatExcludePackages for
82+
// excluded packages
6883
String[] springJavaformatExcludePackages = getSpringJavaformatExcludePackages(project);
6984
if (springJavaformatExcludePackages != null) {
7085
checkFormat.exclude(springJavaformatExcludePackages);
@@ -76,30 +91,35 @@ public void apply(Project project) {
7691
private static String getSpringJavaformatVersion(Project project) {
7792
String springJavaformatVersion = DEFAULT_SPRING_JAVAFORMAT_VERSION;
7893
if (project.hasProperty(SPRING_JAVAFORMAT_VERSION_PROPERTY)) {
79-
springJavaformatVersion = Objects.requireNonNull(project.findProperty(SPRING_JAVAFORMAT_VERSION_PROPERTY)).toString();
94+
springJavaformatVersion = Objects.requireNonNull(project.findProperty(SPRING_JAVAFORMAT_VERSION_PROPERTY))
95+
.toString();
8096
}
8197
return springJavaformatVersion;
8298
}
8399

84100
private static String getNohttpCheckstyleVersion(Project project) {
85101
String nohttpCheckstyleVersion = DEFAULT_NOHTTP_CHECKSTYLE_VERSION;
86102
if (project.hasProperty(NOHTTP_CHECKSTYLE_VERSION_PROPERTY)) {
87-
nohttpCheckstyleVersion = Objects.requireNonNull(project.findProperty(NOHTTP_CHECKSTYLE_VERSION_PROPERTY)).toString();
103+
nohttpCheckstyleVersion = Objects.requireNonNull(project.findProperty(NOHTTP_CHECKSTYLE_VERSION_PROPERTY))
104+
.toString();
88105
}
89106
return nohttpCheckstyleVersion;
90107
}
91108

92109
private static String getCheckstyleToolVersion(Project project) {
93110
String checkstyleToolVersion = DEFAULT_CHECKSTYLE_TOOL_VERSION;
94111
if (project.hasProperty(CHECKSTYLE_TOOL_VERSION_PROPERTY)) {
95-
checkstyleToolVersion = Objects.requireNonNull(project.findProperty(CHECKSTYLE_TOOL_VERSION_PROPERTY)).toString();
112+
checkstyleToolVersion = Objects.requireNonNull(project.findProperty(CHECKSTYLE_TOOL_VERSION_PROPERTY))
113+
.toString();
96114
}
97115
return checkstyleToolVersion;
98116
}
99117

100118
@Nullable
101119
private String[] getSpringJavaformatExcludePackages(Project project) {
102-
String springJavaformatExcludePackages = (String) project.findProperty(SPRING_JAVAFORMAT_EXCLUDE_PACKAGES_PROPERTY);
120+
String springJavaformatExcludePackages = (String) project
121+
.findProperty(SPRING_JAVAFORMAT_EXCLUDE_PACKAGES_PROPERTY);
103122
return (springJavaformatExcludePackages != null) ? springJavaformatExcludePackages.split(" ") : null;
104123
}
124+
105125
}

‎project-plugin/src/main/java/org/springframework/gradle/classpath/CheckClasspathForProhibitedDependencies.java

+8-4
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,15 @@ public FileCollection getClasspath() {
5555
@TaskAction
5656
public void checkForProhibitedDependencies() throws IOException {
5757
ResolvedConfiguration resolvedConfiguration = this.classpath.getResolvedConfiguration();
58-
TreeSet<String> prohibited = resolvedConfiguration.getResolvedArtifacts().stream()
59-
.map((artifact) -> artifact.getModuleVersion().getId()).filter(this::prohibited)
60-
.map((id) -> id.getGroup() + ":" + id.getName()).collect(Collectors.toCollection(TreeSet::new));
58+
TreeSet<String> prohibited = resolvedConfiguration.getResolvedArtifacts()
59+
.stream()
60+
.map((artifact) -> artifact.getModuleVersion().getId())
61+
.filter(this::prohibited)
62+
.map((id) -> id.getGroup() + ":" + id.getName())
63+
.collect(Collectors.toCollection(TreeSet::new));
6164
if (!prohibited.isEmpty()) {
62-
StringBuilder message = new StringBuilder(String.format("Found prohibited dependencies in '%s':%n", this.classpath.getName()));
65+
StringBuilder message = new StringBuilder(
66+
String.format("Found prohibited dependencies in '%s':%n", this.classpath.getName()));
6367
for (String dependency : prohibited) {
6468
message.append(String.format(" %s%n", dependency));
6569
}

‎project-plugin/src/main/java/org/springframework/gradle/classpath/SpringCheckClasspathForProhibitedDependenciesPlugin.java

+12-9
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ public class SpringCheckClasspathForProhibitedDependenciesPlugin implements Plug
3434
@Override
3535
public void apply(Project project) {
3636
project.getPlugins().apply(SpringCheckProhibitedDependenciesLifecyclePlugin.class);
37-
project.getPlugins().withType(JavaBasePlugin.class, (javaBasePlugin) ->
38-
configureProhibitedDependencyChecks(project));
37+
project.getPlugins()
38+
.withType(JavaBasePlugin.class, (javaBasePlugin) -> configureProhibitedDependencyChecks(project));
3939
}
4040

4141
private void configureProhibitedDependencyChecks(Project project) {
@@ -54,16 +54,19 @@ private void createProhibitedDependenciesChecks(Project project, String... confi
5454

5555
private void createProhibitedDependenciesCheck(Configuration classpath, Project project) {
5656
String taskName = "check" + capitalize(classpath.getName() + "ForProhibitedDependencies");
57-
TaskProvider<CheckClasspathForProhibitedDependencies> checkClasspathTask = project.getTasks().register(taskName,
58-
CheckClasspathForProhibitedDependencies.class, (checkClasspath) -> {
59-
checkClasspath.setGroup(LifecycleBasePlugin.CHECK_TASK_NAME);
60-
checkClasspath.setDescription("Checks " + classpath.getName() + " for prohibited dependencies");
61-
checkClasspath.setClasspath(classpath);
62-
});
63-
project.getTasks().named(SpringCheckProhibitedDependenciesLifecyclePlugin.CHECK_PROHIBITED_DEPENDENCIES_TASK_NAME, (checkProhibitedTask) -> checkProhibitedTask.dependsOn(checkClasspathTask));
57+
TaskProvider<CheckClasspathForProhibitedDependencies> checkClasspathTask = project.getTasks()
58+
.register(taskName, CheckClasspathForProhibitedDependencies.class, (checkClasspath) -> {
59+
checkClasspath.setGroup(LifecycleBasePlugin.CHECK_TASK_NAME);
60+
checkClasspath.setDescription("Checks " + classpath.getName() + " for prohibited dependencies");
61+
checkClasspath.setClasspath(classpath);
62+
});
63+
project.getTasks()
64+
.named(SpringCheckProhibitedDependenciesLifecyclePlugin.CHECK_PROHIBITED_DEPENDENCIES_TASK_NAME,
65+
(checkProhibitedTask) -> checkProhibitedTask.dependsOn(checkClasspathTask));
6466
}
6567

6668
private static String capitalize(String s) {
6769
return s.substring(0, 1).toUpperCase() + s.substring(1);
6870
}
71+
6972
}

‎project-plugin/src/main/java/org/springframework/gradle/classpath/SpringCheckProhibitedDependenciesLifecyclePlugin.java

+9-4
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,21 @@
2626
* @author Rob Winch
2727
*/
2828
public class SpringCheckProhibitedDependenciesLifecyclePlugin implements Plugin<Project> {
29+
2930
public static final String CHECK_PROHIBITED_DEPENDENCIES_TASK_NAME = "checkForProhibitedDependencies";
3031

3132
@Override
3233
public void apply(Project project) {
33-
TaskProvider<Task> checkProhibitedDependencies = project.getTasks().register(SpringCheckProhibitedDependenciesLifecyclePlugin.CHECK_PROHIBITED_DEPENDENCIES_TASK_NAME, (task) -> {
34-
task.setGroup(JavaBasePlugin.VERIFICATION_GROUP);
35-
task.setDescription("Checks both the compile/runtime classpath of every SourceSet for prohibited dependencies");
36-
});
34+
TaskProvider<Task> checkProhibitedDependencies = project.getTasks()
35+
.register(SpringCheckProhibitedDependenciesLifecyclePlugin.CHECK_PROHIBITED_DEPENDENCIES_TASK_NAME,
36+
(task) -> {
37+
task.setGroup(JavaBasePlugin.VERIFICATION_GROUP);
38+
task.setDescription(
39+
"Checks both the compile/runtime classpath of every SourceSet for prohibited dependencies");
40+
});
3741
project.getTasks().named(JavaBasePlugin.CHECK_TASK_NAME, (checkTask) -> {
3842
checkTask.dependsOn(checkProhibitedDependencies);
3943
});
4044
}
45+
4146
}

‎project-plugin/src/main/java/org/springframework/gradle/docs/SpringJavadocOptionsPlugin.java

+2
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,13 @@
2525
* @author Steve Riesenberg
2626
*/
2727
public class SpringJavadocOptionsPlugin implements Plugin<Project> {
28+
2829
@Override
2930
public void apply(Project project) {
3031
project.getTasks().withType(Javadoc.class, (javadoc) -> {
3132
StandardJavadocDocletOptions options = (StandardJavadocDocletOptions) javadoc.getOptions();
3233
options.addStringOption("Xdoclint:none", "-quiet");
3334
});
3435
}
36+
3537
}

‎project-plugin/src/main/java/org/springframework/gradle/jacoco/SpringJacocoPlugin.java

+3
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@
3131
* @author Steve Riesenberg
3232
*/
3333
public class SpringJacocoPlugin implements Plugin<Project> {
34+
3435
private static final String JACOCO_TOOL_VERSION_PROPERTY = "jacocoToolVersion";
36+
3537
private static final String DEFAULT_JACOCO_TOOL_VERSION = "0.8.7";
3638

3739
@Override
@@ -53,4 +55,5 @@ private static String getJacocoToolVersion(Project project) {
5355
}
5456
return jacocoToolVersion;
5557
}
58+
5659
}

‎project-plugin/src/main/java/org/springframework/gradle/management/SpringManagementConfigurationPlugin.java

+9-6
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,15 @@
2828
import org.gradle.api.publish.maven.plugins.MavenPublishPlugin;
2929

3030
/**
31-
* Creates a Management configuration that is appropriate for adding a platform to that is not exposed externally. If
32-
* the JavaPlugin is applied, the compileClasspath, runtimeClasspath, testCompileClasspath, and testRuntimeClasspath
33-
* will extend from it.
31+
* Creates a Management configuration that is appropriate for adding a platform to that is
32+
* not exposed externally. If the JavaPlugin is applied, the compileClasspath,
33+
* runtimeClasspath, testCompileClasspath, and testRuntimeClasspath will extend from it.
34+
*
3435
* @author Rob Winch
3536
* @author Steve Riesenberg
3637
*/
3738
public class SpringManagementConfigurationPlugin implements Plugin<Project> {
39+
3840
public static final String MANAGEMENT_CONFIGURATION_NAME = "management";
3941

4042
@Override
@@ -58,10 +60,11 @@ public void apply(Project project) {
5860
});
5961
plugins.withType(MavenPublishPlugin.class, (mavenPublish) -> {
6062
PublishingExtension publishing = project.getExtensions().getByType(PublishingExtension.class);
61-
publishing.getPublications().withType(MavenPublication.class, (mavenPublication) ->
62-
mavenPublication.versionMapping((versions) ->
63-
versions.allVariants(VariantVersionMappingStrategy::fromResolutionResult)));
63+
publishing.getPublications()
64+
.withType(MavenPublication.class, (mavenPublication) -> mavenPublication.versionMapping(
65+
(versions) -> versions.allVariants(VariantVersionMappingStrategy::fromResolutionResult)));
6466
});
6567
});
6668
}
69+
6770
}

‎project-plugin/src/main/java/org/springframework/gradle/nohttp/SpringNoHttpPlugin.java

+2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
* @author Steve Riesenberg
2828
*/
2929
public class SpringNoHttpPlugin implements Plugin<Project> {
30+
3031
@Override
3132
public void apply(Project project) {
3233
// Apply nohttp plugin
@@ -38,4 +39,5 @@ public void apply(Project project) {
3839
nohttp.setAllowlistFile(allowlistFile);
3940
nohttp.getSource().exclude("**/build/**");
4041
}
42+
4143
}

‎project-plugin/src/main/java/org/springframework/gradle/propdeps/SpringPropDepsEclipsePlugin.java

+2
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
* @author Steve Riesenberg
3232
*/
3333
public class SpringPropDepsEclipsePlugin implements Plugin<Project> {
34+
3435
@Override
3536
public void apply(Project project) {
3637
PluginManager pluginManager = project.getPluginManager();
@@ -44,4 +45,5 @@ public void apply(Project project) {
4445
classpath.getPlusConfigurations().add(project.getConfigurations().getByName("optional"));
4546
});
4647
}
48+
4749
}

‎project-plugin/src/main/java/org/springframework/gradle/propdeps/SpringPropDepsIdeaPlugin.java

+2
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
* @link https://youtrack.jetbrains.com/issue/IDEA-117668
3434
*/
3535
public class SpringPropDepsIdeaPlugin implements Plugin<Project> {
36+
3637
@Override
3738
public void apply(Project project) {
3839
PluginManager pluginManager = project.getPluginManager();
@@ -47,4 +48,5 @@ public void apply(Project project) {
4748
idea.getScopes().get("PROVIDED").get("plus").add(project.getConfigurations().getByName("optional"));
4849
});
4950
}
51+
5052
}

0 commit comments

Comments
 (0)