Merge pull request #16 from Klemek/dev

v1.2.5

README.md

@@ -127,6 +127,10 @@ Resources are located on the `data` folder and can be referenced as the root of
 
 In your template, the following data is sent :
 
+<details>
+<summary>details (click)</summary>
+<p>
+
 * `info`  (every pages)
   * `title` :  the blog's title as in the config
   * `description` the blog's description as in the config
@@ -146,6 +150,8 @@ In your template, the following data is sent :
   * `realPath` : the system's path for the folder
   * `escapedTitle` : the code with alphanumeric and underscore characters only
 * `error` (error pages only) : the error code
+</p>
+</details>
 
 #### 5. Create and init your git source
 
@@ -280,11 +286,13 @@ Any URL like `/year/month/day/anything/` will redirect to this article (and link
    * `error` (default: error.ejs)  
      the name of the error page template on the data directory  
      it will receive `error`, the error code
-   * `hidden` (default: `[.ejs]`)  
-     file extensions to be returned 404 when reached
+   * `hidden` (default: `[*.ejs,/.git*]`)  
+     path matches to be returned 404 when reached
 * `article`
    * `index` (default: index.md)  
      the name of the Markdown page of the article on the `/year/month/day/` directory
+   * `draft` (default: draft.md)  
+     the name of the Markdown page of an article not shown on the list
    * `template` (default: template.ejs)  
      the name of the article page template on the data directory
    * `thumbnail_tag`: (default: thumbnail)  

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitblog.md",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "A static blog using Markdown pulled from your git repository.",
   "main": "src/server.js",
   "dependencies": {

src/app.js

@@ -69,8 +69,9 @@ module.exports = (config) => {
       Object.keys(articles).forEach((key) => delete articles[key]);
       Object.keys(dict).forEach((key) => articles[key] = dict[key]);
       const nb = Object.keys(articles).length;
+      const dnb = Object.values(articles).filter(a => a.draft).length;
       if (nb > 0)
-        console.log(cons.ok, `loaded ${nb} article${nb > 1 ? 's' : ''}`);
+        console.log(cons.ok, `loaded ${nb} article${nb > 1 ? 's' : ''} (${dnb} drafted)`);
       else
         console.log(cons.warn, `no articles loaded, check your configuration`);
 
@@ -144,7 +145,11 @@ module.exports = (config) => {
       if (err)
         showError(req, res, 404);
       else
-        render(req, res, homePath, {articles: Object.values(articles).sort((a, b) => ('' + b.path).localeCompare(a.path))});
+        render(req, res, homePath,
+          {
+            articles: Object.values(articles)
+              .filter(d => !d.draft).sort((a, b) => ('' + b.path).localeCompare(a.path))
+          });
     });
   });
 
