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

Initial commit.

Browse source
This commit is contained in:
Erik C. Thauvin 2016-01-18 13:22:10 -08:00
commit aeee81544c
27 changed files with 2651 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -0,0 +1,79 @@
/*
* Constants.java
*
* Copyright (c) 2016, Erik C. Thauvin (erik@thauvin.net)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the author nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.thauvin.erik.semver;
/**
* The <code>Constants</code> class.
*
* @author <a href="mailto:erik@thauvin.net">Erik C. Thauvin</a>
* @created 2016-01-13
* @since 1.0
*/
public final class Constants
{
public static final String DEFAULT_CLASS_NAME = "GeneratedVersion";
public static final int DEFAULT_MAJOR = 1;
public static final int DEFAULT_MINOR = 0;
public static final int DEFAULT_PATCH = 0;
public static final String DEFAULT_TEMPLATE = "version.vm";
public static final String EMPTY = "";
public static final String KEY_VERSION_BUILDMETA = "version.buildmeta";
public static final String KEY_VERSION_MAJOR = "version.major";
public static final String KEY_VERSION_MINOR = "version.minor";
public static final String KEY_VERSION_PATCH = "version.patch";
public static final String KEY_VERSION_PRERELEASE = "version.prerelease";
public static final String VELOCITY_PROPERTIES = "velocity.properties";
/**
* Disables the default constructor.
*
* @throws UnsupportedOperationException if an error occurred. if the constructor is called.
*/
private Constants()
throws UnsupportedOperationException
{
throw new UnsupportedOperationException("Illegal constructor call.");
}
}

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

@ -0,0 +1,77 @@
/*
* Version.java
*
* Copyright (c) 2016, Erik C. Thauvin (erik@thauvin.net)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the author nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.thauvin.erik.semver;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* The <code>Version</code> class.
*
* @author <a href="mailto:erik@thauvin.net">Erik C. Thauvin</a>
* @created 2016-01-13
* @since 1.0
*/
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
public @interface Version
{
String buildmeta() default Constants.EMPTY;
String buildmetaKey() default Constants.KEY_VERSION_BUILDMETA;
String className() default Constants.DEFAULT_CLASS_NAME;
int major() default Constants.DEFAULT_MAJOR;
String majorKey() default Constants.KEY_VERSION_MAJOR;
int minor() default Constants.DEFAULT_MINOR;
String minorKey() default Constants.KEY_VERSION_MINOR;
int patch() default Constants.DEFAULT_PATCH;
String patchKey() default Constants.KEY_VERSION_PATCH;
String prerelease() default Constants.EMPTY;
String prereleaseKey() default Constants.KEY_VERSION_PRERELEASE;
String properties() default Constants.EMPTY;
String template() default Constants.DEFAULT_TEMPLATE;
}

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

@ -0,0 +1,135 @@
/*
* VersionInfo.java
*
* Copyright (c) 2016, Erik C. Thauvin (erik@thauvin.net)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the author nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.thauvin.erik.semver;
/**
* The <code>VersionInfo</code> class.
*
* @author <a href="mailto:erik@thauvin.net">Erik C. Thauvin</a>
* @created 2016-01-16
* @since 1.0
*/
public class VersionInfo
{
private final long epoch = System.currentTimeMillis();
private String buildmeta;
private int major;
private int minor;
private int patch;
private String prerelease;
public VersionInfo()
{
major = Constants.DEFAULT_MAJOR;
minor = Constants.DEFAULT_MINOR;
patch = Constants.DEFAULT_PATCH;
buildmeta = Constants.EMPTY;
prerelease = Constants.EMPTY;
}
public VersionInfo(final Version version)
{
major = version.major();
minor = version.minor();
patch = version.patch();
buildmeta = version.buildmeta();
prerelease = version.prerelease();
}
public String getBuildMetadata()
{
return buildmeta;
}
public void setBuildMetadata(final String buildmeta)
{
this.buildmeta = buildmeta;
}
public long getEpoch()
{
return epoch;
}
public int getMajor()
{
return major;
}
public void setMajor(final int major)
{
this.major = major;
}
public int getMinor()
{
return minor;
}
public void setMinor(final int minor)
{
this.minor = minor;
}
public int getPatch()
{
return patch;
}
public void setPatch(final int patch)
{
this.patch = patch;
}
public String getPreRelease()
{
return prerelease;
}
public void setPreRelease(final String prerelease)
{
this.prerelease = prerelease;
}
public String getVersion()
{
return "" + major + '.' + minor + '.' + patch + (prerelease.length() > 0 ? '-' + prerelease : "") + (
buildmeta.length() > 0 ? '+' + buildmeta : "");
}
}

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

