Articles rendering system

2019-06-20 13:49:44 +02:00
parent 69d05e3900
commit b7a2fd0740
7 changed files with 131 additions and 12 deletions
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>GitBlog.md - Home</title>
+    <link rel="stylesheet" type="text/css" href="style.css">
+</head>
+<body>
+<main>
+    <%- article.content %>
+</main>
+</body>
+</html>
@@ -15,13 +15,14 @@ const cons = {

 module.exports = (config) => {
    const fw = require('./file_walker')(config);
+    const renderer = require('./renderer')(config);

    // set view engine from configuration
    app.set('view engine', config['view_engine']);
    // reroute the views folder to the root folder
    app.set('views', path.join(__dirname, '..'));

-    const articles = [];
+    const articles = {};

    /**
     * Fetch articles from the data folder and send success as a response
@@ -34,8 +35,9 @@ module.exports = (config) => {
                return console.error(cons.error, 'loading articles : ' + err);
            }
            articles.splice(0, articles.length, ...list);
-            if (articles.length > 0)
-                console.log(cons.ok, `loaded ${articles.length} article${articles.length > 1 ? 's' : ''}`);
+            const nb = Object.keys(articles).length;
+            if (nb > 0)
+                console.log(cons.ok, `loaded ${nb} article${nb > 1 ? 's' : ''}`);
            else
                console.log(cons.warn, `no articles loaded, check your configuration`);
            callback(true);
@@ -79,16 +81,42 @@ module.exports = (config) => {

    // home endpoint : send the correct index page or error if not existing
    app.get('/', (req, res) => {
-        const homePath = `${config['data_dir']}/${config['home']['index']}`;
+        const homePath = path.join(config['data_dir'], config['home']['index']);
        fs.access(homePath, fs.constants.R_OK, (err) => {
            if (err)
                showError(req.path, 404, res);
            else
-                render(res, homePath, {articles: articles});
+                render(res, homePath, {articles: Object.values(articles)});
        });
    });

-    // catch all gets and return 404 if it's an hidden file type
+    // catch all article urls and render them
+    app.get('*', (req, res, next) => {
+        if (req.path.test(/^\/\d{4}\/\d{2}\/\d{2}\/(\w*\/)?$/)) {
+            const articlePath = req.path.substr(0, 11);
+            const article = articles[articlePath];
+            if (!article)
+                showError(req.path, 404, res);
+            else {
+                renderer.render(article.realPath, (err, html) => {
+                    if (err)
+                        return showError(req.path, 500, res);
+                    article.content = html;
+                    const templatePath = path.join(config['data_dir'], config['home']['index']);
+                    fs.access(templatePath, fs.constants.R_OK, (err) => {
+                        if (err)
+                            showError(req.path, 404, res);
+                        else
+                            render(res, templatePath, {article: article});
+                    });
+                });
+            }
+        } else {
+            next();
+        }
+    });
+
+    // catch all hidden file type and return 404
    app.get('*', (req, res, next) => {
        if (config['home']['hidden'].includes(path.extname(req.path)))
            showError(req.path, 404, res);
@@ -14,6 +14,7 @@
  },
  "article": {
    "index": "index.md",
+    "template": "template.ejs",
    "thumbnail_tag": "thumbnail",
    "default_title": "Untitled",
    "default_thumbnail": null
@@ -25,5 +26,13 @@
  "webhook": {
    "endpoint": "/webhook",
    "secretFile": "git_secret"
+  },
+  "showdown": {
+    "parseImgDimensions": true,
+    "strikethrough": true,
+    "tables": true,
+    "tasklists": true,
+    "openLinksInNewWindow": true,
+    "emoji": true
  }
 }
@@ -76,7 +76,7 @@ module.exports = (config) => {
                    .filter((matches) => matches && matches.length > 1);
                if (paths.length === 0)
                    cb(null, []);
-                const list = [];
+                const articles = {};
                let remaining = 0;
                paths.forEach((matches) => {
                    const article = {
@@ -94,11 +94,11 @@ module.exports = (config) => {
                        article.title = info.title || config['article']['default_title'];
                        article.thumbnail = info.thumbnail ? path.join(article.path, info.thumbnail) : config['article']['default_thumbnail'];
                        article.escapedTitle = article.title.toLowerCase().replace(/[^\w]/gm, ' ').trim().replace(/ /gm, '_');
-                        article.url = path.join(article.path, article.escapedTitle);
-                        list.push(article);
+                        article.url = path.join(article.path, article.escapedTitle)+'/';
+                        articles[article.path]=article;
                        remaining--;
                        if (remaining === 0)
-                            cb(null, list);
+                            cb(null, articles);
                    });
                });

@@ -0,0 +1,16 @@
+const fs = require('fs');
+const showdown = require('showdown');
+
+module.exports = (config) => {
+    const converter = new showdown.Converter(config['showdown']);
+    return {
+        render : (file, cb) => {
+            fs.readFile(file, {encoding:'UTF-8'}, (err, data) => {
+               if(err)
+                   return cb(err);
+               const html = converter.makeHtml(data);
+               cb(null,html);
+            });
+        }
+    };
+};
@@ -234,7 +234,7 @@ describe('Test article fetching', () => {
                title: 'Untitled',
                thumbnail: 'default.png',
                escapedTitle: 'untitled',
-                url: path.join('2019', '05', '05', 'untitled'),
+                url: path.join('2019', '05', '05', 'untitled')+'/',
            });
            done();
        });
@@ -262,7 +262,7 @@ describe('Test article fetching', () => {
                title: 'Title with : info !',
                thumbnail: path.join('2019', '05', '05', './thumbnail.jpg'),
                escapedTitle: 'title_with___info',
-                url: path.join('2019', '05', '05', 'title_with___info'),
+                url: path.join('2019', '05', '05', 'title_with___info')+'/',
            });
            done();
        });
@@ -0,0 +1,53 @@
+/* jshint -W117 */
+const fs = require('fs');
+const path = require('path');
+const utils = require('./test_utils');
+
+const dataDir = 'test_data';
+const file = path.join(dataDir, 'test.md');
+
+const config = {
+    'showdown': {
+        'simplifiedAutoLink': true,
+        'smartIndentationFix': true
+    }
+};
+
+const renderer = require('../src/renderer')(config);
+
+beforeEach(() => {
+    utils.deleteFolderSync(dataDir);
+    fs.mkdirSync(dataDir);
+});
+
+afterAll(() => {
+    if (fs.existsSync(dataDir)) {
+        utils.deleteFolderSync(dataDir);
+    }
+});
+
+test('invalid file', (done) => {
+    renderer.render('invalid file', (err, html) => {
+        expect(err).not.toBeNull();
+        expect(html).not.toBeDefined();
+        done();
+    });
+});
+
+test('normal file', (done) => {
+    fs.writeFileSync(file, `# Hello`);
+    renderer.render(file, (err, html) => {
+        expect(err).toBeNull();
+        expect(html).toBe('<h1 id="hello">Hello</h1>');
+        done();
+    });
+});
+
+test('custom rules', (done) => {
+    fs.writeFileSync(file, `www.google.com`);
+    renderer.render(file, (err, html) => {
+        expect(err).toBeNull();
+        expect(html).toBe('<p><a href="http://www.google.com">www.google.com</a></p>');
+        done();
+    });
+});