Merge pull request #14 from Klemek/dev

v1.2.3
[skip CI]Updated nodemon config
2019-06-26 21:03:49 +02:00 · 2019-06-26 21:03:39 +02:00 · 2019-06-26 20:59:42 +02:00 · 2019-06-26 20:09:08 +02:00 · 2019-06-26 19:52:25 +02:00 · 2019-06-26 19:48:51 +02:00
13 changed files with 200 additions and 109 deletions
@@ -3,6 +3,7 @@
 /config.json
 /config.example.json
 /data
+/data/*
 /test_data
 /access.log
 /error.log
@@ -125,6 +125,28 @@ Resources are located on the `data` folder and can be referenced as the root of
 /styles/main.css => data/styles/main.css
 ```

+In your template, the following data is sent :
+
+* `info`  (every pages)
+  * `title` :  the blog's title as in the config
+  * `description` the blog's description as in the config
+  * `host` : the specified or guessed host with the protocol
+  * `version` : the GitBlog.md current running version
+  * `request` : the Express request object
+  * `config` : the content of the config
+* `article` (article pages only)
+  * `title` : the full title
+  * `thumbnail` the URL path of the thumbnail
+  * `url` : the URL path for this article (with the title)
+  * `date` : a JS date
+  * `year`
+  * `month`
+  * `day`
+  * `path` : the URL path for the folder of the article (without the title)
+  * `realPath` : the system's path for the folder
+  * `escapedTitle` : the code with alphanumeric and underscore characters only
+* `error` (error pages only) : the error code
+
 #### 5. Create and init your git source

 You need to [create a new repository](https://github.com/new) on your favorite Git service.
@@ -132,7 +154,10 @@ You need to [create a new repository](https://github.com/new) on your favorite G
 ```bash
 #gitblog.md/
 cd data
+git init
 git remote add origin <url_of_your_repo.git>
+git add .
+git commit -m "initial commit"
 git push -u origin master
 ```

@@ -157,7 +182,7 @@ Here are the steps for Github, if you use another platform adapt it your way (he
 ```json
 "webhook": {
    "endpoint": "/webhook",
-    "secret": "sha1=<value>",
+    "secret": "<value>",
    "signature_header": "X-Hub-Signature"
  },
 ```
@@ -165,6 +190,14 @@ Here are the steps for Github, if you use another platform adapt it your way (he
 * Update your webhook on github to include the secret
 * Check if Github successfully reached the endpoint

+#### 8. Keep your server always up and running (optionnal)
+
+This project `package.json` comes with a [nodemon](https://github.com/remy/nodemon) config. 
+
+After installing (`npm i -g nodemon`) you can then run the app with juste the `nodemon` command in the working directory.
+
+With this method, you can do a simple `git pull` to update your server.
+
 ## Writing an article
 [back to top](#gitblog-md)

@@ -212,6 +245,9 @@ Any URL like `/year/month/day/anything/` will redirect to this article (and link

 *  `node_port` (default: 3000)  
  the port the server is listening to
+*  `host` (default: none)  
+  if set (like `https://mywebsite.com`, it will be used as reference for creating links  
+  by default, host is guessed based on first request
 * `data_dir` (default: data)  
  the directory where will be located the git repo with templates and articles
 * `view_engine` (default: ejs)  
@@ -1,6 +1,6 @@
 {
  "name": "gitblog.md",
-  "version": "1.1.4",
+  "version": "1.2.3",
  "description": "A static blog using Markdown pulled from your git repository.",
  "main": "src/server.js",
  "dependencies": {
@@ -46,5 +46,16 @@
      "!src/postinstall.js",
      "!src/lib/*.js"
    ]
+  },
+  "nodemonConfig": {
+    "verbose": true,
+    "ignore": [
+      "test/*",
+      "sample_data/*",
+      "data/*",
+      "uml/*",
+      "*.log",
+      "README.md"
+    ]
  }
 }
@@ -1,19 +1,8 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-    <meta charset="UTF-8">
+    <%- include('head'); %>
    <title><%= info.title %> - Error <%= error %></title>
-
-    <meta name="twitter:card" content="summary_large_image">
-    <%= `<meta property="og:title" content="${info.title} - Home">` %>
-    <%= `<meta property="twitter:title" content="${info.title} - Home">` %>
-    <%= `<meta property="og:description" content="${info.description}">` %>
-    <%= `<meta property="twitter:description" content="${info.description}">` %>
-    <%= `<meta property="org:url" content="${info.host}/">` %>
-
-    <meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
-
-    <link rel="stylesheet" type="text/css" href="/style.css">
 </head>
 <body>
 <main>
@@ -1,6 +1,6 @@
 <hr>
 <footer>
-    <small><a href="/rss">RSS feed</a> - @<%= new Date().getFullYear() %> - Made with <a
+    <small><a href="/rss">RSS feed</a> - <%= new Date().getFullYear() %> - Made with <a
                href="https://github.com/klemek/gitblog.md">GitBlog.md</a> (v<%= info.version %>)
    </small>
 </footer>
@@ -0,0 +1,30 @@
+<meta charset="UTF-8">
+<meta http-equiv="content-type" content="text/html;charset=UTF-8">
+<META NAME="ROBOTS" CONTENT="INDEX, FOLLOW">
+
+<meta name="twitter:card" content="summary_large_image">
+<%- `<meta property="og:description" content="${info.description}">` %>
+<%- `<meta property="twitter:description" content="${info.description}">` %>
+<% if(locals.article){ %>
+    <%- `<meta property="org:url" content="${info.host + article.url}">` %>
+    <%- `<meta property="og:title" content="${info.title} - ${article.title}">` %>
+    <%- `<meta property="twitter:title" content="${info.title} - ${article.title}">` %>
+    <% if (article.thumbnail) { %>
+        <%- `<meta property="og:image" content="${info.host}/${article.thumbnail}">` %>
+        <%- `<meta property="twitter:image" content="${info.host}/${article.thumbnail}">` %>
+    <% } %>
+
+    <link rel="stylesheet" type="text/css" href="/css/prism.css">
+<% } else { %>
+    <%- `<meta property="org:url" content="${info.host}/">` %>
+    <%- `<meta property="og:title" content="${info.title} - Home">` %>
+    <%- `<meta property="twitter:title" content="${info.title} - Home">` %>
+
+    <%- `<meta property="description" content="${info.description}">` %>
+<% } %>
+
+<link rel="alternate" type="application/rss+xml" title="RSS feed" href="/rss"/>
+
+<meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
+
+<link rel="stylesheet" type="text/css" href="/style.css">
@@ -1,19 +1,8 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-    <meta charset="UTF-8">
+    <%- include('head'); %>
    <title><%= info.title %> - Home</title>
-
-    <meta name="twitter:card" content="summary_large_image">
-    <%= `<meta property="og:title" content="${info.title} - Home">` %>
-    <%= `<meta property="twitter:title" content="${info.title} - Home">` %>
-    <%= `<meta property="og:description" content="${info.description}">` %>
-    <%= `<meta property="twitter:description" content="${info.description}">` %>
-    <%= `<meta property="org:url" content="${info.host}/">` %>
-
-    <meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
-
-    <link rel="stylesheet" type="text/css" href="style.css">
 </head>
 <body>
 <main>
@@ -8,7 +8,7 @@ body, html {
 }

 body {
-    font: 14px/1.45 -apple-system, BlinkMacSystemFont, Segoe UI, sans-serif;
+    font: 15px sans-serif;
    color: #111;
    -webkit-text-size-adjust: none;
    background-color: #F5F5F5;
@@ -16,8 +16,8 @@ body {
 }

 main {
-    max-width: 75ch;
-    padding: 2ch;
+    max-width: 42rem;
+    padding: 2rem;
    margin: auto;
    background-color: #F0F0F0;
    min-height: 100vh;
@@ -58,7 +58,7 @@ blockquote {
    border-left: 0.5em solid #ccc;
    padding-left: 1em;
    margin: 0.25em 0;
-    color: #333;
+    color: #555;
 }

 blockquote > p {
@@ -108,7 +108,7 @@ main.article div.header a.link-home {
    line-height: 2.4;
 }

-main.article div.header h1, main.article div.header h2, div.article h3 {
+main.article div.header h1, main.article div.header h2 {
    margin-top: 0.85em;
    margin-bottom: 0.25em;
    font-size: 2em;
@@ -123,11 +123,19 @@ main.article div.header span.time, div.article span.time {
 }

 div.article {
-    margin-left: 1em;
+    margin: 0 1em 1em 1em;
 }

 div.article h3 {
    font-size: 1.3em;
+    margin:0;
+}
+
+div.article img{
+    max-width: 100%;
+    height: auto;
+    margin-right:1em;
+    margin-top:0.25em;
 }

 #text {
@@ -1,24 +1,8 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-    <meta charset="UTF-8">
+    <%- include('head'); %>
    <title><%= info.title %> - <%= article.title %></title>
-
-    <meta name="twitter:card" content="summary_large_image">
-    <%= `<meta property="og:title" content="${info.title} - ${article.title}">` %>
-    <%= `<meta property="twitter:title" content="${info.title} - ${article.title}">` %>
-    <%= `<meta property="og:description" content="${info.description}">` %>
-    <%= `<meta property="twitter:description" content="${info.description}">` %>
-    <%= `<meta property="org:url" content="${info.host + article.url}">` %>
-    <% if (article.thumbnail) { %>
-        <%= `<meta property="org:image" content="${info.host + article.thumbnail}">` %>
-        <%= `<meta property="twitter:image" content="${info.host + article.thumbnail}">` %>
-    <% } %>
-
-    <meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
-
-    <link rel="stylesheet" type="text/css" href="/prism.css">
-    <link rel="stylesheet" type="text/css" href="/style.css">
 </head>
 <body>
 <main class="article">
@@ -26,6 +26,28 @@ const cons = {
 };

 module.exports = (config) => {
+  /**
+   * Fetch articles from the data folder and send success as a response
+   * @param success
+   * @param error
+   */
+  let reload;
+  /**
+   * Render the page with the view engine and catch errors
+   * @param req
+   * @param res
+   * @param vPath - path of the view
+   * @param data - data to pass to the view
+   * @param code - code to send along the page
+   */
+  let render;
+  /**
+   * Show an error with the correct page
+   * @param req
+   * @param res
+   * @param code - error code
+   */
+  let showError;
  const fw = require('./file_walker')(config);
  const renderer = require('./renderer')(config);

