Release ZomboidDoc v3.0.0

Resolves: #56

Author: matshou

.idea/runConfigurations/Annotate_Lua.xml

@@ -69,7 +69,7 @@ Read [Commands](#commands) and [Examples](#examples) section for more informatio
 Here is an overview list of available commands:
 
 - `help` - print command usage info for all available commands.
-- `version` - print Project Zomboid game installation version.
+- `version` - print application and game version information.
 - `annotate` - annotate vanilla Lua files with EmmyLua.
 - `compile` - compile Lua library from modding API.
 

.idea/runConfigurations/Compile_Lua.xml

@@ -24,15 +24,15 @@ apply from: 'setup.gradle'
 apply from: 'spotless.gradle'
 apply from: 'distribution.gradle'
 
-group 'io.yooksi'
-version '2.2.0'
+group 'io.cocolabs'
+version file('version.txt').readLines().get(0)
 
 wrapper {
     distributionType = Wrapper.DistributionType.ALL
 }
 
 application {
-    mainClassName = 'io.yooksi.pz.zdoc.Main'
+    mainClassName = 'io.cocolabs.pz.zdoc.Main'
 }
 
 java {

README.md

@@ -19,6 +19,7 @@
 import java.io.InputStream;
 import java.io.Writer;
 import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.util.Map;
 import java.util.Objects;
 import java.util.regex.Matcher;
@@ -36,7 +37,7 @@
 @NonNullApi
 public class ZUnixStartScriptGenerator implements ScriptGenerator {
 
-	private static final Charset CHARSET = Charset.defaultCharset();
+	private static final Charset CHARSET = StandardCharsets.UTF_8;
 	private static final ClassLoader CL = ZUnixStartScriptGenerator.class.getClassLoader();
 
 	private static final String[] CLASSPATH_ADDENDUM = new String[]{

build.gradle

@@ -19,6 +19,7 @@
 import java.io.InputStream;
 import java.io.Writer;
 import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.util.Map;
 import java.util.Objects;
 import java.util.regex.Matcher;
@@ -36,7 +37,7 @@
 @NonNullApi
 public class ZWindowsStartScriptGenerator implements ScriptGenerator {
 
-	private static final Charset CHARSET = Charset.defaultCharset();
+	private static final Charset CHARSET = StandardCharsets.UTF_8;
 	private static final ClassLoader CL = ZWindowsStartScriptGenerator.class.getClassLoader();
 
 	private static final String[] CLASSPATH_ADDENDUM = new String[]{

buildSrc/src/main/java/ZUnixStartScriptGenerator.java

@@ -58,6 +58,10 @@ tasks.register("generateChangelog", Exec.class) {
 
 distributions.main.contents {
     it.from ('README.md', 'LICENSE.txt', 'CHANGELOG.md')
+    // version.txt is used by version command
+    it.from(projectDir) {
+        it.include 'version.txt'
+    }
     it.exclude {
         File file = it.file
         String filename = file.getName()

buildSrc/src/main/java/ZWindowsStartScriptGenerator.java

@@ -1,6 +1,6 @@
 /*
  * ZomboidDoc - Lua library compiler for Project Zomboid
- * Copyright (C) 2021 Matthew Cain
+ * Copyright (C) 2020-2021 Matthew Cain
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package io.yooksi.pz.zdoc;
+package io.cocolabs.pz.zdoc;
 
 import java.io.File;
 import java.io.IOException;

distribution.gradle

@@ -1,6 +1,6 @@
 /*
  * ZomboidDoc - Lua library compiler for Project Zomboid
- * Copyright (C) 2021 Matthew Cain
+ * Copyright (C) 2020-2021 Matthew Cain
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -15,13 +15,13 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package io.yooksi.pz.zdoc;
+package io.cocolabs.pz.zdoc;
 
 import java.util.List;
 
 import org.jetbrains.annotations.TestOnly;
 
-import io.yooksi.pz.zdoc.cmd.Command;
+import io.cocolabs.pz.zdoc.cmd.Command;
 
 class MainTest extends TestWorkspace implements IntegrationTest {
 

src/intTest/java/io/yooksi/pz/zdoc/IntegrationTest.java src/intTest/java/io/cocolabs/pz/zdoc/IntegrationTest.java

@@ -1,6 +1,6 @@
 /*
  * ZomboidDoc - Lua library compiler for Project Zomboid
- * Copyright (C) 2021 Matthew Cain
+ * Copyright (C) 2020-2021 Matthew Cain
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package io.yooksi.pz.zdoc.compile;
+package io.cocolabs.pz.zdoc.compile;
 
 import java.io.File;
 import java.io.IOException;
@@ -30,7 +30,7 @@
 import org.junit.jupiter.api.Test;
 import org.opentest4j.AssertionFailedError;
 
-import io.yooksi.pz.zdoc.IntegrationTest;
+import io.cocolabs.pz.zdoc.IntegrationTest;
 
 class JavaCompilerIntTest implements IntegrationTest {
 

src/intTest/java/io/yooksi/pz/zdoc/MainTest.java src/intTest/java/io/cocolabs/pz/zdoc/MainTest.java

@@ -15,41 +15,40 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package io.yooksi.pz.zdoc;
+package io.cocolabs.pz.zdoc;
 
 import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.IOException;
-import java.nio.charset.Charset;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.*;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 import org.apache.commons.cli.ParseException;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.reflect.MethodUtils;
 
-import io.yooksi.pz.zdoc.cmd.Command;
-import io.yooksi.pz.zdoc.cmd.CommandLine;
-import io.yooksi.pz.zdoc.compile.CompilerException;
-import io.yooksi.pz.zdoc.compile.JavaCompiler;
-import io.yooksi.pz.zdoc.compile.LuaAnnotator;
-import io.yooksi.pz.zdoc.compile.LuaCompiler;
-import io.yooksi.pz.zdoc.doc.ZomboidJavaDoc;
-import io.yooksi.pz.zdoc.doc.ZomboidLuaDoc;
-import io.yooksi.pz.zdoc.element.lua.LuaClass;
-import io.yooksi.pz.zdoc.logger.Logger;
-import io.yooksi.pz.zdoc.util.Utils;
-
-import static io.yooksi.pz.zdoc.compile.LuaAnnotator.AnnotateResult;
-import static io.yooksi.pz.zdoc.compile.LuaAnnotator.AnnotateRules;
+import io.cocolabs.pz.zdoc.cmd.Command;
+import io.cocolabs.pz.zdoc.cmd.CommandLine;
+import io.cocolabs.pz.zdoc.compile.CompilerException;
+import io.cocolabs.pz.zdoc.compile.JavaCompiler;
+import io.cocolabs.pz.zdoc.compile.LuaAnnotator;
+import io.cocolabs.pz.zdoc.compile.LuaCompiler;
+import io.cocolabs.pz.zdoc.doc.ZomboidJavaDoc;
+import io.cocolabs.pz.zdoc.doc.ZomboidLuaDoc;
+import io.cocolabs.pz.zdoc.element.lua.LuaClass;
+import io.cocolabs.pz.zdoc.logger.Logger;
+import io.cocolabs.pz.zdoc.util.Utils;
 
 public class Main {
 
-	public static final String CHARSET = Charset.defaultCharset().name();
+	public static final String CHARSET = StandardCharsets.UTF_8.name();
 	public static final ClassLoader CLASS_LOADER = Main.class.getClassLoader();
 
 	/**
@@ -79,13 +78,32 @@ else if (command == Command.HELP)
 		else if (command == Command.VERSION)
 		{
 			try {
+				/* first try to find version file project root directory,
+				 * available when we are not running from a jar
+				 */
+				String zdocVersion;
+				File versionFile = new File("version.txt");
+				if (!versionFile.exists())
+				{
+					try (InputStream iStream = CLASS_LOADER.getResourceAsStream("version.txt"))
+					{
+						if (iStream == null) {
+							throw new FileNotFoundException("Unable to read version, missing version.txt");
+						}
+						zdocVersion = iStream.toString();
+					}
+				}
+				else zdocVersion = FileUtils.readFileToString(versionFile, CHARSET);
+				Logger.info("zdoc version " + zdocVersion);
+
 				Class<?> coreClass = Utils.getClassForName("zombie.core.Core");
 				Object core = MethodUtils.invokeStaticMethod(coreClass, "getInstance");
 
 				Object gameVersion = MethodUtils.invokeExactMethod(core, "getGameVersion");
 				Object sGameVersion = MethodUtils.invokeExactMethod(gameVersion, "toString");
 
 				Logger.info("game version " + sGameVersion);
+				return;
 			}
 			catch (ReflectiveOperationException e) {
 				throw new RuntimeException(e);
@@ -98,10 +116,11 @@ else if (command == Command.VERSION)
 			Logger.debug("Preparing to parse and document lua files...");
 
 			Path root = cmdLine.getInputPath();
+			List<Path> paths;
 			Path dir = cmdLine.getOutputPath();
-			List<Path> paths = Files.walk(Paths.get(root.toString()))
-					.filter(Files::isRegularFile).collect(Collectors.toCollection(ArrayList::new));
-
+			try (Stream<Path> stream = Files.walk(Paths.get(root.toString()))) {
+				paths = stream.filter(Files::isRegularFile).collect(Collectors.toCollection(ArrayList::new));
+			}
 			if (paths.size() > 1) {
 				Logger.info("Parsing and documenting lua files found in " + root);
 			}
@@ -145,8 +164,8 @@ else if (dir != null)
 					String fileName = path.getFileName().toString();
 					List<String> content = new ArrayList<>();
 
-					AnnotateRules rules = new AnnotateRules(properties, exclude);
-					AnnotateResult result = LuaAnnotator.annotate(path.toFile(), content, rules);
+					LuaAnnotator.AnnotateRules rules = new LuaAnnotator.AnnotateRules(properties, exclude);
+					LuaAnnotator.AnnotateResult result = LuaAnnotator.annotate(path.toFile(), content, rules);
 
 					String addendum = outputFile.exists() ? " and overwriting" : "";
 					Logger.debug(String.format("Annotating%s file %s...", addendum, fileName));

src/intTest/java/io/yooksi/pz/zdoc/compile/JavaCompilerIntTest.java src/intTest/java/io/cocolabs/pz/zdoc/compile/JavaCompilerIntTest.java

@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package io.yooksi.pz.zdoc.cmd;
+package io.cocolabs.pz.zdoc.cmd;
 
 import java.util.Arrays;
 import java.util.stream.Collectors;
@@ -28,6 +28,7 @@
 /**
  * All available application commands.
  */
+@SuppressWarnings("ImmutableEnumChecker")
 public enum Command {
 
 	HELP("help", "", new Options(), "print command usage info"),
@@ -68,7 +69,7 @@ public enum Command {
 		this(name, HelpFormatter.DEFAULT_OPT_PREFIX, options, help);
 	}
 
-	/** @return {@code Command} that matches the given name. */
+	/** Returns command that matches the given name. */
 	public static @Nullable Command get(String name) {
 
 		for (Command value : Command.values())
@@ -81,8 +82,9 @@ public enum Command {
 	}
 
 	/**
-	 * @return {@code Command} that matches first element in the given
-	 * 		array of arguments or {@code null} if no matching command was found.
+	 * Returns command that matches first array element.
+	 *
+	 * @return first array element or {@code null} if no matching command was found.
 	 *
 	 * @throws IllegalArgumentException if argument array is empty.
 	 */
@@ -95,10 +97,13 @@ public enum Command {
 	}
 
 	/**
-	 * @return {@code Command} that matches first element in the given
-	 * 		array of arguments or {@code null} if no matching command was found.
+	 * Returns command that matches first array element.
+	 *
+	 * @param fromIndex index to reference the first element from.
+	 * @return first array element or {@code null} if no matching command was found.
 	 *
 	 * @throws IllegalArgumentException if argument array is empty.
+	 * @see #parse(String[])
 	 */
 	public static @Nullable Command parse(String[] args, int fromIndex) {