-
Notifications
You must be signed in to change notification settings - Fork 459
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Toggle formatting inline with spotless:off and spotless:on (#691)
- Loading branch information
Showing
17 changed files
with
525 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
157 changes: 157 additions & 0 deletions
157
lib/src/main/java/com/diffplug/spotless/generic/PipeStepPair.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| /* | ||
| * Copyright 2020 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.generic; | ||
|
|
||
| import java.io.Serializable; | ||
| import java.util.ArrayList; | ||
| import java.util.Objects; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import com.diffplug.spotless.FormatterStep; | ||
|
|
||
| import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; | ||
|
|
||
| public class PipeStepPair { | ||
| /** The two steps will be named `<name>In` and `<name>Out`. */ | ||
| public static Builder named(String name) { | ||
| return new Builder(name); | ||
| } | ||
|
|
||
| public static String defaultToggleName() { | ||
| return "toggle"; | ||
| } | ||
|
|
||
| public static String defaultToggleOff() { | ||
| return "spotless:off"; | ||
| } | ||
|
|
||
| public static String defaultToggleOn() { | ||
| return "spotless:on"; | ||
| } | ||
|
|
||
| public static class Builder { | ||
| String name; | ||
| Pattern regex; | ||
|
|
||
| private Builder(String name) { | ||
| this.name = Objects.requireNonNull(name); | ||
| } | ||
|
|
||
| /** Defines the opening and closing markers. */ | ||
| public Builder openClose(String open, String close) { | ||
| return regex(Pattern.quote(open) + "([\\s\\S]*?)" + Pattern.quote(close)); | ||
| } | ||
|
|
||
| /** Defines the pipe via regex. Must have *exactly one* capturing group. */ | ||
| public Builder regex(String regex) { | ||
| return regex(Pattern.compile(regex)); | ||
| } | ||
|
|
||
| /** Defines the pipe via regex. Must have *exactly one* capturing group. */ | ||
| public Builder regex(Pattern regex) { | ||
| this.regex = regex; | ||
| return this; | ||
| } | ||
|
|
||
| public PipeStepPair buildPair() { | ||
| return new PipeStepPair(name, regex); | ||
| } | ||
| } | ||
|
|
||
| final FormatterStep in, out; | ||
|
|
||
| private PipeStepPair(String name, Pattern pattern) { | ||
| StateIn stateIn = new StateIn(pattern); | ||
| StateOut stateOut = new StateOut(stateIn); | ||
| in = FormatterStep.create(name + "In", stateIn, state -> state::format); | ||
| out = FormatterStep.create(name + "Out", stateOut, state -> state::format); | ||
| } | ||
|
|
||
| public FormatterStep in() { | ||
| return in; | ||
| } | ||
|
|
||
| public FormatterStep out() { | ||
| return out; | ||
| } | ||
|
|
||
| @SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED") | ||
| static class StateIn implements Serializable { | ||
| private static final long serialVersionUID = -844178006407733370L; | ||
|
|
||
| final Pattern regex; | ||
|
|
||
| public StateIn(Pattern regex) { | ||
| this.regex = regex; | ||
| } | ||
|
|
||
| final transient ArrayList<String> groups = new ArrayList<>(); | ||
|
|
||
| private String format(String unix) { | ||
| groups.clear(); | ||
| Matcher matcher = regex.matcher(unix); | ||
| while (matcher.find()) { | ||
| groups.add(matcher.group(1)); | ||
| } | ||
| return unix; | ||
| } | ||
| } | ||
|
|
||
| @SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED") | ||
| static class StateOut implements Serializable { | ||
| private static final long serialVersionUID = -1195263184715054229L; | ||
|
|
||
| final StateIn in; | ||
|
|
||
| StateOut(StateIn in) { | ||
| this.in = in; | ||
| } | ||
|
|
||
| final transient StringBuilder builder = new StringBuilder(); | ||
|
|
||
| private String format(String unix) { | ||
| if (in.groups.isEmpty()) { | ||
| return unix; | ||
| } | ||
| builder.setLength(0); | ||
| Matcher matcher = in.regex.matcher(unix); | ||
| int lastEnd = 0; | ||
| int groupIdx = 0; | ||
| while (matcher.find()) { | ||
| builder.append(unix, lastEnd, matcher.start(1)); | ||
| builder.append(in.groups.get(groupIdx)); | ||
| lastEnd = matcher.end(1); | ||
| ++groupIdx; | ||
| } | ||
| if (groupIdx == in.groups.size()) { | ||
| builder.append(unix, lastEnd, unix.length()); | ||
| return builder.toString(); | ||
| } else { | ||
| // throw an error with either the full regex, or the nicer open/close pair | ||
| Matcher openClose = Pattern.compile("\\\\Q([\\s\\S]*?)\\\\E" + "\\Q([\\s\\S]*?)\\E" + "\\\\Q([\\s\\S]*?)\\\\E") | ||
| .matcher(in.regex.pattern()); | ||
| String pattern; | ||
| if (openClose.matches()) { | ||
| pattern = openClose.group(1) + " " + openClose.group(2); | ||
| } else { | ||
| pattern = in.regex.pattern(); | ||
| } | ||
| throw new Error("An intermediate step removed a match of " + pattern); | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
48 changes: 48 additions & 0 deletions
48
plugin-gradle/src/test/java/com/diffplug/gradle/spotless/ToggleOffOnTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /* | ||
| * Copyright 2020 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.gradle.spotless; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| import org.junit.Test; | ||
|
|
||
| public class ToggleOffOnTest extends GradleIntegrationHarness { | ||
| @Test | ||
| public void toggleOffOn() throws IOException { | ||
| setFile("build.gradle").toLines( | ||
| "plugins { id 'com.diffplug.spotless' }", | ||
| "spotless {", | ||
| " format 'toLower', {", | ||
| " target '**/*.md'", | ||
| " custom 'lowercase', { str -> str.toLowerCase() }", | ||
| " toggleOffOn()", | ||
| " }", | ||
| "}"); | ||
| setFile("test.md").toLines( | ||
| "A B C", | ||
| "spotless:off", | ||
| "D E F", | ||
| "spotless:on", | ||
| "G H I"); | ||
| gradleRunner().withArguments("spotlessApply").build(); | ||
| assertFile("test.md").hasLines( | ||
| "a b c", | ||
| "spotless:off", | ||
| "D E F", | ||
| "spotless:on", | ||
| "g h i"); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.