diff options
Diffstat (limited to 'lib/generate/index.js')
| -rw-r--r-- | lib/generate/index.js | 374 |
1 files changed, 0 insertions, 374 deletions
diff --git a/lib/generate/index.js b/lib/generate/index.js deleted file mode 100644 index de1fc0e..0000000 --- a/lib/generate/index.js +++ /dev/null @@ -1,374 +0,0 @@ -var Q = require("q"); -var _ = require("lodash"); -var path = require("path"); -var tmp = require('tmp'); - -var swig = require('./template'); -var fs = require("./fs"); -var parse = require("../parse"); -var Plugin = require("./plugin"); -var defaultConfig = require("./config"); - -var generators = { - "site": require("./site"), - "page": require("./page"), - "ebook": require("./ebook"), - "json": require("./json") -}; - -var defaultDescription = "Book generated using GitBook"; - - -var containsFiles = function(dir, files) { - return Q.all(_.map(files, function(file) { - return fs.exists(path.join(dir, file)); - })) - .then(_.all); -}; - -// Test if generator exists -var checkGenerator = function(options) { - if (!generators[options.generator]) { - return Q.reject(new Error("Invalid generator (availables are: "+_.keys(generators).join(", ")+")")); - } - return Q(); -}; - -// Create the generator and load plugins -var loadGenerator = function(options) { - return checkGenerator(options) - .then(function() { - var generator = new generators[options.generator](options); - - return generator.load() - .then(_.constant(generator)); - }); -}; - - - -var generate = function(options) { - // Read config file - return defaultConfig.read(options) - .then(function(_options) { - options = _options; - - // Validate options - if (!options.input) { - return Q.reject(new Error("Need option input (book input directory)")); - } - - // Check files to get folder type (book, multilanguage book or neither) - return checkGenerator(options); - }) - - // Read readme - .then(function() { - return fs.readFile(path.join(options.input, "README.md"), "utf-8") - .then(function(_readme) { - _readme = parse.readme(_readme); - - options.title = options.title || _readme.title; - options.description = options.description || _readme.description || defaultDescription; - }); - }) - - // Detect multi-languages book - .then(function() { - return containsFiles(options.input, ['LANGS.md']) - }) - - .then(function(isMultiLang) { - // Multi language book - if(isMultiLang) { - return generateMultiLang(options); - } - - // Book - return generateBook(options); - }); -}; - -/* - * Generate a multilanguage book by generating a book for each folder. - */ -var generateMultiLang = function(options) { - var langsSummary; - options.output = options.output || path.join(options.input, "_book"); - - return checkGenerator(options) - - // Multi-languages book - .then(function() { - return fs.readFile(path.join(options.input, "LANGS.md"), "utf-8") - }) - - // Clean output folder - .then(function(_langsSummary) { - langsSummary = _langsSummary; - return fs.remove(options.output); - }) - .then(function() { - return fs.mkdirp(options.output); - }) - - // Generate sub-books - .then(function() { - options.langsSummary = parse.langs(langsSummary); - - // Generated a book for each valid entry - return _.reduce(options.langsSummary.list, function(prev, entry) { - return prev.then(function() { - return generate(_.extend({}, options, { - input: path.join(options.input, entry.path), - output: path.join(options.output, entry.path), - originalInput: options.input, - originalOutput: options.output - })); - }) - }, Q()); - }) - - .then(function() { - return loadGenerator(options); - }) - - // Generate languages index - .then(function(generator) { - return generator.langsIndex(options.langsSummary); - }) - - // Copy cover file - .then(function() { - return Q.all([ - fs.copy(path.join(options.input, "cover.jpg"), path.join(options.output, "cover.jpg")), - fs.copy(path.join(options.input, "cover_small.jpg"), path.join(options.output, "cover_small.jpg")) - ]) - .fail(function() { - return Q(); - }) - }) - - // Return options to caller - .then(_.constant(options)); -}; - -/* - * Use a specific generator to convert a gitbook to a site/pdf/ebook/ - * output is always a folder - */ -var generateBook = function(options) { - var files; - - options.output = options.output || path.join(options.input, "_book"); - - // Check if it's a book - return containsFiles(options.input, ['SUMMARY.md', 'README.md']) - - // Fail if not a book - .then(function(isBook) { - if(!isBook) { - return Q.reject(new Error("Invalid gitbook repository, need SUMMARY.md and README.md")); - } - }) - - // Clean output folder - .then(function() { - return fs.remove(options.output); - }) - - .then(function() { - return fs.mkdirp(options.output); - }) - - // List all files in the repository - .then(function() { - return fs.list(options.input) - .then(function(_files) { - files = _files; - }); - }) - - .then(function() { - return loadGenerator(options); - }) - - // Convert files - .then(function(generator) { - // Generate the book - return Q() - - // Get summary - .then(function() { - var summary = { - path: path.join(options.input, "SUMMARY.md") - }; - - var _callHook = function(name) { - return generator.callHook(name, summary) - .then(function(_summary) { - summary = _summary; - return summary; - }); - }; - - return fs.readFile(summary.path, "utf-8") - .then(function(_content) { - summary.content = _content; - return _callHook("summary:before"); - }) - .then(function() { - summary.content = parse.summary(summary.content); - return _callHook("summary:after"); - }) - .then(function() { - options.summary = summary.content; - options.navigation = parse.navigation(options.summary); - }); - }) - - // Read glossary - .then(function() { - var glossary = {}; - - var _callHook = function(name) { - return generator.callHook(name, glossary) - .then(function(_glossary) { - glossary = _glossary; - return glossary; - }); - }; - - return fs.readFile(path.join(options.input, "GLOSSARY.md"), "utf-8") - .fail(function() { - return ""; - }) - .then(function(_content) { - glossary.content = _content; - return _callHook("glossary:before"); - }) - .then(function() { - glossary.content = parse.glossary(glossary.content); - return _callHook("glossary:after"); - }) - .then(function() { - options.glossary = glossary.content; - }); - }) - - // Skip processing some files - .then(function() { - files = _.filter(files, function (file) { - return !( - file === 'SUMMARY.md' || - file === 'GLOSSARY.md' - ); - }); - }) - - // Copy file and replace markdown file - .then(function() { - return Q.all( - _.chain(files) - .map(function(file) { - if (!file) return; - - if (file[file.length -1] == "/") { - return Q(generator.transferFolder(file)); - } else if (path.extname(file) == ".md" && options.navigation[file] != null) { - return fs.readFile(path.join(options.input, file), "utf-8") - .then(function(content) { - return Q(generator.convertFile(content, file)); - }); - } else { - return Q(generator.transferFile(file)); - } - }) - .value() - ); - }) - - // Finish generation - .then(function() { - return generator.callHook("finish:before"); - }) - .then(function() { - return generator.finish(); - }) - .then(function() { - return generator.callHook("finish"); - }); - }) - - // Return all options - .then(function() { - return options; - }); -}; - -/* - * Extract files from generate output in a temporary folder - */ -var generateFile = function(options) { - options = _.defaults(options || {}, { - input: null, - output: null, - extension: null - }); - - return Q.nfcall(tmp.dir) - .then(function(tmpDir) { - return generate( - _.extend({}, - options, - { - output: tmpDir - }) - ) - .then(function(_options) { - var ext = options.extension; - var outputFile = options.output || path.resolve(options.input, "book."+ext); - - var copyFile = function(lang) { - var _outputFile = outputFile; - var _tmpDir = tmpDir; - - if (lang) { - _outputFile = _outputFile.slice(0, -path.extname(_outputFile).length)+"_"+lang+path.extname(_outputFile); - _tmpDir = path.join(_tmpDir, lang); - } - - return fs.copy( - path.join(_tmpDir, "index."+ext), - _outputFile - ); - }; - - // Multi-langs book - return Q() - .then(function() { - if (_options.langsSummary) { - return Q.all( - _.map(_options.langsSummary.list, function(lang) { - return copyFile(lang.lang); - }) - ); - } else { - return copyFile(); - } - }) - .then(function() { - return fs.remove(tmpDir); - }); - }); - }); -}; - -module.exports = { - generators: generators, - folder: generate, - file: generateFile, - book: generateBook, - Plugin: Plugin, - config: defaultConfig -}; |