erik/semver
erik/semver
1
1
Fork 0
Code Issues Pull requests Releases Activity

Removed checkstyle, using IDEA default code format.

Browse source
This commit is contained in:
Erik C. Thauvin 2021-06-18 18:08:32 -07:00
parent 5dce160cf1
commit 5a422fe502
11 changed files with 98 additions and 55 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.idea/compiler.xml generated
View file

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<project version="4"> <project version="4">
<component name="CompilerConfiguration"> <component name="CompilerConfiguration">
<bytecodeTargetLevel> <bytecodeTargetLevel target="1.8">
<module name="example_annotationProcessor" target="1.8" /> <module name="example_annotationProcessor" target="1.8" />
<module name="example_main" target="1.8" /> <module name="example_main" target="1.8" />
<module name="example_test" target="1.8" /> <module name="example_test" target="1.8" />

5
.idea/jarRepositories.xml generated
View file

@ -26,5 +26,10 @@
<option name="name" value="BintrayJCenter" /> <option name="name" value="BintrayJCenter" />
<option name="url" value="https://jcenter.bintray.com/" /> <option name="url" value="https://jcenter.bintray.com/" />
</remote-repository> </remote-repository>
<remote-repository>
<option name="id" value="MavenLocal" />
<option name="name" value="MavenLocal" />
<option name="url" value="file:$MAVEN_REPOSITORY$/" />
</remote-repository>
</component> </component>
</project> </project>

58
.idea/misc.xml generated
View file

@ -1,5 +1,61 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<project version="4"> <project version="4">
<component name="EntryPointsManager">
<entry_points version="2.0">
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants DEFAULT_BUILDMETA_PREFIX" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants DEFAULT_CLASS_NAME" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants DEFAULT_JAVA_TEMPLATE" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants DEFAULT_JAVA_TYPE" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants DEFAULT_KEYS_PREFIX" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants DEFAULT_KOTLIN_TEMPLATE" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants DEFAULT_MAJOR" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants DEFAULT_MINOR" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants DEFAULT_PATCH" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants DEFAULT_PRERELEASE_PREFIX" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants DEFAULT_SEPARATOR" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants DEFAULT_TEMPLATE_NAME" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants EMPTY" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants KAPT_KOTLIN_GENERATED_OPTION_NAME" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants KEY_VERSION_BUILDMETA" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants KEY_VERSION_BUILDMETA_PREFIX" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants KEY_VERSION_MAJOR" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants KEY_VERSION_MINOR" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants KEY_VERSION_PATCH" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants KEY_VERSION_PRERELEASE" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants KEY_VERSION_PRERELEASE_PREFIX" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants KEY_VERSION_PROJECT" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants KEY_VERSION_SEPARATOR" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants KOTLIN_TYPE" />
<entry_point TYPE="field" FQNAME="net.thauvin.erik.semver.Constants SEMVER_PROJECT_DIR_ARG" />
</entry_points>
<pattern value="net.thauvin.erik.semver.Constants" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="getBuildMeta" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="getBuildMetaPrefix" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="getClassName" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="getEpoch" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="getMajor" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="getMinor" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="getPackageName" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="getPatch" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="getPreRelease" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="getPreReleasePrefix" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="getSemver" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="getSeparator" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="setBuildMeta" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="setBuildMetaPrefix" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="setClassName" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="setMajor" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="setMinor" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="setPackageName" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="setPatch" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="setPreRelease" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="setPreReleasePrefix" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="setProject" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="setSeparator" />
<pattern value="net.thauvin.erik.semver.VersionInfo" />
<pattern value="net.thauvin.erik.semver.VersionInfo" method="VersionInfo" />
<pattern value="net.thauvin.erik.semver.Constants" method="Constants" />
</component>
<component name="ExternalStorageConfigurationManager" enabled="true" /> <component name="ExternalStorageConfigurationManager" enabled="true" />
<component name="FrameworkDetectionExcludesConfiguration"> <component name="FrameworkDetectionExcludesConfiguration">
<file type="web" url="file://$PROJECT_DIR$" /> <file type="web" url="file://$PROJECT_DIR$" />
@ -20,7 +76,7 @@
</map> </map>
</option> </option>
</component> </component>
<component name="ProjectRootManager" version="2" languageLevel="JDK_1_8" default="false" project-jdk-name="1.8" project-jdk-type="JavaSDK"> <component name="ProjectRootManager" version="2" languageLevel="JDK_1_8" project-jdk-name="15" project-jdk-type="JavaSDK">
<output url="file://$PROJECT_DIR$/out" /> <output url="file://$PROJECT_DIR$/out" />
</component> </component>
</project> </project>

