commit c103a85140dbeb3c19996b4cca9b6d49905675f0 Author: Erik C. Thauvin Date: Thu Apr 27 22:36:49 2023 -0700 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a63b224 --- /dev/null +++ b/.gitignore @@ -0,0 +1,55 @@ +.gradle +.DS_Store +build +lib/bld/** +lib/compile/** +lib/runtime/** +lib/standalone/** +lib/test/** +!bld-wrapper.jar +!bld-wrapper.properties + +# IDEA ignores + +# User-specific +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Editor-based Rest Client +.idea/httpRequests \ No newline at end of file diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..26d3352 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,3 @@ +# Default ignored files +/shelf/ +/workspace.xml diff --git a/.idea/app.iml b/.idea/app.iml new file mode 100644 index 0000000..787b59b --- /dev/null +++ b/.idea/app.iml @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/bld.iml b/.idea/bld.iml new file mode 100644 index 0000000..e63e11e --- /dev/null +++ b/.idea/bld.iml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml new file mode 100644 index 0000000..d91f848 --- /dev/null +++ b/.idea/codeStyles/codeStyleConfig.xml @@ -0,0 +1,5 @@ + + + + \ No newline at end of file diff --git a/.idea/copyright/Apache_License.xml b/.idea/copyright/Apache_License.xml new file mode 100644 index 0000000..206aa7d --- /dev/null +++ b/.idea/copyright/Apache_License.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/copyright/profiles_settings.xml b/.idea/copyright/profiles_settings.xml new file mode 100644 index 0000000..f2907f1 --- /dev/null +++ b/.idea/copyright/profiles_settings.xml @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml new file mode 100644 index 0000000..1e01b48 --- /dev/null +++ b/.idea/inspectionProfiles/Project_Default.xml @@ -0,0 +1,8 @@ + + + + \ No newline at end of file diff --git a/.idea/libraries/bld.xml b/.idea/libraries/bld.xml new file mode 100644 index 0000000..7596927 --- /dev/null +++ b/.idea/libraries/bld.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/libraries/compile.xml b/.idea/libraries/compile.xml new file mode 100644 index 0000000..9bd86aa --- /dev/null +++ b/.idea/libraries/compile.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/libraries/runtime.xml b/.idea/libraries/runtime.xml new file mode 100644 index 0000000..2ae5c4b --- /dev/null +++ b/.idea/libraries/runtime.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/libraries/test.xml b/.idea/libraries/test.xml new file mode 100644 index 0000000..b80486a --- /dev/null +++ b/.idea/libraries/test.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..f0c7aa1 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..55adcb9 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/.idea/runConfigurations/Run Tests.xml b/.idea/runConfigurations/Run Tests.xml new file mode 100644 index 0000000..176e92e --- /dev/null +++ b/.idea/runConfigurations/Run Tests.xml @@ -0,0 +1,9 @@ + + + + \ No newline at end of file diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..c3fbf4e --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,11 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "type": "java", + "name": "Run Tests", + "request": "launch", + "mainClass": "rife.bld.extension.GeneratedVersionOperationTest" + } + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..4fdc74b --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,15 @@ +{ + "java.project.sourcePaths": [ + "src/main/java", + "src/main/resources", + "src/test/java", + "src/bld/java" + ], + "java.configuration.updateBuildConfiguration": "automatic", + "java.project.referencedLibraries": [ + "${HOME}/.rife2/dist/rife2-1.6.1.jar", + "lib/compile/*.jar", + "lib/runtime/*.jar", + "lib/test/*.jar" + ] +} diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..23f75ac --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + https://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/README.md b/README.md new file mode 100755 index 0000000..6b81d9c --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# TBD \ No newline at end of file diff --git a/bld b/bld new file mode 100755 index 0000000..fb37b6d --- /dev/null +++ b/bld @@ -0,0 +1,2 @@ +#!/usr/bin/env sh +java -jar "$(dirname "$0")/lib/bld/bld-wrapper.jar" "$0" --build rife.bld.extension.GeneratedVersionOperationBuild "$@" \ No newline at end of file diff --git a/bld.bat b/bld.bat new file mode 100644 index 0000000..7ae3588 --- /dev/null +++ b/bld.bat @@ -0,0 +1,4 @@ +@echo off +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +java -jar "%DIRNAME%/lib/bld/bld-wrapper.jar" "%0" --build rife.bld.extension.GeneratedVersionOperationBuild %* \ No newline at end of file diff --git a/config/pmd.xml b/config/pmd.xml new file mode 100644 index 0000000..1039e40 --- /dev/null +++ b/config/pmd.xml @@ -0,0 +1,110 @@ + + + Erik's Ruleset + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/lib/bld/bld-wrapper.jar b/lib/bld/bld-wrapper.jar new file mode 100644 index 0000000..f3a38ad Binary files /dev/null and b/lib/bld/bld-wrapper.jar differ diff --git a/lib/bld/bld-wrapper.properties b/lib/bld/bld-wrapper.properties new file mode 100644 index 0000000..c17ed38 --- /dev/null +++ b/lib/bld/bld-wrapper.properties @@ -0,0 +1,6 @@ +bld.downloadExtensionJavadoc=false +bld.downloadExtensionSources=true +bld.extension-pmd=com.uwyn.rife2:bld-pmd:0.9.1-SNAPSHOT +bld.repositories=MAVEN_LOCAL,MAVEN_CENTRAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES +rife2.downloadLocation= +rife2.version=1.6.1 \ No newline at end of file diff --git a/src/bld/java/rife/bld/extension/GeneratedVersionOperationBuild.java b/src/bld/java/rife/bld/extension/GeneratedVersionOperationBuild.java new file mode 100644 index 0000000..e4500de --- /dev/null +++ b/src/bld/java/rife/bld/extension/GeneratedVersionOperationBuild.java @@ -0,0 +1,44 @@ +package rife.bld.extension; + +import rife.bld.BaseProject; +import rife.bld.BuildCommand; + +import java.util.List; + +import static rife.bld.dependencies.Repository.MAVEN_CENTRAL; +import static rife.bld.dependencies.Repository.RIFE2_RELEASES; +import static rife.bld.dependencies.Scope.compile; +import static rife.bld.dependencies.Scope.test; + +public class GeneratedVersionOperationBuild extends BaseProject { + public GeneratedVersionOperationBuild() { + pkg = "rife.bld.extension"; + name = "GeneratedVersionOperation"; + version = version(0, 9, 0, "SNAPSHOT"); + + javaRelease = 17; + downloadSources = true; + autoDownloadPurge = true; + repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES); + + scope(compile) + .include(dependency("com.uwyn.rife2", "rife2", version(1, 5, 22))); + scope(test) + .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 9, 2))) + .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 9, 2))) + .include(dependency("org.assertj:assertj-joda-time:2.2.0")); + } + + public static void main(String[] args) { + new GeneratedVersionOperationBuild().start(args); + } + + @BuildCommand(summary = "Runs PMD analysis") + public void pmd() throws Exception { + new PmdOperation() + .fromProject(this) + .failOnViolation(true) + .ruleSets("config/pmd.xml") + .execute(); + } +} \ No newline at end of file diff --git a/src/main/java/rife/bld/extension/GeneratedVersion.java b/src/main/java/rife/bld/extension/GeneratedVersion.java new file mode 100644 index 0000000..5662d5b --- /dev/null +++ b/src/main/java/rife/bld/extension/GeneratedVersion.java @@ -0,0 +1,76 @@ +/* + * Copyright 2023 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package rife.bld.extension; + +import rife.bld.BaseProject; + +import java.io.File; + +/** + * GeneratedVersion data class. + * + * @author Erik C. Thauvin + * @since 1.0 + */ +@SuppressWarnings("PMD.DataClass") +public class GeneratedVersion { + private String className; + private String packageName; + private BaseProject project; + private String projectName; + private File template; + + public String getClassName() { + return className; + } + + public String getPackageName() { + return packageName; + } + + public BaseProject getProject() { + return project; + } + + public String getProjectName() { + return projectName; + } + + public File getTemplate() { + return template; + } + + public void setClassName(String className) { + this.className = className; + } + + public void setPackageName(String packageName) { + this.packageName = packageName; + } + + public void setProject(BaseProject project) { + this.project = project; + } + + public void setProjectName(String projectName) { + this.projectName = projectName; + } + + public void setTemplate(File template) { + this.template = template; + } +} diff --git a/src/main/java/rife/bld/extension/GeneratedVersionOperation.java b/src/main/java/rife/bld/extension/GeneratedVersionOperation.java new file mode 100644 index 0000000..c779cc0 --- /dev/null +++ b/src/main/java/rife/bld/extension/GeneratedVersionOperation.java @@ -0,0 +1,187 @@ +/* + * Copyright 2023 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package rife.bld.extension; + + +import rife.bld.BaseProject; +import rife.bld.operations.AbstractOperation; +import rife.resources.ResourceFinderDirectories; +import rife.template.Template; +import rife.template.TemplateFactory; +import rife.tools.FileUtils; +import rife.tools.exceptions.FileUtilsErrorException; + +import java.io.File; +import java.nio.file.Path; +import java.util.Objects; +import java.util.logging.Level; +import java.util.logging.Logger; + +/** + * Implements the GeneratedVersionOperation class. + * + * @author Erik C. Thauvin + * @since 1.0 + */ +public class GeneratedVersionOperation extends AbstractOperation { + private static final String CLASSNAME = "className"; + private static final String EPOCH = "epoch"; + private static final Logger LOGGER = Logger.getLogger(GeneratedVersionOperation.class.getName()); + private static final String MAJOR = "major"; + private static final String MINOR = "minor"; + private static final String PACKAGE_NAME = "packageName"; + private static final String PROJECT = "project"; + private static final String QUALIFIER = "qualifier"; + private static final String REVISION = "revision"; + private static final String VERSION = "version"; + private final GeneratedVersion generatedVersion = new GeneratedVersion(); + + /** + * Builds the template based on the {@link GeneratedVersion} data. + */ + public static Template buildTemplate(GeneratedVersion gv) { + Template template; + var version = gv.getProject().version(); + if (gv.getTemplate() == null) { + 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()); + } + + if (gv.getPackageName() == null) { + gv.setPackageName(gv.getProject().pkg()); + } + + if (template.hasValueId(PACKAGE_NAME)) { + template.setValue(PACKAGE_NAME, gv.getPackageName()); + } + + gv.setClassName(Objects.requireNonNullElse(gv.getClassName(), "GeneratedVersion")); + if (template.hasValueId(CLASSNAME)) { + template.setValue(CLASSNAME, gv.getClassName()); + } + + if (template.hasValueId(PROJECT)) { + if (gv.getProjectName() == null) { + gv.setProjectName(gv.getProject().name()); + } + template.setValue(PROJECT, gv.getProjectName()); + } + + if (template.hasValueId(EPOCH)) { + template.setValue(EPOCH, System.currentTimeMillis()); + } + + if (template.hasValueId(VERSION)) { + template.setValue(VERSION, version.toString()); + } + + if (template.hasValueId(MAJOR)) { + template.setValue(MAJOR, version.majorInt()); + } + + if (template.hasValueId(MINOR)) { + template.setValue(MINOR, version.minorInt()); + } + + if (template.hasValueId(REVISION)) { + template.setValue(REVISION, version.revisionInt()); + } + + if (template.hasValueId(QUALIFIER)) { + template.setValue(QUALIFIER, version.qualifier()); + } + + return template; + } + + public static void writeTemplate(Template template, GeneratedVersion gv) { + Path generatedVersionPath; + if (gv.getPackageName() != null) { + generatedVersionPath = Path.of(gv.getProject().srcMainJavaDirectory().getAbsolutePath(), + gv.getPackageName().replace(".", File.separator), gv.getClassName()); + } else { + generatedVersionPath = Path.of(gv.getProject().srcMainJavaDirectory().getAbsolutePath(), + gv.getClassName()); + } + + 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); + } + } + } else { + if (LOGGER.isLoggable(Level.SEVERE)) { + LOGGER.severe("Could not create project package directories."); + } + } + } + + /** + * Sets the class name. + */ + public GeneratedVersionOperation className(String className) { + generatedVersion.setClassName(className); + return this; + } + + /** + * Sets the class template path + */ + public GeneratedVersionOperation classTemplate(File template) { + generatedVersion.setTemplate(template); + return this; + } + + @Override + public void execute() throws Exception { + if (generatedVersion.getProject() == null && LOGGER.isLoggable(Level.SEVERE)) { + LOGGER.severe("A project must be specified."); + } + + var template = buildTemplate(generatedVersion); + writeTemplate(template, generatedVersion); + } + + /** + * Sets the project name. + */ + public GeneratedVersionOperation fromProject(BaseProject project) { + generatedVersion.setProject(project); + return this; + } + + /** + * Sets the package name. + */ + public GeneratedVersionOperation packageName(String packageName) { + generatedVersion.setPackageName(packageName); + return this; + } + + /** + * Sets the project name. + */ + public GeneratedVersionOperation projectName(String projectName) { + generatedVersion.setPackageName(projectName); + return this; + } +} \ No newline at end of file diff --git a/src/main/resources/templates/version.txt b/src/main/resources/templates/version.txt new file mode 100644 index 0000000..52f1d84 --- /dev/null +++ b/src/main/resources/templates/version.txt @@ -0,0 +1,28 @@ +/* + * This file is automatically generated. + * Do not modify! -- ALL CHANGES WILL BE ERASED! + */ + +package {{v packageName/}}; + +import java.util.Date; + +/** + * Provides project version information. + */ +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 int MAJOR = {{v major/}}; + public static final int MINOR = {{v minor/}}; + public static final int REVISION = {{v revision/}}; + public static final String QUALIFIER = "{{v qualifier/}}"; + public static final String VERSION = "{{v version/}}"; + + /** + * Disables the default constructor. + */ + private {{v className/}}() { + throw new UnsupportedOperationException("Illegal constructor call."); + } +} diff --git a/src/test/java/rife/bld/extension/GeneratedVersionTest.java b/src/test/java/rife/bld/extension/GeneratedVersionTest.java new file mode 100644 index 0000000..67a11cb --- /dev/null +++ b/src/test/java/rife/bld/extension/GeneratedVersionTest.java @@ -0,0 +1,85 @@ +/* + * Copyright 2023 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package rife.bld.extension; + +import org.junit.jupiter.api.Test; +import rife.bld.BaseProject; +import rife.bld.WebProject; +import rife.bld.dependencies.VersionNumber; + +import java.io.File; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Implements the GeneratedVersionTest class. + * + * @author Erik C. Thauvin + * @since 1.0 + */ +class GeneratedVersionTest { + private final BaseProject PROJECT = new WebProject() { + @Override + public String pkg() { + return "com.example"; + } + + @Override + public String name() { + return "MyExample"; + } + + @Override + public VersionNumber version() { + return new VersionNumber(2, 1, 3); + } + }; + + @Test + void buildTemplateCustomTest() { + var gv = new GeneratedVersion(); + gv.setProject(PROJECT); + gv.setTemplate(new File(gv.getProject().srcTestResourcesDirectory().getAbsolutePath(), + "version_test.txt")); + gv.setPackageName("com.example.my"); + gv.setClassName("MyVersion"); + + var t = GeneratedVersionOperation.buildTemplate(gv); + + assertThat(t.getContent()).contains("package com.example.my;").contains("class MyVersion") + .contains("MAJOR = 2").contains("MINOR = 1").contains("REVISION = 3").contains("QUALIFIER = \"\"") + .contains("private MyVersion"); + } + + @Test + void testBuildTemplate() { + var gv = new GeneratedVersion(); + gv.setProject(PROJECT); + var t = GeneratedVersionOperation.buildTemplate(gv); + + assertThat(t).isNotNull(); + + assertThat(gv.getProject()).isEqualTo(PROJECT); + assertThat(gv.getPackageName()).isEqualTo(PROJECT.pkg()); + assertThat(gv.getProjectName()).isEqualTo(PROJECT.name()); + + assertThat(t.getContent()).contains("package com.example;").contains("class GeneratedVersion") + .contains("PROJECT = \"MyExample\";").contains("MAJOR = 2").contains("MINOR = 1") + .contains("REVISION = 3").contains("QUALIFIER = \"\"").contains("VERSION = \"2.1.3\"") + .contains("private GeneratedVersion"); + } +} diff --git a/src/test/resources/version_test.txt b/src/test/resources/version_test.txt new file mode 100644 index 0000000..757425b --- /dev/null +++ b/src/test/resources/version_test.txt @@ -0,0 +1,20 @@ +package {{v packageName/}}; + +import java.util.Date; + +/** + * Provides project version information. + */ +public final class {{v className/}} { + public static final int MAJOR = {{v major/}}; + public static final int MINOR = {{v minor/}}; + public static final int REVISION = {{v revision/}}; + public static final String QUALIFIER = "{{v qualifier/}}"; + + /** + * Disables the default constructor. + */ + private {{v className/}}() { + throw new UnsupportedOperationException("Illegal constructor call."); + } +}