@@ -216,7 +221,7 @@ module.exports = (config) => {
       if (!article)
         showError(req, res, 404);
       else {
-        renderer.render(path.join(article.realPath, config['article']['index']), (err, html) => {
+        renderer.render(article.realPath, (err, html) => {
           if (err) {
             console.log(cons.error, `failed to render article ${req.path} : ${err}`);
             return showError(req, res, 500);

src/config.default.json

@@ -24,6 +24,7 @@
   },
   "article": {
     "index": "index.md",
+    "draft": "draft.md",
     "template": "template.ejs",
     "thumbnail_tag": "thumbnail",
     "default_title": "Untitled",

src/file_walker.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 
-const joinUrl = (...paths) => path.join(...paths).replace(/\\/g,'/');
+const joinUrl = (...paths) => path.join(...paths).replace(/\\/g, '/');
 
 /**
  * Get all files path inside a given folder path
@@ -71,8 +71,8 @@ module.exports = (config) => {
         if (err)
           return cb(err);
         const paths = fileList
-          .map((p) => p.substr(config['data_dir'].length+1).split(path.sep))
-          .filter((p) => p.length === 4 && p[3] === config['article']['index'] &&
+          .map((p) => p.substr(config['data_dir'].length + 1).split(path.sep))
+          .filter((p) => p.length === 4 && (p[3] === config['article']['index'] || p[3] === config['article']['draft']) &&
             /^\d{4}$/.test(p[0]) && /^\d{2}$/.test(p[1]) && /^\d{2}$/.test(p[2]));
         if (paths.length === 0)
           cb(null, {});
@@ -81,7 +81,8 @@ module.exports = (config) => {
         paths.forEach((p) => {
           const article = {
             path: joinUrl(p[0], p[1], p[2]),
-            realPath: path.join(config['data_dir'], p[0], p[1], p[2]),
+            draft: p[3] === config['article']['draft'],
+            realPath: path.join(config['data_dir'], p[0], p[1], p[2], p[3]),
             year: parseInt(p[0]),
             month: parseInt(p[1]),
             day: parseInt(p[2])
@@ -89,14 +90,15 @@ module.exports = (config) => {
           article.date = new Date(article.year, article.month, article.day);
           article.date.setUTCHours(0);
           remaining++;
-          readIndexFile(path.join(article.realPath, config['article']['index']), config['article']['thumbnail_tag'], (err, info) => {
+          readIndexFile(article.realPath, config['article']['thumbnail_tag'], (err, info) => {
             if (err)
               return cb(err);
             article.title = info.title || config['article']['default_title'];
             article.thumbnail = info.thumbnail ? joinUrl(article.path, info.thumbnail) : config['article']['default_thumbnail'];
             article.escapedTitle = article.title.toLowerCase().replace(/[^\w]/gm, ' ').trim().replace(/ /gm, '_');
             article.url = '/' + joinUrl(article.path, article.escapedTitle) + '/';
-            articles[article.path] = article;
+            if (!articles[article.path] || !article.draft)
+              articles[article.path] = article;
             remaining--;
             if (remaining === 0)
               cb(null, articles);

test/app.test.js

@@ -121,10 +121,10 @@ describe('Test root path', () => {
     });
   });
   test('404 no index but error page', (done) => {
-    fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %> at <%= path %>');
+    fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>');
     request(app).get('/').then((response) => {
       expect(response.statusCode).toBe(404);
-      expect(response.text).toBe('error 404 at /');
+      expect(response.text).toBe('error 404');
       done();
     });
   });
@@ -160,14 +160,17 @@ describe('Test root path', () => {
       done();
     });
   });
-  test('200 2 articles', (done, fail) => {
+  test('200 2 articles 1 drafted', (done, fail) => {
     utils.createEmptyDirs([
       path.join(dataDir, '2019', '05', '05'),
-      path.join(dataDir, '2018', '05', '05')
+      path.join(dataDir, '2018', '05', '05'),
+      path.join(dataDir, '2017', '05', '05')
     ]);
     utils.createEmptyFiles([
-      path.join(dataDir, '2019', '05', '05', 'index.md'),
-      path.join(dataDir, '2018', '05', '05', 'index.md')
+      path.join(dataDir, '2019', '05', '05', 'draft.md'),
+      path.join(dataDir, '2018', '05', '05', 'index.md'),
+      path.join(dataDir, '2018', '05', '05', 'draft.md'),
+      path.join(dataDir, '2017', '05', '05', 'index.md'),
     ]);
     fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= articles.length %>');
     app.reload(() => {
@@ -319,12 +322,11 @@ describe('Test articles rendering', () => {
     });
   });
 
-  test('500 no index', (done, fail) => {
+  test('500 fail to render', (done, fail) => {
     utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
     fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'index.md'), '# Hello');
-    fs.writeFileSync(path.join(dataDir, testTemplate), '<%- article.content %><%- `<a href="${article.url}">reload</a>` %>');
+    fs.writeFileSync(path.join(dataDir, testTemplate), '<%- articl.content %><%- `<a href="${article.url}">reload</a>` %>');
     app.reload(() => {
-      config['article']['index'] = 'invalid.md';
       request(app).get('/2019/05/05/hello/').then((response) => {
         expect(response.statusCode).toBe(500);
         done();
@@ -356,6 +358,19 @@ describe('Test articles rendering', () => {
     }, fail);
   });
 
+  test('200 rendered draft', (done, fail) => {
+    utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
+    fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'draft.md'), '# Hello');
+    fs.writeFileSync(path.join(dataDir, testTemplate), '<%- article.content %><%- `<a href="${article.url}">reload</a>` %>');
+    app.reload(() => {
+      request(app).get('/2019/05/05/hello/').then((response) => {
+        expect(response.statusCode).toBe(200);
+        expect(response.text).toBe('<h1 id="hello">Hello</h1><a href="/2019/05/05/hello/">reload</a>');
+        done();
+      });
+    }, fail);
+  });
+
   test('200 other url', (done, fail) => {
     utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
     utils.createEmptyFiles([
@@ -394,10 +409,10 @@ describe('Test static files', () => {
     });
   });
   test('404 invalid file but error page', (done) => {
-    fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %> at <%= path %>');
+    fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>');
     request(app).get('/somefile.txt').then((response) => {
       expect(response.statusCode).toBe(404);
-      expect(response.text).toBe('error 404 at /somefile.txt');
+      expect(response.text).toBe('error 404');
       done();
     });
   });

test/file_walker.test.js

@@ -6,13 +6,14 @@ const utils = require('./test_utils');
 const dataDir = 'test_data';
 const testIndex = 'testindex.md';
 
-const joinUrl = (...paths) => path.join(...paths).replace(/\\/g,'/');
+const joinUrl = (...paths) => path.join(...paths).replace(/\\/g, '/');
 
 const config = {
   'test': true,
   'data_dir': dataDir,
   'article': {
     'index': testIndex,
+    'draft': 'draft.md',
     'default_title': 'Untitled',
     'default_thumbnail': 'default.png',
     'thumbnail_tag': 'thumbnail'
@@ -235,9 +236,10 @@ describe('Test article fetching', () => {
       expect(Object.keys(dict).length).toBe(1);
       expect(dict[joinUrl('2019', '05', '05')]).toEqual({
         path: joinUrl('2019', '05', '05'),
-        realPath: dir,
+        realPath: file,
         year: 2019,
         month: 5,
+        draft: false,
         day: 5,
         date: date,
         title: 'Untitled',
@@ -265,10 +267,11 @@ describe('Test article fetching', () => {
       expect(Object.keys(dict).length).toBe(1);
       expect(dict[joinUrl('2019', '05', '05')]).toEqual({
         path: joinUrl('2019', '05', '05'),
-        realPath: dir,
+        realPath: file,
         year: 2019,
         month: 5,
         day: 5,
+        draft: false,
         date: date,
         title: 'Title with : info !',
         thumbnail: joinUrl('2019', '05', '05', './thumbnail.jpg'),
@@ -278,5 +281,64 @@ describe('Test article fetching', () => {
       done();
     });
   });
+  test('correct draft file', (done) => {
+    const dir = path.join(dataDir, '2019', '05', '05');
+    const file = path.join(dir, 'draft.md');
+    utils.createEmptyDirs([dir]);
+    fs.writeFileSync(file, `
+           # Title with : info !
+           ![thumbnail](./thumbnail.jpg)
+           this is some text
+           `);
+    const date = new Date(2019, 5, 5);
+    date.setUTCHours(0);
+    fw.fetchArticles((err, dict) => {
+      expect(err).toBeNull();
+      expect(dict).toBeDefined();
+      expect(Object.keys(dict).length).toBe(1);
+      expect(dict[joinUrl('2019', '05', '05')]).toEqual({
+        path: joinUrl('2019', '05', '05'),
+        realPath: file,
+        year: 2019,
+        month: 5,
+        day: 5,
+        draft: true,
+        date: date,
+        title: 'Title with : info !',
+        thumbnail: joinUrl('2019', '05', '05', './thumbnail.jpg'),
+        escapedTitle: 'title_with___info',
+        url: '/' + joinUrl('2019', '05', '05', 'title_with___info') + '/',
+      });
+      done();
+    });
+  });
+  test('index file override draft', (done) => {
+    const dir = path.join(dataDir, '2019', '05', '05');
+    const file = path.join(dir, testIndex);
+    const file2 = path.join(dir, 'draft.md');
+    utils.createEmptyDirs([dir]);
+    utils.createEmptyFiles([file, file2]);
+    const date = new Date(2019, 5, 5);
+    date.setUTCHours(0);
+    fw.fetchArticles((err, dict) => {
+      expect(err).toBeNull();
+      expect(dict).toBeDefined();
+      expect(Object.keys(dict).length).toBe(1);
+      expect(dict[joinUrl('2019', '05', '05')]).toEqual({
+        path: joinUrl('2019', '05', '05'),
+        realPath: file,
+        year: 2019,
+        month: 5,
+        draft: false,
+        day: 5,
+        date: date,
+        title: 'Untitled',
+        thumbnail: 'default.png',
+        escapedTitle: 'untitled',
+        url: '/' + joinUrl('2019', '05', '05', 'untitled') + '/',
+      });
+      done();
+    });
+  });
 });