Merge pull request #12 from Klemek/dev

v1.2.1

.gitignore

@@ -3,6 +3,7 @@
 /config.json
 /config.example.json
 /data
+/data/*
 /test_data
 /access.log
 /error.log

.jshintignore

@@ -0,0 +1,2 @@
+/node_modules
+/src/lib

.travis.yml

@@ -6,13 +6,8 @@ cache:
   npm: true
   directories:
     - node_modules
-addons:
-  apt:
-    packages:
-      - graphviz
 install:
   - npm install
-  - npm install node-plantuml
 before_script:
   - npm install -g jshint
 script:

README.md

@@ -81,7 +81,7 @@ On the `/rss` endpoint, the servers gives you a RSS feed based on the list of ar
 #### 1. Download and install the latest version from the repo
 ```bash
 git clone https://github.com/klemek/gitblog.md.git
-npm install
+npm install --production
 ```
 #### 2. Create your config file
 ```bash
@@ -125,6 +125,30 @@ 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)
+  * `error` : the error code
+  * `path` : the resource that caused the error
+
 #### 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 +156,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 +184,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"
   },
 ```
@@ -203,13 +230,18 @@ Any URL like `/year/month/day/anything/` will redirect to this article (and link
 * **Prism**  
   It highlight code blocks to be more readable (more info [here](https://prismjs.com/), you will need the corresponding CSS file on your templates)
 * **MathJax**  
-  It allows you to add math equations to your articles by simply writing LaTeX between $$ for full size (and between $ for inline) (more info [here](https://www.mathjax.org/))
+  It allows you to add math equations to your articles by simply writing LaTeX between `$$` for full size (and between $ for inline) (more info [here](https://www.mathjax.org/))
+* **PlantUML**  
+  It allows you to add UML diagrams with PlantUML Syntax between `@startuml` and `@enduml` (more info [here](http://www.plantuml.com))
 
 ## Configuration
 [back to top](#gitblog-md)
 
 *  `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)  
@@ -227,7 +259,15 @@ Any URL like `/year/month/day/anything/` will redirect to this article (and link
      activate Prism code highlighting
    * `mathjax` (default: true)  
      activate MathJax equations formatting
+   * `plantuml` (default: true)  
+     activate PlantUML diagram rendering
 * `home`
+   * `title` (default: GitBlog.md)  
+     the title of your blog, **strongly advised to be changed**  
+     given to the template to complete page title and metadata
+   * `description` (default: A static blog using Markdown pulled from your git repository)  
+     the description of your blog, **strongly advised to be changed**  
+     given to the template to complete page title and metadata
    * `index` (default: index.ejs)  
      the name of the home page template on the data directory  
      it will receive `articles`, a list of articles for rendering

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "gitblog.md",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitblog.md",
-  "version": "1.0.3",
+  "version": "1.2.1",
   "description": "A static blog using Markdown pulled from your git repository.",
   "main": "src/server.js",
   "dependencies": {
@@ -43,7 +43,8 @@
       "src/**/*.js",
       "!/node_modules/",
       "!src/server.js",
-      "!src/postinstall.js"
+      "!src/postinstall.js",
+      "!src/lib/*.js"
     ]
   }
 }

sample_data/article/index.md

