From 09c45c794b00af432ed80f4abfbcb7fb7e0e8e84 Mon Sep 17 00:00:00 2001
From: Aaron Fiore <founder@evergreencrypto.co>
Date: Sat, 20 Jul 2024 16:44:12 -0700
Subject: [PATCH] root: macro: layout reorg, related refactor

---
 .../root/macro/{internal => common}/common.hh    |  6 +++---
 .../root/macro/{internal => common}/crypto.hh    |  6 +++---
 .../root/macro/{internal => common}/utility.hh   |  6 +++---
 container/src/root/macro/rootlogon.C             | 16 ++++++++--------
 container/src/root/macro/{ => test}/test.C       |  8 ++++----
 .../src/root/macro/{ => web/internal}/crypto.C   | 10 +++++-----
 .../src/root/macro/{ => web/internal}/meta.C     |  8 ++++----
 container/src/root/macro/{web.C => web/server.C} | 12 ++++++------
 8 files changed, 36 insertions(+), 36 deletions(-)
 rename container/src/root/macro/{internal => common}/common.hh (93%)
 rename container/src/root/macro/{internal => common}/crypto.hh (94%)
 rename container/src/root/macro/{internal => common}/utility.hh (93%)
 rename container/src/root/macro/{ => test}/test.C (95%)
 rename container/src/root/macro/{ => web/internal}/crypto.C (97%)
 rename container/src/root/macro/{ => web/internal}/meta.C (97%)
 rename container/src/root/macro/{web.C => web/server.C} (88%)

diff --git a/container/src/root/macro/internal/common.hh b/container/src/root/macro/common/common.hh
similarity index 93%
rename from container/src/root/macro/internal/common.hh
rename to container/src/root/macro/common/common.hh
index 4916b39..9bbcec4 100644
--- a/container/src/root/macro/internal/common.hh
+++ b/container/src/root/macro/common/common.hh
@@ -20,8 +20,8 @@
 //! \note File intended to be loaded into ROOT.cern framework / Cling interpreter
 //! \since docker-finance 1.0.0
 
-#ifndef CONTAINER_SRC_ROOT_MACRO_INTERNAL_COMMON_HH_
-#define CONTAINER_SRC_ROOT_MACRO_INTERNAL_COMMON_HH_
+#ifndef CONTAINER_SRC_ROOT_MACRO_COMMON_COMMON_HH_
+#define CONTAINER_SRC_ROOT_MACRO_COMMON_COMMON_HH_
 
 #include <initializer_list>
 #include <iostream>
@@ -85,6 +85,6 @@ class Command final
 }  // namespace macro
 }  // namespace docker_finance
 
-#endif  // CONTAINER_SRC_ROOT_MACRO_INTERNAL_COMMON_HH_
+#endif  // CONTAINER_SRC_ROOT_MACRO_COMMON_COMMON_HH_
 
 // # vim: sw=2 sts=2 si ai et
diff --git a/container/src/root/macro/internal/crypto.hh b/container/src/root/macro/common/crypto.hh
similarity index 94%
rename from container/src/root/macro/internal/crypto.hh
rename to container/src/root/macro/common/crypto.hh
index 5501bd2..a5dcd23 100644
--- a/container/src/root/macro/internal/crypto.hh
+++ b/container/src/root/macro/common/crypto.hh
@@ -20,8 +20,8 @@
 //! \note File intended to be loaded into ROOT.cern framework / Cling interpreter
 //! \since docker-finance 1.0.0
 
-#ifndef CONTAINER_SRC_ROOT_MACRO_INTERNAL_CRYPTO_HH_
-#define CONTAINER_SRC_ROOT_MACRO_INTERNAL_CRYPTO_HH_
+#ifndef CONTAINER_SRC_ROOT_MACRO_COMMON_CRYPTO_HH_
+#define CONTAINER_SRC_ROOT_MACRO_COMMON_CRYPTO_HH_
 
 #include <memory>
 
