Compare commits

...

4 commits

Author SHA1 Message Date
accf0d638a
Cleaned up examples 2024-07-16 16:18:10 -07:00
fb75d12740
Added pattern option for String-based entries 2024-07-16 16:09:21 -07:00
23540cbc8e
Converted EntryBase to a generic abstract class 2024-07-16 16:08:21 -07:00
dacacbab56
Updated dependencies
Cleanup GitHub workflow
2024-07-16 16:02:21 -07:00
16 changed files with 398 additions and 492 deletions

View file

@ -22,11 +22,8 @@ jobs:
distribution: "zulu" distribution: "zulu"
java-version: ${{ matrix.java-version }} java-version: ${{ matrix.java-version }}
- name: Grant execute permission for bld - name: Download dependencies
run: chmod +x bld
- name: Download the dependencies
run: ./bld download run: ./bld download
- name: Run tests with bld - name: Run tests
run: ./bld compile test run: ./bld compile test

View file

@ -69,12 +69,13 @@ 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 an entry value. | | `modify()` | `modify("-foo", String::concat)`<br/>`modify("-foo", (v, s) -> v + s)`<br/>`modify((v, s) -> v.trim())` |
| `set()` | The value to set the property to, regardless of its previous 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. |
## EntryDate ## EntryDate

View file

@ -10,6 +10,7 @@
./bld update-major run ./bld update-major run
./bld update-minor run ./bld update-minor run
./bld update-patch run ./bld update-patch run
./bld update-release run
``` ```
# Delete Version Properties # Delete Version Properties

View file

@ -1,6 +1,6 @@
#Sun Apr 02 10:32:44 PDT 2023 #Sun Apr 02 10:32:44 PDT 2023
bld.downloadExtensionSources=true bld.downloadExtensionSources=true
bld.downloadLocation= bld.downloadLocation=
bld.extension=com.uwyn.rife2:bld-property-file:0.9.6-SNAPSHOT bld.extension=com.uwyn.rife2:bld-property-file:0.9.5
bld.repositories=MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES bld.repositories=MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
bld.version=1.9.1 bld.version=1.9.1

View file

@ -42,8 +42,8 @@ public class PropertyFileExampleBuild extends Project {
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, 10, 2))) .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 3)))
.include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 2))); .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 3)));
} }
public static void main(String[] args) { public static void main(String[] args) {
@ -107,6 +107,7 @@ 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();
} }

View file

@ -1,6 +1,4 @@
# #
#Sun Oct 22 14:31:42 PDT 2023 #Tue Jul 16 16:16:38 PDT 2024
release=beta.20231022143142 build.date=2024-07-16
version.major=1 release=beta.20240716161638
version.minor=0
version.patch=1

View file

@ -1,7 +1,7 @@
bld.downloadExtensionJavadoc=false bld.downloadExtensionJavadoc=false
bld.downloadExtensionSources=true bld.downloadExtensionSources=true
bld.downloadLocation= bld.downloadLocation=
bld.extension-jacoco=com.uwyn.rife2:bld-jacoco-report:0.9.5 bld.extension-jacoco=com.uwyn.rife2:bld-jacoco-report:0.9.6
bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.1.0 bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.1.2
bld.repositories=MAVEN_CENTRAL,MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES bld.repositories=MAVEN_CENTRAL,MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
bld.version=1.9.1 bld.version=1.9.1

View file