@@ -18,6 +18,7 @@ If you see this page, that means it's working
 * [Check Boxes](#checkboxes)
 * [Spoilers](#spoilers)
 * [Math Equations](#mathequations)
+* [UML](#uml)
 * [Youtube Videos](#youtubevideos)
 
 ### Headers
@@ -224,6 +225,33 @@ $$
 
 Where $\alpha$ is cool
 
+### UML
+[Back to top](#top)
+
+You can use PlantUML diagrams with `@startuml` and `@enduml` tags :
+
+@startuml
+title Article
+cloud web
+node nodejs {
+    TCP -right- [express]
+    [showdown]
+}
+package data {
+    package "2019/06/18" {
+        component index [
+            index.md
+            image.png
+            ...
+        ]
+    }
+}
+web -down-> TCP : 1. /2019/06/18/title
+express -down-> index : 2. fetch
+index -up-> showdown : 3. markdown
+showdown -left-> express : 4. html
+express -up-> web : 5. html
+@enduml
 
 ### Youtube Videos
 [Back to top](#top)

sample_data/home/error.ejs

@@ -2,8 +2,8 @@
 <html lang="en">
 <head>
     <meta charset="UTF-8">
-    <title>Error <%= error %></title>
-    <link rel="stylesheet" type="text/css" href="/style.css">
+    <title><%= info.title %> - Error <%= error %></title>
+    <%- include('head'); %>
 </head>
 <body>
 <main>

sample_data/home/footer.ejs

@@ -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>

sample_data/home/head.ejs

@@ -0,0 +1,25 @@
+<meta name="twitter:card" content="summary_large_image">
+<% if(locals.article){ %>
+    <%- `<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="og:image" content="${info.host}/${article.thumbnail}">` %>
+        <%- `<meta property="twitter:image" content="${info.host}/${article.thumbnail}">` %>
+    <% } %>
+    <link rel="stylesheet" type="text/css" href="/prism.css">
+<% } else { %>
+    <%- `<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}/">` %>
+<% } %>
+
+<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">

sample_data/home/index.ejs

@@ -2,13 +2,13 @@
 <html lang="en">
 <head>
     <meta charset="UTF-8">
-    <title>GitBlog.md - Home</title>
-    <link rel="stylesheet" type="text/css" href="style.css">
+    <title><%= info.title %> - Home</title>
+    <%- include('head'); %>
 </head>
 <body>
 <main>
-    <h1>GitBlog.md</h1>
-    A static blog using Markdown pulled from your git repository
+    <h1><%= info.title %></h1>
+    <%= info.description %>
     <h2>Articles in this blog :</h2>
     <% articles.forEach((article) => { %>
         <div class="article">

sample_data/home/style.css

@@ -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 {

sample_data/home/template.ejs

@@ -2,9 +2,8 @@
 <html lang="en">
 <head>
     <meta charset="UTF-8">
-    <title>GitBlog.md - <%= article.title %></title>
-    <link rel="stylesheet" type="text/css" href="/prism.css">
-    <link rel="stylesheet" type="text/css" href="/style.css">
+    <title><%= info.title %> - <%= article.title %></title>
+    <%- include('head'); %>
 </head>
 <body>
 <main class="article">

src/app.js

@@ -36,6 +36,7 @@ module.exports = (config) => {
 
   const articles = {};
   let lastRSS = '';
+  let host = config['host'];
 
   /**
    * Fetch articles from the data folder and send success as a response
@@ -66,14 +67,20 @@ module.exports = (config) => {
 
   /**
    * 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
    */
-  const render = (res, vPath, data, code = 200) => {
+  const render = (req, res, vPath, data, code = 200) => {
     data.info = {
-      version: pjson.version
+      title: config['home']['title'],
+      description: config['home']['description'],
+      host: host,
+      version: pjson.version,
+      request: req,
+      config: config
     };
     res.render(vPath, data, (err, html) => {
       if (err) {
@@ -86,20 +93,29 @@ module.exports = (config) => {
 
   /**
    * Show an error with the correct page
+   * @param req
    * @param resPath - the page of the original error
    * @param code - error code
    * @param res
    */
-  const showError = (resPath, code, res) => {
+  const showError = (req, resPath, code, res) => {
     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, path: resPath}, code);
     });
   };
 
+  app.use((req, res, next) => {
+    if (!host) {
+      host = 'http://' + req.headers.host;
+      console.log(cons.ok, 'Currently hosted on ' + host);
+    }
+    next();
+  });
+
   //log request at result end
   app.use((req, res, next) => {
     if (config['access_log']) {
@@ -123,7 +139,7 @@ module.exports = (config) => {
       if (err)
         showError(req.path, 404, res);
       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))});
     });
   });
 
@@ -148,7 +164,7 @@ module.exports = (config) => {
           });
         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);
     }
@@ -207,7 +223,7 @@ module.exports = (config) => {
               console.log(cons.error, `no template found at ${templatePath}`);
               showError(req.path, 500, res);
             } else
-              render(res, templatePath, {article: article});
+              render(req, res, templatePath, {article: article});
           });
         });
       }
@@ -225,7 +241,7 @@ module.exports = (config) => {
   });
 
   // serve all static files via get
-  app.get('*', express.static(config['data_dir']));
+  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);

src/config.default.json

