serial interface: respond with correctly formatted dummy data (#122)

dhebbeker · web-flow · commit 6e7cac5bb4cf · 2024-09-21T13:20:21.000+02:00
Resolves #61 - [x] dependency must be merged first: Task-Tracker-Systems/Protocol-Serial-Interface#1 - [x] describe suggested changes ### Summary Use a JSON library to serialize objects to JSON formatted strings. Send dummy data. - `lib/3rd_party_adapters/nlohmann/JsonGenerator.cpp`: Add adapter for using a library which parses to/from JSON format. Although the operations currently used by the adapter are rather simple (to JSON) - one could argue that the use of the library is excessive. The library is used in anticipation that JSON strings will be parsed (from JSON). The `to_json()` definitions allows to use the library to parse arrays of the specific object. - `lib/application_business_rules/serial_interface/JsonGenerator.hpp` is a generic interface to the adapter above. - `lib/application_business_rules/serial_interface/Protocol.cpp`: - add command for "info" query - add dummy objects to be sent - `lib/enterprise_business_rules/serial_protocol/DeletedTaskObject.hpp`: defines structure for [deleted task JSON object](https://github.com/Task-Tracker-Systems/Protocol-Serial-Interface/blob/9315fd14875894c13f2616d422e197d37d798233/deleted-task-object.schema.json) - `lib/enterprise_business_rules/serial_protocol/ProtocolVersionObject.hpp`: Defines structure for [protocol version JSON object](https://github.com/Task-Tracker-Systems/Protocol-Serial-Interface/blob/9315fd14875894c13f2616d422e197d37d798233/protocol-version-object.schema.json) - `lib/enterprise_business_rules/serial_protocol/TaskObject.hpp`: Defines structure for [task JSON object](https://github.com/Task-Tracker-Systems/Protocol-Serial-Interface/blob/9315fd14875894c13f2616d422e197d37d798233/task-object.schema.json) - `lib/enterprise_business_rules/serial_protocol/TaskList.hpp`: Defines a container for [an array of JSON task objects](https://github.com/Task-Tracker-Systems/Protocol-Serial-Interface/blob/9315fd14875894c13f2616d422e197d37d798233/task-object.schema.json)
diff --git a/lib/3rd_party_adapters/nlohmann/JsonGenerator.cpp b/lib/3rd_party_adapters/nlohmann/JsonGenerator.cpp
@@ -0,0 +1,54 @@
+#include <nlohmann/json.hpp>
+#include <serial_interface/JsonGenerator.hpp>
+#include <serial_protocol/DeletedTaskObject.hpp>
+#include <serial_protocol/ProtocolVersionObject.hpp>
+#include <serial_protocol/TaskList.hpp>
+#include <serial_protocol/TaskObject.hpp>
+
+/**
+ * Indentation used by default for formating JSON.
+ */
+static constexpr int defaultJsonIndent = 4;
+
+template <>
+std::string toJsonString<task_tracker_systems::ProtocolVersionObject>(const task_tracker_systems::ProtocolVersionObject &object)
+{
+    auto jsonObject = nlohmann::json::object();
+    jsonObject["major"] = object.major;
+    jsonObject["minor"] = object.minor;
+    jsonObject["patch"] = object.patch;
+    return jsonObject.dump(defaultJsonIndent);
+}
+
+namespace task_tracker_systems
+{
+static void to_json(nlohmann::json &jsonObject, const task_tracker_systems::TaskObject &object)
+{
+    jsonObject["id"] = object.id;
+    jsonObject["label"] = object.label;
+    jsonObject["duration"] = object.duration;
+}
+} // namespace task_tracker_systems
+
+template <>
+std::string toJsonString<task_tracker_systems::TaskObject>(const task_tracker_systems::TaskObject &object)
+{
+    auto jsonObject = nlohmann::json::object();
+    to_json(jsonObject, object);
+    return jsonObject.dump(defaultJsonIndent);
+}
+
+template <>
+std::string toJsonString<task_tracker_systems::TaskList>(const task_tracker_systems::TaskList &object)
+{
+    nlohmann::json jsonObject(object);
+    return jsonObject.dump(defaultJsonIndent);
+}
+
+template <>
+std::string toJsonString<task_tracker_systems::DeletedTaskObject>(const task_tracker_systems::DeletedTaskObject &object)
+{
+    auto jsonObject = nlohmann::json::object();
+    jsonObject["id"] = object.id;
+    return jsonObject.dump(defaultJsonIndent);
+}
diff --git a/lib/application_business_rules/serial_interface/JsonGenerator.hpp b/lib/application_business_rules/serial_interface/JsonGenerator.hpp
@@ -0,0 +1,16 @@
+/**
+ * \file .
+ * \brief Interface to JSON serializer.
+ */
+#pragma once
+#include <string>
+
+/**
+ * Serializes an object to a JSON formatted string.
+ *
+ * @tparam T a serializable structure or container
+ * @param object data to be serialized
+ * @returns string JSON formatted
+ */
+template <class T>
+std::string toJsonString(const T &object);
diff --git a/lib/application_business_rules/serial_interface/Protocol.cpp b/lib/application_business_rules/serial_interface/Protocol.cpp
@@ -8,22 +8,41 @@ namespace cli = command_line_interpreter;
 // --------------------------
 // --- define commands ------
 // --------------------------
+#include "JsonGenerator.hpp"
+#include <serial_protocol/ProtocolVersionObject.hpp>
+#include <serial_protocol/TaskList.hpp>
+#include <serial_protocol/TaskObject.hpp>
 #include <string>
 
+using namespace task_tracker_systems;
+
+// command for info
+static const auto info = []() {
+    constexpr ProtocolVersionObject version = {.major = 0, .minor = 1, .patch = 0};
+    serial_port::cout << toJsonString(version) << std::endl;
+};
+static const auto infoCmd = cli::makeCommand("info", std::function(info));
+
 // command for list
-static const auto list = []() { serial_port::cout << "this is a list: a, b, c, ..." << std::endl; };
+static const auto list = []() { 
+    const TaskList dummyList = {
+        {.id = 1, .label = "first", .duration = 100U}, 
+        {.id = 2, .label =  "second", .duration = 200U},
+        };
+    serial_port::cout << toJsonString(dummyList) << std::endl; };
 static const auto listCmd = cli::makeCommand("list", std::function(list));
 
 // command for edit
-static const auto edit = [](const int id, const std::basic_string<ProtocolHandler::CharType> label, const int duration) {
-    serial_port::cout << "Edit id(" << id << ") label('" << label << "') duration(" << duration << ")" << std::endl;
+static const auto edit = [](const unsigned int id, const std::basic_string<ProtocolHandler::CharType> label, const std::chrono::seconds::rep duration) {
+    const TaskObject task = {.id = id, .label = label, .duration = duration};
+    serial_port::cout << toJsonString(task) << std::endl;
 };
-static const cli::Option<int> id = {.labels = {"--id"}, .defaultValue = 0};
+static const cli::Option<unsigned int> id = {.labels = {"--id"}, .defaultValue = 0};
 static const cli::Option<std::basic_string<ProtocolHandler::CharType>> label = {.labels = {"--name"}, .defaultValue = "foo"};
-static const cli::Option<int> duration = {.labels = {"--duration"}, .defaultValue = 0};
+static const cli::Option<std::chrono::seconds::rep> duration = {.labels = {"--duration"}, .defaultValue = 0};
 static const auto editCmd = cli::makeCommand("edit", std::function(edit), std::make_tuple(&id, &label, &duration));
 
-static const std::array<const cli::BaseCommand<char> *, 2> commands = {&listCmd, &editCmd};
+static const std::array<const cli::BaseCommand<char> *, 3> commands = {&listCmd, &editCmd, &infoCmd};
 
 bool ProtocolHandler::execute(const CharType *const commandLine)
 {
diff --git a/lib/enterprise_business_rules/serial_protocol/DeletedTaskObject.hpp b/lib/enterprise_business_rules/serial_protocol/DeletedTaskObject.hpp
@@ -0,0 +1,16 @@
+#pragma once
+
+namespace task_tracker_systems
+{
+
+/**
+ * deleted task object
+ */
+struct DeletedTaskObject
+{
+    /**
+     * unique identifier
+     */
+    unsigned int id;
+};
+} // namespace task_tracker_systems
diff --git a/lib/enterprise_business_rules/serial_protocol/ProtocolVersionObject.hpp b/lib/enterprise_business_rules/serial_protocol/ProtocolVersionObject.hpp
@@ -0,0 +1,15 @@
+#pragma once
+#include <cstdint>
+
+namespace task_tracker_systems
+{
+/**
+ * Protocol Version Object
+ */
+struct ProtocolVersionObject
+{
+    std::uint8_t major;
+    std::uint8_t minor;
+    std::uint16_t patch;
+};
+} // namespace task_tracker_systems
diff --git a/lib/enterprise_business_rules/serial_protocol/TaskList.hpp b/lib/enterprise_business_rules/serial_protocol/TaskList.hpp
@@ -0,0 +1,12 @@
+#pragma once
+#include "TaskObject.hpp"
+#include <vector>
+
+namespace task_tracker_systems
+{
+
+/**
+ * list of tasks
+ */
+typedef std::vector<TaskObject> TaskList;
+} // namespace task_tracker_systems
diff --git a/lib/enterprise_business_rules/serial_protocol/TaskObject.hpp b/lib/enterprise_business_rules/serial_protocol/TaskObject.hpp
@@ -0,0 +1,26 @@
+#pragma once
+#include <chrono>
+#include <string>
+
+namespace task_tracker_systems
+{
+
+/**
+ * task object
+ */
+struct TaskObject
+{
+    /**
+     * unique identifier
+     */
+    unsigned int id;
+    /**
+     * name or summary; ASCII only, no line breaks
+     */
+    std::string label;
+    /**
+     * duration in seconds
+     */
+    std::chrono::seconds::rep duration;
+};
+} // namespace task_tracker_systems
diff --git a/platformio.ini b/platformio.ini
@@ -31,6 +31,7 @@ build_src_filter = +<*> -<.git/> -<.svn/>
 lib_deps = 
 	adafruit/Adafruit SSD1306@~2.5.3
 	lvgl@^8.3
+	johboh/nlohmann-json@^3.11.3
     ; adding local library as dependency is necessary as it does not have any include files. This is because nothing should depend from this layer.
 	3rd_party_adapters          ; this is necessary as no source code dependency shall exist to that packet
 lib_ldf_mode = deep             ; to automatically detect nested dependencies (for external libraries)
@@ -50,6 +51,7 @@ platform = native
 lib_deps =
 	unity
 	ArduinoFake
+	enterprise_business_rules
 lib_ldf_mode = chain ; automatically detect dependencies but to not recurse into other components
 build_flags =
 	-Wno-deprecated ; Workaround for https://github.com/FabioBatSilva/ArduinoFake/pull/41#issuecomment-1440550553