@@ -80,6 +80,6 @@ auto g_Random = std::make_unique<::docker_finance::crypto::libsodium::Random>();
 }  // namespace macro
 }  // namespace docker_finance
 
-#endif  // CONTAINER_SRC_ROOT_MACRO_INTERNAL_CRYPTO_HH_
+#endif  // CONTAINER_SRC_ROOT_MACRO_COMMON_CRYPTO_HH_
 
 // # vim: sw=2 sts=2 si ai et
diff --git a/container/src/root/macro/internal/utility.hh b/container/src/root/macro/common/utility.hh
similarity index 93%
rename from container/src/root/macro/internal/utility.hh
rename to container/src/root/macro/common/utility.hh
index fea058e..81c1363 100644
--- a/container/src/root/macro/internal/utility.hh
+++ b/container/src/root/macro/common/utility.hh
@@ -20,8 +20,8 @@
 //! \note File intended to be loaded into ROOT.cern framework / Cling interpreter
 //! \since docker-finance 1.0.0
 
-#ifndef CONTAINER_SRC_ROOT_MACRO_INTERNAL_UTILITY_HH_
-#define CONTAINER_SRC_ROOT_MACRO_INTERNAL_UTILITY_HH_
+#ifndef CONTAINER_SRC_ROOT_MACRO_COMMON_UTILITY_HH_
+#define CONTAINER_SRC_ROOT_MACRO_COMMON_UTILITY_HH_
 
 #include <ctime>
 #include <string>
@@ -74,6 +74,6 @@ std::string make_timestamp()
 }  // namespace macro
 }  // namespace docker_finance
 
-#endif  // CONTAINER_SRC_ROOT_MACRO_INTERNAL_UTILITY_HH_
+#endif  // CONTAINER_SRC_ROOT_MACRO_COMMON_UTILITY_HH_
 
 // # vim: sw=2 sts=2 si ai et
diff --git a/container/src/root/macro/rootlogon.C b/container/src/root/macro/rootlogon.C
index 2fd8158..99bd7dc 100644
--- a/container/src/root/macro/rootlogon.C
+++ b/container/src/root/macro/rootlogon.C
@@ -28,7 +28,7 @@
 #include <string>
 
 // NOTE: the one-and-only header at startup that's not manually loaded
-#include "./internal/common.hh"
+#include "./common/common.hh"
 
 //! \namespace docker_finance
 //! \since docker-finance 1.0.0
@@ -107,13 +107,13 @@ void help()
       << "  1. Use tab auto-complete to load docker-finance tests and run\n"
       << "     unit tests and benchmarks:\n"
       << "\n"
-      << "      root [0] docker_finance::macro::load(\"test.C\")\n"
+      << "      root [0] docker_finance::macro::load(\"test/test.C\")\n"
       << "      root [1] docker_finance::macro::Unit::run()\n"
       << "      root [2] docker_finance::macro::Benchmark::run()\n"
       << "\n"
       << "  2. Load webserver and run registered commands:\n"
       << "\n"
-      << "      root [0] docker_finance::macro::load(\"web.C\")\n"
+      << "      root [0] docker_finance::macro::load(\"web/server.C\")\n"
       << "      root [1] docker_finance::macro::Web::run()\n"
       << "\n"
       << "     Now, open your web browser to http://127.0.0.1:8080\n"
@@ -134,10 +134,10 @@ void help()
 //! \ingroup cpp_macro
 //! \details
 //!   Example:
-//!     <br>&emsp; root [0] docker_finance::macro::load("test.C")<br>
+//!     <br>&emsp; root [0] docker_finance::macro::load("test/test.C")<br>
 //!
 //!   Will load:
-//!     <br>&emsp; root/macro/test.C<br>
+//!     <br>&emsp; root/macro/test/test.C<br>
 //!
 //! \note  Parent directory is `root/macro`
 void load(const std::string& path)
@@ -149,10 +149,10 @@ void load(const std::string& path)
 //! \ingroup cpp_macro
 //! \details
 //!   Example:
