Merge pull request GitbookIO#356 from GitbookIO/feature/includes

Support importing code snippets

Author: SamyPesse

lib/parse/code_include.js

@@ -0,0 +1,20 @@
+var fs = require('fs');
+var path = require('path');
+
+module.exports = function(code, folder) {
+    folder = folder || '';
+
+    return code.replace(/{{([\s\S]+?)}}/g, function(match, filename) {
+        // Normalize filename
+        var fname = path.join(folder, filename.trim());
+
+        // Try including snippet from FS
+        try {
+            // Trim trailing newlines/space of imported snippets
+            return fs.readFileSync(fname, 'utf8').trimRight();
+        } catch(err) {}
+
+        // If fails leave content as is
+        return match;
+    });
+};

lib/parse/page.js

@@ -5,6 +5,7 @@ var hljs = require('highlight.js');
 var lex = require('./lex');
 var renderer = require('./renderer');
 
+var codeInclude = require('./code_include');
 var lnormalize = require('../utils/lang').normalize;
 
 
@@ -74,15 +75,20 @@ function parsePage(src, options) {
             // Main language
             var lang = validLangs ? langs[0] : null;
 
+            // codeInclude shortcut
+            var ci = function(code) {
+                return codeInclude(code, options.dir);
+            };
+
             return {
                 id: section.id,
                 type: section.type,
                 content: render(nonCodeNodes),
                 lang: lang,
                 code: {
-                    base: codeNodes[0].text,
-                    solution: codeNodes[1].text,
-                    validation: codeNodes[2].text,
+                    base: ci(codeNodes[0].text),
+                    solution: ci(codeNodes[1].text),
+                    validation: ci(codeNodes[2].text),
                     // Context is optional
                     context: codeNodes[3] ? codeNodes[3].text : null,
                 }

lib/parse/renderer.js

@@ -1,6 +1,7 @@
 var url = require('url');
 var inherits = require('util').inherits;
 var links = require('../utils').links;
+var codeInclude = require('./code_include');
 
 
 var path = require('path');
@@ -125,7 +126,7 @@ GitBookRenderer.prototype._createCheckboxAndRadios = function(text) {
     var length = splittedText.length;
     var label = '<label class="quiz-label" for="' + quizIdentifier + '">' + splittedText[length - 1] + '</label>';
     return text.replace(fieldRegex, field).replace(splittedText[length - 1], label);
-}
+};
 
 GitBookRenderer.prototype.tablecell = function(content, flags) {
     return GitBookRenderer.super_.prototype.tablecell(this._createCheckboxAndRadios(content), flags);
@@ -135,5 +136,15 @@ GitBookRenderer.prototype.listitem = function(text) {
     return GitBookRenderer.super_.prototype.listitem(this._createCheckboxAndRadios(text));
 };
 
+GitBookRenderer.prototype.code = function(code, lang, escaped) {
+    return GitBookRenderer.super_.prototype.code.call(
+        this,
+        // Import code snippets
+        codeInclude(code, this._extra_options.dir),
+        lang,
+        escaped
+    );
+};
+
 // Exports
 module.exports = GitBookRenderer;

test/fixtures/INCLUDES.md

@@ -0,0 +1,29 @@
+# Beautiful chapter
+
+Here is a nice included snippet :
+
+```c
+{{ included.c }}
+```
+
+----
+
+An exercise using includes
+
+```c
+{{ included.c }}
+
+Remove this extra code at the end
+```
+
+```c
+{{ included.c }}
+```
+
+```c
+{{ included.c }}
+
+This validation code is wrong but who cares ?
+```
+
+----

test/fixtures/included.c

@@ -0,0 +1,7 @@
+#include <stdio.h>
+
+int main(int argc, char *argv[]) {
+    printf("All is well\n");
+
+    return 0;
+}

test/includes.js

@@ -0,0 +1,38 @@
+var fs = require('fs');
+var path = require('path');
+var assert = require('assert');
+
+var page = require('../').parse.page;
+
+var FIXTURES_DIR = path.join(__dirname, './fixtures/');
+
+function loadPage (name, options) {
+    var CONTENT = fs.readFileSync(FIXTURES_DIR + name + '.md', 'utf8');
+    return page(CONTENT, options);
+}
+
+
+describe('Code includes', function() {
+
+    var LEXED = loadPage('INCLUDES', {
+        'dir': FIXTURES_DIR,
+    });
+
+    var INCLUDED_C = fs.readFileSync(path.join(FIXTURES_DIR, 'included.c'), 'utf8');
+
+    it('should work for snippets', function() {
+        assert.equal(LEXED[0].type, 'normal');
+        // Has replaced include
+        assert.equal(
+            LEXED[0].content.indexOf('{{ included.c }}'),
+            -1
+        );
+    });
+
+    it('should work for exercises', function() {
+        assert.equal(LEXED[1].type, 'exercise');
+
+        // Solution is trimmed version of source
+        assert.equal(LEXED[1].code.solution, INCLUDED_C.trim());
+    });
+});