rife2/bld-generated-version
rife2/bld-generated-version
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improved buildTemplate and writeTemplate

Browse source
This commit is contained in:
Erik C. Thauvin 2023-04-28 10:27:18 -07:00
parent ecfde209af
commit 66f1ac9218
3 changed files with 64 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

45
src/main/java/rife/bld/extension/GeneratedVersionOperation.java
View file

@ -21,11 +21,12 @@ import rife.bld.BaseProject;
import rife.bld.operations.AbstractOperation;
import rife.resources.ResourceFinderDirectories;
import rife.template.Template;
import rife.template.TemplateConfig;
import rife.template.TemplateFactory;
import rife.tools.FileUtils;
import rife.tools.exceptions.FileUtilsErrorException;
import java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import java.util.Objects;
import java.util.logging.Level;
@ -60,7 +61,8 @@ public class GeneratedVersionOperation extends AbstractOperation<GeneratedVersio
template = TemplateFactory.TXT.get("version.txt");
} else {
var files = new ResourceFinderDirectories(new File[]{gv.getTemplate().getParentFile()});
template = TemplateFactory.TXT.setResourceFinder(files).get(gv.getTemplate().getName());
template = new TemplateFactory(TemplateConfig.TXT, "txtFiles", TemplateFactory.TXT)
.setResourceFinder(files).get(gv.getTemplate().getName());
}
if (gv.getPackageName() == null) {
@ -110,27 +112,32 @@ public class GeneratedVersionOperation extends AbstractOperation<GeneratedVersio
return template;
}
public static void writeTemplate(Template template, GeneratedVersion gv) {
Path generatedVersionPath;
public static void writeTemplate(Template template, File directory, GeneratedVersion gv) {
if (gv.getPackageName() != null) {
generatedVersionPath = Path.of(gv.getProject().srcMainJavaDirectory().getAbsolutePath(),
gv.getPackageName().replace(".", File.separator), gv.getClassName());
gv.setClassFile(Path.of(directory.getAbsolutePath(),
gv.getPackageName().replace(".", File.separator), gv.getClassName() + ".java").toFile());
} else {
generatedVersionPath = Path.of(gv.getProject().srcMainJavaDirectory().getAbsolutePath(),
gv.getClassName());
gv.setClassFile(Path.of(directory.getAbsolutePath(), gv.getClassName() + ".java").toFile());
}
if (generatedVersionPath.getParent().toFile().mkdirs()) {
try {
FileUtils.writeString(template.getContent(), generatedVersionPath.toFile());
} catch (FileUtilsErrorException e) {
if (LOGGER.isLoggable(Level.SEVERE)) {
LOGGER.log(Level.SEVERE, "Unable to write the version class file.", e);
}
if (!gv.getClassFile().getParentFile().exists()) {
var mkdirs = gv.getClassFile().getParentFile().mkdirs();
if (!mkdirs && !gv.getClassFile().getParentFile().exists() && LOGGER.isLoggable(Level.SEVERE)) {
LOGGER.log(Level.SEVERE, "Could not create project package directories: {0}",
gv.getClassFile().getParent());
}
} else {
}
try {
var updated = gv.getClassFile().exists();
FileUtils.writeString(template.getContent(), gv.getClassFile());
if (LOGGER.isLoggable(Level.INFO)) {
LOGGER.log(Level.INFO, "Generated version class has been {0}: {1}",
new String[]{updated ? "updated" : "created", gv.getClassFile().toString()});
}
} catch (IOException e) {
if (LOGGER.isLoggable(Level.SEVERE)) {
LOGGER.severe("Could not create project package directories.");
LOGGER.log(Level.SEVERE, "Unable to write the version class file.", e);
}
}
}
@ -152,13 +159,13 @@ public class GeneratedVersionOperation extends AbstractOperation<GeneratedVersio
}
@Override
public void execute() throws Exception {
public void execute() {
if (generatedVersion.getProject() == null && LOGGER.isLoggable(Level.SEVERE)) {
LOGGER.severe("A project must be specified.");
}
var template = buildTemplate(generatedVersion);
writeTemplate(template, generatedVersion);
writeTemplate(template, generatedVersion.getProject().srcMainJavaDirectory(), generatedVersion);
}
/**

2
src/main/resources/templates/version.txt
View file

@ -12,7 +12,7 @@ import java.util.Date;
*/
public final class {{v className/}} {
public static final String PROJECT = "{{v project/}}";
public static final Date BUILDDATE = new Date({{v epoch/}}L);
public static final Date BUILD_DATE = new Date({{v epoch/}}L);
public static final int MAJOR = {{v major/}};
public static final int MINOR = {{v minor/}};
public static final int REVISION = {{v revision/}};

39
src/test/java/rife/bld/extension/GeneratedVersionTest.java
View file

@ -18,10 +18,14 @@ package rife.bld.extension;
import org.junit.jupiter.api.Test;
import rife.bld.BaseProject;
import rife.bld.WebProject;
import rife.bld.Project;
import rife.bld.dependencies.VersionNumber;
import rife.tools.FileUtils;
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.util.Objects;
import static org.assertj.core.api.Assertions.assertThat;
@ -32,7 +36,7 @@ import static org.assertj.core.api.Assertions.assertThat;
* @since 1.0
*/
class GeneratedVersionTest {
private final BaseProject PROJECT = new WebProject() {
private final BaseProject PROJECT = new Project() {
@Override
public String pkg() {
return "com.example";
@ -49,6 +53,17 @@ class GeneratedVersionTest {
}
};
static void deleteOnExit(File folder) {
folder.deleteOnExit();
for (var f : Objects.requireNonNull(folder.listFiles())) {
if (f.isDirectory()) {
deleteOnExit(f);
} else {
f.deleteOnExit();
}
}
}
@Test
void buildTemplateCustomTest() {
var gv = new GeneratedVersion();
@ -82,4 +97,24 @@ class GeneratedVersionTest {
.contains("REVISION = 3").contains("QUALIFIER = \"\"").contains("VERSION = \"2.1.3\"")
.contains("private GeneratedVersion");
}
@Test
void testWriteTemplate() throws IOException {
var gv = new GeneratedVersion();
gv.setProject(PROJECT);
var t = GeneratedVersionOperation.buildTemplate(gv);
var tmpDir = Files.createTempDirectory("bldGeneratedVersion").toFile();
GeneratedVersionOperation.writeTemplate(t, tmpDir, gv);
assertThat(gv.getClassFile()).exists();
deleteOnExit(tmpDir);
var versionClass = FileUtils.readString(gv.getClassFile());
assertThat(versionClass).contains("package com.example;").contains("class GeneratedVersion")
.contains("MAJOR = 2").contains("MINOR = 1").contains("REVISION = 3")
.contains("private GeneratedVersion");
}
}