oboe.js-demo/index.js

A website for Oboe.js

var express = require('express'),
    gzippo = require('gzippo'),
    consolidate = require('consolidate'),
    readContent = require('./read-content.js'),
    readPagesList = require('./read-pages-list.js'),
    barrier = require('./barrier.js'),
    environment = require('optimist')
                    .demand(['env'])
                    .argv.env,
    
    PORT = '8888',

    isProd = (environment == 'prod'),  
    SCRIPTS = isProd? ['/js-concat/all.js'] : require('./sourceList.js'),

    CSS_STYLESHEETS = isProd? ["all-min.css"] : ["all.css"],
        
    LATEST_TAG = 'v1.15.2',
    ANALYTICS_ID = 'UA-47871814-1',
    RAW_REPO_LOCATION = 'https://raw.github.com/jimhigson/oboe.js',
    REPO_LOCATION = 'https://github.com/jimhigson/oboe.js',

    app = express();

require('colors');

console.log('starting up for environment', environment.blue );

app.engine('handlebars', consolidate.handlebars);
app.set('view engine', 'handlebars');
app.set('views', __dirname + '/views');

/* create <template> elements to send to the client side so it can
 * make visualisations by cloning them */
function renderClientSideDemoTemplates(res, callback){
    var DEMO_TEMPLATE_OPTIONS = {packetRadius: 15};

    res.render('demoTemplate', DEMO_TEMPLATE_OPTIONS,
        function(err, demoContentHtml) {
            callback(demoContentHtml);
        });
}

function defaultOpts(opts) {
    opts = opts || {};
    opts.scripts     = SCRIPTS;
    opts.stylesheets = CSS_STYLESHEETS;
    opts.latestTag   = LATEST_TAG;
    opts.analyticsId = ANALYTICS_ID;
    opts.repo = REPO_LOCATION;
    opts.rawRepo = RAW_REPO_LOCATION;
    opts.logoSize = 64;
    opts.releasedJs = RAW_REPO_LOCATION + '/' + LATEST_TAG + '/dist';
    opts.production = isProd;
    
    return opts;
}

function respondWithMarkdown(req, res, getContentFn, opts){
    
    var view = (req.query.mode == 'raw'? 'raw' : 'page');

    opts = defaultOpts(opts);
        
    var bar = barrier(function(){
        res.render(view, opts);
        console.log('The HTML page for', req.url.blue, 'was created in', String(bar.duration).blue, 'ms');
    });
    
    readPagesList(bar.add(function(pages){
        // if any page in the pages list is the current, mark as such:
        pages.forEach(function(page){
            var pageUrl = '/' + page.path;
            page.current = ( pageUrl == req.url ); 
        });
        
        opts.pages = pages;
    }));

    getContentFn(req, opts, bar.add(function( outline ){

        opts.content = outline.content;
        opts.heading = outline.heading;
        opts.sections = outline.sections;
        opts.multipleSections = outline.multipleSections;
        res.status(outline.status);
    }));

    renderClientSideDemoTemplates(res, bar.add(function(templateHtml) {
        
        opts.templates = templateHtml;
    }));
}

function readMarkdownFromFile( filename ) {
   
   return function( req, opts, callback ) {

      readContent(filename, opts, callback);
   };
}

app
   .use(function(req, res, next) {
      // Connect middleware:
      // works around an issue in gzippo where requests from a load balancer for the homepage
      // would 404 because it tries to serve as a non-existent static, non-gzipped resource.
      // TODO: find something less buggy than gzippo
      
      if( !req.headers['Content-Encoding'] && req.url == '/' ) {
         respondWithMarkdown(req, res, readMarkdownFromFile('index'));
      } else {
         // for all other requests, go on as usual:
         next();
      }
   })
   .use(express.favicon(__dirname + '/statics/favicons/favicon.ico'))
   .use(gzippo.staticGzip('statics')) // gzip for static
   .use(gzippo.staticGzip('pdf'))
   .use(gzippo.staticGzip('bower_components')) // gzip for static
   .use(express.compress()) // gzip for dynamic
   .get('/', function(req, res){
        respondWithMarkdown(req, res, readMarkdownFromFile('index'), {   
           home: true,
           twitter: true
        });
   })
   .get('/:page', function(req, res){
       respondWithMarkdown(req, res, readMarkdownFromFile(req.params.page));
   });

// allow single demos to be viewed but only if we are in dev:
if( environment == 'dev' ) {
   app.get('/demo/:demo', function(req, res){
        
       function generateMarkdownForSingleDemo(req, _opts, callback){
           var demoName = req.params.demo;
           
           callback({
               content:'<figure data-demo="' + demoName  + '"></figure>'
           ,   heading: {text:'Demo: ' + demoName}
           ,   sections:[]
           ,   status:200
           });
       }
        
       respondWithMarkdown(req, res, generateMarkdownForSingleDemo);
   })
}

// As a catch-all generate a 404.
app.use(function(req,res){
   console.warn('Unrecognised path; catch-all serving 404:'.red, req.url);
   
   respondWithMarkdown(req, res, readMarkdownFromFile('404'));
});

app.listen(PORT);

console.log('started on port', PORT.blue);