Refactored class diagram generator to use identifiers for types

This commit is contained in:
Bartek Kryza
2021-03-07 23:04:43 +01:00
parent 77f24b5360
commit e07392dae6
14 changed files with 252 additions and 115 deletions

View File

@@ -40,21 +40,22 @@ TEST_CASE("Test t00002", "[unit-test]")
REQUIRE(model.name == "t00002_class");
auto puml = generate_class_puml(diagram, model);
AliasMatcher _A(puml);
REQUIRE_THAT(puml, StartsWith("@startuml"));
REQUIRE_THAT(puml, EndsWith("@enduml\n"));
REQUIRE_THAT(puml, IsAbstractClass("A"));
REQUIRE_THAT(puml, IsClass("B"));
REQUIRE_THAT(puml, IsClass("C"));
REQUIRE_THAT(puml, IsClass("D"));
REQUIRE_THAT(puml, IsBaseClass("A", "B"));
REQUIRE_THAT(puml, IsBaseClass("A", "C"));
REQUIRE_THAT(puml, IsBaseClass("B", "D"));
REQUIRE_THAT(puml, IsBaseClass("C", "D"));
REQUIRE_THAT(puml, IsAbstractClass(_A("A")));
REQUIRE_THAT(puml, IsClass(_A("B")));
REQUIRE_THAT(puml, IsClass(_A("C")));
REQUIRE_THAT(puml, IsClass(_A("D")));
REQUIRE_THAT(puml, IsBaseClass(_A("A"), _A("B")));
REQUIRE_THAT(puml, IsBaseClass(_A("A"), _A("C")));
REQUIRE_THAT(puml, IsBaseClass(_A("B"), _A("D")));
REQUIRE_THAT(puml, IsBaseClass(_A("C"), _A("D")));
REQUIRE_THAT(puml, IsMethod(Abstract(Public("foo_a"))));
REQUIRE_THAT(puml, IsMethod(Abstract(Public("foo_c"))));
REQUIRE_THAT(puml, IsAssociation("D", "A", "as"));
REQUIRE_THAT(puml, IsAssociation(_A("D"), _A("A"), "as"));
save_puml(
"./" + config.output_directory + "/" + diagram->name + ".puml", puml);

View File

@@ -39,10 +39,11 @@ TEST_CASE("Test t00003", "[unit-test]")
REQUIRE(model.name == "t00003_class");
auto puml = generate_class_puml(diagram, model);
AliasMatcher _A(puml);
REQUIRE_THAT(puml, StartsWith("@startuml"));
REQUIRE_THAT(puml, EndsWith("@enduml\n"));
REQUIRE_THAT(puml, Contains("class A"));
REQUIRE_THAT(puml, IsClass(_A("A")));
REQUIRE_THAT(puml, IsMethod(Default(Public("A"))));
REQUIRE_THAT(puml, IsMethod(Default(Public("~A"))));

View File

@@ -41,16 +41,17 @@ TEST_CASE("Test t00004", "[unit-test]")
REQUIRE(model.name == "t00004_class");
auto puml = generate_class_puml(diagram, model);
AliasMatcher _A(puml);
REQUIRE_THAT(puml, StartsWith("@startuml"));
REQUIRE_THAT(puml, EndsWith("@enduml\n"));
REQUIRE_THAT(puml, IsClass("A"));
REQUIRE_THAT(puml, IsClass("AA"));
REQUIRE_THAT(puml, IsClass("AAA"));
REQUIRE_THAT(puml, IsClass(_A("A")));
REQUIRE_THAT(puml, IsClass(_A("AA")));
REQUIRE_THAT(puml, IsClass(_A("AAA")));
REQUIRE_THAT(puml, IsEnum("Lights"));
REQUIRE_THAT(puml, IsInnerClass("A", "AA"));
REQUIRE_THAT(puml, IsInnerClass("AA", "AAA"));
REQUIRE_THAT(puml, IsInnerClass("AA", "Lights"));
REQUIRE_THAT(puml, IsInnerClass(_A("A"), _A("AA")));
REQUIRE_THAT(puml, IsInnerClass(_A("AA"), _A("AAA")));
REQUIRE_THAT(puml, IsInnerClass(_A("AA"), "Lights"));
REQUIRE_THAT(puml, IsMethod(Const(Public("foo"))));
REQUIRE_THAT(puml, IsMethod(Const(Public("foo2"))));