@@ -1,5 +1,6 @@
 {
   "node_port": 3000,
+  "host": "",
   "data_dir": "data",
   "view_engine": "ejs",
   "access_log": "access.log",
@@ -8,9 +9,12 @@
     "rss": true,
     "webhook": true,
     "prism": true,
-    "mathjax": true
+    "mathjax": true,
+    "plantuml": true
   },
   "home": {
+    "title": "GitBlog.md",
+    "description": "A static blog using Markdown pulled from your git repository",
     "index": "index.ejs",
     "error": "error.ejs",
     "hidden": [
@@ -34,7 +38,7 @@
     "endpoint": "/webhook",
     "secret": "",
     "signature_header": "",
-    "pull_command": "git pull"
+    "pull_command": "git pull origin master"
   },
   "showdown": {
     "parseImgDimensions": true,
@@ -47,5 +51,8 @@
   "mathjax": {
     "output_format": "svg",
     "speak_text": true
+  },
+  "plantuml": {
+    "output_format": "svg"
   }
 }

src/config.js

@@ -10,6 +10,10 @@ const fs = require('fs');
 const merge = (ref, src) => {
   if (typeof ref !== typeof src) {
     return ref;
+  } else if (ref.length && !src.length) {
+    return ref;
+  } else if (ref.length && src.length) {
+    return src;
   } else if (typeof ref === 'object') {
     const out = {};
     Object.keys(ref).forEach((key) => out[key] = merge(ref[key], src[key]));

src/renderer.js

@@ -1,4 +1,5 @@
 const fs = require('fs');
+const path = require('path');
 const showdown = require('showdown');
 
 module.exports = (config) => {
@@ -21,12 +22,27 @@ module.exports = (config) => {
     while ((match = codeRegex.exec(data))) {
       const lang = match[1].trim();
       const code = match[2].trim();
-      try {
-        const block = Prism.highlight(code, Prism.languages[lang] || Prism.languages.autoit, lang);
-        data = data.slice(0, match.index) + `<pre><code class="${lang} language-${lang}">` + block + '</code></pre>' + data.slice(match.index + match[0].length);
-      } catch (err) {
-        console.error(err);
-      }
+      const block = Prism.highlight(code, Prism.languages[lang] || Prism.languages.autoit, lang);
+      data = data.slice(0, match.index) + `<pre><code class="${lang} language-${lang}">` + block + '</code></pre>' + data.slice(match.index + match[0].length);
+    }
+    cb(data);
+  };
+
+  if (config['modules']['plantuml']) {
+    require('./script_loader')(path.join(__dirname, 'lib', 'plantuml_synchro.js'));
+  }
+
+  const renderPlantUML = (data, cb) => {
+    if (!config['modules']['plantuml'])
+      return cb(data);
+    const umlRegex = /@startuml\r?\n((?:(?!@enduml)[\s\S])*)\r?\n@enduml/m;
+    let match;
+    while ((match = umlRegex.exec(data))) {
+      const code = match[1].trim();
+      const s = unescape(encodeURIComponent(code)); // jshint ignore:line
+      const compressed = global['zip_deflate'](s);
+      const url = `http://www.plantuml.com/plantuml/${config['plantuml']['output_format']}/${encode64(compressed)}`;// jshint ignore:line
+      data = data.slice(0, match.index) + `<img alt="generated PlantUML diagram" src="${url}">` + data.slice(match.index + match[0].length);
     }
     cb(data);
   };
@@ -81,16 +97,19 @@ module.exports = (config) => {
   return {
     renderShowDown: config['test'] ? renderShowDown : undefined,
     renderPrism: config['test'] ? renderPrism : undefined,
+    renderPlantUML: config['test'] ? renderPlantUML : undefined,
     renderMathJax: config['test'] ? renderMathJax : undefined,
     render: (file, cb) => {
       fs.readFile(file, {encoding: 'UTF-8'}, (err, data) => {
         if (err)
           return cb(err);
 
-        renderPrism(data, (data2) => {
-          renderMathJax(data2, (data3) => {
-            renderShowDown(data3, (html) => {
-              cb(null, html);
+        renderPrism(data, (data) => {
+          renderPlantUML(data, (data) => {
+            renderMathJax(data, (data) => {
+              renderShowDown(data, (html) => {
+                cb(null, html);
+              });
             });
           });
         });

src/script_loader.js

@@ -0,0 +1,10 @@
+const fs = require('fs');
+
+/**
+ * Import client-side script into the "global" var
+ * @param scriptPath
+ */
+module.exports = (scriptPath) => {
+  eval.call(global, fs.readFileSync(scriptPath, {encoding: 'UTF-8'}));
+};
+

test/app.test.js

@@ -175,11 +175,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) => {
@@ -385,9 +393,10 @@ describe('Test static files', () => {
     });
   });
   test('200 valid file', (done) => {
-    fs.writeFileSync(path.join(dataDir, 'somefile.txt'), 'filecontent');
-    request(app).get('/somefile.txt').then((response) => {
+    fs.writeFileSync(path.join(dataDir, 'somefile.css'), 'filecontent');
+    request(app).get('/somefile.css').then((response) => {
       expect(response.statusCode).toBe(200);
+      expect(response.type).toBe('text/css');
       expect(response.text).toBe('filecontent');
       done();
     });

test/config.test.js

@@ -65,3 +65,17 @@ test('wrong config fixed', () => {
   expect(config['node_port']).toBe(3000);
   expect(config['data_dir']).toBe('data2');
 });
+
+test('array parsing', () => {
+  fs.writeFileSync(configFile, '{"home":{"hidden":["item1","item2"]}}');
+  const config = require('../src/config')();
+  expect(config).toBeDefined();
+  expect(config['home']['hidden']).toEqual(['item1', 'item2']);
+});
+
+test('array fix', () => {
+  fs.writeFileSync(configFile, '{"home":{"hidden":{}}}');
+  const config = require('../src/config')();
+  expect(config).toBeDefined();
+  expect(config['home']['hidden']).toEqual(['.ejs']);
+});

test/renderer.test.js

@@ -10,7 +10,8 @@ const config = {
   'test': true,
   'modules': {
     'prism': true,
-    'mathjax': true
+    'mathjax': true,
+    'plantuml': true
   },
   'showdown': {
     'simplifiedAutoLink': true,
@@ -19,6 +20,9 @@ const config = {
   'mathjax': {
     'output_format': 'html',
     'speak_text': false
+  },
+  'plantuml': {
+    'output_format': 'svg'
   }
 };
 
@@ -27,6 +31,7 @@ const renderer = require('../src/renderer')(config);
 beforeEach(() => {
   config['modules']['prism'] = true;
   config['modules']['mathjax'] = true;
+  config['modules']['plantuml'] = true;
   utils.deleteFolderSync(dataDir);
   fs.mkdirSync(dataDir);
 });
@@ -91,6 +96,31 @@ describe('Test Prism', () => {
   });
 });
 
+describe('Test PlantUML', () => {
+  test('no plantuml', (done) => {
+    config['modules']['plantuml'] = false;
+    renderer.renderPlantUML('@startuml\nBob -> Alice : hello\n@enduml', (data) => {
+      expect(data).toBe('@startuml\nBob -> Alice : hello\n@enduml');
+      done();
+    });
+  });
+
+  test('plantuml correct', (done) => {
+    renderer.renderPlantUML('@startuml\nBob -> Alice : hello\n@enduml', (data) => {
+      expect(data).toBe('<img alt="generated PlantUML diagram" src="http://www.plantuml.com/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000">');
+      done();
+    });
+  });
+
+  test('plantuml multiple uml', (done) => {
+    renderer.renderPlantUML('@startuml\nBob -> Alice : hello\n@enduml\n@startuml\nBob -> Alice : hello\n@enduml', (data) => {
+      expect(data).toBe('<img alt="generated PlantUML diagram" src="http://www.plantuml.com/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000">\n<img alt="generated PlantUML diagram" src="http://www.plantuml.com/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000">');
+      done();
+    });
+  });
+});
+
+
 describe('Test MathJax', () => {
   test('no mathjax', (done) => {
     config['modules']['mathjax'] = false;

test/script_loader.test.js

@@ -0,0 +1,51 @@
+/* jshint -W117 */
+const fs = require('fs');
+const path = require('path');
+const utils = require('./test_utils');
+
+const dataDir = 'test_data';
+
+beforeEach(() => {
+  utils.deleteFolderSync(dataDir);
+  fs.mkdirSync(dataDir);
+});
+
+afterAll(() => {
+  if (fs.existsSync(dataDir)) {
+    utils.deleteFolderSync(dataDir);
+  }
+});
+
+test('load 1 script', () => {
+  const file = path.join(dataDir, 'test.js');
+  fs.writeFileSync(file, `
+           var a = 5;
+           function b(){
+            return a;
+           }`);
+  require('../src/script_loader')(file);
+  expect(global['b']).toBeDefined();
+  expect(global['b']()).toBe(5);
+});
+
+test('load 2 script', () => {
+  const file1 = path.join(dataDir, 'test.js');
+  fs.writeFileSync(file1, `
+           var a = 5;
+           function b(){
+            return a;
+           }`);
+  const file2 = path.join(dataDir, 'test2.js');
+  fs.writeFileSync(file2, `
+           var a = 9;
+           function b(){
+            return a;
+           }`);
+  require('../src/script_loader')(file1);
+  expect(global['b']).toBeDefined();
+  expect(global['b']()).toBe(5);
+
+  require('../src/script_loader.js')(file2);
+  expect(global['b']).toBeDefined();
+  expect(global['b']()).toBe(9);
+});