adds a static compilation more for #6 - alpha

Author: wilzbach

bin/sniper

@@ -2,37 +2,64 @@
 
 var program = require('commander');
 var path = require('path');
+var join = path.join;
 var fs = require('fs');
 var cwd = process.cwd();
+var Minilog = require('minilog');
+
 var Server = require("..");
+var staticProg = require("../lib/static.js");
 
 program
   .version(JSON.parse(fs.readFileSync(__dirname + '/../package.json', 'utf8')).version)
   .usage('[options] [files]')
   .option('-p, --port <number>', 'port to run', 9090)
+  .option('-c, --compile', 'Creates static output', false)
   .option('-v, --verbose', 'Increase verbosity', false)
   .parse(process.argv);
 
 // default settings
 var options = {
-	config: "package.json",
-	templateDir: "templates",
-	snippets: "snippets",
+  config: "package.json",
+  templateDir: "templates",
+  snippets: "snippets",
+};
+// define templates
+options.templates = {
+  snip: "template.html",
+  list: "list.html",
+  all: "all.html"
 };
+var templates = options.templates;
+var templateDir = join(__dirname, "/../templates");
+for (var key in templates) {
+  templates[key] = join(templateDir, templates[key]);
+}
 
 // PARSE cli
 
-if(program.args.length === 0){
-	options.dirname = cwd;
+if (program.args.length === 0) {
+  options.dirname = cwd;
 } else {
-	options.dirname = program.args[0];	
+  options.dirname = program.args[0];
 }
 
 options.port = program.port;
 options.dirname = path.normalize(options.dirname);
-options.verbose = program.verbose;
 
-console.log("running: http://localhost:" + options.port);
-console.log("DIR:" + options.dirname);
+if (program.verbose) {
+  Minilog.enable();
+}
 
-var server = new Server(options);
+if (program.compile) {
+  console.log("WARNING: static compilation mode is in alpha - use with caution");
+  staticProg(options).then(function(){
+    console.log("=)");
+  }).error(function(){
+    console.log("error happened");
+  });
+} else {
+  console.log("running: http://localhost:" + options.port);
+  console.log("DIR:" + options.dirname);
+  var server = new Server(options);
+}

lib/index.js

@@ -24,10 +24,6 @@ module.exports = function(opts) {
     filename: filename
   };
 
-  if (opts.verbose) {
-    Minilog.enable();
-  }
-
   var log = Minilog("index");
 
   this.evt = new EventEmitter();
@@ -101,7 +97,8 @@ module.exports = function(opts) {
     router: router,
     parsed: deepcopy(self.parsed),
     evt: self.evt,
-    dirOpts: dirOpts
+    dirOpts: dirOpts,
+    templates: opts.templates
   });
 
   this.server.listen(this.port);

lib/routes.js

@@ -25,18 +25,7 @@ module.exports = function(opts) {
     self.parsed = config;
   });
 
-  // define templates
-  var templates = {
-    snip: "template.html",
-    list: "list.html",
-    all: "all.html"
-  };
-
-  var templateDir = join(__dirname, "/../templates");
-  for (var key in templates) {
-    templates[key] = join(templateDir, templates[key]);
-  }
-
+  var templates = opts.templates;
   var sniper = new Sniper({
     snippetFolder: this.parsed.snippetFolder
   });

lib/sniper.js

@@ -5,15 +5,15 @@ var swig = require('swig');
 var Minilog = require('minilog');
 var log = Minilog("sniper");
 
