Updated README and added yaml parser simple map

Author: sea5kg

README.md

@@ -3,3 +3,59 @@
 [![Build Status](https://api.travis-ci.com/wsjcpp/wsjcpp-yaml.svg?branch=master)](https://api.travis-ci.com/wsjcpp/wsjcpp-yaml) [![Github Stars](https://img.shields.io/github/stars/wsjcpp/wsjcpp-yaml.svg?label=github%20%E2%98%85)](https://github.com/wsjcpp/wsjcpp-yaml/stargazers) [![Github Stars](https://img.shields.io/github/contributors/wsjcpp/wsjcpp-yaml.svg)](https://github.com/wsjcpp/wsjcpp-yaml/) [![Github Forks](https://img.shields.io/github/forks/wsjcpp/wsjcpp-yaml.svg?label=github%20forks)](https://github.com/wsjcpp/wsjcpp-yaml/network/members)
 
 C++ Write/Reader yaml files
+
+
+## Integrate to your c++ project
+
+include files:
+
+- src/wsjcpp_yaml.cpp
+- src/wsjcpp_yaml.h
+- src.wsjcpp/wsjcpp-logger/fallen.h
+- src.wsjcpp/wsjcpp-logger/fallen.cpp
+
+In you main file configure logger:
+
+```cpp
+
+#include <string.h>
+#include <iostream>
+#include "wsjcpp_yaml.h"
+#include "fallen.h"
+
+
+
+int main(int argc, char* argv[]) {
+    std::string TAG = "MAIN";
+    std::string appLogPath = ".logs";
+    Log::setLogDirectory(appLogPath);
+    if (!Fallen::dirExists(appLogPath)) {
+        Fallen::makeDir(appLogPath);
+    }
+    Log::info(TAG, "Hello!");
+
+    // now you can use WSJCppYAML
+    WSJCppYAML yaml;
+    if (yaml.loadFromString(
+        "# yaml content\n"
+        "yaml: nice format\n"
+        "some-map: value1\n"
+        "some-map2: value2\n"
+        "some-array:\n"
+        "  - test1 \n"
+        "  - test2 \n"
+    )) {
+        Log::throw_err(TAG, "Error parsing");
+        return -1;
+    }
+
+    std::cout << "yaml is " << yaml.getRoot()->getElement("yaml")->getValue() << std::endl;
+    std::cout << "some-map is " << yaml.getRoot()->getElement("some-map")->getValue() << std::endl;
+    std::cout << "some-map2 is " << yaml.getRoot()->getElement("some-map2")->getValue() << std::endl;
+    std::cout << "some-array has " << std::to_string(yaml.getRoot()->getElement("some-array")->getLength()) << std::endl;
+    std::cout << "some-array element 1 is " << yaml.getRoot()->getElement("some-array")->->getElement(0)->getValue() << std::endl;
+    std::cout << "some-array element 2 is " << yaml.getRoot()->getElement("some-array")->->getElement(1)->getValue() << std::endl;
+    return 0;
+}
+
+```

src/wsjcpp_yaml.cpp

@@ -240,10 +240,15 @@ std::string WSJCppYAMLItem::toString() {
     if (this->isValue()) {
         sRet = m_sValue;
         if (m_sComment.length() > 0) {
-            sRet += " #" + m_sComment;    
+            if (sRet.length() > 0) {
+                sRet += " ";
+            }
+            sRet += "#" + m_sComment;
         }
     } else if (this->isEmpty()) {
-        sRet = "#" + m_sComment;
+        if (m_sComment.length() > 0) {
+            sRet += "#" + m_sComment;
+        }
     } else if (this->isArray()) {
         sRet += "\n";
         for (int i = 0; i < m_vObjects.size(); i++) {
@@ -511,7 +516,7 @@ bool WSJCppYAML::loadFromString(std::string &sBuffer) {
 
 // ---------------------------------------------------------------------
 
-bool WSJCppYAML::saveToString(std::string &sBuffer) {
+bool WSJCppYAML::saveToString(std::string &sBuffer) { // TODO move to fallen
     sBuffer = m_pRoot->toString();
     return true;
 }
@@ -553,7 +558,7 @@ bool WSJCppYAML::parse(const std::string &sBuffer) {
 
     for (int nLine = 0; nLine < vLines.size(); nLine++) {
         st.sLine = vLines[nLine];
-        Log::info(TAG, "Line(" + std::to_string(nLine) + ") '" + st.sLine + "'");
+        // Log::info(TAG, "Line(" + std::to_string(nLine) + ") '" + st.sLine + "'");
         st.nLine = nLine;
         st.line = WSJCppYAMLParsebleLine(nLine);
         st.line.parseLine(st.sLine);

unit-tests/CMakeLists.txt

@@ -29,8 +29,11 @@ list (APPEND WSJCPP_SOURCES "./src/unit_tests.h")
 list (APPEND WSJCPP_SOURCES "./src/unit_tests.cpp")
 list (APPEND WSJCPP_SOURCES "./src/unit_test_line_parser.h")
 list (APPEND WSJCPP_SOURCES "./src/unit_test_line_parser.cpp")
-list (APPEND WSJCPP_SOURCES "./src/unit_test_yaml_parser.h")
-list (APPEND WSJCPP_SOURCES "./src/unit_test_yaml_parser.cpp")
+list (APPEND WSJCPP_SOURCES "./src/unit_test_yaml_parser_simple_map.h")
+list (APPEND WSJCPP_SOURCES "./src/unit_test_yaml_parser_simple_map.cpp")
+# list (APPEND WSJCPP_SOURCES "./src/unit_test_yaml_parser.h")
+# list (APPEND WSJCPP_SOURCES "./src/unit_test_yaml_parser.cpp")
+
 list (APPEND WSJCPP_SOURCES "./src/main.cpp")
 
 include_directories(${WSJCPP_INCLUDE_DIRS})

unit-tests/src/unit_test_yaml_parser_simple_map.cpp

@@ -0,0 +1,51 @@
+#include "unit_test_yaml_parser_simple_map.h"
+#include <vector>
+#include <iostream>
+#include <fallen.h>
+#include <wsjcpp_yaml.h>
+
+REGISTRY_UNIT_TEST(UnitTestYamlParserSimpleMap)
+
+UnitTestYamlParserSimpleMap::UnitTestYamlParserSimpleMap()
+    : UnitTestBase("UnitTestYamlParserSimpleMap") {
+    //
+}
+
+// ---------------------------------------------------------------------
+
+void UnitTestYamlParserSimpleMap::init() {
+    // nothing
+}
+
+// ---------------------------------------------------------------------
+
+bool UnitTestYamlParserSimpleMap::run() {
+
+    std::string g_sTestYaml = 
+        "# Some comment 1\n"
+        "param1: value1\n"
+        "param2: value2 # some comment 2\n"
+        "\n" // empty line
+    ;
+
+    bool bTestSuccess = true;
+    
+    WSJCppYAML yaml;
+    if (yaml.loadFromString(g_sTestYaml)) {
+        Log::throw_err(TAG, "Error parsing");
+        return -1;
+    }
+    
+    WSJCppYAMLItem *pItem = nullptr;
+    compareS(bTestSuccess, "param1", yaml.getRoot()->getElement("param1")->getValue(), "value1");
+    compareS(bTestSuccess, "param2", yaml.getRoot()->getElement("param2")->getValue(), "value2");
+
+    std::string sSaved = "";
+    if (yaml.saveToString(sSaved)) {
+        compareS(bTestSuccess, "yaml_save", sSaved, g_sTestYaml);
+    } else {
+        Log::err(TAG, "Could not save to string");
+        bTestSuccess = false;
+    }
+    return bTestSuccess;
+}

unit-tests/src/unit_test_yaml_parser_simple_map.h

@@ -0,0 +1,13 @@
+#ifndef UNIT_TEST_YAML_PARSER_SIMPLE_MAP_H
+#define UNIT_TEST_YAML_PARSER_SIMPLE_MAP_H
+
+#include <unit_tests.h>
+
+class UnitTestYamlParserSimpleMap : public UnitTestBase {
+    public:
+        UnitTestYamlParserSimpleMap();
+        virtual void init();
+        virtual bool run();
+};
+
+#endif // UNIT_TEST_YAML_PARSER_SIMPLE_MAP_H