Skip to content

Commit a060ee4

Browse files
nedtwiggnedtwigg
committed
Added FreshMark to lib, along with infrastructure necessary to test steps entirely within lib.
1 parent 2dc2232 commit a060ee4

File tree

7 files changed

+312
-0
lines changed

7 files changed

+312
-0
lines changed

‎lib/src/main/java/com/diffplug/spotless/markdown/FreshMarkStep.java

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
/*
2+
* Copyright 2016 DiffPlug
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package com.diffplug.spotless.markdown;
17+
18+
import java.io.Serializable;
19+
import java.lang.reflect.Method;
20+
import java.net.URLClassLoader;
21+
import java.util.Map;
22+
import java.util.Objects;
23+
import java.util.function.Consumer;
24+
import java.util.logging.Logger;
25+
26+
import com.diffplug.spotless.FormatterFunc;
27+
import com.diffplug.spotless.FormatterStep;
28+
import com.diffplug.spotless.JarState;
29+
import com.diffplug.spotless.Provisioner;
30+
import com.diffplug.spotless.ThrowingEx.Supplier;
31+
32+
/** A step for [FreshMark](https://github.com/diffplug/freshmark). */
33+
public class FreshMarkStep {
34+
public static final String defaultVersion() {
35+
return DEFAULT_VERSION;
36+
}
37+
38+
private static final String DEFAULT_VERSION = "1.3.1";
39+
private static final String NAME = "freshmark";
40+
private static final String MAVEN_COORDINATE = "com.diffplug.freshmark:freshmark:";
41+
private static final String FORMATTER_CLASS = "com.diffplug.freshmark.FreshMark";
42+
private static final String FORMATTER_METHOD = "compile";
43+
44+
/** Creates a formatter step for the given version and settings file. */
45+
public static FormatterStep create(Supplier<Map<String, ?>> properties, Provisioner provisioner) {
46+
return create(defaultVersion(), properties, provisioner);
47+
}
48+
49+
/** Creates a formatter step for the given version and settings file. */
50+
public static FormatterStep create(String version, Supplier<Map<String, ?>> properties, Provisioner provisioner) {
51+
return FormatterStep.createCloseableLazy(NAME,
52+
() -> new State(new JarState(MAVEN_COORDINATE + version, provisioner), properties.get()),
53+
State::createFormat);
54+
}
55+
56+
private static class State implements Serializable {
57+
private static final long serialVersionUID = 1L;
58+
59+
/** The jar that contains the eclipse formatter. */
60+
final JarState jarState;
61+
final Map<String, ?> properties;
62+
63+
State(JarState jarState, Map<String, ?> properties) {
64+
this.jarState = Objects.requireNonNull(jarState);
65+
this.properties = Objects.requireNonNull(properties);
66+
}
67+
68+
FormatterFunc.Closeable createFormat() throws Exception {
69+
Logger logger = Logger.getLogger(FreshMarkStep.class.getName());
70+
Consumer<String> loggingStream = logger::warning;
71+
72+
URLClassLoader classLoader = jarState.openIsolatedClassLoader();
73+
74+
// instantiate the formatter and get its format method
75+
Class<?> formatterClazz = classLoader.loadClass(FORMATTER_CLASS);
76+
Object formatter = formatterClazz.getConstructor(Map.class, Consumer.class).newInstance(properties, loggingStream);
77+
Method method = formatterClazz.getMethod(FORMATTER_METHOD, String.class);
78+
return FormatterFunc.Closeable.of(classLoader, input -> (String) method.invoke(formatter, input));
79+
}
80+
}
81+
}

