Add jackson-dataformat-yaml and Initial checkin

qqq-backend-core/pom.xml

@@ -65,12 +65,17 @@
       <dependency>
          <groupId>com.fasterxml.jackson.core</groupId>
          <artifactId>jackson-databind</artifactId>
-         <version>2.14.0-rc1</version>
+         <version>2.14.0</version>
       </dependency>
       <dependency>
          <groupId>com.fasterxml.jackson.datatype</groupId>
          <artifactId>jackson-datatype-jsr310</artifactId>
-         <version>2.13.0</version>
+         <version>2.14.0</version>
+      </dependency>
+      <dependency>
+         <groupId>com.fasterxml.jackson.dataformat</groupId>
+         <artifactId>jackson-dataformat-yaml</artifactId>
+         <version>2.14.0</version>
       </dependency>
       <dependency>
          <groupId>org.json</groupId>

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/utils/YamlUtils.java

@@ -0,0 +1,81 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2023.  Kingsrook, LLC
+ * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
+ * contact@kingsrook.com
+ * https://github.com/Kingsrook/
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.utils;
+
+
+import java.util.Map;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
+import com.kingsrook.qqq.backend.core.logging.QLogger;
+
+
+/*******************************************************************************
+ **
+ *******************************************************************************/
+public class YamlUtils
+{
+   private static final QLogger LOG = QLogger.getLogger(YamlUtils.class);
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public static Map<String, Object> toMap(String yaml) throws JsonProcessingException
+   {
+      ObjectMapper objectMapper = new ObjectMapper(new YAMLFactory());
+      objectMapper.findAndRegisterModules();
+      return (objectMapper.readValue(yaml, Map.class));
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public static String toYaml(Object object)
+   {
+      try
+      {
+         YAMLFactory yamlFactory = new YAMLFactory()
+            .disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER);
+
+         ObjectMapper objectMapper = new ObjectMapper(yamlFactory);
+         objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+         objectMapper.setSerializationInclusion(JsonInclude.Include.NON_EMPTY);
+
+         // todo? objectMapper.setFilterProvider(new OmitDefaultValuesFilterProvider());
+
+         objectMapper.findAndRegisterModules();
+         return (objectMapper.writeValueAsString(object));
+      }
+      catch(Exception e)
+      {
+         LOG.error("Error serializing object of type [" + object.getClass().getSimpleName() + "] to yaml", e);
+         throw new IllegalArgumentException("Error in YAML Serialization", e);
+      }
+   }
+
+}

qqq-backend-core/src/test/java/com/kingsrook/qqq/backend/core/utils/YamlUtilsTest.java

@@ -0,0 +1,73 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2023.  Kingsrook, LLC
+ * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
+ * contact@kingsrook.com
+ * https://github.com/Kingsrook/
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.utils;
+
+
+import java.util.Map;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
+import org.junit.jupiter.api.Test;
+
+
+/*******************************************************************************
+ ** Unit test for YamlUtils
+ *******************************************************************************/
+class YamlUtilsTest
+{
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   @Test
+   void test() throws JsonProcessingException
+   {
+      String yaml = """
+         orderNo: "B-9910"
+         date: "2019-04-18"
+         customerName: "Customer, Jane"
+         orderLines:
+         - item: "Copper Wire (200ft)"
+           quantity: 1
+           unitPrice: 50.67
+         - item: "Washers (1/4\\")"
+           quantity: 24
+           unitPrice: 0.15
+         """;
+
+      Map<String, Object> map = YamlUtils.toMap(yaml);
+      System.out.println(map);
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   @Test
+   void testQInstanceToYaml()
+   {
+      QInstance qInstance = TestUtils.defineInstance();
+      String    yaml      = YamlUtils.toYaml(qInstance);
+      System.out.println(yaml);
+   }
+
+}