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

Compare commits

base: rife2:master
Branches Tags
rife2:master
rife2:0.9.9
rife2:0.9.8
rife2:0.9.7
rife2:0.9.6
rife2:0.9.5
rife2:0.9.4
rife2:0.9.3
rife2:0.9.2
rife2:0.9.1
rife2:0.9.0
..
compare: rife2:0.9.2
Branches Tags
rife2:master
rife2:0.9.9
rife2:0.9.8
rife2:0.9.7
rife2:0.9.6
rife2:0.9.5
rife2:0.9.4
rife2:0.9.3
rife2:0.9.2
rife2:0.9.1
rife2:0.9.0

1 commit
master ... 0.9.2

Author SHA1 Message Date
Erik C. Thauvin
650bb819cf Upgrade to bld 1.7.1 2023-08-18 02:00:24 -07:00
39 changed files with 720 additions and 1030 deletions
Download patch file Download diff file Expand all files Collapse all files

41
.github/workflows/bld.yml vendored
View file

@ -4,48 +4,29 @@ on: [ push, pull_request, workflow_dispatch ]
jobs: jobs:
build-bld-project: build-bld-project:
runs-on: ubuntu-latest
strategy: strategy:
matrix: matrix:
java-version: [ 17, 21, 24 ] java-version: [ 17, 19, 20 ]
kotlin-version: [ 1.9.25, 2.0.21, 2.1.20 ]
os: [ ubuntu-latest, windows-latest, macos-latest ]
runs-on: ${{ matrix.os }}
steps: steps:
- name: Checkout source repository - name: Checkout source repository
uses: actions/checkout@v4 uses: actions/checkout@v3
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Set up JDK ${{ matrix.java-version }} - name: Set up JDK ${{ matrix.java-version }}
uses: actions/setup-java@v4 uses: actions/setup-java@v3
with: with:
distribution: "zulu" distribution: 'zulu'
java-version: ${{ matrix.java-version }} java-version: ${{ matrix.java-version }}
- name: Download dependencies [examples] - name: Grant execute permission for bld
working-directory: examples run: chmod +x bld
- name: Download the dependencies
run: ./bld download run: ./bld download
- name: Compile run [examples] - name: Run tests with bld
working-directory: examples
run: ./bld compile run
- name: Update version properties and run [examples]
working-directory: examples
run: |
./bld update-major run
./bld update-minor run
./bld update-patch run
./bld update-release run
- name: Delete version properties and run [examples]
working-directory: examples
run: ./bld delete-version run
- name: Download dependencies
run: ./bld download
- name: Run tests
run: ./bld compile test run: ./bld compile test

12
.github/workflows/pages.yml vendored
View file

@ -30,14 +30,14 @@ jobs:
steps: steps:
- name: Checkout source repository - name: Checkout source repository
uses: actions/checkout@v4 uses: actions/checkout@v3
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Set up JDK 17 - name: Set up JDK 17
uses: actions/setup-java@v4 uses: actions/setup-java@v3
with: with:
distribution: "zulu" distribution: 'zulu'
java-version: 17 java-version: 17
- name: Build Javadocs - name: Build Javadocs
@ -47,11 +47,11 @@ jobs:
uses: actions/configure-pages@v3 uses: actions/configure-pages@v3
- name: Upload artifact - name: Upload artifact
uses: actions/upload-pages-artifact@v3 uses: actions/upload-pages-artifact@v1
with: with:
# Upload generated Javadocs repository # Upload generated Javadocs repository
path: "build/javadoc/" path: 'build/javadoc/'
- name: Deploy to GitHub Pages - name: Deploy to GitHub Pages
id: deployment id: deployment
uses: actions/deploy-pages@v4 uses: actions/deploy-pages@v1

6
.idea/bld.xml generated
View file

@ -1,6 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="BldConfiguration">
<events />
</component>
</project>

2
.idea/copyright/Apache_License.xml generated
View file

@ -1,6 +1,6 @@
<component name="CopyrightManager"> <component name="CopyrightManager">
<copyright> <copyright>
<option name="notice" value="Copyright 2023-&amp;#36;today.year the original author or authors.&#10; &#10;Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);&#10;you may not use this file except in compliance with the License.&#10;You may obtain a copy of the License at&#10;&#10; https://www.apache.org/licenses/LICENSE-2.0&#10;&#10;Unless required by applicable law or agreed to in writing, software&#10;distributed under the License is distributed on an &quot;AS IS&quot; BASIS,&#10;WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.&#10;See the License for the specific language governing permissions and&#10;limitations under the License." /> <option name="notice" value=" Copyright &amp;#36;today.year the original author or authors.&#10; &#10; Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);&#10; you may not use this file except in compliance with the License.&#10; You may obtain a copy of the License at&#10; &#10; https://www.apache.org/licenses/LICENSE-2.0&#10; &#10; Unless required by applicable law or agreed to in writing, software&#10; distributed under the License is distributed on an &quot;AS IS&quot; BASIS,&#10; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.&#10; See the License for the specific language governing permissions and&#10; limitations under the License." />
<option name="myName" value="Apache License" /> <option name="myName" value="Apache License" />
</copyright> </copyright>
</component> </component>

13
.idea/icon.svg generated
View file

@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg width="100%" height="100%" viewBox="0 0 179 108" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
<g transform="matrix(1,0,0,1,-210.511,-96.3382)">
<g transform="matrix(1,0,0,1,-23.3386,-649.816)">
<g transform="matrix(0.221288,0,0,0.24,73.9536,390.254)">
<path d="M722.568,1482.92L722.568,1921.1L808.968,1921.1L808.968,1888.7C822.168,1907.9 846.168,1930.1 893.568,1930.1C933.168,1930.1 961.968,1917.5 985.368,1893.5C1012.97,1865.9 1027.37,1827.5 1027.37,1786.1C1027.37,1741.7 1011.17,1705.1 985.368,1680.5C961.968,1658.3 928.968,1644.5 892.368,1644.5C862.968,1644.5 830.568,1654.1 808.968,1683.5L808.968,1482.92L722.568,1482.92ZM871.368,1718.9C888.768,1718.9 903.768,1723.7 917.568,1736.9C930.168,1748.9 938.568,1766.3 938.568,1787.9C938.568,1807.7 930.168,1825.1 917.568,1837.1C904.368,1849.7 887.568,1855.7 872.568,1855.7C856.368,1855.7 837.168,1849.1 823.368,1835.9C813.168,1826.3 803.568,1810.1 803.568,1787.9C803.568,1765.1 812.568,1749.5 822.768,1738.7C836.568,1724.3 852.768,1718.9 871.368,1718.9Z" style="fill:rgb(35,146,255);fill-rule:nonzero;"/>
<rect x="1083.77" y="1482.92" width="86.4" height="438.182" style="fill:rgb(250,144,82);fill-rule:nonzero;"/>
<path d="M1531.37,1482.92L1444.97,1482.92L1444.97,1683.5C1423.37,1654.1 1390.97,1644.5 1361.57,1644.5C1324.97,1644.5 1291.97,1658.3 1268.57,1680.5C1242.77,1705.1 1226.57,1741.7 1226.57,1786.1C1226.57,1827.5 1240.97,1865.9 1268.57,1893.5C1291.97,1917.5 1320.77,1930.1 1360.37,1930.1C1407.77,1930.1 1431.77,1907.9 1444.97,1888.7L1444.97,1921.1L1531.37,1921.1L1531.37,1482.92ZM1382.57,1718.9C1401.17,1718.9 1417.37,1724.3 1431.17,1738.7C1441.37,1749.5 1450.37,1765.1 1450.37,1787.9C1450.37,1810.1 1440.77,1826.3 1430.57,1835.9C1416.77,1849.1 1397.57,1855.7 1381.37,1855.7C1366.37,1855.7 1349.57,1849.7 1336.37,1837.1C1323.77,1825.1 1315.37,1807.7 1315.37,1787.9C1315.37,1766.3 1323.77,1748.9 1336.37,1736.9C1350.17,1723.7 1365.17,1718.9 1382.57,1718.9Z" style="fill:rgb(35,146,255);fill-rule:nonzero;"/>
</g>
</g>
</g>
</svg>
Side by side

Before

Width:  |  Height:  |  Size: 2.4 KiB

141
.idea/intellij-javadocs-4.0.1.xml generated
View file

@ -1,141 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="JavaDocConfiguration">
<GENERAL>
<MODE>UPDATE</MODE>
<OVERRIDDEN_METHODS>false</OVERRIDDEN_METHODS>
<SPLITTED_CLASS_NAME>true</SPLITTED_CLASS_NAME>
<LEVELS>
<LEVEL>METHOD</LEVEL>
<LEVEL>FIELD</LEVEL>
<LEVEL>TYPE</LEVEL>
</LEVELS>
<VISIBILITIES>
<VISIBILITY>PUBLIC</VISIBILITY>
<VISIBILITY>DEFAULT</VISIBILITY>
<VISIBILITY>PROTECTED</VISIBILITY>
</VISIBILITIES>
</GENERAL>
<TEMPLATES>
<CLASSES>
<CLASS>
<KEY>^.*(public|protected|private)*.+interface\s+\w+.*</KEY>
<VALUE>/**\n
* The interface ${name}.\n
&lt;#if element.typeParameters?has_content&gt; * \n
&lt;/#if&gt;&lt;#list element.typeParameters as typeParameter&gt; * @param &lt;${typeParameter.name}&gt; the type parameter\n
&lt;/#list&gt; */</VALUE>
</CLASS>
<CLASS>
<KEY>^.*(public|protected|private)*.+enum\s+\w+.*</KEY>
<VALUE>/**\n
* The enum ${name}.\n
*/</VALUE>
</CLASS>
<CLASS>
<KEY>^.*(public|protected|private)*.+class\s+\w+.*</KEY>
<VALUE>/**\n
* The type ${name}.\n
&lt;#if element.typeParameters?has_content&gt; * \n
&lt;/#if&gt;&lt;#list element.typeParameters as typeParameter&gt; * @param &lt;${typeParameter.name}&gt; the type parameter\n
&lt;/#list&gt; */</VALUE>
</CLASS>
<CLASS>
<KEY>.+</KEY>
<VALUE>/**\n
* The type ${name}.\n
*/</VALUE>
</CLASS>
</CLASSES>
<CONSTRUCTORS>
<CONSTRUCTOR>
<KEY>.+</KEY>
<VALUE>/**\n
* Instantiates a new ${name}.\n
&lt;#if element.parameterList.parameters?has_content&gt; *\n
&lt;/#if&gt;&lt;#list element.parameterList.parameters as parameter&gt; * @param ${parameter.name} the ${paramNames[parameter.name]}\n
&lt;/#list&gt;&lt;#if element.throwsList.referenceElements?has_content&gt; *\n
&lt;/#if&gt;&lt;#list element.throwsList.referenceElements as exception&gt; * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n
&lt;/#list&gt; */</VALUE>
</CONSTRUCTOR>
</CONSTRUCTORS>
<METHODS>
<METHOD>
<KEY>^.*(public|protected|private)*\s*.*(\w(\s*&lt;.+&gt;)*)+\s+get\w+\s*\(.*\).+</KEY>
<VALUE>/**\n
* Gets ${partName}.\n
&lt;#if element.typeParameters?has_content&gt; * \n
&lt;/#if&gt;&lt;#list element.typeParameters as typeParameter&gt; * @param &lt;${typeParameter.name}&gt; the type parameter\n
&lt;/#list&gt;&lt;#if element.parameterList.parameters?has_content&gt; *\n
&lt;/#if&gt;&lt;#list element.parameterList.parameters as parameter&gt; * @param ${parameter.name} the ${paramNames[parameter.name]}\n
&lt;/#list&gt;&lt;#if isNotVoid&gt; *\n
* @return the ${partName}\n
&lt;/#if&gt;&lt;#if element.throwsList.referenceElements?has_content&gt; *\n
&lt;/#if&gt;&lt;#list element.throwsList.referenceElements as exception&gt; * @throws ${exception.referenceName} if an error occurs\n
&lt;/#list&gt; */</VALUE>
</METHOD>
<METHOD>
<KEY>^.*(public|protected|private)*\s*.*(void|\w(\s*&lt;.+&gt;)*)+\s+set\w+\s*\(.*\).+</KEY>
<VALUE>/**\n
* Sets ${partName}.\n
&lt;#if element.typeParameters?has_content&gt; * \n
&lt;/#if&gt;&lt;#list element.typeParameters as typeParameter&gt; * @param &lt;${typeParameter.name}&gt; the type parameter\n
&lt;/#list&gt;&lt;#if element.parameterList.parameters?has_content&gt; *\n
&lt;/#if&gt;&lt;#list element.parameterList.parameters as parameter&gt; * @param ${parameter.name} the ${paramNames[parameter.name]}\n
&lt;/#list&gt;&lt;#if isNotVoid&gt; *\n
* @return the ${partName}\n
&lt;/#if&gt;&lt;#if element.throwsList.referenceElements?has_content&gt; *\n
&lt;/#if&gt;&lt;#list element.throwsList.referenceElements as exception&gt; * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n
&lt;/#list&gt; */</VALUE>
</METHOD>
<METHOD>
<KEY>^.*((public\s+static)|(static\s+public))\s+void\s+main\s*\(\s*String\s*(\[\s*\]|\.\.\.)\s+\w+\s*\).+</KEY>
<VALUE>/**\n
* The entry point of application.\n
&lt;#if element.parameterList.parameters?has_content&gt; *\n
&lt;/#if&gt; * @param ${element.parameterList.parameters[0].name} the input arguments\n
&lt;#if element.throwsList.referenceElements?has_content&gt; *\n
&lt;/#if&gt;&lt;#list element.throwsList.referenceElements as exception&gt; * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n
&lt;/#list&gt; */</VALUE>
</METHOD>
<METHOD>
<KEY>.+</KEY>
<VALUE>/**\n
* ${name}&lt;#if isNotVoid&gt; ${return}&lt;/#if&gt;.\n
&lt;#if element.typeParameters?has_content&gt; * \n
&lt;/#if&gt;&lt;#list element.typeParameters as typeParameter&gt; * @param &lt;${typeParameter.name}&gt; the type parameter\n
&lt;/#list&gt;&lt;#if element.parameterList.parameters?has_content&gt; *\n
&lt;/#if&gt;&lt;#list element.parameterList.parameters as parameter&gt; * @param ${parameter.name} the ${paramNames[parameter.name]}\n
&lt;/#list&gt;&lt;#if isNotVoid&gt; *\n
* @return the ${return}\n
&lt;/#if&gt;&lt;#if element.throwsList.referenceElements?has_content&gt; *\n
&lt;/#if&gt;&lt;#list element.throwsList.referenceElements as exception&gt; * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n
&lt;/#list&gt; */</VALUE>
</METHOD>
</METHODS>
<FIELDS>
<FIELD>
<KEY>^.*(public|protected|private)*.+static.*(\w\s\w)+.+</KEY>
<VALUE>/**\n
* The constant ${element.getName()}.\n
*/</VALUE>
</FIELD>
<FIELD>
<KEY>^.*(public|protected|private)*.*(\w\s\w)+.+</KEY>
<VALUE>/**\n
&lt;#if element.parent.isInterface()&gt; * The constant ${element.getName()}.\n
&lt;#else&gt; * The ${name}.\n
&lt;/#if&gt; */</VALUE>
</FIELD>
<FIELD>
<KEY>.+</KEY>
<VALUE>/**\n
&lt;#if element.parent.isEnum()&gt; *${name} ${typeName}.\n
&lt;#else&gt; * The ${name}.\n
&lt;/#if&gt;*/</VALUE>
</FIELD>
</FIELDS>
</TEMPLATES>
</component>
</project>