-//!     <br>&emsp; root [0] docker_finance::macro::load({"test.C", "../src/hash.hh"})<br>
+//!     <br>&emsp; root [0] docker_finance::macro::load({"test/test.C", "../src/hash.hh"})<br>
 //!
 //!   Will load:
-//!     <br>&emsp; root/macro/test.C and root/src/hash.hh<br>
+//!     <br>&emsp; root/macro/test/test.C and root/src/hash.hh<br>
 //!
 //! \note  Parent directory is `root/macro`
 void load(const std::initializer_list<std::string>& paths)
@@ -185,7 +185,7 @@ void rootlogon()
   gSystem->AddLinkedLibs("-lcryptopp");  // Crypto++
   gSystem->AddLinkedLibs("-lsodium");  // libsodium
 
-  // Load docker-finance source
+  // Load docker-finance public API source
   gInterpreter->ProcessLine(".L ../src/hash.hh");
   gInterpreter->ProcessLine(".L ../src/random.hh");
   gInterpreter->ProcessLine(".L ../src/utility.hh");
diff --git a/container/src/root/macro/test.C b/container/src/root/macro/test/test.C
similarity index 95%
rename from container/src/root/macro/test.C
rename to container/src/root/macro/test/test.C
index 8a7f8d2..c1f8fa7 100644
--- a/container/src/root/macro/test.C
+++ b/container/src/root/macro/test/test.C
@@ -20,8 +20,8 @@
 //! \note File intended to be loaded into ROOT.cern framework / Cling interpreter
 //! \since docker-finance 1.0.0
 
-#ifndef CONTAINER_SRC_ROOT_MACRO_TEST_C_
-#define CONTAINER_SRC_ROOT_MACRO_TEST_C_
+#ifndef CONTAINER_SRC_ROOT_MACRO_TEST_TEST_C_
+#define CONTAINER_SRC_ROOT_MACRO_TEST_TEST_C_
 
 #include <benchmark/benchmark.h>
 #include <gtest/gtest.h>
@@ -30,7 +30,7 @@
 #include <iostream>
 #include <string>
 
-#include "./internal/common.hh"
+#include "../common/common.hh"
 
 //! \namespace docker_finance
 //! \since docker-finance 1.0.0
@@ -122,6 +122,6 @@ class Benchmark
 }  // namespace macro
 }  // namespace docker_finance
 
-#endif  // CONTAINER_SRC_ROOT_MACRO_TEST_C_
+#endif  // CONTAINER_SRC_ROOT_MACRO_TEST_TEST_C_
 
 // # vim: sw=2 sts=2 si ai et
diff --git a/container/src/root/macro/crypto.C b/container/src/root/macro/web/internal/crypto.C
similarity index 97%
rename from container/src/root/macro/crypto.C
rename to container/src/root/macro/web/internal/crypto.C
index 5643709..b8206c6 100644
--- a/container/src/root/macro/crypto.C
+++ b/container/src/root/macro/web/internal/crypto.C
@@ -20,8 +20,8 @@
 //! \note File intended to be loaded into ROOT.cern framework / Cling interpreter
 //! \since docker-finance 1.0.0
 
-#ifndef CONTAINER_SRC_ROOT_MACRO_CRYPTO_C_
-#define CONTAINER_SRC_ROOT_MACRO_CRYPTO_C_
+#ifndef CONTAINER_SRC_ROOT_MACRO_WEB_INTERNAL_CRYPTO_C_
+#define CONTAINER_SRC_ROOT_MACRO_WEB_INTERNAL_CRYPTO_C_
 
 #include <TCanvas.h>
 #include <TGraph.h>
@@ -33,8 +33,8 @@
 #include <utility>
 #include <vector>
 
-#include "./internal/crypto.hh"
-#include "./internal/utility.hh"
+#include "../../common/crypto.hh"
+#include "../../common/utility.hh"
 
 //! \namespace docker_finance
 //! \since docker-finance 1.0.0
@@ -361,6 +361,6 @@ class Crypto final
 }  // namespace macro
 }  // namespace docker_finance
 