‎testlib/build.gradle

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ dependencies {
55
compile project(':lib')
66
compile "com.diffplug.durian:durian-core:${VER_DURIAN}"
77
compile "com.diffplug.durian:durian-io:${VER_DURIAN}"
8+
compile "com.diffplug.durian:durian-testlib:${VER_DURIAN}"
89
compile "junit:junit:${VER_JUNIT}"
910
compile "org.assertj:assertj-core:${VER_ASSERTJ}"
1011
compile gradleTestKit()

‎testlib/src/main/java/com/diffplug/spotless/StepEqualityTester.java

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/*
2+
* Copyright 2016 DiffPlug
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package com.diffplug.spotless;
17+
18+
import java.util.ArrayList;
19+
import java.util.List;
20+
21+
import com.diffplug.common.base.Box;
22+
import com.diffplug.common.testing.EqualsTester;
23+
24+
public abstract class StepEqualityTester {
25+
protected abstract FormatterStep create();
26+
27+
protected abstract void setupTest(API api);
28+
29+
public interface API {
30+
void assertThis();
31+
32+
void assertThisEqualToThis();
33+
34+
void areDifferentThan();
35+
}
36+
37+
public void testEquals() {
38+
List<List<Object>> allGroups = new ArrayList<>();
39+
Box<List<Object>> currentGroup = Box.of(new ArrayList<>());
40+
API api = new API() {
41+
@Override
42+
public void assertThis() {
43+
currentGroup.get().add(create());
44+
}
45+
46+
@Override
47+
public void assertThisEqualToThis() {
48+
assertThis();
49+
assertThis();
50+
}
51+
52+
@Override
53+
public void areDifferentThan() {
54+
allGroups.add(currentGroup.get());
55+
currentGroup.set(new ArrayList<>());
56+
}
57+
};
58+
setupTest(api);
59+
List<Object> lastGroup = currentGroup.get();
60+
if (!lastGroup.isEmpty()) {
61+
throw new IllegalArgumentException("Looks like you forgot to make a final call to 'areDifferentThan()'.");
62+
}
63+
EqualsTester tester = new EqualsTester();
64+
for (List<Object> step : allGroups) {
65+
tester.addEqualityGroup(step.toArray());
66+
}
67+
tester.testEquals();
68+
}
69+
}

‎testlib/src/main/java/com/diffplug/spotless/TestProvisioner.java

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
/*
2+
* Copyright 2016 DiffPlug
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package com.diffplug.spotless;
17+
18+
import java.io.File;
19+
import java.util.function.Consumer;
20+
21+
import org.gradle.api.Project;
22+
import org.gradle.api.artifacts.Configuration;
23+
import org.gradle.api.artifacts.Dependency;
24+
import org.gradle.api.artifacts.dsl.RepositoryHandler;
25+
import org.gradle.testfixtures.ProjectBuilder;
26+
27+
import com.diffplug.common.base.StandardSystemProperty;
28+
29+
public class TestProvisioner {
30+
/**
31+
* Creates a Provisioner for the given repositories.
32+
*
33+
* The first time a project is created, there are ~7 seconds of configuration
34+
* which will go away for all subsequent runs.
35+
*
36+
* Every call to resolve will take about 1 second, even when all artifacts are resolved.
37+
*/
38+
private static Provisioner createWithRepositories(Consumer<RepositoryHandler> repoConfig) {
39+
// use the default gradle home directory to ensure that files are always resolved to the same location
40+
File gradleHome = new File(StandardSystemProperty.USER_DIR.value() + "/.gradle");
41+
Project project = ProjectBuilder.builder()
42+
.withGradleUserHomeDir(gradleHome)
43+
.build();
44+
repoConfig.accept(project.getRepositories());
45+
return mavenCoords -> {
46+
Dependency[] deps = mavenCoords.stream()
47+
.map(project.getDependencies()::create)
48+
.toArray(Dependency[]::new);
49+
Configuration config = project.getConfigurations().detachedConfiguration(deps);
50+
config.setDescription(mavenCoords.toString());
51+
return config.resolve();
52+
};
53+
}
54+
55+
/** Creates a Provisioner for the jcenter repo. */
56+
public static Provisioner jcenter() {
57+
return createWithRepositories(repo -> repo.jcenter());
58+
}
59+
60+
/** Creates a Provisioner for the mavenCentral repo. */
61+
public static Provisioner mavenCentral() {
62+
return createWithRepositories(repo -> repo.mavenCentral());
63+
}
64+
}

‎testlib/src/test/java/com/diffplug/spotless/markdown/FreshMarkStepTest.java

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
/*
2+
* Copyright 2016 DiffPlug
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package com.diffplug.spotless.markdown;
17+
18+
import java.util.HashMap;
19+
import java.util.Map;
20+
21+
import org.junit.Test;
22+
23+
import com.diffplug.spotless.FormatterStep;
24+
import com.diffplug.spotless.StepEqualityTester;
25+
import com.diffplug.spotless.StepHarness;
26+
import com.diffplug.spotless.TestProvisioner;
27+
28+
public class FreshMarkStepTest {
29+
@Test
30+
public void behavior() throws Exception {
31+
HashMap<String, String> map = new HashMap<>();
32+
map.put("lib", "MyLib");
33+
map.put("author", "Me");
34+
StepHarness.forStep(FreshMarkStep.create(() -> map, TestProvisioner.mavenCentral()))
35+
.testResource("freshmark/FreshMarkUnformatted.test", "freshmark/FreshMarkFormatted.test");
36+
}
37+
38+
@Test
39+
public void equality() throws Exception {
40+
new StepEqualityTester() {
41+
String version = "1.3.1";
42+
Map<String, Object> props = new HashMap<>();
43+
44+
@Override
45+
protected void setupTest(API api) {
46+
// same version and props == same
47+
api.assertThisEqualToThis();
48+
api.areDifferentThan();
49+
// change the version, and it's different
50+
version = "1.3.0";
51+
api.assertThisEqualToThis();
52+
api.areDifferentThan();
53+
// change the props, and it's different
54+
props.put("1", "2");
55+
api.assertThisEqualToThis();
56+
api.areDifferentThan();
57+
}
58+
59+
@Override
60+
protected FormatterStep create() {
61+
String finalVersion = this.version;
62+
Map<String, ?> finalProps = new HashMap<>(props);
63+
return FreshMarkStep.create(finalVersion, () -> finalProps, TestProvisioner.mavenCentral());
64+
}
65+
}.testEquals();
66+
}
67+
}

‎testlib/src/test/resources/freshmark/FreshMarkFormatted.test

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!---freshmark shields
2+
output = link(shield('License Apache', 'license', 'Apache', 'brightgreen'), 'https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)');
3+
-->
4+
[![License Apache](https://img.shields.io/badge/license-Apache-brightgreen.svg)](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0))
5+
<!---freshmark /shields -->
6+
7+
Unformatted stuff.
8+
9+
<!---freshmark props
10+
output = 'lib=' + lib + ' author=' + author;
11+
-->
12+
lib=MyLib author=Me
13+
<!---freshmark /props -->
14+
15+

‎testlib/src/test/resources/freshmark/FreshMarkUnformatted.test

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!---freshmark shields
2+
output = link(shield('License Apache', 'license', 'Apache', 'brightgreen'), 'https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)');
3+
-->
4+
[![License Apache](https://img.shields.io/badge/license-Apache-blue.svg)](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0))
5+
<!---freshmark /shields -->
6+
7+
Unformatted stuff.
8+
9+
<!---freshmark props
10+
output = 'lib=' + lib + ' author=' + author;
11+
-->
12+
13+
<!---freshmark /props -->
14+
15+

0 commit comments

Comments
 (0)