Merge bcd9090 into c9ac8c7

.gitignore

@@ -7,3 +7,5 @@
 *.peg.js
 .DS_STORE
 ._.DS_STORE
+/hashspace-gh-pages
+/docs/*.exe

build/grunt/docs.js

@@ -0,0 +1,295 @@
+var YAML = require('js-yaml');
+var express = require('express');
+
+
+var app = express();
+var yamlheadsep = /(\s*?\-+\s*\n)/g;
+
+
+module.exports = function(grunt) {
+  grunt.file.defaultEncoding = 'utf8';
+
+  var VERSION = grunt.config('pkg').version;
+
+  var GH_PAGES_PATH = './hashspace-gh-pages/';
+  var GH_PAGES_GLOB = [ GH_PAGES_PATH + '*' , '!README.md', '!CNAME', '!dist/*'];
+
+  var DOCS_PATH = "./docs/";
+
+  var DOCS_MD_GLOB = [ '**/*.md', '!samples/**/*.md' ],
+      DOCS_STATICS_GLOB = [
+        'css/**',
+        'images/*',
+        'libs/**',
+        'todomvc/**'
+      ],
+      DOCS_LESS_GLOB = [ '_css/*.less' ],
+      DOCS_PLAYGROUND_GLOB = [
+        'playground/**/*.js',
+        'playground/**/*.css',
+        'playground/**/*.hsp'
+      ],
+      DOCS_SAMPLES_GLOB = [ 'samples/**/*' ];
+
+
+  var pathifyFromDocs = function(path) { return DOCS_PATH + path; };
+
+  var WATCH_LESS_GLOB       = DOCS_LESS_GLOB.map(pathifyFromDocs),
+      WATCH_MARKDOWN_GLOB   = DOCS_MD_GLOB.map(pathifyFromDocs),
+      WATCH_SAMPLES_GLOB    = DOCS_SAMPLES_GLOB.map(pathifyFromDocs),
+      WATCH_PLAYGROUND_GLOB = DOCS_PLAYGROUND_GLOB.map(pathifyFromDocs);
+
+
+
+  // Less compilation
+
+  grunt.config.set('less', {
+    "docs": {
+      options: {
+        compress: true
+      },
+      files: [
+        {
+          expand: true,
+          cwd: DOCS_PATH,
+          src: DOCS_LESS_GLOB,
+          flatten: true,
+          dest: GH_PAGES_PATH + '/css',
+          ext: '.css'
+        }
+      ]
+    }
+  });
+
+
+  // Markadown Generation
+
+  function extractYamlHeader(src, context) {
+    var splits = src.split(yamlheadsep), yamlheader, markdown = src;
+    // we might have a yaml markdown header
+    if (splits.length > 1) {
+      grunt.verbose.writeln("");
+      grunt.verbose.write("Yaml header detected...");
+      try {
+        yamlheader = YAML.load(splits[0]);
+        grunt.verbose.ok();
+      } catch(e) {
+        grunt.log.error("Yaml header is probably not valid", e);
+        return;
+      }
+
+      grunt.verbose.writeln("Exposing header variables to context...");
+      Object.keys(yamlheader).forEach(function(key) {
+        context[key] = yamlheader[key];
+        grunt.verbose.ok("'" + key + "'", '->', yamlheader[key]);
+      });
+
+      markdown = splits.splice(2).join("\n"); // The actual markdown to be process
+    }
+    return markdown;
+  }
+
+  function processMappings(markdown, context) {
+    var mappings;
+    if (context.mappings) {
+      grunt.verbose.write("Strings replacement to be done...");
+      mappings = context.mappings;
+      Object.keys(context.mappings).forEach(function(key) {
+        markdown = markdown.replace('<p>[' + key + ']</p>', mappings[key]);
+        grunt.verbose.ok("'" + key + "'", '->', mappings[key]);
+      });
+    }
+    return markdown;
+  }
+
+  grunt.config.set('markdown', {
+    "docs": {
+      files: [
+        {
+          expand: true,
+          cwd: DOCS_PATH,
+          src: DOCS_MD_GLOB,
+          dest: GH_PAGES_PATH,
+          ext: '.html'
+        }
+      ],
+      options: {
+        template: DOCS_PATH + '_layouts/default.html',
+        templateContext: function() {
+          return {
+            title: "Web fuel for the long run",
+            cssclass: "",
+            footerscripts: "",
+            headerscripts: "",
+            version: VERSION
+          };
+        },
+        preCompile: function(src, context) {
+          return extractYamlHeader(src, context);
+        },
+        postCompile: function(markdown, context) {
+          return processMappings(markdown, context);
+        },
+        markdownOptions: {
+          gfm: true,
+          highlight: "manual"
+        }
+      }
+    }
+  });
+
+
+  // Playground Express Server
+
+  grunt.registerTask("docs:playground-server", "Launch local version of documentation including playground", function() {
+    grunt.config.requires('hspserver.port');
+    grunt.config.requires('hspserver.base');
+
+    var port            = grunt.config('hspserver.port'),
+        hspRoot         = grunt.config('hspserver.base'),
+        emptyJsResponse = function(req, res) { res.set('Content-Type', 'application/x-javascript'); return res.send(""); },
+        compilerPath    = '/dist/' + VERSION + '/hashspace-noder-compiler.min.js',
+        runtimePath     = '/dist/' + VERSION + '/hashspace-noder.min.js';
+
+    grunt.log.subhead('Local website setup');
+    grunt.log.writeln('Starting local documentation web server...');
+    // Log requests
+    if (grunt.option('verbose')) {
+        app.use(express.logger());
+    }
+
+    // Serve static files from the generated hashspace gh-pages folder
+    app.use(express.static(GH_PAGES_PATH));
+    grunt.verbose.ok("/ ->", GH_PAGES_PATH);
+
+    // Serve also static files from the configured folder where hsp is located
+    app.use('/hsp' , express.static(hspRoot));
+    grunt.verbose.ok("/hsp ->", hspRoot);
+
+    // Proxying acorn-js
+    app.get("/acorn/acorn.js", function(req, res) { res.sendfile(require.resolve('acorn/acorn')); });
+
+    // Empty polyfills for client hsp runtime and compiler to force noder-js to read them from
+    app.get(compilerPath, emptyJsResponse);
+    grunt.verbose.ok(compilerPath, 'polyfilled to be empty');
+    app.get(runtimePath, emptyJsResponse);
+    grunt.verbose.ok(runtimePath, 'polyfilled to be empty');
+
+    // Proxying /test and /node_modules folders
+    app.use('/test', express.static('./test'));
+    app.use('/node_modules', express.static('./node_modules'));
+
+    app.listen(port);
+    grunt.log.ok("started and listening on", 'http://localhost:' + port + '/');
+
+    // Give back the handle to Grunt 4ever :D
+    this.async();
+  });
+
+
+  // Building all needed files for the playground
+
+  grunt.registerTask("docs:playground-build", "Build a static playground version", function() {
+
+    grunt.log.subhead("Building playground and samples files");
+    // We copy the Playground files
+    grunt.verbose.or.write("Copying playground file...");
+    grunt.file.expand({ cwd: DOCS_PATH, filter: "isFile" }, DOCS_PLAYGROUND_GLOB).forEach(function(file) {
+      grunt.file.copy(DOCS_PATH + file, GH_PAGES_PATH + file);
+    });
+    grunt.verbose.or.ok();
+
+    // We copy the Samples files
+    grunt.verbose.or.write("Copying samples file...");
+    grunt.file.expand({ cwd: DOCS_PATH, filter: "isFile" }, DOCS_SAMPLES_GLOB).forEach(function(file) {
+      grunt.file.copy(DOCS_PATH + file, GH_PAGES_PATH + file);
+    });
+    grunt.verbose.or.ok();
+
+  });
+
+
+  // Preparing the build
+
+  grunt.registerTask("docs:setup", "Verify that everything is fine before we start", function() {
+    if (!grunt.file.exists(GH_PAGES_PATH)) {
+      grunt.verbose.or.write(GH_PAGES_PATH + " does not exist, let's create it...");
+      grunt.file.mkdir(GH_PAGES_PATH);
+      grunt.verbose.or.ok();
+      /*grunt.log.error('Make sure you have the hashspace gh-pages branch checked ' +
+                    'out at ./hashspace-gh-pages.');
+      return false;*/
+    }
+    grunt.verbose.or.write('Emptying', '"' + GH_PAGES_PATH + '"' , 'folder...');
+    grunt.file.expand({ filter: "isFile" }, GH_PAGES_GLOB).forEach(function(file) {
+      grunt.file.delete(file, { force: true });
+    });
+    grunt.verbose.or.ok();
+  });
+
+
+  // Copying static files
+
+  grunt.registerTask("docs:copy-statics", "Copy static files", function() {
+    // Moving previously built uglify.js to /libs
+    grunt.file.copy("tmp/uglify-js.js", GH_PAGES_PATH + 'libs/uglify-js.js');
+    grunt.file.delete('tmp', { force: true });
+
+    grunt.verbose.or.write("Copying images, css, javascript libs...");
+    grunt.file.expand({ cwd: DOCS_PATH, filter: "isFile" }, DOCS_STATICS_GLOB).forEach(function(file) {
+      grunt.file.copy(DOCS_PATH + file, GH_PAGES_PATH + file);
+    });
+    grunt.verbose.or.ok();
+  });
+
+
+  // Watching stuff...
+
+  grunt.registerTask("docs:watch", "Watching any file where local website should be rebuild", function() {
+    var watchConfig      = grunt.config("watch");
+
+    grunt.log.subhead("Expanding original watch config...");
+    watchConfig.docs_markdown = {
+      files: WATCH_MARKDOWN_GLOB,
+      tasks: ["markdown:docs"]
+    };
+    grunt.log.writeln("Watching markdown files...");
+
+    watchConfig.docs_less = {
+      files: WATCH_LESS_GLOB,
+      tasks: ["less:docs"]
+    };
+    grunt.log.writeln("Watching less files...");
+
+    watchConfig.docs_playground = {
+      files: WATCH_SAMPLES_GLOB.concat(WATCH_PLAYGROUND_GLOB),
+      tasks: ["docs:playground-build"]
+    };
+    grunt.log.writeln("Watching '" + DOCS_PATH + "playground/' files...");
+    grunt.log.writeln("Watching '" + DOCS_PATH + "samples/' files...");
+
+    grunt.config("watch", watchConfig);
+
+    grunt.task.run(["watch"]);
+  });
+
+
+
+  // Public tasks definition
+
+  grunt.registerTask("docs:prepare", [
+    "docs:setup",
+    "atpackager:uglify",
+    "docs:copy-statics",
+    "less:docs",
+    "markdown:docs"
+  ]);
+
+  grunt.registerTask("docs:playground", [
+    "docs:prepare",
+    "docs:playground-build",
+    "docs:playground-server"
+  ]);
+
+  grunt.registerTask("docs:release", ["docs:prepare", "docs:playground-build"]);
+};