-var helper= require("biojs-util-snippets").helper;
+var helper = require("biojs-util-snippets").helper;
 
 module.exports = function(opts) {
 
   this.opts = opts;
   var self = this;
 
   // adds an optional slash to relative paths
-  function makeAbsolute(path) {
+  this.makeAbsolute = function(path) {
     var firstChar = path.charAt(0);
     // check whether it is http or https
     if (path.indexOf(":") >= 0) {
@@ -27,7 +27,7 @@ module.exports = function(opts) {
       return path.slice(1);
     }
     return "/" + path;
-  }
+  };
 
   // removes the extension and filters duplicates
   this.getSnippets = function() {
@@ -65,13 +65,14 @@ module.exports = function(opts) {
   // displays the script tags
   this.renderHead = function(snipTemplate, parsedD) {
     var template = swig.compileFile(snipTemplate);
-    if(parsedD.css){
-      parsedD.css = parsedD.css.map(makeAbsolute);
+    var css = {};
+    if (parsedD.css) {
+      css = parsedD.css.map(self.makeAbsolute);
     }
-    parsedD.js = parsedD.js.map(makeAbsolute);
+    var js = parsedD.js.map(self.makeAbsolute);
     var head = template({
-      css: parsedD.css,
-      scripts: parsedD.js
+      css: css,
+      scripts: js
     });
     return head;
   };
@@ -104,7 +105,7 @@ module.exports = function(opts) {
     var buffer = "";
 
     if (fs.existsSync(extraFile)) {
-      console.log("found extra config:", extraFile);
+      log.info("found extra config: " + extraFile);
       this.addJSON(extraFile, parsedD);
     }
 
@@ -126,7 +127,7 @@ module.exports = function(opts) {
       if (!htmlExists) {
         buffer += "(function(){\n";
         var mainVar = helper.findMainVar(jsContent);
-        log.debug("selected main var: "+ mainVar);
+        log.debug("selected main var: " + mainVar);
         buffer += "var " + mainVar + " = document.getElementById('" + divName + "');\n";
       }
       buffer += jsContent;

lib/static.js

@@ -0,0 +1,70 @@
+var q = require("bluebird");
+var fsp = q.promisifyAll(require("fs"));
+var path = require('path');
+var join = path.join;
+var minilog = require('minilog');
+var log = minilog("static");
+
+var readConfig = require('./read_config');
+var Sniper = require('./sniper');
+
+module.exports = function(opts) {
+
+  var dirname = opts.dirname || __dirname;
+  var self = this;
+
+  var filename = join(dirname, opts.config);
+  var dirOpts = {
+    dirname: dirname,
+    filename: filename
+  };
+  var templates = opts.templates;
+
+  var parsed = readConfig(dirOpts);
+  if (!parsed) {
+    console.log("invalid package.json - see https://github.com/biojs/biojs-sniper for more help");
+    process.exit(1);
+  }
+
+  var snippetFolder = parsed.snippetFolder;
+  var outputDir = opts.outputDir || snippetFolder + "-out";
+
+  fsp.mkdir(outputDir, function(err){
+    if(err.code !== "EEXIST"){
+      log.warn(err);
+    }
+  });
+
+  log.debug("opening snipper dir:" + snippetFolder);
+  log.debug("opening snipper out dir:" + outputDir);
+  var sniper = new Sniper({
+    snippetFolder: snippetFolder,
+  });
+
+  // custom absolute folder (one folder higher)
+  sniper.makeAbsolute = function(path) {
+    var firstChar = path.charAt(0);
+    // check whether it is http or https
+    if (path.indexOf(":") >= 0) {
+      return path;
+    }
+    // defined path
+    if (firstChar === "/") {
+      return ".." + path;
+    }
+    return "../" + path;
+  };
+
+  return fsp.readdirAsync(snippetFolder).filter(function(name) {
+    return name.indexOf(".js") >= 0;
+  }).map(function(name) {
+    var snippet = name.split(".")[0];
+    var buffer = sniper.buildSnippet(snippet, parsed);
+    var text = sniper.renderHead(templates.snip, parsed);
+    text += buffer;
+    return fsp.writeFileAsync(join(outputDir,snippet + ".html"), text, "utf8");
+  }).all().then(function(){
+    console.log("Have a look in " + outputDir);
+  });
+
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "biojs-sniper",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "Renders snippets on demand",
   "main": "lib/index.js",
   "bin": {