@ -0,0 +1,252 @@
/*
* VersionProcessor.java
*
* Copyright (c) 2016, Erik C. Thauvin (erik@thauvin.net)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the author nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.thauvin.erik.semver;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;
import javax.annotation.processing.*;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.ElementKind;
import javax.lang.model.element.PackageElement;
import javax.lang.model.element.TypeElement;
import javax.tools.Diagnostic;
import javax.tools.JavaFileObject;
import java.io.*;
import java.net.URL;
import java.util.HashSet;
import java.util.Properties;
import java.util.Set;
/**
* The <code>VersionProcessor</code> class.
*
* @author <a href="mailto:erik@thauvin.net">Erik C. Thauvin</a>
* @created 2016-01-13
* @since 1.0
*/
public class VersionProcessor extends AbstractProcessor
{
private Filer filer;
private Messager messager;
private void error(final String s)
{
log(Diagnostic.Kind.ERROR, s);
}
private void error(final String s, final Throwable t)
{
messager.printMessage(Diagnostic.Kind.ERROR, (t != null ? t.toString() : s));
}
private VersionInfo findValues(final Version version)
throws IOException
{
final VersionInfo versionInfo;
if (version.properties().length() > 0)
{
versionInfo = new VersionInfo();
final File propsFile = new File(version.properties());
if (propsFile.exists())
{
note("Found properties: " + propsFile);
final Properties p = new Properties();
try (FileReader reader = new FileReader(propsFile))
{
p.load(reader);
versionInfo.setMajor(parseIntProperty(p, version.majorKey(), Constants.DEFAULT_MAJOR));
versionInfo.setMinor(parseIntProperty(p, version.minorKey(), Constants.DEFAULT_MINOR));
versionInfo.setPatch(parseIntProperty(p, version.patchKey(), Constants.DEFAULT_PATCH));
versionInfo.setBuildMetadata(p.getProperty(version.buildmetaKey(), Constants.EMPTY));
versionInfo.setPreRelease(p.getProperty(version.prereleaseKey(), Constants.EMPTY));
}
}
else
{
error("Could not find: " + propsFile);
throw new FileNotFoundException(propsFile + " (The system cannot find the file specified)");
}
}
else
{
versionInfo = new VersionInfo(version);
}
return versionInfo;
}
/**
* {@inheritDoc}
*/
@Override
public Set<String> getSupportedAnnotationTypes()
{
final Set<String> result = new HashSet<>();
result.add(Version.class.getCanonicalName());
return result;
}
/**
* {@inheritDoc}
*/
@Override
public SourceVersion getSupportedSourceVersion()
{
return SourceVersion.RELEASE_8;
}
/**
* {@inheritDoc}
*/
@Override
public synchronized void init(final ProcessingEnvironment processingEnv)
{
super.init(processingEnv);
filer = processingEnv.getFiler();
messager = processingEnv.getMessager();
}
/**
* {@inheritDoc}
*/
@Override
public boolean process(final Set<? extends TypeElement> annotations, final RoundEnvironment roundEnv)
{
for (final Element annotatedElement : roundEnv.getElementsAnnotatedWith(Version.class))
{
final Version version = annotatedElement.getAnnotation(Version.class);
if (annotatedElement.getKind() == ElementKind.CLASS)
{
final Element enclosing = annotatedElement.getEnclosingElement();
if (enclosing.getKind() == ElementKind.PACKAGE)
{
final PackageElement packageElement = (PackageElement) enclosing;
try
{
final VersionInfo versionInfo = findValues(version);
note("Found version: " + versionInfo.getVersion());
writeTemplate(packageElement.getQualifiedName().toString(),
version.className(),
versionInfo,
version.template());
}
catch (IOException e)
{
error("IOException occurred while running annotation processor", e);
}
}
}
}
return true;
}
private void log(final Diagnostic.Kind kind, final String s)
{
messager.printMessage(kind, '[' + VersionProcessor.class.getSimpleName() + "] " + s);
}
private void note(final String s)
{
log(Diagnostic.Kind.NOTE, s);
}
private int parseIntProperty(final Properties p, final String property, final int defaultValue)
{
try
{
return Integer.parseInt(p.getProperty(property, "" + defaultValue));
}
catch (NumberFormatException ignore)
{
warn("Invalid property value: " + property);
return defaultValue;
}
}
private void warn(final String s)
{
log(Diagnostic.Kind.WARNING, s);
}
private void writeTemplate(final String packageName, final String className, final VersionInfo versionInfo,
final String template)
throws IOException
{
final Properties p = new Properties();
final URL url = this.getClass().getClassLoader().getResource(Constants.VELOCITY_PROPERTIES);
if (url != null)
{
p.load(url.openStream());
final VelocityEngine ve = new VelocityEngine(p);
ve.init();
final VelocityContext vc = new VelocityContext();
vc.put("packageName", packageName);
vc.put("className", className);
vc.put("buildmeta", versionInfo.getBuildMetadata());
vc.put("epoch", versionInfo.getEpoch());
vc.put("patch", versionInfo.getPatch());
vc.put("major", versionInfo.getMajor());
vc.put("minor", versionInfo.getMinor());
vc.put("prerelease", versionInfo.getPreRelease());
final Template vt = ve.getTemplate(template);
note("Loaded template: " + vt.getName());
final JavaFileObject jfo = filer.createSourceFile(packageName + '.' + className);
try (final Writer writer = jfo.openWriter())
{
vt.merge(vc, writer);
}
note("Generated source: " + jfo.getName());
}
else
{
error("Could not load '" + Constants.VELOCITY_PROPERTIES + "' from jar.");
}
}
}