View File

@@ -42,37 +42,38 @@ TEST_CASE("Test t00005", "[unit-test]")
REQUIRE(model.name == "t00005_class");
auto puml = generate_class_puml(diagram, model);
AliasMatcher _A(puml);
REQUIRE_THAT(puml, StartsWith("@startuml"));
REQUIRE_THAT(puml, EndsWith("@enduml\n"));
REQUIRE_THAT(puml, IsClass("A"));
REQUIRE_THAT(puml, IsClass("B"));
REQUIRE_THAT(puml, IsClass("C"));
REQUIRE_THAT(puml, IsClass("D"));
REQUIRE_THAT(puml, IsClass("E"));
REQUIRE_THAT(puml, IsClass("F"));
REQUIRE_THAT(puml, IsClass("G"));
REQUIRE_THAT(puml, IsClass("H"));
REQUIRE_THAT(puml, IsClass("I"));
REQUIRE_THAT(puml, IsClass("J"));
REQUIRE_THAT(puml, IsClass("K"));
REQUIRE_THAT(puml, IsClass("R"));
REQUIRE_THAT(puml, IsClass(_A("A")));
REQUIRE_THAT(puml, IsClass(_A("B")));
REQUIRE_THAT(puml, IsClass(_A("C")));
REQUIRE_THAT(puml, IsClass(_A("D")));
REQUIRE_THAT(puml, IsClass(_A("E")));
REQUIRE_THAT(puml, IsClass(_A("F")));
REQUIRE_THAT(puml, IsClass(_A("G")));
REQUIRE_THAT(puml, IsClass(_A("H")));
REQUIRE_THAT(puml, IsClass(_A("I")));
REQUIRE_THAT(puml, IsClass(_A("J")));
REQUIRE_THAT(puml, IsClass(_A("K")));
REQUIRE_THAT(puml, IsClass(_A("R")));
REQUIRE_THAT(puml, IsField(Public("int some_int")));
REQUIRE_THAT(puml, IsField(Public("int * some_int_pointer")));
REQUIRE_THAT(puml, IsField(Public("int ** some_int_pointer_pointer")));
REQUIRE_THAT(puml, IsComposition("R", "A", "a"));
REQUIRE_THAT(puml, IsAssociation("R", "B", "b"));
REQUIRE_THAT(puml, IsAssociation("R", "C", "c"));
REQUIRE_THAT(puml, IsAssociation("R", "D", "d"));
REQUIRE_THAT(puml, IsAssociation("R", "E", "e"));
REQUIRE_THAT(puml, IsComposition("R", "F", "f"));
REQUIRE_THAT(puml, IsAssociation("R", "G", "g"));
REQUIRE_THAT(puml, IsAssociation("R", "H", "h"));
REQUIRE_THAT(puml, IsAssociation("R", "I", "i"));
REQUIRE_THAT(puml, IsAssociation("R", "J", "j"));
REQUIRE_THAT(puml, IsAssociation("R", "K", "k"));
REQUIRE_THAT(puml, IsComposition(_A("R"), _A("A"), "a"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("B"), "b"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("C"), "c"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("D"), "d"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("E"), "e"));
REQUIRE_THAT(puml, IsComposition(_A("R"), _A("F"), "f"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("G"), "g"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("H"), "h"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("I"), "i"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("J"), "j"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("K"), "k"));
save_puml(
"./" + config.output_directory + "/" + diagram->name + ".puml", puml);

View File

