mirror of
https://github.com/szymon-jozef/static-site-generator.git
synced 2026-09-07 12:10:42 +02:00
Compare commits
53 Commits
html-style
...
84148f92df
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
84148f92df | ||
|
|
2013826acb | ||
|
|
bdcf7cf5da | ||
| 858bd19f10 | |||
| eecadf4fab | |||
| 8556937f58 | |||
| bc9228cdc7 | |||
| 74b46f4923 | |||
| 763761ea82 | |||
| 1668cb8563 | |||
| 5fa62d64ee | |||
| b171f11982 | |||
|
|
d2efd637cd | ||
| 90adcd88e7 | |||
| ddc590571a | |||
| 35cb6e3d82 | |||
| a2d76d4c4f | |||
| ef8fbfbb53 | |||
| e9b88530c2 | |||
| 322df82288 | |||
| fe02a16416 | |||
|
|
dd2c6ca810 | ||
| 2c8b9f2cfc | |||
| cf3b502509 | |||
| 1754c9fbab | |||
| 763a941042 | |||
|
|
a59773ef3e | ||
| 210f3ec04b | |||
|
|
ca7e6c8be6 | ||
| 94fbc3f30d | |||
| 55af7474d0 | |||
| 931a1908c1 | |||
| 0bae066c1f | |||
|
|
a486a04c2f | ||
|
|
944a07ae32 | ||
|
|
cc344019dd | ||
|
|
173d1954b3 | ||
|
|
a1c8c67021 | ||
| 3339e6d6a2 | |||
| df9874b3e2 | |||
| 0e0bc02441 | |||
| 671bfc0a35 | |||
| f3a13fbfd6 | |||
|
|
3ad3f873eb | ||
| 8679a627de | |||
| 38226a350f | |||
| 5fa92851eb | |||
| cf272d9156 | |||
| 546979c413 | |||
| ba708e3f32 | |||
|
|
ad01b5e7ac | ||
| 81cc7979b7 | |||
| 6d4cb18809 |
28
.github/workflows/c-cpp.yml
vendored
Normal file
28
.github/workflows/c-cpp.yml
vendored
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
name: C/C++ CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [ "master" ]
|
||||||
|
pull_request:
|
||||||
|
branches: [ "master" ]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
working-directory: ./src
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: install dependencies
|
||||||
|
run: |
|
||||||
|
sudo apt update
|
||||||
|
sudo apt install -y g++ catch2 libmd4c-dev libmd4c-html0-dev libtomlplusplus-dev
|
||||||
|
- name: make
|
||||||
|
run: make
|
||||||
|
- name: make test
|
||||||
|
run: make test
|
||||||
|
- name: make clean
|
||||||
|
run: make clean
|
||||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -1,3 +1,7 @@
|
|||||||
out/
|
out/
|
||||||
posts/
|
posts/
|
||||||
|
src/build/
|
||||||
|
/src/blog
|
||||||
|
/src/tests
|
||||||
|
/src/.cache/
|
||||||
*.o
|
*.o
|
||||||
|
|||||||
32
README.md
32
README.md
@@ -1,3 +1,5 @@
|
|||||||
|
[](https://github.com/szymon-jozef/static-site-generator/actions/workflows/c-cpp.yml)
|
||||||
|
|
||||||
# IMPORTANT
|
# IMPORTANT
|
||||||
This is still work in progress. It doesn't work yet.
|
This is still work in progress. It doesn't work yet.
|
||||||
I pushed it onto github just to have easy access from other computers.
|
I pushed it onto github just to have easy access from other computers.
|
||||||
@@ -8,10 +10,11 @@ As this is still a WIP, here is a short list of what works and what still needs
|
|||||||
- [x] config parsing
|
- [x] config parsing
|
||||||
- [x] metadata parsing
|
- [x] metadata parsing
|
||||||
- [x] basic tests
|
- [x] basic tests
|
||||||
- [ ] parsing markdown
|
- [x] parsing markdown
|
||||||
- [ ] generating html documents
|
- [ ] generating html documents
|
||||||
- [ ] some nicer css styles
|
- [ ] some nicer css styles
|
||||||
- [ ] more sensible templates
|
- [ ] more sensible templates
|
||||||
|
- [x] change yaml style metadata to toml
|
||||||
|
|
||||||
# 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.
|
||||||
@@ -32,10 +35,11 @@ Every blog post needs to be in a different file in `/posts` directory.
|
|||||||
An example from `/examples/post.md`
|
An example from `/examples/post.md`
|
||||||
```md
|
```md
|
||||||
---
|
---
|
||||||
author: "joseph"
|
[metadata]
|
||||||
date: "2026-01-01"
|
author = "joseph"
|
||||||
title: "Example of a blog post"
|
date = 2026-01-01
|
||||||
tags: ["blog", "test", "lalilulelo"]
|
title = "Example of a blog post"
|
||||||
|
tags = ["blog", "test", "lalilulelo"]
|
||||||
---
|
---
|
||||||
# This is an example post
|
# This is an example post
|
||||||
|
|
||||||
@@ -80,7 +84,7 @@ From there you can rsync/push it to your server or do whatever you want to do wi
|
|||||||
# How does the directory structure work?
|
# How does the directory structure work?
|
||||||
Also pretty simple. You have:
|
Also pretty simple. You have:
|
||||||
- `/config` for config files. Initially empty so you need to copy it from example dir or make one yourself.
|
- `/config` for config files. Initially empty so you need to copy it from example dir or make one yourself.
|
||||||
- `/examples` example of configuration files. Tests are dependent on it so don't edit the content of these files! You can copy it to `/config` and edit it there.
|
- `/examples` example of configuration files. You can copy it to `/config` and edit it there.
|
||||||
- `/out` for processed site.
|
- `/out` for processed site.
|
||||||
- `/posts` here you write your blog posts. Every file should be in markdown format, metadata included!.
|
- `/posts` here you write your blog posts. Every file should be in markdown format, metadata included!.
|
||||||
- `/src` for cpp files. Here's where you run the binary to translate your markdown posts into html.
|
- `/src` for cpp files. Here's where you run the binary to translate your markdown posts into html.
|
||||||
@@ -115,20 +119,22 @@ signal = "signal url"
|
|||||||
|
|
||||||
# Metadata explanation
|
# Metadata explanation
|
||||||
Metadata is everything at the beginning of the markdown file between `---`.
|
Metadata is everything at the beginning of the markdown file between `---`.
|
||||||
It's written in a format similar to yaml.
|
It's also written in toml. Why toml? I already use it's parser so it's easy to implement.
|
||||||
|
Besides it's readable and easy to write.
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
- author – the author of particular blog entry | string
|
- author – the author of particular blog entry | string
|
||||||
- date – date of writing an entry | string YYYY-MM-DD
|
- date – date of writing an entry | date
|
||||||
- title – title of blog entry | string
|
- title – title of blog entry | string
|
||||||
- tags – tags for blog entry. | json like list
|
- tags – tags for blog entry. | array
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
```
|
```
|
||||||
author: "joseph"
|
[metadata]
|
||||||
date: "2026-01-01"
|
author = "joseph"
|
||||||
title: "Example of a blog post"
|
date = 2026-01-01
|
||||||
tags: ["blog", "test", "lalilulelo"]
|
title = "Example of a blog post"
|
||||||
|
tags = ["blog", "test", "lalilulelo"]
|
||||||
```
|
```
|
||||||
|
|
||||||
# Why did you do this?
|
# Why did you do this?
|
||||||
|
|||||||
74
src/compile_commands.json
Normal file
74
src/compile_commands.json
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
[
|
||||||
|
{
|
||||||
|
"file": "main.cpp",
|
||||||
|
"arguments": [
|
||||||
|
"g++",
|
||||||
|
"-std=c++17",
|
||||||
|
"-Wall",
|
||||||
|
"-Wextra",
|
||||||
|
"-O2",
|
||||||
|
"-I",
|
||||||
|
".",
|
||||||
|
"-c",
|
||||||
|
"main.cpp",
|
||||||
|
"-o",
|
||||||
|
"build/main.o"
|
||||||
|
],
|
||||||
|
"directory": "/home/szymon/Dokumenty/kodowanie/blog/src",
|
||||||
|
"output": "build/main.o"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"file": "config/config.cpp",
|
||||||
|
"arguments": [
|
||||||
|
"g++",
|
||||||
|
"-std=c++17",
|
||||||
|
"-Wall",
|
||||||
|
"-Wextra",
|
||||||
|
"-O2",
|
||||||
|
"-I",
|
||||||
|
".",
|
||||||
|
"-c",
|
||||||
|
"config/config.cpp",
|
||||||
|
"-o",
|
||||||
|
"build/config/config.o"
|
||||||
|
],
|
||||||
|
"directory": "/home/szymon/Dokumenty/kodowanie/blog/src",
|
||||||
|
"output": "build/config/config.o"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"file": "format/format.cpp",
|
||||||
|
"arguments": [
|
||||||
|
"g++",
|
||||||
|
"-std=c++17",
|
||||||
|
"-Wall",
|
||||||
|
"-Wextra",
|
||||||
|
"-O2",
|
||||||
|
"-I",
|
||||||
|
".",
|
||||||
|
"-c",
|
||||||
|
"format/format.cpp",
|
||||||
|
"-o",
|
||||||
|
"build/format/format.o"
|
||||||
|
],
|
||||||
|
"directory": "/home/szymon/Dokumenty/kodowanie/blog/src",
|
||||||
|
"output": "build/format/format.o"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"file": "markdown/markdown.cpp",
|
||||||
|
"arguments": [
|
||||||
|
"g++",
|
||||||
|
"-std=c++17",
|
||||||
|
"-Wall",
|
||||||
|
"-Wextra",
|
||||||
|
"-O2",
|
||||||
|
"-I",
|
||||||
|
".",
|
||||||
|
"-c",
|
||||||
|
"markdown/markdown.cpp",
|
||||||
|
"-o",
|
||||||
|
"build/markdown/markdown.o"
|
||||||
|
],
|
||||||
|
"directory": "/home/szymon/Dokumenty/kodowanie/blog/src",
|
||||||
|
"output": "build/markdown/markdown.o"
|
||||||
|
}
|
||||||
|
]
|
||||||
@@ -5,10 +5,10 @@
|
|||||||
#include <toml++/impl/parser.hpp>
|
#include <toml++/impl/parser.hpp>
|
||||||
#include <toml++/toml.hpp>
|
#include <toml++/toml.hpp>
|
||||||
|
|
||||||
Config get_config(const std::string &CONFIG_FILE) {
|
Config get_config(const std::string &CONFIGURATION) {
|
||||||
toml::table toml_table;
|
toml::table toml_table;
|
||||||
try {
|
try {
|
||||||
toml_table = toml::parse_file(CONFIG_FILE);
|
toml_table = toml::parse(CONFIGURATION);
|
||||||
} catch (const toml::parse_error &err) {
|
} catch (const toml::parse_error &err) {
|
||||||
std::cerr << "Parsing failed:" << std::endl << err << std::endl;
|
std::cerr << "Parsing failed:" << std::endl << err << std::endl;
|
||||||
}
|
}
|
||||||
@@ -17,4 +17,7 @@ struct Config {
|
|||||||
General general;
|
General general;
|
||||||
};
|
};
|
||||||
|
|
||||||
Config get_config(const std::string &CONFIG_FILE);
|
// @brief Load config into `Config` struct
|
||||||
|
// @param CONFIGURATION content of `.toml` file containing configuration
|
||||||
|
// @return Config with parsed configuration
|
||||||
|
Config get_config(const std::string &CONFIGURATION);
|
||||||
11
src/format/format.cpp
Normal file
11
src/format/format.cpp
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
#include "markdown/markdown.hpp"
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
static bool replace_once(std::string &str, const std::string &from,
|
||||||
|
const std::string &to) {
|
||||||
|
size_t start_pos = str.find(from);
|
||||||
|
if (start_pos == std::string::npos)
|
||||||
|
return false;
|
||||||
|
str.replace(start_pos, from.length(), to);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
7
src/format/format.hpp
Normal file
7
src/format/format.hpp
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
#include <string>
|
||||||
|
|
||||||
|
// Change template from file into html
|
||||||
|
// Return html in string
|
||||||
|
std::string inject_html_into_template(const std::string &FILE_NAME,
|
||||||
|
const std::string &TEMPLATE,
|
||||||
|
const std::string &HTML);
|
||||||
36
src/io/io.cpp
Normal file
36
src/io/io.cpp
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
#include "io/io.hpp"
|
||||||
|
#include <fstream>
|
||||||
|
#include <sstream>
|
||||||
|
#include <stdexcept>
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
std::string read_file(const std::string &FILE_PATH) {
|
||||||
|
std::ifstream file(FILE_PATH);
|
||||||
|
if (!file) {
|
||||||
|
throw std::runtime_error("Error while opening file at " + FILE_PATH);
|
||||||
|
}
|
||||||
|
std::stringstream buffer;
|
||||||
|
buffer << file.rdbuf();
|
||||||
|
|
||||||
|
if (file.bad()) {
|
||||||
|
throw std::runtime_error("Error while reading file at " + FILE_PATH);
|
||||||
|
}
|
||||||
|
|
||||||
|
return buffer.str();
|
||||||
|
}
|
||||||
|
|
||||||
|
void write_file(const std::string &FILE_PATH, const std::string &CONTENT) {
|
||||||
|
std::ofstream out(FILE_PATH);
|
||||||
|
if (!out) {
|
||||||
|
throw std::runtime_error("Error while opening file for writing at " +
|
||||||
|
FILE_PATH);
|
||||||
|
}
|
||||||
|
|
||||||
|
out << CONTENT;
|
||||||
|
|
||||||
|
if (!out) {
|
||||||
|
throw std::runtime_error("Error while writing to the " + FILE_PATH);
|
||||||
|
}
|
||||||
|
|
||||||
|
out.close();
|
||||||
|
}
|
||||||
13
src/io/io.hpp
Normal file
13
src/io/io.hpp
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
#include <string>
|
||||||
|
|
||||||
|
// @brief Read file from given path
|
||||||
|
// @param FILE PATH Path to the file
|
||||||
|
// @return File content
|
||||||
|
// @throws std::runtime_error if any errors
|
||||||
|
std::string read_file(const std::string &FILE_PATH);
|
||||||
|
|
||||||
|
/// @brief Writes the given content into a file.
|
||||||
|
/// @param FILE_PATH Path to the file to write.
|
||||||
|
/// @param CONTENT Content to write into the file.
|
||||||
|
/// @throws std::runtime_error if the file cannot be opened or written.
|
||||||
|
void write_file(const std::string &FILE_PATH, const std::string &CONTENT);
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
#include "config.hpp"
|
#include "config/config.hpp"
|
||||||
#include <iostream>
|
#include <iostream>
|
||||||
#include <string>
|
#include <string>
|
||||||
|
|
||||||
|
|||||||
60
src/makefile
60
src/makefile
@@ -1,33 +1,53 @@
|
|||||||
CXX = g++
|
CXX = g++
|
||||||
CXXFLAGS = -std=c++17 -Wall
|
CXXFLAGS = -std=c++17 -Wall -Wextra -O2 -I .
|
||||||
TEST_LIBS = -lmd4c-html -lCatch2Main -lCatch2
|
|
||||||
LIBS = -lmd4c-html
|
LIBS = -lmd4c-html
|
||||||
|
TEST_LIBS = -lmd4c-html -lCatch2Main -lCatch2
|
||||||
|
|
||||||
all: blog
|
BUILD_DIR = build
|
||||||
|
|
||||||
blog: main.o config.o utils.o
|
SOURCES = main.cpp \
|
||||||
$(CXX) $(CXXFLAGS) main.o config.o -o blog $(LIBS)
|
config/config.cpp \
|
||||||
|
format/format.cpp \
|
||||||
|
markdown/markdown.cpp \
|
||||||
|
io/io.cpp
|
||||||
|
|
||||||
main.o: main.cpp config.hpp
|
OBJECTS = $(SOURCES:%.cpp=$(BUILD_DIR)/%.o)
|
||||||
$(CXX) $(CXXFLAGS) -c main.cpp
|
|
||||||
|
|
||||||
config.o: config.cpp config.hpp
|
TEST_SOURCES = tests.cpp \
|
||||||
$(CXX) $(CXXFLAGS) -c config.cpp
|
config/config.cpp \
|
||||||
|
format/format.cpp \
|
||||||
|
markdown/markdown.cpp \
|
||||||
|
io/io.cpp
|
||||||
|
|
||||||
utils.o: utils.cpp utils.hpp
|
TEST_OBJECTS = $(TEST_SOURCES:%.cpp=$(BUILD_DIR)/%.o)
|
||||||
$(CXX) $(CXXFLAGS) -c utils.cpp
|
|
||||||
|
|
||||||
markdown.o: markdown.cpp markdown.hpp
|
TARGET = blog
|
||||||
$(CXX) $(CXXFLAGS) -c markdown.cpp
|
TEST_TARGET = tests
|
||||||
|
|
||||||
tests: tests.o config.o utils.o markdown.o
|
.PHONY: all clean test directories
|
||||||
g++ -std=c++17 -Wall tests.o config.o utils.o markdown.o -o tests $(TEST_LIBS)
|
|
||||||
|
|
||||||
tests.o: tests.cpp config.hpp
|
all: directories $(TARGET)
|
||||||
$(CXX) $(CXXFLAGS) -c tests.cpp
|
|
||||||
|
|
||||||
check: tests
|
directories:
|
||||||
./tests
|
@mkdir -p $(BUILD_DIR)/config
|
||||||
|
@mkdir -p $(BUILD_DIR)/format
|
||||||
|
@mkdir -p $(BUILD_DIR)/markdown
|
||||||
|
|
||||||
|
$(TARGET): $(OBJECTS)
|
||||||
|
$(CXX) $(CXXFLAGS) -o $@ $^ $(LIBS)
|
||||||
|
|
||||||
|
$(TEST_TARGET): $(TEST_OBJECTS)
|
||||||
|
$(CXX) $(CXXFLAGS) -o $@ $^ $(TEST_LIBS)
|
||||||
|
|
||||||
|
$(BUILD_DIR)/%.o: %.cpp
|
||||||
|
@mkdir -p $(dir $@)
|
||||||
|
$(CXX) $(CXXFLAGS) -c $< -o $@
|
||||||
|
|
||||||
|
test: directories $(TEST_TARGET)
|
||||||
|
./$(TEST_TARGET)
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -f *.o blog tests
|
rm -rf $(BUILD_DIR)
|
||||||
|
rm -f $(TARGET) $(TEST_TARGET)
|
||||||
|
|
||||||
|
rebuild: clean all
|
||||||
|
|||||||
@@ -1,43 +0,0 @@
|
|||||||
#include "markdown.hpp"
|
|
||||||
#include "utils.hpp"
|
|
||||||
#include <fstream>
|
|
||||||
#include <iostream>
|
|
||||||
#include <map>
|
|
||||||
#include <md4c-html.h>
|
|
||||||
#include <optional>
|
|
||||||
|
|
||||||
std::optional<Metadata> get_metadata(const std::string &FILE_PATH) {
|
|
||||||
std::fstream file(FILE_PATH);
|
|
||||||
std::string buffer;
|
|
||||||
|
|
||||||
if (!getline(file, buffer) || buffer != "---") {
|
|
||||||
std::cerr << "File " << FILE_PATH << "does not contain metadata."
|
|
||||||
<< std::endl;
|
|
||||||
return std::nullopt;
|
|
||||||
}
|
|
||||||
|
|
||||||
std::map<std::string, std::string> metadata_map;
|
|
||||||
|
|
||||||
while (getline(file, buffer)) {
|
|
||||||
if (buffer == "---") {
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
size_t colon_pos = buffer.find(":");
|
|
||||||
|
|
||||||
if (colon_pos == std::string::npos) {
|
|
||||||
std::cerr << "The line: \n"
|
|
||||||
<< buffer << " does not contain a colon" << std::endl;
|
|
||||||
}
|
|
||||||
|
|
||||||
std::string key = buffer.substr(0, colon_pos);
|
|
||||||
trim(key);
|
|
||||||
|
|
||||||
std::string value = buffer.substr(colon_pos + 1);
|
|
||||||
trim(value);
|
|
||||||
metadata_map[key] = value;
|
|
||||||
}
|
|
||||||
|
|
||||||
return std::optional(Metadata{metadata_map["author"], metadata_map["date"],
|
|
||||||
metadata_map["title"],
|
|
||||||
convert_string_to_set(metadata_map["tags"])});
|
|
||||||
}
|
|
||||||
94
src/markdown/markdown.cpp
Normal file
94
src/markdown/markdown.cpp
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
#include "markdown.hpp"
|
||||||
|
#include <ctime>
|
||||||
|
#include <iostream>
|
||||||
|
#include <map>
|
||||||
|
#include <md4c-html.h>
|
||||||
|
#include <optional>
|
||||||
|
#include <sstream>
|
||||||
|
#include <toml++/toml.hpp>
|
||||||
|
|
||||||
|
std::optional<Metadata> get_metadata(const std::string &FILE_CONTENTS) {
|
||||||
|
std::stringstream file_contents(FILE_CONTENTS);
|
||||||
|
std::stringstream metadata_s;
|
||||||
|
std::string buffer;
|
||||||
|
|
||||||
|
/* if there's no ---, then no metadata in file there is */
|
||||||
|
if (!getline(file_contents, buffer) || buffer != "---") {
|
||||||
|
std::clog << "File does not contain any metadata. Is this intentional?"
|
||||||
|
<< std::endl;
|
||||||
|
return std::nullopt;
|
||||||
|
}
|
||||||
|
|
||||||
|
std::map<std::string, std::string> metadata_map;
|
||||||
|
|
||||||
|
while (getline(file_contents, buffer)) {
|
||||||
|
if (buffer == "---") {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
metadata_s << buffer << '\n';
|
||||||
|
}
|
||||||
|
|
||||||
|
toml::table toml_table = toml::parse(metadata_s);
|
||||||
|
std::vector<std::string> tags;
|
||||||
|
const auto &toml_tags = toml_table["metadata"]["tags"];
|
||||||
|
|
||||||
|
// translate toml into normal vector of strings
|
||||||
|
if (toml_tags.is_array()) {
|
||||||
|
for (auto iter = toml_tags.as_array()->begin();
|
||||||
|
iter < toml_tags.as_array()->end(); iter++) {
|
||||||
|
tags.emplace_back(static_cast<std::string>(iter->as_string()->get()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// time
|
||||||
|
auto toml_time = toml_table["metadata"]["date"];
|
||||||
|
|
||||||
|
struct tm t = {};
|
||||||
|
time_t timestamp = time(NULL);
|
||||||
|
|
||||||
|
if (toml_time.is_date()) {
|
||||||
|
toml::date d = toml_time.as_date()->get();
|
||||||
|
|
||||||
|
t.tm_year = d.year - 1900;
|
||||||
|
t.tm_mon = d.month - 1;
|
||||||
|
t.tm_mday = d.day;
|
||||||
|
t.tm_isdst = 0;
|
||||||
|
|
||||||
|
timestamp = mktime(&t);
|
||||||
|
}
|
||||||
|
|
||||||
|
Metadata metadata = {toml_table["metadata"]["author"].value_or(""), timestamp,
|
||||||
|
toml_table["metadata"]["title"].value_or(""), tags};
|
||||||
|
|
||||||
|
return std::optional(metadata);
|
||||||
|
}
|
||||||
|
|
||||||
|
static void html_callback(const MD_CHAR *data, MD_SIZE size, void *userdata) {
|
||||||
|
std::string *out = static_cast<std::string *>(userdata);
|
||||||
|
out->append(data, size);
|
||||||
|
}
|
||||||
|
|
||||||
|
std::string get_html(const std::string &FILE_CONTENTS) {
|
||||||
|
std::stringstream file_contents(FILE_CONTENTS);
|
||||||
|
std::string buffer, file_string, out;
|
||||||
|
getline(file_contents, buffer);
|
||||||
|
bool is_metadata = buffer == "---";
|
||||||
|
|
||||||
|
/* skip metadata */
|
||||||
|
if (is_metadata) {
|
||||||
|
while (getline(file_contents, buffer)) {
|
||||||
|
if (buffer == "---") {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
file_string += buffer + '\n';
|
||||||
|
}
|
||||||
|
|
||||||
|
while (getline(file_contents, buffer)) {
|
||||||
|
file_string += buffer + '\n';
|
||||||
|
}
|
||||||
|
|
||||||
|
md_html(file_string.c_str(), file_string.size(), html_callback, &out, 0, 0);
|
||||||
|
return out;
|
||||||
|
}
|
||||||
@@ -1,12 +1,14 @@
|
|||||||
|
#include <ctime>
|
||||||
#include <optional>
|
#include <optional>
|
||||||
#include <set>
|
|
||||||
#include <string>
|
#include <string>
|
||||||
|
#include <toml++/toml.hpp>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
struct Metadata {
|
struct Metadata {
|
||||||
std::string author;
|
std::string author;
|
||||||
std::string date;
|
time_t date;
|
||||||
std::string title;
|
std::string title;
|
||||||
std::set<std::string> tags;
|
std::vector<std::string> tags;
|
||||||
};
|
};
|
||||||
|
|
||||||
// Reads the metadata of the markdown file
|
// Reads the metadata of the markdown file
|
||||||
8
src/test_files/config.toml
Normal file
8
src/test_files/config.toml
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
[general]
|
||||||
|
lang = "en"
|
||||||
|
title = "Blog"
|
||||||
|
|
||||||
|
[contact]
|
||||||
|
author = "author"
|
||||||
|
email = "email@example.com"
|
||||||
|
signal = "signal url"
|
||||||
11
src/test_files/formatter.html
Normal file
11
src/test_files/formatter.html
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<title>Document</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
{{replace_me}}
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
BIN
src/test_files/image.png
Normal file
BIN
src/test_files/image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 290 KiB |
42
src/test_files/post.md
Normal file
42
src/test_files/post.md
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
---
|
||||||
|
[metadata]
|
||||||
|
author = "joseph"
|
||||||
|
date = 2026-01-01
|
||||||
|
title = "Example of a blog post"
|
||||||
|
tags = ["blog", "test", "lalilulelo"]
|
||||||
|
---
|
||||||
|
# This is an example post
|
||||||
|
|
||||||
|
In this example we will do a couple of cool markdown things.
|
||||||
|
|
||||||
|
## This is a h2 header
|
||||||
|
*This text is written in italic!*
|
||||||
|
### Look at this!
|
||||||
|
**This text is BOLD!**
|
||||||
|
|
||||||
|
## Hello world!
|
||||||
|
```cpp
|
||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
std::cout << "Hello world!" << std::endl;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
This is super cool!
|
||||||
|
|
||||||
|
## Time to link some random website!
|
||||||
|
This [should be clickable](https://example.com)
|
||||||
|
|
||||||
|
## Image test
|
||||||
|

|
||||||
|
|
||||||
|
## This is an ordered list
|
||||||
|
1. one
|
||||||
|
2. six
|
||||||
|
3. seven
|
||||||
|
|
||||||
|
## This is an unordered one
|
||||||
|
- six
|
||||||
|
- nine
|
||||||
|
- six
|
||||||
|
- nine
|
||||||
157
src/tests.cpp
157
src/tests.cpp
@@ -1,15 +1,95 @@
|
|||||||
#include "config.hpp"
|
#include "config/config.hpp"
|
||||||
#include "markdown.hpp"
|
#include "format/format.hpp"
|
||||||
#include "utils.hpp"
|
#include "io/io.hpp"
|
||||||
|
#include "markdown/markdown.hpp"
|
||||||
#include <catch2/catch_all.hpp>
|
#include <catch2/catch_all.hpp>
|
||||||
#include <catch2/catch_test_macros.hpp>
|
#include <catch2/catch_test_macros.hpp>
|
||||||
|
#include <ctime>
|
||||||
#include <optional>
|
#include <optional>
|
||||||
#include <string>
|
#include <string>
|
||||||
|
|
||||||
TEST_CASE("Checking config file read", "[config]") {
|
namespace TestFiles {
|
||||||
const std::string FILE_NAME = "../examples/config.toml";
|
constexpr const char *config_toml = R"([general]
|
||||||
|
lang = "en"
|
||||||
|
title = "Blog"
|
||||||
|
|
||||||
Config config = get_config(FILE_NAME);
|
[contact]
|
||||||
|
author = "author"
|
||||||
|
email = "email@example.com"
|
||||||
|
signal = "signal url"
|
||||||
|
)";
|
||||||
|
|
||||||
|
constexpr const char *formatter_html = R"(<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<title>Document</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
{{replace_me}}
|
||||||
|
</body>
|
||||||
|
</html>)";
|
||||||
|
|
||||||
|
constexpr const char *no_metadata_post_md = R"(# This markdown has no metadata.
|
||||||
|
That's bad. Don't do it. It's for tests only.)";
|
||||||
|
|
||||||
|
constexpr const char *post_md = R"(---
|
||||||
|
[metadata]
|
||||||
|
author = "joseph"
|
||||||
|
date = 2026-01-01
|
||||||
|
title = "Example of a blog post"
|
||||||
|
tags = ["blog", "test", "lalilulelo"]
|
||||||
|
---
|
||||||
|
# This is an example post
|
||||||
|
|
||||||
|
In this example we will do a couple of cool markdown things.
|
||||||
|
|
||||||
|
## This is a h2 header
|
||||||
|
*This text is written in italic!*
|
||||||
|
### Look at this!
|
||||||
|
**This text is BOLD!**
|
||||||
|
|
||||||
|
## Hello world!
|
||||||
|
```cpp
|
||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
std::cout << "Hello world!" << std::endl;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
This is super cool!
|
||||||
|
|
||||||
|
## Time to link some random website!
|
||||||
|
This [should be clickable](https://example.com)
|
||||||
|
|
||||||
|
## Image test
|
||||||
|

|
||||||
|
|
||||||
|
## This is an ordered list
|
||||||
|
1. one
|
||||||
|
2. six
|
||||||
|
3. seven
|
||||||
|
|
||||||
|
## This is an unordered one
|
||||||
|
- six
|
||||||
|
- nine
|
||||||
|
- six
|
||||||
|
- nine)";
|
||||||
|
} // namespace TestFiles
|
||||||
|
|
||||||
|
// IO tests
|
||||||
|
TEST_CASE("Test reading a file successful") {
|
||||||
|
std::string result = read_file("./test_files/config.toml");
|
||||||
|
REQUIRE(result == TestFiles::config_toml);
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST_CASE("Test reading a file that doesn't exist") {
|
||||||
|
REQUIRE_THROWS(read_file("this/path/doesnt/exist"));
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST_CASE("Checking config file read", "[config]") {
|
||||||
|
Config config = get_config(TestFiles::config_toml);
|
||||||
|
|
||||||
REQUIRE(config.contact.author == "author");
|
REQUIRE(config.contact.author == "author");
|
||||||
REQUIRE(config.contact.email == "email@example.com");
|
REQUIRE(config.contact.email == "email@example.com");
|
||||||
@@ -18,32 +98,65 @@ TEST_CASE("Checking config file read", "[config]") {
|
|||||||
REQUIRE(config.general.title == "Blog");
|
REQUIRE(config.general.title == "Blog");
|
||||||
}
|
}
|
||||||
|
|
||||||
TEST_CASE("convert_string_to_set parses inline YAML string list") {
|
|
||||||
const std::string input = "[\"haha\", \"dupa\", \"xdd\"]";
|
|
||||||
const std::set<std::string> output = {"haha", "dupa", "xdd"};
|
|
||||||
REQUIRE(convert_string_to_set(input) == output);
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST_CASE("get_metadata function data correctness test") {
|
TEST_CASE("get_metadata function data correctness test") {
|
||||||
const std::string FILE_NAME = "../examples/post.md";
|
Metadata result = get_metadata(TestFiles::post_md).value();
|
||||||
Metadata result = get_metadata(FILE_NAME).value();
|
|
||||||
|
|
||||||
std::string expected_author = "joseph";
|
std::string expected_author = "joseph";
|
||||||
std::string expected_date = "2026-01-01";
|
struct tm datetime = {0};
|
||||||
|
datetime.tm_year = 2026 - 1900;
|
||||||
|
datetime.tm_mon = 1 - 1;
|
||||||
|
datetime.tm_mday = 1;
|
||||||
|
datetime.tm_isdst = 0;
|
||||||
|
|
||||||
|
time_t expected_date = mktime(&datetime);
|
||||||
std::string expected_title = "Example of a blog post";
|
std::string expected_title = "Example of a blog post";
|
||||||
std::set<std::string> expected_tags = {"blog", "test", "lalilulelo"};
|
std::vector<std::string> expected_tags = {"blog", "test", "lalilulelo"};
|
||||||
|
|
||||||
REQUIRE(result.author == expected_author);
|
REQUIRE(result.author == expected_author);
|
||||||
REQUIRE(result.date == expected_date);
|
REQUIRE(result.date == expected_date);
|
||||||
REQUIRE(result.title == expected_title);
|
REQUIRE(result.title == expected_title);
|
||||||
|
REQUIRE(result.tags == expected_tags);
|
||||||
for (const auto &tag : expected_tags) {
|
|
||||||
REQUIRE(result.tags.count(tag));
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
TEST_CASE("get_metadata function test with a file that doesn't have metadata") {
|
TEST_CASE("get_metadata function test with a file that doesn't have metadata") {
|
||||||
const std::string FILE_NAME = "../examples/no_metadata_post.md";
|
std::optional<Metadata> result = get_metadata(TestFiles::no_metadata_post_md);
|
||||||
std::optional<Metadata> result = get_metadata(FILE_NAME);
|
|
||||||
REQUIRE(result == std::nullopt);
|
REQUIRE(result == std::nullopt);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
TEST_CASE("get_html function parsing test") {
|
||||||
|
const std::string EXPECTED_OUTPUT =
|
||||||
|
R"HTML(<h1>This is an example post</h1>
|
||||||
|
<p>In this example we will do a couple of cool markdown things.</p>
|
||||||
|
<h2>This is a h2 header</h2>
|
||||||
|
<p><em>This text is written in italic!</em></p>
|
||||||
|
<h3>Look at this!</h3>
|
||||||
|
<p><strong>This text is BOLD!</strong></p>
|
||||||
|
<h2>Hello world!</h2>
|
||||||
|
<pre><code class="language-cpp">#include <iostream>
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
std::cout << "Hello world!" << std::endl;
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<p>This is super cool!</p>
|
||||||
|
<h2>Time to link some random website!</h2>
|
||||||
|
<p>This <a href="https://example.com">should be clickable</a></p>
|
||||||
|
<h2>Image test</h2>
|
||||||
|
<p><img src="./image.png" alt="this should show an image"></p>
|
||||||
|
<h2>This is an ordered list</h2>
|
||||||
|
<ol>
|
||||||
|
<li>one</li>
|
||||||
|
<li>six</li>
|
||||||
|
<li>seven</li>
|
||||||
|
</ol>
|
||||||
|
<h2>This is an unordered one</h2>
|
||||||
|
<ul>
|
||||||
|
<li>six</li>
|
||||||
|
<li>nine</li>
|
||||||
|
<li>six</li>
|
||||||
|
<li>nine</li>
|
||||||
|
</ul>
|
||||||
|
)HTML";
|
||||||
|
|
||||||
|
REQUIRE(get_html(TestFiles::post_md) == EXPECTED_OUTPUT);
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,39 +0,0 @@
|
|||||||
#include <set>
|
|
||||||
#include <sstream>
|
|
||||||
#include <string>
|
|
||||||
|
|
||||||
void trim(std::string &str) {
|
|
||||||
str.erase(str.find_last_not_of(' ') + 1);
|
|
||||||
str.erase(0, str.find_first_not_of(' '));
|
|
||||||
str.erase(str.find_last_not_of('"') + 1);
|
|
||||||
str.erase(0, str.find_first_not_of('"'));
|
|
||||||
}
|
|
||||||
|
|
||||||
std::set<std::string> convert_string_to_set(std::string input) {
|
|
||||||
std::set<std::string> result;
|
|
||||||
std::string buffer;
|
|
||||||
size_t left, right;
|
|
||||||
left = input.find_first_of('[');
|
|
||||||
right = input.find_last_of(']');
|
|
||||||
|
|
||||||
if (left == std::string::npos || right == std::string::npos ||
|
|
||||||
right <= left) {
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
input = input.substr(left + 1, right - left - 1);
|
|
||||||
|
|
||||||
std::stringstream ss(input);
|
|
||||||
|
|
||||||
while (getline(ss, buffer, ',')) {
|
|
||||||
buffer.erase(0, buffer.find_first_not_of(" \t"));
|
|
||||||
buffer.erase(buffer.find_last_not_of(" \t") + 1);
|
|
||||||
|
|
||||||
if (buffer.size() >= 2 && buffer.front() == '"' && buffer.back() == '"') {
|
|
||||||
buffer = buffer.substr(1, buffer.size() - 2);
|
|
||||||
result.insert(buffer);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
#include <set>
|
|
||||||
#include <string>
|
|
||||||
|
|
||||||
// trim string in-place, removing all whitespaces and surrounding '"' symbols
|
|
||||||
void trim(std::string &str);
|
|
||||||
|
|
||||||
// Convert a string containing an inline YAML/JSON-style list of strings
|
|
||||||
// into a std::set<std::string>.
|
|
||||||
//
|
|
||||||
// Supported format (single line):
|
|
||||||
// ["haha", "dupa", "xdd"]
|
|
||||||
//
|
|
||||||
// Limitations:
|
|
||||||
// - no nested structures
|
|
||||||
// - no escaping inside strings
|
|
||||||
// - elements must be quoted
|
|
||||||
//
|
|
||||||
// Example:
|
|
||||||
// Input: ["haha", "dupa", "xdd"]
|
|
||||||
// Output: {"dupa", "haha", "xdd"} // sorted, unique
|
|
||||||
std::set<std::string> convert_string_to_set(std::string input);
|
|
||||||
6
templates/head.html
Normal file
6
templates/head.html
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<title>{{title}}</title>
|
||||||
|
<link rel="stylesheet" href="/style/style.css">
|
||||||
|
</head>
|
||||||
3
templates/header.html
Normal file
3
templates/header.html
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
<header>
|
||||||
|
<h1>{{title}}</h1>
|
||||||
|
</header>
|
||||||
@@ -1,23 +1,12 @@
|
|||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
<html lang="{{lang}}">
|
<html lang="{{lang}}">
|
||||||
<head>
|
{{head}}
|
||||||
<meta charset="UTF-8">
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
||||||
<title>{{title}}</title>
|
|
||||||
<link rel="stylesheet" href="/style/style.css">
|
|
||||||
</head>
|
|
||||||
<body>
|
<body>
|
||||||
<header>
|
{{header}}
|
||||||
<h1>{{title}}</h1>
|
|
||||||
</header>
|
|
||||||
|
|
||||||
<nav id="nav">
|
|
||||||
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
<main>
|
<main>
|
||||||
<ol id="posts">
|
<ol id="posts">
|
||||||
|
{{posts}}
|
||||||
</ol>
|
</ol>
|
||||||
</main>
|
</main>
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
Reference in New Issue
Block a user