szymon/static-site-generator
1
0
Fork 0
mirror of https://github.com/szymon-jozef/static-site-generator.git synced 2026-09-07 20:20:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9 from szymon-jozef/feature/builder

Browse Source 
feature/builder
This commit is contained in:
Szymon
2026-01-12 23:07:46 +01:00
committed by GitHub
parent 3b676a8c49 a89e4bb60f
commit 4c904c0659
7 changed files with 134 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -11,10 +11,12 @@ As this is still a WIP, here is a short list of what works and what still needs
- [x] metadata parsing - [x] metadata parsing
- [x] basic tests - [x] basic tests
- [x] parsing markdown - [x] parsing markdown
- [ ] generating html documents - [x] generating html documents
- [ ] some nicer css styles - [ ] some nicer css styles
- [ ] more sensible templates - [ ] more sensible templates
- [x] change yaml style metadata to toml - [x] change yaml style metadata to toml
- [ ] cli
- [ ] perhaps someday gui?
# What is this? # What is this?
This is a small blog app. Basically a static site generator. This is a small blog app. Basically a static site generator.

43
src/builder/builder.cpp Normal file
View File

@@ -0,0 +1,43 @@
#include "builder/builder.hpp"
#include "config/config.hpp"
#include "format/format.hpp"
std::string build_index(const std::string &TEMPLATE, const Page &PAGE,
const Information &INFORMATION) {
std::string result = TEMPLATE;
result = format_file(result, "{{lang}}", INFORMATION.config.general.lang);
result = format_file(result, "{{head}}", PAGE.head);
result = format_file(result, "{{header}}", PAGE.header);
result = format_file(result, "{{main}}", PAGE.main);
result = format_file(result, "{{footer}}", PAGE.footer);
return result;
}
std::string build_header(const std::string &TEMPLATE,
const Information &INFORMATION) {
std::string result =
format_file(TEMPLATE, "{{title}}", INFORMATION.metadata.title);
;
return result;
}
std::string build_head(const std::string &TEMPLATE,
const Information &INFORMATION) {
std::string result =
format_file(TEMPLATE, "{{title}}", INFORMATION.metadata.title);
return result;
}
std::string build_footer(const std::string &TEMPLATE,
const Information &INFORMATION) {
std::string result = TEMPLATE;
result =
format_file_conditionally(result, "{{if email}}", "{{endif}}",
"{{email}}", INFORMATION.config.contact.email);
result = format_file_conditionally(result, "{{if signal}}", "{{endif}}",
"{{signal}}",
INFORMATION.config.contact.signal);
return result;
}

22
src/builder/builder.hpp Normal file
View File

@@ -0,0 +1,22 @@
#include "config/config.hpp"
#include "markdown/markdown.hpp"
struct Page {
std::string head;
std::string header;
std::string main;
std::string footer;
};
struct Information {
Config config;
Metadata metadata;
};
// @brief Function that builds index.html. It takes all the information from
// `Page` struct that should be built before calling it.
// @param TEMPLATE Template file that will be used to build index
// @param PAGE Page struct with information on html tags
// @return Built index.html in string
std::string build_index(const std::string &TEMPLATE, const Page &PAGE,
const Information &INFORMATION);

7
src/makefile
View File