-#endif  // CONTAINER_SRC_ROOT_MACRO_CRYPTO_C_
+#endif  // CONTAINER_SRC_ROOT_MACRO_WEB_INTERNAL_CRYPTO_C_
 
 // # vim: sw=2 sts=2 si ai et
diff --git a/container/src/root/macro/meta.C b/container/src/root/macro/web/internal/meta.C
similarity index 97%
rename from container/src/root/macro/meta.C
rename to container/src/root/macro/web/internal/meta.C
index 3a2f380..cc48e47 100644
--- a/container/src/root/macro/meta.C
+++ b/container/src/root/macro/web/internal/meta.C
@@ -20,8 +20,8 @@
 //! \note File intended to be loaded into ROOT.cern framework / Cling interpreter
 //! \since docker-finance 1.0.0
 
-#ifndef CONTAINER_SRC_ROOT_MACRO_META_C_
-#define CONTAINER_SRC_ROOT_MACRO_META_C_
+#ifndef CONTAINER_SRC_ROOT_MACRO_WEB_INTERNAL_META_C_
+#define CONTAINER_SRC_ROOT_MACRO_WEB_INTERNAL_META_C_
 
 #include <TCanvas.h>
 #include <TGraph.h>
@@ -32,7 +32,7 @@
 #include <utility>
 #include <vector>
 
-#include "./internal/utility.hh"
+#include "../../common/utility.hh"
 
 //! \namespace docker_finance
 //! \since docker-finance 1.0.0
@@ -225,6 +225,6 @@ class Meta final
 }  // namespace macro
 }  // namespace docker_finance
 
-#endif  // CONTAINER_SRC_ROOT_MACRO_META_C_
+#endif  // CONTAINER_SRC_ROOT_MACRO_WEB_INTERNAL_META_C_
 
 // # vim: sw=2 sts=2 si ai et
diff --git a/container/src/root/macro/web.C b/container/src/root/macro/web/server.C
similarity index 88%
rename from container/src/root/macro/web.C
rename to container/src/root/macro/web/server.C
index 573b8b8..f6bb4d8 100644
--- a/container/src/root/macro/web.C
+++ b/container/src/root/macro/web/server.C
@@ -20,14 +20,14 @@
 //! \note File intended to be loaded into ROOT.cern framework / Cling interpreter
 //! \since docker-finance 1.0.0
 
-#ifndef CONTAINER_SRC_ROOT_MACRO_WEB_C_
-#define CONTAINER_SRC_ROOT_MACRO_WEB_C_
+#ifndef CONTAINER_SRC_ROOT_MACRO_WEB_SERVER_C_
+#define CONTAINER_SRC_ROOT_MACRO_WEB_SERVER_C_
 
 #include <THttpServer.h>
 
 #include <memory>
 
-#include "./internal/common.hh"
+#include "../common/common.hh"
 
 //! \namespace docker_finance
 //! \since docker-finance 1.0.0
@@ -69,12 +69,12 @@ class Web final
   //! \details Registers internal macros
   static void register_commands()
   {
-    ::docker_finance::macro::internal::Command::load({"crypto.C"});
+    ::docker_finance::macro::internal::Command::load({"web/internal/crypto.C"});
     internal::g_HTTPServer->RegisterCommand(
         "/rng_sample",
         "::docker_finance::macro::internal::Crypto::rng_sample(\"%arg1%\")");
 
-    ::docker_finance::macro::internal::Command::load({"meta.C"});
+    ::docker_finance::macro::internal::Command::load({"web/internal/meta.C"});
     internal::g_HTTPServer->RegisterCommand(
         "/meta_sample",
         "::docker_finance::macro::internal::Meta::meta_sample(\"%arg1%\")");
@@ -87,6 +87,6 @@ class Web final
 }  // namespace macro
 }  // namespace docker_finance
 
-#endif  // CONTAINER_SRC_ROOT_MACRO_WEB_C_
+#endif  // CONTAINER_SRC_ROOT_MACRO_WEB_SERVER_C_
 
 // # vim: sw=2 sts=2 si ai et