@@ -36,14 +58,9 @@ module.exports = (config) => {

  const articles = {};
  let lastRSS = '';
-  let host;
+  let host = config['host'];

-  /**
-   * Fetch articles from the data folder and send success as a response
-   * @param success
-   * @param error
-   */
-  const reload = (success, error) => {
+  reload = (success, error) => {
    fw.fetchArticles((err, dict) => {
      if (err) {
        console.error(cons.error, 'error loading articles : ' + err);
@@ -65,42 +82,34 @@ module.exports = (config) => {
  if (config['test'])
    app.reload = reload;

-  /**
-   * Render the page with the view engine and catch errors
-   * @param res
-   * @param vPath - path of the view
-   * @param data - data to pass to the view
-   * @param code - code to send along the page
-   */
-  const render = (res, vPath, data, code = 200) => {
+  render = (req, res, vPath, data, code = 200) => {
    data.info = {
      title: config['home']['title'],
      description: config['home']['description'],
      host: host,
-      version: pjson.version
+      version: pjson.version,
+      request: req,
+      config: config
    };
    res.render(vPath, data, (err, html) => {
-      if (err) {
+      if (err && vPath !== path.join(config['data_dir'], config['home']['error'])) {
+        console.log(cons.error, `failed to render page ${vPath} : ${err}`);
+        showError(req, res, 500);
+      } else if (err) {
        res.sendStatus(500);
-        console.log(cons.error, `failed to render ${vPath} : ${err}`);
+        console.log(cons.error, `failed to render error page : ${err}`);
      } else
        res.status(code).send(html);
    });
  };

-  /**
-   * Show an error with the correct page
-   * @param resPath - the page of the original error
-   * @param code - error code
-   * @param res
-   */
-  const showError = (resPath, code, res) => {
+  showError = (req, res, code) => {
    const errorPath = path.join(config['data_dir'], config['home']['error']);
    fs.access(errorPath, fs.constants.R_OK, (err) => {
      if (err)
        res.sendStatus(code);
      else
-        render(res, errorPath, {error: code, path: resPath}, code);
+        render(req, res, errorPath, {error: code}, code);
    });
  };

@@ -133,9 +142,9 @@ module.exports = (config) => {
    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);
+        showError(req, res, 404);
      else
-        render(res, homePath, {articles: Object.values(articles).sort((a, b) => ('' + b.path).localeCompare(a.path))});
+        render(req, res, homePath, {articles: Object.values(articles).sort((a, b) => ('' + b.path).localeCompare(a.path))});
    });
  });

@@ -146,23 +155,23 @@ module.exports = (config) => {
        const feed = new Rss({
          'title': config['rss']['title'],
          'description': config['rss']['description'],
-          'feed_url': 'http://' + req.headers.host + req.url,
-          'site_url': 'http://' + req.headers.host
+          'feed_url': host + req.url,
+          'site_url': host
        });
        Object.values(articles)
          .slice(0, config['rss']['length'])
          .forEach((article) => {
            feed.item({
              title: article.title,
-              url: 'http://' + req.headers.host + article.url,
+              url: host + article.url,
              date: article.date
            });
          });
        lastRSS = feed.xml();
      }
-      res.type('rss').send(lastRSS);
+      res.type(req.headers['user-agent'].match(/Mozilla/) ? 'text/xml' : 'rss').send(lastRSS);
    } else {
-      showError(req.path, 404, res);
+      showError(req, res, 404);
    }
  });

@@ -205,21 +214,21 @@ module.exports = (config) => {
      const articlePath = req.path.substr(1, 10);
      const article = articles[articlePath];
      if (!article)
-        showError(req.path, 404, res);
+        showError(req, res, 404);
      else {
        renderer.render(path.join(article.realPath, config['article']['index']), (err, html) => {
          if (err) {
            console.log(cons.error, `failed to render article ${req.path} : ${err}`);
-            return showError(req.path, 500, res);
+            return showError(req, res, 500);
          }
          article.content = html;
          const templatePath = path.join(config['data_dir'], config['article']['template']);
          fs.access(templatePath, fs.constants.R_OK, (err) => {
            if (err) {
              console.log(cons.error, `no template found at ${templatePath}`);
-              showError(req.path, 500, res);
+              showError(req, res, 500);
            } else
-              render(res, templatePath, {article: article});
+              render(req, res, templatePath, {article: article});
          });
        });
      }
@@ -229,18 +238,17 @@ module.exports = (config) => {
  });

  // 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);
-    else
-      next();
+  config['home']['hidden'].forEach(pathMatcher => {
+    app.get(pathMatcher, (req, res) => {
+      showError(req, res, 404);
+    });
  });

  // serve all static files via get
  app.get('*', express.static(path.join(__dirname, '..', config['data_dir'])));
  // catch express.static errors (mostly not found) by displaying 404
  app.get('*', (req, res) => {
-    showError(req.path, 404, res);
+    showError(req, res, 404);
  });

  // catch all other methods and return 400
@@ -1,5 +1,6 @@
 {
  "node_port": 3000,
+  "host": "",
  "data_dir": "data",
  "view_engine": "ejs",
  "access_log": "access.log",
@@ -17,7 +18,8 @@
    "index": "index.ejs",
    "error": "error.ejs",
    "hidden": [
-      ".ejs"
+      "*.ejs",
+      "/.git*"
    ]
  },
  "article": {
@@ -37,7 +39,7 @@
    "endpoint": "/webhook",
    "secret": "",
    "signature_header": "",
-    "pull_command": "git pull"
+    "pull_command": "git pull origin master"
  },
  "showdown": {
    "parseImgDimensions": true,
@@ -16,16 +16,15 @@ config['data_dir'] = dataDir;
 config['webhook']['endpoint'] = '/webhooktest';
 config['rss']['endpoint'] = '/rsstest';
 config['rss']['length'] = 2;
-config['home']['index'] = testIndex;
 config['home']['error'] = testError;
 config['article']['template'] = testTemplate;

 const app = require('../src/app')(config);

 beforeEach((done, fail) => {
+  config['home']['index'] = testIndex;
  config['data_dir'] = dataDir;
  config['article']['index'] = 'index.md';
-  config['home']['hidden'] = ['.ejs', '.test'];
  config['access_log'] = '';
  config['error_log'] = '';
  config['modules']['rss'] = true;
@@ -93,20 +92,20 @@ describe('Test request logging', () => {

 describe('Test error logging', () => {
  test('test no log', (done) => {
-    config['home']['hidden'] = null;
-    request(app).get('/somefile.txt').then(() => {
+    config['home']['index'] = null;
+    request(app).get('/').then(() => {
      expect(fs.existsSync(path.join(dataDir, 'error.log'))).toBe(false);
      done();
    });
  });
  test('test null error ', (done) => {
-    config['home']['hidden'] = null;
+    config['home']['index'] = null;
    config['error_log'] = path.join(dataDir, 'error.log');
-    request(app).get('/somefile.txt').then(() => {
+    request(app).get('/').then(() => {
      fs.readFile(path.join(dataDir, 'error.log'), {encoding: 'UTF-8'}, (err, data) => {
        expect(err).toBeNull();
        const start = data.split('\n').slice(0, 2).join('\n');
-        const expected = '500 GET /somefile.txt ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\nTypeError: Cannot read property \'includes\' of null';
+        const expected = '500 GET / ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\nTypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received type object';
        expect(start).toBe(expected);
        done();
      });
@@ -136,6 +135,23 @@ describe('Test root path', () => {
      done();
    });
  });
+  test('500 render error with page', (done) => {
+    fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= null.length %>');
+    fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>');
+    request(app).get('/').then((response) => {
+      expect(response.statusCode).toBe(500);
+      expect(response.text).toBe('error 500');
+      done();
+    });
+  });
+  test('500 render error with failing page', (done) => {
+    fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= null.length %>');
+    fs.writeFileSync(path.join(dataDir, testError), 'error <%= null.error %>');
+    request(app).get('/').then((response) => {
+      expect(response.statusCode).toBe(500);
+      done();
+    });
+  });
  test('200 no articles', (done) => {
    fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= articles.length %>');
    request(app).get('/').then((response) => {
@@ -175,11 +191,19 @@ describe('Test RSS feed', () => {
  test('200 empty rss', (done) => {
    request(app).get('/rsstest').then((response) => {
      expect(response.statusCode).toBe(200);
+      expect(response.type).toBe('application/rss+xml');
      expect(response.text.length).toBeGreaterThan(0);
      expect(response.text.split('<item>').length).toBe(1);
      done();
    });
  });
+  test('200 Mozilla fix', (done) => {
+    request(app).get('/rsstest').set('user-agent', 'Mozilla Firefox 64.0').then((response) => {
+      expect(response.statusCode).toBe(200);
+      expect(response.type).toBe('text/xml');
+      done();
+    });
+  });
  test('200 rss cache', (done) => {
    request(app).get('/rsstest').then(() => {
      request(app).get('/rsstest').then((response) => {
@@ -378,8 +402,17 @@ describe('Test static files', () => {
    });
  });
  test('404 hidden file', (done) => {
-    fs.writeFileSync(path.join(dataDir, 'somefile.test'), '');
-    request(app).get('/somefile.test').then((response) => {
+    utils.createEmptyDirs([path.join(dataDir, 'tmp')]);
+    fs.writeFileSync(path.join(dataDir, 'tmp', 'somefile.ejs'), '');
+    request(app).get('/tmp/somefile.ejs').then((response) => {
+      expect(response.statusCode).toBe(404);
+      done();
+    });
+  });
+  test('404 hidden folder', (done) => {
+    utils.createEmptyDirs([path.join(dataDir, '.git')]);
+    fs.writeFileSync(path.join(dataDir, '.git', 'file.txt'), '');
+    request(app).get('/.git/file.txt').then((response) => {
      expect(response.statusCode).toBe(404);
      done();
    });
@@ -77,5 +77,5 @@ test('array fix', () => {
  fs.writeFileSync(configFile, '{"home":{"hidden":{}}}');
  const config = require('../src/config')();
  expect(config).toBeDefined();
-  expect(config['home']['hidden']).toEqual(['.ejs']);
+  expect(config['home']['hidden']).toEqual(['*.ejs', '/.git*']);
 });
Author	SHA1	Message	Date
Klemek	35fcdc7320	Merge pull request #14 from Klemek/dev v1.2.3	2019-06-26 21:03:49 +02:00
Klemek	dfb93b6764	[skip CI]Updated nodemon config	2019-06-26 21:03:39 +02:00
Klemek	6af4012522	Hidden files path matching	2019-06-26 20:59:42 +02:00
Klemek	1b91002c03	Updated templates meta tags	2019-06-26 20:09:08 +02:00
Klemek	bedd6a2953	Merge pull request #13 from Klemek/dev v1.2.2	2019-06-26 19:52:25 +02:00
Klemek	52d37d56cd	Bug fix	2019-06-26 19:48:51 +02:00
Klemek	fc7bc63c46	Nodemon config	2019-06-26 19:44:52 +02:00
Klemek	4397a76d9b	Merge pull request #12 from Klemek/dev v1.2.1	2019-06-26 19:35:29 +02:00
Klemek	ddf964eb27	Updated version	2019-06-26 19:28:29 +02:00
Klemek	4b47276484	Updated readme	2019-06-26 19:28:18 +02:00
Klemek	a7fedb149f	Host from config if specified	2019-06-26 19:28:00 +02:00
Klemek	ea95a285c9	Merge pull request #11 from Klemek/dev v1.2.0	2019-06-26 19:00:30 +02:00
Klemek	0fde428806	Updated coverage	2019-06-26 18:56:01 +02:00
Klemek	8fc7ff1ca7	Updated version	2019-06-26 18:44:31 +02:00
Klemek	ae4e2eb8d5	Fixing Firefox RSS handling	2019-06-26 18:43:41 +02:00
Klemek	528e4be1fe	Updated templates	2019-06-26 18:34:40 +02:00
Klemek	bd42883330	Update template.ejs	2019-06-26 18:21:44 +02:00
Klemek	b6ac0a73b4	Update style.css	2019-06-26 18:21:26 +02:00
Klemek	aebc3da5bc	Update template.ejs	2019-06-26 16:43:03 +02:00
Klemek	7a4a4f9006	Update footer.ejs	2019-06-26 15:07:32 +02:00
Klemek	1341aa5a56	Update config.default.json	2019-06-26 11:46:06 +02:00
Klemek	5e05f250f4	Update style.css	2019-06-26 10:06:12 +02:00
Klemek	6cf7be3afb	Update README.md	2019-06-23 15:37:23 +02:00
Klemek	6aceacad18	Update README.md	2019-06-23 15:34:46 +02:00
Klemek	a3a23be1c2	Update README.md	2019-06-23 15:34:34 +02:00
Klemek	e8e8024021	Merge pull request #10 from Klemek/dev v1.1.5	2019-06-23 15:15:45 +02:00
Klemek	1806d60ca7	Fixed meta tags being wrong	2019-06-23 15:14:47 +02:00