(function() { var template = require('underscore/template'), fs = require('fs'); template.settings.evaluate = /<\?js([\s\S]+?)\?>/g; template.settings.interpolate = /<\?js=([\s\S]+?)\?>/g; /** @global @param {TAFFY} data See . @param {object} opts */ publish = function(data, opts) { var out = '', containerTemplate = template.render(fs.read(BASEDIR + 'templates/default/tmpl/container.tmpl')); function render(tmpl, partialData) { var renderFunction = arguments.callee.cache[tmpl]; if (!renderFunction) { renderFunction = arguments.callee.cache[tmpl] = template.render(fs.read(BASEDIR + 'templates/default/tmpl/'+tmpl)); } partialData.render = arguments.callee; partialData.find = find; partialData.linkto = linkto; partialData.htmlsafe = htmlsafe; return renderFunction.call(partialData, partialData); } render.cache = {}; function find(spec) { return data.get( data.find(spec) ); } function htmlsafe(str) { return str.replace(/'+htmlsafe(returnTypes.length? ' ⇒ '+returnTypes.join('|') : '')+''; } function addSignatureType(f) { var types = []; if (f.type && f.type.names) { types = f.type.names; } f.signature = (f.signature || '') + ''+htmlsafe(types.length? ' :'+types.join('|') : '')+''; } function addAttribs(f) { var attribs = []; if (f.access && f.access !== 'public') { attribs.push(f.access); } if (f.scope && f.scope !== 'instance') { if (f.kind == 'function' || f.kind == 'property') attribs.push(f.scope); } if (f.readonly === true) { if (f.kind == 'property') attribs.push('readonly'); } f.attribs = ''+htmlsafe(attribs.length? '<'+attribs.join(', ')+'> ' : '')+''; } data.remove({undocumented: true}); var packageInfo = (data.get( data.find({kind: 'package'}) ) || []) [0]; function renderLinks(text) { text = text.replace(/\{@link (\S+)\}/g, function(match, longname) { var link = linkto(longname); return link; }); return text; } data.forEach(function(doclet) { doclet.signature = ''; doclet.attribs = ''; if (doclet.kind === 'function' || doclet.kind === 'class') { addSignatureParams(doclet); addSignatureReturns(doclet); addAttribs(doclet); } if (doclet.kind === 'property') { addSignatureType(doclet); addAttribs(doclet) } if (doclet.examples) { doclet.examples = doclet.examples.map(function(example) { var caption, code; if (example.match(/^\s*([\s\S]+?)<\/caption>(\s*[\n\r])([\s\S]+)$/i)) { caption = RegExp.$1; code = RegExp.$3; } return { caption: caption || '', code: code || example }; }); } }); data.orderBy(['longname', 'version', 'since']); // kinds of containers var globals = data.get( data.find({kind: ['property', 'function'], memberof: {isUndefined: true}}) ), modules = data.get( data.find({kind: 'module'}) ), namespaces = data.get( data.find({kind: 'namespace'}) ); var outdir = opts.destination; if (packageInfo) { outdir += '/' + packageInfo.name + '/' + packageInfo.version + '/'; } fs.mkPath(outdir); // copy static files to outdir var fromDir = BASEDIR + 'templates/default/static', staticFiles = fs.ls(fromDir, 3); staticFiles.forEach(function(fileName) { var toDir = fs.toDir(fileName.replace(fromDir, outdir)); fs.mkPath(toDir); fs.copyFile(fileName, toDir); }); function linkto(longname, linktext) { var url = longnameToUrl[longname]; return url? ''+(linktext || longname)+'' : (linktext || longname); } var containers= ['class', 'module', 'namespace'], urlToLongname = {}, longnameToUrl = {}; data.forEach(function(doclet) { if (doclet.memberof && containers.indexOf(doclet.kind) < 0) { var longname = doclet.longname, urlSafe = doclet.memberof.replace(/[^$a-z0-9._-]/gi, '_'), // TODO handle name collisions url = urlSafe + '.html#'+doclet.name; } else { var longname = doclet.longname, urlSafe = longname.replace(/[^$a-z0-9._-]/gi, '_'), // TODO handle name collisions url = urlSafe + '.html'; } // bidirectional lookups: url <=> longname urlToLongname[urlSafe] = longname; longnameToUrl[longname] = url; }); // do this after the urls have all been generated data.forEach(function(doclet) { if (doclet.classdesc) doclet.classdesc = renderLinks(doclet.classdesc); if (doclet.description) doclet.description = renderLinks(doclet.description); doclet.ancestors = generateAncestry(doclet); }); var nav = '', seen = {}; var moduleNames = data.get( data.find({kind: 'module'}) ); if (moduleNames.length) { nav = nav + '

Modules

'; } var namespaceNames = data.get( data.find({kind: 'namespace'}) ); if (namespaceNames.length) { nav = nav + '

Namespaces

'; } var classNames = data.get( data.find({kind: 'class'}) ); if (classNames.length) { nav = nav + '

Classes

'; } for (var longname in longnameToUrl) { var classes = data.get( data.find({kind: 'class', longname: longname}) ); if (classes.length) generate('Class: '+classes[0].name, classes, longnameToUrl[longname]); var modules = data.get( data.find({kind: 'module', longname: longname}) ); if (modules.length) generate('Module: '+modules[0].name, modules, longnameToUrl[longname]); var namespaces = data.get( data.find({kind: 'namespace', longname: longname}) ); if (namespaces.length) generate('Namespace: '+namespaces[0].name, namespaces, longnameToUrl[longname]); } function generate(title, docs, filename) { var data = { title: title, docs: docs, nav: nav, // helpers render: render, find: find, linkto: linkto, htmlsafe: htmlsafe }; var path = outdir + '/' + filename, html = containerTemplate.call(data, data); fs.write(path, html) } } })();