add support for missing generic steps (closes #207) (#209)

* add support for missing generic steps (closes #207)

add format section for custom formats

* reformated code

* fixed review findings

* use assertFile instead of assertThat.isEqualTo for all tests

* fixed review findings

* fixed code duplication

* updated changelog

Author: matthiasbalke

CHANGES.md

@@ -7,6 +7,8 @@ You might be looking for:
 
 ### Version 1.11.0-SNAPSHOT - TBD (javadoc [lib](https://diffplug.github.io/spotless/javadoc/spotless-lib/snapshot/) [lib-extra](https://diffplug.github.io/spotless/javadoc/spotless-lib-extra/snapshot/), [snapshot repo](https://oss.sonatype.org/content/repositories/snapshots/com/diffplug/spotless/))
 
+* Added generic format support for maven-plugin ([#209](https://github.com/diffplug/spotless/pull/209))
+
 ### Version 1.10.0 - February 15th 2018 (javadoc [lib](https://diffplug.github.io/spotless/javadoc/spotless-lib/1.10.0/) [lib-extra](https://diffplug.github.io/spotless/javadoc/spotless-lib-extra/1.10.0/), artifact [lib]([jcenter](https://bintray.com/diffplug/opensource/spotless-lib), [lib-extra]([jcenter](https://bintray.com/diffplug/opensource/spotless-lib-extra)))
 
 * LicenseHeaderStep now supports customizing the year range separator in copyright notices. ([#199](https://github.com/diffplug/spotless/pull/199))

README.md

@@ -32,12 +32,12 @@ function extra(className) { return '| [`' + className + '`](lib-extra/src/main/j
 output = [
 '| Feature / FormatterStep                       | [plugin-gradle](plugin-gradle/README.md) | [plugin-maven](plugin-maven/README.md) | [(Your build tool here)](CONTRIBUTING.md#how-to-add-a-new-plugin-for-a-build-system) |',
 '| --------------------------------------------- | ------------- | ------------ | --------|',
-lib('generic.EndWithNewlineStep')                +'{{yes}}       | {{no}}       | {{no}}  |',
-lib('generic.IndentStep')                        +'{{yes}}       | {{no}}       | {{no}}  |',
+lib('generic.EndWithNewlineStep')                +'{{yes}}       | {{yes}}       | {{no}}  |',
+lib('generic.IndentStep')                        +'{{yes}}       | {{yes}}       | {{no}}  |',
 lib('generic.LicenseHeaderStep')                 +'{{yes}}       | {{yes}}      | {{no}}  |',
-lib('generic.ReplaceRegexStep')                  +'{{yes}}       | {{no}}       | {{no}}  |',
-lib('generic.ReplaceStep')                       +'{{yes}}       | {{no}}       | {{no}}  |',
-lib('generic.TrimTrailingWhitespaceStep')        +'{{yes}}       | {{no}}       | {{no}}  |',
+lib('generic.ReplaceRegexStep')                  +'{{yes}}       | {{yes}}       | {{no}}  |',
+lib('generic.ReplaceStep')                       +'{{yes}}       | {{yes}}       | {{no}}  |',
+lib('generic.TrimTrailingWhitespaceStep')        +'{{yes}}       | {{yes}}       | {{no}}  |',
 extra('groovy.GrEclipseFormatterStep')           +'{{yes}}       | {{no}}       | {{no}}  |',
 lib('java.GoogleJavaFormatStep')                 +'{{yes}}       | {{yes}}      | {{no}}  |',
 lib('java.ImportOrderStep')                      +'{{yes}}       | {{yes}}      | {{no}}  |',
@@ -55,12 +55,12 @@ lib('sql.DBeaverSQLFormatterStep')               +'{{yes}}       | {{no}}
 -->
 | Feature / FormatterStep                       | [plugin-gradle](plugin-gradle/README.md) | [plugin-maven](plugin-maven/README.md) | [(Your build tool here)](CONTRIBUTING.md#how-to-add-a-new-plugin-for-a-build-system) |
 | --------------------------------------------- | ------------- | ------------ | --------|
-| [`generic.EndWithNewlineStep`](lib/src/main/java/com/diffplug/spotless/generic/EndWithNewlineStep.java) | :+1:       | :white_large_square:       | :white_large_square:  |
-| [`generic.IndentStep`](lib/src/main/java/com/diffplug/spotless/generic/IndentStep.java) | :+1:       | :white_large_square:       | :white_large_square:  |
+| [`generic.EndWithNewlineStep`](lib/src/main/java/com/diffplug/spotless/generic/EndWithNewlineStep.java) | :+1:       | :+1:       | :white_large_square:  |
+| [`generic.IndentStep`](lib/src/main/java/com/diffplug/spotless/generic/IndentStep.java) | :+1:       | :+1:       | :white_large_square:  |
 | [`generic.LicenseHeaderStep`](lib/src/main/java/com/diffplug/spotless/generic/LicenseHeaderStep.java) | :+1:       | :+1:      | :white_large_square:  |
-| [`generic.ReplaceRegexStep`](lib/src/main/java/com/diffplug/spotless/generic/ReplaceRegexStep.java) | :+1:       | :white_large_square:       | :white_large_square:  |
-| [`generic.ReplaceStep`](lib/src/main/java/com/diffplug/spotless/generic/ReplaceStep.java) | :+1:       | :white_large_square:       | :white_large_square:  |
-| [`generic.TrimTrailingWhitespaceStep`](lib/src/main/java/com/diffplug/spotless/generic/TrimTrailingWhitespaceStep.java) | :+1:       | :white_large_square:       | :white_large_square:  |
+| [`generic.ReplaceRegexStep`](lib/src/main/java/com/diffplug/spotless/generic/ReplaceRegexStep.java) | :+1:       | :+1:       | :white_large_square:  |
+| [`generic.ReplaceStep`](lib/src/main/java/com/diffplug/spotless/generic/ReplaceStep.java) | :+1:       | :+1:       | :white_large_square:  |
+| [`generic.TrimTrailingWhitespaceStep`](lib/src/main/java/com/diffplug/spotless/generic/TrimTrailingWhitespaceStep.java) | :+1:       | :+1:       | :white_large_square:  |
 | [`groovy.GrEclipseFormatterStep`](lib-extra/src/main/java/com/diffplug/spotless/extra/groovy/GrEclipseFormatterStep.java) | :+1:       | :white_large_square:       | :white_large_square:  |
 | [`java.GoogleJavaFormatStep`](lib/src/main/java/com/diffplug/spotless/java/GoogleJavaFormatStep.java) | :+1:       | :+1:      | :white_large_square:  |
 | [`java.ImportOrderStep`](lib/src/main/java/com/diffplug/spotless/java/ImportOrderStep.java) | :+1:       | :+1:      | :white_large_square:  |

lib/src/main/java/com/diffplug/spotless/generic/IndentStep.java

@@ -23,6 +23,9 @@
 
 /** Simple step which checks for consistent indentation characters. */
 public final class IndentStep {
+
+	private static final int DEFAULT_NUM_SPACES_PER_TAB = 4;
+
 	// prevent direct instantiation
 	private IndentStep() {}
 
@@ -33,6 +36,11 @@ private <T> T tabSpace(T tab, T space) {
 			return this == TAB ? tab : space;
 		}
 
+		/** Creates a step which will indent with the given type of whitespace, converting between tabs and spaces at the default ratio. */
+		public FormatterStep create() {
+			return IndentStep.create(this, defaultNumSpacesPerTab());
+		}
+
 		/** Synonym for {@link IndentStep#create(Type, int)}. */
 		public FormatterStep create(int numSpacesPerTab) {
 			return IndentStep.create(this, numSpacesPerTab);
@@ -128,4 +136,8 @@ String format(String raw) {
 	private static boolean isSpaceOrTab(char c) {
 		return c == ' ' || c == '\t';
 	}
+
+	public static int defaultNumSpacesPerTab() {
+		return DEFAULT_NUM_SPACES_PER_TAB;
+	}
 }

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/FormatExtension.java

@@ -332,7 +332,7 @@ public void indentWithSpaces(int numSpacesPerTab) {
 
 	/** Ensures that the files are indented using spaces. */
 	public void indentWithSpaces() {
-		indentWithSpaces(4);
+		addStep(IndentStep.Type.SPACE.create());
 	}
 
 	/** Ensures that the files are indented using tabs. */
@@ -342,7 +342,7 @@ public void indentWithTabs(int tabToSpaces) {
 
 	/** Ensures that the files are indented using tabs. */
 	public void indentWithTabs() {
-		indentWithTabs(4);
+		addStep(IndentStep.Type.TAB.create());
 	}
 
 	abstract class LicenseHeaderConfig {

plugin-maven/README.md

@@ -115,6 +115,60 @@ By default, all files matching `src/main/java/**/*.java` and `src/test/java/**/*
 </configuration>
 ```
 
+<a name="format"></a>
+
+## Applying to custom sources
+
+By default, no Ant-Style include patterns are defined.  Each element under `<format>` is a step, and they will be applied in the order specified.  Every step is optional, and they will be applied in the order specified.
+
+```xml
+<configuration>
+  <format>
+    <includes>
+      <!-- include all property files in "resource" folders under "src" -->
+      <include>src/**/resources/**/*.properties</include>
+    </includes>
+
+    <licenseHeader>
+      <!-- Specify either content or file, but not both -->
+      <content>/* Licensed under Apache-2.0 */</content>
+      <file>${basedir}/license-header</file>
+      <!-- conent until first occurrence of the delimiter regex will be interpreted as header section -->
+      <delimiter>#</delimiter>
+    </licenseHeader>
+
+    <!-- Files must end with a newline -->
+    <endWithNewline />
+
+    <!-- Specify whether to use tabs or spaces for indentation -->
+    <indent>
+      <!-- Specify either spaces or tabs -->
+      <spaces>true</spaces>
+      <tabs>true</tabs>
+      <!-- Specify how many spaces are used to convert one tab and vice versa. Defaults to 4 -->
+      <spacesPerTab>4</spacesPerTab>
+    </indent>
+
+    <!-- Trim trailing whitespaces -->
+    <trimTrailingWhitespace />
+
+    <!-- Specify replacements using search and replace -->
+    <replace>
+      <name>Say Hello to Mars</name>
+      <search>World</search>
+      <replacement>Mars</replacement>
+    </replace>
+
+    <!-- Specify replacements using regex match and replace -->
+    <replaceRegex>
+      <name>Say Hello to Mars from Regex</name>
+      <searchRegex>(Hello) W[a-z]{3}d</searchRegex>
+      <replacement>$1 Mars</replacement>
+    </replaceRegex>
+  </format>
+</configuration>
+```
+
 <a name="invisible"></a>
 
 ## Line endings and encodings (invisible stuff)

plugin-maven/src/main/java/com/diffplug/spotless/maven/AbstractSpotlessMojo.java

@@ -27,7 +27,6 @@
 
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
-import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugins.annotations.Component;
 import org.apache.maven.plugins.annotations.Parameter;
 import org.codehaus.plexus.util.FileUtils;
@@ -38,6 +37,7 @@
 import com.diffplug.spotless.Formatter;
 import com.diffplug.spotless.LineEnding;
 import com.diffplug.spotless.Provisioner;
+import com.diffplug.spotless.maven.generic.Format;
 import com.diffplug.spotless.maven.generic.LicenseHeader;
 import com.diffplug.spotless.maven.java.Java;
 import com.diffplug.spotless.maven.scala.Scala;
@@ -71,6 +71,9 @@ public abstract class AbstractSpotlessMojo extends AbstractMojo {
 	@Parameter
 	private LicenseHeader licenseHeader;
 
+	@Parameter
+	private Format format;
+
 	@Parameter
 	private Java java;
 
@@ -80,7 +83,7 @@ public abstract class AbstractSpotlessMojo extends AbstractMojo {
 	protected abstract void process(List<File> files, Formatter formatter) throws MojoExecutionException;
 
 	@Override
-	public final void execute() throws MojoExecutionException, MojoFailureException {
+	public final void execute() throws MojoExecutionException {
 		List<FormatterFactory> formatterFactories = getFormatterFactories();
 
 		for (FormatterFactory formatterFactory : formatterFactories) {
@@ -127,7 +130,7 @@ private FormatterConfig getFormatterConfig() {
 	}
 
 	private List<FormatterFactory> getFormatterFactories() {
-		return Stream.of(java, scala)
+		return Stream.of(format, java, scala)
 				.filter(Objects::nonNull)
 				.collect(toList());
 	}

plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/EndWithNewline.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2016 DiffPlug
+ *
+ * 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 com.diffplug.spotless.maven.generic;
+
+import com.diffplug.spotless.FormatterStep;
+import com.diffplug.spotless.generic.EndWithNewlineStep;
+import com.diffplug.spotless.maven.FormatterStepConfig;
+import com.diffplug.spotless.maven.FormatterStepFactory;
+
+public class EndWithNewline implements FormatterStepFactory {
+
+	@Override
+	public FormatterStep newFormatterStep(FormatterStepConfig config) {
+		return EndWithNewlineStep.create();
+	}
+}

plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/Format.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2016 DiffPlug
+ *
+ * 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 com.diffplug.spotless.maven.generic;
+
+import java.util.Collections;
+import java.util.Set;
+
+import com.diffplug.spotless.maven.FormatterFactory;
+
+public class Format extends FormatterFactory {
+
+	@Override
+	public Set<String> defaultIncludes() {
+		return Collections.emptySet();
+	}
+
+	@Override
+	public String licenseHeaderDelimiter() {
+		// do not specify a default delimiter
+		return null;
+	}
+
+	public void addEndWithNewline(EndWithNewline endWithNewline) {
+		addStepFactory(endWithNewline);
+	}
+
+	public void addIndent(Indent indent) {
+		addStepFactory(indent);
+	}
+
+	public void addTrimTrailingWhitespace(TrimTrailingWhitespace trimTrailingWhitespace) {
+		addStepFactory(trimTrailingWhitespace);
+	}
+
+	public void addReplace(Replace replace) {
+		addStepFactory(replace);
+	}
+
+	public void addReplaceRegex(ReplaceRegex replaceRegex) {
+		addStepFactory(replaceRegex);
+	}
+}

plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/Indent.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2016 DiffPlug
+ *
+ * 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 com.diffplug.spotless.maven.generic;
+
+import org.apache.maven.plugins.annotations.Parameter;
+
+import com.diffplug.spotless.FormatterStep;
+import com.diffplug.spotless.generic.IndentStep;
+import com.diffplug.spotless.maven.FormatterStepConfig;
+import com.diffplug.spotless.maven.FormatterStepFactory;
+
+public class Indent implements FormatterStepFactory {
+
+	@Parameter
+	private boolean tabs;
+
+	@Parameter
+	private boolean spaces;
+
+	@Parameter
+	private Integer spacesPerTab;
+
+	@Override
+	public FormatterStep newFormatterStep(FormatterStepConfig config) {
+
+		if (spacesPerTab == null) {
+			spacesPerTab = IndentStep.defaultNumSpacesPerTab();
+		}
+
+		if (spaces ^ tabs) {
+			if (spaces) {
+				return IndentStep.create(IndentStep.Type.SPACE, spacesPerTab);
+			} else {
+				return IndentStep.create(IndentStep.Type.TAB, spacesPerTab);
+			}
+		} else {
+			throw new IllegalArgumentException("Must specify exactly one of 'spaces' or 'tabs'.");
+		}
+	}
+}

plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/Replace.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2016 DiffPlug
+ *
+ * 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 com.diffplug.spotless.maven.generic;
+
+import org.apache.maven.plugins.annotations.Parameter;
+
+import com.diffplug.spotless.FormatterStep;
+import com.diffplug.spotless.generic.ReplaceStep;
+import com.diffplug.spotless.maven.FormatterStepConfig;
+import com.diffplug.spotless.maven.FormatterStepFactory;
+
+public class Replace implements FormatterStepFactory {
+
+	@Parameter
+	private String name;
+
+	@Parameter
+	private String search;
+
+	@Parameter
+	private String replacement;
+
+	@Override
+	public FormatterStep newFormatterStep(FormatterStepConfig config) {
+		if (name == null || search == null || replacement == null) {
+			throw new IllegalArgumentException("Must specify 'name', 'search' and 'replacement'.");
+		}
+
+		return ReplaceStep.create(name, search, replacement);
+	}
+}