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) {
super(key);
}
/**
- * Sets the initial value to set the {@link java.util.Properties property} to, if not already defined.
+ * Returns the modify function.
*
- * @param defaultValue the default value
- * @return the entry
+ * @return the modify function
*/
- @SuppressWarnings("unused")
- public Entry defaultValue(Object defaultValue) {
- setDefaultValue(defaultValue);
- return this;
+ protected BiFunction modify() {
+ return modify_;
}
/**
- * Sets the {@link Entry entry} up for deletion.
+ * Sets the modify function.
*
- * @return the entry
- */
- public Entry delete() {
- setDelete(true);
- return this;
- }
-
- /**
- * Creates a new {@link Entry entry}.
- *
- * @param modify the modification function
- * @return the entry
+ * @param modify the modify function
*/
public Entry modify(BiFunction modify) {
- setModify(modify);
+ modify_ = modify;
return this;
}
/**
- * Creates a new {@link Entry entry}.
+ * Sets the modify function.
*
* @param value the value to perform a modification with
- * @param modify the modification function
- * @return the entry
+ * @param modify the modify function
*/
public Entry modify(String value, BiFunction modify) {
- setModifyValue(value);
- setModify(modify);
+ modifyValue_ = value;
+ modify_ = modify;
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.
*
@@ -88,7 +85,7 @@ public class Entry extends EntryBase {
* @return the entry
*/
public Entry set(Object s) {
- setNewValue(s);
+ newValue(s);
return this;
}
}
diff --git a/src/main/java/rife/bld/extension/propertyfile/EntryBase.java b/src/main/java/rife/bld/extension/propertyfile/EntryBase.java
index b381b0f..ff9f05e 100644
--- a/src/main/java/rife/bld/extension/propertyfile/EntryBase.java
+++ b/src/main/java/rife/bld/extension/propertyfile/EntryBase.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2023-2024 the original author or authors.
+ * 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.
@@ -16,7 +16,6 @@
package rife.bld.extension.propertyfile;
-import java.util.function.BiFunction;
import java.util.function.IntFunction;
/**
@@ -26,17 +25,14 @@ import java.util.function.IntFunction;
* @author Geert Bevin
* @since 1.0
*/
-@SuppressWarnings("PMD.DataClass")
-public class EntryBase {
- private IntFunction calc;
- private Object defaultValue;
- private boolean isDelete;
- private String key;
- private BiFunction modify;
- private String modifyValue = "";
- private Object newValue;
- private String pattern = "";
- private EntryDate.Units unit = EntryDate.Units.DAY;
+@SuppressWarnings({"unchecked", "PMD.AbstractClassWithoutAbstractMethod"})
+public abstract class EntryBase {
+ private IntFunction calc_;
+ private Object defaultValue_;
+ private boolean isDelete_;
+ private String key_;
+ private Object newValue_;
+ private Object pattern_;
/**
* Creates a new {@link EntryBase entry}.
@@ -44,7 +40,7 @@ public class EntryBase {
* @param key the required property key
*/
public EntryBase(String key) {
- this.key = key;
+ key_ = key;
}
/**
@@ -52,8 +48,18 @@ public class EntryBase {
*
* @return the calc function
*/
- protected IntFunction getCalc() {
- return calc;
+ protected IntFunction calc() {
+ return calc_;
+ }
+
+ /**
+ * Sets the calculation function.
+ *
+ * @param calc the calc function
+ */
+ public T calc(IntFunction calc) {
+ calc_ = calc;
+ return (T) this;
}
/**
@@ -61,62 +67,26 @@ public class EntryBase {
*
* @return the default value
*/
- protected Object getDefaultValue() {
- return defaultValue;
+ protected Object 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() {
- return key;
+ public T defaultValue(Object defaultValue) {
+ defaultValue_ = defaultValue;
+ return (T) this;
}
/**
- * Returns the modify function.
- *
- * @return the modify function
+ * Indicates that the {@link java.util.Properties property} is to be deleted.
*/
- protected BiFunction getModify() {
- return modify;
- }
-
- /**
- * 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;
+ public T delete() {
+ isDelete_ = true;
+ return (T) this;
}
/**
@@ -125,7 +95,16 @@ public class EntryBase {
* @return {@code true} or {@code false}
*/
protected boolean isDelete() {
- return isDelete;
+ return isDelete_;
+ }
+
+ /**
+ * Returns the key of the {@link java.util.Properties property}.
+ *
+ * @return the key
+ */
+ protected String key() {
+ return key_;
}
/**
@@ -134,75 +113,18 @@ public class EntryBase {
* @param key the {@link java.util.Properties property} key
* @return this instance
*/
- @SuppressWarnings("unused")
- public EntryBase key(String key) {
- setKey(key);
- return this;
+ public T key(String key) {
+ key_ = key;
+ 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 calc) {
- this.calc = calc;
- }
-
- /**
- * 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) {
- this.defaultValue = defaultValue;
- }
-
- /**
- * Sets whether the {@link java.util.Properties property} should be deleted.
- *
- * @param delete {@code true} or {@code false}
- */
- protected void setDelete(boolean delete) {
- isDelete = delete;
- }
-
- /**
- * Sets the key of the {@link java.util.Properties property}.
- *
- * @param key the {@link java.util.Properties property} key
- */
- protected void setKey(String key) {
- this.key = key;
- }
-
- /**
- * Sets the modify function.
- *
- * @param modify the modify function
- */
- protected void setModify(BiFunction modify) {
- this.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 modify) {
- this.modifyValue = value;
- this.modify = modify;
- }
-
- /**
- * Sets the modify value.
- *
- * @param value the modify value.
- */
- protected void setModifyValue(String value) {
- this.modifyValue = value;
+ protected Object newValue() {
+ return newValue_;
}
/**
@@ -210,26 +132,26 @@ public class EntryBase {
*
* @param newValue the new value
*/
- public void setNewValue(Object newValue) {
- this.newValue = newValue;
+ protected void newValue(Object newValue) {
+ newValue_ = newValue;
}
/**
- * 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.
+ * Returns the pattern.
+ *
+ * @return the pattern
+ */
+ protected Object pattern() {
+ return pattern_;
+ }
+
+ /**
+ * Sets the {@link java.util.Formatter} pattern.
*
* @param pattern the pattern
*/
- protected void setPattern(String pattern) {
- this.pattern = pattern;
- }
-
- /**
- * 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;
+ public T pattern(Object pattern) {
+ pattern_ = pattern;
+ return (T) this;
}
}
diff --git a/src/main/java/rife/bld/extension/propertyfile/EntryDate.java b/src/main/java/rife/bld/extension/propertyfile/EntryDate.java
index 4d7fba3..8990119 100644
--- a/src/main/java/rife/bld/extension/propertyfile/EntryDate.java
+++ b/src/main/java/rife/bld/extension/propertyfile/EntryDate.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2023-2024 the original author or authors.
+ * 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.
@@ -19,7 +19,6 @@ package rife.bld.extension.propertyfile;
import java.time.*;
import java.util.Calendar;
import java.util.Date;
-import java.util.function.IntFunction;
/**
* 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 Erik C. Thauvin
* @since 1.0
*/
-public class EntryDate extends EntryBase {
+public class EntryDate extends EntryBase {
+ 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
*/
@@ -37,46 +38,23 @@ public class EntryDate extends EntryBase {
super(key);
}
- /**
- * Creates a new {@link EntryDate entry}.
- *
- * @param calc the calculation function
- * @return this instance
- */
- public EntryDate calc(IntFunction calc) {
- setCalc(calc);
- return this;
- }
-
- /**
- * Sets the {@link EntryDate entry} up for deletion.
- *
- * @return this instance
- */
- public EntryDate delete() {
- setDelete(true);
- return this;
- }
-
/**
* Sets the new {@link java.util.Properties property} value to now.
*
* @return this instance
*/
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.
+ * Sets the {@link java.time.format.DateTimeFormatter DateTimeFormatter} pattern.
*
* @param pattern the pattern
- * @return this instance
*/
public EntryDate pattern(String pattern) {
- setPattern(pattern);
+ super.pattern(pattern);
return this;
}
@@ -87,7 +65,7 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate set(Instant instant) {
- setNewValue(instant);
+ newValue(instant);
return this;
}
@@ -98,7 +76,7 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate set(LocalDate date) {
- setNewValue(date);
+ newValue(date);
return this;
}
@@ -109,7 +87,7 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate set(LocalDateTime date) {
- setNewValue(date);
+ newValue(date);
return this;
}
@@ -120,7 +98,7 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate set(ZonedDateTime date) {
- setNewValue(date);
+ newValue(date);
return this;
}
@@ -131,7 +109,7 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate set(LocalTime time) {
- setNewValue(time);
+ newValue(time);
return this;
}
@@ -142,7 +120,7 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate set(Calendar cal) {
- setNewValue(cal);
+ newValue(cal);
return this;
}
@@ -153,10 +131,19 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate set(Date date) {
- setNewValue(date);
+ newValue(date);
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}.
*
@@ -164,7 +151,7 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate unit(Units unit) {
- setUnit(unit);
+ unit_ = unit;
return this;
}
diff --git a/src/main/java/rife/bld/extension/propertyfile/EntryInt.java b/src/main/java/rife/bld/extension/propertyfile/EntryInt.java
index 753d3e7..b2e0e91 100644
--- a/src/main/java/rife/bld/extension/propertyfile/EntryInt.java
+++ b/src/main/java/rife/bld/extension/propertyfile/EntryInt.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2023-2024 the original author or authors.
+ * 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.
@@ -16,17 +16,15 @@
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}.
*
* @author Erik C. Thauvin
* @since 1.0
*/
-public class EntryInt extends EntryBase {
+public class EntryInt extends EntryBase {
/**
- * Creates a new date {@link Entry entry}.
+ * Creates a new {@link EntryInt entry}.
*
* @param key the required property key
*/
@@ -35,35 +33,12 @@ public class EntryInt extends EntryBase {
}
/**
- * Creates a new {@link EntryInt entry}.
+ * Sets the {@link java.text.DecimalFormat DecimalFormat} pattern.
*
- * @param calc the calculation function.
- * @return this instance
+ * @param pattern the pattern
*/
- public EntryInt calc(IntFunction 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(true);
+ public EntryInt pattern(String pattern) {
+ super.pattern(pattern);
return this;
}
@@ -74,7 +49,7 @@ public class EntryInt extends EntryBase {
* @return this instance
*/
public EntryInt set(int i) {
- setNewValue(i);
+ newValue(i);
return this;
}
}
diff --git a/src/main/java/rife/bld/extension/propertyfile/PropertyFileOperation.java b/src/main/java/rife/bld/extension/propertyfile/PropertyFileOperation.java
index e01cb11..f51b288 100644
--- a/src/main/java/rife/bld/extension/propertyfile/PropertyFileOperation.java
+++ b/src/main/java/rife/bld/extension/propertyfile/PropertyFileOperation.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2023-2024 the original author or authors.
+ * 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.
@@ -18,11 +18,15 @@ package rife.bld.extension.propertyfile;
import rife.bld.BaseProject;
import rife.bld.operations.AbstractOperation;
+import rife.bld.operations.exceptions.ExitStatusException;
import java.io.File;
+import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
+import java.util.logging.Level;
+import java.util.logging.Logger;
/**
* Creates or applies edits to a {@link Properties Properties} file.
@@ -31,11 +35,12 @@ import java.util.Properties;
* @since 1.0
*/
public class PropertyFileOperation extends AbstractOperation {
- private final List entries = new ArrayList<>();
- private String comment = "";
- private boolean failOnWarning;
- private File file;
- private BaseProject project;
+ private static final Logger LOGGER = Logger.getLogger(PropertyFileOperation.class.getName());
+ private final List> entries_ = new ArrayList<>();
+ private String comment_ = "";
+ private boolean failOnWarning_;
+ private File file_;
+ private BaseProject project_;
/**
* Sets the comment to be inserted at the top of the {@link java.util.Properties} file.
@@ -43,9 +48,8 @@ public class PropertyFileOperation extends AbstractOperation entry) {
+ entries_.add(entry);
return this;
}
@@ -67,38 +70,49 @@ public class PropertyFileOperation extends AbstractOperation " + dte.getMessage(),
- dte, failOnWarning);
- success = false;
+ throw new IllegalArgumentException(
+ "Non-date value for \"" + entry.key() + "\" --> " + dte.getMessage(), dte);
}
}
-
- if (success) {
- p.setProperty(entry.getKey(), parsedValue);
- }
-
- return success;
+ p.setProperty(entry.key(), dateValue);
}
/**
* Processes an integer {@link Properties property}.
*
- * @param command the issuing command
- * @param p the {@link Properties property}
- * @param entry the {@link Entry} containing the {@link Properties property} edits
- * @param failOnWarning the fail on warning
- * @return the boolean
- * @throws Exception the exception
+ * @param p the {@link Properties property}
+ * @param entry the {@link Entry} containing the {@link Properties property} edits
+ * @throws NumberFormatException if a parsing error occurs
*/
- @SuppressWarnings("PMD.SignatureDeclareThrowsException")
- public static boolean processInt(String command, Properties p, EntryInt entry, boolean failOnWarning)
- throws Exception {
- var success = true;
+ public static void processInt(Properties p, EntryInt entry) throws IllegalArgumentException {
int intValue = 0;
try {
- var fmt = new DecimalFormat(entry.getPattern());
- var value = currentValue(p.getProperty(entry.getKey()), entry.getDefaultValue(),
- entry.getNewValue());
+ var fmt = new DecimalFormat(objectToString(entry.pattern()));
+ var currentValue = currentValue(p.getProperty(entry.key()), entry.defaultValue(), entry.newValue());
- if (value != null) {
- intValue = fmt.parse(String.valueOf(value)).intValue();
+ if (currentValue != null) {
+ intValue = fmt.parse(String.valueOf(currentValue)).intValue();
}
- if (entry.getCalc() != null) {
- intValue = entry.getCalc().apply(intValue);
+ if (entry.calc() != null) {
+ intValue = entry.calc().apply(intValue);
}
- p.setProperty(entry.getKey(), fmt.format(intValue));
+
+ p.setProperty(entry.key(), fmt.format(intValue));
} catch (NumberFormatException | ParseException e) {
- warn(command, "Non-integer value for \"" + entry.getKey() + "\" --> " + e.getMessage(), e,
- failOnWarning);
- success = false;
+ throw new IllegalArgumentException(
+ "Non-integer value for \"" + entry.key() + "\" --> " + e.getMessage(), e);
}
-
- return success;
}
/**
@@ -237,18 +224,16 @@ public final class PropertyFileUtils {
*
* @param p the {@link Properties property}
* @param entry the {@link Entry} containing the {@link Properties property} edits
- * @return the boolean
*/
- public static boolean processString(Properties p, Entry entry) {
- var value = currentValue(p.getProperty(entry.getKey()), entry.getDefaultValue(), entry.getNewValue());
+ public static void processString(Properties p, Entry entry) {
+ var currentValue = currentValue(p.getProperty(entry.key()), entry.defaultValue(), entry.newValue());
- 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) {
- p.setProperty(entry.getKey(), entry.getModify().apply(p.getProperty(entry.getKey()), entry.getModifyValue()));
+ if (entry.modify() != null && entry.modifyValue() != null) {
+ var modify = entry.modify().apply(p.getProperty(entry.key()), entry.modifyValue());
+ p.setProperty(entry.key(), String.format(modify, entry.pattern()));
}
-
- return true;
}
/**
@@ -262,20 +247,8 @@ public final class PropertyFileUtils {
public static void saveProperties(File file, String comment, Properties p) throws IOException {
try (var output = Files.newOutputStream(file.toPath())) {
p.store(output, comment);
- } catch (IIOException 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);
+ } catch (IOException ioe) {
+ throw new IOException("An IO error occurred while saving the Properties file: " + file, ioe);
}
}
@@ -284,17 +257,20 @@ public final class PropertyFileUtils {
*
* @param command The command name
* @param message the message log
- * @param e the related exception
* @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, Exception e, boolean failOnWarning) throws Exception {
+ static void warn(String command, String message, boolean failOnWarning, boolean silent)
+ throws ExitStatusException {
if (failOnWarning) {
- LOGGER.log(Level.SEVERE, '[' + command + "] " + message, e);
- throw e;
+ if (LOGGER.isLoggable(Level.SEVERE) && !silent) {
+ LOGGER.log(Level.SEVERE, '[' + command + "] " + message);
+ }
+ throw new ExitStatusException(ExitStatusException.EXIT_FAILURE);
} else {
- warn(command, message);
+ if (LOGGER.isLoggable(Level.WARNING) && !silent) {
+ LOGGER.warning('[' + command + "] " + message);
+ }
}
}
}
diff --git a/src/test/java/rife/bld/extension/propertyfile/PropertyFileOperationTest.java b/src/test/java/rife/bld/extension/propertyfile/PropertyFileOperationTest.java
new file mode 100644
index 0000000..a0d949d
--- /dev/null
+++ b/src/test/java/rife/bld/extension/propertyfile/PropertyFileOperationTest.java
@@ -0,0 +1,104 @@
+/*
+ * 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);
+ }
+}
diff --git a/src/test/java/rife/bld/extension/propertyfile/PropertyFileUtilsTest.java b/src/test/java/rife/bld/extension/propertyfile/PropertyFileUtilsTest.java
index d64e767..a3b6695 100644
--- a/src/test/java/rife/bld/extension/propertyfile/PropertyFileUtilsTest.java
+++ b/src/test/java/rife/bld/extension/propertyfile/PropertyFileUtilsTest.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2023-2024 the original author or authors.
+ * 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.
@@ -17,19 +17,19 @@
package rife.bld.extension.propertyfile;
import org.junit.jupiter.api.Test;
+import rife.bld.operations.exceptions.ExitStatusException;
import rife.tools.Localization;
import java.io.File;
-import java.io.IOException;
import java.time.*;
import java.util.Calendar;
import java.util.Date;
import java.util.Properties;
-import static org.assertj.core.api.Assertions.assertThat; // NOPMD
-import static org.assertj.core.api.Assertions.assertThatCode; // NOPMD
-import static rife.bld.extension.propertyfile.Calc.ADD; // NOPMD
-import static rife.bld.extension.propertyfile.Calc.SUB; // NOPMD
+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.SUB;
/**
* PropertyFileUtilsTest class
@@ -37,8 +37,8 @@ import static rife.bld.extension.propertyfile.Calc.SUB; // NOPMD
* @author Erik C. Thauvin
* @since 1.0
*/
+@SuppressWarnings("PMD.AvoidDuplicateLiterals")
class PropertyFileUtilsTest {
- final static int dayOfYear = LocalDate.now().getDayOfYear();
final static Properties p = new Properties();
final static String t = "test";
@@ -49,7 +49,7 @@ class PropertyFileUtilsTest {
public EntryDate newEntryDate() {
p.clear();
- return new EntryDate("adate").pattern("D");
+ return new EntryDate("aDate").pattern("D");
}
public EntryInt newEntryInt() {
@@ -58,42 +58,41 @@ class PropertyFileUtilsTest {
}
@Test
- @SuppressWarnings("PMD.SignatureDeclareThrowsException")
- void parseDateSub() throws Exception {
- var entryDate = newEntryDate();
- entryDate.setCalc(SUB);
- PropertyFileUtils.processDate(t, p, entryDate.now(), true);
- assertThat(p.getProperty(entryDate.getKey())).as("processDate(now-3)").isEqualTo(String.valueOf(dayOfYear - 1));
+ void parseDateSub() {
+ var entryDate = newEntryDate().calc(SUB);
+ PropertyFileUtils.processDate(p, entryDate.now());
+ assertThat(p.getProperty(entryDate.key())).as("processDate(now-3)").isEqualTo(String.valueOf(
+ LocalDateTime.now().minusDays(1).getDayOfYear()));
- entryDate.setCalc(v -> v - 2);
- PropertyFileUtils.processDate(t, p, entryDate.now(), true);
- assertThat(p.getProperty(entryDate.getKey())).as("processDate(now-2)").isEqualTo(String.valueOf(dayOfYear - 2));
+ entryDate.calc(v -> v - 2);
+ PropertyFileUtils.processDate(p, entryDate.now());
+ assertThat(p.getProperty(entryDate.key())).as("processDate(now-2)").isEqualTo(String.valueOf(
+ LocalDateTime.now().minusDays(2).getDayOfYear()));
- entryDate.setCalc(SUB);
- PropertyFileUtils.processDate(t, p, entryDate.set(new Date()), true);
- assertThat(p.getProperty(entryDate.getKey())).as("processDate(date-1)").isEqualTo(String.valueOf(dayOfYear - 1));
+ entryDate.calc(SUB);
+ PropertyFileUtils.processDate(p, entryDate.set(new Date()));
+ assertThat(p.getProperty(entryDate.key())).as("processDate(date-1)").isEqualTo(String.valueOf(
+ LocalDateTime.now().minusDays(1).getDayOfYear()));
- entryDate.setCalc(v -> v - 2);
- PropertyFileUtils.processDate(t, p, entryDate.set(Calendar.getInstance()), true);
- assertThat(p.getProperty(entryDate.getKey())).as("processDate(cal-2)").isEqualTo(String.valueOf(dayOfYear - 2));
+ entryDate.calc(v -> v - 2);
+ PropertyFileUtils.processDate(p, entryDate.set(Calendar.getInstance()));
+ assertThat(p.getProperty(entryDate.key())).as("processDate(cal-2)").isEqualTo(String.valueOf(
+ LocalDateTime.now().minusDays(2).getDayOfYear()));
- entryDate.setCalc(v -> v - 3);
- PropertyFileUtils.processDate(t, p, entryDate.set(LocalDate.now()),
- true);
- assertThat(p.getProperty(entryDate.getKey())).as("processDate(LocalDate-3)").isEqualTo(String.valueOf(dayOfYear - 3));
+ entryDate.calc(v -> v - 3);
+ PropertyFileUtils.processDate(p, entryDate.set(LocalDate.now()));
+ assertThat(p.getProperty(entryDate.key())).as("processDate(LocalDate-3)").isEqualTo(String.valueOf(
+ LocalDateTime.now().minusDays(3).getDayOfYear()));
}
@Test
- @SuppressWarnings("PMD.SignatureDeclareThrowsException")
- void parseIntSubTest() throws Exception {
- var entryInt = newEntryInt();
- entryInt.calc(SUB);
- entryInt.setPattern("0000");
- PropertyFileUtils.processInt(t, p, entryInt.defaultValue("0017"), true);
- assertThat(p.getProperty(entryInt.getKey())).as("sub(0017)").isEqualTo("0016");
+ void parseIntSubTest() {
+ var entryInt = newEntryInt().calc(SUB).pattern("0000");
+ PropertyFileUtils.processInt(p, entryInt.defaultValue("0017"));
+ assertThat(p.getProperty(entryInt.key())).as("sub(0017)").isEqualTo("0016");
- PropertyFileUtils.processInt(t, p, entryInt.set(16).calc(v -> v - 3), true);
- assertThat(p.getProperty(entryInt.getKey())).as("sub(16)-3").isEqualTo("0013");
+ PropertyFileUtils.processInt(p, entryInt.set(16).calc(v -> v - 3));
+ assertThat(p.getProperty(entryInt.key())).as("sub(16)-3").isEqualTo("0013");
}
@Test
@@ -102,119 +101,122 @@ class PropertyFileUtilsTest {
var entry = newEntry();
PropertyFileUtils.processString(p, entry.set(1));
PropertyFileUtils.processString(p, entry.modify("-foo", String::concat));
- assertThat(p.getProperty(entry.getKey())).as(String.format("processString(%s, %s)", entry.getKey(),
- entry.getNewValue())).isEqualTo("1-foo");
+ assertThat(p.getProperty(entry.key())).as(String.format("processString(%s, %s)", entry.key(),
+ entry.newValue())).isEqualTo("1-foo");
}
@Test
void parseStringCap() {
var entry = newEntry();
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
void parseStringCat() {
var entry = newEntry();
- entry.set(t).setModify("-foo", String::concat);
+ entry.set(t).modify("-foo", String::concat);
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
void parseStringPrepend() {
var entry = newEntry();
PropertyFileUtils.processString(p, entry.set(1));
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");
}
@Test
void parseStringReplace() {
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);
- assertThat(p.getProperty(entry.getKey())).as("replace(t -> T)").isEqualTo("TesT");
-
+ assertThat(p.getProperty(entry.key())).as("replace(t -> T)").isEqualTo("TesT");
}
@Test
void parseStringSub() {
var entry = newEntry();
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
- @SuppressWarnings("PMD.SignatureDeclareThrowsException")
- void parseTimeTest() throws Exception {
+ void parseTimeTest() {
var entry = new EntryDate("time").pattern("m");
var time = LocalTime.now();
- entry.setCalc(ADD);
- PropertyFileUtils.processDate(t, p, entry.set(time).unit(EntryDate.Units.MINUTE), true);
- assertThat(p.getProperty(entry.getKey())).as("processDate(now+1)")
+ entry.calc(ADD);
+ PropertyFileUtils.processDate(p, entry.set(time).unit(EntryDate.Units.MINUTE));
+ assertThat(p.getProperty(entry.key())).as("processDate(now+1)")
.isEqualTo(String.valueOf(time.plusMinutes(1).getMinute()));
- entry.setCalc(SUB);
- PropertyFileUtils.processDate(t, p, entry.set(time).unit(EntryDate.Units.HOUR).pattern("H"), true);
- assertThat(p.getProperty(entry.getKey())).as("processDate(now+1)")
+ entry.calc(SUB);
+ PropertyFileUtils.processDate(p, entry.set(time).unit(EntryDate.Units.HOUR).pattern("H"));
+ assertThat(p.getProperty(entry.key())).as("processDate(now+1)")
.isEqualTo(String.valueOf(time.minusHours(1).getHour()));
}
@Test
- @SuppressWarnings("PMD.SignatureDeclareThrowsException")
- void processDateAddTest() throws Exception {
+ void processDateAddTest() {
var entryDate = newEntryDate();
- entryDate.setCalc(ADD);
- PropertyFileUtils.processDate(t, p, entryDate.now(), true);
- assertThat(p.getProperty(entryDate.getKey())).as("processDate(now+1)").isEqualTo(String.valueOf(dayOfYear + 1));
+ entryDate.calc(ADD);
+ PropertyFileUtils.processDate(p, entryDate.now());
+ assertThat(p.getProperty(entryDate.key())).as("processDate(now+1)").isEqualTo(String.valueOf(
+ LocalDateTime.now().plusDays(1).getDayOfYear()));
- PropertyFileUtils.processDate(t, p, entryDate.now().calc(v -> v + 3), true);
- assertThat(p.getProperty(entryDate.getKey())).as("processDate(now+3)").isEqualTo(String.valueOf(dayOfYear + 3));
+ PropertyFileUtils.processDate(p, entryDate.now().calc(v -> v + 3));
+ assertThat(p.getProperty(entryDate.key())).as("processDate(now+3)").isEqualTo(String.valueOf(
+ LocalDateTime.now().plusDays(3).getDayOfYear()));
- entryDate.setCalc(ADD);
- PropertyFileUtils.processDate(t, p, entryDate.set(ZonedDateTime.now()), true);
- assertThat(p.getProperty(entryDate.getKey())).as("processDate(ZonedDateTime+1)")
- .isEqualTo(String.valueOf(dayOfYear + 1));
+ entryDate.calc(ADD);
+ PropertyFileUtils.processDate(p, entryDate.set(ZonedDateTime.now()));
+ assertThat(p.getProperty(entryDate.key())).as("processDate(ZonedDateTime+1)")
+ .isEqualTo(String.valueOf(LocalDateTime.now().plusDays(1).getDayOfYear()));
- PropertyFileUtils.processDate(t, p, entryDate.set(Instant.now()).calc(v -> v + 2), true);
- assertThat(p.getProperty(entryDate.getKey())).as("processDate(Instant+2)").isEqualTo(String.valueOf(dayOfYear + 2));
+ PropertyFileUtils.processDate(p, entryDate.set(Instant.now()).calc(v -> v + 2));
+ assertThat(p.getProperty(entryDate.key())).as("processDate(Instant+2)").isEqualTo(String.valueOf(
+ LocalDateTime.now().plusDays(2).getDayOfYear()));
- entryDate.setCalc(v -> v + 3);
- PropertyFileUtils.processDate(t, p, entryDate.set(LocalDateTime.now()), true);
- assertThat(p.getProperty(entryDate.getKey())).as("processDate(LocalDteTime+2)").isEqualTo(String.valueOf(dayOfYear + 3));
+ entryDate.calc(v -> v + 3);
+ PropertyFileUtils.processDate(p, entryDate.set(LocalDateTime.now()));
+ assertThat(p.getProperty(entryDate.key())).as("processDate(LocalDteTime+2)")
+ .isEqualTo(String.valueOf(LocalDateTime.now().plusDays(3).getDayOfYear()));
}
@Test
- @SuppressWarnings("PMD.SignatureDeclareThrowsException")
- void processIntAddTest() throws Exception {
- var entryInt = newEntryInt();
- entryInt.calc(ADD);
- entryInt.setDefaultValue("-1");
- PropertyFileUtils.processInt(t, p, entryInt, true);
- assertThat(p.getProperty(entryInt.getKey())).as("add(-1)").isEqualTo("0");
+ void processIntAddTest() {
+ var entryInt = newEntryInt().calc(ADD).defaultValue("-1");
+ PropertyFileUtils.processInt(p, entryInt);
+ assertThat(p.getProperty(entryInt.key())).as("add(-1)").isEqualTo("0");
- entryInt.setKey("anint");
- entryInt.setDefaultValue("0");
- PropertyFileUtils.processInt(t, p, entryInt, true);
- assertThat(p.getProperty(entryInt.getKey())).as("add(0)").isEqualTo("1");
- PropertyFileUtils.processInt(t, p, entryInt, true);
- assertThat(p.getProperty(entryInt.getKey())).as("add(1)").isEqualTo("2");
+ entryInt.key("anInt").defaultValue("0");
+ PropertyFileUtils.processInt(p, entryInt);
+ assertThat(p.getProperty(entryInt.key())).as("add(0)").isEqualTo("1");
+ PropertyFileUtils.processInt(p, entryInt);
+ assertThat(p.getProperty(entryInt.key())).as("add(1)").isEqualTo("2");
- entryInt.setKey("formatted.int");
- entryInt.setDefaultValue("0013");
- entryInt.setPattern("0000");
- PropertyFileUtils.processInt(t, p, entryInt, true);
- 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.key("formatted.int").defaultValue("0013").pattern("0000");
+ PropertyFileUtils.processInt(p, entryInt);
+ assertThat(p.getProperty(entryInt.key())).as("add(0013)").isEqualTo("0014");
+ PropertyFileUtils.processInt(p, entryInt);
+ assertThat(p.getProperty(entryInt.key())).as("add(0014)").isEqualTo("0015");
entryInt.calc(v -> v + 2);
- PropertyFileUtils.processInt(t, p, entryInt, true);
- assertThat(p.getProperty(entryInt.getKey())).as("add(0015)+2").isEqualTo("0017");
+ PropertyFileUtils.processInt(p, entryInt);
+ assertThat(p.getProperty(entryInt.key())).as("add(0015)+2").isEqualTo("0017");
}
@Test
@@ -222,18 +224,17 @@ class PropertyFileUtilsTest {
var entry = newEntry();
PropertyFileUtils.processString(p, entry);
- assertThat(entry.getNewValue()).as(String.format("processString(%s, %s)", entry.getKey(), entry.getNewValue()))
- .isEqualTo(p.getProperty(entry.getKey()));
+ assertThat(entry.newValue()).as(String.format("processString(%s, %s)", entry.key(), entry.newValue()))
+ .isEqualTo(p.getProperty(entry.key()));
- entry.setKey("version.minor");
+ entry.key("version.minor");
PropertyFileUtils.processString(p, entry.set(0));
- assertThat(entry.getNewValue().toString()).as(String.format("processString(%s, %s)", entry.getKey(), entry.getNewValue()))
- .isEqualTo(p.getProperty(entry.getKey()));
+ assertThat(entry.newValue().toString()).as(String.format("processString(%s, %s)", entry.key(), entry.newValue()))
+ .isEqualTo(p.getProperty(entry.key()));
}
@Test
- @SuppressWarnings("PMD.SignatureDeclareThrowsException")
void savePropertiesTest() throws Exception {
var p = new Properties();
var test = "test";
@@ -245,13 +246,22 @@ class PropertyFileUtilsTest {
assertThatCode(() -> PropertyFileUtils.saveProperties(tmp, "Generated file - do not modify!", p))
.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);
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
void testCurrentValue() {
var value = "value";
@@ -267,9 +277,9 @@ class PropertyFileUtilsTest {
@Test
void testWarn() {
- assertThatCode(() -> PropertyFileUtils.warn("command", "message", new IOException(t), true))
- .hasMessage(t).isInstanceOf(IOException.class);
- assertThatCode(() -> PropertyFileUtils.warn("command", t, new Exception(t), false))
+ assertThatCode(() -> PropertyFileUtils.warn("command", "message", true, false))
+ .isInstanceOf(ExitStatusException.class);
+ assertThatCode(() -> PropertyFileUtils.warn("command", t, false, false))
.as("failOnWarning = false").doesNotThrowAnyException();
}
}