zappa.coffee | |
---|---|
Zappa is a CoffeeScript DSL-ish interface for building web apps on the node.js runtime, integrating express, socket.io and other best-of-breed libraries. | zappa = version: '0.2.1'
log = console.log
fs = require 'fs'
path = require 'path'
_ = require 'underscore'
uuid = require 'node-uuid'
express = require 'express'
socketio = require 'socket.io'
jsdom = require 'jsdom'
jquery = fs.readFileSync(__dirname + '/../vendor/jquery-1.6.4.min.js').toString()
sammy = fs.readFileSync(__dirname + '/../vendor/sammy-0.7.0.min.js').toString()
uglify = require 'uglify-js' |
CoffeeScript-generated JavaScript may contain anyone of these; when we "rewrite" a function (see below) though, it loses access to its parent scope, and consequently to any helpers it might need. So we need to reintroduce these helpers manually inside any "rewritten" function. | coffeescript_helpers = """
var __slice = Array.prototype.slice;
var __hasProp = Object.prototype.hasOwnProperty;
var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
var __extends = function(child, parent) {
for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; }
function ctor() { this.constructor = child; }
ctor.prototype = parent.prototype; child.prototype = new ctor; child.__super__ = parent.prototype;
return child; };
var __indexOf = Array.prototype.indexOf || function(item) {
for (var i = 0, l = this.length; i < l; i++) {
if (this[i] === item) return i;
} return -1; };
""".replace /\n/g, '' |
"Rewrites" a function so that it accepts the value of @/this ("context") and local variables as parameters. The names of local variables to be "extracted" have to be provided beforehand. The function will lose access to its parent scope in the process. | rewrite_function = (func, locals_names) ->
code = String(func)
code = "function () {#{code}}" unless code.indexOf 'function' is 0
code = "#{coffeescript_helpers}return (#{code}).apply(context, args);"
for name in locals_names
code = "var #{name} = locals.#{name};" + code
new Function('context', 'locals', 'args', code)
minify = (js) ->
ast = uglify.parser.parse(js)
ast = uglify.uglify.ast_mangle(ast)
ast = uglify.uglify.ast_squeeze(ast)
uglify.uglify.gen_code(ast) |
Builds an array of unique names from the desired scopes. Ex.: select names, 'http + defs + helpers' | select = (names, scopes) ->
_.union (names[i] for i in scopes.split ' + ') |
The stringified zappa client. | client = require('./client').build(zappa.version, coffeescript_helpers, rewrite_function) |
Keep inline views at the module level and namespaced by app id so that the monkeypatched express can look them up. | views = {}
|
Monkeypatch express to support lookup of inline templates. Such is life. | express.View.prototype.__defineGetter__ 'exists', -> |
Path given by zappa: /path/to/appid/foo.bar. | |
Try appid/foo.bar in memory. | p = @path.replace @root + '/', ''
id = p.split('/')[0]
return true if views[p] |
Try appid/foo in memory. | p = p.replace(path.extname(p), '')
return true if views[p] |
Try /path/to/foo.bar in filesystem (normal express behaviour). | p = @path.replace id + '/', ''
try
fs.statSync(p)
return true
catch err
return false
express.View.prototype.__defineGetter__ 'contents', -> |
Path given by zappa: /path/to/appid/foo.bar. | |
Try appid/foo.bar in memory. | p = @path.replace @root + '/', ''
id = p.split('/')[0]
return views[p] if views[p] |
Try appid/foo in memory. | p = p.replace(path.extname(p), '')
return views[p] if views[p] |
Try /path/to/foo.bar in filesystem (normal express behaviour). | p = @path.replace id + '/', ''
fs.readFileSync p, 'utf8' |
Takes in a function and builds express/socket.io apps based on the rules contained in it. The optional externals object allows passing variables from the outside to the root scope. | zappa.app = ->
id = uuid()
externals = null
root_function = null
for a in arguments
switch typeof a
when 'function' then root_function = a
when 'object' then externals = a |
Names of local variables that we have to know beforehand, to use with | names = |
The last four ( | globals: ['global', 'process', 'console', 'setTimeout', 'clearTimeout', 'setInterval', 'clearInterval',
'require', 'module', '__filename', '__dirname']
root: ['zappa', 'express', 'app', 'io', 'requiring', 'get', 'post', 'put', 'del', 'at',
'helper', 'def', 'view', 'set', 'use', 'configure', 'include', 'shared', 'client', 'coffee', 'js', 'css',
'stylus', 'enable', 'disable', 'settings', 'postrender'] |
TODO: cookies, app data, clients list | http: ['app', 'settings', 'response', 'request', 'next', 'params', 'send', 'render', 'redirect', 'session'] |
TODO: app data, clients list, join | ws: ['app', 'io', 'settings', 'socket', 'id', 'params', 'client', 'emit', 'broadcast']
postrender: ['window', '$']
externals: (k for k, v of externals)
helpers: []
defs: [] |
Storage for user-provided stuff. Views are kept at the module level. | routes = []
ws_handlers = {}
helpers = {}
defs = {}
postrenders = {}
app = express.createServer()
io = socketio.listen(app) |
Zappa's default settings. | app.set 'view engine', 'coffee'
app.register '.coffee', zappa.adapter require('coffeekup').adapters.express,
blacklist: ['format', 'autoescape', 'locals', 'hardcode', 'cache'] |
Builds the applications's root scope. | root_context = {}
root_locals = {zappa, express, app, io}
root_locals[g] = eval(g) for g in names.globals
|
These "globals" are actually local to each module, so we get our values from our parent module. | root_locals.module = module.parent
root_locals.__filename = module.parent.filename
root_locals.__dirname = path.dirname(module.parent.filename) |
TODO: Find out how to pass the correct | require.paths.unshift dir for dir in module.parent.paths
require.paths.unshift root_locals.__dirname
|
Sets default view dir to root_local's dir name. | app.set 'views', root_locals.__dirname + '/views'
for verb in ['get', 'post', 'put', 'del']
do (verb) ->
root_locals[verb] = ->
if typeof arguments[0] isnt 'object'
routes.push verb: verb, path: arguments[0], handler: arguments[1]
else
for k, v of arguments[0]
routes.push verb: verb, path: k, handler: v
root_locals.client = (obj) ->
app.enable 'serve zappa'
for k, v of obj
js = ";zappa.run(#{v});"
js = minify(js) if app.settings['minify']
routes.push verb: 'get', path: k, handler: js, contentType: 'js'
root_locals.coffee = (obj) ->
for k, v of obj
js = ";#{coffeescript_helpers}(#{v})();"
js = minify(js) if app.settings['minify']
routes.push verb: 'get', path: k, handler: js, contentType: 'js'
root_locals.js = (obj) ->
for k, v of obj
js = String(v)
js = minify(js) if app.settings['minify']
routes.push verb: 'get', path: k, handler: js, contentType: 'js'
root_locals.css = (obj) ->
for k, v of obj
css = String(v)
routes.push verb: 'get', path: k, handler: css, contentType: 'css'
root_locals.stylus = (obj) ->
for k, v of obj
css = require('stylus').render v, filename: k, (err, css) ->
throw err if err
routes.push verb: 'get', path: k, handler: css, contentType: 'css'
root_locals.helper = (obj) ->
for k, v of obj
names.helpers.push k
helpers[k] = v
root_locals.def = (obj) ->
for k, v of obj
names.defs.push k
defs[k] = v
root_locals.postrender = (obj) ->
for k, v of obj
postrenders[k] = v
root_locals.at = (obj) ->
for k, v of obj
ws_handlers[k] = v
root_locals.view = (obj) ->
for k, v of obj
views["#{id}/#{k}"] = v
root_locals.set = (obj) ->
for k, v of obj
app.set k, v
root_locals.enable = ->
app.enable i for i in arguments
root_locals.disable = ->
app.disable i for i in arguments
root_locals.use = ->
wrappers =
static: (path = root_locals.__dirname + '/public') ->
express.static(path)
use = (name, arg = null) ->
if wrappers[name]
app.use wrappers[name](arg)
else if typeof express[name] is 'function'
app.use express[name](arg)
for a in arguments
switch typeof a
when 'function' then app.use a
when 'string' then use a
when 'object' then use k, v for k, v of a
root_locals.requiring = ->
pairs = {}
for a in arguments
pairs[a] = require a
root_locals.def pairs
root_locals.configure = (p) ->
if typeof p is 'function' then app.configure p
else app.configure k, v for k, v of p
root_locals.settings = app.settings
root_locals.shared = (obj) ->
app.enable 'serve zappa'
for k, v of obj
js = ";zappa.run(#{v});"
js = minify(js) if app.settings['minify']
routes.push verb: 'get', path: k, handler: js, contentType: 'js'
rewritten_shared = rewrite_function(v, select names, 'globals + root + externals')
rewritten_shared(root_context, root_locals)
root_locals.include = (name) ->
sub = root_locals.require name
rewritten_sub = rewrite_function(sub.include, select names, 'globals + root + externals')
include_locals = {}
include_locals[k] = v for k, v of root_locals
include_module = require.cache[require.resolve(name)]
|
These "globals" are actually local to each module, so we get our values from the required module. | include_locals.module = include_module
include_locals.__filename = include_module.filename
include_locals.__dirname = path.dirname(include_module.filename) |
TODO: Find out how to pass the correct | rewritten_sub(root_context, include_locals) |
Variables passed through the object parameter. | root_locals[k] = v for k, v of externals |
Executes the (rewriten) end-user function and learns how the app should be structured. | rewritten_root = rewrite_function(root_function, select names, 'globals + root + externals')
rewritten_root(root_context, root_locals) |
Implements the application according to the specification. | for k, v of helpers
helpers[k] = rewrite_function(v, select names, 'globals + http + externals + helpers + defs')
for k, v of ws_handlers
ws_handlers[k] = rewrite_function(v, select names, 'globals + ws + externals + helpers + defs')
for k, v of postrenders
postrenders[k] = rewrite_function(v, select names, 'globals + postrender + externals + helpers + defs')
if app.settings['serve zappa']
js = ";#{coffeescript_helpers}(#{client})();"
js = minify(js) if app.settings['minify']
app.get '/zappa/zappa.js', (req, res) ->
res.contentType 'js'
res.send js
if app.settings['serve jquery']
app.get '/zappa/jquery.js', (req, res) ->
res.contentType 'js'
res.send jquery
if app.settings['serve sammy']
app.get '/zappa/sammy.js', (req, res) ->
res.contentType 'js'
res.send sammy
if app.settings['default layout']
root_locals.view layout: ->
doctype 5
html ->
head ->
title @title if @title
if @scripts
for s in @scripts
script src: s + '.js'
script(src: @script + '.js') if @script
if @stylesheets
for s in @stylesheets
link rel: 'stylesheet', href: s + '.css'
link(rel: 'stylesheet', href: @stylesheet + '.css') if @stylesheet
style @style if @style
body @body |
Implements the http server with express. | for r in routes
do (r) ->
if typeof r.handler is 'string'
app[r.verb] r.path, (req, res) ->
res.contentType r.contentType if r.contentType?
res.send r.handler
else
rewritten_handler = rewrite_function(r.handler,
select(names, 'globals + http + externals + helpers + defs'))
context = null
locals = {app, settings: app.settings}
|
TODO: fix pseudo-globals here too. | locals[g] = eval(g) for g in names.globals
|
TODO: externals are also shadowing certain immutable request scope vars. Should it? | locals[e] = externals[e] for e in names.externals
for name, def of defs
locals[name] = def
for name, helper of helpers
do (name, helper) ->
locals[name] = ->
helper(context, locals, arguments)
app[r.verb] r.path, (req, res, next) ->
context = {}
context[k] = v for k, v of req.query
context[k] = v for k, v of req.params
context[k] = v for k, v of req.body
locals.params = context
locals.request = req
locals.session = req.session
locals.response = res
locals.next = next
locals.send = -> res.send.apply res, arguments
locals.redirect = -> res.redirect.apply res, arguments
locals.render = (args...) -> |
Adds the app id to the view name so that the monkeypatched express.View.exists and express.View.contents can lookup this app's inline templates. | args[0] = id + '/' + args[0]
|
Make sure the second arg is an object. | args[1] ?= {}
args.splice 1, 0, {} if typeof args[1] is 'function'
|
Send request input vars to template as | args[1].params ?= locals.params
if args[1].postrender? |
Apply postrender before sending response. | res.render args[0], args[1], (err, str) ->
jsdom.env html: str, src: [jquery], done: (err, window) ->
locals.window = window
locals.$ = window.$
rendered = postrenders[args[1].postrender](context, locals)
doctype = (window.document.doctype or '') + "\n"
res.send doctype + window.document.documentElement.outerHTML
else |
Just forward params to express. | res.render.apply res, args
result = rewritten_handler(context, locals)
res.contentType(r.contentType) if r.contentType?
if typeof result is 'string' then res.send result
else return result |
Implements the websockets server with socket.io. | io.sockets.on 'connection', (socket) ->
context = {}
locals =
app: app
io: io
settings: app.settings
socket: socket
id: socket.id
client: {}
emit: -> socket.emit.apply socket, arguments
broadcast: -> socket.broadcast.emit.apply socket.broadcast, arguments |
TODO: fix pseudo-globals here too. | locals[g] = eval(g) for g in names.globals
|
TODO: externals are also shadowing certain immutable socket scope vars. Should it? | locals[e] = externals[e] for e in names.externals
for name, def of defs
locals[name] = def
for name, helper of helpers
locals[name] = ->
helper(context, locals, arguments)
ws_handlers.connection(context, locals) if ws_handlers.connection?
socket.on 'disconnect', ->
context = {}
ws_handlers.disconnect(context, locals) if ws_handlers.disconnect?
for name, h of ws_handlers
do (name, h) ->
if name isnt 'connection' and name isnt 'disconnect'
socket.on name, (data) ->
context = {}
context[k] = v for k, v of data
locals.params = context
h(context, locals)
{id, app, io} |
Takes a function and runs it as a zappa app. Optionally accepts a port number, and/or
a hostname (any order). The hostname must be a string, and the port number must be
castable as a number.
Returns an object where | zappa.run = ->
host = null
port = 3000
root_function = null
externals = null
for a in arguments
switch typeof a
when 'string'
if isNaN( (Number) a ) then host = a
else port = (Number) a
when 'number' then port = a
when 'function' then root_function = a
when 'object' then externals = a
zapp = zappa.app(externals, root_function)
app = zapp.app
if host then app.listen port, host
else app.listen port
log 'Express server listening on port %d in %s mode',
app.address().port, app.settings.env
log "Zappa #{zappa.version} orchestrating the show"
zapp |
Creates a zappa view adapter for templating engine Zappa, by default, automatically sends all request params to templates,
but inside the This adapter adds a "root local" for each of these params, only if a local with the same name doesn't exist already, and the name is not in the optional blacklist. The blacklist is useful to prevent request params from triggering unset template engine options. If | zappa.adapter = (engine, options = {}) ->
options.blacklist ?= []
engine = require(engine) if typeof engine is 'string'
compile: (template, data) ->
template = engine.compile(template, data)
(data) ->
for k, v of data.params
if typeof data[k] is 'undefined' and k not in options.blacklist
data[k] = v
template(data)
module.exports = zappa.run
module.exports.run = zappa.run
module.exports.app = zappa.app
module.exports.adapter = zappa.adapter
module.exports.version = zappa.version
|