Merge pull request #232 from metafacture/230-addTransformationFunction

Add `timestamp()` Fix function.

Author: blackwinter

README.md

@@ -310,6 +310,20 @@ hash("foo")
 # ["name", "value"] => {"name":"value"}
 ```
 
+#### `timestamp`
+
+Creates (or replaces) a field with the current timestamp.
+
+Options:
+
+- `format`: Date and time pattern as in [java.text.SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html) (Default: Unix timestamp).
+- `timezone`: Time zone as in [java.util.TimeZone](https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html) (Default: UTC).
+- `language`: Language tag as in [java.util.Locale](https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html) (Default: The locale of the host system).
+
+```perl
+timestamp("<targetField>"[, format: "<formatPattern>"][, timezone: "<timezoneCode>"][, language: "<languageCode>"])
+```
+
 #### `format`
 
 Replaces the value with a formatted (`sprintf`-like) version.

metafix/src/main/java/org/metafacture/metafix/FixMethod.java

@@ -18,6 +18,7 @@
 
 import org.metafacture.metafix.api.FixFunction;
 import org.metafacture.metamorph.api.Maps;
+import org.metafacture.metamorph.functions.Timestamp;
 import org.metafacture.metamorph.maps.FileMap;
 
 import java.io.File;
@@ -286,6 +287,19 @@ public void apply(final Metafix metafix, final Record record, final List<String>
             record.set(field, newValue);
         }
     },
+    timestamp {
+        @Override
+        public void apply(final Metafix metafix, final Record record, final List<String> params, final Map<String, String> options) {
+            final String field = params.get(0);
+            final Timestamp timestamp = new Timestamp();
+
+            withOption(options, "format", timestamp::setFormat);
+            withOption(options, "language", timestamp::setLanguage);
+            withOption(options, "timezone", timestamp::setTimezone);
+
+            record.set(field, new Value(timestamp.process(null)));
+        }
+    },
     vacuum {
         @Override
         public void apply(final Metafix metafix, final Record record, final List<String> params, final Map<String, String> options) {

metafix/src/main/java/org/metafacture/metafix/api/FixFunction.java

@@ -24,13 +24,20 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.function.Consumer;
 import java.util.stream.Stream;
 
 @FunctionalInterface
 public interface FixFunction {
 
     void apply(Metafix metafix, Record record, List<String> params, Map<String, String> options);
 
+    default void withOption(final Map<String, String> options, final String key, final Consumer<String> consumer) {
+        if (options.containsKey(key)) {
+            consumer.accept(options.get(key));
+        }
+    }
+
     default boolean getBoolean(final Map<String, String> options, final String key) {
         return Boolean.parseBoolean(options.get(key));
     }

metafix/src/test/java/org/metafacture/metafix/MetafixRecordTest.java

@@ -17,6 +17,7 @@
 package org.metafacture.metafix;
 
 import org.metafacture.framework.StreamReceiver;
+import org.metafacture.metamorph.api.MorphBuildException;
 
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
@@ -2798,6 +2799,56 @@ public void shouldRenameArrayFieldWithAsterisk() {
         );
     }
 
+    private void shouldNotAddTimestamp(final String options, final String message) {
+        MetafixTestHelpers.assertProcessException(MorphBuildException.class, message, () -> shouldAddTimestamp(options, ""));
+    }
+
+    private void shouldAddTimestamp(final String options, final String pattern) {
+        MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
+                "timestamp(test" + options + ")"
+            ),
+            i -> {
+                i.startRecord("1");
+                i.endRecord();
+            },
+            o -> {
+                o.get().startRecord("1");
+                o.get().literal(ArgumentMatchers.eq("test"), ArgumentMatchers.matches(pattern));
+                o.get().endRecord();
+            }
+        );
+    }
+
+    @Test
+    public void shouldAddTimestamp() {
+        shouldAddTimestamp("", "\\d+");
+    }
+
+    @Test
+    public void shouldAddTimestampWithFormat() {
+        shouldAddTimestamp(", format: 'yyyy-MM-dd'", "\\d{4}-\\d{2}-\\d{2}");
+    }
+
+    @Test
+    public void shouldNotAddTimestampWithUnsupportedFormat() {
+        shouldNotAddTimestamp(", format: \"'\"", "The date/time format ''' is not supported. ");
+    }
+
+    @Test
+    public void shouldAddTimestampWithLanguage() {
+        shouldAddTimestamp(", format: 'yyyy-MM-dd G', language: 'pl'", "\\d{4}-\\d{2}-\\d{2} n\\.e\\.");
+    }
+
+    @Test
+    public void shouldNotAddTimestampWithUnsupportedLanguage() {
+        shouldNotAddTimestamp(", language: '--'", "Language '--' not supported.");
+    }
+
+    @Test
+    public void shouldAddTimestampWithTimezone() {
+        shouldAddTimestamp(", format: 'yyyy-MM-dd Z', timezone: 'UTC'", "\\d{4}-\\d{2}-\\d{2} \\+0000");
+    }
+
     @Test
     @MetafixToDo("See https://github.com/metafacture/metafacture-fix/pull/170")
     public void shouldNotSplitLiteralName() {