@ -24,7 +24,6 @@ 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.MAVEN_CENTRAL; import static rife.bld.dependencies.Repository.MAVEN_CENTRAL;
@ -47,9 +46,9 @@ public class PropertyFileBuild extends Project {
scope(compile) scope(compile)
.include(dependency("com.uwyn.rife2", "bld", version(1, 9, 1))); .include(dependency("com.uwyn.rife2", "bld", version(1, 9, 1)));
scope(test) scope(test)
.include(dependency("org.jsoup", "jsoup", version(1, 17, 2))) .include(dependency("org.jsoup", "jsoup", version(1, 18, 1)))
.include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 2))) .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 3)))
.include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 2))) .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 3)))
.include(dependency("org.assertj:assertj-joda-time:2.2.0")); .include(dependency("org.assertj:assertj-joda-time:2.2.0"));
javadocOperation() javadocOperation()
@ -97,14 +96,14 @@ public class PropertyFileBuild extends Project {
} }
@BuildCommand(summary = "Generates JaCoCo Reports") @BuildCommand(summary = "Generates JaCoCo Reports")
public void jacoco() throws IOException { public void jacoco() throws Exception {
new JacocoReportOperation() new JacocoReportOperation()
.fromProject(this) .fromProject(this)
.execute(); .execute();
} }
@BuildCommand(summary = "Runs PMD analysis") @BuildCommand(summary = "Runs PMD analysis")
public void pmd() { public void pmd() throws Exception {
new PmdOperation() new PmdOperation()
.fromProject(this) .fromProject(this)
.failOnViolation(true) .failOnViolation(true)

View file

@ -25,62 +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 { public class Entry extends EntryBase<Entry> {
private String modifyValue_ = "";
private BiFunction<String, String, String> modify_;
/** /**
* Instantiates a new Entry. * Creates a new {@link Entry entry}.
* *
* @param key the key * @param key the required property key
*/ */
public Entry(String key) { public Entry(String key) {
super(key); super(key);
} }
/** /**
* <p>Sets the initial value to set the {@link java.util.Properties property} to, if not already defined.</p> * Returns the modify function.
* *
* @param defaultValue the default value * @return the modify function
* @return the entry
*/ */
@SuppressWarnings("unused") protected BiFunction<String, String, String> modify() {
public Entry defaultValue(Object defaultValue) { return modify_;
setDefaultValue(defaultValue);
return this;
} }
/** /**
* Sets the {@link Entry entry} up for deletion. * Sets the modify function.
* *
* @return the entry * @param modify the modify function
*/
public Entry delete() {
setDelete();
return this;
}
/**
* Creates a new {@link Entry entry}.
*
* @param modify the modification function
* @return the entry
*/ */
public Entry modify(BiFunction<String, String, String> modify) { public Entry modify(BiFunction<String, String, String> modify) {
setModify(modify); modify_ = modify;
return this; return this;
} }
/** /**
* Creates a new {@link Entry entry}. * Sets the modify function.
* *
* @param value the value to perform a modification with * @param value the value to perform a modification with
* @param modify the modification function * @param modify the modify function
* @return the entry
*/ */
public Entry modify(String value, BiFunction<String, String, String> modify) { public Entry modify(String value, BiFunction<String, String, String> modify) {
setModifyValue(value); modifyValue_ = value;
setModify(modify); modify_ = 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.
* *
@ -88,7 +85,7 @@ public class Entry extends EntryBase {
* @return the entry * @return the entry
*/ */
public Entry set(Object s) { public Entry set(Object s) {
setNewValue(s); newValue(s);
return this; return this;
} }
} }

View file

@ -16,7 +16,6 @@
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;
/** /**
@ -26,17 +25,14 @@ 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("PMD.DataClass") @SuppressWarnings({"unchecked", "PMD.AbstractClassWithoutAbstractMethod"})
public class EntryBase { public abstract class EntryBase<T> {
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 String modifyValue_ = "";
private BiFunction<String, String, String> modify_;
private Object newValue_; private Object newValue_;
private String pattern_ = ""; private Object pattern_;
private EntryDate.Units unit_ = EntryDate.Units.DAY;
/** /**
* Creates a new {@link EntryBase entry}. * Creates a new {@link EntryBase entry}.
@ -52,71 +48,45 @@ public class EntryBase {
* *
* @return the calc function * @return the calc function
*/ */
protected IntFunction<Integer> getCalc() { protected IntFunction<Integer> calc() {
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 * @return the default value
*/ */
protected Object getDefaultValue() { protected Object defaultValue() {
return defaultValue_; return defaultValue_;
} }
/** /**
* Returns the key of the {@link java.util.Properties property}. * Sets the initial value to set the {@link java.util.Properties property} to, if not already defined.
* *
* @return the key * @param defaultValue the default value
*/ */
protected String getKey() { public T defaultValue(Object defaultValue) {
return key_; defaultValue_ = defaultValue;
return (T) this;
} }
/** /**
* Returns the modify function. * Indicates that the {@link java.util.Properties property} is to be deleted.
*
* @return the modify function
*/ */
protected BiFunction<String, String, String> getModify() { public T delete() {
return modify_; isDelete_ = true;
} return (T) this;
/**
* Returns the value to be used in the {@link #modify_} function.
*
* @return the modify value
*/
protected String getModifyValue() {
return modifyValue_;
}
/**
* Returns the new value to set the {@link java.util.Properties property)} to.
*
* @return the new value
*/
public Object getNewValue() {
return newValue_;
}
/**
* Returns the pattern.
*
* @return the pattern
*/
protected String getPattern() {
return pattern_;
}
/**
* Returns the {@link EntryDate.Units unit}.
*
* @return the unit
*/
protected EntryDate.Units getUnit() {
return unit_;
} }
/** /**
@ -128,79 +98,33 @@ public class EntryBase {
return 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 * @return this instance
*/ */
@SuppressWarnings("unused") public T key(String key) {
public EntryBase key(String key) {
key_ = key; key_ = key;
return this; return (T) this;
} }
/** /**
* Sets the calculation function. * Returns the new value to set the {@link java.util.Properties property)} to.
* *
* @param calc the calc function * @return the new value
*/ */
protected void setCalc(IntFunction<Integer> calc) { protected Object newValue() {
calc_ = calc; return newValue_;
}
/**
* Sets the initial value to set the {@link java.util.Properties property} to, if not already defined.
*
* @param defaultValue the default value
*/
protected void setDefaultValue(Object defaultValue) {
defaultValue_ = defaultValue;
}
/**
* Sets the {@link java.util.Properties property} to be deleted.
*/
protected void setDelete() {
isDelete_ = true;
}
/**
* Sets the key of the {@link java.util.Properties property}.
*
* @param key the {@link java.util.Properties property} key
*/
protected void setKey(String key) {
key_ = key;
}
/**
* Sets the modify function.
*
* @param modify the modify function
*/
protected void setModify(BiFunction<String, String, String> modify) {
modify_ = modify;
}
/**
* Sets the modify function.
*
* @param value the value to perform a modification with
* @param modify the modify function
*/
protected void setModify(String value, BiFunction<String, String, String> modify) {
modifyValue_ = value;
modify_ = modify;
}
/**
* Sets the modify value.
*
* @param value the modify value.
*/
protected void setModifyValue(String value) {
modifyValue_ = value;
} }
/** /**
@ -208,26 +132,26 @@ public class EntryBase {
* *
* @param newValue the new value * @param newValue the new value
*/ */
public void setNewValue(Object newValue) { protected void newValue(Object newValue) {
newValue_ = newValue; newValue_ = newValue;
} }
/** /**
* Sets the {@link java.text.DecimalFormat DecimalFormat} or {@link java.time.format.DateTimeFormatter DateTimeFormatter} * Returns the pattern.
* pattern to be used with {@link EntryDate} or {@link EntryInt} respectively.
* *
* @param pattern the pattern * @return the pattern
*/ */
protected void setPattern(String pattern) { protected Object pattern() {
pattern_ = pattern; return pattern_;
} }
/** /**
* Sets the {@link EntryDate.Units unit} value to apply to calculations. * Sets the {@link java.util.Formatter} pattern.
* *
* @param unit the {@link EntryDate.Units unit} * @param pattern the pattern
*/ */
protected void setUnit(EntryDate.Units unit) { public T pattern(Object pattern) {
unit_ = unit; pattern_ = pattern;
return (T) this;
} }
} }

View file

@ -19,7 +19,6 @@ 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}.
@ -27,9 +26,11 @@ import java.util.function.IntFunction;
* @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 { public class EntryDate extends EntryBase<EntryDate> {
private EntryDate.Units unit_ = EntryDate.Units.DAY;
/** /**
* Creates a new date {@link Entry entry}. * Creates a new {@link EntryDate entry}.
* *
* @param key the required property key * @param key the required property key
*/ */
@ -37,46 +38,13 @@ public class EntryDate extends EntryBase {
super(key); super(key);
} }
/**
* Creates a new {@link EntryDate entry}.
*
* @param calc the calculation function
* @return this instance
*/
public EntryDate calc(IntFunction<Integer> calc) {
setCalc(calc);
return this;
}
/**
* Sets the {@link EntryDate entry} up for deletion.
*
* @return this instance
*/
public EntryDate delete() {
setDelete();
return this;
}
/** /**
* Sets the new {@link java.util.Properties property} value to now. * Sets the new {@link java.util.Properties property} value to now.
* *
* @return this instance * @return this instance
*/ */
public EntryDate now() { public EntryDate now() {
setNewValue("now"); newValue("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
* @return this instance
*/
public EntryDate pattern(String pattern) {
setPattern(pattern);
return this; return this;
} }
@ -87,7 +55,7 @@ public class EntryDate extends EntryBase {
* @return this instance * @return this instance
*/ */
public EntryDate set(Instant instant) { public EntryDate set(Instant instant) {
setNewValue(instant); newValue(instant);
return this; return this;
} }
@ -98,7 +66,7 @@ public class EntryDate extends EntryBase {
* @return this instance * @return this instance
*/ */
public EntryDate set(LocalDate date) { public EntryDate set(LocalDate date) {
setNewValue(date); newValue(date);
return this; return this;
} }
@ -109,7 +77,7 @@ public class EntryDate extends EntryBase {
* @return this instance * @return this instance
*/ */
public EntryDate set(LocalDateTime date) { public EntryDate set(LocalDateTime date) {
setNewValue(date); newValue(date);
return this; return this;
} }
@ -120,7 +88,7 @@ public class EntryDate extends EntryBase {
* @return this instance * @return this instance
*/ */
public EntryDate set(ZonedDateTime date) { public EntryDate set(ZonedDateTime date) {
setNewValue(date); newValue(date);
return this; return this;
} }
@ -131,7 +99,7 @@ public class EntryDate extends EntryBase {
* @return this instance * @return this instance
*/ */
public EntryDate set(LocalTime time) { public EntryDate set(LocalTime time) {
setNewValue(time); newValue(time);
return this; return this;
} }
@ -142,7 +110,7 @@ public class EntryDate extends EntryBase {
* @return this instance * @return this instance
*/ */
public EntryDate set(Calendar cal) { public EntryDate set(Calendar cal) {
setNewValue(cal); newValue(cal);
return this; return this;
} }
@ -153,10 +121,19 @@ public class EntryDate extends EntryBase {
* @return this instance * @return this instance
*/ */
public EntryDate set(Date date) { public EntryDate set(Date date) {
setNewValue(date); newValue(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}.
* *
@ -164,7 +141,17 @@ public class EntryDate extends EntryBase {
* @return this instance * @return this instance
*/ */
public EntryDate unit(Units unit) { public EntryDate unit(Units unit) {
setUnit(unit); unit_ = unit;
return this;
}
/**
* Sets the {@link java.time.format.DateTimeFormatter DateTimeFormatter} pattern.
*
* @param pattern the pattern
*/
public EntryDate pattern(String pattern) {
super.pattern(pattern);
return this; return this;
} }

View file

@ -16,17 +16,15 @@
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 { public class EntryInt extends EntryBase<EntryInt> {
/** /**
* Creates a new date {@link Entry entry}. * Creates a new {@link EntryInt entry}.
* *
* @param key the required property key * @param key the required property key
*/ */
@ -34,39 +32,6 @@ public class EntryInt extends EntryBase {
super(key); super(key);
} }
/**
* Creates a new {@link EntryInt entry}.
*
* @param calc the calculation function.
* @return this instance
*/
public EntryInt calc(IntFunction<Integer> calc) {
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
* @return this instance
*/
@SuppressWarnings("unused")
public EntryInt defaultValue(Object defaultValue) {
setDefaultValue(defaultValue);
return this;
}
/**
* Sets the {@link EntryInt entry} up for deletion.
*
* @return this instance
*/
public EntryInt delete() {
setDelete();
return this;
}
/** /**
* Sets the new {@link java.util.Properties property} value to an integer. * Sets the new {@link java.util.Properties property} value to an integer.
* *
@ -74,7 +39,17 @@ public class EntryInt extends EntryBase {
* @return this instance * @return this instance
*/ */
public EntryInt set(int i) { public EntryInt set(int i) {
setNewValue(i); newValue(i);
return this;
}
/**
* Sets the {@link java.text.DecimalFormat DecimalFormat} pattern.
*
* @param pattern the pattern
*/
public EntryInt pattern(String pattern) {
super.pattern(pattern);
return this; return this;
} }
} }

View file

@ -18,11 +18,14 @@ 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.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.
@ -31,7 +34,8 @@ import java.util.Properties;
* @since 1.0 * @since 1.0
*/ */
public class PropertyFileOperation extends AbstractOperation<PropertyFileOperation> { public class PropertyFileOperation extends AbstractOperation<PropertyFileOperation> {
private final List<EntryBase> entries_ = new ArrayList<>(); private final static Logger LOGGER = Logger.getLogger(PropertyFileOperation.class.getName());
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_;
@ -55,8 +59,7 @@ public class PropertyFileOperation extends AbstractOperation<PropertyFileOperati
* @param entry the {@link Entry entry} * @param entry the {@link Entry entry}
* @return this instance * @return this instance
*/ */
@SuppressWarnings("unused") public PropertyFileOperation entry(EntryBase<?> entry) {
public PropertyFileOperation entry(EntryBase entry) {
entries_.add(entry); entries_.add(entry);
return this; return this;
} }
@ -66,38 +69,49 @@ public class PropertyFileOperation extends AbstractOperation<PropertyFileOperati
*/ */
@Override @Override
public void execute() throws Exception { public void execute() throws Exception {
if (project_ == null) {
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 commandName = project_.getCurrentCommandName();
var properties = new Properties(); var properties = new Properties();
var success = false; var success = true;
if (file_ == null) { if (file_ == null) {
PropertyFileUtils.warn(commandName, "A properties file must be specified."); warn(commandName, "A properties file must be specified.");
} else { } else {
success = PropertyFileUtils.loadProperties(commandName, file_, properties); success = PropertyFileUtils.loadProperties(commandName, file_, properties, silent());
} }
if (success) { if (success) {
for (var entry : entries_) { for (var entry : entries_) {
if (entry.getKey().isBlank()) { if (entry.key().isBlank()) {
PropertyFileUtils.warn(commandName, "An entry key must specified."); warn(commandName, "An entry key must specified.");
} else { } else {
var key = entry.getKey(); var key = entry.key();
Object value = entry.getNewValue(); Object value = entry.newValue();
Object defaultValue = entry.getDefaultValue(); Object defaultValue = entry.defaultValue();
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())) {
PropertyFileUtils.warn(commandName, "An entry must be set or have a default value: " + key); warn(commandName, "An entry must be set or have a default value: " + key);
} else { } else {
if (entry instanceof EntryDate) { try {
success = PropertyFileUtils.processDate(commandName, properties, (EntryDate) entry, failOnWarning_); if (entry instanceof EntryDate) {
} else if (entry instanceof EntryInt) { PropertyFileUtils.processDate(properties, (EntryDate) entry);
success = PropertyFileUtils.processInt(commandName, properties, (EntryInt) entry, failOnWarning_); } else if (entry instanceof EntryInt) {
} else { PropertyFileUtils.processInt(properties, (EntryInt) entry);
success = PropertyFileUtils.processString(properties, (Entry) entry); } else {
PropertyFileUtils.processString(properties, (Entry) entry);
}
} catch (IllegalArgumentException e) {
warn(commandName, e.getMessage());
} }
} }
} }
@ -152,4 +166,24 @@ public class PropertyFileOperation extends AbstractOperation<PropertyFileOperati
project_ = project; 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);
}
}
}
} }

View file

@ -16,7 +16,8 @@
package rife.bld.extension.propertyfile; package rife.bld.extension.propertyfile;
import javax.imageio.IIOException; import rife.bld.operations.exceptions.ExitStatusException;
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;
@ -69,165 +70,153 @@ public final class PropertyFileUtils {
* @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 * @return the boolean
* @throws Exception the exception * @throws ExitStatusException if an error occurred
*/ */
@SuppressWarnings("PMD.SignatureDeclareThrowsException") public static boolean loadProperties(String command, File file, Properties p, boolean silent)
public static boolean loadProperties(String command, File file, Properties p) throws Exception { throws ExitStatusException {
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(), ioe, true); warn(command, "Could not load properties file: " + ioe.getMessage(), true, silent);
success = false; success = false;
} }
} }
} else { } else {
warn(command, "Please specify the properties file location."); warn(command, "Please specify the properties file location.", true, silent);
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 command the issuing command * @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 * @throws DateTimeException if a parsing error occurs
* @param failOnWarning the fail on warning
* @return the boolean
* @throws Exception the exception
*/ */
@SuppressWarnings({"PMD.SignatureDeclareThrowsException", "PMD.ExceptionAsFlowControl"}) @SuppressWarnings("PMD.ExceptionAsFlowControl")
public static boolean processDate(String command, Properties p, EntryDate entry, boolean failOnWarning) public static void processDate(Properties p, EntryDate entry) throws IllegalArgumentException {
throws Exception { var currentValue = currentValue(null, entry.defaultValue(), entry.newValue());
var success = true; var pattern = objectToString(entry.pattern());
var value = currentValue(null, entry.getDefaultValue(), entry.getNewValue());
var pattern = entry.getPattern();
var parsedValue = String.valueOf(value); var dateValue = String.valueOf(currentValue);
if (pattern != null && !pattern.isBlank()) { if (pattern != null && !pattern.isBlank()) {
var offset = 0; var offset = 0;
if (entry.getCalc() != null) { if (entry.calc() != null) {
offset = entry.getCalc().apply(offset); offset = entry.calc().apply(offset);
} }
var dtf = DateTimeFormatter.ofPattern(pattern); var dtf = DateTimeFormatter.ofPattern(pattern);
var unit = entry.getUnit(); var unit = entry.unit();
try { try {
if (value instanceof String) { if (currentValue instanceof String) {
if ("now".equalsIgnoreCase((String) value)) { if ("now".equalsIgnoreCase((String) currentValue)) {
value = ZonedDateTime.now(); currentValue = ZonedDateTime.now();
} else { } else {
throw new DateTimeException("Excepted: Calendar, Date or java.time."); throw new DateTimeException("Excepted: Calendar, Date or java.time.");
} }
} else if (value instanceof LocalDateTime) { } else if (currentValue instanceof LocalDateTime) {
value = ((LocalDateTime) value).atZone(ZoneId.systemDefault()); currentValue = ((LocalDateTime) currentValue).atZone(ZoneId.systemDefault());
} else if (value instanceof Date) { } else if (currentValue instanceof Date) {
value = ((Date) value).toInstant().atZone(ZoneId.systemDefault()); currentValue = ((Date) currentValue).toInstant().atZone(ZoneId.systemDefault());
} else if (value instanceof Calendar) { } else if (currentValue instanceof Calendar) {
value = ((Calendar) value).toInstant().atZone(ZoneId.systemDefault()); currentValue = ((Calendar) currentValue).toInstant().atZone(ZoneId.systemDefault());
} else if (value instanceof Instant) { } else if (currentValue instanceof Instant) {
value = ((Instant) value).atZone(ZoneId.systemDefault()); currentValue = ((Instant) currentValue).atZone(ZoneId.systemDefault());
} }
if (value instanceof LocalDate) { if (currentValue instanceof LocalDate) {
if (offset != 0) { if (offset != 0) {
if (unit == EntryDate.Units.DAY) { if (unit == EntryDate.Units.DAY) {
value = ((LocalDate) value).plusDays(offset); currentValue = ((LocalDate) currentValue).plusDays(offset);
} else if (unit == EntryDate.Units.MONTH) { } else if (unit == EntryDate.Units.MONTH) {
value = ((LocalDate) value).plusMonths(offset); currentValue = ((LocalDate) currentValue).plusMonths(offset);
} else if (unit == EntryDate.Units.WEEK) { } else if (unit == EntryDate.Units.WEEK) {
value = ((LocalDate) value).plusWeeks(offset); currentValue = ((LocalDate) currentValue).plusWeeks(offset);
} else if (unit == EntryDate.Units.YEAR) { } else if (unit == EntryDate.Units.YEAR) {
value = ((LocalDate) value).plusYears(offset); currentValue = ((LocalDate) currentValue).plusYears(offset);
} }
} }
parsedValue = dtf.format((LocalDate) value); dateValue = dtf.format((LocalDate) currentValue);
} else if (value instanceof LocalTime) { } else if (currentValue instanceof LocalTime) {
if (offset != 0) { if (offset != 0) {
if (unit == EntryDate.Units.SECOND) { if (unit == EntryDate.Units.SECOND) {
value = ((LocalTime) value).plusSeconds(offset); currentValue = ((LocalTime) currentValue).plusSeconds(offset);
} else if (unit == EntryDate.Units.MINUTE) { } else if (unit == EntryDate.Units.MINUTE) {
value = ((LocalTime) value).plusMinutes(offset); currentValue = ((LocalTime) currentValue).plusMinutes(offset);
} else if (unit == EntryDate.Units.HOUR) { } else if (unit == EntryDate.Units.HOUR) {
value = ((LocalTime) value).plusHours(offset); currentValue = ((LocalTime) currentValue).plusHours(offset);
} }
} }
parsedValue = dtf.format((LocalTime) value); dateValue = dtf.format((LocalTime) currentValue);
} else if (value instanceof ZonedDateTime) { } else if (currentValue instanceof ZonedDateTime) {
if (offset != 0) { if (offset != 0) {
if (unit == EntryDate.Units.DAY) { if (unit == EntryDate.Units.DAY) {
value = ((ZonedDateTime) value).plusDays(offset); currentValue = ((ZonedDateTime) currentValue).plusDays(offset);
} else if (unit == EntryDate.Units.MONTH) { } else if (unit == EntryDate.Units.MONTH) {
value = ((ZonedDateTime) value).plusMonths(offset); currentValue = ((ZonedDateTime) currentValue).plusMonths(offset);
} else if (unit == EntryDate.Units.WEEK) { } else if (unit == EntryDate.Units.WEEK) {
value = ((ZonedDateTime) value).plusWeeks(offset); currentValue = ((ZonedDateTime) currentValue).plusWeeks(offset);
} else if (unit == EntryDate.Units.YEAR) { } else if (unit == EntryDate.Units.YEAR) {
value = ((ZonedDateTime) value).plusYears(offset); currentValue = ((ZonedDateTime) currentValue).plusYears(offset);
} else if (unit == EntryDate.Units.SECOND) { } else if (unit == EntryDate.Units.SECOND) {
value = ((ZonedDateTime) value).plusSeconds(offset); currentValue = ((ZonedDateTime) currentValue).plusSeconds(offset);
} else if (unit == EntryDate.Units.MINUTE) { } else if (unit == EntryDate.Units.MINUTE) {
value = ((ZonedDateTime) value).plusMinutes(offset); currentValue = ((ZonedDateTime) currentValue).plusMinutes(offset);
} else if (unit == EntryDate.Units.HOUR) { } else if (unit == EntryDate.Units.HOUR) {
value = ((ZonedDateTime) value).plusHours(offset); currentValue = ((ZonedDateTime) currentValue).plusHours(offset);
} }
} }
parsedValue = dtf.format((ZonedDateTime) value); dateValue = dtf.format((ZonedDateTime) currentValue);
} }
} catch (DateTimeException dte) { } catch (DateTimeException dte) {
warn(command, "Non-date value for \"" + entry.getKey() + "\" --> " + dte.getMessage(), throw new IllegalArgumentException(
dte, failOnWarning); "Non-date value for \"" + entry.key() + "\" --> " + dte.getMessage(), dte);
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 command the issuing command * @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 * @throws NumberFormatException if a parsing error occurs
* @param failOnWarning the fail on warning
* @return the boolean
* @throws Exception the exception
*/ */
@SuppressWarnings("PMD.SignatureDeclareThrowsException") public static void processInt(Properties p, EntryInt entry) throws IllegalArgumentException {
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(entry.getPattern()); var fmt = new DecimalFormat(objectToString(entry.pattern()));
var value = currentValue(p.getProperty(entry.getKey()), entry.getDefaultValue(), var currentValue = currentValue(p.getProperty(entry.key()), entry.defaultValue(), entry.newValue());
entry.getNewValue());
if (value != null) { if (currentValue != null) {
intValue = fmt.parse(String.valueOf(value)).intValue(); intValue = fmt.parse(String.valueOf(currentValue)).intValue();
} }
if (entry.getCalc() != null) { if (entry.calc() != null) {
intValue = entry.getCalc().apply(intValue); intValue = entry.calc().apply(intValue);
} }
p.setProperty(entry.getKey(), fmt.format(intValue));
p.setProperty(entry.key(), fmt.format(intValue));
} catch (NumberFormatException | ParseException e) { } catch (NumberFormatException | ParseException e) {
warn(command, "Non-integer value for \"" + entry.getKey() + "\" --> " + e.getMessage(), e, throw new IllegalArgumentException(
failOnWarning); "Non-integer value for \"" + entry.key() + "\" --> " + e.getMessage(), e);
success = false;
} }
return success;
} }
/** /**
@ -235,19 +224,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
* @return the boolean
*/ */
@SuppressWarnings("SameReturnValue") 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.getKey(), String.valueOf(value)); p.setProperty(entry.key(), String.format(String.valueOf(currentValue), entry.pattern()));
if (entry.getModify() != null && entry.getModifyValue() != null) { if (entry.modify() != null && entry.modifyValue() != null) {
p.setProperty(entry.getKey(), entry.getModify().apply(p.getProperty(entry.getKey()), entry.getModifyValue())); var modify = entry.modify().apply(p.getProperty(entry.key()), entry.modifyValue());
p.setProperty(entry.key(), String.format(modify, entry.pattern()));
} }
return true;
} }
/** /**
@ -261,20 +247,8 @@ public final class PropertyFileUtils {
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 (IIOException ioe) { } catch (IOException ioe) {
throw new IIOException("An IO error occurred while saving the Properties file: " + file, ioe); throw new IOException("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);
} }
} }
@ -283,18 +257,20 @@ 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 Exception the exception * @throws ExitStatusException if a {@link Level#SEVERE} exception occurs
*/ */
@SuppressWarnings({"PMD.SignatureDeclareThrowsException"}) static void warn(String command, String message, boolean failOnWarning, boolean silent)
static void warn(String command, String message, Exception e, boolean failOnWarning) throws Exception { throws ExitStatusException {
LOGGER.warning("ahah");
if (failOnWarning) { if (failOnWarning) {
LOGGER.log(Level.SEVERE, '[' + command + "] " + message, e); if (LOGGER.isLoggable(Level.SEVERE) && !silent) {
throw e; LOGGER.log(Level.SEVERE, '[' + command + "] " + message);
}
throw new ExitStatusException(ExitStatusException.EXIT_FAILURE);
} else { } else {
warn(command, message); if (LOGGER.isLoggable(Level.WARNING) && !silent) {
LOGGER.warning('[' + command + "] " + message);
}
} }
} }
} }

View file

@ -18,6 +18,7 @@ package rife.bld.extension.propertyfile;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import rife.bld.Project; import rife.bld.Project;
import rife.bld.operations.exceptions.ExitStatusException;
import java.io.File; import java.io.File;
import java.nio.file.Files; import java.nio.file.Files;
@ -26,6 +27,7 @@ import java.time.format.DateTimeFormatter;
import java.util.Properties; import java.util.Properties;
import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatCode;
import static rife.bld.extension.propertyfile.Calc.ADD; import static rife.bld.extension.propertyfile.Calc.ADD;
class PropertyFileOperationTest { class PropertyFileOperationTest {
@ -76,4 +78,10 @@ class PropertyFileOperationTest {
assertThat(p.getProperty("build.date")).as("dalete build.date").isNull(); assertThat(p.getProperty("build.date")).as("dalete build.date").isNull();
assertThat(p).as("version keys").containsKeys("version.major", "version.minor", "version.patch"); 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);
}
} }

View file

@ -17,19 +17,19 @@
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; // NOPMD import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatCode; // NOPMD import static org.assertj.core.api.Assertions.assertThatCode;
import static rife.bld.extension.propertyfile.Calc.ADD; // NOPMD import static rife.bld.extension.propertyfile.Calc.ADD;
import static rife.bld.extension.propertyfile.Calc.SUB; // NOPMD import static rife.bld.extension.propertyfile.Calc.SUB;
/** /**
* PropertyFileUtilsTest class * PropertyFileUtilsTest class
@ -37,6 +37,7 @@ import static rife.bld.extension.propertyfile.Calc.SUB; // NOPMD
* @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 int dayOfYear = LocalDate.now().getDayOfYear();
final static Properties p = new Properties(); final static Properties p = new Properties();
@ -49,7 +50,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,40 +59,36 @@ class PropertyFileUtilsTest {
} }
@Test @Test
void parseDateSub() throws Exception { void parseDateSub() {
var entryDate = newEntryDate(); var entryDate = newEntryDate().calc(SUB);
entryDate.setCalc(SUB); PropertyFileUtils.processDate(p, entryDate.now());
PropertyFileUtils.processDate(t, p, entryDate.now(), true); assertThat(p.getProperty(entryDate.key())).as("processDate(now-3)").isEqualTo(String.valueOf(dayOfYear - 1));
assertThat(p.getProperty(entryDate.getKey())).as("processDate(now-3)").isEqualTo(String.valueOf(dayOfYear - 1));
entryDate.setCalc(v -> v - 2); entryDate.calc(v -> v - 2);
PropertyFileUtils.processDate(t, p, entryDate.now(), true); PropertyFileUtils.processDate(p, entryDate.now());
assertThat(p.getProperty(entryDate.getKey())).as("processDate(now-2)").isEqualTo(String.valueOf(dayOfYear - 2)); assertThat(p.getProperty(entryDate.key())).as("processDate(now-2)").isEqualTo(String.valueOf(dayOfYear - 2));
entryDate.setCalc(SUB); entryDate.calc(SUB);
PropertyFileUtils.processDate(t, p, entryDate.set(new Date()), true); PropertyFileUtils.processDate(p, entryDate.set(new Date()));
assertThat(p.getProperty(entryDate.getKey())).as("processDate(date-1)").isEqualTo(String.valueOf(dayOfYear - 1)); assertThat(p.getProperty(entryDate.key())).as("processDate(date-1)").isEqualTo(String.valueOf(dayOfYear - 1));
entryDate.setCalc(v -> v - 2); entryDate.calc(v -> v - 2);
PropertyFileUtils.processDate(t, p, entryDate.set(Calendar.getInstance()), true); PropertyFileUtils.processDate(p, entryDate.set(Calendar.getInstance()));
assertThat(p.getProperty(entryDate.getKey())).as("processDate(cal-2)").isEqualTo(String.valueOf(dayOfYear - 2)); assertThat(p.getProperty(entryDate.key())).as("processDate(cal-2)").isEqualTo(String.valueOf(dayOfYear - 2));
entryDate.setCalc(v -> v - 3); entryDate.calc(v -> v - 3);
PropertyFileUtils.processDate(t, p, entryDate.set(LocalDate.now()), PropertyFileUtils.processDate(p, entryDate.set(LocalDate.now()));
true); assertThat(p.getProperty(entryDate.key())).as("processDate(LocalDate-3)").isEqualTo(String.valueOf(dayOfYear - 3));
assertThat(p.getProperty(entryDate.getKey())).as("processDate(LocalDate-3)").isEqualTo(String.valueOf(dayOfYear - 3));
} }
@Test @Test
void parseIntSubTest() throws Exception { void parseIntSubTest() {
var entryInt = newEntryInt(); var entryInt = newEntryInt().calc(SUB).pattern("0000");
entryInt.calc(SUB); PropertyFileUtils.processInt(p, entryInt.defaultValue("0017"));
entryInt.setPattern("0000"); assertThat(p.getProperty(entryInt.key())).as("sub(0017)").isEqualTo("0016");
PropertyFileUtils.processInt(t, p, entryInt.defaultValue("0017"), true);
assertThat(p.getProperty(entryInt.getKey())).as("sub(0017)").isEqualTo("0016");
PropertyFileUtils.processInt(t, p, entryInt.set(16).calc(v -> v - 3), true); PropertyFileUtils.processInt(p, entryInt.set(16).calc(v -> v - 3));
assertThat(p.getProperty(entryInt.getKey())).as("sub(16)-3").isEqualTo("0013"); assertThat(p.getProperty(entryInt.key())).as("sub(16)-3").isEqualTo("0013");
} }
@Test @Test
@ -100,116 +97,118 @@ 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.getKey())).as(String.format("processString(%s, %s)", entry.getKey(), assertThat(p.getProperty(entry.key())).as(String.format("processString(%s, %s)", entry.key(),
entry.getNewValue())).isEqualTo("1-foo"); entry.newValue())).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.getKey())).as("capitalize").isEqualTo(t.toUpperCase(Localization.getLocale())); assertThat(p.getProperty(entry.key())).as("capitalize").isEqualTo(t.toUpperCase(Localization.getLocale()));
} }
@Test @Test
void parseStringCat() { void parseStringCat() {
var entry = newEntry(); var entry = newEntry();
entry.set(t).setModify("-foo", String::concat); entry.set(t).modify("-foo", String::concat);
PropertyFileUtils.processString(p, entry); PropertyFileUtils.processString(p, entry);
assertThat(p.getProperty(entry.getKey())).as("replace").isEqualTo(t + "-foo"); assertThat(p.getProperty(entry.key())).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.getKey())).as(String.format("processString(%s, %s)", entry.getKey(), entry.getNewValue())) assertThat(p.getProperty(entry.key())).as(String.format("processString(%s, %s)", entry.key(), entry.newValue()))
.isEqualTo("foo-1"); .isEqualTo("foo-1");
} }
@Test @Test
void parseStringReplace() { void parseStringReplace() {
var entry = newEntry(); var entry = newEntry();
entry.set(t).setModify("T", (v, s) -> v.replace("t", s)); entry.set(t).modify("T", (v, s) -> v.replace("t", s));
PropertyFileUtils.processString(p, entry); PropertyFileUtils.processString(p, entry);
assertThat(p.getProperty(entry.getKey())).as("replace(t -> T)").isEqualTo("TesT"); assertThat(p.getProperty(entry.key())).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.getKey())).as("substring(1)").isEqualTo(t.substring(1)); assertThat(p.getProperty(entry.key())).as("substring(1)").isEqualTo(t.substring(1));
} }
@Test @Test
void parseTimeTest() throws Exception { void parseTimeTest() {
var entry = new EntryDate("time").pattern("m"); var entry = new EntryDate("time").pattern("m");
var time = LocalTime.now(); var time = LocalTime.now();
entry.setCalc(ADD); entry.calc(ADD);
PropertyFileUtils.processDate(t, p, entry.set(time).unit(EntryDate.Units.MINUTE), true); PropertyFileUtils.processDate(p, entry.set(time).unit(EntryDate.Units.MINUTE));
assertThat(p.getProperty(entry.getKey())).as("processDate(now+1)") assertThat(p.getProperty(entry.key())).as("processDate(now+1)")
.isEqualTo(String.valueOf(time.plusMinutes(1).getMinute())); .isEqualTo(String.valueOf(time.plusMinutes(1).getMinute()));
entry.setCalc(SUB); entry.calc(SUB);
PropertyFileUtils.processDate(t, p, entry.set(time).unit(EntryDate.Units.HOUR).pattern("H"), true); PropertyFileUtils.processDate(p, entry.set(time).unit(EntryDate.Units.HOUR).pattern("H"));
assertThat(p.getProperty(entry.getKey())).as("processDate(now+1)") assertThat(p.getProperty(entry.key())).as("processDate(now+1)")
.isEqualTo(String.valueOf(time.minusHours(1).getHour())); .isEqualTo(String.valueOf(time.minusHours(1).getHour()));
} }
@Test @Test
void processDateAddTest() throws Exception { void processDateAddTest() {
var entryDate = newEntryDate(); var entryDate = newEntryDate();
entryDate.setCalc(ADD); entryDate.calc(ADD);
PropertyFileUtils.processDate(t, p, entryDate.now(), true); PropertyFileUtils.processDate(p, entryDate.now());
assertThat(p.getProperty(entryDate.getKey())).as("processDate(now+1)").isEqualTo(String.valueOf(dayOfYear + 1)); assertThat(p.getProperty(entryDate.key())).as("processDate(now+1)").isEqualTo(String.valueOf(dayOfYear + 1));
PropertyFileUtils.processDate(t, p, entryDate.now().calc(v -> v + 3), true); PropertyFileUtils.processDate(p, entryDate.now().calc(v -> v + 3));
assertThat(p.getProperty(entryDate.getKey())).as("processDate(now+3)").isEqualTo(String.valueOf(dayOfYear + 3)); assertThat(p.getProperty(entryDate.key())).as("processDate(now+3)").isEqualTo(String.valueOf(dayOfYear + 3));
entryDate.setCalc(ADD); entryDate.calc(ADD);
PropertyFileUtils.processDate(t, p, entryDate.set(ZonedDateTime.now()), true); PropertyFileUtils.processDate(p, entryDate.set(ZonedDateTime.now()));
assertThat(p.getProperty(entryDate.getKey())).as("processDate(ZonedDateTime+1)") assertThat(p.getProperty(entryDate.key())).as("processDate(ZonedDateTime+1)")
.isEqualTo(String.valueOf(dayOfYear + 1)); .isEqualTo(String.valueOf(dayOfYear + 1));
PropertyFileUtils.processDate(t, p, entryDate.set(Instant.now()).calc(v -> v + 2), true); PropertyFileUtils.processDate(p, entryDate.set(Instant.now()).calc(v -> v + 2));
assertThat(p.getProperty(entryDate.getKey())).as("processDate(Instant+2)").isEqualTo(String.valueOf(dayOfYear + 2)); assertThat(p.getProperty(entryDate.key())).as("processDate(Instant+2)").isEqualTo(String.valueOf(dayOfYear + 2));
entryDate.setCalc(v -> v + 3); entryDate.calc(v -> v + 3);
PropertyFileUtils.processDate(t, p, entryDate.set(LocalDateTime.now()), true); PropertyFileUtils.processDate(p, entryDate.set(LocalDateTime.now()));
assertThat(p.getProperty(entryDate.getKey())).as("processDate(LocalDteTime+2)").isEqualTo(String.valueOf(dayOfYear + 3)); assertThat(p.getProperty(entryDate.key())).as("processDate(LocalDteTime+2)").isEqualTo(String.valueOf(dayOfYear + 3));
} }
@Test @Test
void processIntAddTest() throws Exception { void processIntAddTest() {
var entryInt = newEntryInt(); var entryInt = newEntryInt().calc(ADD).defaultValue("-1");
entryInt.calc(ADD); PropertyFileUtils.processInt(p, entryInt);
entryInt.setDefaultValue("-1"); assertThat(p.getProperty(entryInt.key())).as("add(-1)").isEqualTo("0");
PropertyFileUtils.processInt(t, p, entryInt, true);
assertThat(p.getProperty(entryInt.getKey())).as("add(-1)").isEqualTo("0");
entryInt.setKey("anint"); entryInt.key("anInt").defaultValue("0");
entryInt.setDefaultValue("0"); PropertyFileUtils.processInt(p, entryInt);
PropertyFileUtils.processInt(t, p, entryInt, true); assertThat(p.getProperty(entryInt.key())).as("add(0)").isEqualTo("1");
assertThat(p.getProperty(entryInt.getKey())).as("add(0)").isEqualTo("1"); PropertyFileUtils.processInt(p, entryInt);
PropertyFileUtils.processInt(t, p, entryInt, true); assertThat(p.getProperty(entryInt.key())).as("add(1)").isEqualTo("2");
assertThat(p.getProperty(entryInt.getKey())).as("add(1)").isEqualTo("2");
entryInt.setKey("formatted.int"); entryInt.key("formatted.int").defaultValue("0013").pattern("0000");
entryInt.setDefaultValue("0013"); PropertyFileUtils.processInt(p, entryInt);
entryInt.setPattern("0000"); assertThat(p.getProperty(entryInt.key())).as("add(0013)").isEqualTo("0014");
PropertyFileUtils.processInt(t, p, entryInt, true); PropertyFileUtils.processInt(p, entryInt);
assertThat(p.getProperty(entryInt.getKey())).as("add(0013)").isEqualTo("0014"); assertThat(p.getProperty(entryInt.key())).as("add(0014)").isEqualTo("0015");
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(t, p, entryInt, true); PropertyFileUtils.processInt(p, entryInt);
assertThat(p.getProperty(entryInt.getKey())).as("add(0015)+2").isEqualTo("0017"); assertThat(p.getProperty(entryInt.key())).as("add(0015)+2").isEqualTo("0017");
} }
@Test @Test
@ -217,14 +216,14 @@ class PropertyFileUtilsTest {
var entry = newEntry(); var entry = newEntry();
PropertyFileUtils.processString(p, entry); PropertyFileUtils.processString(p, entry);
assertThat(entry.getNewValue()).as(String.format("processString(%s, %s)", entry.getKey(), entry.getNewValue())) assertThat(entry.newValue()).as(String.format("processString(%s, %s)", entry.key(), entry.newValue()))
.isEqualTo(p.getProperty(entry.getKey())); .isEqualTo(p.getProperty(entry.key()));
entry.setKey("version.minor"); entry.key("version.minor");
PropertyFileUtils.processString(p, entry.set(0)); PropertyFileUtils.processString(p, entry.set(0));
assertThat(entry.getNewValue().toString()).as(String.format("processString(%s, %s)", entry.getKey(), entry.getNewValue())) assertThat(entry.newValue().toString()).as(String.format("processString(%s, %s)", entry.key(), entry.newValue()))
.isEqualTo(p.getProperty(entry.getKey())); .isEqualTo(p.getProperty(entry.key()));
} }
@Test @Test
@ -239,13 +238,22 @@ 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)).as("load properties").isTrue(); assertThat(PropertyFileUtils.loadProperties(t, tmp, p, false)).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";
@ -261,9 +269,9 @@ class PropertyFileUtilsTest {
@Test @Test
void testWarn() { void testWarn() {
assertThatCode(() -> PropertyFileUtils.warn("command", "message", new IOException(t), true)) assertThatCode(() -> PropertyFileUtils.warn("command", "message", true, false))
.hasMessage(t).isInstanceOf(IOException.class); .isInstanceOf(ExitStatusException.class);
assertThatCode(() -> PropertyFileUtils.warn("command", t, new Exception(t), false)) assertThatCode(() -> PropertyFileUtils.warn("command", t, false, false))
.as("failOnWarning = false").doesNotThrowAnyException(); .as("failOnWarning = false").doesNotThrowAnyException();
} }
} }