@@ -43,42 +43,43 @@ TEST_CASE("Test t00006", "[unit-test]")
REQUIRE(model.name == "t00006_class");
auto puml = generate_class_puml(diagram, model);
AliasMatcher _A(puml);
REQUIRE_THAT(puml, StartsWith("@startuml"));
REQUIRE_THAT(puml, EndsWith("@enduml\n"));
REQUIRE_THAT(puml, IsClass("A"));
REQUIRE_THAT(puml, IsClass("B"));
REQUIRE_THAT(puml, IsClass("C"));
REQUIRE_THAT(puml, IsClass("D"));
REQUIRE_THAT(puml, IsClass("E"));
REQUIRE_THAT(puml, IsClass("F"));
REQUIRE_THAT(puml, IsClass("G"));
REQUIRE_THAT(puml, IsClass("H"));
REQUIRE_THAT(puml, IsClass("I"));
REQUIRE_THAT(puml, IsClass("J"));
REQUIRE_THAT(puml, IsClass("K"));
REQUIRE_THAT(puml, IsClass("L"));
REQUIRE_THAT(puml, IsClass("M"));
REQUIRE_THAT(puml, IsClass("N"));
REQUIRE_THAT(puml, IsClass("NN"));
REQUIRE_THAT(puml, IsClass("NNN"));
REQUIRE_THAT(puml, IsClass(_A("A")));
REQUIRE_THAT(puml, IsClass(_A("B")));
REQUIRE_THAT(puml, IsClass(_A("C")));
REQUIRE_THAT(puml, IsClass(_A("D")));
REQUIRE_THAT(puml, IsClass(_A("E")));
REQUIRE_THAT(puml, IsClass(_A("F")));
REQUIRE_THAT(puml, IsClass(_A("G")));
REQUIRE_THAT(puml, IsClass(_A("H")));
REQUIRE_THAT(puml, IsClass(_A("I")));
REQUIRE_THAT(puml, IsClass(_A("J")));
REQUIRE_THAT(puml, IsClass(_A("K")));
REQUIRE_THAT(puml, IsClass(_A("L")));
REQUIRE_THAT(puml, IsClass(_A("M")));
REQUIRE_THAT(puml, IsClass(_A("N")));
REQUIRE_THAT(puml, IsClass(_A("NN")));
REQUIRE_THAT(puml, IsClass(_A("NNN")));
REQUIRE_THAT(puml, IsComposition("R", "A", "a"));
REQUIRE_THAT(puml, IsAssociation("R", "B", "b"));
REQUIRE_THAT(puml, IsComposition("R", "C", "c"));
REQUIRE_THAT(puml, IsAssociation("R", "D", "d"));
REQUIRE_THAT(puml, IsComposition("R", "E", "e"));
REQUIRE_THAT(puml, IsComposition("R", "F", "f"));
REQUIRE_THAT(puml, IsAssociation("R", "G", "g"));
REQUIRE_THAT(puml, IsComposition("R", "H", "h"));
REQUIRE_THAT(puml, IsAssociation("R", "I", "i"));
REQUIRE_THAT(puml, IsComposition("R", "J", "j"));
REQUIRE_THAT(puml, IsAssociation("R", "K", "k"));
REQUIRE_THAT(puml, IsComposition("R", "L", "lm"));
REQUIRE_THAT(puml, IsComposition("R", "M", "lm"));
REQUIRE_THAT(puml, IsComposition("R", "N", "ns"));
REQUIRE_THAT(puml, IsComposition("R", "NN", "ns"));
REQUIRE_THAT(puml, IsComposition("R", "NNN", "ns"));
REQUIRE_THAT(puml, IsComposition(_A("R"), _A("A"), "a"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("B"), "b"));
REQUIRE_THAT(puml, IsComposition(_A("R"), _A("C"), "c"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("D"), "d"));
REQUIRE_THAT(puml, IsComposition(_A("R"), _A("E"), "e"));
REQUIRE_THAT(puml, IsComposition(_A("R"), _A("F"), "f"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("G"), "g"));
REQUIRE_THAT(puml, IsComposition(_A("R"), _A("H"), "h"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("I"), "i"));
REQUIRE_THAT(puml, IsComposition(_A("R"), _A("J"), "j"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("K"), "k"));
REQUIRE_THAT(puml, IsComposition(_A("R"), _A("L"), "lm"));
REQUIRE_THAT(puml, IsComposition(_A("R"), _A("M"), "lm"));
REQUIRE_THAT(puml, IsComposition(_A("R"), _A("N"), "ns"));
REQUIRE_THAT(puml, IsComposition(_A("R"), _A("NN"), "ns"));
REQUIRE_THAT(puml, IsComposition(_A("R"), _A("NNN"), "ns"));
save_puml(
"./" + config.output_directory + "/" + diagram->name + ".puml", puml);

View File

