Skip to content

Add groupId and artifactId to UI including validation (partly #274, #149, #150) #292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
m-reza-rahman merged 1 commit into from
May 14, 2024
Merged

Add groupId and artifactId to UI including validation (partly #274, #149, #150) #292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 36 additions & 11 deletions ui/src/main/java/org/eclipse/starter/ui/Project.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ public class Project implements Serializable {
entry("open-liberty", "Open Liberty"), entry("payara", "Payara"), entry("tomee", "TomEE"),
entry("wildfly", "WildFly"));

private static final String DEFAULT_GROUPID = "org.eclipse";;

private static final String DEFAULT_ARTIFACTID = "jakartaee-hello-world";

private static Map<String, String> cache = new ConcurrentHashMap<>();

@Inject
Expand All @@ -57,14 +61,18 @@ public class Project implements Serializable {
private Map<String, SelectItem> runtimes = new LinkedHashMap<>();
private String runtime = "none";

private String groupId = DEFAULT_GROUPID;

private String artifactId = DEFAULT_ARTIFACTID;

public Project() {
jakartaVersions.put("10", new SelectItem("10", "Jakarta EE 10"));
jakartaVersions.put("9.1", new SelectItem("9.1", "Jakarta EE 9.1"));
jakartaVersions.put("9", new SelectItem("9", "Jakarta EE 9"));
jakartaVersions.put("8", new SelectItem("8", "Jakarta EE 8"));

profiles.put("full", new SelectItem("full", "Platform"));
profiles.put("web", new SelectItem("web", "Web Profile"));
profiles.put("web", new SelectItem("web", "Web Profile"));
profiles.put("core", new SelectItem("core", "Core Profile"));

javaVersions.put("17", new SelectItem("17", "Java SE 17"));
Expand Down Expand Up @@ -143,6 +151,14 @@ public void setRuntime(String runtime) {
this.runtime = runtime;
}

public String getGroupId() { return groupId; }

public void setGroupId(String groupId) { this.groupId = groupId; }

public String getArtifactId() { return artifactId; }

public void setArtifactId(String artifactId) { this.artifactId = artifactId; }

public void onJakartaVersionChange() {
LOGGER.log(Level.INFO,
"Validating form for Jakarta EE version: {0}, Jakarta EE profile: {1}, Java SE version: {2}, Docker: {3}, runtime: {4}",
Expand Down Expand Up @@ -323,8 +339,8 @@ public void onRuntimeChange() {
public void generate() {
try {
LOGGER.log(Level.INFO,
"Generating project - Jakarta EE version: {0}, Jakarta EE profile: {1}, Java SE version: {2}, Docker: {3}, runtime: {4}",
new Object[] { jakartaVersion, profile, javaVersion, docker, runtime });
"Generating project - Jakarta EE version: {0}, Jakarta EE profile: {1}, Java SE version: {2}, Docker: {3}, runtime: {4}, groupId: {5}, artifactId: {6}",
new Object[]{jakartaVersion, profile, javaVersion, docker, runtime, groupId, artifactId});

String cachedDirectory = cache.get(getCacheKey());

Expand All @@ -338,25 +354,34 @@ public void generate() {
entry("jakartaVersion",
((jakartaVersion % 1.0 != 0) ? String.format("%s", jakartaVersion)
: String.format("%.0f", jakartaVersion))),
entry("profile", profile), entry("javaVersion", javaVersion),
entry("docker", (docker ? "yes" : "no")), entry("runtime", runtime)));
entry("profile", profile),
entry("javaVersion", javaVersion),
entry("docker", (docker ? "yes" : "no")),
entry("runtime", runtime),
entry("groupId", groupId),
entry("artifactId", artifactId),
entry("package", groupId)));

MavenUtility.invokeMavenArchetype("org.eclipse.starter", "jakarta-starter", VersionInfo.ARCHETYPE_VERSION,
properties, workingDirectory);

LOGGER.info("Creating zip file.");
ZipUtility.zipDirectory(new File(workingDirectory, "jakartaee-hello-world"), workingDirectory);
ZipUtility.zipDirectory(new File(workingDirectory, artifactId), workingDirectory);

LOGGER.info("Downloading zip file.");
downloadZip(new File(workingDirectory, "jakartaee-hello-world.zip"));
downloadZip(new File(workingDirectory, artifactId + ".zip"));

// caching makes only sense if defaults weren't changed since otherwise it's unlikely to hit cache
if (groupId.equals(DEFAULT_GROUPID) && artifactId.equals(DEFAULT_ARTIFACTID)) {
LOGGER.info("Caching output.");
cache.put(getCacheKey(), workingDirectory.getAbsolutePath());
}

LOGGER.info("Caching output.");
cache.put(getCacheKey(), workingDirectory.getAbsolutePath());
workingDirectory.deleteOnExit();
} else {
LOGGER.log(Level.INFO, "Downloading zip file from cached directory: {0}",
new Object[] { cachedDirectory });
downloadZip(new File(cachedDirectory, "jakartaee-hello-world.zip"));
downloadZip(new File(cachedDirectory, artifactId + ".zip"));
}

facesContext.responseComplete();
Expand All @@ -377,7 +402,7 @@ private void downloadZip(File zip) {
externalContext.setResponseContentType("application/zip");
externalContext.setResponseContentLength((int) zip.length());
externalContext.setResponseHeader("Content-Disposition",
"attachment; filename=\"jakartaee-hello-world.zip\"");
"attachment; filename=\"" + zip.getName() + "\"");

Files.copy(zip.toPath(), externalContext.getResponseOutputStream());
} catch (IOException e) {
Expand Down
10 changes: 10 additions & 0 deletions ui/src/main/webapp/WEB-INF/template.xhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@
.ui-panelgrid .ui-panelgrid-footer.ui-widget-header {
text-align: center;
}

.input-container {
display: flex;
justify-content: space-between;
}

.input-container .input-field {
flex-grow: 1;
margin-right: 10px;
}
</h:outputStylesheet>

<title>Eclipse Starter for Jakarta EE</title>
Expand Down
30 changes: 22 additions & 8 deletions ui/src/main/webapp/index.xhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,11 @@
</p>
<div class="card">
<h:form>
<p:messages id="msg"/>
<p:panelGrid
columnClasses="ui-grid-col-3, ui-grid-col-9"
columns="2" layout="grid" styleClass="text-align-left">

<p:row>
<p:column colspan="2">
<p:messages/>
</p:column>
</p:row>

<p:outputLabel for="@next" value="Jakarta EE version" />
<p:column>
<p:selectOneRadio required="true" value="#{project.jakartaVersion}" columns="3" layout="responsive">
Expand Down Expand Up @@ -85,12 +80,31 @@
<h:outputText styleClass="footnote" value="Docker support requires a runtime other than GlassFish."/>
</p:column>

<p:outputLabel for="@next" value="Group / Artifact"/>
<p:column>
<p:outputPanel class="input-container">
<p:inputText required="true" styleClass="input-field" value="#{project.groupId}"
requiredMessage="Group has to be provided"
validatorMessage="Group has to satisfy java package naming convention">
<!-- groupId satisfies java package naming which must start with a letter followes by any number of letters, digits or underscore and then any number of similar parts separated by dot -->
<f:validateRegex pattern="^[a-zA-Z][a-zA-Z0-9_]*(\.[a-zA-Z][a-zA-Z0-9_]*)*$"/>
<p:ajax event="change" update="@this,msg"/>
</p:inputText>
<p:inputText required="true" styleClass="input-field" value="#{project.artifactId}"
requiredMessage="Artifact has to be provided"
validatorMessage="Artifact has to satisfy jar naming convention">
<!-- artifactId must start with a letter and then contain any number of letters, digits or underscore -->
<f:validateRegex pattern="^[a-zA-Z][a-zA-Z0-9_-]*$"/>
<p:ajax event="change" update="@this,msg"/>
</p:inputText>
</p:outputPanel>
</p:column>

<f:facet name="footer">
<p:commandButton value="Generate" ajax="false"
styleClass="generate-button"
icon="pi pi-arrow-down"
action="#{project.generate}">
</p:commandButton>
action="#{project.generate}"/>
</f:facet>

</p:panelGrid>
Expand Down