ci-release.sh

@@ -1,12 +1,13 @@
-if [ $TRAVIS_PULL_REQUEST = "false" ]; then
+if [ "$TRAVIS_PULL_REQUEST" = "false" ] && [ "$TRAVIS_SECURE_ENV_VARS" = "true" ]; then
     # we need to clone the repo once again, as by default Travis CI makes
     # shallow clones where gh-pages branch is not available and can't be fetched
-    git clone "https://github.com/${TRAVIS_REPO_SLUG}.git" temp && cd temp &&
+    git clone "https://github.com/${TRAVIS_REPO_SLUG}.git" hashspace-gh-pages && cd hashspace-gh-pages &&
     git config user.email "releasebot@ariatemplates.com" &&
-    git config user.name "Release Bot" &&
+    git config user.name "Titan Bot" &&
     git checkout -b gh-pages origin/gh-pages &&
     cp -rv ../dist . &&
+    grunt docs
     git add -f dist &&
     git commit -m "release ${TRAVIS_COMMIT}" &&
     git push --quiet "https://${GH_CREDENTIALS}@github.com/${TRAVIS_REPO_SLUG}.git" gh-pages
-fi
+fi

docs/404.md

@@ -0,0 +1,5 @@
+title: Not found
+cssclass: home
+---
+
+## <span class="not-found">This page does not exist</span>