7
.idea/libraries/bld.xml generated
View file

@ -2,12 +2,11 @@
<library name="bld"> <library name="bld">
<CLASSES> <CLASSES>
<root url="file://$PROJECT_DIR$/lib/bld" /> <root url="file://$PROJECT_DIR$/lib/bld" />
<root url="jar://$USER_HOME$/.bld/dist/bld-2.2.1.jar!/" /> <root url="jar://$USER_HOME$/.bld/dist/bld-1.7.0.jar!/" />
</CLASSES> </CLASSES>
<JAVADOC /> <JAVADOC />
<SOURCES> <SOURCES>
<root url="file://$PROJECT_DIR$/lib/bld" /> <root url="jar://$USER_HOME$/.bld/dist/bld-1.7.0-sources.jar!/" />
<root url="jar://$USER_HOME$/.bld/dist/bld-2.2.1-sources.jar!/" />
</SOURCES> </SOURCES>
<excluded> <excluded>
<root url="jar://$PROJECT_DIR$/lib/bld/bld-wrapper.jar!/" /> <root url="jar://$PROJECT_DIR$/lib/bld/bld-wrapper.jar!/" />
@ -15,4 +14,4 @@
<jarDirectory url="file://$PROJECT_DIR$/lib/bld" recursive="false" /> <jarDirectory url="file://$PROJECT_DIR$/lib/bld" recursive="false" />
<jarDirectory url="file://$PROJECT_DIR$/lib/bld" recursive="false" type="SOURCES" /> <jarDirectory url="file://$PROJECT_DIR$/lib/bld" recursive="false" type="SOURCES" />
</library> </library>
</component> </component>

4
.idea/libraries/compile.xml generated
View file

@ -7,7 +7,7 @@
<SOURCES> <SOURCES>
<root url="file://$PROJECT_DIR$/lib/compile" /> <root url="file://$PROJECT_DIR$/lib/compile" />
</SOURCES> </SOURCES>
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="true" /> <jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="false" />
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="true" type="SOURCES" /> <jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="false" type="SOURCES" />
</library> </library>
</component> </component>

4
.idea/libraries/runtime.xml generated
View file

@ -7,7 +7,7 @@
<SOURCES> <SOURCES>
<root url="file://$PROJECT_DIR$/lib/runtime" /> <root url="file://$PROJECT_DIR$/lib/runtime" />
</SOURCES> </SOURCES>
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="true" /> <jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="false" />
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="true" type="SOURCES" /> <jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="false" type="SOURCES" />
</library> </library>
</component> </component>

4
.idea/libraries/test.xml generated
View file

@ -7,7 +7,7 @@
<SOURCES> <SOURCES>
<root url="file://$PROJECT_DIR$/lib/test" /> <root url="file://$PROJECT_DIR$/lib/test" />
</SOURCES> </SOURCES>
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="true" /> <jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="false" />
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="true" type="SOURCES" /> <jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="false" type="SOURCES" />
</library> </library>
</component> </component>

6
.idea/misc.xml generated
View file

@ -1,3 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4"> <project version="4">
<component name="EntryPointsManager"> <component name="EntryPointsManager">
<pattern value="rife.bld.extension.propertyFile.Entry" method="defaultValue" /> <pattern value="rife.bld.extension.propertyFile.Entry" method="defaultValue" />
@ -17,6 +18,11 @@
<pattern value="rife.bld.extension.propertyfile.PropertyFileOperation" /> <pattern value="rife.bld.extension.propertyfile.PropertyFileOperation" />
</component> </component>
<component name="PDMPlugin"> <component name="PDMPlugin">
<option name="customRuleSets">
<list>
<option value="K:\java\semver\config\pmd.xml" />
</list>
</option>
<option name="skipTestSources" value="false" /> <option name="skipTestSources" value="false" />
</component> </component>
<component name="ProjectRootManager" version="2" languageLevel="JDK_17" project-jdk-name="17" project-jdk-type="JavaSDK"> <component name="ProjectRootManager" version="2" languageLevel="JDK_17" project-jdk-name="17" project-jdk-type="JavaSDK">

6
.vscode/launch.json vendored
View file

@ -1,6 +1,12 @@
{ {
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{
"type": "java",
"name": "Run Main",
"request": "launch",
"mainClass": "rife.bld.extension.propertyfile.PropertyFileOperation"
},
{ {
"type": "java", "type": "java",
"name": "Run Tests", "name": "Run Tests",

10
.vscode/settings.json vendored
View file

@ -3,13 +3,13 @@
"src/main/java", "src/main/java",
"src/main/resources", "src/main/resources",
"src/test/java", "src/test/java",
"src/test/resources", "src/bld/java"
"src/bld/java",
"src/bld/resources"
], ],
"java.configuration.updateBuildConfiguration": "automatic", "java.configuration.updateBuildConfiguration": "automatic",
"java.project.referencedLibraries": [ "java.project.referencedLibraries": [
"${HOME}/.bld/dist/bld-2.2.1.jar", "${HOME}bld-1.7.0-SNAPSHOT.jar",
"lib/**/*.jar" "lib/compile/*.jar",
"lib/runtime/*.jar",
"lib/test/*.jar"
] ]
} }

32
README.md
View file