@@ -9,7 +9,8 @@ SOURCES = main.cpp \
config/config.cpp \ config/config.cpp \
format/format.cpp \ format/format.cpp \
markdown/markdown.cpp \ markdown/markdown.cpp \
io/io.cpp io/io.cpp \
builder/builder.cpp
OBJECTS = $(SOURCES:%.cpp=$(BUILD_DIR)/%.o) OBJECTS = $(SOURCES:%.cpp=$(BUILD_DIR)/%.o)
@@ -17,7 +18,8 @@ TEST_SOURCES = tests.cpp \
config/config.cpp \ config/config.cpp \
format/format.cpp \ format/format.cpp \
markdown/markdown.cpp \ markdown/markdown.cpp \
io/io.cpp io/io.cpp \
builder/builder.cpp
TEST_OBJECTS = $(TEST_SOURCES:%.cpp=$(BUILD_DIR)/%.o) TEST_OBJECTS = $(TEST_SOURCES:%.cpp=$(BUILD_DIR)/%.o)
@@ -33,6 +35,7 @@ directories:
@mkdir -p $(BUILD_DIR)/format @mkdir -p $(BUILD_DIR)/format
@mkdir -p $(BUILD_DIR)/io @mkdir -p $(BUILD_DIR)/io
@mkdir -p $(BUILD_DIR)/markdown @mkdir -p $(BUILD_DIR)/markdown
@mkdir -p $(BUILD_DIR)/builder
$(TARGET): $(OBJECTS) $(TARGET): $(OBJECTS)
$(CXX) $(CXXFLAGS) -o $@ $^ $(LIBS) $(CXX) $(CXXFLAGS) -o $@ $^ $(LIBS)

1
src/markdown/markdown.hpp
View File

@@ -1,3 +1,4 @@
#pragma once
#include <ctime> #include <ctime>
#include <optional> #include <optional>
#include <string> #include <string>

52
src/tests.cpp
View File

@@ -1,3 +1,4 @@
#include "builder/builder.hpp"
#include "config/config.hpp" #include "config/config.hpp"
#include "format/format.hpp" #include "format/format.hpp"
#include "io/io.hpp" #include "io/io.hpp"
@@ -128,6 +129,21 @@ This [should be clickable](https://example.com)
- nine - nine
- six - six
- nine)"; - nine)";
constexpr const char *template_index = R"(<!DOCTYPE html>
<html lang="{{lang}}">
<head>
{{head}}
</head>
<body>
<header>{{header}}</header>
<main>
{{main}}
</main>
{{footer}}
</body>
</html>)";
} // namespace TestFiles } // namespace TestFiles
// IO tests // IO tests
@@ -158,7 +174,7 @@ TEST_CASE("get_metadata function data correctness test") {
Metadata result = get_metadata(TestFiles::post_md).value(); Metadata result = get_metadata(TestFiles::post_md).value();
std::string expected_author = "joseph"; std::string expected_author = "joseph";
struct tm datetime = {0}; struct tm datetime = {};
datetime.tm_year = 2026 - 1900; datetime.tm_year = 2026 - 1900;
datetime.tm_mon = 1 - 1; datetime.tm_mon = 1 - 1;
datetime.tm_mday = 1; datetime.tm_mday = 1;
@@ -241,3 +257,37 @@ TEST_CASE("Test format_file_conditionally with empty tag") {
format_file_conditionally(TestFiles::formatter_html_conditionally, format_file_conditionally(TestFiles::formatter_html_conditionally,
"{{if tag}}", "{{endif}}", "{{tag}}", "")); "{{if tag}}", "{{endif}}", "{{tag}}", ""));
} }
// Builder tests
TEST_CASE("build_index correctly assembles the page", "[builder]") {
Config config;
config.general.lang = "pl";
Metadata metadata;
Information info;
info.config = config;
info.metadata = metadata;
Page page;
page.head = "<meta charset='utf-8'><title>Test</title>";
page.header = "<nav>Menu</nav>";
page.main = "<article>Treść wpisu</article>";
page.footer = "<footer>Stopka</footer>";
std::string expected_output = R"(<!DOCTYPE html>
<html lang="pl">
<head>
<meta charset='utf-8'><title>Test</title>
</head>
<body>
<header><nav>Menu</nav></header>
<main>
<article>Treść wpisu</article>
</main>
<footer>Stopka</footer>
</body>
</html>)";
std::string result = build_index(TestFiles::template_index, page, info);
REQUIRE(result == expected_output);
}

13
templates/index.html
View File

@@ -1,13 +1,18 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="{{lang}}"> <html lang="{{lang}}">
<head>
{{head}} {{head}}
</head>
<body> <body>
<header>
{{header}} {{header}}
</header>
<main> <main>
<ol id="posts"> {{main}}
{{posts}}
</ol>
</main> </main>
<footer>
{{footer}}
</footer>
</body> </body>
</html> </html>