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

Added checkstyle.

Browse source
This commit is contained in:
Erik C. Thauvin 2019-04-16 11:20:33 -07:00
parent eba4b97704
commit 5f431e0725
9 changed files with 404 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -29,6 +29,7 @@
* 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;
/**

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

@ -29,6 +29,7 @@
* 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;
@ -46,51 +47,171 @@ import java.lang.annotation.Target;
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
public @interface Version {
/**
* Returns the build metadata version.
*
* @return The build metadata version.
*/
String buildMeta() default Constants.EMPTY;
/**
* Returns the build metadata key.
*
* @return The build metadata key.
*/
String buildMetaKey() default Constants.KEY_VERSION_BUILDMETA;
/**
* Returns the build metadata prefix.
*
* @return The build metadata prefix.
*/
String buildMetaPrefix() default Constants.DEFAULT_BUILDMETA_PREFIX;
/**
* Returns the build metadata prefix key.
*
* @return The build metadata prefix key.
*/
String buildMetaPrefixKey() default Constants.KEY_VERSION_BUILDMETA_PREFIX;
/**
* Returns the class name.
*
* @return The class name.
*/
String className() default Constants.DEFAULT_CLASS_NAME;
/**
* Returns the keys prefix.
*
* @return The keys prefix.
*/
String keysPrefix() default Constants.DEFAULT_KEYS_PREFIX;
/**
* Returns the major version.
*
* @return The major version.
*/
int major() default Constants.DEFAULT_MAJOR;
/**
* Returns the major key.
*
* @return The major key.
*/
String majorKey() default Constants.KEY_VERSION_MAJOR;
/**
* Returns the minor version.
*
* @return The build minor version.
*/
int minor() default Constants.DEFAULT_MINOR;
/**
* Returns the minor key.
*
* @return The minor key.
*/
String minorKey() default Constants.KEY_VERSION_MINOR;
/**
* Returns the package name.
*
* @return The package name .
*/
String packageName() default Constants.EMPTY;
/**
* Returns the patch version.
*
* @return The patch version.
*/
int patch() default Constants.DEFAULT_PATCH;
/**
* Returns the patch key.
*
* @return The patch key.
*/
String patchKey() default Constants.KEY_VERSION_PATCH;
/**
* Returns the pre-release version.
*
* @return The pre-release version.
*/
String preRelease() default Constants.EMPTY;
/**
* Returns the pre-release key.
*
* @return The pre-release key.
*/
String preReleaseKey() default Constants.KEY_VERSION_PRERELEASE;
/**
* Returns the pre-release prefix.
*
* @return The pre-release prefix.
*/
String preReleasePrefix() default Constants.DEFAULT_PRERELEASE_PREFIX;
/**
* Returns the pre-release prefix key.
*
* @return The pre-release prefix key.
*/
String preReleasePrefixKey() default Constants.KEY_VERSION_PRERELEASE_PREFIX;
/**
* Returns the project name.
*
* @return The project name.
*/
String project() default Constants.EMPTY;
/**
* Returns the project key.
*
* @return The project.
*/
String projectKey() default Constants.KEY_VERSION_PROJECT;
/**
* Returns the properties file name.
*
* @return The properties file name.
*/
String properties() default Constants.EMPTY;
/**
* Returns the version separator.
*
* @return The separator.
*/
String separator() default Constants.DEFAULT_SEPARATOR;
/**
* Returns the version separator key.
*
* @return The separator key.
*/
String separatorKey() default Constants.KEY_VERSION_SEPARATOR;
/**
* Returns the template name.
*
* @return The template.
*/
String template() default Constants.DEFAULT_JAVA_TEMPLATE;
/**
* Returns the template type.
*
* @return The type.
*/
String type() default Constants.DEFAULT_JAVA_TYPE;
}

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

@ -29,6 +29,7 @@
* 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;
/**
@ -281,7 +282,7 @@ public class VersionInfo {
/**
* Sames as {@link #getVersion()}
* Sames as {@link #getVersion()}.
*/
public String getSemver() {
return getVersion();
@ -307,11 +308,15 @@ public class VersionInfo {
/**
* Returns the full version string.
* <p>
* Formatted as:
* <blockquote><code>[MAJOR][SEPARATOR][MINOR][SEPARATOR][PATCH][[PRERELEASE-PREFIX][PRERELEASE]][[BUILDMETA-PREFIX][BUILDMETA]]</code></blockquote>
* <p>
* For example:
*
* <p>Formatted as:
* <blockquote>
* <code>
* [MAJOR][SEPARATOR][MINOR][SEPARATOR][PATCH][[PRERELEASE-PREFIX][PRERELEASE]][[BUILDMETA-PREFIX][BUILDMETA]]
* </code>
* </blockquote>
*
* <p>For example:
* <ul>
* <li><code>1.0.0</code></li>
* <li><code>1.0.0-beta</code></li>

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

@ -29,6 +29,7 @@
* 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 com.github.mustachejava.DefaultMustacheFactory;
@ -97,11 +98,13 @@ public class VersionProcessor extends AbstractProcessor {
versionInfo.setBuildMeta(
p.getProperty(version.keysPrefix() + version.buildMetaKey(), version.buildMeta()));
versionInfo.setBuildMetaPrefix(
p.getProperty(version.keysPrefix() + version.buildMetaPrefixKey(), version.buildMetaPrefix()));
p.getProperty(version.keysPrefix() + version.buildMetaPrefixKey(),
version.buildMetaPrefix()));
versionInfo.setPreRelease(
p.getProperty(version.keysPrefix() + version.preReleaseKey(), version.preRelease()));
versionInfo.setPreReleasePrefix(
p.getProperty(version.keysPrefix() + version.preReleasePrefixKey(), version.preReleasePrefix()));
p.getProperty(version.keysPrefix() + version.preReleasePrefixKey(),
version.preReleasePrefix()));
versionInfo.setSeparator(
p.getProperty(version.keysPrefix() + version.separatorKey(), version.separator()));
}
@ -187,11 +190,11 @@ public class VersionProcessor extends AbstractProcessor {
}
note("Found version: " + versionInfo.getVersion());
final String template;
if (version.template().equals(Constants.DEFAULT_JAVA_TEMPLATE) &&
new File(Constants.DEFAULT_TEMPLATE_NAME).exists()) {
if (version.template().equals(Constants.DEFAULT_JAVA_TEMPLATE)
&& new File(Constants.DEFAULT_TEMPLATE_NAME).exists()) {
template = Constants.DEFAULT_TEMPLATE_NAME;
} else if (version.template().equals(Constants.DEFAULT_JAVA_TEMPLATE) &&
version.type().equals(Constants.KOTLIN_TYPE)) {
} else if (version.template().equals(Constants.DEFAULT_JAVA_TEMPLATE)
&& version.type().equals(Constants.KOTLIN_TYPE)) {
template = Constants.DEFAULT_KOTLIN_TEMPLATE;
} else {
template = version.template();

1
src/test/java/net/thauvin/erik/semver/ConstantsTest.java
View file

@ -29,6 +29,7 @@
* 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.testng.Assert;

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

@ -29,6 +29,7 @@
* 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.testng.Assert;

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

@ -29,6 +29,7 @@
* 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.testng.Assert;

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

@ -29,6 +29,7 @@
* 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.Annotation;