Improvements to format.cpp.

- `format` now checks for invalid values of index.
- Added tests for `format`.

Author: ZCG-coder

CMakeLists.txt

@@ -105,7 +105,7 @@ SET(COMPONENTS
 # NEW_COMPONENT: PATCH Do NOT remove the previous comment.
 
 SET(TARGETS ${COMPONENTS} util)
-SET(TEST_TARGETS_TEMP util fraction number factors ${COMPONENTS})
+SET(TEST_TARGETS_TEMP util fraction number factors format ${COMPONENTS})
 
 FOREACH(TEST_TARGET IN LISTS TEST_TARGETS_TEMP)
     SET(TARGET_NAME "test")

include/output.hpp

@@ -130,7 +130,7 @@ namespace steppable::output
               const std::basic_string<T>& msg,
               const std::vector<std::string>& args = {})
     {
-        std::cout << colors::brightGreen << formats::bold << LARGE_DOT << name << " INFO: " << reset
+        std::cout << colors::brightGreen << formats::bold << LARGE_DOT << name << " - INFO: " << reset
                   << colors::brightGreen;
         std::cout << format::format(msg, args) << reset << '\n';
     }

src/format.cpp

@@ -22,6 +22,7 @@
 
 #include "format.hpp"
 
+#include <algorithm>
 #include <stdexcept>
 #include <string>
 #include <vector>
@@ -41,28 +42,36 @@ namespace steppable::__internals::format
         std::string result = format;
         std::string index;
         bool inBrackets = false;
-        for (char i : format)
+        for (size_t idx = 0; idx < format.size(); idx++)
         {
+            char i = format.at(idx);
             switch (i)
             {
             // Start replacing!
             case '{':
             {
                 inBrackets = true;
-                index = i;
+                index.erase(index.begin(), index.end());
                 break;
             }
 
             // End replacing
             case '}':
             {
                 inBrackets = false;
-                size_t argIndex = std::stoull(index.substr(1));
+                // SIZE_MAX is 20 digits long, so we can safely assume that the index must not be longer than 20
+                // characters.
+                if (index.length() > 20 or index.length() < 1)
+                    throw std::length_error("Argument index too long or too short.");
+                if (not std::ranges::all_of(index, [](const char& c) { return std::isdigit(c); }))
+                    throw std::invalid_argument("Argument index must be a number.");
+
+                size_t argIndex = std::stoull(index);
                 if (argIndex >= args.size())
                     throw std::out_of_range("Argument index out of range.");
 
                 // +1 for the closing bracket
-                result.replace(result.find(index), index.size() + 1, args.at(argIndex));
+                result.replace(result.find("{" + index), index.size() + 2, args.at(argIndex));
                 break;
             }
 

tests/testFormat.cpp

@@ -0,0 +1,55 @@
+/**************************************************************************************************
+ * Copyright (c) 2023-2024 NWSOFT                                                                 *
+ *                                                                                                *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy                   *
+ * of this software and associated documentation files (the "Software"), to deal                  *
+ * in the Software without restriction, including without limitation the rights                   *
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell                      *
+ * copies of the Software, and to permit persons to whom the Software is                          *
+ * furnished to do so, subject to the following conditions:                                       *
+ *                                                                                                *
+ * The above copyright notice and this permission notice shall be included in all                 *
+ * copies or substantial portions of the Software.                                                *
+ *                                                                                                *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR                     *
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,                       *
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE                    *
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER                         *
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,                  *
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE                  *
+ * SOFTWARE.                                                                                      *
+ **************************************************************************************************/
+
+#include "colors.hpp"
+#include "factors.hpp"
+#include "output.hpp"
+#include "testing.hpp"
+#include "util.hpp"
+
+#include <iomanip>
+#include <iostream>
+#include <string>
+
+using namespace steppable::__internals;
+
+TEST_START()
+SECTION(Test format)
+const std::string& formatOrig = "Hello, {0}!";
+const std::string& arg = "world";
+const std::string& expected = "Hello, world!";
+
+const std::string& result = format::format(formatOrig, { arg });
+_.assertIsEqual(result, expected);
+SECTION_END()
+
+SECTION(Test format with multiple values)
+const std::string& formatOrig = "{0}, {1}!";
+const std::string& arg1 = "Hello";
+const std::string& arg2 = "world";
+const std::string& expected = "Hello, world!";
+
+const std::string& result = format::format(formatOrig, { arg1, arg2 });
+_.assertIsEqual(result, expected);
+SECTION_END()
+
+TEST_END()