Add some tests for TextFlow::Column

tests/CMakeLists.txt

@@ -87,6 +87,7 @@ set(TEST_SOURCES
         ${SELF_TEST_DIR}/IntrospectiveTests/RandomNumberGeneration.tests.cpp
         ${SELF_TEST_DIR}/IntrospectiveTests/Reporters.tests.cpp
         ${SELF_TEST_DIR}/IntrospectiveTests/Tag.tests.cpp
+        ${SELF_TEST_DIR}/IntrospectiveTests/TextFlow.tests.cpp
         ${SELF_TEST_DIR}/IntrospectiveTests/Sharding.tests.cpp
         ${SELF_TEST_DIR}/IntrospectiveTests/String.tests.cpp
         ${SELF_TEST_DIR}/IntrospectiveTests/StringManip.tests.cpp

tests/SelfTest/IntrospectiveTests/TextFlow.tests.cpp

@@ -0,0 +1,200 @@
+
+//              Copyright Catch2 Authors
+// Distributed under the Boost Software License, Version 1.0.
+//   (See accompanying file LICENSE_1_0.txt or copy at
+//        https://www.boost.org/LICENSE_1_0.txt)
+
+// SPDX-License-Identifier: BSL-1.0
+
+#include <catch2/catch_test_macros.hpp>
+#include <catch2/internal/catch_textflow.hpp>
+
+#include <sstream>
+
+using Catch::TextFlow::Column;
+
+namespace {
+    static std::string as_written(Column const& c) {
+        std::stringstream sstr;
+        sstr << c;
+        return sstr.str();
+    }
+}
+
+TEST_CASE( "TextFlow::Column one simple line",
+           "[TextFlow][column][approvals]" ) {
+    Column col( "simple short line" );
+
+    REQUIRE(as_written(col) == "simple short line");
+}
+
+TEST_CASE( "TextFlow::Column respects already present newlines",
+           "[TextFlow][column][approvals]" ) {
+    Column col( "abc\ndef" );
+    REQUIRE( as_written( col ) == "abc\ndef" );
+}
+
+TEST_CASE( "TextFlow::Column respects width setting",
+           "[TextFlow][column][approvals]" ) {
+    Column col( "The quick brown fox jumped over the lazy dog" );
+
+    SECTION( "width=20" ) {
+        col.width( 20 );
+        REQUIRE( as_written( col ) == "The quick brown fox\n"
+                                      "jumped over the lazy\n"
+                                      "dog" );
+    }
+    SECTION("width=10") {
+        col.width( 10 );
+        REQUIRE( as_written( col ) == "The quick\n"
+                                      "brown fox\n"
+                                      "jumped\n"
+                                      "over the\n"
+                                      "lazy dog" );
+    }
+    SECTION("width=5") {
+        // This is so small some words will have to be split with hyphen
+        col.width(5);
+        REQUIRE( as_written( col ) == "The\n"
+                                      "quick\n"
+                                      "brown\n"
+                                      "fox\n"
+                                      "jump-\n"
+                                      "ed\n"
+                                      "over\n"
+                                      "the\n"
+                                      "lazy\n"
+                                      "dog" );
+    }
+}
+
+TEST_CASE( "TextFlow::Column respects indentation setting",
+           "[TextFlow][column][approvals]" ) {
+    Column col( "First line\nSecond line\nThird line" );
+
+    SECTION("Default: no indentation at all") {
+        REQUIRE(as_written(col) == "First line\nSecond line\nThird line");
+    }
+    SECTION("Indentation on first line only") {
+        col.initialIndent(3);
+        REQUIRE(as_written(col) == "   First line\nSecond line\nThird line");
+    }
+    SECTION("Indentation on all lines") {
+        col.indent(3);
+        REQUIRE(as_written(col) == "   First line\n   Second line\n   Third line");
+    }
+    SECTION("Indentation on later lines only") {
+        col.indent(5).initialIndent(0);
+        REQUIRE(as_written(col) == "First line\n     Second line\n     Third line");
+    }
+    SECTION("Different indentation on first and later lines") {
+        col.initialIndent(1).indent(2);
+        REQUIRE(as_written(col) == " First line\n  Second line\n  Third line");
+    }
+}
+
+TEST_CASE("TextFlow::Column indentation respects whitespace", "[TextFlow][column][approvals]") {
+    Column col(" text with whitespace\n after newlines");
+
+    SECTION("No extra indentation") {
+        col.initialIndent(0).indent(0);
+        REQUIRE(as_written(col) == " text with whitespace\n after newlines");
+    }
+    SECTION("Different indentation on first and later lines") {
+        col.initialIndent(1).indent(2);
+        REQUIRE(as_written(col) == "  text with whitespace\n   after newlines");
+    }
+}
+
+TEST_CASE( "TextFlow::Column linebreaking prefers boundary characters",
+           "[TextFlow][column][approvals]" ) {
+    SECTION("parentheses") {
+        Column col("(Hello)aaa(World)");
+        SECTION("width=20") {
+            col.width(20);
+            REQUIRE(as_written(col) == "(Hello)aaa(World)");
+        }
+        SECTION("width=15") {
+            col.width(15);
+            REQUIRE(as_written(col) == "(Hello)aaa\n(World)");
+        }
+        SECTION("width=8") {
+            col.width(8);
+            REQUIRE(as_written(col) == "(Hello)\naaa\n(World)");
+        }
+    }
+    SECTION("commas") {
+        Column col("Hello, world");
+        col.width(8);
+
+        REQUIRE(as_written(col) == "Hello,\nworld");
+    }
+}
+
+
+TEST_CASE( "TextFlow::Column respects indentation for empty lines",
+           "[TextFlow][column][approvals][!shouldfail]" ) {
+    // This is currently bugged and does not do what it should
+    Column col("\n\nthird line");
+    col.indent(2);
+
+    //auto b = col.begin();
+    //auto e = col.end();
+
+    //auto b1 = *b;
+    //++b;
+    //auto b2 = *b;
+    //++b;
+    //auto b3 = *b;
+    //++b;
+
+    //REQUIRE(b == e);
+
+    std::string written = as_written(col);
+
+    REQUIRE(as_written(col) == "  \n  \n  third line");
+}
+
+TEST_CASE( "TextFlow::Column leading/trailing whitespace",
+           "[TextFlow][column][approvals]" ) {
+    SECTION("Trailing whitespace") {
+        Column col("some trailing whitespace: \t");
+        REQUIRE(as_written(col) == "some trailing whitespace: \t");
+    }
+    SECTION("Some leading whitespace") {
+        Column col("\t \t whitespace wooo");
+        REQUIRE(as_written(col) == "\t \t whitespace wooo");
+    }
+    SECTION("both") {
+        Column col(" abc ");
+        REQUIRE(as_written(col) == " abc ");
+    }
+    SECTION("whitespace only") {
+        Column col("\t \t");
+        REQUIRE(as_written(col) == "\t \t");
+    }
+}
+
+TEST_CASE( "TextFlow::Column can handle empty string",
+           "[TextFlow][column][approvals]" ) {
+    Column col("");
+    REQUIRE(as_written(col) == "");
+}
+
+TEST_CASE( "#1400 - TextFlow::Column wrapping would sometimes duplicate words",
+           "[TextFlow][column][regression][approvals]" ) {
+    const auto long_string = std::string(
+        "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque nisl \n"
+        "massa, luctus ut ligula vitae, suscipit tempus velit. Vivamus sodales, quam in \n"
+        "convallis posuere, libero nisi ultricies orci, nec lobortis.\n");
+
+    auto col = Column(long_string)
+        .width(79)
+        .indent(2);
+
+    REQUIRE(as_written(col) ==
+            "  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque nisl \n"
+            "  massa, luctus ut ligula vitae, suscipit tempus velit. Vivamus sodales, quam\n"
+            "  in \n"
+            "  convallis posuere, libero nisi ultricies orci, nec lobortis.");
+}