Change set_* functions to not create intermediate structures. (#631)

Mirroring Catmandu's behaviour: "will not create the intermediate structures if they are missing".

Author: blackwinter

README.md

@@ -642,21 +642,41 @@ retain("<sourceField_1>"[, ...])
 
 ##### `set_array`
 
-_Currently alias for [`add_array`](#add_array)._
+Creates a new array (with optional values), provided that the intermediate structures (i.e. parent fields) exist.
 
-We advise you to use [`add_array`](#add_array) instead of `set_array` due to changing behaviour in an upcoming release. For more information see: [#309](https://github.com/metafacture/metafacture-fix/issues/309)
+```perl
+set_array("<targetFieldName>")
+set_array("<targetFieldName>", "<value_1>"[, ...])
+```
+
+[Example in Playground](https://metafacture.org/playground/?example=set_array)
+
+[Java Code](https://github.com/search?type=code&q=repo:metafacture/metafacture-core+path:FixMethod.java+"+set_array+{")
 
 ##### `set_field`
 
-_Currently alias for [`add_field`](#add_field)._
+Creates a field with a defined value, provided that the intermediate structures (i.e. parent fields) exist.
+
+```perl
+set_field("<targetFieldName>", "<fieldValue>")
+```
+
+[Example in Playground](https://metafacture.org/playground/?example=set_field)
 
-We advise you to use [`add_field`](#add_field) instead of `set_field` due to changing behaviour in an upcoming release. For more information see: [#309](https://github.com/metafacture/metafacture-fix/issues/309)
+[Java Code](https://github.com/search?type=code&q=repo:metafacture/metafacture-core+path:FixMethod.java+"+set_field+{")
 
 ##### `set_hash`
 
-_Currently alias for [`add_hash`](#add_hash)._
+Creates a new hash (with optional values), provided that the intermediate structures (i.e. parent fields) exist.
+
+```perl
+set_hash("<targetFieldName>")
+set_hash("<targetFieldName>", "subfieldName": "<subfieldValue>"[, ...])
+```
+
+[Example in Playground](https://metafacture.org/playground/?example=set_hash)
 
-We advise you to use [`add_hash`](#add_hash) instead of `set_hash` due to changing behaviour in an upcoming release. For more information see: [#309](https://github.com/metafacture/metafacture-fix/issues/309)
+[Java Code](https://github.com/search?type=code&q=repo:metafacture/metafacture-core+path:FixMethod.java+"+set_hash+{")
 
 ##### `timestamp`
 

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

@@ -408,19 +408,25 @@ public void apply(final Metafix metafix, final Record record, final List<String>
     set_array {
         @Override
         public void apply(final Metafix metafix, final Record record, final List<String> params, final Map<String, String> options) {
-            add_array.apply(metafix, record, params, options);
+            if (parentFieldExists(record, params.get(0))) {
+                add_array.apply(metafix, record, params, options);
+            }
         }
     },
     set_field {
         @Override
         public void apply(final Metafix metafix, final Record record, final List<String> params, final Map<String, String> options) {
-            add_field.apply(metafix, record, params, options);
+            if (parentFieldExists(record, params.get(0))) {
+                add_field.apply(metafix, record, params, options);
+            }
         }
     },
     set_hash {
         @Override
         public void apply(final Metafix metafix, final Record record, final List<String> params, final Map<String, String> options) {
-            add_hash.apply(metafix, record, params, options);
+            if (parentFieldExists(record, params.get(0))) {
+                add_hash.apply(metafix, record, params, options);
+            }
         }
     },
     timestamp {

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

@@ -194,4 +194,17 @@ default Stream<Value> flatten(final Stream<Value> stream) {
         ));
     }
 
+    /**
+     * Checks whether the given field's parent field exists in the record.
+     *
+     * @param record the record
+     * @param field the field
+     *
+     * @return true if the given field's parent field exists in the record
+     */
+    default boolean parentFieldExists(final Record record, final String field) {
+        final int index = field.lastIndexOf(Value.FIELD_PATH_SEPARATOR);
+        return index < 1 || record.containsPath(field.substring(0, index));
+    }
+
 }

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

@@ -994,9 +994,9 @@ public void shouldLookupInCopiedNestedArraysCreatedWithPrepend() {
     private void shouldLookupInCopiedNestedArraysCreatedWith(final String reservedField) {
         MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
                 "put_map('rswk-indicator', s: 'SubjectHeading')",
-                "set_array('subject[]')",
-                "set_array('subject[]." + reservedField + ".componentList[]')",
-                "set_array('subject[].$last.componentList[]." + reservedField + ".type[]')",
+                "add_array('subject[]')",
+                "add_array('subject[]." + reservedField + ".componentList[]')",
+                "add_array('subject[].$last.componentList[]." + reservedField + ".type[]')",
                 "do list(path: 'D', 'var': '$i')",
                 "  copy_field('$i', 'subject[].$last.componentList[].$last.type[]." + reservedField + "')",
                 "end",

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

@@ -2818,11 +2818,9 @@ public void addFieldWithReplaceAllArray() {
     private void addFieldWithReplaceAllArray(final boolean replaceAll) {
         MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
                 "do list(path: 'contribution[]', 'var': '$i')",
-                "  set_array('$i.agent.altLabel[]')",
                 "  add_field('$i.agent.altLabel[].$append', 'contribution')",
                 "end",
                 "do list(path: 'subject[]', 'var': '$i')",
-                "  set_array('$i.altLabel[]')",
                 "  add_field('$i.altLabel[].$append', 'subject')",
                 "end",
                 replaceAll ? "replace_all('contribution[].*.agent.altLabel[].*', 't', '')" : "",
@@ -2875,10 +2873,10 @@ public void setArrayWithReplaceAll() {
     private void setArrayWithReplaceAll(final boolean replaceAll) {
         MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
                 "do list(path: 'contribution[]', 'var': '$i')",
-                "  set_array('$i.agent.altLabel[]', 'contribution')",
+                "  add_array('$i.agent.altLabel[]', 'contribution')",
                 "end",
                 "do list(path: 'subject[]', 'var': '$i')",
-                "  set_array('$i.altLabel[]', 'subject')",
+                "  add_array('$i.altLabel[]', 'subject')",
                 "end",
                 replaceAll ? "replace_all('contribution[].*.agent.altLabel[].*', 't', '')" : "",
                 replaceAll ? "replace_all('subject[].*.altLabel[].*', 't', '')" : ""
@@ -2930,11 +2928,9 @@ public void copyFieldWithReplaceAllArray() {
     private void copyFieldWithReplaceAllArray(final boolean replaceAll) {
         MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
                 "do list(path: 'contribution[]', 'var': '$i')",
-                "  set_array('$i.agent.altLabel[]')",
                 "  copy_field('$i.label', '$i.agent.altLabel[].$append')",
                 "end",
                 "do list(path: 'subject[]', 'var': '$i')",
-                "  set_array('$i.altLabel[]')",
                 "  copy_field('$i.label', '$i.altLabel[].$append')",
                 "end",
                 replaceAll ? "replace_all('contribution[].*.agent.altLabel[].*', 't', '')" : "",
@@ -2987,11 +2983,9 @@ public void pasteWithReplaceAll() {
     private void pasteWithReplaceAll(final boolean replaceAll) {
         MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
                 "do list(path: 'contribution[]', 'var': '$i')",
-                "  set_array('$i.agent.altLabel[]')",
                 "  paste('$i.agent.altLabel[].$append', '$i.label', '~!')",
                 "end",
                 "do list(path: 'subject[]', 'var': '$i')",
-                "  set_array('$i.altLabel[]')",
                 "  paste('$i.altLabel[].$append', '$i.label', '~!')",
                 "end",
                 replaceAll ? "replace_all('contribution[].*.agent.altLabel[].*', ' !', '')" : "",

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

@@ -164,10 +164,10 @@ public void entitiesPassThroughRepeatNestedEntity() {
     }
 
     @Test
-    public void setEmpty() {
+    public void addEmpty() {
         MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
-                "set_field('my.nested.name','patrick')",
-                "set_field('your.nested.name','nicolas')"),
+                "add_field('my.nested.name','patrick')",
+                "add_field('your.nested.name','nicolas')"),
             i -> {
                 i.startRecord("1");
                 i.endRecord();
@@ -185,6 +185,20 @@ public void setEmpty() {
             });
     }
 
+    @Test
+    public void setEmpty() {
+        MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
+                "set_field('my.nested.name','patrick')",
+                "set_field('your.nested.name','nicolas')"),
+            i -> {
+                i.startRecord("1");
+                i.endRecord();
+            }, (o, f) -> {
+                o.get().startRecord("1");
+                o.get().endRecord();
+            });
+    }
+
     @Test
     public void setExisting() {
         MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(

metafix/src/test/resources/org/metafacture/metafix/integration/lookup/fromXml/toJson/lookupInDeeplyNestedArrayOfObjects/test.fix

@@ -1,11 +1,11 @@
 put_map("rswk-indicator", s: "SubjectHeading")
 
 if exists("6890?")
-  set_array("subject[].$append.type[]", "ComplexSubject")
+  add_array("subject[].$append.type[]", "ComplexSubject")
   set_array("subject[].$last.label")
   set_array("subject[].$last.componentList[]")
   do list(path: "6890?", "var": "$i")
-    set_array("subject[].$last.componentList[].$append.type[]")
+    add_array("subject[].$last.componentList[].$append.type[]")
     do list(path: "$i.D", "var": "$k")
       copy_field("$k", "subject[].$last.componentList[].$last.type[].$append")
     end

metafix/src/test/resources/org/metafacture/metafix/integration/method/fromXml/toJson/replace_toUpper/test.fix

@@ -1,5 +1,5 @@
 do list(path: "700[01] ", "var": "$i")
-  set_hash("contribution[].$append.agent")
+  add_hash("contribution[].$append.agent")
   copy_field("$i.a", "contribution[].$last.agent.label")
 end
 

metafix/src/test/resources/org/metafacture/metafix/integration/method/fromXml/toJson/replace_toUpperStrictnessHandlesProcessExceptions/test.fix

@@ -1,5 +1,5 @@
 do list(path: "700[01] ", "var": "$i")
-  set_hash("contribution[].$append.agent")
+  add_hash("contribution[].$append.agent")
   copy_field("$i.a", "contribution[].$last.agent.label")
 end
 

metafix/src/test/resources/org/metafacture/metafix/integration/record/fromJson/toJson/add_arrayIntoArrayOfObjectsWithAppend/expected.json

@@ -0,0 +1,18 @@
+{
+  "animals" : [ {
+    "name" : "Jake",
+    "type" : "dog"
+  }, {
+    "name" : "Blacky",
+    "type" : "bird"
+  } ],
+  "animals_2" : [ {
+    "name" : "Jake",
+    "type" : "dog"
+  }, {
+    "name" : "Blacky",
+    "type" : "bird"
+  }, {
+    "test" : [ "test", "test", "test" ]
+  } ]
+}