@ -1,23 +1,15 @@
# [bld](https://rife2.com/bld) Extension to Create or Modify Properties Files # [Bld](https://rife2.com/bld) Extension to Create or Modify Properties Files
[![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Java](https://img.shields.io/badge/java-17%2B-blue)](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) [![Java](https://img.shields.io/badge/java-17%2B-blue)](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
[![bld](https://img.shields.io/badge/2.2.1-FA9052?label=bld&labelColor=2392FF)](https://rife2.com/bld) [![bld](https://img.shields.io/badge/1.7.1-FA9052?label=bld&labelColor=2392FF)](https://rife2.com/bld)
[![Release](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/releases/com/uwyn/rife2/bld-property-file/maven-metadata.xml?color=blue)](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-property-file) [![Release](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/releases/com/uwyn/rife2/bld-property-file/maven-metadata.xml?color=blue)](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-property-file)
[![Snapshot](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/snapshots/com/uwyn/rife2/bld-property-file/maven-metadata.xml?label=snapshot)](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-property-file) [![Snapshot](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/snapshots/com/uwyn/rife2/bld-property-file/maven-metadata.xml?label=snapshot)](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-property-file)
[![GitHub CI](https://github.com/rife2/bld-property-file/actions/workflows/bld.yml/badge.svg)](https://github.com/rife2/bld-property-file/actions/workflows/bld.yml) [![GitHub CI](https://github.com/rife2/bld-property-file/actions/workflows/bld.yml/badge.svg)](https://github.com/rife2/bld-property-file/actions/workflows/bld.yml)
To install the latest version, add the following to the `lib/bld/bld-wrapper.properties` file: To install, please refer to the [extensions documentation](https://github.com/rife2/bld/wiki/Extensions).
```properties To create or modifying [property files](https://docs.oracle.com/javase/tutorial/essential/environment/properties.html) with [bld](https://rife2.com/bld), add the follwing to your build file:
bld.extension-property-file=com.uwyn.rife2:bld-property-file
```
For more information, please refer to the [extensions](https://github.com/rife2/bld/wiki/Extensions) documentation.
## Create or Modify Property Files
To create or modify [property files](https://docs.oracle.com/javase/tutorial/essential/environment/properties.html) with [bld](https://rife2.com/bld), add the follwing to your build file:
```java ```java
@BuildCommand @BuildCommand
@ -32,7 +24,6 @@ public void updateMajor() throws Exception {
.execute(); .execute();
} }
``` ```
Invoking the `updateMajor` command, will create the `version.propertees`file: Invoking the `updateMajor` command, will create the `version.propertees`file:
```sh ```sh
@ -77,13 +68,12 @@ The [PropertyFileOperation](https://rife2.github.io/bld-property-file/rife/bld/e
The [Entry](https://rife2.github.io/bld-property-file/rife/bld/extension/propertyfile/Entry.html) class is used to specify modifications to a [String property](https://docs.oracle.com/javase/tutorial/essential/environment/properties.html). The [Entry](https://rife2.github.io/bld-property-file/rife/bld/extension/propertyfile/Entry.html) class is used to specify modifications to a [String property](https://docs.oracle.com/javase/tutorial/essential/environment/properties.html).
| Function | Description/Example | | Function | Description/Example |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------| |:-----------------|:--------------------------------------------------------------------------------------------------------|
| `defaultValue()` | The value to be used if the property doesn't exist. | | `defaultValue()` | The value to be used if the property doesn't exist. |
| `delete()` | Delete the property. | | `delete()` | Delete the property. |
| `modify()` | `modify("-foo", String::concat)`<br/>`modify("-foo", (v, s) -> v + s)`<br/>`modify((v, s) -> v.trim())` | | `modify()` | `modify("-foo", String::concat)`<br/>`modify("-foo", (v, s) -> v + s)`<br/>`modify((v, s) -> v.trim())` | Modify an entry value. |
| `pattern()` | If present, will parse the value as a [Formatter](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Formatter.html) pattern. | | `set()` | The value to set the property to, regardless of its previous value. |
| `set()` | The value to set the property to, regardless of its previous value. |
## EntryDate ## EntryDate
@ -125,4 +115,4 @@ The [EntryInt](https://rife2.github.io/bld-property-file/rife/bld/extension/prop
| `pattern()` | If present, will parse the value as a [DecimalFormat](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/text/DecimalFormat.html) pattern. | | `pattern()` | If present, will parse the value as a [DecimalFormat](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/text/DecimalFormat.html) pattern. |
| `set()` | The [integer value](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html) to set the property to, regardless of its previous value. | | `set()` | The [integer value](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html) to set the property to, regardless of its previous value. |
It is inspired by the [ant PropertyFile task](https://ant.apache.org/manual/Tasks/propertyfile.html). It is inspired by the [ant PropertyFile task](https://ant.apache.org/manual/Tasks/propertyfile.html).

19
config/pmd.xml
View file

@ -7,9 +7,9 @@
<!-- BEST PRACTICES --> <!-- BEST PRACTICES -->
<rule ref="category/java/bestpractices.xml"> <rule ref="category/java/bestpractices.xml">
<exclude name="AvoidPrintStackTrace"/> <exclude name="AvoidPrintStackTrace"/>
<exclude name="JUnit4TestShouldUseTestAnnotation"/>
<exclude name="JUnitTestContainsTooManyAsserts"/>
<exclude name="GuardLogStatement"/> <exclude name="GuardLogStatement"/>
<exclude name="UnitTestContainsTooManyAsserts"/>
<exclude name="UnitTestShouldUseTestAnnotation"/>
</rule> </rule>
<rule ref="category/java/bestpractices.xml/MissingOverride"> <rule ref="category/java/bestpractices.xml/MissingOverride">
@ -24,8 +24,8 @@
<rule ref="category/java/codestyle.xml"> <rule ref="category/java/codestyle.xml">
<exclude name="AtLeastOneConstructor"/> <exclude name="AtLeastOneConstructor"/>
<exclude name="ClassNamingConventions"/> <exclude name="ClassNamingConventions"/>
<exclude name="CommentDefaultAccessModifier"/>
<exclude name="ConfusingTernary"/> <exclude name="ConfusingTernary"/>
<exclude name="CommentDefaultAccessModifier"/>
<exclude name="FieldNamingConventions"/> <exclude name="FieldNamingConventions"/>
<exclude name="LocalVariableCouldBeFinal"/> <exclude name="LocalVariableCouldBeFinal"/>
<exclude name="LongVariable"/> <exclude name="LongVariable"/>
@ -35,15 +35,8 @@
<exclude name="ShortClassName"/> <exclude name="ShortClassName"/>
<exclude name="ShortMethodName"/> <exclude name="ShortMethodName"/>
<exclude name="ShortVariable"/> <exclude name="ShortVariable"/>
<exclude name="UseExplicitTypes"/>
<exclude name="UseUnderscoresInNumericLiterals"/>
<exclude name="UselessParentheses"/> <exclude name="UselessParentheses"/>
</rule> <exclude name="UseUnderscoresInNumericLiterals"/>
<rule ref="category/java/codestyle.xml/UnnecessaryImport">
<properties>
<property name="violationSuppressRegex" value="Unused (static|.*\.\*).*"/>
</properties>
</rule> </rule>
<!-- DESIGN --> <!-- DESIGN -->
@ -53,6 +46,8 @@
<exclude name="AvoidUncheckedExceptionsInSignatures"/> <exclude name="AvoidUncheckedExceptionsInSignatures"/>
<exclude name="CognitiveComplexity"/> <exclude name="CognitiveComplexity"/>
<exclude name="CyclomaticComplexity"/> <exclude name="CyclomaticComplexity"/>
<exclude name="ExcessiveClassLength"/>
<exclude name="ExcessiveMethodLength"/>
<exclude name="ExcessiveParameterList"/> <exclude name="ExcessiveParameterList"/>
<exclude name="ExcessivePublicCount"/> <exclude name="ExcessivePublicCount"/>
<exclude name="GodClass"/> <exclude name="GodClass"/>
@ -106,4 +101,4 @@
<!-- SECURITY --> <!-- SECURITY -->
<rule ref="category/java/security.xml"> <rule ref="category/java/security.xml">
</rule> </rule>
</ruleset> </ruleset>

4
examples/.idea/libraries/bld.xml generated
View file

@ -2,12 +2,12 @@
<library name="bld"> <library name="bld">
<CLASSES> <CLASSES>
<root url="file://$PROJECT_DIR$/lib/bld" /> <root url="file://$PROJECT_DIR$/lib/bld" />
<root url="jar://$USER_HOME$/.bld/dist/bld-2.2.1.jar!/" /> <root url="jar://$USER_HOME$/.bld/dist/bld-1.7.0.jar!/" />
<root url="file://$PROJECT_DIR$/lib/bld" /> <root url="file://$PROJECT_DIR$/lib/bld" />
</CLASSES> </CLASSES>
<JAVADOC /> <JAVADOC />
<SOURCES> <SOURCES>
<root url="jar://$USER_HOME$/.bld/dist/bld-2.2.1-sources.jar!/" /> <root url="jar://$USER_HOME$/.bld/dist/bld-1.7.0-sources.jar!/" />
<root url="file://$PROJECT_DIR$/lib/bld" /> <root url="file://$PROJECT_DIR$/lib/bld" />
</SOURCES> </SOURCES>
<jarDirectory url="file://$PROJECT_DIR$/lib/bld" recursive="false" /> <jarDirectory url="file://$PROJECT_DIR$/lib/bld" recursive="false" />

4
examples/.idea/libraries/compile.xml generated
View file

@ -7,7 +7,7 @@
<SOURCES> <SOURCES>
<root url="file://$PROJECT_DIR$/lib/compile" /> <root url="file://$PROJECT_DIR$/lib/compile" />
</SOURCES> </SOURCES>
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="true" /> <jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="false" />
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="true" type="SOURCES" /> <jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="false" type="SOURCES" />
</library> </library>
</component> </component>

4
examples/.idea/libraries/runtime.xml generated
View file

@ -7,7 +7,7 @@
<SOURCES> <SOURCES>
<root url="file://$PROJECT_DIR$/lib/runtime" /> <root url="file://$PROJECT_DIR$/lib/runtime" />
</SOURCES> </SOURCES>
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="true" /> <jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="false" />
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="true" type="SOURCES" /> <jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="false" type="SOURCES" />
</library> </library>
</component> </component>

4
examples/.idea/libraries/test.xml generated
View file

@ -7,7 +7,7 @@
<SOURCES> <SOURCES>
<root url="file://$PROJECT_DIR$/lib/test" /> <root url="file://$PROJECT_DIR$/lib/test" />
</SOURCES> </SOURCES>
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="true" /> <jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="false" />
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="true" type="SOURCES" /> <jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="false" type="SOURCES" />
</library> </library>
</component> </component>

1
examples/.idea/misc.xml generated
View file

@ -1,3 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4"> <project version="4">
<component name="EntryPointsManager"> <component name="EntryPointsManager">
<list size="1"> <list size="1">

9
examples/.vscode/launch.json vendored
View file

@ -1,6 +1,12 @@
{ {
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{
"type": "java",
"name": "Run Main",
"request": "launch",
"mainClass": "com.example.PropertyFileExampleMain"
},
{ {
"type": "java", "type": "java",
"name": "Run Tests", "name": "Run Tests",
@ -12,8 +18,7 @@
"--disable-banner", "--disable-banner",
"--disable-ansi-colors", "--disable-ansi-colors",
"--exclude-engine=junit-platform-suite", "--exclude-engine=junit-platform-suite",
"--exclude-engine=junit-vintage" "--exclude-engine=junit-vintage"]
]
} }
] ]
} }

10
examples/.vscode/settings.json vendored
View file

@ -3,13 +3,13 @@
"src/main/java", "src/main/java",
"src/main/resources", "src/main/resources",
"src/test/java", "src/test/java",
"src/test/resources", "src/bld/java"
"src/bld/java",
"src/bld/resources"
], ],
"java.configuration.updateBuildConfiguration": "automatic", "java.configuration.updateBuildConfiguration": "automatic",
"java.project.referencedLibraries": [ "java.project.referencedLibraries": [
"${HOME}/.bld/dist/bld-2.2.1.jar", "${HOME}bld-1.7.0.jar",
"lib/**/*.jar" "lib/compile/*.jar",
"lib/runtime/*.jar",
"lib/test/*.jar"
] ]
} }

65
examples/README.md
View file

@ -1,20 +1,57 @@
# Compile and Run Example # [Bld Property File](https://github.com/rife2/bld-property-file) Extension Examples
```console ## Compile
./bld compile run
First make sure the project up-to-date and compiled:
```shell
./bld download compile
```
## Run
To run the examples, issue one of the following command or combination there off.
```shell
./bld updateMajor run
./bld updateMinor run
./bld updatePatch run
./bld updateRelease run
```
Upon execution, the `version.properties` file will be created and displayed:
```shell
./bld updateMajor run
``` ```
# Update Version Properties ```text
+---------------------------+
```console | version.properties |
./bld update-major run +---------------------------+
./bld update-minor run #
./bld update-patch run #Sun Apr 02 23:51:39 PDT 2023
./bld update-release run build.date=2023-04-02
version.major=1
version.minor=0
version.patch=0
``` ```
# Delete Version Properties Subsequent commands will reflect the modifications to the
`version.major`, `version.minor` or `version.patch` properties:
```console ```shell
./bld delete-version run ./bld upatePatch run
``` ```
```text
+---------------------------+
| version.properties |
+---------------------------+
#
#Sun Apr 02 23:55:09 PDT 2023
build.date=2023-04-02
version.major=1
version.minor=0
version.patch=10
```
[View the Examples Build](https://github.com/rife2/bld-property-file/blob/master/examples/src/bld/java/com/example/PropertyFileExampleBuild.java)

BIN
examples/lib/bld/bld-wrapper.jar
View file

Binary file not shown.

6
examples/lib/bld/bld-wrapper.properties
View file

@ -1,6 +1,6 @@
#Sun Apr 02 10:32:44 PDT 2023 #Sun Apr 02 10:32:44 PDT 2023
bld.extension=com.uwyn.rife2:bld-property-file:0.9.2
bld.repositories=RIFE2_SNAPSHOTS,RIFE2_RELEASES,MAVEN_CENTRAL
bld.downloadExtensionSources=true bld.downloadExtensionSources=true
bld.downloadLocation= bld.downloadLocation=
bld.extension=com.uwyn.rife2:bld-property-file:0.9.9 bld.version=1.7.1
bld.repositories=MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
bld.version=2.2.1

30
examples/src/bld/java/com/example/PropertyFileExampleBuild.java
View file

@ -14,17 +14,6 @@ import static rife.bld.dependencies.Repository.RIFE2_RELEASES;
import static rife.bld.dependencies.Scope.test; import static rife.bld.dependencies.Scope.test;
import static rife.bld.extension.propertyfile.Calc.ADD; import static rife.bld.extension.propertyfile.Calc.ADD;
/**
* Example build.
*
* <ul style="list-style-type:none">
* <li>./bld updateMajor run</li>
* <li>./bld updateMinor run</li>
* <li>./bld updatePath run</li>
* <li>./bld updateRelease run</li>
* <li>./bld deleteVersion run</li>
* </ul>
*/
public class PropertyFileExampleBuild extends Project { public class PropertyFileExampleBuild extends Project {
final EntryDate buildDateEntry = new EntryDate("build.date").now().pattern("yyyy-MM-dd"); final EntryDate buildDateEntry = new EntryDate("build.date").now().pattern("yyyy-MM-dd");
@ -35,22 +24,20 @@ public class PropertyFileExampleBuild extends Project {
version = version(0, 1, 0); version = version(0, 1, 0);
javaRelease = 17; javaRelease = 17;
downloadSources = true; downloadSources = true;
autoDownloadPurge = true; autoDownloadPurge = true;
repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES); repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES);
scope(test) scope(test)
.include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 12, 1))) .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 9, 3)))
.include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 12, 1))); .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 9, 3)));
} }
public static void main(String[] args) { public static void main(String[] args) {
new PropertyFileExampleBuild().start(args); new PropertyFileExampleBuild().start(args);
} }
@BuildCommand(value = "update-major", summary = "Updates major version") @BuildCommand(summary = "Updates major version")
public void updateMajor() throws Exception { public void updateMajor() throws Exception {
new PropertyFileOperation() new PropertyFileOperation()
.fromProject(this) .fromProject(this)
@ -66,7 +53,7 @@ public class PropertyFileExampleBuild extends Project {
.execute(); .execute();
} }
@BuildCommand(value = "update-minor", summary = "Updates minor version") @BuildCommand(summary = "Updates minor version")
public void updateMinor() throws Exception { public void updateMinor() throws Exception {
new PropertyFileOperation() new PropertyFileOperation()
.fromProject(this) .fromProject(this)
@ -82,7 +69,7 @@ public class PropertyFileExampleBuild extends Project {
.execute(); .execute();
} }
@BuildCommand(value = "update-patch", summary = "Updates patch version") @BuildCommand(summary = "Updates patch version")
public void updatePatch() throws Exception { public void updatePatch() throws Exception {
new PropertyFileOperation() new PropertyFileOperation()
.fromProject(this) .fromProject(this)
@ -98,7 +85,7 @@ public class PropertyFileExampleBuild extends Project {
.execute(); .execute();
} }
@BuildCommand(value = "update-release", summary = "Updates the release") @BuildCommand(summary = "Updates the release")
public void updateRelease() throws Exception { public void updateRelease() throws Exception {
new PropertyFileOperation() new PropertyFileOperation()
.fromProject(this) .fromProject(this)
@ -107,11 +94,10 @@ public class PropertyFileExampleBuild extends Project {
.entry(new EntryDate("release").now().pattern("yyyyMMddHHmmss")) .entry(new EntryDate("release").now().pattern("yyyyMMddHHmmss"))
// prepend 'beta.' to the release // prepend 'beta.' to the release
.entry(new Entry("release").modify("beta.", (v, s) -> s + v)) .entry(new Entry("release").modify("beta.", (v, s) -> s + v))
.entry(buildDateEntry)
.execute(); .execute();
} }
@BuildCommand(value = "delete-version", summary = "Delete version properties") @BuildCommand(summary = "Delete version properties")
public void deleteVersion() throws Exception { public void deleteVersion() throws Exception {
new PropertyFileOperation() new PropertyFileOperation()
.fromProject(this) .fromProject(this)
@ -123,4 +109,4 @@ public class PropertyFileExampleBuild extends Project {
.entry(buildDateEntry.delete()) .entry(buildDateEntry.delete())
.execute(); .execute();
} }
} }

7
examples/version.properties
View file

@ -1,7 +0,0 @@
#
#Mon Jan 13 22:23:02 PST 2025
build.date=2025-01-13
release=beta.20250113222132
version.major=3
version.minor=1
version.patch=20

BIN
lib/bld/bld-wrapper.jar
View file

Binary file not shown.

7
lib/bld/bld-wrapper.properties
View file

@ -1,6 +1,7 @@
bld.downloadExtensionJavadoc=false bld.downloadExtensionJavadoc=false
bld.downloadExtensionSources=true bld.downloadExtensionSources=true
bld.extension-pmd=com.uwyn.rife2:bld-pmd:0.9.2
bld.extension-jacoco=com.uwyn.rife2:bld-jacoco-report:0.9.0
bld.repositories=RIFE2_SNAPSHOTS,RIFE2_RELEASES,MAVEN_CENTRAL
bld.downloadLocation= bld.downloadLocation=
bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.2.2 bld.version=1.7.1
bld.repositories=MAVEN_CENTRAL,MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
bld.version=2.2.1

77
src/bld/java/rife/bld/extension/propertyfile/PropertyFileBuild.java
View file

@ -1,31 +1,18 @@
/*
* Copyright 2023-2025 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.propertyfile; package rife.bld.extension.propertyfile;
import rife.bld.BuildCommand; import rife.bld.BuildCommand;
import rife.bld.Project; import rife.bld.Project;
import rife.bld.extension.JacocoReportOperation;
import rife.bld.extension.PmdOperation; import rife.bld.extension.PmdOperation;
import rife.bld.publish.PublishDeveloper; import rife.bld.publish.PublishDeveloper;
import rife.bld.publish.PublishLicense; import rife.bld.publish.PublishLicense;
import rife.bld.publish.PublishScm; import rife.bld.publish.PublishScm;
import java.io.IOException;
import java.util.List; import java.util.List;
import static rife.bld.dependencies.Repository.*; 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.compile;
import static rife.bld.dependencies.Scope.test; import static rife.bld.dependencies.Scope.test;
import static rife.bld.operations.JavadocOptions.DocLinkOption.NO_MISSING; import static rife.bld.operations.JavadocOptions.DocLinkOption.NO_MISSING;
@ -34,58 +21,45 @@ public class PropertyFileBuild extends Project {
public PropertyFileBuild() { public PropertyFileBuild() {
pkg = "rife.bld.extension"; pkg = "rife.bld.extension";
name = "bld-property-file"; name = "bld-property-file";
version = version(0, 9, 9); version = version(0, 9, 2, "SNAPSHOT");
javaRelease = 17; javaRelease = 17;
downloadSources = true; downloadSources = true;
autoDownloadPurge = true; autoDownloadPurge = true;
repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL, RIFE2_RELEASES, RIFE2_SNAPSHOTS); repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES);
var rife2 = version(1, 7, 0);
scope(compile) scope(compile)
.include(dependency("com.uwyn.rife2", "bld", version(2, 2, 1))); .include(dependency("com.uwyn.rife2", "rife2", rife2))
.include(dependency("com.uwyn.rife2", "bld", version(1, 7, 1)));
scope(test) scope(test)
.include(dependency("org.jsoup", "jsoup", version(1, 19, 1))) .include(dependency("org.jsoup", "jsoup", version(1, 16, 1)))
.include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 12, 1))) .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 0)))
.include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 12, 1))) .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 0)))
.include(dependency("org.assertj:assertj-joda-time:2.2.0")); .include(dependency("org.assertj:assertj-joda-time:2.2.0"));
javadocOperation() javadocOperation()
.javadocOptions() .javadocOptions()
.author()
.docLint(NO_MISSING) .docLint(NO_MISSING)
.link("https://rife2.github.io/bld/") .link("https://rife2.github.io/bld/")
.link("https://rife2.github.io/rife2/"); .link("https://rife2.github.io/rife2/");
publishOperation() publishOperation()
.repository(version.isSnapshot() ? repository("rife2-snapshot") : repository("rife2")) .repository(version.isSnapshot() ? repository("rife2-snapshot") : repository("rife2"))
.repository(repository("github"))
.info() .info()
.groupId("com.uwyn.rife2") .groupId("com.uwyn.rife2")
.artifactId("bld-property-file") .artifactId("bld-property-file")
.description("bld Extension to Create or Modify Properties Files") .description("bld Extension to Create or Modify Properties Files")
.url("https://github.com/rife2/bld-property-file") .url("https://github.com/rife2/bld-property-file")
.developer( .developer(new PublishDeveloper().id("ethauvin").name("Erik C. Thauvin").email("erik@thauvin.net")
new PublishDeveloper().id("ethauvin") .url("https://erik.thauvin.net/"))
.name("Erik C. Thauvin") .developer(new PublishDeveloper().id("gbevin").name("Geert Bevin").email("gbevin@uwyn.com")
.email("erik@thauvin.net") .url("https://github.com/gbevin"))
.url("https://erik.thauvin.net/") .license(new PublishLicense().name("The Apache License, Version 2.0")
) .url("http://www.apache.org/licenses/LICENSE-2.0.txt"))
.developer( .scm(new PublishScm().connection("scm:git:https://github.com/rife2/bld-property-file.git")
new PublishDeveloper() .developerConnection("scm:git:git@github.com:rife2/bld-property-file.git")
.id("gbevin") .url("https://github.com/rife2/bld-property-file"))
.name("Geert Bevin")
.email("gbevin@uwyn.com")
.url("https://github.com/gbevin")
)
.license(
new PublishLicense()
.name("The Apache License, Version 2.0")
.url("https://www.apache.org/licenses/LICENSE-2.0.txt")
)
.scm(
new PublishScm().connection("scm:git:https://github.com/rife2/bld-property-file.git")
.developerConnection("scm:git:git@github.com:rife2/bld-property-file.git")
.url("https://github.com/rife2/bld-property-file"))
.signKey(property("sign.key")) .signKey(property("sign.key"))
.signPassphrase(property("sign.passphrase")); .signPassphrase(property("sign.passphrase"));
} }
@ -94,8 +68,15 @@ public class PropertyFileBuild extends Project {
new PropertyFileBuild().start(args); new PropertyFileBuild().start(args);
} }
@BuildCommand(summary = "Generates JaCoCo Reports")
public void jacoco() throws IOException {
new JacocoReportOperation()
.fromProject(this)
.execute();
}
@BuildCommand(summary = "Runs PMD analysis") @BuildCommand(summary = "Runs PMD analysis")
public void pmd() throws Exception { public void pmd() {
new PmdOperation() new PmdOperation()
.fromProject(this) .fromProject(this)
.failOnViolation(true) .failOnViolation(true)

28
src/main/java/rife/bld/extension/propertyfile/Calc.java
View file

@ -1,17 +1,17 @@
/* /*
* Copyright 2023-2025 the original author or authors. * Copyright 2023 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* https://www.apache.org/licenses/LICENSE-2.0 * https://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package rife.bld.extension.propertyfile; package rife.bld.extension.propertyfile;
@ -26,13 +26,7 @@ import java.util.function.IntFunction;
* @since 1.0 * @since 1.0
*/ */
public final class Calc { public final class Calc {
/**
* The add function.
*/
public static final IntFunction<Integer> ADD = Calc::add; public static final IntFunction<Integer> ADD = Calc::add;
/**
* The sub function.
*/
public static final IntFunction<Integer> SUB = Calc::sub; public static final IntFunction<Integer> SUB = Calc::sub;
@ -44,7 +38,6 @@ public final class Calc {
* Adds {@code 1} to the value. * Adds {@code 1} to the value.
* *
* @param v the value * @param v the value
* @return the new value
*/ */
public static Integer add(int v) { public static Integer add(int v) {
return v + 1; return v + 1;
@ -54,7 +47,6 @@ public final class Calc {
* Subtracts {@code 1} to the value. * Subtracts {@code 1} to the value.
* *
* @param v the value * @param v the value
* @return the new value
*/ */
public static Integer sub(int v) { public static Integer sub(int v) {
return v - 1; return v - 1;

74
src/main/java/rife/bld/extension/propertyfile/Entry.java
View file

@ -1,17 +1,17 @@
/* /*
* Copyright 2023-2025 the original author or authors. * Copyright 2023 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* https://www.apache.org/licenses/LICENSE-2.0 * https://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package rife.bld.extension.propertyfile; package rife.bld.extension.propertyfile;
@ -25,67 +25,59 @@ import java.util.function.BiFunction;
* @author <a href="https://github.com/gbevin">Geert Bevin</a> * @author <a href="https://github.com/gbevin">Geert Bevin</a>
* @since 1.0 * @since 1.0
*/ */
public class Entry extends EntryBase<Entry> { public class Entry extends EntryBase {
private String modifyValue_ = "";
private BiFunction<String, String, String> modify_;
/**
* Creates a new {@link Entry entry}.
*
* @param key the required property key
*/
public Entry(String key) { public Entry(String key) {
super(key); super(key);
} }
/** /**
* Returns the modify function. * <p>Sets the initial value to set the {@link java.util.Properties property} to, if not already defined.</p>
* *
* @return the modify function * @param defaultValue the default value
*/ */
protected BiFunction<String, String, String> modify() { @SuppressWarnings("unused")
return modify_; public Entry defaultValue(Object defaultValue) {
setDefaultValue(defaultValue);
return this;
} }
/** /**
* Sets the modify function. * Sets the {@link Entry entry} up for deletion.
*/
public Entry delete() {
setDelete(true);
return this;
}
/**
* Creates a new {@link Entry entry}.
* *
* @param modify the modify function * @param modify the modification function
*/ */
public Entry modify(BiFunction<String, String, String> modify) { public Entry modify(BiFunction<String, String, String> modify) {
modify_ = modify; setModify(modify);
return this; return this;
} }
/** /**
* Sets the modify function. * Creates a new {@link Entry entry}.
* *
* @param value the value to perform a modification with * @param value the value to perform a modification with
* @param modify the modify function * @param modify the modification function
*/ */
public Entry modify(String value, BiFunction<String, String, String> modify) { public Entry modify(String value, BiFunction<String, String, String> modify) {
modifyValue_ = value; setModifyValue(value);
modify_ = modify; setModify(modify);
return this; return this;
} }
/**
* Returns the value to be used in the {@link #modify_} function.
*
* @return the modify value
*/
protected String modifyValue() {
return modifyValue_;
}
/** /**
* Sets the new {@link java.util.Properties property} value. * Sets the new {@link java.util.Properties property} value.
* *
* @param s The new value * @param s The new value
* @return the entry
*/ */
public Entry set(Object s) { public Entry set(Object s) {
newValue(s); setNewValue(s);
return this; return this;
} }
} }

224
src/main/java/rife/bld/extension/propertyfile/EntryBase.java
View file

@ -1,21 +1,22 @@
/* /*
* Copyright 2023-2025 the original author or authors. * Copyright 2023 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* https://www.apache.org/licenses/LICENSE-2.0 * https://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package rife.bld.extension.propertyfile; package rife.bld.extension.propertyfile;
import java.util.function.BiFunction;
import java.util.function.IntFunction; import java.util.function.IntFunction;
/** /**
@ -25,14 +26,17 @@ import java.util.function.IntFunction;
* @author <a href="https://github.com/gbevin">Geert Bevin</a> * @author <a href="https://github.com/gbevin">Geert Bevin</a>
* @since 1.0 * @since 1.0
*/ */
@SuppressWarnings({"unchecked", "PMD.AbstractClassWithoutAbstractMethod"}) @SuppressWarnings("PMD.DataClass")
public abstract class EntryBase<T> { public class EntryBase {
private IntFunction<Integer> calc_; private IntFunction<Integer> calc;
private Object defaultValue_; private Object defaultValue;
private boolean isDelete_; private boolean isDelete;
private String key_; private String key;
private Object newValue_; private BiFunction<String, String, String> modify;
private Object pattern_; private String modifyValue = "";
private Object newValue;
private String pattern = "";
private EntryDate.Units unit = EntryDate.Units.DAY;
/** /**
* Creates a new {@link EntryBase entry}. * Creates a new {@link EntryBase entry}.
@ -40,35 +44,88 @@ public abstract class EntryBase<T> {
* @param key the required property key * @param key the required property key
*/ */
public EntryBase(String key) { public EntryBase(String key) {
key_ = key; this.key = key;
} }
/** /**
* Returns the calculation function. * Returns the calculation function.
*
* @return the calc function
*/ */
protected IntFunction<Integer> calc() { protected IntFunction<Integer> getCalc() {
return calc_; return calc;
}
/**
* Sets the calculation function.
*
* @param calc the calc function
*/
public T calc(IntFunction<Integer> calc) {
calc_ = calc;
return (T) this;
} }
/** /**
* Returns the default value. * Returns the default value.
*
* @return the default value
*/ */
protected Object defaultValue() { protected Object getDefaultValue() {
return defaultValue_; return defaultValue;
}
/**
* Returns the key of the {@link java.util.Properties property}.
*/
protected String getKey() {
return key;
}
/**
* Returns the modify function.
*/
protected BiFunction<String, String, String> getModify() {
return modify;
}
/**
* Returns the value to be used in the {@link #modify} function.
*/
protected String getModifyValue() {
return modifyValue;
}
/**
* Returns the new value to set the {@link java.util.Properties property)} to.
*/
public Object getNewValue() {
return newValue;
}
/**
* Returns the pattern.
*/
protected String getPattern() {
return pattern;
}
/**
* Returns the {@link EntryDate.Units unit}.
*/
protected EntryDate.Units getUnit() {
return unit;
}
/**
* Returns {@code true} if the {@link java.util.Properties property} is to be deleted.
*/
protected boolean isDelete() {
return isDelete;
}
/**
* Sets the key of the {@link java.util.Properties property}.
*
* @param key the {@link java.util.Properties property} key
*/
@SuppressWarnings("unused")
public EntryBase key(String key) {
setKey(key);
return this;
}
/**
* Sets the calculation function.
*/
protected void setCalc(IntFunction<Integer> calc) {
this.calc = calc;
} }
/** /**
@ -76,55 +133,50 @@ public abstract class EntryBase<T> {
* *
* @param defaultValue the default value * @param defaultValue the default value
*/ */
public T defaultValue(Object defaultValue) { protected void setDefaultValue(Object defaultValue) {
defaultValue_ = defaultValue; this.defaultValue = defaultValue;
return (T) this;
} }
/** /**
* Indicates that the {@link java.util.Properties property} is to be deleted. * Sets whether the {@link java.util.Properties property} should be deleted.
*/ */
public T delete() { protected void setDelete(boolean delete) {
isDelete_ = true; isDelete = delete;
return (T) this;
}
/**
* Returns {@code true} if the {@link java.util.Properties property} is to be deleted.
*
* @return {@code true} or {@code false}
*/
protected boolean isDelete() {
return isDelete_;
}
/**
* Returns the key of the {@link java.util.Properties property}.
*
* @return the key
*/
protected String key() {
return key_;
} }
/** /**
* Sets the key of the {@link java.util.Properties property}. * Sets the key of the {@link java.util.Properties property}.
* *
* @param key the {@link java.util.Properties property} key * @param key the {@link java.util.Properties property} key
* @return this instance
*/ */
public T key(String key) { protected void setKey(String key) {
key_ = key; this.key = key;
return (T) this;
} }
/** /**
* Returns the new value to set the {@link java.util.Properties property)} to. * Sets the modify function.
*
* @return the new value
*/ */
protected Object newValue() { protected void setModify(BiFunction<String, String, String> modify) {
return newValue_; this.modify = modify;
}
/**
* Sets the modify function.
*
* @param value the value to perform a modification with
*/
protected void setModify(String value, BiFunction<String, String, String> modify) {
this.modifyValue = value;
this.modify = modify;
}
/**
* Sets the modify value.
*
* @param value the modify value.
*/
protected void setModifyValue(String value) {
this.modifyValue = value;
} }
/** /**
@ -132,26 +184,26 @@ public abstract class EntryBase<T> {
* *
* @param newValue the new value * @param newValue the new value
*/ */
protected void newValue(Object newValue) { public void setNewValue(Object newValue) {
newValue_ = newValue; this.newValue = newValue;
} }
/** /**
* Returns the pattern. * Sets the {@link java.text.DecimalFormat DecimalFormat} or {@link java.time.format.DateTimeFormatter DateTimeFormatter}
* * pattern to be used with {@link EntryDate} or {@link EntryInt} respectively.
* @return the pattern
*/
protected Object pattern() {
return pattern_;
}
/**
* Sets the {@link java.util.Formatter} pattern.
* *
* @param pattern the pattern * @param pattern the pattern
*/ */
public T pattern(Object pattern) { protected void setPattern(String pattern) {
pattern_ = pattern; this.pattern = pattern;
return (T) this; }
/**
* Sets the {@link EntryDate.Units unit} value to apply to calculations.
*
* @param unit the {@link EntryDate.Units unit}
*/
protected void setUnit(EntryDate.Units unit) {
this.unit = unit;
} }
} }

118
src/main/java/rife/bld/extension/propertyfile/EntryDate.java
View file

@ -1,17 +1,17 @@
/* /*
* Copyright 2023-2025 the original author or authors. * Copyright 2023 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* https://www.apache.org/licenses/LICENSE-2.0 * https://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package rife.bld.extension.propertyfile; package rife.bld.extension.propertyfile;
@ -19,6 +19,7 @@ package rife.bld.extension.propertyfile;
import java.time.*; import java.time.*;
import java.util.Calendar; import java.util.Calendar;
import java.util.Date; import java.util.Date;
import java.util.function.IntFunction;
/** /**
* Declares the modifications to be made to a {@link java.util.Properties Date-based property}. * Declares the modifications to be made to a {@link java.util.Properties Date-based property}.
@ -26,11 +27,9 @@ import java.util.Date;
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a> * @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @since 1.0 * @since 1.0
*/ */
public class EntryDate extends EntryBase<EntryDate> { public class EntryDate extends EntryBase {
private EntryDate.Units unit_ = EntryDate.Units.DAY;
/** /**
* Creates a new {@link EntryDate entry}. * Creates a new date {@link Entry entry}.
* *
* @param key the required property key * @param key the required property key
*/ */
@ -39,22 +38,39 @@ public class EntryDate extends EntryBase<EntryDate> {
} }
/** /**
* Sets the new {@link java.util.Properties property} value to now. * Creates a new {@link EntryDate entry}.
* *
* @return this instance * @param calc the calculation function
*/ */
public EntryDate now() { public EntryDate calc(IntFunction<Integer> calc) {
newValue("now"); setCalc(calc);
return this; return this;
} }
/** /**
* Sets the {@link java.time.format.DateTimeFormatter DateTimeFormatter} pattern. * Sets the {@link EntryDate entry} up for deletion.
*/
public EntryDate delete() {
setDelete(true);
return this;
}
/**
* Sets the new {@link java.util.Properties property} value to now.
*/
public EntryDate now() {
setNewValue("now");
return this;
}
/**
* Sets the pattern for {@link EntryInt} and {@link EntryDate} to{@link java.text.DecimalFormat DecimalFormat} and
* {@link java.time.format.DateTimeFormatter DateTimeFormatter} respectively.
* *
* @param pattern the pattern * @param pattern the pattern
*/ */
public EntryDate pattern(String pattern) { public EntryDate pattern(String pattern) {
super.pattern(pattern); setPattern(pattern);
return this; return this;
} }
@ -62,10 +78,9 @@ public class EntryDate extends EntryBase<EntryDate> {
* Sets the new {@link java.util.Properties property} value to an {@link Instant} * Sets the new {@link java.util.Properties property} value to an {@link Instant}
* *
* @param instant the {@link Instant} to set the value to * @param instant the {@link Instant} to set the value to
* @return this instance
*/ */
public EntryDate set(Instant instant) { public EntryDate set(Instant instant) {
newValue(instant); setNewValue(instant);
return this; return this;
} }
@ -73,10 +88,9 @@ public class EntryDate extends EntryBase<EntryDate> {
* Sets the new {@link java.util.Properties property} value to a {@link LocalDate} * Sets the new {@link java.util.Properties property} value to a {@link LocalDate}
* *
* @param date the {@link LocalDate} to set the value to * @param date the {@link LocalDate} to set the value to
* @return this instance
*/ */
public EntryDate set(LocalDate date) { public EntryDate set(LocalDate date) {
newValue(date); setNewValue(date);
return this; return this;
} }
@ -84,10 +98,9 @@ public class EntryDate extends EntryBase<EntryDate> {
* Sets the new {@link java.util.Properties property} value to a {@link LocalDateTime} * Sets the new {@link java.util.Properties property} value to a {@link LocalDateTime}
* *
* @param date the {@link LocalDateTime} to set the value to * @param date the {@link LocalDateTime} to set the value to
* @return this instance
*/ */
public EntryDate set(LocalDateTime date) { public EntryDate set(LocalDateTime date) {
newValue(date); setNewValue(date);
return this; return this;
} }
@ -95,10 +108,9 @@ public class EntryDate extends EntryBase<EntryDate> {
* Sets the new {@link java.util.Properties property} value to a {@link ZonedDateTime} * Sets the new {@link java.util.Properties property} value to a {@link ZonedDateTime}
* *
* @param date the {@link ZonedDateTime} to set the value to * @param date the {@link ZonedDateTime} to set the value to
* @return this instance
*/ */
public EntryDate set(ZonedDateTime date) { public EntryDate set(ZonedDateTime date) {
newValue(date); setNewValue(date);
return this; return this;
} }
@ -106,10 +118,9 @@ public class EntryDate extends EntryBase<EntryDate> {
* Sets the new {@link java.util.Properties property} value to a {@link LocalTime} * Sets the new {@link java.util.Properties property} value to a {@link LocalTime}
* *
* @param time the {@link LocalTime} to set the value to * @param time the {@link LocalTime} to set the value to
* @return this instance
*/ */
public EntryDate set(LocalTime time) { public EntryDate set(LocalTime time) {
newValue(time); setNewValue(time);
return this; return this;
} }
@ -117,10 +128,9 @@ public class EntryDate extends EntryBase<EntryDate> {
* Sets the new {@link java.util.Properties property} value to a {@link Calendar} * Sets the new {@link java.util.Properties property} value to a {@link Calendar}
* *
* @param cal the {@link Calendar} to set the value to * @param cal the {@link Calendar} to set the value to
* @return this instance
*/ */
public EntryDate set(Calendar cal) { public EntryDate set(Calendar cal) {
newValue(cal); setNewValue(cal);
return this; return this;
} }
@ -128,30 +138,19 @@ public class EntryDate extends EntryBase<EntryDate> {
* Sets the new {@link java.util.Properties property} value to a {@link Date} * Sets the new {@link java.util.Properties property} value to a {@link Date}
* *
* @param date the {@link Date} to set the value to * @param date the {@link Date} to set the value to
* @return this instance
*/ */
public EntryDate set(Date date) { public EntryDate set(Date date) {
newValue(date); setNewValue(date);
return this; return this;
} }
/**
* Returns the {@link EntryDate.Units unit}.
*
* @return the unit
*/
public EntryDate.Units unit() {
return unit_;
}
/** /**
* Sets the {@link Units unit} value to apply to calculations for {@link EntryDate}. * Sets the {@link Units unit} value to apply to calculations for {@link EntryDate}.
* *
* @param unit the {@link Units unit} * @param unit the {@link Units unit}
* @return this instance
*/ */
public EntryDate unit(Units unit) { public EntryDate unit(Units unit) {
unit_ = unit; setUnit(unit);
return this; return this;
} }
@ -169,33 +168,6 @@ public class EntryDate extends EntryBase<EntryDate> {
* </uL> * </uL>
*/ */
public enum Units { public enum Units {
/** SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR
* Second units.
*/
SECOND,
/**
* Minute units.
*/
MINUTE,
/**
* Hour units.
*/
HOUR,
/**
* Day units.
*/
DAY,
/**
* Week units.
*/
WEEK,
/**
* Month units.
*/
MONTH,
/**
* Year units.
*/
YEAR
} }
} }

56
src/main/java/rife/bld/extension/propertyfile/EntryInt.java
View file

@ -1,30 +1,32 @@
/* /*
* Copyright 2023-2025 the original author or authors. * Copyright 2023 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* https://www.apache.org/licenses/LICENSE-2.0 * https://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package rife.bld.extension.propertyfile; package rife.bld.extension.propertyfile;
import java.util.function.IntFunction;
/** /**
* Declares the modifications to be made to an {@link java.util.Properties Integer-based property}. * Declares the modifications to be made to an {@link java.util.Properties Integer-based property}.
* *
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a> * @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @since 1.0 * @since 1.0
*/ */
public class EntryInt extends EntryBase<EntryInt> { public class EntryInt extends EntryBase {
/** /**
* Creates a new {@link EntryInt entry}. * Creates a new date {@link Entry entry}.
* *
* @param key the required property key * @param key the required property key
*/ */
@ -33,12 +35,31 @@ public class EntryInt extends EntryBase<EntryInt> {
} }
/** /**
* Sets the {@link java.text.DecimalFormat DecimalFormat} pattern. * Creates a new {@link EntryInt entry}.
* *
* @param pattern the pattern * @param calc the calculation function.
*/ */
public EntryInt pattern(String pattern) { public EntryInt calc(IntFunction<Integer> calc) {
super.pattern(pattern); setCalc(calc);
return this;
}
/**
* Sets the initial value to set the {@link java.util.Properties property} to, if not already defined.
*
* @param defaultValue the default value
*/
@SuppressWarnings("unused")
public EntryInt defaultValue(Object defaultValue) {
setDefaultValue(defaultValue);
return this;
}
/**
* Sets the {@link EntryInt entry} up for deletion.
*/
public EntryInt delete() {
setDelete(true);
return this; return this;
} }
@ -46,10 +67,9 @@ public class EntryInt extends EntryBase<EntryInt> {
* Sets the new {@link java.util.Properties property} value to an integer. * Sets the new {@link java.util.Properties property} value to an integer.
* *
* @param i The integer to set the value to * @param i The integer to set the value to
* @return this instance
*/ */
public EntryInt set(int i) { public EntryInt set(int i) {
newValue(i); setNewValue(i);
return this; return this;
} }
} }

151
src/main/java/rife/bld/extension/propertyfile/PropertyFileOperation.java
View file

@ -1,32 +1,28 @@
/* /*
* Copyright 2023-2025 the original author or authors. * Copyright 2023 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* https://www.apache.org/licenses/LICENSE-2.0 * https://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package rife.bld.extension.propertyfile; package rife.bld.extension.propertyfile;
import rife.bld.BaseProject; import rife.bld.BaseProject;
import rife.bld.operations.AbstractOperation; import rife.bld.operations.AbstractOperation;
import rife.bld.operations.exceptions.ExitStatusException;
import java.io.File; import java.io.File;
import java.nio.file.Path;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.Properties; import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;
/** /**
* Creates or applies edits to a {@link Properties Properties} file. * Creates or applies edits to a {@link Properties Properties} file.
@ -35,21 +31,20 @@ import java.util.logging.Logger;
* @since 1.0 * @since 1.0
*/ */
public class PropertyFileOperation extends AbstractOperation<PropertyFileOperation> { public class PropertyFileOperation extends AbstractOperation<PropertyFileOperation> {
private static final Logger LOGGER = Logger.getLogger(PropertyFileOperation.class.getName()); private final List<EntryBase> entries = new ArrayList<>();
private final List<EntryBase<?>> entries_ = new ArrayList<>(); private String comment = "";
private String comment_ = ""; private boolean failOnWarning;
private boolean failOnWarning_; private File file;
private File file_; private BaseProject project;
private BaseProject project_;
/** /**
* Sets the comment to be inserted at the top of the {@link java.util.Properties} file. * Sets the comment to be inserted at the top of the {@link java.util.Properties} file.
* *
* @param comment the header comment * @param comment the header comment
* @return this instance
*/ */
@SuppressWarnings("unused")
public PropertyFileOperation comment(String comment) { public PropertyFileOperation comment(String comment) {
comment_ = comment; this.comment = comment;
return this; return this;
} }
@ -58,10 +53,10 @@ public class PropertyFileOperation extends AbstractOperation<PropertyFileOperati
* file. * file.
* *
* @param entry the {@link Entry entry} * @param entry the {@link Entry entry}
* @return this instance
*/ */
public PropertyFileOperation entry(EntryBase<?> entry) { @SuppressWarnings("unused")
entries_.add(entry); public PropertyFileOperation entry(EntryBase entry) {
entries.add(entry);
return this; return this;
} }
@ -70,49 +65,38 @@ public class PropertyFileOperation extends AbstractOperation<PropertyFileOperati
*/ */
@Override @Override
public void execute() throws Exception { public void execute() throws Exception {
if (project_ == null) { var commandName = project.getCurrentCommandName();
if (LOGGER.isLoggable(Level.SEVERE) && !silent()) {
LOGGER.log(Level.SEVERE, "A project is required");
}
throw new ExitStatusException(ExitStatusException.EXIT_FAILURE);
}
var commandName = project_.getCurrentCommandName();
var properties = new Properties(); var properties = new Properties();
var success = true; var success = false;
if (file_ == null) { if (file == null) {
warn(commandName, "A properties file must be specified."); PropertyFileUtils.warn(commandName, "A properties file must be specified.");
} else { } else {
success = PropertyFileUtils.loadProperties(commandName, file_, properties, silent()); success = PropertyFileUtils.loadProperties(commandName, file, properties);
} }
if (success) { if (success) {
for (var entry : entries_) { for (var entry : entries) {
if (entry.key().isBlank()) { if (entry.getKey().isBlank()) {
warn(commandName, "An entry key must specified."); PropertyFileUtils.warn(commandName, "An entry key must specified.");
} else { } else {
var key = entry.key(); var key = entry.getKey();
Object value = entry.newValue(); Object value = entry.getNewValue();
Object defaultValue = entry.defaultValue(); Object defaultValue = entry.getDefaultValue();
var p = properties.getProperty(key); var p = properties.getProperty(key);
if (entry.isDelete()) { if (entry.isDelete()) {
properties.remove(key); properties.remove(key);
} else if ((value == null || String.valueOf(value).isBlank()) } else if ((value == null || String.valueOf(value).isBlank())
&& (defaultValue == null || String.valueOf(defaultValue).isBlank()) && (defaultValue == null || String.valueOf(defaultValue).isBlank())
&& (p == null || p.isBlank())) { && (p == null || p.isBlank())) {
warn(commandName, "An entry must be set or have a default value: " + key); PropertyFileUtils.warn(commandName, "An entry must be set or have a default value: " + key);
} else { } else {
try { if (entry instanceof EntryDate) {
if (entry instanceof EntryDate) { success = PropertyFileUtils.processDate(commandName, properties, (EntryDate) entry, failOnWarning);
PropertyFileUtils.processDate(properties, (EntryDate) entry); } else if (entry instanceof EntryInt) {
} else if (entry instanceof EntryInt) { success = PropertyFileUtils.processInt(commandName, properties, (EntryInt) entry, failOnWarning);
PropertyFileUtils.processInt(properties, (EntryInt) entry); } else {
} else { success = PropertyFileUtils.processString(properties, (Entry) entry);
PropertyFileUtils.processString(properties, (Entry) entry);
}
} catch (IllegalArgumentException e) {
warn(commandName, e.getMessage());
} }
} }
} }
@ -120,7 +104,7 @@ public class PropertyFileOperation extends AbstractOperation<PropertyFileOperati
} }
if (success) { if (success) {
PropertyFileUtils.saveProperties(file_, comment_, properties); PropertyFileUtils.saveProperties(file, comment, properties);
} }
} }
@ -128,10 +112,10 @@ public class PropertyFileOperation extends AbstractOperation<PropertyFileOperati
* Sets the {@link #execute() execution} to return a failure on any warnings. * Sets the {@link #execute() execution} to return a failure on any warnings.
* *
* @param failOnWarning if set to {@code true}, the execution will fail on any warnings. * @param failOnWarning if set to {@code true}, the execution will fail on any warnings.
* @return this instance
*/ */
@SuppressWarnings("unused")
public PropertyFileOperation failOnWarning(boolean failOnWarning) { public PropertyFileOperation failOnWarning(boolean failOnWarning) {
failOnWarning_ = failOnWarning; this.failOnWarning = failOnWarning;
return this; return this;
} }
@ -139,10 +123,10 @@ public class PropertyFileOperation extends AbstractOperation<PropertyFileOperati
* Sets the location of the {@link java.util.Properties} file to be edited. * Sets the location of the {@link java.util.Properties} file to be edited.
* *
* @param file the file to be edited * @param file the file to be edited
* @return this instance
*/ */
@SuppressWarnings("unused")
public PropertyFileOperation file(File file) { public PropertyFileOperation file(File file) {
file_ = file; this.file = file;
return this; return this;
} }
@ -150,59 +134,18 @@ public class PropertyFileOperation extends AbstractOperation<PropertyFileOperati
* Sets the location of the {@link java.util.Properties} file to be edited. * Sets the location of the {@link java.util.Properties} file to be edited.
* *
* @param file the file to be edited * @param file the file to be edited
* @return this instance
*/ */
@SuppressWarnings("unused")
public PropertyFileOperation file(String file) { public PropertyFileOperation file(String file) {
return file(new File(file)); this.file = new File(file);
} return this;
/**
* Retrieves the location of the {@link java.util.Properties} file to be edited.
*
* @return the properties file
*/
public File file() {
return file_;
}
/**
* Sets the location of the {@link java.util.Properties} file to be edited.
*
* @param file the file to be edited
* @return this instance
*/
public PropertyFileOperation file(Path file) {
return file(file.toFile());
} }
/** /**
* Creates a new operation. * Creates a new operation.
*
* @param project the project
* @return this instance
*/ */
public PropertyFileOperation fromProject(BaseProject project) { public PropertyFileOperation fromProject(BaseProject project) {
project_ = project; this.project = project;
return this; return this;
} }
/**
* Logs a warning.
*
* @param command The command name
* @param message the message log
* @throws ExitStatusException if a {@link Level#SEVERE} exception occurs
*/
private void warn(String command, String message) throws ExitStatusException {
if (failOnWarning_) {
if (LOGGER.isLoggable(Level.SEVERE) && !silent()) {
LOGGER.log(Level.SEVERE, '[' + command + "] " + message);
throw new ExitStatusException(ExitStatusException.EXIT_FAILURE);
}
} else {
if (LOGGER.isLoggable(Level.WARNING) && !silent()) {
LOGGER.warning('[' + command + "] " + message);
}
}
}
} }

226
src/main/java/rife/bld/extension/propertyfile/PropertyFileUtils.java
View file

@ -1,23 +1,22 @@
/* /*
* Copyright 2023-2025 the original author or authors. * Copyright 2023 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* https://www.apache.org/licenses/LICENSE-2.0 * https://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package rife.bld.extension.propertyfile; package rife.bld.extension.propertyfile;
import rife.bld.operations.exceptions.ExitStatusException; import javax.imageio.IIOException;
import java.io.File; import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.nio.file.Files; import java.nio.file.Files;
@ -39,7 +38,7 @@ import java.util.logging.Logger;
* @since 1.0 * @since 1.0
*/ */
public final class PropertyFileUtils { public final class PropertyFileUtils {
private static final Logger LOGGER = Logger.getLogger(PropertyFileUtils.class.getName()); private final static Logger LOGGER = Logger.getLogger(PropertyFileUtils.class.getName());
private PropertyFileUtils() { private PropertyFileUtils() {
// no-op // no-op
@ -49,9 +48,8 @@ public final class PropertyFileUtils {
* Returns the new value, value or default value depending on which is specified. * Returns the new value, value or default value depending on which is specified.
* *
* @param value the value * @param value the value
* @param defaultValue the default value
* @param newValue the new value * @param newValue the new value
* @return the object * @param defaultValue the default value
*/ */
public static Object currentValue(String value, Object defaultValue, Object newValue) { public static Object currentValue(String value, Object defaultValue, Object newValue) {
if (newValue != null) { if (newValue != null) {
@ -69,154 +67,160 @@ public final class PropertyFileUtils {
* @param command the issuing command * @param command the issuing command
* @param file the file location * @param file the file location
* @param p the {@link Properties properties} to load into. * @param p the {@link Properties properties} to load into.
* @return the boolean
* @throws ExitStatusException if an error occurred
*/ */
public static boolean loadProperties(String command, File file, Properties p, boolean silent) @SuppressWarnings("PMD.SignatureDeclareThrowsException")
throws ExitStatusException { public static boolean loadProperties(String command, File file, Properties p) throws Exception {
boolean success = true; boolean success = true;
if (file != null) { if (file != null) {
if (file.exists()) { if (file.exists()) {
try (var propStream = Files.newInputStream(file.toPath(), StandardOpenOption.READ)) { try (var propStream = Files.newInputStream(file.toPath(), StandardOpenOption.READ)) {
p.load(propStream); p.load(propStream);
} catch (IOException ioe) { } catch (IOException ioe) {
warn(command, "Could not load properties file: " + ioe.getMessage(), true, silent); warn(command, "Could not load properties file: " + ioe.getMessage(), ioe, true);
success = false; success = false;
} }
} }
} else { } else {
warn(command, "Please specify the properties file location.", true, silent); warn(command, "Please specify the properties file location.");
success = false; success = false;
} }
return success; return success;
} }
private static String objectToString(Object o) {
if (o == null) {
return "";
} else {
return String.valueOf(o);
}
}
/** /**
* Processes a date {@link Properties property}. * Processes a date {@link Properties property}.
* *
* @param p the {@link Properties property} * @param command the issuing command
* @param entry the {@link Entry} containing the {@link Properties property} edits * @param p the {@link Properties property}
* @throws DateTimeException if a parsing error occurs * @param entry the {@link Entry} containing the {@link Properties property} edits
*/ */
@SuppressWarnings("PMD.ExceptionAsFlowControl") @SuppressWarnings({"PMD.SignatureDeclareThrowsException", "PMD.ExceptionAsFlowControl"})
public static void processDate(Properties p, EntryDate entry) throws IllegalArgumentException { public static boolean processDate(String command, Properties p, EntryDate entry, boolean failOnWarning)
var currentValue = currentValue(null, entry.defaultValue(), entry.newValue()); throws Exception {
var pattern = objectToString(entry.pattern()); var success = true;
var value = currentValue(null, entry.getDefaultValue(),
entry.getNewValue());
var dateValue = String.valueOf(currentValue); var pattern = entry.getPattern();
String parsedValue = String.valueOf(value);
if (pattern != null && !pattern.isBlank()) { if (pattern != null && !pattern.isBlank()) {
var offset = 0; var offset = 0;
if (entry.calc() != null) { if (entry.getCalc() != null) {
offset = entry.calc().apply(offset); offset = entry.getCalc().apply(offset);
} }
var dtf = DateTimeFormatter.ofPattern(pattern); var dtf = DateTimeFormatter.ofPattern(pattern);
var unit = entry.unit(); var unit = entry.getUnit();
try { try {
if (currentValue instanceof String) { if (value instanceof String) {
if ("now".equalsIgnoreCase((String) currentValue)) { if ("now".equalsIgnoreCase((String) value)) {
currentValue = ZonedDateTime.now(); value = ZonedDateTime.now();
} else { } else {
throw new DateTimeException("Excepted: Calendar, Date or java.time."); throw new DateTimeException("Excepted: Calendar, Date or java.time.");
} }
} else if (currentValue instanceof LocalDateTime) { } else if (value instanceof LocalDateTime) {
currentValue = ((LocalDateTime) currentValue).atZone(ZoneId.systemDefault()); value = ((LocalDateTime) value).atZone(ZoneId.systemDefault());
} else if (currentValue instanceof Date) { } else if (value instanceof Date) {
currentValue = ((Date) currentValue).toInstant().atZone(ZoneId.systemDefault()); value = ((Date) value).toInstant().atZone(ZoneId.systemDefault());
} else if (currentValue instanceof Calendar) { } else if (value instanceof Calendar) {
currentValue = ((Calendar) currentValue).toInstant().atZone(ZoneId.systemDefault()); value = ((Calendar) value).toInstant().atZone(ZoneId.systemDefault());
} else if (currentValue instanceof Instant) { } else if (value instanceof Instant) {
currentValue = ((Instant) currentValue).atZone(ZoneId.systemDefault()); value = ((Instant) value).atZone(ZoneId.systemDefault());
} }
if (currentValue instanceof LocalDate) { if (value instanceof LocalDate) {
if (offset != 0) { if (offset != 0) {
if (unit == EntryDate.Units.DAY) { if (unit == EntryDate.Units.DAY) {
currentValue = ((LocalDate) currentValue).plusDays(offset); value = ((LocalDate) value).plusDays(offset);
} else if (unit == EntryDate.Units.MONTH) { } else if (unit == EntryDate.Units.MONTH) {
currentValue = ((LocalDate) currentValue).plusMonths(offset); value = ((LocalDate) value).plusMonths(offset);
} else if (unit == EntryDate.Units.WEEK) { } else if (unit == EntryDate.Units.WEEK) {
currentValue = ((LocalDate) currentValue).plusWeeks(offset); value = ((LocalDate) value).plusWeeks(offset);
} else if (unit == EntryDate.Units.YEAR) { } else if (unit == EntryDate.Units.YEAR) {
currentValue = ((LocalDate) currentValue).plusYears(offset); value = ((LocalDate) value).plusYears(offset);
} }
} }
dateValue = dtf.format((LocalDate) currentValue); parsedValue = dtf.format((LocalDate) value);
} else if (currentValue instanceof LocalTime) { } else if (value instanceof LocalTime) {
if (offset != 0) { if (offset != 0) {
if (unit == EntryDate.Units.SECOND) { if (unit == EntryDate.Units.SECOND) {
currentValue = ((LocalTime) currentValue).plusSeconds(offset); value = ((LocalTime) value).plusSeconds(offset);
} else if (unit == EntryDate.Units.MINUTE) { } else if (unit == EntryDate.Units.MINUTE) {
currentValue = ((LocalTime) currentValue).plusMinutes(offset); value = ((LocalTime) value).plusMinutes(offset);
} else if (unit == EntryDate.Units.HOUR) { } else if (unit == EntryDate.Units.HOUR) {
currentValue = ((LocalTime) currentValue).plusHours(offset); value = ((LocalTime) value).plusHours(offset);
} }
} }
dateValue = dtf.format((LocalTime) currentValue); parsedValue = dtf.format((LocalTime) value);
} else if (currentValue instanceof ZonedDateTime) { } else if (value instanceof ZonedDateTime) {
if (offset != 0) { if (offset != 0) {
if (unit == EntryDate.Units.DAY) { if (unit == EntryDate.Units.DAY) {
currentValue = ((ZonedDateTime) currentValue).plusDays(offset); value = ((ZonedDateTime) value).plusDays(offset);
} else if (unit == EntryDate.Units.MONTH) { } else if (unit == EntryDate.Units.MONTH) {
currentValue = ((ZonedDateTime) currentValue).plusMonths(offset); value = ((ZonedDateTime) value).plusMonths(offset);
} else if (unit == EntryDate.Units.WEEK) { } else if (unit == EntryDate.Units.WEEK) {
currentValue = ((ZonedDateTime) currentValue).plusWeeks(offset); value = ((ZonedDateTime) value).plusWeeks(offset);
} else if (unit == EntryDate.Units.YEAR) { } else if (unit == EntryDate.Units.YEAR) {
currentValue = ((ZonedDateTime) currentValue).plusYears(offset); value = ((ZonedDateTime) value).plusYears(offset);
} else if (unit == EntryDate.Units.SECOND) { } else if (unit == EntryDate.Units.SECOND) {
currentValue = ((ZonedDateTime) currentValue).plusSeconds(offset); value = ((ZonedDateTime) value).plusSeconds(offset);
} else if (unit == EntryDate.Units.MINUTE) { } else if (unit == EntryDate.Units.MINUTE) {
currentValue = ((ZonedDateTime) currentValue).plusMinutes(offset); value = ((ZonedDateTime) value).plusMinutes(offset);
} else if (unit == EntryDate.Units.HOUR) { } else if (unit == EntryDate.Units.HOUR) {
currentValue = ((ZonedDateTime) currentValue).plusHours(offset); value = ((ZonedDateTime) value).plusHours(offset);
} }
} }
dateValue = dtf.format((ZonedDateTime) currentValue); parsedValue = dtf.format((ZonedDateTime) value);
} }
} catch (DateTimeException dte) { } catch (DateTimeException dte) {
throw new IllegalArgumentException( warn(command, "Non-date value for \"" + entry.getKey() + "\" --> " + dte.getMessage(),
"Non-date value for \"" + entry.key() + "\" --> " + dte.getMessage(), dte); dte, failOnWarning);
success = false;
} }
} }
p.setProperty(entry.key(), dateValue);
if (success) {
p.setProperty(entry.getKey(), parsedValue);
}
return success;
} }
/** /**
* Processes an integer {@link Properties property}. * Processes an integer {@link Properties property}.
* *
* @param p the {@link Properties property} * @param command the issuing command
* @param entry the {@link Entry} containing the {@link Properties property} edits * @param p the {@link Properties property}
* @throws NumberFormatException if a parsing error occurs * @param entry the {@link Entry} containing the {@link Properties property} edits
*/ */
public static void processInt(Properties p, EntryInt entry) throws IllegalArgumentException { @SuppressWarnings("PMD.SignatureDeclareThrowsException")
public static boolean processInt(String command, Properties p, EntryInt entry, boolean failOnWarning)
throws Exception {
var success = true;
int intValue = 0; int intValue = 0;
try { try {
var fmt = new DecimalFormat(objectToString(entry.pattern())); var fmt = new DecimalFormat(entry.getPattern());
var currentValue = currentValue(p.getProperty(entry.key()), entry.defaultValue(), entry.newValue()); var value = currentValue(p.getProperty(entry.getKey()), entry.getDefaultValue(),
entry.getNewValue());
if (currentValue != null) { if (value != null) {
intValue = fmt.parse(String.valueOf(currentValue)).intValue(); intValue = fmt.parse(String.valueOf(value)).intValue();
} }
if (entry.calc() != null) { if (entry.getCalc() != null) {
intValue = entry.calc().apply(intValue); intValue = entry.getCalc().apply(intValue);
} }
p.setProperty(entry.getKey(), fmt.format(intValue));
p.setProperty(entry.key(), fmt.format(intValue));
} catch (NumberFormatException | ParseException e) { } catch (NumberFormatException | ParseException e) {
throw new IllegalArgumentException( warn(command, "Non-integer value for \"" + entry.getKey() + "\" --> " + e.getMessage(), e,
"Non-integer value for \"" + entry.key() + "\" --> " + e.getMessage(), e); failOnWarning);
success = false;
} }
return success;
} }
/** /**
@ -225,15 +229,16 @@ public final class PropertyFileUtils {
* @param p the {@link Properties property} * @param p the {@link Properties property}
* @param entry the {@link Entry} containing the {@link Properties property} edits * @param entry the {@link Entry} containing the {@link Properties property} edits
*/ */
public static void processString(Properties p, Entry entry) { public static boolean processString(Properties p, Entry entry) {
var currentValue = currentValue(p.getProperty(entry.key()), entry.defaultValue(), entry.newValue()); var value = currentValue(p.getProperty(entry.getKey()), entry.getDefaultValue(), entry.getNewValue());
p.setProperty(entry.key(), String.format(String.valueOf(currentValue), entry.pattern())); p.setProperty(entry.getKey(), String.valueOf(value));
if (entry.modify() != null && entry.modifyValue() != null) { if (entry.getModify() != null && entry.getModifyValue() != null) {
var modify = entry.modify().apply(p.getProperty(entry.key()), entry.modifyValue()); p.setProperty(entry.getKey(), entry.getModify().apply(p.getProperty(entry.getKey()), entry.getModifyValue()));
p.setProperty(entry.key(), String.format(modify, entry.pattern()));
} }
return true;
} }
/** /**
@ -242,13 +247,24 @@ public final class PropertyFileUtils {
* @param file the file location * @param file the file location
* @param comment the header comment * @param comment the header comment
* @param p the {@link Properties} to save into the file * @param p the {@link Properties} to save into the file
* @throws IOException the io exception
*/ */
public static void saveProperties(File file, String comment, Properties p) throws IOException { public static void saveProperties(File file, String comment, Properties p) throws IOException {
try (var output = Files.newOutputStream(file.toPath())) { try (var output = Files.newOutputStream(file.toPath())) {
p.store(output, comment); p.store(output, comment);
} catch (IOException ioe) { } catch (IIOException ioe) {
throw new IOException("An IO error occurred while saving the Properties file: " + file, ioe); throw new IIOException("An IO error occurred while saving the Properties file: " + file, ioe);
}
}
/**
* Logs a warning.
*
* @param command the issuing command
* @param message the message to log
*/
static void warn(String command, String message) {
if (LOGGER.isLoggable(Level.WARNING)) {
LOGGER.warning('[' + command + "] " + message);
} }
} }
@ -257,20 +273,16 @@ public final class PropertyFileUtils {
* *
* @param command The command name * @param command The command name
* @param message the message log * @param message the message log
* @param e the related exception
* @param failOnWarning logs and throws exception if set to {@code true} * @param failOnWarning logs and throws exception if set to {@code true}
* @throws ExitStatusException if a {@link Level#SEVERE} exception occurs
*/ */
static void warn(String command, String message, boolean failOnWarning, boolean silent) @SuppressWarnings({"PMD.SignatureDeclareThrowsException"})
throws ExitStatusException { static void warn(String command, String message, Exception e, boolean failOnWarning) throws Exception {
if (failOnWarning) { if (failOnWarning) {
if (LOGGER.isLoggable(Level.SEVERE) && !silent) { LOGGER.log(Level.SEVERE, '[' + command + "] " + message, e);
LOGGER.log(Level.SEVERE, '[' + command + "] " + message); throw e;
}
throw new ExitStatusException(ExitStatusException.EXIT_FAILURE);
} else { } else {
if (LOGGER.isLoggable(Level.WARNING) && !silent) { warn(command, message);
LOGGER.warning('[' + command + "] " + message);
}
} }
} }
} }

104
src/test/java/rife/bld/extension/propertyfile/PropertyFileOperationTest.java
View file

@ -1,104 +0,0 @@
/*
* Copyright 2023-2025 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.propertyfile;
import org.assertj.core.api.AutoCloseableSoftAssertions;
import org.junit.jupiter.api.Test;
import rife.bld.Project;
import rife.bld.operations.exceptions.ExitStatusException;
import java.io.File;
import java.nio.file.Files;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
import java.util.Properties;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatCode;
import static rife.bld.extension.propertyfile.Calc.ADD;
class PropertyFileOperationTest {
@Test
@SuppressWarnings("PMD.AvoidDuplicateLiterals")
void testExecute() throws Exception {
var tmpFile = File.createTempFile("property-file-", "properties");
tmpFile.deleteOnExit();
new PropertyFileOperation()
.fromProject(new Project())
.file(tmpFile)
.comment("This is a comment")
.failOnWarning(true)
.entry(new EntryInt("version.major").defaultValue(0).calc(ADD))
.entry(new EntryInt("version.minor").set(0))
.entry(new EntryInt("version.patch").set(0))
.entry(new EntryDate("build.date").now().pattern("yyyy-MM-dd"))
.execute();
var p = new Properties();
p.load(Files.newInputStream(tmpFile.toPath()));
try (var softly = new AutoCloseableSoftAssertions()) {
softly.assertThat(p.getProperty("version.major")).as("major").isEqualTo("1");
softly.assertThat(p.getProperty("version.minor")).as("minor").isEqualTo("0");
softly.assertThat(p.getProperty("version.patch")).as("patch").isEqualTo("0");
softly.assertThat(p.getProperty("build.date")).as("date")
.isEqualTo(LocalDate.now().format(DateTimeFormatter.ISO_LOCAL_DATE));
}
new PropertyFileOperation()
.fromProject(new Project())
.file(tmpFile.getAbsolutePath())
.entry(new EntryInt("version.major").calc(c -> c + 2))
.execute();
p.load(Files.newInputStream(tmpFile.toPath()));
assertThat(p.getProperty("version.major")).as("major+2").isEqualTo("3");
new PropertyFileOperation()
.fromProject(new Project())
.file(tmpFile)
.entry(new EntryInt("build.date").delete())
.execute();
p.clear();
p.load(Files.newInputStream(tmpFile.toPath()));
assertThat(p.getProperty("build.date")).as("dalete build.date").isNull();
assertThat(p).as("version keys").containsKeys("version.major", "version.minor", "version.patch");
}
@Test
void testExecuteNoProject() {
var op = new PropertyFileOperation();
assertThatCode(op::execute).isInstanceOf(ExitStatusException.class);
}
@Test
void testFile() {
var foo = new File("foo");
var op = new PropertyFileOperation().file("foo");
assertThat(op.file()).as("as string").isEqualTo(foo);
op = new PropertyFileOperation().file(foo);
assertThat(op.file()).as("as file").isEqualTo(foo);
op = new PropertyFileOperation().file(foo.toPath());
assertThat(op.file()).as("as path").isEqualTo(foo);
}
}

234
src/test/java/rife/bld/extension/propertyfile/PropertyFileUtilsTest.java
View file

@ -1,35 +1,35 @@
/* /*
* Copyright 2023-2025 the original author or authors. * Copyright 2023 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* https://www.apache.org/licenses/LICENSE-2.0 * https://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package rife.bld.extension.propertyfile; package rife.bld.extension.propertyfile;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import rife.bld.operations.exceptions.ExitStatusException;
import rife.tools.Localization; import rife.tools.Localization;
import java.io.File; import java.io.File;
import java.io.IOException;
import java.time.*; import java.time.*;
import java.util.Calendar; import java.util.Calendar;
import java.util.Date; import java.util.Date;
import java.util.Properties; import java.util.Properties;
import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThat; // NOPMD
import static org.assertj.core.api.Assertions.assertThatCode; import static org.assertj.core.api.Assertions.assertThatCode; // NOPMD
import static rife.bld.extension.propertyfile.Calc.ADD; import static rife.bld.extension.propertyfile.Calc.ADD; // NOPMD
import static rife.bld.extension.propertyfile.Calc.SUB; import static rife.bld.extension.propertyfile.Calc.SUB; // NOPMD
/** /**
* PropertyFileUtilsTest class * PropertyFileUtilsTest class
@ -37,8 +37,8 @@ import static rife.bld.extension.propertyfile.Calc.SUB;
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a> * @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @since 1.0 * @since 1.0
*/ */
@SuppressWarnings("PMD.AvoidDuplicateLiterals")
class PropertyFileUtilsTest { class PropertyFileUtilsTest {
final static int dayOfYear = LocalDate.now().getDayOfYear();
final static Properties p = new Properties(); final static Properties p = new Properties();
final static String t = "test"; final static String t = "test";
@ -49,7 +49,7 @@ class PropertyFileUtilsTest {
public EntryDate newEntryDate() { public EntryDate newEntryDate() {
p.clear(); p.clear();
return new EntryDate("aDate").pattern("D"); return new EntryDate("adate").pattern("D");
} }
public EntryInt newEntryInt() { public EntryInt newEntryInt() {
@ -58,41 +58,42 @@ class PropertyFileUtilsTest {
} }
@Test @Test
void parseDateSub() { @SuppressWarnings("PMD.SignatureDeclareThrowsException")
var entryDate = newEntryDate().calc(SUB); void parseDateSub() throws Exception {
PropertyFileUtils.processDate(p, entryDate.now()); var entryDate = newEntryDate();
assertThat(p.getProperty(entryDate.key())).as("processDate(now-3)").isEqualTo(String.valueOf( entryDate.setCalc(SUB);
LocalDateTime.now().minusDays(1).getDayOfYear())); PropertyFileUtils.processDate(t, p, entryDate.now(), true);
assertThat(p.getProperty(entryDate.getKey())).as("processDate(now-3)").isEqualTo(String.valueOf(dayOfYear - 1));
entryDate.calc(v -> v - 2); entryDate.setCalc(v -> v - 2);
PropertyFileUtils.processDate(p, entryDate.now()); PropertyFileUtils.processDate(t, p, entryDate.now(), true);
assertThat(p.getProperty(entryDate.key())).as("processDate(now-2)").isEqualTo(String.valueOf( assertThat(p.getProperty(entryDate.getKey())).as("processDate(now-2)").isEqualTo(String.valueOf(dayOfYear - 2));
LocalDateTime.now().minusDays(2).getDayOfYear()));
entryDate.calc(SUB); entryDate.setCalc(SUB);
PropertyFileUtils.processDate(p, entryDate.set(new Date())); PropertyFileUtils.processDate(t, p, entryDate.set(new Date()), true);
assertThat(p.getProperty(entryDate.key())).as("processDate(date-1)").isEqualTo(String.valueOf( assertThat(p.getProperty(entryDate.getKey())).as("processDate(date-1)").isEqualTo(String.valueOf(dayOfYear - 1));
LocalDateTime.now().minusDays(1).getDayOfYear()));
entryDate.calc(v -> v - 2); entryDate.setCalc(v -> v - 2);
PropertyFileUtils.processDate(p, entryDate.set(Calendar.getInstance())); PropertyFileUtils.processDate(t, p, entryDate.set(Calendar.getInstance()), true);
assertThat(p.getProperty(entryDate.key())).as("processDate(cal-2)").isEqualTo(String.valueOf( assertThat(p.getProperty(entryDate.getKey())).as("processDate(cal-2)").isEqualTo(String.valueOf(dayOfYear - 2));
LocalDateTime.now().minusDays(2).getDayOfYear()));
entryDate.calc(v -> v - 3); entryDate.setCalc(v -> v - 3);
PropertyFileUtils.processDate(p, entryDate.set(LocalDate.now())); PropertyFileUtils.processDate(t, p, entryDate.set(LocalDate.now()),
assertThat(p.getProperty(entryDate.key())).as("processDate(LocalDate-3)").isEqualTo(String.valueOf( true);
LocalDateTime.now().minusDays(3).getDayOfYear())); assertThat(p.getProperty(entryDate.getKey())).as("processDate(LocalDate-3)").isEqualTo(String.valueOf(dayOfYear - 3));
} }
@Test @Test
void parseIntSubTest() { @SuppressWarnings("PMD.SignatureDeclareThrowsException")
var entryInt = newEntryInt().calc(SUB).pattern("0000"); void parseIntSubTest() throws Exception {
PropertyFileUtils.processInt(p, entryInt.defaultValue("0017")); var entryInt = newEntryInt();
assertThat(p.getProperty(entryInt.key())).as("sub(0017)").isEqualTo("0016"); entryInt.calc(SUB);
entryInt.setPattern("0000");
PropertyFileUtils.processInt(t, p, entryInt.defaultValue("0017"), true);
assertThat(p.getProperty(entryInt.getKey())).as("sub(0017)").isEqualTo("0016");
PropertyFileUtils.processInt(p, entryInt.set(16).calc(v -> v - 3)); PropertyFileUtils.processInt(t, p, entryInt.set(16).calc(v -> v - 3), true);
assertThat(p.getProperty(entryInt.key())).as("sub(16)-3").isEqualTo("0013"); assertThat(p.getProperty(entryInt.getKey())).as("sub(16)-3").isEqualTo("0013");
} }
@Test @Test
@ -101,122 +102,119 @@ class PropertyFileUtilsTest {
var entry = newEntry(); var entry = newEntry();
PropertyFileUtils.processString(p, entry.set(1)); PropertyFileUtils.processString(p, entry.set(1));
PropertyFileUtils.processString(p, entry.modify("-foo", String::concat)); PropertyFileUtils.processString(p, entry.modify("-foo", String::concat));
assertThat(p.getProperty(entry.key())).as(String.format("processString(%s, %s)", entry.key(), assertThat(p.getProperty(entry.getKey())).as(String.format("processString(%s, %s)", entry.getKey(),
entry.newValue())).isEqualTo("1-foo"); entry.getNewValue())).isEqualTo("1-foo");
} }
@Test @Test
void parseStringCap() { void parseStringCap() {
var entry = newEntry(); var entry = newEntry();
PropertyFileUtils.processString(p, entry.set(t).modify("", (v, s) -> v.toUpperCase(Localization.getLocale()))); PropertyFileUtils.processString(p, entry.set(t).modify("", (v, s) -> v.toUpperCase(Localization.getLocale())));
assertThat(p.getProperty(entry.key())).as("capitalize").isEqualTo(t.toUpperCase(Localization.getLocale())); assertThat(p.getProperty(entry.getKey())).as("capitalize").isEqualTo(t.toUpperCase(Localization.getLocale()));
} }
@Test @Test
void parseStringCat() { void parseStringCat() {
var entry = newEntry(); var entry = newEntry();
entry.set(t).modify("-foo", String::concat); entry.set(t).setModify("-foo", String::concat);
PropertyFileUtils.processString(p, entry); PropertyFileUtils.processString(p, entry);
assertThat(p.getProperty(entry.key())).as("replace").isEqualTo(t + "-foo"); assertThat(p.getProperty(entry.getKey())).as("replace").isEqualTo(t + "-foo");
} }
@Test
void parseStringFormat() {
var entry = new Entry("foo").set("%.2f").pattern(3.14159f);
PropertyFileUtils.processString(p, entry);
assertThat(p.getProperty(entry.key())).as("format").isEqualTo("3.14");
}
@Test @Test
void parseStringPrepend() { void parseStringPrepend() {
var entry = newEntry(); var entry = newEntry();
PropertyFileUtils.processString(p, entry.set(1)); PropertyFileUtils.processString(p, entry.set(1));
PropertyFileUtils.processString(p, entry.modify("foo-", (v, s) -> s + v)); PropertyFileUtils.processString(p, entry.modify("foo-", (v, s) -> s + v));
assertThat(p.getProperty(entry.key())).as(String.format("processString(%s, %s)", entry.key(), entry.newValue())) assertThat(p.getProperty(entry.getKey())).as(String.format("processString(%s, %s)", entry.getKey(), entry.getNewValue()))
.isEqualTo("foo-1"); .isEqualTo("foo-1");
} }
@Test @Test
void parseStringReplace() { void parseStringReplace() {
var entry = newEntry(); var entry = newEntry();
entry.set(t).modify("T", (v, s) -> v.replace("t", s)); entry.set(t).setModify("T", (v, s) -> v.replace("t", s));
PropertyFileUtils.processString(p, entry); PropertyFileUtils.processString(p, entry);
assertThat(p.getProperty(entry.key())).as("replace(t -> T)").isEqualTo("TesT"); assertThat(p.getProperty(entry.getKey())).as("replace(t -> T)").isEqualTo("TesT");
} }
@Test @Test
void parseStringSub() { void parseStringSub() {
var entry = newEntry(); var entry = newEntry();
PropertyFileUtils.processString(p, entry.set(t).modify((v, s) -> v.substring(1))); PropertyFileUtils.processString(p, entry.set(t).modify((v, s) -> v.substring(1)));
assertThat(p.getProperty(entry.key())).as("substring(1)").isEqualTo(t.substring(1)); assertThat(p.getProperty(entry.getKey())).as("substring(1)").isEqualTo(t.substring(1));
} }
@Test @Test
void parseTimeTest() { @SuppressWarnings("PMD.SignatureDeclareThrowsException")
void parseTimeTest() throws Exception {
var entry = new EntryDate("time").pattern("m"); var entry = new EntryDate("time").pattern("m");
var time = LocalTime.now(); var time = LocalTime.now();
entry.calc(ADD); entry.setCalc(ADD);
PropertyFileUtils.processDate(p, entry.set(time).unit(EntryDate.Units.MINUTE)); PropertyFileUtils.processDate(t, p, entry.set(time).unit(EntryDate.Units.MINUTE), true);
assertThat(p.getProperty(entry.key())).as("processDate(now+1)") assertThat(p.getProperty(entry.getKey())).as("processDate(now+1)")
.isEqualTo(String.valueOf(time.plusMinutes(1).getMinute())); .isEqualTo(String.valueOf(time.plusMinutes(1).getMinute()));
entry.calc(SUB); entry.setCalc(SUB);
PropertyFileUtils.processDate(p, entry.set(time).unit(EntryDate.Units.HOUR).pattern("H")); PropertyFileUtils.processDate(t, p, entry.set(time).unit(EntryDate.Units.HOUR).pattern("H"), true);
assertThat(p.getProperty(entry.key())).as("processDate(now+1)") assertThat(p.getProperty(entry.getKey())).as("processDate(now+1)")
.isEqualTo(String.valueOf(time.minusHours(1).getHour())); .isEqualTo(String.valueOf(time.minusHours(1).getHour()));
} }
@Test @Test
void processDateAddTest() { @SuppressWarnings("PMD.SignatureDeclareThrowsException")
void processDateAddTest() throws Exception {
var entryDate = newEntryDate(); var entryDate = newEntryDate();
entryDate.calc(ADD); entryDate.setCalc(ADD);
PropertyFileUtils.processDate(p, entryDate.now()); PropertyFileUtils.processDate(t, p, entryDate.now(), true);
assertThat(p.getProperty(entryDate.key())).as("processDate(now+1)").isEqualTo(String.valueOf( assertThat(p.getProperty(entryDate.getKey())).as("processDate(now+1)").isEqualTo(String.valueOf(dayOfYear + 1));
LocalDateTime.now().plusDays(1).getDayOfYear()));
PropertyFileUtils.processDate(p, entryDate.now().calc(v -> v + 3)); PropertyFileUtils.processDate(t, p, entryDate.now().calc(v -> v + 3), true);
assertThat(p.getProperty(entryDate.key())).as("processDate(now+3)").isEqualTo(String.valueOf( assertThat(p.getProperty(entryDate.getKey())).as("processDate(now+3)").isEqualTo(String.valueOf(dayOfYear + 3));
LocalDateTime.now().plusDays(3).getDayOfYear()));
entryDate.calc(ADD); entryDate.setCalc(ADD);
PropertyFileUtils.processDate(p, entryDate.set(ZonedDateTime.now())); PropertyFileUtils.processDate(t, p, entryDate.set(ZonedDateTime.now()), true);
assertThat(p.getProperty(entryDate.key())).as("processDate(ZonedDateTime+1)") assertThat(p.getProperty(entryDate.getKey())).as("processDate(ZonedDateTime+1)")
.isEqualTo(String.valueOf(LocalDateTime.now().plusDays(1).getDayOfYear())); .isEqualTo(String.valueOf(dayOfYear + 1));
PropertyFileUtils.processDate(p, entryDate.set(Instant.now()).calc(v -> v + 2)); PropertyFileUtils.processDate(t, p, entryDate.set(Instant.now()).calc(v -> v + 2), true);
assertThat(p.getProperty(entryDate.key())).as("processDate(Instant+2)").isEqualTo(String.valueOf( assertThat(p.getProperty(entryDate.getKey())).as("processDate(Instant+2)").isEqualTo(String.valueOf(dayOfYear + 2));
LocalDateTime.now().plusDays(2).getDayOfYear()));
entryDate.calc(v -> v + 3); entryDate.setCalc(v -> v + 3);
PropertyFileUtils.processDate(p, entryDate.set(LocalDateTime.now())); PropertyFileUtils.processDate(t, p, entryDate.set(LocalDateTime.now()), true);
assertThat(p.getProperty(entryDate.key())).as("processDate(LocalDteTime+2)") assertThat(p.getProperty(entryDate.getKey())).as("processDate(LocalDteTime+2)").isEqualTo(String.valueOf(dayOfYear + 3));
.isEqualTo(String.valueOf(LocalDateTime.now().plusDays(3).getDayOfYear()));
} }
@Test @Test
void processIntAddTest() { @SuppressWarnings("PMD.SignatureDeclareThrowsException")
var entryInt = newEntryInt().calc(ADD).defaultValue("-1"); void processIntAddTest() throws Exception {
PropertyFileUtils.processInt(p, entryInt); var entryInt = newEntryInt();
assertThat(p.getProperty(entryInt.key())).as("add(-1)").isEqualTo("0"); entryInt.calc(ADD);
entryInt.setDefaultValue("-1");
PropertyFileUtils.processInt(t, p, entryInt, true);
assertThat(p.getProperty(entryInt.getKey())).as("add(-1)").isEqualTo("0");
entryInt.key("anInt").defaultValue("0"); entryInt.setKey("anint");
PropertyFileUtils.processInt(p, entryInt); entryInt.setDefaultValue("0");
assertThat(p.getProperty(entryInt.key())).as("add(0)").isEqualTo("1"); PropertyFileUtils.processInt(t, p, entryInt, true);
PropertyFileUtils.processInt(p, entryInt); assertThat(p.getProperty(entryInt.getKey())).as("add(0)").isEqualTo("1");
assertThat(p.getProperty(entryInt.key())).as("add(1)").isEqualTo("2"); PropertyFileUtils.processInt(t, p, entryInt, true);
assertThat(p.getProperty(entryInt.getKey())).as("add(1)").isEqualTo("2");
entryInt.key("formatted.int").defaultValue("0013").pattern("0000"); entryInt.setKey("formatted.int");
PropertyFileUtils.processInt(p, entryInt); entryInt.setDefaultValue("0013");
assertThat(p.getProperty(entryInt.key())).as("add(0013)").isEqualTo("0014"); entryInt.setPattern("0000");
PropertyFileUtils.processInt(p, entryInt); PropertyFileUtils.processInt(t, p, entryInt, true);
assertThat(p.getProperty(entryInt.key())).as("add(0014)").isEqualTo("0015"); assertThat(p.getProperty(entryInt.getKey())).as("add(0013)").isEqualTo("0014");
PropertyFileUtils.processInt(t, p, entryInt, true);
assertThat(p.getProperty(entryInt.getKey())).as("add(0014)").isEqualTo("0015");
entryInt.calc(v -> v + 2); entryInt.calc(v -> v + 2);
PropertyFileUtils.processInt(p, entryInt); PropertyFileUtils.processInt(t, p, entryInt, true);
assertThat(p.getProperty(entryInt.key())).as("add(0015)+2").isEqualTo("0017"); assertThat(p.getProperty(entryInt.getKey())).as("add(0015)+2").isEqualTo("0017");
} }
@Test @Test
@ -224,17 +222,18 @@ class PropertyFileUtilsTest {
var entry = newEntry(); var entry = newEntry();
PropertyFileUtils.processString(p, entry); PropertyFileUtils.processString(p, entry);
assertThat(entry.newValue()).as(String.format("processString(%s, %s)", entry.key(), entry.newValue())) assertThat(entry.getNewValue()).as(String.format("processString(%s, %s)", entry.getKey(), entry.getNewValue()))
.isEqualTo(p.getProperty(entry.key())); .isEqualTo(p.getProperty(entry.getKey()));
entry.key("version.minor"); entry.setKey("version.minor");
PropertyFileUtils.processString(p, entry.set(0)); PropertyFileUtils.processString(p, entry.set(0));
assertThat(entry.newValue().toString()).as(String.format("processString(%s, %s)", entry.key(), entry.newValue())) assertThat(entry.getNewValue().toString()).as(String.format("processString(%s, %s)", entry.getKey(), entry.getNewValue()))
.isEqualTo(p.getProperty(entry.key())); .isEqualTo(p.getProperty(entry.getKey()));
} }
@Test @Test
@SuppressWarnings("PMD.SignatureDeclareThrowsException")
void savePropertiesTest() throws Exception { void savePropertiesTest() throws Exception {
var p = new Properties(); var p = new Properties();
var test = "test"; var test = "test";
@ -246,22 +245,13 @@ class PropertyFileUtilsTest {
assertThatCode(() -> PropertyFileUtils.saveProperties(tmp, "Generated file - do not modify!", p)) assertThatCode(() -> PropertyFileUtils.saveProperties(tmp, "Generated file - do not modify!", p))
.as("save properties").doesNotThrowAnyException(); .as("save properties").doesNotThrowAnyException();
assertThat(PropertyFileUtils.loadProperties(t, tmp, p, false)).as("load properties").isTrue(); assertThat(PropertyFileUtils.loadProperties(t, tmp, p)).as("load properties").isTrue();
assertThat(p.getProperty(test)).as("read property").isEqualTo(test); assertThat(p.getProperty(test)).as("read property").isEqualTo(test);
tmp.deleteOnExit(); tmp.deleteOnExit();
} }
@Test
void testChangeKey() {
var entry = new Entry("foo").key("bar");
assertThat(entry.key()).isEqualTo("bar");
entry.key("foo");
assertThat(entry.key()).isEqualTo("foo");
}
@Test @Test
void testCurrentValue() { void testCurrentValue() {
var value = "value"; var value = "value";
@ -277,9 +267,9 @@ class PropertyFileUtilsTest {
@Test @Test
void testWarn() { void testWarn() {
assertThatCode(() -> PropertyFileUtils.warn("command", "message", true, false)) assertThatCode(() -> PropertyFileUtils.warn("command", "message", new IOException(t), true))
.isInstanceOf(ExitStatusException.class); .hasMessage(t).isInstanceOf(IOException.class);
assertThatCode(() -> PropertyFileUtils.warn("command", t, false, false)) assertThatCode(() -> PropertyFileUtils.warn("command", t, new Exception(t), false))
.as("failOnWarning = false").doesNotThrowAnyException(); .as("failOnWarning = false").doesNotThrowAnyException();
} }
} }