1
src/main/resources/META-INF/services/javax.annotation.processing.Processor Normal file
View file

@ -0,0 +1 @@
net.thauvin.erik.semver.VersionProcessor

4
src/main/resources/velocity.properties Normal file
View file

@ -0,0 +1,4 @@
runtime.log.logsystem.class = org.apache.velocity.runtime.log.SystemLogChute
resource.loader = file, class
file.resource.loader.class = org.apache.velocity.runtime.resource.loader.FileResourceLoader
class.resource.loader.class = org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader

92
src/main/resources/version.vm Normal file
View file

@ -0,0 +1,92 @@
/*
* This file is automatically generated by the Semantic Version Annotation Processor.
* Do not modify this file -- YOUR CHANGES WILL BE ERASED!
*/
package ${packageName};
import java.util.Date;
/**
* This class provides semantic version information.
*
* @author Semantic Version Annotation Processor
*/
public final class ${className} {
private final static String buildmeta = "${buildmeta}";
private final static Date date = new Date(${epoch}L);
private final static int major = ${major};
private final static int minor = ${minor};
private final static int patch = ${patch};
private final static String prerelease = "${prerelease}";
/**
* Returns the build date.
*
* @return The build date.
*/
public static Date getBuildDate() {
return date;
}
/**
* Returns the full version.
*
* @return The full version string.
*/
public static String getVersion() {
return "" + getMajor() + '.' + getMinor() + '.' + getPatch() + getPreRelease() + getBuildMetadata();
}
/**
* Returns the major version.
*
* @return The major version.
*/
public static int getMajor() {
return major;
}
/**
* Returns the minor version.
*
* @return The minor version.
*/
public static int getMinor() {
return minor;
}
/**
* Returns the patch version.
*
* @return The patch version.
*/
public static int getPatch() {
return patch;
}
/**
* Returns the pre-release version.
*
* @return The pre-release version, if any.
*/
public static String getPreRelease() {
if (prerelease.length() > 0) {
return '-' + prerelease;
}
return "";
}
/**
* Returns the build metadata.
*
* @return The build metadata, if any.
*/
public static String getBuildMetadata() {
if (buildmeta.length() > 0) {
return '+' + buildmeta;
}
return "";
}
}