[NOID] Fixes #4066: Implement an apoc.convert.fromYaml function (#4184)

* [NOID] Fixed #4066: Implement an apoc.convert.fromYaml function

* [NOID] added gradle deps

* [NOID] changes for 4.4

* [NOID] compile fixes, spotless and licence changes

* [NOID] retriggered licenses

* [NOID] retry license

* [NOID] retry trigger license

LICENSES.txt

@@ -103,6 +103,7 @@ Apache-2.0
   jackson-databind-2.17.2.jar
   jackson-dataformat-cbor-2.17.2.jar
   jackson-dataformat-csv-2.17.2.jar
+  jackson-dataformat-yaml-2.17.0.jar
   jackson-datatype-jsr310-2.17.0.jar
   jackson-datatype-jsr310-2.17.2.jar
   jackson-jaxrs-base-2.15.2.jar
@@ -221,6 +222,7 @@ Apache-2.0
   shiro-crypto-hash-1.13.0.jar
   shiro-event-1.13.0.jar
   shiro-lang-1.13.0.jar
+  snakeyaml-2.2.jar
   snappy-java-1.1.10.4.jar
   token-provider-2.0.3.jar
   websocket-api-9.4.53.v20231009.jar

NOTICE.txt

@@ -133,6 +133,7 @@ Apache-2.0
   jackson-databind-2.17.2.jar
   jackson-dataformat-cbor-2.17.2.jar
   jackson-dataformat-csv-2.17.2.jar
+  jackson-dataformat-yaml-2.17.0.jar
   jackson-datatype-jsr310-2.17.0.jar
   jackson-datatype-jsr310-2.17.2.jar
   jackson-jaxrs-base-2.15.2.jar
@@ -251,6 +252,7 @@ Apache-2.0
   shiro-crypto-hash-1.13.0.jar
   shiro-event-1.13.0.jar
   shiro-lang-1.13.0.jar
+  snakeyaml-2.2.jar
   snappy-java-1.1.10.4.jar
   token-provider-2.0.3.jar
   websocket-api-9.4.53.v20231009.jar

core/src/main/java/apoc/export/csv/CsvPropertyConverter.java

@@ -61,7 +61,7 @@ public static boolean addPropertyToGraphEntity(
         return true;
     }
 
-    static Object[] getPrototypeFor(String type) {
+    public static Object[] getPrototypeFor(String type) {
         switch (type) {
             case "INT":
             case "LONG":

docs/asciidoc/modules/ROOT/pages/overview/apoc.convert/apoc.convert.fromYaml.adoc

@@ -0,0 +1,37 @@
+= apoc.convert.fromYaml
+:description: This section contains reference documentation for the apoc.convert.fromYaml function.
+
+label:function[] label:apoc-extended[]
+
+[.emphasis]
+apoc.convert.fromYaml(value, $config) - Deserializes the YAML string to Neo4j value
+
+== Signature
+
+[source]
+----
+apoc.convert.fromYaml(value :: STRING, config = {} :: MAP) :: ANY
+----
+
+== Input parameters
+[.procedures, opts=header]
+|===
+| Name | Type | Default
+|value|STRING|null
+|config|MAP|{}
+|===
+
+== Config parameters
+include::partial$usage/config/apoc.convert.fromYaml.adoc[]
+
+[[yaml-dependencies]]
+=== Install dependencies
+Note that to use this function, you have to install additional dependencies
+which can be downloaded https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/{apoc-release}/apoc-yaml-dependencies-{apoc-release}-all.jar[from this link].
+
+
+[[usage-apoc.convert.fromYaml]]
+== Usage Examples
+include::partial$usage/apoc.convert.fromYaml.adoc[]
+
+

docs/asciidoc/modules/ROOT/pages/overview/apoc.convert/apoc.convert.toYaml.adoc

@@ -0,0 +1,36 @@
+= apoc.convert.fromYaml
+:description: This section contains reference documentation for the apoc.convert.fromYaml function.
+
+label:function[] label:apoc-full[]
+
+[.emphasis]
+apoc.convert.fromYaml(value, $config) - Deserializes the YAML string to Neo4j value
+
+== Signature
+
+[source]
+----
+apoc.convert.fromYaml(value :: STRING, config = {} :: MAP) :: ANY
+----
+
+== Input parameters
+[.procedures, opts=header]
+|===
+| Name | Type | Default
+|value|STRING|null
+|config|MAP|{}
+|===
+
+== Config parameters
+include::partial$usage/config/apoc.convert.fromYaml.adoc[]
+
+[[yaml-dependencies]]
+=== Install dependencies
+Note that to use this function, you have to install additional dependencies
+which can be downloaded https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/{apoc-release}/apoc-yaml-dependencies-{apoc-release}-all.jar[from this link].
+
+
+[[usage-apoc.convert.fromYaml]]
+== Usage Examples
+include::partial$usage/apoc.convert.fromYaml.adoc[]
+

docs/asciidoc/modules/ROOT/pages/overview/apoc.convert/index.adoc

@@ -118,5 +118,10 @@ apoc.convert.toString(value) \| tries it's best to convert the value to a string
 apoc.convert.toStringList(value) \| tries it's best to convert the value to a list of strings
 |label:function[]
 |label:apoc-core[]
+|xref::overview/apoc.convert/apoc.convert.fromYaml.adoc[apoc.convert.fromYaml icon:book[]]
+
+apoc.convert.fromYaml(value, $config) - Deserializes the YAML string to Neo4j value
+|label:function[]
+|label:apoc-full[]
 |===
 

docs/asciidoc/modules/ROOT/partials/generated-documentation/documentation.adoc

@@ -676,6 +676,13 @@ apoc.convert.toString(value) \| tries it's best to convert the value to a string
 apoc.convert.toStringList(value) \| tries it's best to convert the value to a list of strings
 |label:function[]
 |label:apoc-core[]
+
+|xref::overview/apoc.convert/apoc.convert.fromYaml.adoc[apoc.convert.fromYaml icon:book[]]
+
+apoc.convert.fromYaml(value, $config) - Deserializes the YAML string to Neo4j value
+|label:function[]
+|label:apoc-full[]
+
 |===
 
 == xref::overview/apoc.couchbase/index.adoc[]

docs/asciidoc/modules/ROOT/partials/generated-documentation/nav.adoc

@@ -129,6 +129,8 @@ This file is generated by DocsTest, so don't change it!
 *** xref::overview/apoc.convert/apoc.convert.toSortedJsonMap.adoc[]
 *** xref::overview/apoc.convert/apoc.convert.toString.adoc[]
 *** xref::overview/apoc.convert/apoc.convert.toStringList.adoc[]
+*** xref::overview/apoc.convert/apoc.convert.toYaml.adoc[]
+*** xref::overview/apoc.convert/apoc.convert.fromYaml.adoc[]
 ** xref::overview/apoc.couchbase/index.adoc[]
 *** xref::overview/apoc.couchbase/apoc.couchbase.append.adoc[]
 *** xref::overview/apoc.couchbase/apoc.couchbase.exists.adoc[]