@@ -43,17 +43,18 @@ TEST_CASE("Test t00007", "[unit-test]")
REQUIRE(model.name == "t00007_class");
auto puml = generate_class_puml(diagram, model);
AliasMatcher _A(puml);
REQUIRE_THAT(puml, StartsWith("@startuml"));
REQUIRE_THAT(puml, EndsWith("@enduml\n"));
REQUIRE_THAT(puml, IsClass("A"));
REQUIRE_THAT(puml, IsClass("B"));
REQUIRE_THAT(puml, IsClass("C"));
REQUIRE_THAT(puml, IsClass("R"));
REQUIRE_THAT(puml, IsClass(_A("A")));
REQUIRE_THAT(puml, IsClass(_A("B")));
REQUIRE_THAT(puml, IsClass(_A("C")));
REQUIRE_THAT(puml, IsClass(_A("R")));
REQUIRE_THAT(puml, IsComposition("R", "A", "a"));
REQUIRE_THAT(puml, IsAssociation("R", "B", "b"));
REQUIRE_THAT(puml, IsAssociation("R", "C", "c"));
REQUIRE_THAT(puml, IsComposition(_A("R"), _A("A"), "a"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("B"), "b"));
REQUIRE_THAT(puml, IsAssociation(_A("R"), _A("C"), "c"));
save_puml(
"./" + config.output_directory + "/" + diagram->name + ".puml", puml);

View File

@@ -40,6 +40,7 @@ TEST_CASE("Test t00008", "[unit-test]")
REQUIRE(model.name == "t00008_class");
auto puml = generate_class_puml(diagram, model);
AliasMatcher _A(puml);
REQUIRE_THAT(puml, StartsWith("@startuml"));
REQUIRE_THAT(puml, EndsWith("@enduml\n"));

View File

@@ -91,6 +91,7 @@ void save_puml(const std::string &path, const std::string &puml)
}
using clanguml::test::matchers::Abstract;
using clanguml::test::matchers::AliasMatcher;
using clanguml::test::matchers::Const;
using clanguml::test::matchers::Default;
using clanguml::test::matchers::HasCall;

View File

@@ -24,6 +24,7 @@
#include "uml/class_diagram_model.h"
#include "uml/class_diagram_visitor.h"
#include "uml/sequence_diagram_visitor.h"
#include "util/util.h"
#include "catch.h"
@@ -36,6 +37,7 @@ using Catch::Matchers::EndsWith;
using Catch::Matchers::StartsWith;
using Catch::Matchers::VectorContains;
using clanguml::cx::compilation_database;
using namespace clanguml::util;
std::pair<clanguml::config::config, compilation_database> load_config(
const std::string &test_name);
@@ -190,6 +192,36 @@ auto HasCallWithResponse(std::string const &from, std::string const &to,
fmt::format("\"{}\" --> \"{}\"", to, from), caseSensitivity));
}
struct AliasMatcher {
AliasMatcher(const std::string &puml_)
: puml{split(puml_, "\n")}
{
}
std::string operator()(const std::string &name)
{
std::vector<std::string> patterns;
patterns.push_back("class \"" + name + "\" as ");
patterns.push_back("abstract \"" + name + "\" as ");
patterns.push_back("enum \"" + name + "\" as ");
for (const auto &line : puml) {
for (const auto &pattern : patterns) {
const auto idx = line.find(pattern);
if (idx != std::string::npos) {
std::string res = line.substr(idx + pattern.size());
return trim(res);
}
}
}
throw std::runtime_error(fmt::format(
"Cannot find alias {} in {}", name, fmt::join(puml, "\n")));
}
const std::vector<std::string> puml;
};
ContainsMatcher IsClass(std::string const &str,
CaseSensitive::Choice caseSensitivity = CaseSensitive::Yes)
{
@@ -200,8 +232,8 @@ ContainsMatcher IsClassTemplate(std::string const &str,
std::string const &tmplt,
CaseSensitive::Choice caseSensitivity = CaseSensitive::Yes)
{
return ContainsMatcher(
CasedString(fmt::format("class {}<{}>", str, tmplt), caseSensitivity));
return ContainsMatcher(CasedString(
fmt::format("class \"{}<{}>\"", str, tmplt), caseSensitivity));
}
ContainsMatcher IsEnum(std::string const &str,