12
build.gradle
View file

@ -1,5 +1,4 @@
plugins { plugins {
id 'checkstyle'
id 'java' id 'java'
id 'jacoco' id 'jacoco'
id 'maven-publish' id 'maven-publish'
@ -154,13 +153,6 @@ tasks.withType(SpotBugsTask) {
} }
} }
tasks.withType(Checkstyle) {
reports {
xml.enabled = false
html.enabled = true
}
}
task release { task release {
group = 'Publishing' group = 'Publishing'
description = 'Releases new version to local maven repository.' description = 'Releases new version to local maven repository.'
@ -194,8 +186,8 @@ task pandoc(type: Exec) {
jacocoTestReport { jacocoTestReport {
dependsOn(test) dependsOn(test)
reports { reports {
html.enabled = true html.required = true
xml.enabled = true xml.required = true
} }
} }

1
src/main/java/net/thauvin/erik/semver/Constants.java
View file

@ -39,7 +39,6 @@ package net.thauvin.erik.semver;
* @created 2016-01-13 * @created 2016-01-13
* @since 1.0 * @since 1.0
*/ */
@SuppressWarnings("WeakerAccess")
public final class Constants { public final class Constants {
/** /**
* The default metadata prefix. * The default metadata prefix.

1
src/main/java/net/thauvin/erik/semver/Version.java
View file

@ -44,6 +44,7 @@ import java.lang.annotation.Target;
* @created 2016-01-13 * @created 2016-01-13
* @since 1.0 * @since 1.0
*/ */
@SuppressWarnings("SameReturnValue")
@Retention(RetentionPolicy.SOURCE) @Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE) @Target(ElementType.TYPE)
public @interface Version { public @interface Version {

12
src/main/java/net/thauvin/erik/semver/VersionInfo.java
View file

@ -330,11 +330,11 @@ public class VersionInfo {
*/ */
public String getVersion() { public String getVersion() {
return major return major
+ separator + separator
+ minor + minor
+ separator + separator
+ patch + patch
+ (preRelease.length() > 0 ? preReleasePrefix + preRelease : "") + (preRelease.length() > 0 ? preReleasePrefix + preRelease : "")
+ (buildMeta.length() > 0 ? buildMetaPrefix + buildMeta : ""); + (buildMeta.length() > 0 ? buildMetaPrefix + buildMeta : "");
} }
} }

48
src/main/java/net/thauvin/erik/semver/VersionProcessor.java
View file

@ -38,12 +38,7 @@ import com.github.mustachejava.MustacheFactory;
import com.github.mustachejava.MustacheNotFoundException; import com.github.mustachejava.MustacheNotFoundException;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import javax.annotation.processing.AbstractProcessor; import javax.annotation.processing.*;
import javax.annotation.processing.Filer;
import javax.annotation.processing.Messager;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.SupportedOptions;
import javax.lang.model.SourceVersion; import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element; import javax.lang.model.element.Element;
import javax.lang.model.element.ElementKind; import javax.lang.model.element.ElementKind;
@ -51,12 +46,7 @@ import javax.lang.model.element.PackageElement;
import javax.lang.model.element.TypeElement; import javax.lang.model.element.TypeElement;
import javax.tools.Diagnostic; import javax.tools.Diagnostic;
import javax.tools.FileObject; import javax.tools.FileObject;
import java.io.File; import java.io.*;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
import java.nio.file.Files; import java.nio.file.Files;
import java.util.HashSet; import java.util.HashSet;
@ -70,7 +60,7 @@ import java.util.Set;
* @created 2016-01-13 * @created 2016-01-13
* @since 1.0 * @since 1.0
*/ */
@SuppressWarnings({ "PMD.GuardLogStatement", "PMD.BeanMembersShouldSerialize"}) @SuppressWarnings({"PMD.GuardLogStatement", "PMD.BeanMembersShouldSerialize"})
@SupportedOptions({Constants.KAPT_KOTLIN_GENERATED_OPTION_NAME, Constants.SEMVER_PROJECT_DIR_ARG}) @SupportedOptions({Constants.KAPT_KOTLIN_GENERATED_OPTION_NAME, Constants.SEMVER_PROJECT_DIR_ARG})
public class VersionProcessor extends AbstractProcessor { public class VersionProcessor extends AbstractProcessor {
private Filer filer; private Filer filer;
@ -97,27 +87,27 @@ public class VersionProcessor extends AbstractProcessor {
final Properties p = new Properties(); final Properties p = new Properties();
try (InputStreamReader reader = new InputStreamReader( try (InputStreamReader reader = new InputStreamReader(
Files.newInputStream(propsFile.toPath()), StandardCharsets.UTF_8)) { Files.newInputStream(propsFile.toPath()), StandardCharsets.UTF_8)) {
p.load(reader); p.load(reader);
versionInfo.setProject( versionInfo.setProject(
p.getProperty(version.keysPrefix() + version.projectKey(), version.project())); p.getProperty(version.keysPrefix() + version.projectKey(), version.project()));
versionInfo.setMajor( versionInfo.setMajor(
parseIntProperty(p, version.keysPrefix() + version.majorKey(), version.major())); parseIntProperty(p, version.keysPrefix() + version.majorKey(), version.major()));
versionInfo.setMinor( versionInfo.setMinor(
parseIntProperty(p, version.keysPrefix() + version.minorKey(), version.minor())); parseIntProperty(p, version.keysPrefix() + version.minorKey(), version.minor()));
versionInfo.setPatch( versionInfo.setPatch(
parseIntProperty(p, version.keysPrefix() + version.patchKey(), version.patch())); parseIntProperty(p, version.keysPrefix() + version.patchKey(), version.patch()));
versionInfo.setBuildMeta( versionInfo.setBuildMeta(
p.getProperty(version.keysPrefix() + version.buildMetaKey(), version.buildMeta())); p.getProperty(version.keysPrefix() + version.buildMetaKey(), version.buildMeta()));
versionInfo.setBuildMetaPrefix( versionInfo.setBuildMetaPrefix(
p.getProperty(version.keysPrefix() + version.buildMetaPrefixKey(), version.buildMetaPrefix())); p.getProperty(version.keysPrefix() + version.buildMetaPrefixKey(), version.buildMetaPrefix()));
versionInfo.setPreRelease( versionInfo.setPreRelease(
p.getProperty(version.keysPrefix() + version.preReleaseKey(), version.preRelease())); p.getProperty(version.keysPrefix() + version.preReleaseKey(), version.preRelease()));
versionInfo.setPreReleasePrefix(p.getProperty(version.keysPrefix() + version.preReleasePrefixKey(), versionInfo.setPreReleasePrefix(p.getProperty(version.keysPrefix() + version.preReleasePrefixKey(),
version.preReleasePrefix())); version.preReleasePrefix()));
versionInfo.setSeparator( versionInfo.setSeparator(
p.getProperty(version.keysPrefix() + version.separatorKey(), version.separator())); p.getProperty(version.keysPrefix() + version.separatorKey(), version.separator()));
} }
} else { } else {
final String findOrRead; final String findOrRead;
@ -128,7 +118,7 @@ public class VersionProcessor extends AbstractProcessor {
} }
error("Could not " + findOrRead + ": " + propsFile); error("Could not " + findOrRead + ": " + propsFile);
throw new FileNotFoundException( throw new FileNotFoundException(
"Could not " + findOrRead + " the specified file: `" + propsFile.getAbsolutePath() + '`'); "Could not " + findOrRead + " the specified file: `" + propsFile.getAbsolutePath() + '`');
} }
} }
@ -197,7 +187,7 @@ public class VersionProcessor extends AbstractProcessor {
if (isLocalTemplate && Constants.DEFAULT_JAVA_TEMPLATE.equals(version.template())) { if (isLocalTemplate && Constants.DEFAULT_JAVA_TEMPLATE.equals(version.template())) {
template = Constants.DEFAULT_TEMPLATE_NAME; template = Constants.DEFAULT_TEMPLATE_NAME;
} else if (Constants.DEFAULT_JAVA_TEMPLATE.equals(version.template()) && Constants.KOTLIN_TYPE } else if (Constants.DEFAULT_JAVA_TEMPLATE.equals(version.template()) && Constants.KOTLIN_TYPE
.equals(version.type())) { .equals(version.type())) {
template = Constants.DEFAULT_KOTLIN_TEMPLATE; template = Constants.DEFAULT_KOTLIN_TEMPLATE;
} else { } else {
template = version.template(); template = version.template();
@ -216,7 +206,7 @@ public class VersionProcessor extends AbstractProcessor {
private void log(final Diagnostic.Kind kind, final String s) { private void log(final Diagnostic.Kind kind, final String s) {
if (messager != null) { if (messager != null) {
messager.printMessage(kind, messager.printMessage(kind,
'[' + VersionProcessor.class.getSimpleName() + "] " + s + System.lineSeparator()); '[' + VersionProcessor.class.getSimpleName() + "] " + s + System.lineSeparator());
} }
} }
@ -239,7 +229,7 @@ public class VersionProcessor extends AbstractProcessor {
@SuppressFBWarnings({"PATH_TRAVERSAL_IN", "UAC_UNNECESSARY_API_CONVERSION_FILE_TO_PATH"}) @SuppressFBWarnings({"PATH_TRAVERSAL_IN", "UAC_UNNECESSARY_API_CONVERSION_FILE_TO_PATH"})
private void writeTemplate(final String type, final VersionInfo versionInfo, final String template) private void writeTemplate(final String type, final VersionInfo versionInfo, final String template)
throws IOException { throws IOException {
final File dir = getLocalFile(""); final File dir = getLocalFile("");
final MustacheFactory mf = new DefaultMustacheFactory(dir); final MustacheFactory mf = new DefaultMustacheFactory(dir);
final Mustache mustache = mf.compile(template); final Mustache mustache = mf.compile(template);
@ -269,13 +259,13 @@ public class VersionProcessor extends AbstractProcessor {
note("Could not create target directory: " + ktFile.getParentFile().getAbsolutePath()); note("Could not create target directory: " + ktFile.getParentFile().getAbsolutePath());
} }
try (OutputStreamWriter osw = new OutputStreamWriter(Files.newOutputStream(ktFile.toPath()), try (OutputStreamWriter osw = new OutputStreamWriter(Files.newOutputStream(ktFile.toPath()),
StandardCharsets.UTF_8)) { StandardCharsets.UTF_8)) {
mustache.execute(osw, versionInfo).flush(); mustache.execute(osw, versionInfo).flush();
} }
note("Generated source: " + fileName + " (" + ktFile.getParentFile().getAbsolutePath() + ')'); note("Generated source: " + fileName + " (" + ktFile.getParentFile().getAbsolutePath() + ')');
} else { } else {
final FileObject jfo = filer.createSourceFile( final FileObject jfo = filer.createSourceFile(
versionInfo.getPackageName() + '.' + versionInfo.getClassName()); versionInfo.getPackageName() + '.' + versionInfo.getClassName());
try (Writer writer = jfo.openWriter()) { try (Writer writer = jfo.openWriter()) {
mustache.execute(writer, versionInfo).flush(); mustache.execute(writer, versionInfo).flush();
} }

10
src/test/java/net/thauvin/erik/semver/VersionInfoTest.java
View file

@ -97,7 +97,7 @@ public class VersionInfoTest {
assertEquals(versionInfo.getVersion(), "3-2-1+001", "getVersion(3-2-1+001)"); assertEquals(versionInfo.getVersion(), "3-2-1+001", "getVersion(3-2-1+001)");
assertEquals(versionInfo.getVersion(), versionInfo.getSemver(), assertEquals(versionInfo.getVersion(), versionInfo.getSemver(),
"getVersion(3-2-1+001) = getSemver(3-2-1+001) "); "getVersion(3-2-1+001) = getSemver(3-2-1+001) ");
} }
@Test @Test
@ -175,18 +175,18 @@ public class VersionInfoTest {
assertEquals(versionInfo.getPreRelease(), version.preRelease(), "getPreRelease(preRelease)"); assertEquals(versionInfo.getPreRelease(), version.preRelease(), "getPreRelease(preRelease)");
assertEquals(versionInfo.getPreReleasePrefix(), version.preReleasePrefix(), assertEquals(versionInfo.getPreReleasePrefix(), version.preReleasePrefix(),
"getPreReleasePrefix(preReleasePrefix)"); "getPreReleasePrefix(preReleasePrefix)");
assertEquals(versionInfo.getBuildMeta(), version.buildMeta(), "getBuildMeta(buildMeta)"); assertEquals(versionInfo.getBuildMeta(), version.buildMeta(), "getBuildMeta(buildMeta)");
assertEquals(versionInfo.getBuildMetaPrefix(), version.buildMetaPrefix(), assertEquals(versionInfo.getBuildMetaPrefix(), version.buildMetaPrefix(),
"getBuildMetaPrefix(buildMetaPrefix)"); "getBuildMetaPrefix(buildMetaPrefix)");
assertEquals(versionInfo.getPackageName(), version.packageName(), "getPackageName(packageName)"); assertEquals(versionInfo.getPackageName(), version.packageName(), "getPackageName(packageName)");
assertEquals(versionInfo.getVersion(), assertEquals(versionInfo.getVersion(),
version.major() + "." + version.minor() + '.' + version.patch() + '-' + version.preRelease() + '+' version.major() + "." + version.minor() + '.' + version.patch() + '-' + version.preRelease() + '+'
+ version.buildMeta(), "getVersion(version)"); + version.buildMeta(), "getVersion(version)");
assertEquals(versionInfo.getVersion(), versionInfo.getSemver(), "getVersion(version) = getSemver(version)"); assertEquals(versionInfo.getVersion(), versionInfo.getSemver(), "getVersion(version) = getSemver(version)");

2
src/test/java/net/thauvin/erik/semver/VersionProcessorTest.java
View file

@ -73,7 +73,7 @@ public class VersionProcessorTest {
p.setProperty("4", " 4 "); p.setProperty("4", " 4 ");
final Method method = processor.getClass().getDeclaredMethod("parseIntProperty", Properties.class, String.class, final Method method = processor.getClass().getDeclaredMethod("parseIntProperty", Properties.class, String.class,
int.class); int.class);
method.setAccessible(true); method.setAccessible(true);
assertEquals(method.invoke(processor, p, "1", -1), 1, "parseIntProperty(1)"); assertEquals(method.invoke(processor, p, "1", -1), 1, "parseIntProperty(1)");

2
src/test/java/net/thauvin/erik/semver/VersionTest.java
View file

@ -41,7 +41,7 @@ import java.lang.annotation.Annotation;
* @created 2019-04-02 * @created 2019-04-02
* @since 1.2.0 * @since 1.2.0
*/ */
@SuppressWarnings({"ClassExplicitlyAnnotation"}) @SuppressWarnings({"ClassExplicitlyAnnotation", "SameReturnValue"})
class VersionTest implements Version { class VersionTest implements Version {
@Override @Override
public Class<? extends Annotation> annotationType() { public Class<? extends Annotation> annotationType() {